* doc/invoke.texi (RS6000 options): LRA is enabled by default.
[official-gcc.git] / gcc / doc / invoke.texi
blob2bd105a867f2955ebc9c17ff6904afecd776baab
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function} -fgimple@gol
184 -fhosted  -ffreestanding -fopenacc -fopenmp -fopenmp-simd @gol
185 -fms-extensions -fplan9-extensions -fsso-struct=@var{endianness}
186 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n} -fargs-in-order=@var{n} -fcheck-new @gol
194 -fconstexpr-depth=@var{n} -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wmultiple-inheritance @gol
217 -Wnamespaces -Wnarrowing @gol
218 -Wnoexcept -Wnon-virtual-dtor  -Wreorder -Wregister @gol
219 -Weffc++  -Wstrict-null-sentinel -Wtemplates @gol
220 -Wno-non-template-friend  -Wold-style-cast @gol
221 -Woverloaded-virtual  -Wno-pmf-conversions @gol
222 -Wsign-promo -Wvirtual-inheritance}
224 @item Objective-C and Objective-C++ Language Options
225 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
226 Objective-C and Objective-C++ Dialects}.
227 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
228 -fgnu-runtime  -fnext-runtime @gol
229 -fno-nil-receivers @gol
230 -fobjc-abi-version=@var{n} @gol
231 -fobjc-call-cxx-cdtors @gol
232 -fobjc-direct-dispatch @gol
233 -fobjc-exceptions @gol
234 -fobjc-gc @gol
235 -fobjc-nilcheck @gol
236 -fobjc-std=objc1 @gol
237 -fno-local-ivars @gol
238 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
239 -freplace-objc-classes @gol
240 -fzero-link @gol
241 -gen-decls @gol
242 -Wassign-intercept @gol
243 -Wno-protocol  -Wselector @gol
244 -Wstrict-selector-match @gol
245 -Wundeclared-selector}
247 @item Diagnostic Message Formatting Options
248 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
249 @gccoptlist{-fmessage-length=@var{n}  @gol
250 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
251 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
252 -fno-diagnostics-show-option -fno-diagnostics-show-caret @gol
253 -fdiagnostics-parseable-fixits -fdiagnostics-generate-patch @gol
254 -fno-show-column}
256 @item Warning Options
257 @xref{Warning Options,,Options to Request or Suppress Warnings}.
258 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
259 -pedantic-errors @gol
260 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
261 -Walloc-zero -Walloc-size-larger-than=@var{n}
262 -Walloca -Walloca-larger-than=@var{n} @gol
263 -Wno-aggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
264 -Wno-attributes -Wbool-compare -Wbool-operation @gol
265 -Wno-builtin-declaration-mismatch @gol
266 -Wno-builtin-macro-redefined -Wc90-c99-compat -Wc99-c11-compat @gol
267 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
268 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
269 -Wconversion -Wcoverage-mismatch -Wno-cpp -Wdangling-else -Wdate-time @gol
270 -Wdelete-incomplete @gol
271 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
272 -Wdisabled-optimization @gol
273 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
274 -Wno-div-by-zero -Wdouble-promotion -Wduplicated-cond @gol
275 -Wempty-body  -Wenum-compare  -Wno-endif-labels -Wexpansion-to-defined @gol
276 -Werror  -Werror=* -Wfatal-errors -Wfloat-equal  -Wformat  -Wformat=2 @gol
277 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-length=@var{n} @gol
278 -Wformat-nonliteral @gol
279 -Wformat-security  -Wformat-signedness  -Wformat-y2k -Wframe-address @gol
280 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
281 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
282 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
283 -Wimplicit-function-declaration  -Wimplicit-int @gol
284 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
285 -Wno-int-to-pointer-cast -Winvalid-memory-model -Wno-invalid-offsetof @gol
286 -Winvalid-pch -Wlarger-than=@var{len} @gol
287 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
288 -Wmain -Wmaybe-uninitialized -Wmemset-elt-size -Wmemset-transposed-args @gol
289 -Wmisleading-indentation -Wmissing-braces @gol
290 -Wmissing-field-initializers -Wmissing-include-dirs @gol
291 -Wno-multichar -Wnonnull -Wnonnull-compare @gol
292 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
293 -Wnull-dereference -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
294 -Woverride-init-side-effects -Woverlength-strings @gol
295 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
296 -Wparentheses -Wno-pedantic-ms-format @gol
297 -Wplacement-new -Wplacement-new=@var{n} @gol
298 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
299 -Wno-pragmas -Wredundant-decls -Wrestrict  -Wno-return-local-addr @gol
300 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
301 -Wshadow=global, -Wshadow=local, -Wshadow=compatible-local @gol
302 -Wshift-overflow -Wshift-overflow=@var{n} @gol
303 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
304 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
305 -Wno-scalar-storage-order @gol
306 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
307 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
308 -Wstrict-aliasing=n -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
309 -Wstringop-overflow=@var{n} @gol
310 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
311 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
312 -Wmissing-format-attribute -Wsubobject-linkage @gol
313 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
314 -Wswitch-unreachable  -Wsync-nand @gol
315 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
316 -Wtype-limits  -Wundef @gol
317 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
318 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
319 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
320 -Wunused-parameter -Wno-unused-result @gol
321 -Wunused-value -Wunused-variable @gol
322 -Wunused-const-variable -Wunused-const-variable=@var{n} @gol
323 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
324 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
325 -Wvla -Wvla-larger-than=@var{n} -Wvolatile-register-var  -Wwrite-strings @gol
326 -Wzero-as-null-pointer-constant -Whsa}
328 @item C and Objective-C-only Warning Options
329 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
330 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
331 -Wold-style-declaration  -Wold-style-definition @gol
332 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
333 -Wdeclaration-after-statement -Wpointer-sign}
335 @item Debugging Options
336 @xref{Debugging Options,,Options for Debugging Your Program}.
337 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf -gdwarf-@var{version} @gol
338 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
339 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
340 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
341 -fdebug-prefix-map=@var{old}=@var{new} -fdebug-types-section @gol
342 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
343 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
344 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
345 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
346 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
347 -fvar-tracking -fvar-tracking-assignments}
349 @item Optimization Options
350 @xref{Optimize Options,,Options that Control Optimization}.
351 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
352 -falign-jumps[=@var{n}] @gol
353 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
354 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
355 -fauto-inc-dec -fbranch-probabilities @gol
356 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
357 -fbtr-bb-exclusive -fcaller-saves @gol
358 -fcombine-stack-adjustments -fconserve-stack @gol
359 -fcompare-elim -fcprop-registers -fcrossjumping @gol
360 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
361 -fcx-limited-range @gol
362 -fdata-sections -fdce -fdelayed-branch @gol
363 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
364 -fdevirtualize-at-ltrans -fdse @gol
365 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
366 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
367 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
368 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
369 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
370 -fif-conversion2 -findirect-inlining @gol
371 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
372 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment -fipa-bit-cp @gol
373 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
374 -fira-algorithm=@var{algorithm} @gol
375 -fira-region=@var{region} -fira-hoist-pressure @gol
376 -fira-loop-pressure -fno-ira-share-save-slots @gol
377 -fno-ira-share-spill-slots @gol
378 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
379 -fivopts -fkeep-inline-functions -fkeep-static-functions @gol
380 -fkeep-static-consts -flimit-function-alignment -flive-range-shrinkage @gol
381 -floop-block -floop-interchange -floop-strip-mine @gol
382 -floop-unroll-and-jam -floop-nest-optimize @gol
383 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
384 -flto-partition=@var{alg} -fmerge-all-constants @gol
385 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
386 -fmove-loop-invariants -fno-branch-count-reg @gol
387 -fno-defer-pop -fno-fp-int-builtin-inexact -fno-function-cse @gol
388 -fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole @gol
389 -fno-peephole2 -fno-printf-return-value -fno-sched-interblock @gol
390 -fno-sched-spec -fno-signed-zeros @gol
391 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
392 -fomit-frame-pointer -foptimize-sibling-calls @gol
393 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
394 -fprefetch-loop-arrays @gol
395 -fprofile-correction @gol
396 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
397 -fprofile-reorder-functions @gol
398 -freciprocal-math -free -frename-registers -freorder-blocks @gol
399 -freorder-blocks-algorithm=@var{algorithm} @gol
400 -freorder-blocks-and-partition -freorder-functions @gol
401 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
402 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
403 -fsched-spec-load -fsched-spec-load-dangerous @gol
404 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
405 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
406 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
407 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
408 -fschedule-fusion @gol
409 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
410 -fselective-scheduling -fselective-scheduling2 @gol
411 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
412 -fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate @gol
413 -fsignaling-nans @gol
414 -fsingle-precision-constant -fsplit-ivs-in-unroller -fsplit-loops@gol
415 -fsplit-paths @gol
416 -fsplit-wide-types -fssa-backprop -fssa-phiopt @gol
417 -fstdarg-opt -fstore-merging -fstrict-aliasing @gol
418 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
419 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
420 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
421 -ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting -ftree-loop-if-convert @gol
422 -ftree-loop-im @gol
423 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
424 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
425 -ftree-loop-vectorize @gol
426 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
427 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
428 -ftree-switch-conversion -ftree-tail-merge @gol
429 -ftree-ter -ftree-vectorize -ftree-vrp -funconstrained-commons @gol
430 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
431 -funsafe-math-optimizations -funswitch-loops @gol
432 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
433 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
434 --param @var{name}=@var{value}
435 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
437 @item Program Instrumentation Options
438 @xref{Instrumentation Options,,Program Instrumentation Options}.
439 @gccoptlist{-p  -pg  -fprofile-arcs --coverage -ftest-coverage @gol
440 -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
441 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
442 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
443 -fsanitize-undefined-trap-on-error -fbounds-check @gol
444 -fcheck-pointer-bounds -fchkp-check-incomplete-type @gol
445 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
446 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
447 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
448 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
449 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
450 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
451 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
452 -fchkp-use-wrappers -fchkp-flexible-struct-trailing-arrays@gol
453 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
454 -fstack-protector-explicit -fstack-check @gol
455 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
456 -fno-stack-limit -fsplit-stack @gol
457 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
458 -fvtv-counts -fvtv-debug @gol
459 -finstrument-functions @gol
460 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
461 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
463 @item Preprocessor Options
464 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
465 @gccoptlist{-A@var{question}=@var{answer} @gol
466 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
467 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
468 -dD  -dI  -dM  -dN  -dU @gol
469 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
470 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
471 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
472 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
473 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
474 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
475 -H  -imacros @var{file}  -include @var{file} @gol
476 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
477 -no-integrated-cpp  -P  -remap @gol
478 -traditional  -traditional-cpp  -trigraphs @gol
479 -U@var{macro}  -undef  @gol
480 -Wp,@var{option}  -Xpreprocessor @var{option}}
482 @item Assembler Options
483 @xref{Assembler Options,,Passing Options to the Assembler}.
484 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
486 @item Linker Options
487 @xref{Link Options,,Options for Linking}.
488 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
489 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
490 -s  -static -static-libgcc -static-libstdc++ @gol
491 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
492 -static-libmpx -static-libmpxwrappers @gol
493 -shared -shared-libgcc  -symbolic @gol
494 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
495 -u @var{symbol} -z @var{keyword}}
497 @item Directory Options
498 @xref{Directory Options,,Options for Directory Search}.
499 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
500 -idirafter @var{dir} @gol
501 -imacros @var{file}  -imultilib @var{dir} @gol
502 -iplugindir=@var{dir} -iprefix @var{file} @gol
503 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
504 -iwithprefix @var{dir} -iwithprefixbefore @var{dir}  @gol
505 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
506 -nostdinc  -nostdinc++ --sysroot=@var{dir}}
508 @item Code Generation Options
509 @xref{Code Gen Options,,Options for Code Generation Conventions}.
510 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
511 -ffixed-@var{reg}  -fexceptions @gol
512 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
513 -fasynchronous-unwind-tables @gol
514 -fno-gnu-unique @gol
515 -finhibit-size-directive  -fno-common  -fno-ident @gol
516 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
517 -fno-jump-tables @gol
518 -frecord-gcc-switches @gol
519 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
520 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
521 -fleading-underscore  -ftls-model=@var{model} @gol
522 -fstack-reuse=@var{reuse_level} @gol
523 -ftrampolines  -ftrapv  -fwrapv @gol
524 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
525 -fstrict-volatile-bitfields -fsync-libcalls}
527 @item Developer Options
528 @xref{Developer Options,,GCC Developer Options}.
529 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
530 -fchecking -fchecking=@var{n} -fdbg-cnt-list @gol
531 -fdbg-cnt=@var{counter-value-list} @gol
532 -fdisable-ipa-@var{pass_name} @gol
533 -fdisable-rtl-@var{pass_name} @gol
534 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
535 -fdisable-tree-@var{pass_name} @gol
536 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
537 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
538 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
539 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
540 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
541 -fdump-passes @gol
542 -fdump-rtl-@var{pass} -fdump-rtl-@var{pass}=@var{filename} @gol
543 -fdump-statistics @gol
544 -fdump-tree-all @gol
545 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
546 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
547 -fdump-tree-cfg -fdump-tree-alias @gol
548 -fdump-tree-ch @gol
549 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
550 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
551 -fdump-tree-gimple@r{[}-raw@r{]} @gol
552 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
553 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
554 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
555 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
556 -fdump-tree-backprop@r{[}-@var{n}@r{]} @gol
557 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
558 -fdump-tree-nrv -fdump-tree-vect @gol
559 -fdump-tree-sink @gol
560 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
561 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
562 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
563 -fdump-tree-vtable-verify @gol
564 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
565 -fdump-tree-split-paths@r{[}-@var{n}@r{]} @gol
566 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
567 -fdump-final-insns=@var{file} @gol
568 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
569 -fenable-@var{kind}-@var{pass} @gol
570 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
571 -fira-verbose=@var{n} @gol
572 -flto-report -flto-report-wpa -fmem-report-wpa @gol
573 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report @gol
574 -fopt-info -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
575 -fprofile-report @gol
576 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
577 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
578 -fstats  -fstack-usage  -ftime-report -ftime-report-details @gol
579 -fvar-tracking-assignments-toggle -gtoggle @gol
580 -print-file-name=@var{library}  -print-libgcc-file-name @gol
581 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
582 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
583 -print-sysroot -print-sysroot-headers-suffix @gol
584 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
586 @item Machine-Dependent Options
587 @xref{Submodel Options,,Machine-Dependent Options}.
588 @c This list is ordered alphanumerically by subsection name.
589 @c Try and put the significant identifier (CPU or system) first,
590 @c so users have a clue at guessing where the ones they want will be.
592 @emph{AArch64 Options}
593 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
594 -mgeneral-regs-only @gol
595 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
596 -mstrict-align @gol
597 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
598 -mtls-dialect=desc  -mtls-dialect=traditional @gol
599 -mtls-size=@var{size} @gol
600 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
601 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
602 -mlow-precision-recip-sqrt -mno-low-precision-recip-sqrt@gol
603 -mlow-precision-sqrt -mno-low-precision-sqrt@gol
604 -mlow-precision-div -mno-low-precision-div @gol
605 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
607 @emph{Adapteva Epiphany Options}
608 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
609 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
610 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
611 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
612 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
613 -msplit-vecmove-early -m1reg-@var{reg}}
615 @emph{ARC Options}
616 @gccoptlist{-mbarrel-shifter @gol
617 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
618 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
619 -mea -mno-mpy -mmul32x16 -mmul64 -matomic @gol
620 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
621 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
622 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
623 -mlong-calls -mmedium-calls -msdata @gol
624 -mvolatile-cache -mtp-regno=@var{regno} @gol
625 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
626 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
627 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
628 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
629 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
630 -mtune=@var{cpu} -mmultcost=@var{num} @gol
631 -munalign-prob-threshold=@var{probability} -mmpy-option=@var{multo} @gol
632 -mdiv-rem -mcode-density -mll64 -mfpu=@var{fpu}}
634 @emph{ARM Options}
635 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
636 -mabi=@var{name} @gol
637 -mapcs-stack-check  -mno-apcs-stack-check @gol
638 -mapcs-reentrant  -mno-apcs-reentrant @gol
639 -msched-prolog  -mno-sched-prolog @gol
640 -mlittle-endian  -mbig-endian @gol
641 -mfloat-abi=@var{name} @gol
642 -mfp16-format=@var{name}
643 -mthumb-interwork  -mno-thumb-interwork @gol
644 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
645 -mtune=@var{name} -mprint-tune-info @gol
646 -mstructure-size-boundary=@var{n} @gol
647 -mabort-on-noreturn @gol
648 -mlong-calls  -mno-long-calls @gol
649 -msingle-pic-base  -mno-single-pic-base @gol
650 -mpic-register=@var{reg} @gol
651 -mnop-fun-dllimport @gol
652 -mpoke-function-name @gol
653 -mthumb  -marm @gol
654 -mtpcs-frame  -mtpcs-leaf-frame @gol
655 -mcaller-super-interworking  -mcallee-super-interworking @gol
656 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
657 -mword-relocations @gol
658 -mfix-cortex-m3-ldrd @gol
659 -munaligned-access @gol
660 -mneon-for-64bits @gol
661 -mslow-flash-data @gol
662 -masm-syntax-unified @gol
663 -mrestrict-it @gol
664 -mpure-code @gol
665 -mcmse}
667 @emph{AVR Options}
668 @gccoptlist{-mmcu=@var{mcu} -mabsdata -maccumulate-args @gol
669 -mbranch-cost=@var{cost} @gol
670 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
671 -mrelax -mrmw -mstrict-X -mtiny-stack -mfract-convert-truncate -nodevicelib @gol
672 -Waddr-space-convert -Wmisspelled-isr}
674 @emph{Blackfin Options}
675 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
676 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
677 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
678 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
679 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
680 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
681 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
682 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
683 -micplb}
685 @emph{C6X Options}
686 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
687 -msim -msdata=@var{sdata-type}}
689 @emph{CRIS Options}
690 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
691 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
692 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
693 -mstack-align  -mdata-align  -mconst-align @gol
694 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
695 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
696 -mmul-bug-workaround  -mno-mul-bug-workaround}
698 @emph{CR16 Options}
699 @gccoptlist{-mmac @gol
700 -mcr16cplus -mcr16c @gol
701 -msim -mint32 -mbit-ops
702 -mdata-model=@var{model}}
704 @emph{Darwin Options}
705 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
706 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
707 -client_name  -compatibility_version  -current_version @gol
708 -dead_strip @gol
709 -dependency-file  -dylib_file  -dylinker_install_name @gol
710 -dynamic  -dynamiclib  -exported_symbols_list @gol
711 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
712 -force_flat_namespace  -headerpad_max_install_names @gol
713 -iframework @gol
714 -image_base  -init  -install_name  -keep_private_externs @gol
715 -multi_module  -multiply_defined  -multiply_defined_unused @gol
716 -noall_load   -no_dead_strip_inits_and_terms @gol
717 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
718 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
719 -private_bundle  -read_only_relocs  -sectalign @gol
720 -sectobjectsymbols  -whyload  -seg1addr @gol
721 -sectcreate  -sectobjectsymbols  -sectorder @gol
722 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
723 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
724 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
725 -single_module  -static  -sub_library  -sub_umbrella @gol
726 -twolevel_namespace  -umbrella  -undefined @gol
727 -unexported_symbols_list  -weak_reference_mismatches @gol
728 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
729 -mkernel -mone-byte-bool}
731 @emph{DEC Alpha Options}
732 @gccoptlist{-mno-fp-regs  -msoft-float @gol
733 -mieee  -mieee-with-inexact  -mieee-conformant @gol
734 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
735 -mtrap-precision=@var{mode}  -mbuild-constants @gol
736 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
737 -mbwx  -mmax  -mfix  -mcix @gol
738 -mfloat-vax  -mfloat-ieee @gol
739 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
740 -msmall-text  -mlarge-text @gol
741 -mmemory-latency=@var{time}}
743 @emph{FR30 Options}
744 @gccoptlist{-msmall-model -mno-lsim}
746 @emph{FT32 Options}
747 @gccoptlist{-msim -mlra -mnodiv}
749 @emph{FRV Options}
750 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
751 -mhard-float  -msoft-float @gol
752 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
753 -mdouble  -mno-double @gol
754 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
755 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
756 -mlinked-fp  -mlong-calls  -malign-labels @gol
757 -mlibrary-pic  -macc-4  -macc-8 @gol
758 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
759 -moptimize-membar -mno-optimize-membar @gol
760 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
761 -mvliw-branch  -mno-vliw-branch @gol
762 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
763 -mno-nested-cond-exec  -mtomcat-stats @gol
764 -mTLS -mtls @gol
765 -mcpu=@var{cpu}}
767 @emph{GNU/Linux Options}
768 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
769 -tno-android-cc -tno-android-ld}
771 @emph{H8/300 Options}
772 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
774 @emph{HPPA Options}
775 @gccoptlist{-march=@var{architecture-type} @gol
776 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
777 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
778 -mfixed-range=@var{register-range} @gol
779 -mjump-in-delay -mlinker-opt -mlong-calls @gol
780 -mlong-load-store  -mno-disable-fpregs @gol
781 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
782 -mno-jump-in-delay  -mno-long-load-store @gol
783 -mno-portable-runtime  -mno-soft-float @gol
784 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
785 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
786 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
787 -munix=@var{unix-std}  -nolibdld  -static  -threads}
789 @emph{IA-64 Options}
790 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
791 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
792 -mconstant-gp  -mauto-pic  -mfused-madd @gol
793 -minline-float-divide-min-latency @gol
794 -minline-float-divide-max-throughput @gol
795 -mno-inline-float-divide @gol
796 -minline-int-divide-min-latency @gol
797 -minline-int-divide-max-throughput  @gol
798 -mno-inline-int-divide @gol
799 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
800 -mno-inline-sqrt @gol
801 -mdwarf2-asm -mearly-stop-bits @gol
802 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
803 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
804 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
805 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
806 -msched-spec-ldc -msched-spec-control-ldc @gol
807 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
808 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
809 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
810 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
812 @emph{LM32 Options}
813 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
814 -msign-extend-enabled -muser-enabled}
816 @emph{M32R/D Options}
817 @gccoptlist{-m32r2 -m32rx -m32r @gol
818 -mdebug @gol
819 -malign-loops -mno-align-loops @gol
820 -missue-rate=@var{number} @gol
821 -mbranch-cost=@var{number} @gol
822 -mmodel=@var{code-size-model-type} @gol
823 -msdata=@var{sdata-type} @gol
824 -mno-flush-func -mflush-func=@var{name} @gol
825 -mno-flush-trap -mflush-trap=@var{number} @gol
826 -G @var{num}}
828 @emph{M32C Options}
829 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
831 @emph{M680x0 Options}
832 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
833 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
834 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
835 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
836 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
837 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
838 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
839 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
840 -mxgot -mno-xgot}
842 @emph{MCore Options}
843 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
844 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
845 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
846 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
847 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
849 @emph{MeP Options}
850 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
851 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
852 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
853 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
854 -mtiny=@var{n}}
856 @emph{MicroBlaze Options}
857 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
858 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
859 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
860 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
861 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
863 @emph{MIPS Options}
864 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
865 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
866 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
867 -mips16  -mno-mips16  -mflip-mips16 @gol
868 -minterlink-compressed -mno-interlink-compressed @gol
869 -minterlink-mips16  -mno-interlink-mips16 @gol
870 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
871 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
872 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
873 -mno-float  -msingle-float  -mdouble-float @gol
874 -modd-spreg -mno-odd-spreg @gol
875 -mabs=@var{mode}  -mnan=@var{encoding} @gol
876 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
877 -mmcu -mmno-mcu @gol
878 -meva -mno-eva @gol
879 -mvirt -mno-virt @gol
880 -mxpa -mno-xpa @gol
881 -mmicromips -mno-micromips @gol
882 -mmsa -mno-msa @gol
883 -mfpu=@var{fpu-type} @gol
884 -msmartmips  -mno-smartmips @gol
885 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
886 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
887 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
888 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
889 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
890 -membedded-data  -mno-embedded-data @gol
891 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
892 -mcode-readable=@var{setting} @gol
893 -msplit-addresses  -mno-split-addresses @gol
894 -mexplicit-relocs  -mno-explicit-relocs @gol
895 -mcheck-zero-division  -mno-check-zero-division @gol
896 -mdivide-traps  -mdivide-breaks @gol
897 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
898 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
899 -mfix-24k -mno-fix-24k @gol
900 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
901 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
902 -mfix-vr4120  -mno-fix-vr4120 @gol
903 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
904 -mflush-func=@var{func}  -mno-flush-func @gol
905 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
906 -mcompact-branches=@var{policy} @gol
907 -mfp-exceptions -mno-fp-exceptions @gol
908 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
909 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address @gol
910 -mframe-header-opt -mno-frame-header-opt}
912 @emph{MMIX Options}
913 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
914 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
915 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
916 -mno-base-addresses  -msingle-exit  -mno-single-exit}
918 @emph{MN10300 Options}
919 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
920 -mno-am33 -mam33 -mam33-2 -mam34 @gol
921 -mtune=@var{cpu-type} @gol
922 -mreturn-pointer-on-d0 @gol
923 -mno-crt0  -mrelax -mliw -msetlb}
925 @emph{Moxie Options}
926 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
928 @emph{MSP430 Options}
929 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
930 -mwarn-mcu @gol
931 -mcode-region= -mdata-region= @gol
932 -msilicon-errata= -msilicon-errata-warn= @gol
933 -mhwmult= -minrt}
935 @emph{NDS32 Options}
936 @gccoptlist{-mbig-endian -mlittle-endian @gol
937 -mreduced-regs -mfull-regs @gol
938 -mcmov -mno-cmov @gol
939 -mperf-ext -mno-perf-ext @gol
940 -mv3push -mno-v3push @gol
941 -m16bit -mno-16bit @gol
942 -misr-vector-size=@var{num} @gol
943 -mcache-block-size=@var{num} @gol
944 -march=@var{arch} @gol
945 -mcmodel=@var{code-model} @gol
946 -mctor-dtor -mrelax}
948 @emph{Nios II Options}
949 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
950 -mel -meb @gol
951 -mno-bypass-cache -mbypass-cache @gol
952 -mno-cache-volatile -mcache-volatile @gol
953 -mno-fast-sw-div -mfast-sw-div @gol
954 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
955 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
956 -mcustom-fpu-cfg=@var{name} @gol
957 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
958 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
960 @emph{Nvidia PTX Options}
961 @gccoptlist{-m32 -m64 -mmainkernel -moptimize}
963 @emph{PDP-11 Options}
964 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
965 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
966 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
967 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
968 -mbranch-expensive  -mbranch-cheap @gol
969 -munix-asm  -mdec-asm}
971 @emph{picoChip Options}
972 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
973 -msymbol-as-address -mno-inefficient-warnings}
975 @emph{PowerPC Options}
976 See RS/6000 and PowerPC Options.
978 @emph{RL78 Options}
979 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
980 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
981 -m64bit-doubles -m32bit-doubles -msave-mduc-in-interrupts}
983 @emph{RS/6000 and PowerPC Options}
984 @gccoptlist{-mcpu=@var{cpu-type} @gol
985 -mtune=@var{cpu-type} @gol
986 -mcmodel=@var{code-model} @gol
987 -mpowerpc64 @gol
988 -maltivec  -mno-altivec @gol
989 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
990 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
991 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
992 -mfprnd  -mno-fprnd @gol
993 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
994 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
995 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
996 -malign-power  -malign-natural @gol
997 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
998 -msingle-float -mdouble-float -msimple-fpu @gol
999 -mstring  -mno-string  -mupdate  -mno-update @gol
1000 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1001 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1002 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1003 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1004 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1005 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
1006 -mprioritize-restricted-insns=@var{priority} @gol
1007 -msched-costly-dep=@var{dependence_type} @gol
1008 -minsert-sched-nops=@var{scheme} @gol
1009 -mcall-sysv  -mcall-netbsd @gol
1010 -maix-struct-return  -msvr4-struct-return @gol
1011 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
1012 -mblock-move-inline-limit=@var{num} @gol
1013 -misel -mno-isel @gol
1014 -misel=yes  -misel=no @gol
1015 -mspe -mno-spe @gol
1016 -mspe=yes  -mspe=no @gol
1017 -mpaired @gol
1018 -mgen-cell-microcode -mwarn-cell-microcode @gol
1019 -mvrsave -mno-vrsave @gol
1020 -mmulhw -mno-mulhw @gol
1021 -mdlmzb -mno-dlmzb @gol
1022 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
1023 -mprototype  -mno-prototype @gol
1024 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1025 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
1026 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
1027 -mno-recip-precision @gol
1028 -mveclibabi=@var{type} -mfriz -mno-friz @gol
1029 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
1030 -msave-toc-indirect -mno-save-toc-indirect @gol
1031 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
1032 -mcrypto -mno-crypto -mhtm -mno-htm -mdirect-move -mno-direct-move @gol
1033 -mquad-memory -mno-quad-memory @gol
1034 -mquad-memory-atomic -mno-quad-memory-atomic @gol
1035 -mcompat-align-parm -mno-compat-align-parm @gol
1036 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
1037 -mupper-regs-di -mno-upper-regs-di @gol
1038 -mupper-regs -mno-upper-regs @gol
1039 -mfloat128 -mno-float128 -mfloat128-hardware -mno-float128-hardware @gol
1040 -mgnu-attribute -mno-gnu-attribute @gol
1041 -mlra -mno-lra}
1043 @emph{RX Options}
1044 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1045 -mcpu=@gol
1046 -mbig-endian-data -mlittle-endian-data @gol
1047 -msmall-data @gol
1048 -msim  -mno-sim@gol
1049 -mas100-syntax -mno-as100-syntax@gol
1050 -mrelax@gol
1051 -mmax-constant-size=@gol
1052 -mint-register=@gol
1053 -mpid@gol
1054 -mallow-string-insns -mno-allow-string-insns@gol
1055 -mjsr@gol
1056 -mno-warn-multiple-fast-interrupts@gol
1057 -msave-acc-in-interrupts}
1059 @emph{S/390 and zSeries Options}
1060 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1061 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
1062 -mlong-double-64 -mlong-double-128 @gol
1063 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
1064 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
1065 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1066 -mhtm -mvx -mzvector @gol
1067 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1068 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
1069 -mhotpatch=@var{halfwords},@var{halfwords}}
1071 @emph{Score Options}
1072 @gccoptlist{-meb -mel @gol
1073 -mnhwloop @gol
1074 -muls @gol
1075 -mmac @gol
1076 -mscore5 -mscore5u -mscore7 -mscore7d}
1078 @emph{SH Options}
1079 @gccoptlist{-m1  -m2  -m2e @gol
1080 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
1081 -m3  -m3e @gol
1082 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1083 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
1084 -mb  -ml  -mdalign  -mrelax @gol
1085 -mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave @gol
1086 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
1087 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
1088 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
1089 -maccumulate-outgoing-args @gol
1090 -matomic-model=@var{atomic-model} @gol
1091 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
1092 -mcbranch-force-delay-slot @gol
1093 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1094 -mpretend-cmove -mtas}
1096 @emph{Solaris 2 Options}
1097 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1098 -pthreads -pthread}
1100 @emph{SPARC Options}
1101 @gccoptlist{-mcpu=@var{cpu-type} @gol
1102 -mtune=@var{cpu-type} @gol
1103 -mcmodel=@var{code-model} @gol
1104 -mmemory-model=@var{mem-model} @gol
1105 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1106 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1107 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1108 -mhard-quad-float  -msoft-quad-float @gol
1109 -mstack-bias  -mno-stack-bias @gol
1110 -mstd-struct-return  -mno-std-struct-return @gol
1111 -munaligned-doubles  -mno-unaligned-doubles @gol
1112 -muser-mode  -mno-user-mode @gol
1113 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1114 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1115 -mcbcond -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1116 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1117 -mfix-at697f -mfix-ut699 @gol
1118 -mlra -mno-lra}
1120 @emph{SPU Options}
1121 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1122 -msafe-dma -munsafe-dma @gol
1123 -mbranch-hints @gol
1124 -msmall-mem -mlarge-mem -mstdmain @gol
1125 -mfixed-range=@var{register-range} @gol
1126 -mea32 -mea64 @gol
1127 -maddress-space-conversion -mno-address-space-conversion @gol
1128 -mcache-size=@var{cache-size} @gol
1129 -matomic-updates -mno-atomic-updates}
1131 @emph{System V Options}
1132 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1134 @emph{TILE-Gx Options}
1135 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1136 -mcmodel=@var{code-model}}
1138 @emph{TILEPro Options}
1139 @gccoptlist{-mcpu=@var{cpu} -m32}
1141 @emph{V850 Options}
1142 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1143 -mprolog-function  -mno-prolog-function  -mspace @gol
1144 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1145 -mapp-regs  -mno-app-regs @gol
1146 -mdisable-callt  -mno-disable-callt @gol
1147 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1148 -mv850e -mv850 -mv850e3v5 @gol
1149 -mloop @gol
1150 -mrelax @gol
1151 -mlong-jumps @gol
1152 -msoft-float @gol
1153 -mhard-float @gol
1154 -mgcc-abi @gol
1155 -mrh850-abi @gol
1156 -mbig-switch}
1158 @emph{VAX Options}
1159 @gccoptlist{-mg  -mgnu  -munix}
1161 @emph{Visium Options}
1162 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1163 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1165 @emph{VMS Options}
1166 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1167 -mpointer-size=@var{size}}
1169 @emph{VxWorks Options}
1170 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1171 -Xbind-lazy  -Xbind-now}
1173 @emph{x86 Options}
1174 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1175 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1176 -mfpmath=@var{unit} @gol
1177 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1178 -mno-fp-ret-in-387 -m80387 -mhard-float -msoft-float @gol
1179 -mno-wide-multiply  -mrtd  -malign-double @gol
1180 -mpreferred-stack-boundary=@var{num} @gol
1181 -mincoming-stack-boundary=@var{num} @gol
1182 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1183 -mrecip -mrecip=@var{opt} @gol
1184 -mvzeroupper -mprefer-avx128 @gol
1185 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1186 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl @gol
1187 -mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes @gol
1188 -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
1189 -mprefetchwt1 -mclflushopt -mxsavec -mxsaves @gol
1190 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1191 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mclzero
1192 -mpku -mthreads @gol
1193 -mms-bitfields -mno-align-stringops  -minline-all-stringops @gol
1194 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1195 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1196 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1197 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1198 -mregparm=@var{num}  -msseregparm @gol
1199 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1200 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1201 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1202 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1203 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1204 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1205 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1206 -malign-data=@var{type} -mstack-protector-guard=@var{guard} @gol
1207 -mmitigate-rop -mgeneral-regs-only}
1209 @emph{x86 Windows Options}
1210 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1211 -mnop-fun-dllimport -mthread @gol
1212 -municode -mwin32 -mwindows -fno-set-stack-executable}
1214 @emph{Xstormy16 Options}
1215 @gccoptlist{-msim}
1217 @emph{Xtensa Options}
1218 @gccoptlist{-mconst16 -mno-const16 @gol
1219 -mfused-madd  -mno-fused-madd @gol
1220 -mforce-no-pic @gol
1221 -mserialize-volatile  -mno-serialize-volatile @gol
1222 -mtext-section-literals  -mno-text-section-literals @gol
1223 -mauto-litpools  -mno-auto-litpools @gol
1224 -mtarget-align  -mno-target-align @gol
1225 -mlongcalls  -mno-longcalls}
1227 @emph{zSeries Options}
1228 See S/390 and zSeries Options.
1229 @end table
1232 @node Overall Options
1233 @section Options Controlling the Kind of Output
1235 Compilation can involve up to four stages: preprocessing, compilation
1236 proper, assembly and linking, always in that order.  GCC is capable of
1237 preprocessing and compiling several files either into several
1238 assembler input files, or into one assembler input file; then each
1239 assembler input file produces an object file, and linking combines all
1240 the object files (those newly compiled, and those specified as input)
1241 into an executable file.
1243 @cindex file name suffix
1244 For any given input file, the file name suffix determines what kind of
1245 compilation is done:
1247 @table @gcctabopt
1248 @item @var{file}.c
1249 C source code that must be preprocessed.
1251 @item @var{file}.i
1252 C source code that should not be preprocessed.
1254 @item @var{file}.ii
1255 C++ source code that should not be preprocessed.
1257 @item @var{file}.m
1258 Objective-C source code.  Note that you must link with the @file{libobjc}
1259 library to make an Objective-C program work.
1261 @item @var{file}.mi
1262 Objective-C source code that should not be preprocessed.
1264 @item @var{file}.mm
1265 @itemx @var{file}.M
1266 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1267 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1268 to a literal capital M@.
1270 @item @var{file}.mii
1271 Objective-C++ source code that should not be preprocessed.
1273 @item @var{file}.h
1274 C, C++, Objective-C or Objective-C++ header file to be turned into a
1275 precompiled header (default), or C, C++ header file to be turned into an
1276 Ada spec (via the @option{-fdump-ada-spec} switch).
1278 @item @var{file}.cc
1279 @itemx @var{file}.cp
1280 @itemx @var{file}.cxx
1281 @itemx @var{file}.cpp
1282 @itemx @var{file}.CPP
1283 @itemx @var{file}.c++
1284 @itemx @var{file}.C
1285 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1286 the last two letters must both be literally @samp{x}.  Likewise,
1287 @samp{.C} refers to a literal capital C@.
1289 @item @var{file}.mm
1290 @itemx @var{file}.M
1291 Objective-C++ source code that must be preprocessed.
1293 @item @var{file}.mii
1294 Objective-C++ source code that should not be preprocessed.
1296 @item @var{file}.hh
1297 @itemx @var{file}.H
1298 @itemx @var{file}.hp
1299 @itemx @var{file}.hxx
1300 @itemx @var{file}.hpp
1301 @itemx @var{file}.HPP
1302 @itemx @var{file}.h++
1303 @itemx @var{file}.tcc
1304 C++ header file to be turned into a precompiled header or Ada spec.
1306 @item @var{file}.f
1307 @itemx @var{file}.for
1308 @itemx @var{file}.ftn
1309 Fixed form Fortran source code that should not be preprocessed.
1311 @item @var{file}.F
1312 @itemx @var{file}.FOR
1313 @itemx @var{file}.fpp
1314 @itemx @var{file}.FPP
1315 @itemx @var{file}.FTN
1316 Fixed form Fortran source code that must be preprocessed (with the traditional
1317 preprocessor).
1319 @item @var{file}.f90
1320 @itemx @var{file}.f95
1321 @itemx @var{file}.f03
1322 @itemx @var{file}.f08
1323 Free form Fortran source code that should not be preprocessed.
1325 @item @var{file}.F90
1326 @itemx @var{file}.F95
1327 @itemx @var{file}.F03
1328 @itemx @var{file}.F08
1329 Free form Fortran source code that must be preprocessed (with the
1330 traditional preprocessor).
1332 @item @var{file}.go
1333 Go source code.
1335 @item @var{file}.ads
1336 Ada source code file that contains a library unit declaration (a
1337 declaration of a package, subprogram, or generic, or a generic
1338 instantiation), or a library unit renaming declaration (a package,
1339 generic, or subprogram renaming declaration).  Such files are also
1340 called @dfn{specs}.
1342 @item @var{file}.adb
1343 Ada source code file containing a library unit body (a subprogram or
1344 package body).  Such files are also called @dfn{bodies}.
1346 @c GCC also knows about some suffixes for languages not yet included:
1347 @c Pascal:
1348 @c @var{file}.p
1349 @c @var{file}.pas
1350 @c Ratfor:
1351 @c @var{file}.r
1353 @item @var{file}.s
1354 Assembler code.
1356 @item @var{file}.S
1357 @itemx @var{file}.sx
1358 Assembler code that must be preprocessed.
1360 @item @var{other}
1361 An object file to be fed straight into linking.
1362 Any file name with no recognized suffix is treated this way.
1363 @end table
1365 @opindex x
1366 You can specify the input language explicitly with the @option{-x} option:
1368 @table @gcctabopt
1369 @item -x @var{language}
1370 Specify explicitly the @var{language} for the following input files
1371 (rather than letting the compiler choose a default based on the file
1372 name suffix).  This option applies to all following input files until
1373 the next @option{-x} option.  Possible values for @var{language} are:
1374 @smallexample
1375 c  c-header  cpp-output
1376 c++  c++-header  c++-cpp-output
1377 objective-c  objective-c-header  objective-c-cpp-output
1378 objective-c++ objective-c++-header objective-c++-cpp-output
1379 assembler  assembler-with-cpp
1381 f77  f77-cpp-input f95  f95-cpp-input
1383 @end smallexample
1385 @item -x none
1386 Turn off any specification of a language, so that subsequent files are
1387 handled according to their file name suffixes (as they are if @option{-x}
1388 has not been used at all).
1389 @end table
1391 If you only want some of the stages of compilation, you can use
1392 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1393 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1394 @command{gcc} is to stop.  Note that some combinations (for example,
1395 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1397 @table @gcctabopt
1398 @item -c
1399 @opindex c
1400 Compile or assemble the source files, but do not link.  The linking
1401 stage simply is not done.  The ultimate output is in the form of an
1402 object file for each source file.
1404 By default, the object file name for a source file is made by replacing
1405 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1407 Unrecognized input files, not requiring compilation or assembly, are
1408 ignored.
1410 @item -S
1411 @opindex S
1412 Stop after the stage of compilation proper; do not assemble.  The output
1413 is in the form of an assembler code file for each non-assembler input
1414 file specified.
1416 By default, the assembler file name for a source file is made by
1417 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1419 Input files that don't require compilation are ignored.
1421 @item -E
1422 @opindex E
1423 Stop after the preprocessing stage; do not run the compiler proper.  The
1424 output is in the form of preprocessed source code, which is sent to the
1425 standard output.
1427 Input files that don't require preprocessing are ignored.
1429 @cindex output file option
1430 @item -o @var{file}
1431 @opindex o
1432 Place output in file @var{file}.  This applies to whatever
1433 sort of output is being produced, whether it be an executable file,
1434 an object file, an assembler file or preprocessed C code.
1436 If @option{-o} is not specified, the default is to put an executable
1437 file in @file{a.out}, the object file for
1438 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1439 assembler file in @file{@var{source}.s}, a precompiled header file in
1440 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1441 standard output.
1443 @item -v
1444 @opindex v
1445 Print (on standard error output) the commands executed to run the stages
1446 of compilation.  Also print the version number of the compiler driver
1447 program and of the preprocessor and the compiler proper.
1449 @item -###
1450 @opindex ###
1451 Like @option{-v} except the commands are not executed and arguments
1452 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1453 This is useful for shell scripts to capture the driver-generated command lines.
1455 @item --help
1456 @opindex help
1457 Print (on the standard output) a description of the command-line options
1458 understood by @command{gcc}.  If the @option{-v} option is also specified
1459 then @option{--help} is also passed on to the various processes
1460 invoked by @command{gcc}, so that they can display the command-line options
1461 they accept.  If the @option{-Wextra} option has also been specified
1462 (prior to the @option{--help} option), then command-line options that
1463 have no documentation associated with them are also displayed.
1465 @item --target-help
1466 @opindex target-help
1467 Print (on the standard output) a description of target-specific command-line
1468 options for each tool.  For some targets extra target-specific
1469 information may also be printed.
1471 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1472 Print (on the standard output) a description of the command-line
1473 options understood by the compiler that fit into all specified classes
1474 and qualifiers.  These are the supported classes:
1476 @table @asis
1477 @item @samp{optimizers}
1478 Display all of the optimization options supported by the
1479 compiler.
1481 @item @samp{warnings}
1482 Display all of the options controlling warning messages
1483 produced by the compiler.
1485 @item @samp{target}
1486 Display target-specific options.  Unlike the
1487 @option{--target-help} option however, target-specific options of the
1488 linker and assembler are not displayed.  This is because those
1489 tools do not currently support the extended @option{--help=} syntax.
1491 @item @samp{params}
1492 Display the values recognized by the @option{--param}
1493 option.
1495 @item @var{language}
1496 Display the options supported for @var{language}, where
1497 @var{language} is the name of one of the languages supported in this
1498 version of GCC@.
1500 @item @samp{common}
1501 Display the options that are common to all languages.
1502 @end table
1504 These are the supported qualifiers:
1506 @table @asis
1507 @item @samp{undocumented}
1508 Display only those options that are undocumented.
1510 @item @samp{joined}
1511 Display options taking an argument that appears after an equal
1512 sign in the same continuous piece of text, such as:
1513 @samp{--help=target}.
1515 @item @samp{separate}
1516 Display options taking an argument that appears as a separate word
1517 following the original option, such as: @samp{-o output-file}.
1518 @end table
1520 Thus for example to display all the undocumented target-specific
1521 switches supported by the compiler, use:
1523 @smallexample
1524 --help=target,undocumented
1525 @end smallexample
1527 The sense of a qualifier can be inverted by prefixing it with the
1528 @samp{^} character, so for example to display all binary warning
1529 options (i.e., ones that are either on or off and that do not take an
1530 argument) that have a description, use:
1532 @smallexample
1533 --help=warnings,^joined,^undocumented
1534 @end smallexample
1536 The argument to @option{--help=} should not consist solely of inverted
1537 qualifiers.
1539 Combining several classes is possible, although this usually
1540 restricts the output so much that there is nothing to display.  One
1541 case where it does work, however, is when one of the classes is
1542 @var{target}.  For example, to display all the target-specific
1543 optimization options, use:
1545 @smallexample
1546 --help=target,optimizers
1547 @end smallexample
1549 The @option{--help=} option can be repeated on the command line.  Each
1550 successive use displays its requested class of options, skipping
1551 those that have already been displayed.
1553 If the @option{-Q} option appears on the command line before the
1554 @option{--help=} option, then the descriptive text displayed by
1555 @option{--help=} is changed.  Instead of describing the displayed
1556 options, an indication is given as to whether the option is enabled,
1557 disabled or set to a specific value (assuming that the compiler
1558 knows this at the point where the @option{--help=} option is used).
1560 Here is a truncated example from the ARM port of @command{gcc}:
1562 @smallexample
1563   % gcc -Q -mabi=2 --help=target -c
1564   The following options are target specific:
1565   -mabi=                                2
1566   -mabort-on-noreturn                   [disabled]
1567   -mapcs                                [disabled]
1568 @end smallexample
1570 The output is sensitive to the effects of previous command-line
1571 options, so for example it is possible to find out which optimizations
1572 are enabled at @option{-O2} by using:
1574 @smallexample
1575 -Q -O2 --help=optimizers
1576 @end smallexample
1578 Alternatively you can discover which binary optimizations are enabled
1579 by @option{-O3} by using:
1581 @smallexample
1582 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1583 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1584 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1585 @end smallexample
1587 @item --version
1588 @opindex version
1589 Display the version number and copyrights of the invoked GCC@.
1591 @item -pass-exit-codes
1592 @opindex pass-exit-codes
1593 Normally the @command{gcc} program exits with the code of 1 if any
1594 phase of the compiler returns a non-success return code.  If you specify
1595 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1596 the numerically highest error produced by any phase returning an error
1597 indication.  The C, C++, and Fortran front ends return 4 if an internal
1598 compiler error is encountered.
1600 @item -pipe
1601 @opindex pipe
1602 Use pipes rather than temporary files for communication between the
1603 various stages of compilation.  This fails to work on some systems where
1604 the assembler is unable to read from a pipe; but the GNU assembler has
1605 no trouble.
1607 @item -specs=@var{file}
1608 @opindex specs
1609 Process @var{file} after the compiler reads in the standard @file{specs}
1610 file, in order to override the defaults which the @command{gcc} driver
1611 program uses when determining what switches to pass to @command{cc1},
1612 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1613 @option{-specs=@var{file}} can be specified on the command line, and they
1614 are processed in order, from left to right.  @xref{Spec Files}, for
1615 information about the format of the @var{file}.
1617 @item -wrapper
1618 @opindex wrapper
1619 Invoke all subcommands under a wrapper program.  The name of the
1620 wrapper program and its parameters are passed as a comma separated
1621 list.
1623 @smallexample
1624 gcc -c t.c -wrapper gdb,--args
1625 @end smallexample
1627 @noindent
1628 This invokes all subprograms of @command{gcc} under
1629 @samp{gdb --args}, thus the invocation of @command{cc1} is
1630 @samp{gdb --args cc1 @dots{}}.
1632 @item -fplugin=@var{name}.so
1633 @opindex fplugin
1634 Load the plugin code in file @var{name}.so, assumed to be a
1635 shared object to be dlopen'd by the compiler.  The base name of
1636 the shared object file is used to identify the plugin for the
1637 purposes of argument parsing (See
1638 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1639 Each plugin should define the callback functions specified in the
1640 Plugins API.
1642 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1643 @opindex fplugin-arg
1644 Define an argument called @var{key} with a value of @var{value}
1645 for the plugin called @var{name}.
1647 @item -fdump-ada-spec@r{[}-slim@r{]}
1648 @opindex fdump-ada-spec
1649 For C and C++ source and include files, generate corresponding Ada specs.
1650 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1651 GNAT User's Guide}, which provides detailed documentation on this feature.
1653 @item -fada-spec-parent=@var{unit}
1654 @opindex fada-spec-parent
1655 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1656 Ada specs as child units of parent @var{unit}.
1658 @item -fdump-go-spec=@var{file}
1659 @opindex fdump-go-spec
1660 For input files in any language, generate corresponding Go
1661 declarations in @var{file}.  This generates Go @code{const},
1662 @code{type}, @code{var}, and @code{func} declarations which may be a
1663 useful way to start writing a Go interface to code written in some
1664 other language.
1666 @include @value{srcdir}/../libiberty/at-file.texi
1667 @end table
1669 @node Invoking G++
1670 @section Compiling C++ Programs
1672 @cindex suffixes for C++ source
1673 @cindex C++ source file suffixes
1674 C++ source files conventionally use one of the suffixes @samp{.C},
1675 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1676 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1677 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1678 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1679 files with these names and compiles them as C++ programs even if you
1680 call the compiler the same way as for compiling C programs (usually
1681 with the name @command{gcc}).
1683 @findex g++
1684 @findex c++
1685 However, the use of @command{gcc} does not add the C++ library.
1686 @command{g++} is a program that calls GCC and automatically specifies linking
1687 against the C++ library.  It treats @samp{.c},
1688 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1689 files unless @option{-x} is used.  This program is also useful when
1690 precompiling a C header file with a @samp{.h} extension for use in C++
1691 compilations.  On many systems, @command{g++} is also installed with
1692 the name @command{c++}.
1694 @cindex invoking @command{g++}
1695 When you compile C++ programs, you may specify many of the same
1696 command-line options that you use for compiling programs in any
1697 language; or command-line options meaningful for C and related
1698 languages; or options that are meaningful only for C++ programs.
1699 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1700 explanations of options for languages related to C@.
1701 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1702 explanations of options that are meaningful only for C++ programs.
1704 @node C Dialect Options
1705 @section Options Controlling C Dialect
1706 @cindex dialect options
1707 @cindex language dialect options
1708 @cindex options, dialect
1710 The following options control the dialect of C (or languages derived
1711 from C, such as C++, Objective-C and Objective-C++) that the compiler
1712 accepts:
1714 @table @gcctabopt
1715 @cindex ANSI support
1716 @cindex ISO support
1717 @item -ansi
1718 @opindex ansi
1719 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1720 equivalent to @option{-std=c++98}.
1722 This turns off certain features of GCC that are incompatible with ISO
1723 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1724 such as the @code{asm} and @code{typeof} keywords, and
1725 predefined macros such as @code{unix} and @code{vax} that identify the
1726 type of system you are using.  It also enables the undesirable and
1727 rarely used ISO trigraph feature.  For the C compiler,
1728 it disables recognition of C++ style @samp{//} comments as well as
1729 the @code{inline} keyword.
1731 The alternate keywords @code{__asm__}, @code{__extension__},
1732 @code{__inline__} and @code{__typeof__} continue to work despite
1733 @option{-ansi}.  You would not want to use them in an ISO C program, of
1734 course, but it is useful to put them in header files that might be included
1735 in compilations done with @option{-ansi}.  Alternate predefined macros
1736 such as @code{__unix__} and @code{__vax__} are also available, with or
1737 without @option{-ansi}.
1739 The @option{-ansi} option does not cause non-ISO programs to be
1740 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1741 addition to @option{-ansi}.  @xref{Warning Options}.
1743 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1744 option is used.  Some header files may notice this macro and refrain
1745 from declaring certain functions or defining certain macros that the
1746 ISO standard doesn't call for; this is to avoid interfering with any
1747 programs that might use these names for other things.
1749 Functions that are normally built in but do not have semantics
1750 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1751 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1752 built-in functions provided by GCC}, for details of the functions
1753 affected.
1755 @item -std=
1756 @opindex std
1757 Determine the language standard. @xref{Standards,,Language Standards
1758 Supported by GCC}, for details of these standard versions.  This option
1759 is currently only supported when compiling C or C++.
1761 The compiler can accept several base standards, such as @samp{c90} or
1762 @samp{c++98}, and GNU dialects of those standards, such as
1763 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1764 compiler accepts all programs following that standard plus those
1765 using GNU extensions that do not contradict it.  For example,
1766 @option{-std=c90} turns off certain features of GCC that are
1767 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1768 keywords, but not other GNU extensions that do not have a meaning in
1769 ISO C90, such as omitting the middle term of a @code{?:}
1770 expression. On the other hand, when a GNU dialect of a standard is
1771 specified, all features supported by the compiler are enabled, even when
1772 those features change the meaning of the base standard.  As a result, some
1773 strict-conforming programs may be rejected.  The particular standard
1774 is used by @option{-Wpedantic} to identify which features are GNU
1775 extensions given that version of the standard. For example
1776 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1777 comments, while @option{-std=gnu99 -Wpedantic} does not.
1779 A value for this option must be provided; possible values are
1781 @table @samp
1782 @item c90
1783 @itemx c89
1784 @itemx iso9899:1990
1785 Support all ISO C90 programs (certain GNU extensions that conflict
1786 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1788 @item iso9899:199409
1789 ISO C90 as modified in amendment 1.
1791 @item c99
1792 @itemx c9x
1793 @itemx iso9899:1999
1794 @itemx iso9899:199x
1795 ISO C99.  This standard is substantially completely supported, modulo
1796 bugs and floating-point issues
1797 (mainly but not entirely relating to optional C99 features from
1798 Annexes F and G).  See
1799 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1800 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1802 @item c11
1803 @itemx c1x
1804 @itemx iso9899:2011
1805 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1806 substantially completely supported, modulo bugs, floating-point issues
1807 (mainly but not entirely relating to optional C11 features from
1808 Annexes F and G) and the optional Annexes K (Bounds-checking
1809 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1811 @item gnu90
1812 @itemx gnu89
1813 GNU dialect of ISO C90 (including some C99 features).
1815 @item gnu99
1816 @itemx gnu9x
1817 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1819 @item gnu11
1820 @itemx gnu1x
1821 GNU dialect of ISO C11.  This is the default for C code.
1822 The name @samp{gnu1x} is deprecated.
1824 @item c++98
1825 @itemx c++03
1826 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1827 additional defect reports. Same as @option{-ansi} for C++ code.
1829 @item gnu++98
1830 @itemx gnu++03
1831 GNU dialect of @option{-std=c++98}.
1833 @item c++11
1834 @itemx c++0x
1835 The 2011 ISO C++ standard plus amendments.
1836 The name @samp{c++0x} is deprecated.
1838 @item gnu++11
1839 @itemx gnu++0x
1840 GNU dialect of @option{-std=c++11}.
1841 The name @samp{gnu++0x} is deprecated.
1843 @item c++14
1844 @itemx c++1y
1845 The 2014 ISO C++ standard plus amendments.
1846 The name @samp{c++1y} is deprecated.
1848 @item gnu++14
1849 @itemx gnu++1y
1850 GNU dialect of @option{-std=c++14}.
1851 This is the default for C++ code.
1852 The name @samp{gnu++1y} is deprecated.
1854 @item c++1z
1855 The next revision of the ISO C++ standard, tentatively planned for
1856 2017.  Support is highly experimental, and will almost certainly
1857 change in incompatible ways in future releases.
1859 @item gnu++1z
1860 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1861 and will almost certainly change in incompatible ways in future
1862 releases.
1863 @end table
1865 @item -fgnu89-inline
1866 @opindex fgnu89-inline
1867 The option @option{-fgnu89-inline} tells GCC to use the traditional
1868 GNU semantics for @code{inline} functions when in C99 mode.
1869 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1870 Using this option is roughly equivalent to adding the
1871 @code{gnu_inline} function attribute to all inline functions
1872 (@pxref{Function Attributes}).
1874 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1875 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1876 specifies the default behavior).
1877 This option is not supported in @option{-std=c90} or
1878 @option{-std=gnu90} mode.
1880 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1881 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1882 in effect for @code{inline} functions.  @xref{Common Predefined
1883 Macros,,,cpp,The C Preprocessor}.
1885 @item -fpermitted-flt-eval-methods=@var{style}
1886 @opindex fpermitted-flt-eval-methods
1887 @opindex fpermitted-flt-eval-methods=c11
1888 @opindex fpermitted-flt-eval-methods=ts-18661-3
1889 ISO/IEC TS 18661-3 defines new permissible values for
1890 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1891 a semantic type that is an interchange or extended format should be
1892 evaluated to the precision and range of that type.  These new values are
1893 a superset of those permitted under C99/C11, which does not specify the
1894 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1895 conforming to C11 may not have been written expecting the possibility of
1896 the new values.
1898 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1899 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1900 or the extended set of values specified in ISO/IEC TS 18661-3.
1902 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1904 The default when in a standards compliant mode (@option{-std=c11} or similar)
1905 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1906 dialect (@option{-std=gnu11} or similar) is
1907 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1909 @item -aux-info @var{filename}
1910 @opindex aux-info
1911 Output to the given filename prototyped declarations for all functions
1912 declared and/or defined in a translation unit, including those in header
1913 files.  This option is silently ignored in any language other than C@.
1915 Besides declarations, the file indicates, in comments, the origin of
1916 each declaration (source file and line), whether the declaration was
1917 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1918 @samp{O} for old, respectively, in the first character after the line
1919 number and the colon), and whether it came from a declaration or a
1920 definition (@samp{C} or @samp{F}, respectively, in the following
1921 character).  In the case of function definitions, a K&R-style list of
1922 arguments followed by their declarations is also provided, inside
1923 comments, after the declaration.
1925 @item -fallow-parameterless-variadic-functions
1926 @opindex fallow-parameterless-variadic-functions
1927 Accept variadic functions without named parameters.
1929 Although it is possible to define such a function, this is not very
1930 useful as it is not possible to read the arguments.  This is only
1931 supported for C as this construct is allowed by C++.
1933 @item -fno-asm
1934 @opindex fno-asm
1935 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1936 keyword, so that code can use these words as identifiers.  You can use
1937 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1938 instead.  @option{-ansi} implies @option{-fno-asm}.
1940 In C++, this switch only affects the @code{typeof} keyword, since
1941 @code{asm} and @code{inline} are standard keywords.  You may want to
1942 use the @option{-fno-gnu-keywords} flag instead, which has the same
1943 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1944 switch only affects the @code{asm} and @code{typeof} keywords, since
1945 @code{inline} is a standard keyword in ISO C99.
1947 @item -fno-builtin
1948 @itemx -fno-builtin-@var{function}
1949 @opindex fno-builtin
1950 @cindex built-in functions
1951 Don't recognize built-in functions that do not begin with
1952 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1953 functions provided by GCC}, for details of the functions affected,
1954 including those which are not built-in functions when @option{-ansi} or
1955 @option{-std} options for strict ISO C conformance are used because they
1956 do not have an ISO standard meaning.
1958 GCC normally generates special code to handle certain built-in functions
1959 more efficiently; for instance, calls to @code{alloca} may become single
1960 instructions which adjust the stack directly, and calls to @code{memcpy}
1961 may become inline copy loops.  The resulting code is often both smaller
1962 and faster, but since the function calls no longer appear as such, you
1963 cannot set a breakpoint on those calls, nor can you change the behavior
1964 of the functions by linking with a different library.  In addition,
1965 when a function is recognized as a built-in function, GCC may use
1966 information about that function to warn about problems with calls to
1967 that function, or to generate more efficient code, even if the
1968 resulting code still contains calls to that function.  For example,
1969 warnings are given with @option{-Wformat} for bad calls to
1970 @code{printf} when @code{printf} is built in and @code{strlen} is
1971 known not to modify global memory.
1973 With the @option{-fno-builtin-@var{function}} option
1974 only the built-in function @var{function} is
1975 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1976 function is named that is not built-in in this version of GCC, this
1977 option is ignored.  There is no corresponding
1978 @option{-fbuiltin-@var{function}} option; if you wish to enable
1979 built-in functions selectively when using @option{-fno-builtin} or
1980 @option{-ffreestanding}, you may define macros such as:
1982 @smallexample
1983 #define abs(n)          __builtin_abs ((n))
1984 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1985 @end smallexample
1987 @item -fgimple
1988 @opindex fgimple
1990 Enable parsing of function definitions marked with @code{__GIMPLE}.
1991 This is an experimental feature that allows unit testing of GIMPLE
1992 passes.
1994 @item -fhosted
1995 @opindex fhosted
1996 @cindex hosted environment
1998 Assert that compilation targets a hosted environment.  This implies
1999 @option{-fbuiltin}.  A hosted environment is one in which the
2000 entire standard library is available, and in which @code{main} has a return
2001 type of @code{int}.  Examples are nearly everything except a kernel.
2002 This is equivalent to @option{-fno-freestanding}.
2004 @item -ffreestanding
2005 @opindex ffreestanding
2006 @cindex hosted environment
2008 Assert that compilation targets a freestanding environment.  This
2009 implies @option{-fno-builtin}.  A freestanding environment
2010 is one in which the standard library may not exist, and program startup may
2011 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2012 This is equivalent to @option{-fno-hosted}.
2014 @xref{Standards,,Language Standards Supported by GCC}, for details of
2015 freestanding and hosted environments.
2017 @item -fopenacc
2018 @opindex fopenacc
2019 @cindex OpenACC accelerator programming
2020 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2021 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2022 compiler generates accelerated code according to the OpenACC Application
2023 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2024 implies @option{-pthread}, and thus is only supported on targets that
2025 have support for @option{-pthread}.
2027 @item -fopenacc-dim=@var{geom}
2028 @opindex fopenacc-dim
2029 @cindex OpenACC accelerator programming
2030 Specify default compute dimensions for parallel offload regions that do
2031 not explicitly specify.  The @var{geom} value is a triple of
2032 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2033 can be omitted, to use a target-specific default value.
2035 @item -fopenmp
2036 @opindex fopenmp
2037 @cindex OpenMP parallel
2038 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2039 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2040 compiler generates parallel code according to the OpenMP Application
2041 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
2042 implies @option{-pthread}, and thus is only supported on targets that
2043 have support for @option{-pthread}. @option{-fopenmp} implies
2044 @option{-fopenmp-simd}.
2046 @item -fopenmp-simd
2047 @opindex fopenmp-simd
2048 @cindex OpenMP SIMD
2049 @cindex SIMD
2050 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2051 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2052 are ignored.
2054 @item -fcilkplus
2055 @opindex fcilkplus
2056 @cindex Enable Cilk Plus
2057 Enable the usage of Cilk Plus language extension features for C/C++.
2058 When the option @option{-fcilkplus} is specified, enable the usage of
2059 the Cilk Plus Language extension features for C/C++.  The present
2060 implementation follows ABI version 1.2.  This is an experimental
2061 feature that is only partially complete, and whose interface may
2062 change in future versions of GCC as the official specification
2063 changes.  Currently, all features but @code{_Cilk_for} have been
2064 implemented.
2066 @item -fgnu-tm
2067 @opindex fgnu-tm
2068 When the option @option{-fgnu-tm} is specified, the compiler
2069 generates code for the Linux variant of Intel's current Transactional
2070 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2071 an experimental feature whose interface may change in future versions
2072 of GCC, as the official specification changes.  Please note that not
2073 all architectures are supported for this feature.
2075 For more information on GCC's support for transactional memory,
2076 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2077 Transactional Memory Library}.
2079 Note that the transactional memory feature is not supported with
2080 non-call exceptions (@option{-fnon-call-exceptions}).
2082 @item -fms-extensions
2083 @opindex fms-extensions
2084 Accept some non-standard constructs used in Microsoft header files.
2086 In C++ code, this allows member names in structures to be similar
2087 to previous types declarations.
2089 @smallexample
2090 typedef int UOW;
2091 struct ABC @{
2092   UOW UOW;
2094 @end smallexample
2096 Some cases of unnamed fields in structures and unions are only
2097 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2098 fields within structs/unions}, for details.
2100 Note that this option is off for all targets but x86 
2101 targets using ms-abi.
2103 @item -fplan9-extensions
2104 @opindex fplan9-extensions
2105 Accept some non-standard constructs used in Plan 9 code.
2107 This enables @option{-fms-extensions}, permits passing pointers to
2108 structures with anonymous fields to functions that expect pointers to
2109 elements of the type of the field, and permits referring to anonymous
2110 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2111 struct/union fields within structs/unions}, for details.  This is only
2112 supported for C, not C++.
2114 @item -fcond-mismatch
2115 @opindex fcond-mismatch
2116 Allow conditional expressions with mismatched types in the second and
2117 third arguments.  The value of such an expression is void.  This option
2118 is not supported for C++.
2120 @item -flax-vector-conversions
2121 @opindex flax-vector-conversions
2122 Allow implicit conversions between vectors with differing numbers of
2123 elements and/or incompatible element types.  This option should not be
2124 used for new code.
2126 @item -funsigned-char
2127 @opindex funsigned-char
2128 Let the type @code{char} be unsigned, like @code{unsigned char}.
2130 Each kind of machine has a default for what @code{char} should
2131 be.  It is either like @code{unsigned char} by default or like
2132 @code{signed char} by default.
2134 Ideally, a portable program should always use @code{signed char} or
2135 @code{unsigned char} when it depends on the signedness of an object.
2136 But many programs have been written to use plain @code{char} and
2137 expect it to be signed, or expect it to be unsigned, depending on the
2138 machines they were written for.  This option, and its inverse, let you
2139 make such a program work with the opposite default.
2141 The type @code{char} is always a distinct type from each of
2142 @code{signed char} or @code{unsigned char}, even though its behavior
2143 is always just like one of those two.
2145 @item -fsigned-char
2146 @opindex fsigned-char
2147 Let the type @code{char} be signed, like @code{signed char}.
2149 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2150 the negative form of @option{-funsigned-char}.  Likewise, the option
2151 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2153 @item -fsigned-bitfields
2154 @itemx -funsigned-bitfields
2155 @itemx -fno-signed-bitfields
2156 @itemx -fno-unsigned-bitfields
2157 @opindex fsigned-bitfields
2158 @opindex funsigned-bitfields
2159 @opindex fno-signed-bitfields
2160 @opindex fno-unsigned-bitfields
2161 These options control whether a bit-field is signed or unsigned, when the
2162 declaration does not use either @code{signed} or @code{unsigned}.  By
2163 default, such a bit-field is signed, because this is consistent: the
2164 basic integer types such as @code{int} are signed types.
2166 @item -fsso-struct=@var{endianness}
2167 @opindex fsso-struct
2168 Set the default scalar storage order of structures and unions to the
2169 specified endianness.  The accepted values are @samp{big-endian} and
2170 @samp{little-endian}.  If the option is not passed, the compiler uses
2171 the native endianness of the target.  This option is not supported for C++.
2173 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2174 code that is not binary compatible with code generated without it if the
2175 specified endianness is not the native endianness of the target.
2176 @end table
2178 @node C++ Dialect Options
2179 @section Options Controlling C++ Dialect
2181 @cindex compiler options, C++
2182 @cindex C++ options, command-line
2183 @cindex options, C++
2184 This section describes the command-line options that are only meaningful
2185 for C++ programs.  You can also use most of the GNU compiler options
2186 regardless of what language your program is in.  For example, you
2187 might compile a file @file{firstClass.C} like this:
2189 @smallexample
2190 g++ -g -fstrict-enums -O -c firstClass.C
2191 @end smallexample
2193 @noindent
2194 In this example, only @option{-fstrict-enums} is an option meant
2195 only for C++ programs; you can use the other options with any
2196 language supported by GCC@.
2198 Some options for compiling C programs, such as @option{-std}, are also
2199 relevant for C++ programs.
2200 @xref{C Dialect Options,,Options Controlling C Dialect}.
2202 Here is a list of options that are @emph{only} for compiling C++ programs:
2204 @table @gcctabopt
2206 @item -fabi-version=@var{n}
2207 @opindex fabi-version
2208 Use version @var{n} of the C++ ABI@.  The default is version 0.
2210 Version 0 refers to the version conforming most closely to
2211 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2212 will change in different versions of G++ as ABI bugs are fixed.
2214 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2216 Version 2 is the version of the C++ ABI that first appeared in G++
2217 3.4, and was the default through G++ 4.9.
2219 Version 3 corrects an error in mangling a constant address as a
2220 template argument.
2222 Version 4, which first appeared in G++ 4.5, implements a standard
2223 mangling for vector types.
2225 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2226 attribute const/volatile on function pointer types, decltype of a
2227 plain decl, and use of a function parameter in the declaration of
2228 another parameter.
2230 Version 6, which first appeared in G++ 4.7, corrects the promotion
2231 behavior of C++11 scoped enums and the mangling of template argument
2232 packs, const/static_cast, prefix ++ and --, and a class scope function
2233 used as a template argument.
2235 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2236 builtin type and corrects the mangling of lambdas in default argument
2237 scope.
2239 Version 8, which first appeared in G++ 4.9, corrects the substitution
2240 behavior of function types with function-cv-qualifiers.
2242 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2243 @code{nullptr_t}.
2245 Version 10, which first appeared in G++ 6.1, adds mangling of
2246 attributes that affect type identity, such as ia32 calling convention
2247 attributes (e.g. @samp{stdcall}).
2249 Version 11, which first appeared in G++ 7, corrects the mangling of
2250 sizeof... expressions.  It also implies
2251 @option{-fnew-inheriting-ctors}.
2253 See also @option{-Wabi}.
2255 @item -fabi-compat-version=@var{n}
2256 @opindex fabi-compat-version
2257 On targets that support strong aliases, G++
2258 works around mangling changes by creating an alias with the correct
2259 mangled name when defining a symbol with an incorrect mangled name.
2260 This switch specifies which ABI version to use for the alias.
2262 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2263 compatibility).  If another ABI version is explicitly selected, this
2264 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2265 use @option{-fabi-compat-version=2}.
2267 If this option is not provided but @option{-Wabi=@var{n}} is, that
2268 version is used for compatibility aliases.  If this option is provided
2269 along with @option{-Wabi} (without the version), the version from this
2270 option is used for the warning.
2272 @item -fno-access-control
2273 @opindex fno-access-control
2274 Turn off all access checking.  This switch is mainly useful for working
2275 around bugs in the access control code.
2277 @item -faligned-new
2278 @opindex faligned-new
2279 Enable support for C++17 @code{new} of types that require more
2280 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2281 numeric argument such as @code{-faligned-new=32} can be used to
2282 specify how much alignment (in bytes) is provided by that function,
2283 but few users will need to override the default of
2284 @code{alignof(std::max_align_t)}.
2286 @item -fcheck-new
2287 @opindex fcheck-new
2288 Check that the pointer returned by @code{operator new} is non-null
2289 before attempting to modify the storage allocated.  This check is
2290 normally unnecessary because the C++ standard specifies that
2291 @code{operator new} only returns @code{0} if it is declared
2292 @code{throw()}, in which case the compiler always checks the
2293 return value even without this option.  In all other cases, when
2294 @code{operator new} has a non-empty exception specification, memory
2295 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2296 @samp{new (nothrow)}.
2298 @item -fconcepts
2299 @opindex fconcepts
2300 Enable support for the C++ Extensions for Concepts Technical
2301 Specification, ISO 19217 (2015), which allows code like
2303 @smallexample
2304 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2305 template <Addable T> T add (T a, T b) @{ return a + b; @}
2306 @end smallexample
2308 @item -fconstexpr-depth=@var{n}
2309 @opindex fconstexpr-depth
2310 Set the maximum nested evaluation depth for C++11 constexpr functions
2311 to @var{n}.  A limit is needed to detect endless recursion during
2312 constant expression evaluation.  The minimum specified by the standard
2313 is 512.
2315 @item -fconstexpr-loop-limit=@var{n}
2316 @opindex fconstexpr-loop-limit
2317 Set the maximum number of iterations for a loop in C++14 constexpr functions
2318 to @var{n}.  A limit is needed to detect infinite loops during
2319 constant expression evaluation.  The default is 262144 (1<<18).
2321 @item -fdeduce-init-list
2322 @opindex fdeduce-init-list
2323 Enable deduction of a template type parameter as
2324 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2326 @smallexample
2327 template <class T> auto forward(T t) -> decltype (realfn (t))
2329   return realfn (t);
2332 void f()
2334   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2336 @end smallexample
2338 This deduction was implemented as a possible extension to the
2339 originally proposed semantics for the C++11 standard, but was not part
2340 of the final standard, so it is disabled by default.  This option is
2341 deprecated, and may be removed in a future version of G++.
2343 @item -ffriend-injection
2344 @opindex ffriend-injection
2345 Inject friend functions into the enclosing namespace, so that they are
2346 visible outside the scope of the class in which they are declared.
2347 Friend functions were documented to work this way in the old Annotated
2348 C++ Reference Manual.  
2349 However, in ISO C++ a friend function that is not declared
2350 in an enclosing scope can only be found using argument dependent
2351 lookup.  GCC defaults to the standard behavior.
2353 This option is for compatibility, and may be removed in a future
2354 release of G++.
2356 @item -fno-elide-constructors
2357 @opindex fno-elide-constructors
2358 The C++ standard allows an implementation to omit creating a temporary
2359 that is only used to initialize another object of the same type.
2360 Specifying this option disables that optimization, and forces G++ to
2361 call the copy constructor in all cases.  This option also causes G++
2362 to call trivial member functions which otherwise would be expanded inline.
2364 In C++17, the compiler is required to omit these temporaries, but this
2365 option still affects trivial member functions.
2367 @item -fno-enforce-eh-specs
2368 @opindex fno-enforce-eh-specs
2369 Don't generate code to check for violation of exception specifications
2370 at run time.  This option violates the C++ standard, but may be useful
2371 for reducing code size in production builds, much like defining
2372 @code{NDEBUG}.  This does not give user code permission to throw
2373 exceptions in violation of the exception specifications; the compiler
2374 still optimizes based on the specifications, so throwing an
2375 unexpected exception results in undefined behavior at run time.
2377 @item -fextern-tls-init
2378 @itemx -fno-extern-tls-init
2379 @opindex fextern-tls-init
2380 @opindex fno-extern-tls-init
2381 The C++11 and OpenMP standards allow @code{thread_local} and
2382 @code{threadprivate} variables to have dynamic (runtime)
2383 initialization.  To support this, any use of such a variable goes
2384 through a wrapper function that performs any necessary initialization.
2385 When the use and definition of the variable are in the same
2386 translation unit, this overhead can be optimized away, but when the
2387 use is in a different translation unit there is significant overhead
2388 even if the variable doesn't actually need dynamic initialization.  If
2389 the programmer can be sure that no use of the variable in a
2390 non-defining TU needs to trigger dynamic initialization (either
2391 because the variable is statically initialized, or a use of the
2392 variable in the defining TU will be executed before any uses in
2393 another TU), they can avoid this overhead with the
2394 @option{-fno-extern-tls-init} option.
2396 On targets that support symbol aliases, the default is
2397 @option{-fextern-tls-init}.  On targets that do not support symbol
2398 aliases, the default is @option{-fno-extern-tls-init}.
2400 @item -ffor-scope
2401 @itemx -fno-for-scope
2402 @opindex ffor-scope
2403 @opindex fno-for-scope
2404 If @option{-ffor-scope} is specified, the scope of variables declared in
2405 a @i{for-init-statement} is limited to the @code{for} loop itself,
2406 as specified by the C++ standard.
2407 If @option{-fno-for-scope} is specified, the scope of variables declared in
2408 a @i{for-init-statement} extends to the end of the enclosing scope,
2409 as was the case in old versions of G++, and other (traditional)
2410 implementations of C++.
2412 If neither flag is given, the default is to follow the standard,
2413 but to allow and give a warning for old-style code that would
2414 otherwise be invalid, or have different behavior.
2416 @item -fno-gnu-keywords
2417 @opindex fno-gnu-keywords
2418 Do not recognize @code{typeof} as a keyword, so that code can use this
2419 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2420 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2421 @option{-std=c++98}, @option{-std=c++11}, etc.
2423 @item -fno-implicit-templates
2424 @opindex fno-implicit-templates
2425 Never emit code for non-inline templates that are instantiated
2426 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2427 @xref{Template Instantiation}, for more information.
2429 @item -fno-implicit-inline-templates
2430 @opindex fno-implicit-inline-templates
2431 Don't emit code for implicit instantiations of inline templates, either.
2432 The default is to handle inlines differently so that compiles with and
2433 without optimization need the same set of explicit instantiations.
2435 @item -fno-implement-inlines
2436 @opindex fno-implement-inlines
2437 To save space, do not emit out-of-line copies of inline functions
2438 controlled by @code{#pragma implementation}.  This causes linker
2439 errors if these functions are not inlined everywhere they are called.
2441 @item -fms-extensions
2442 @opindex fms-extensions
2443 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2444 int and getting a pointer to member function via non-standard syntax.
2446 @item -fnew-inheriting-ctors
2447 @opindex fnew-inheriting-ctors
2448 Enable the P0136 adjustment to the semantics of C++11 constructor
2449 inheritance.  This is part of C++17 but also considered to be a Defect
2450 Report against C++11 and C++14.  This flag is enabled by default
2451 unless @option{-fabi-version=10} or lower is specified.
2453 @item -fnew-ttp-matching
2454 @opindex fnew-ttp-matching
2455 Enable the P0522 resolution to Core issue 150, template template
2456 parameters and default arguments: this allows a template with default
2457 template arguments as an argument for a template template parameter
2458 with fewer template parameters.  This flag is enabled by default for
2459 @option{-std=c++1z}.
2461 @item -fno-nonansi-builtins
2462 @opindex fno-nonansi-builtins
2463 Disable built-in declarations of functions that are not mandated by
2464 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2465 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2467 @item -fnothrow-opt
2468 @opindex fnothrow-opt
2469 Treat a @code{throw()} exception specification as if it were a
2470 @code{noexcept} specification to reduce or eliminate the text size
2471 overhead relative to a function with no exception specification.  If
2472 the function has local variables of types with non-trivial
2473 destructors, the exception specification actually makes the
2474 function smaller because the EH cleanups for those variables can be
2475 optimized away.  The semantic effect is that an exception thrown out of
2476 a function with such an exception specification results in a call
2477 to @code{terminate} rather than @code{unexpected}.
2479 @item -fno-operator-names
2480 @opindex fno-operator-names
2481 Do not treat the operator name keywords @code{and}, @code{bitand},
2482 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2483 synonyms as keywords.
2485 @item -fno-optional-diags
2486 @opindex fno-optional-diags
2487 Disable diagnostics that the standard says a compiler does not need to
2488 issue.  Currently, the only such diagnostic issued by G++ is the one for
2489 a name having multiple meanings within a class.
2491 @item -fpermissive
2492 @opindex fpermissive
2493 Downgrade some diagnostics about nonconformant code from errors to
2494 warnings.  Thus, using @option{-fpermissive} allows some
2495 nonconforming code to compile.
2497 @item -fno-pretty-templates
2498 @opindex fno-pretty-templates
2499 When an error message refers to a specialization of a function
2500 template, the compiler normally prints the signature of the
2501 template followed by the template arguments and any typedefs or
2502 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2503 rather than @code{void f(int)}) so that it's clear which template is
2504 involved.  When an error message refers to a specialization of a class
2505 template, the compiler omits any template arguments that match
2506 the default template arguments for that template.  If either of these
2507 behaviors make it harder to understand the error message rather than
2508 easier, you can use @option{-fno-pretty-templates} to disable them.
2510 @item -frepo
2511 @opindex frepo
2512 Enable automatic template instantiation at link time.  This option also
2513 implies @option{-fno-implicit-templates}.  @xref{Template
2514 Instantiation}, for more information.
2516 @item -fno-rtti
2517 @opindex fno-rtti
2518 Disable generation of information about every class with virtual
2519 functions for use by the C++ run-time type identification features
2520 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2521 of the language, you can save some space by using this flag.  Note that
2522 exception handling uses the same information, but G++ generates it as
2523 needed. The @code{dynamic_cast} operator can still be used for casts that
2524 do not require run-time type information, i.e.@: casts to @code{void *} or to
2525 unambiguous base classes.
2527 @item -fsized-deallocation
2528 @opindex fsized-deallocation
2529 Enable the built-in global declarations
2530 @smallexample
2531 void operator delete (void *, std::size_t) noexcept;
2532 void operator delete[] (void *, std::size_t) noexcept;
2533 @end smallexample
2534 as introduced in C++14.  This is useful for user-defined replacement
2535 deallocation functions that, for example, use the size of the object
2536 to make deallocation faster.  Enabled by default under
2537 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2538 warns about places that might want to add a definition.
2540 @item -fstrict-enums
2541 @opindex fstrict-enums
2542 Allow the compiler to optimize using the assumption that a value of
2543 enumerated type can only be one of the values of the enumeration (as
2544 defined in the C++ standard; basically, a value that can be
2545 represented in the minimum number of bits needed to represent all the
2546 enumerators).  This assumption may not be valid if the program uses a
2547 cast to convert an arbitrary integer value to the enumerated type.
2549 @item -fstrong-eval-order
2550 @opindex fstrong-eval-order
2551 Evaluate member access, array subscripting, and shift expressions in
2552 left-to-right order, and evaluate assignment in right-to-left order,
2553 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2554 @option{-fstrong-eval-order=some} enables just the ordering of member
2555 access and shift expressions, and is the default without
2556 @option{-std=c++1z}.
2558 @item -ftemplate-backtrace-limit=@var{n}
2559 @opindex ftemplate-backtrace-limit
2560 Set the maximum number of template instantiation notes for a single
2561 warning or error to @var{n}.  The default value is 10.
2563 @item -ftemplate-depth=@var{n}
2564 @opindex ftemplate-depth
2565 Set the maximum instantiation depth for template classes to @var{n}.
2566 A limit on the template instantiation depth is needed to detect
2567 endless recursions during template class instantiation.  ANSI/ISO C++
2568 conforming programs must not rely on a maximum depth greater than 17
2569 (changed to 1024 in C++11).  The default value is 900, as the compiler
2570 can run out of stack space before hitting 1024 in some situations.
2572 @item -fno-threadsafe-statics
2573 @opindex fno-threadsafe-statics
2574 Do not emit the extra code to use the routines specified in the C++
2575 ABI for thread-safe initialization of local statics.  You can use this
2576 option to reduce code size slightly in code that doesn't need to be
2577 thread-safe.
2579 @item -fuse-cxa-atexit
2580 @opindex fuse-cxa-atexit
2581 Register destructors for objects with static storage duration with the
2582 @code{__cxa_atexit} function rather than the @code{atexit} function.
2583 This option is required for fully standards-compliant handling of static
2584 destructors, but only works if your C library supports
2585 @code{__cxa_atexit}.
2587 @item -fno-use-cxa-get-exception-ptr
2588 @opindex fno-use-cxa-get-exception-ptr
2589 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2590 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2591 if the runtime routine is not available.
2593 @item -fvisibility-inlines-hidden
2594 @opindex fvisibility-inlines-hidden
2595 This switch declares that the user does not attempt to compare
2596 pointers to inline functions or methods where the addresses of the two functions
2597 are taken in different shared objects.
2599 The effect of this is that GCC may, effectively, mark inline methods with
2600 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2601 appear in the export table of a DSO and do not require a PLT indirection
2602 when used within the DSO@.  Enabling this option can have a dramatic effect
2603 on load and link times of a DSO as it massively reduces the size of the
2604 dynamic export table when the library makes heavy use of templates.
2606 The behavior of this switch is not quite the same as marking the
2607 methods as hidden directly, because it does not affect static variables
2608 local to the function or cause the compiler to deduce that
2609 the function is defined in only one shared object.
2611 You may mark a method as having a visibility explicitly to negate the
2612 effect of the switch for that method.  For example, if you do want to
2613 compare pointers to a particular inline method, you might mark it as
2614 having default visibility.  Marking the enclosing class with explicit
2615 visibility has no effect.
2617 Explicitly instantiated inline methods are unaffected by this option
2618 as their linkage might otherwise cross a shared library boundary.
2619 @xref{Template Instantiation}.
2621 @item -fvisibility-ms-compat
2622 @opindex fvisibility-ms-compat
2623 This flag attempts to use visibility settings to make GCC's C++
2624 linkage model compatible with that of Microsoft Visual Studio.
2626 The flag makes these changes to GCC's linkage model:
2628 @enumerate
2629 @item
2630 It sets the default visibility to @code{hidden}, like
2631 @option{-fvisibility=hidden}.
2633 @item
2634 Types, but not their members, are not hidden by default.
2636 @item
2637 The One Definition Rule is relaxed for types without explicit
2638 visibility specifications that are defined in more than one
2639 shared object: those declarations are permitted if they are
2640 permitted when this option is not used.
2641 @end enumerate
2643 In new code it is better to use @option{-fvisibility=hidden} and
2644 export those classes that are intended to be externally visible.
2645 Unfortunately it is possible for code to rely, perhaps accidentally,
2646 on the Visual Studio behavior.
2648 Among the consequences of these changes are that static data members
2649 of the same type with the same name but defined in different shared
2650 objects are different, so changing one does not change the other;
2651 and that pointers to function members defined in different shared
2652 objects may not compare equal.  When this flag is given, it is a
2653 violation of the ODR to define types with the same name differently.
2655 @item -fno-weak
2656 @opindex fno-weak
2657 Do not use weak symbol support, even if it is provided by the linker.
2658 By default, G++ uses weak symbols if they are available.  This
2659 option exists only for testing, and should not be used by end-users;
2660 it results in inferior code and has no benefits.  This option may
2661 be removed in a future release of G++.
2663 @item -nostdinc++
2664 @opindex nostdinc++
2665 Do not search for header files in the standard directories specific to
2666 C++, but do still search the other standard directories.  (This option
2667 is used when building the C++ library.)
2668 @end table
2670 In addition, these optimization, warning, and code generation options
2671 have meanings only for C++ programs:
2673 @table @gcctabopt
2674 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2675 @opindex Wabi
2676 @opindex Wno-abi
2677 Warn when G++ it generates code that is probably not compatible with
2678 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2679 ABI with each major release, normally @option{-Wabi} will warn only if
2680 there is a check added later in a release series for an ABI issue
2681 discovered since the initial release.  @option{-Wabi} will warn about
2682 more things if an older ABI version is selected (with
2683 @option{-fabi-version=@var{n}}).
2685 @option{-Wabi} can also be used with an explicit version number to
2686 warn about compatibility with a particular @option{-fabi-version}
2687 level, e.g. @option{-Wabi=2} to warn about changes relative to
2688 @option{-fabi-version=2}.
2690 If an explicit version number is provided and
2691 @option{-fabi-compat-version} is not specified, the version number
2692 from this option is used for compatibility aliases.  If no explicit
2693 version number is provided with this option, but
2694 @option{-fabi-compat-version} is specified, that version number is
2695 used for ABI warnings.
2697 Although an effort has been made to warn about
2698 all such cases, there are probably some cases that are not warned about,
2699 even though G++ is generating incompatible code.  There may also be
2700 cases where warnings are emitted even though the code that is generated
2701 is compatible.
2703 You should rewrite your code to avoid these warnings if you are
2704 concerned about the fact that code generated by G++ may not be binary
2705 compatible with code generated by other compilers.
2707 Known incompatibilities in @option{-fabi-version=2} (which was the
2708 default from GCC 3.4 to 4.9) include:
2710 @itemize @bullet
2712 @item
2713 A template with a non-type template parameter of reference type was
2714 mangled incorrectly:
2715 @smallexample
2716 extern int N;
2717 template <int &> struct S @{@};
2718 void n (S<N>) @{2@}
2719 @end smallexample
2721 This was fixed in @option{-fabi-version=3}.
2723 @item
2724 SIMD vector types declared using @code{__attribute ((vector_size))} were
2725 mangled in a non-standard way that does not allow for overloading of
2726 functions taking vectors of different sizes.
2728 The mangling was changed in @option{-fabi-version=4}.
2730 @item
2731 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2732 qualifiers, and @code{decltype} of a plain declaration was folded away.
2734 These mangling issues were fixed in @option{-fabi-version=5}.
2736 @item
2737 Scoped enumerators passed as arguments to a variadic function are
2738 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2739 On most targets this does not actually affect the parameter passing
2740 ABI, as there is no way to pass an argument smaller than @code{int}.
2742 Also, the ABI changed the mangling of template argument packs,
2743 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2744 a class scope function used as a template argument.
2746 These issues were corrected in @option{-fabi-version=6}.
2748 @item
2749 Lambdas in default argument scope were mangled incorrectly, and the
2750 ABI changed the mangling of @code{nullptr_t}.
2752 These issues were corrected in @option{-fabi-version=7}.
2754 @item
2755 When mangling a function type with function-cv-qualifiers, the
2756 un-qualified function type was incorrectly treated as a substitution
2757 candidate.
2759 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2761 @item
2762 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2763 unaligned accesses.  Note that this did not affect the ABI of a
2764 function with a @code{nullptr_t} parameter, as parameters have a
2765 minimum alignment.
2767 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2769 @item
2770 Target-specific attributes that affect the identity of a type, such as
2771 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2772 did not affect the mangled name, leading to name collisions when
2773 function pointers were used as template arguments.
2775 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2777 @end itemize
2779 It also warns about psABI-related changes.  The known psABI changes at this
2780 point include:
2782 @itemize @bullet
2784 @item
2785 For SysV/x86-64, unions with @code{long double} members are 
2786 passed in memory as specified in psABI.  For example:
2788 @smallexample
2789 union U @{
2790   long double ld;
2791   int i;
2793 @end smallexample
2795 @noindent
2796 @code{union U} is always passed in memory.
2798 @end itemize
2800 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2801 @opindex Wabi-tag
2802 @opindex -Wabi-tag
2803 Warn when a type with an ABI tag is used in a context that does not
2804 have that ABI tag.  See @ref{C++ Attributes} for more information
2805 about ABI tags.
2807 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2808 @opindex Wctor-dtor-privacy
2809 @opindex Wno-ctor-dtor-privacy
2810 Warn when a class seems unusable because all the constructors or
2811 destructors in that class are private, and it has neither friends nor
2812 public static member functions.  Also warn if there are no non-private
2813 methods, and there's at least one private member function that isn't
2814 a constructor or destructor.
2816 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2817 @opindex Wdelete-non-virtual-dtor
2818 @opindex Wno-delete-non-virtual-dtor
2819 Warn when @code{delete} is used to destroy an instance of a class that
2820 has virtual functions and non-virtual destructor. It is unsafe to delete
2821 an instance of a derived class through a pointer to a base class if the
2822 base class does not have a virtual destructor.  This warning is enabled
2823 by @option{-Wall}.
2825 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2826 @opindex Wliteral-suffix
2827 @opindex Wno-literal-suffix
2828 Warn when a string or character literal is followed by a ud-suffix which does
2829 not begin with an underscore.  As a conforming extension, GCC treats such
2830 suffixes as separate preprocessing tokens in order to maintain backwards
2831 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2832 For example:
2834 @smallexample
2835 #define __STDC_FORMAT_MACROS
2836 #include <inttypes.h>
2837 #include <stdio.h>
2839 int main() @{
2840   int64_t i64 = 123;
2841   printf("My int64: %" PRId64"\n", i64);
2843 @end smallexample
2845 In this case, @code{PRId64} is treated as a separate preprocessing token.
2847 This warning is enabled by default.
2849 @item -Wlto-type-mismatch
2850 @opindex Wlto-type-mismatch
2851 @opindex Wno-lto-type-mismatch
2853 During the link-time optimization warn about type mismatches in
2854 global declarations from different compilation units.
2855 Requires @option{-flto} to be enabled.  Enabled by default.
2857 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2858 @opindex Wnarrowing
2859 @opindex Wno-narrowing
2860 With @option{-std=gnu++98} or @option{-std=c++98}, warn when a narrowing
2861 conversion prohibited by C++11 occurs within
2862 @samp{@{ @}}, e.g.
2864 @smallexample
2865 int i = @{ 2.2 @}; // error: narrowing from double to int
2866 @end smallexample
2868 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2870 When a later standard is in effect, e.g. when using @option{-std=c++11},
2871 narrowing conversions are diagnosed by default, as required by the standard.
2872 A narrowing conversion from a constant produces an error,
2873 and a narrowing conversion from a non-constant produces a warning,
2874 but @option{-Wno-narrowing} suppresses the diagnostic.
2875 Note that this does not affect the meaning of well-formed code;
2876 narrowing conversions are still considered ill-formed in SFINAE contexts.
2878 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2879 @opindex Wnoexcept
2880 @opindex Wno-noexcept
2881 Warn when a noexcept-expression evaluates to false because of a call
2882 to a function that does not have a non-throwing exception
2883 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2884 the compiler to never throw an exception.
2886 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2887 @opindex Wnon-virtual-dtor
2888 @opindex Wno-non-virtual-dtor
2889 Warn when a class has virtual functions and an accessible non-virtual
2890 destructor itself or in an accessible polymorphic base class, in which
2891 case it is possible but unsafe to delete an instance of a derived
2892 class through a pointer to the class itself or base class.  This
2893 warning is automatically enabled if @option{-Weffc++} is specified.
2895 @item -Wregister @r{(C++ and Objective-C++ only)}
2896 @opindex Wregister
2897 @opindex Wno-register
2898 Warn on uses of the @code{register} storage class specifier, except
2899 when it is part of the GNU @ref{Explicit Register Variables} extension.
2900 The use of the @code{register} keyword as storage class specifier has
2901 been deprecated in C++11 and removed in C++17.
2902 Enabled by default with @option{-std=c++1z}.
2904 @item -Wreorder @r{(C++ and Objective-C++ only)}
2905 @opindex Wreorder
2906 @opindex Wno-reorder
2907 @cindex reordering, warning
2908 @cindex warning for reordering of member initializers
2909 Warn when the order of member initializers given in the code does not
2910 match the order in which they must be executed.  For instance:
2912 @smallexample
2913 struct A @{
2914   int i;
2915   int j;
2916   A(): j (0), i (1) @{ @}
2918 @end smallexample
2920 @noindent
2921 The compiler rearranges the member initializers for @code{i}
2922 and @code{j} to match the declaration order of the members, emitting
2923 a warning to that effect.  This warning is enabled by @option{-Wall}.
2925 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2926 @opindex fext-numeric-literals
2927 @opindex fno-ext-numeric-literals
2928 Accept imaginary, fixed-point, or machine-defined
2929 literal number suffixes as GNU extensions.
2930 When this option is turned off these suffixes are treated
2931 as C++11 user-defined literal numeric suffixes.
2932 This is on by default for all pre-C++11 dialects and all GNU dialects:
2933 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2934 @option{-std=gnu++14}.
2935 This option is off by default
2936 for ISO C++11 onwards (@option{-std=c++11}, ...).
2937 @end table
2939 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2941 @table @gcctabopt
2942 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2943 @opindex Weffc++
2944 @opindex Wno-effc++
2945 Warn about violations of the following style guidelines from Scott Meyers'
2946 @cite{Effective C++} series of books:
2948 @itemize @bullet
2949 @item
2950 Define a copy constructor and an assignment operator for classes
2951 with dynamically-allocated memory.
2953 @item
2954 Prefer initialization to assignment in constructors.
2956 @item
2957 Have @code{operator=} return a reference to @code{*this}.
2959 @item
2960 Don't try to return a reference when you must return an object.
2962 @item
2963 Distinguish between prefix and postfix forms of increment and
2964 decrement operators.
2966 @item
2967 Never overload @code{&&}, @code{||}, or @code{,}.
2969 @end itemize
2971 This option also enables @option{-Wnon-virtual-dtor}, which is also
2972 one of the effective C++ recommendations.  However, the check is
2973 extended to warn about the lack of virtual destructor in accessible
2974 non-polymorphic bases classes too.
2976 When selecting this option, be aware that the standard library
2977 headers do not obey all of these guidelines; use @samp{grep -v}
2978 to filter out those warnings.
2980 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2981 @opindex Wstrict-null-sentinel
2982 @opindex Wno-strict-null-sentinel
2983 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2984 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2985 to @code{__null}.  Although it is a null pointer constant rather than a
2986 null pointer, it is guaranteed to be of the same size as a pointer.
2987 But this use is not portable across different compilers.
2989 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2990 @opindex Wno-non-template-friend
2991 @opindex Wnon-template-friend
2992 Disable warnings when non-templatized friend functions are declared
2993 within a template.  Since the advent of explicit template specification
2994 support in G++, if the name of the friend is an unqualified-id (i.e.,
2995 @samp{friend foo(int)}), the C++ language specification demands that the
2996 friend declare or define an ordinary, nontemplate function.  (Section
2997 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2998 could be interpreted as a particular specialization of a templatized
2999 function.  Because this non-conforming behavior is no longer the default
3000 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
3001 check existing code for potential trouble spots and is on by default.
3002 This new compiler behavior can be turned off with
3003 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
3004 but disables the helpful warning.
3006 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3007 @opindex Wold-style-cast
3008 @opindex Wno-old-style-cast
3009 Warn if an old-style (C-style) cast to a non-void type is used within
3010 a C++ program.  The new-style casts (@code{dynamic_cast},
3011 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3012 less vulnerable to unintended effects and much easier to search for.
3014 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3015 @opindex Woverloaded-virtual
3016 @opindex Wno-overloaded-virtual
3017 @cindex overloaded virtual function, warning
3018 @cindex warning for overloaded virtual function
3019 Warn when a function declaration hides virtual functions from a
3020 base class.  For example, in:
3022 @smallexample
3023 struct A @{
3024   virtual void f();
3027 struct B: public A @{
3028   void f(int);
3030 @end smallexample
3032 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3033 like:
3035 @smallexample
3036 B* b;
3037 b->f();
3038 @end smallexample
3040 @noindent
3041 fails to compile.
3043 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3044 @opindex Wno-pmf-conversions
3045 @opindex Wpmf-conversions
3046 Disable the diagnostic for converting a bound pointer to member function
3047 to a plain pointer.
3049 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3050 @opindex Wsign-promo
3051 @opindex Wno-sign-promo
3052 Warn when overload resolution chooses a promotion from unsigned or
3053 enumerated type to a signed type, over a conversion to an unsigned type of
3054 the same size.  Previous versions of G++ tried to preserve
3055 unsignedness, but the standard mandates the current behavior.
3057 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3058 @opindex Wtemplates
3059 Warn when a primary template declaration is encountered.  Some coding
3060 rules disallow templates, and this may be used to enforce that rule.
3061 The warning is inactive inside a system header file, such as the STL, so
3062 one can still use the STL.  One may also instantiate or specialize
3063 templates.
3065 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3066 @opindex Wmultiple-inheritance
3067 Warn when a class is defined with multiple direct base classes.  Some
3068 coding rules disallow multiple inheritance, and this may be used to
3069 enforce that rule.  The warning is inactive inside a system header file,
3070 such as the STL, so one can still use the STL.  One may also define
3071 classes that indirectly use multiple inheritance.
3073 @item -Wvirtual-inheritance
3074 @opindex Wvirtual-inheritance
3075 Warn when a class is defined with a virtual direct base classe.  Some
3076 coding rules disallow multiple inheritance, and this may be used to
3077 enforce that rule.  The warning is inactive inside a system header file,
3078 such as the STL, so one can still use the STL.  One may also define
3079 classes that indirectly use virtual inheritance.
3081 @item -Wnamespaces
3082 @opindex Wnamespaces
3083 Warn when a namespace definition is opened.  Some coding rules disallow
3084 namespaces, and this may be used to enforce that rule.  The warning is
3085 inactive inside a system header file, such as the STL, so one can still
3086 use the STL.  One may also use using directives and qualified names.
3088 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3089 @opindex Wterminate
3090 @opindex Wno-terminate
3091 Disable the warning about a throw-expression that will immediately
3092 result in a call to @code{terminate}.
3093 @end table
3095 @node Objective-C and Objective-C++ Dialect Options
3096 @section Options Controlling Objective-C and Objective-C++ Dialects
3098 @cindex compiler options, Objective-C and Objective-C++
3099 @cindex Objective-C and Objective-C++ options, command-line
3100 @cindex options, Objective-C and Objective-C++
3101 (NOTE: This manual does not describe the Objective-C and Objective-C++
3102 languages themselves.  @xref{Standards,,Language Standards
3103 Supported by GCC}, for references.)
3105 This section describes the command-line options that are only meaningful
3106 for Objective-C and Objective-C++ programs.  You can also use most of
3107 the language-independent GNU compiler options.
3108 For example, you might compile a file @file{some_class.m} like this:
3110 @smallexample
3111 gcc -g -fgnu-runtime -O -c some_class.m
3112 @end smallexample
3114 @noindent
3115 In this example, @option{-fgnu-runtime} is an option meant only for
3116 Objective-C and Objective-C++ programs; you can use the other options with
3117 any language supported by GCC@.
3119 Note that since Objective-C is an extension of the C language, Objective-C
3120 compilations may also use options specific to the C front-end (e.g.,
3121 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3122 C++-specific options (e.g., @option{-Wabi}).
3124 Here is a list of options that are @emph{only} for compiling Objective-C
3125 and Objective-C++ programs:
3127 @table @gcctabopt
3128 @item -fconstant-string-class=@var{class-name}
3129 @opindex fconstant-string-class
3130 Use @var{class-name} as the name of the class to instantiate for each
3131 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3132 class name is @code{NXConstantString} if the GNU runtime is being used, and
3133 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3134 @option{-fconstant-cfstrings} option, if also present, overrides the
3135 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3136 to be laid out as constant CoreFoundation strings.
3138 @item -fgnu-runtime
3139 @opindex fgnu-runtime
3140 Generate object code compatible with the standard GNU Objective-C
3141 runtime.  This is the default for most types of systems.
3143 @item -fnext-runtime
3144 @opindex fnext-runtime
3145 Generate output compatible with the NeXT runtime.  This is the default
3146 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3147 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3148 used.
3150 @item -fno-nil-receivers
3151 @opindex fno-nil-receivers
3152 Assume that all Objective-C message dispatches (@code{[receiver
3153 message:arg]}) in this translation unit ensure that the receiver is
3154 not @code{nil}.  This allows for more efficient entry points in the
3155 runtime to be used.  This option is only available in conjunction with
3156 the NeXT runtime and ABI version 0 or 1.
3158 @item -fobjc-abi-version=@var{n}
3159 @opindex fobjc-abi-version
3160 Use version @var{n} of the Objective-C ABI for the selected runtime.
3161 This option is currently supported only for the NeXT runtime.  In that
3162 case, Version 0 is the traditional (32-bit) ABI without support for
3163 properties and other Objective-C 2.0 additions.  Version 1 is the
3164 traditional (32-bit) ABI with support for properties and other
3165 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3166 nothing is specified, the default is Version 0 on 32-bit target
3167 machines, and Version 2 on 64-bit target machines.
3169 @item -fobjc-call-cxx-cdtors
3170 @opindex fobjc-call-cxx-cdtors
3171 For each Objective-C class, check if any of its instance variables is a
3172 C++ object with a non-trivial default constructor.  If so, synthesize a
3173 special @code{- (id) .cxx_construct} instance method which runs
3174 non-trivial default constructors on any such instance variables, in order,
3175 and then return @code{self}.  Similarly, check if any instance variable
3176 is a C++ object with a non-trivial destructor, and if so, synthesize a
3177 special @code{- (void) .cxx_destruct} method which runs
3178 all such default destructors, in reverse order.
3180 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3181 methods thusly generated only operate on instance variables
3182 declared in the current Objective-C class, and not those inherited
3183 from superclasses.  It is the responsibility of the Objective-C
3184 runtime to invoke all such methods in an object's inheritance
3185 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3186 by the runtime immediately after a new object instance is allocated;
3187 the @code{- (void) .cxx_destruct} methods are invoked immediately
3188 before the runtime deallocates an object instance.
3190 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3191 support for invoking the @code{- (id) .cxx_construct} and
3192 @code{- (void) .cxx_destruct} methods.
3194 @item -fobjc-direct-dispatch
3195 @opindex fobjc-direct-dispatch
3196 Allow fast jumps to the message dispatcher.  On Darwin this is
3197 accomplished via the comm page.
3199 @item -fobjc-exceptions
3200 @opindex fobjc-exceptions
3201 Enable syntactic support for structured exception handling in
3202 Objective-C, similar to what is offered by C++.  This option
3203 is required to use the Objective-C keywords @code{@@try},
3204 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3205 @code{@@synchronized}.  This option is available with both the GNU
3206 runtime and the NeXT runtime (but not available in conjunction with
3207 the NeXT runtime on Mac OS X 10.2 and earlier).
3209 @item -fobjc-gc
3210 @opindex fobjc-gc
3211 Enable garbage collection (GC) in Objective-C and Objective-C++
3212 programs.  This option is only available with the NeXT runtime; the
3213 GNU runtime has a different garbage collection implementation that
3214 does not require special compiler flags.
3216 @item -fobjc-nilcheck
3217 @opindex fobjc-nilcheck
3218 For the NeXT runtime with version 2 of the ABI, check for a nil
3219 receiver in method invocations before doing the actual method call.
3220 This is the default and can be disabled using
3221 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3222 checked for nil in this way no matter what this flag is set to.
3223 Currently this flag does nothing when the GNU runtime, or an older
3224 version of the NeXT runtime ABI, is used.
3226 @item -fobjc-std=objc1
3227 @opindex fobjc-std
3228 Conform to the language syntax of Objective-C 1.0, the language
3229 recognized by GCC 4.0.  This only affects the Objective-C additions to
3230 the C/C++ language; it does not affect conformance to C/C++ standards,
3231 which is controlled by the separate C/C++ dialect option flags.  When
3232 this option is used with the Objective-C or Objective-C++ compiler,
3233 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3234 This is useful if you need to make sure that your Objective-C code can
3235 be compiled with older versions of GCC@.
3237 @item -freplace-objc-classes
3238 @opindex freplace-objc-classes
3239 Emit a special marker instructing @command{ld(1)} not to statically link in
3240 the resulting object file, and allow @command{dyld(1)} to load it in at
3241 run time instead.  This is used in conjunction with the Fix-and-Continue
3242 debugging mode, where the object file in question may be recompiled and
3243 dynamically reloaded in the course of program execution, without the need
3244 to restart the program itself.  Currently, Fix-and-Continue functionality
3245 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3246 and later.
3248 @item -fzero-link
3249 @opindex fzero-link
3250 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3251 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3252 compile time) with static class references that get initialized at load time,
3253 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3254 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3255 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3256 for individual class implementations to be modified during program execution.
3257 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3258 regardless of command-line options.
3260 @item -fno-local-ivars
3261 @opindex fno-local-ivars
3262 @opindex flocal-ivars
3263 By default instance variables in Objective-C can be accessed as if
3264 they were local variables from within the methods of the class they're
3265 declared in.  This can lead to shadowing between instance variables
3266 and other variables declared either locally inside a class method or
3267 globally with the same name.  Specifying the @option{-fno-local-ivars}
3268 flag disables this behavior thus avoiding variable shadowing issues.
3270 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3271 @opindex fivar-visibility
3272 Set the default instance variable visibility to the specified option
3273 so that instance variables declared outside the scope of any access
3274 modifier directives default to the specified visibility.
3276 @item -gen-decls
3277 @opindex gen-decls
3278 Dump interface declarations for all classes seen in the source file to a
3279 file named @file{@var{sourcename}.decl}.
3281 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3282 @opindex Wassign-intercept
3283 @opindex Wno-assign-intercept
3284 Warn whenever an Objective-C assignment is being intercepted by the
3285 garbage collector.
3287 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3288 @opindex Wno-protocol
3289 @opindex Wprotocol
3290 If a class is declared to implement a protocol, a warning is issued for
3291 every method in the protocol that is not implemented by the class.  The
3292 default behavior is to issue a warning for every method not explicitly
3293 implemented in the class, even if a method implementation is inherited
3294 from the superclass.  If you use the @option{-Wno-protocol} option, then
3295 methods inherited from the superclass are considered to be implemented,
3296 and no warning is issued for them.
3298 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3299 @opindex Wselector
3300 @opindex Wno-selector
3301 Warn if multiple methods of different types for the same selector are
3302 found during compilation.  The check is performed on the list of methods
3303 in the final stage of compilation.  Additionally, a check is performed
3304 for each selector appearing in a @code{@@selector(@dots{})}
3305 expression, and a corresponding method for that selector has been found
3306 during compilation.  Because these checks scan the method table only at
3307 the end of compilation, these warnings are not produced if the final
3308 stage of compilation is not reached, for example because an error is
3309 found during compilation, or because the @option{-fsyntax-only} option is
3310 being used.
3312 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3313 @opindex Wstrict-selector-match
3314 @opindex Wno-strict-selector-match
3315 Warn if multiple methods with differing argument and/or return types are
3316 found for a given selector when attempting to send a message using this
3317 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3318 is off (which is the default behavior), the compiler omits such warnings
3319 if any differences found are confined to types that share the same size
3320 and alignment.
3322 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3323 @opindex Wundeclared-selector
3324 @opindex Wno-undeclared-selector
3325 Warn if a @code{@@selector(@dots{})} expression referring to an
3326 undeclared selector is found.  A selector is considered undeclared if no
3327 method with that name has been declared before the
3328 @code{@@selector(@dots{})} expression, either explicitly in an
3329 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3330 an @code{@@implementation} section.  This option always performs its
3331 checks as soon as a @code{@@selector(@dots{})} expression is found,
3332 while @option{-Wselector} only performs its checks in the final stage of
3333 compilation.  This also enforces the coding style convention
3334 that methods and selectors must be declared before being used.
3336 @item -print-objc-runtime-info
3337 @opindex print-objc-runtime-info
3338 Generate C header describing the largest structure that is passed by
3339 value, if any.
3341 @end table
3343 @node Diagnostic Message Formatting Options
3344 @section Options to Control Diagnostic Messages Formatting
3345 @cindex options to control diagnostics formatting
3346 @cindex diagnostic messages
3347 @cindex message formatting
3349 Traditionally, diagnostic messages have been formatted irrespective of
3350 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3351 options described below
3352 to control the formatting algorithm for diagnostic messages, 
3353 e.g.@: how many characters per line, how often source location
3354 information should be reported.  Note that some language front ends may not
3355 honor these options.
3357 @table @gcctabopt
3358 @item -fmessage-length=@var{n}
3359 @opindex fmessage-length
3360 Try to format error messages so that they fit on lines of about
3361 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3362 done; each error message appears on a single line.  This is the
3363 default for all front ends.
3365 @item -fdiagnostics-show-location=once
3366 @opindex fdiagnostics-show-location
3367 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3368 reporter to emit source location information @emph{once}; that is, in
3369 case the message is too long to fit on a single physical line and has to
3370 be wrapped, the source location won't be emitted (as prefix) again,
3371 over and over, in subsequent continuation lines.  This is the default
3372 behavior.
3374 @item -fdiagnostics-show-location=every-line
3375 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3376 messages reporter to emit the same source location information (as
3377 prefix) for physical lines that result from the process of breaking
3378 a message which is too long to fit on a single line.
3380 @item -fdiagnostics-color[=@var{WHEN}]
3381 @itemx -fno-diagnostics-color
3382 @opindex fdiagnostics-color
3383 @cindex highlight, color
3384 @vindex GCC_COLORS @r{environment variable}
3385 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3386 or @samp{auto}.  The default depends on how the compiler has been configured,
3387 it can be any of the above @var{WHEN} options or also @samp{never}
3388 if @env{GCC_COLORS} environment variable isn't present in the environment,
3389 and @samp{auto} otherwise.
3390 @samp{auto} means to use color only when the standard error is a terminal.
3391 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3392 aliases for @option{-fdiagnostics-color=always} and
3393 @option{-fdiagnostics-color=never}, respectively.
3395 The colors are defined by the environment variable @env{GCC_COLORS}.
3396 Its value is a colon-separated list of capabilities and Select Graphic
3397 Rendition (SGR) substrings. SGR commands are interpreted by the
3398 terminal or terminal emulator.  (See the section in the documentation
3399 of your text terminal for permitted values and their meanings as
3400 character attributes.)  These substring values are integers in decimal
3401 representation and can be concatenated with semicolons.
3402 Common values to concatenate include
3403 @samp{1} for bold,
3404 @samp{4} for underline,
3405 @samp{5} for blink,
3406 @samp{7} for inverse,
3407 @samp{39} for default foreground color,
3408 @samp{30} to @samp{37} for foreground colors,
3409 @samp{90} to @samp{97} for 16-color mode foreground colors,
3410 @samp{38;5;0} to @samp{38;5;255}
3411 for 88-color and 256-color modes foreground colors,
3412 @samp{49} for default background color,
3413 @samp{40} to @samp{47} for background colors,
3414 @samp{100} to @samp{107} for 16-color mode background colors,
3415 and @samp{48;5;0} to @samp{48;5;255}
3416 for 88-color and 256-color modes background colors.
3418 The default @env{GCC_COLORS} is
3419 @smallexample
3420 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:quote=01:\
3421 fixit-insert=32:fixit-delete=31:\
3422 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
3423 @end smallexample
3424 @noindent
3425 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3426 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3427 @samp{01} is bold, and @samp{31} is red.
3428 Setting @env{GCC_COLORS} to the empty string disables colors.
3429 Supported capabilities are as follows.
3431 @table @code
3432 @item error=
3433 @vindex error GCC_COLORS @r{capability}
3434 SGR substring for error: markers.
3436 @item warning=
3437 @vindex warning GCC_COLORS @r{capability}
3438 SGR substring for warning: markers.
3440 @item note=
3441 @vindex note GCC_COLORS @r{capability}
3442 SGR substring for note: markers.
3444 @item range1=
3445 @vindex range1 GCC_COLORS @r{capability}
3446 SGR substring for first additional range.
3448 @item range2=
3449 @vindex range2 GCC_COLORS @r{capability}
3450 SGR substring for second additional range.
3452 @item locus=
3453 @vindex locus GCC_COLORS @r{capability}
3454 SGR substring for location information, @samp{file:line} or
3455 @samp{file:line:column} etc.
3457 @item quote=
3458 @vindex quote GCC_COLORS @r{capability}
3459 SGR substring for information printed within quotes.
3461 @item fixit-insert=
3462 @vindex fixit-insert GCC_COLORS @r{capability}
3463 SGR substring for fix-it hints suggesting text to
3464 be inserted or replaced.
3466 @item fixit-delete=
3467 @vindex fixit-delete GCC_COLORS @r{capability}
3468 SGR substring for fix-it hints suggesting text to
3469 be deleted.
3471 @item diff-filename=
3472 @vindex diff-filename GCC_COLORS @r{capability}
3473 SGR substring for filename headers within generated patches.
3475 @item diff-hunk=
3476 @vindex diff-hunk GCC_COLORS @r{capability}
3477 SGR substring for the starts of hunks within generated patches.
3479 @item diff-delete=
3480 @vindex diff-delete GCC_COLORS @r{capability}
3481 SGR substring for deleted lines within generated patches.
3483 @item diff-insert=
3484 @vindex diff-insert GCC_COLORS @r{capability}
3485 SGR substring for inserted lines within generated patches.
3486 @end table
3488 @item -fno-diagnostics-show-option
3489 @opindex fno-diagnostics-show-option
3490 @opindex fdiagnostics-show-option
3491 By default, each diagnostic emitted includes text indicating the
3492 command-line option that directly controls the diagnostic (if such an
3493 option is known to the diagnostic machinery).  Specifying the
3494 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3496 @item -fno-diagnostics-show-caret
3497 @opindex fno-diagnostics-show-caret
3498 @opindex fdiagnostics-show-caret
3499 By default, each diagnostic emitted includes the original source line
3500 and a caret @samp{^} indicating the column.  This option suppresses this
3501 information.  The source line is truncated to @var{n} characters, if
3502 the @option{-fmessage-length=n} option is given.  When the output is done
3503 to the terminal, the width is limited to the width given by the
3504 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3506 @item -fdiagnostics-parseable-fixits
3507 @opindex fdiagnostics-parseable-fixits
3508 Emit fix-it hints in a machine-parseable format, suitable for consumption
3509 by IDEs.  For each fix-it, a line will be printed after the relevant
3510 diagnostic, starting with the string ``fix-it:''.  For example:
3512 @smallexample
3513 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3514 @end smallexample
3516 The location is expressed as a half-open range, expressed as a count of
3517 bytes, starting at byte 1 for the initial column.  In the above example,
3518 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3519 given string:
3521 @smallexample
3522 00000000011111111112222222222
3523 12345678901234567890123456789
3524   gtk_widget_showall (dlg);
3525   ^^^^^^^^^^^^^^^^^^
3526   gtk_widget_show_all
3527 @end smallexample
3529 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3530 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3531 (e.g. vertical tab as ``\013'').
3533 An empty replacement string indicates that the given range is to be removed.
3534 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3535 be inserted at the given position.
3537 @item -fdiagnostics-generate-patch
3538 @opindex fdiagnostics-generate-patch
3539 Print fix-it hints to stderr in unified diff format, after any diagnostics
3540 are printed.  For example:
3542 @smallexample
3543 --- test.c
3544 +++ test.c
3545 @@ -42,5 +42,5 @@
3547  void show_cb(GtkDialog *dlg)
3548  @{
3549 -  gtk_widget_showall(dlg);
3550 +  gtk_widget_show_all(dlg);
3551  @}
3553 @end smallexample
3555 The diff may or may not be colorized, following the same rules
3556 as for diagnostics (see @option{-fdiagnostics-color}).
3558 @item -fno-show-column
3559 @opindex fno-show-column
3560 Do not print column numbers in diagnostics.  This may be necessary if
3561 diagnostics are being scanned by a program that does not understand the
3562 column numbers, such as @command{dejagnu}.
3564 @end table
3566 @node Warning Options
3567 @section Options to Request or Suppress Warnings
3568 @cindex options to control warnings
3569 @cindex warning messages
3570 @cindex messages, warning
3571 @cindex suppressing warnings
3573 Warnings are diagnostic messages that report constructions that
3574 are not inherently erroneous but that are risky or suggest there
3575 may have been an error.
3577 The following language-independent options do not enable specific
3578 warnings but control the kinds of diagnostics produced by GCC@.
3580 @table @gcctabopt
3581 @cindex syntax checking
3582 @item -fsyntax-only
3583 @opindex fsyntax-only
3584 Check the code for syntax errors, but don't do anything beyond that.
3586 @item -fmax-errors=@var{n}
3587 @opindex fmax-errors
3588 Limits the maximum number of error messages to @var{n}, at which point
3589 GCC bails out rather than attempting to continue processing the source
3590 code.  If @var{n} is 0 (the default), there is no limit on the number
3591 of error messages produced.  If @option{-Wfatal-errors} is also
3592 specified, then @option{-Wfatal-errors} takes precedence over this
3593 option.
3595 @item -w
3596 @opindex w
3597 Inhibit all warning messages.
3599 @item -Werror
3600 @opindex Werror
3601 @opindex Wno-error
3602 Make all warnings into errors.
3604 @item -Werror=
3605 @opindex Werror=
3606 @opindex Wno-error=
3607 Make the specified warning into an error.  The specifier for a warning
3608 is appended; for example @option{-Werror=switch} turns the warnings
3609 controlled by @option{-Wswitch} into errors.  This switch takes a
3610 negative form, to be used to negate @option{-Werror} for specific
3611 warnings; for example @option{-Wno-error=switch} makes
3612 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3613 is in effect.
3615 The warning message for each controllable warning includes the
3616 option that controls the warning.  That option can then be used with
3617 @option{-Werror=} and @option{-Wno-error=} as described above.
3618 (Printing of the option in the warning message can be disabled using the
3619 @option{-fno-diagnostics-show-option} flag.)
3621 Note that specifying @option{-Werror=}@var{foo} automatically implies
3622 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3623 imply anything.
3625 @item -Wfatal-errors
3626 @opindex Wfatal-errors
3627 @opindex Wno-fatal-errors
3628 This option causes the compiler to abort compilation on the first error
3629 occurred rather than trying to keep going and printing further error
3630 messages.
3632 @end table
3634 You can request many specific warnings with options beginning with
3635 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3636 implicit declarations.  Each of these specific warning options also
3637 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3638 example, @option{-Wno-implicit}.  This manual lists only one of the
3639 two forms, whichever is not the default.  For further
3640 language-specific options also refer to @ref{C++ Dialect Options} and
3641 @ref{Objective-C and Objective-C++ Dialect Options}.
3643 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3644 options, such as @option{-Wunused}, which may turn on further options,
3645 such as @option{-Wunused-value}. The combined effect of positive and
3646 negative forms is that more specific options have priority over less
3647 specific ones, independently of their position in the command-line. For
3648 options of the same specificity, the last one takes effect. Options
3649 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3650 as if they appeared at the end of the command-line.
3652 When an unrecognized warning option is requested (e.g.,
3653 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3654 that the option is not recognized.  However, if the @option{-Wno-} form
3655 is used, the behavior is slightly different: no diagnostic is
3656 produced for @option{-Wno-unknown-warning} unless other diagnostics
3657 are being produced.  This allows the use of new @option{-Wno-} options
3658 with old compilers, but if something goes wrong, the compiler
3659 warns that an unrecognized option is present.
3661 @table @gcctabopt
3662 @item -Wpedantic
3663 @itemx -pedantic
3664 @opindex pedantic
3665 @opindex Wpedantic
3666 Issue all the warnings demanded by strict ISO C and ISO C++;
3667 reject all programs that use forbidden extensions, and some other
3668 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3669 version of the ISO C standard specified by any @option{-std} option used.
3671 Valid ISO C and ISO C++ programs should compile properly with or without
3672 this option (though a rare few require @option{-ansi} or a
3673 @option{-std} option specifying the required version of ISO C)@.  However,
3674 without this option, certain GNU extensions and traditional C and C++
3675 features are supported as well.  With this option, they are rejected.
3677 @option{-Wpedantic} does not cause warning messages for use of the
3678 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3679 warnings are also disabled in the expression that follows
3680 @code{__extension__}.  However, only system header files should use
3681 these escape routes; application programs should avoid them.
3682 @xref{Alternate Keywords}.
3684 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3685 C conformance.  They soon find that it does not do quite what they want:
3686 it finds some non-ISO practices, but not all---only those for which
3687 ISO C @emph{requires} a diagnostic, and some others for which
3688 diagnostics have been added.
3690 A feature to report any failure to conform to ISO C might be useful in
3691 some instances, but would require considerable additional work and would
3692 be quite different from @option{-Wpedantic}.  We don't have plans to
3693 support such a feature in the near future.
3695 Where the standard specified with @option{-std} represents a GNU
3696 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3697 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3698 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3699 where they are required by the base standard.  (It does not make sense
3700 for such warnings to be given only for features not in the specified GNU
3701 C dialect, since by definition the GNU dialects of C include all
3702 features the compiler supports with the given option, and there would be
3703 nothing to warn about.)
3705 @item -pedantic-errors
3706 @opindex pedantic-errors
3707 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3708 requires a diagnostic, in some cases where there is undefined behavior
3709 at compile-time and in some other cases that do not prevent compilation
3710 of programs that are valid according to the standard. This is not
3711 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3712 by this option and not enabled by the latter and vice versa.
3714 @item -Wall
3715 @opindex Wall
3716 @opindex Wno-all
3717 This enables all the warnings about constructions that some users
3718 consider questionable, and that are easy to avoid (or modify to
3719 prevent the warning), even in conjunction with macros.  This also
3720 enables some language-specific warnings described in @ref{C++ Dialect
3721 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3723 @option{-Wall} turns on the following warning flags:
3725 @gccoptlist{-Waddress   @gol
3726 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3727 -Wbool-compare  @gol
3728 -Wbool-operation  @gol
3729 -Wc++11-compat  -Wc++14-compat@gol
3730 -Wchar-subscripts  @gol
3731 -Wcomment  @gol
3732 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3733 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3734 -Wformat   @gol
3735 -Wint-in-bool-context  @gol
3736 -Wimplicit @r{(C and Objective-C only)} @gol
3737 -Wimplicit-int @r{(C and Objective-C only)} @gol
3738 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3739 -Winit-self @r{(only for C++)} @gol
3740 -Wlogical-not-parentheses
3741 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3742 -Wmaybe-uninitialized @gol
3743 -Wmemset-elt-size @gol
3744 -Wmemset-transposed-args @gol
3745 -Wmisleading-indentation @r{(only for C/C++)} @gol
3746 -Wmissing-braces @r{(only for C/ObjC)} @gol
3747 -Wnarrowing @r{(only for C++)}  @gol
3748 -Wnonnull  @gol
3749 -Wnonnull-compare  @gol
3750 -Wopenmp-simd @gol
3751 -Wparentheses  @gol
3752 -Wpointer-sign  @gol
3753 -Wreorder   @gol
3754 -Wreturn-type  @gol
3755 -Wsequence-point  @gol
3756 -Wsign-compare @r{(only in C++)}  @gol
3757 -Wsizeof-pointer-memaccess @gol
3758 -Wstrict-aliasing  @gol
3759 -Wstrict-overflow=1  @gol
3760 -Wswitch  @gol
3761 -Wtautological-compare  @gol
3762 -Wtrigraphs  @gol
3763 -Wuninitialized  @gol
3764 -Wunknown-pragmas  @gol
3765 -Wunused-function  @gol
3766 -Wunused-label     @gol
3767 -Wunused-value     @gol
3768 -Wunused-variable  @gol
3769 -Wvolatile-register-var @gol
3772 Note that some warning flags are not implied by @option{-Wall}.  Some of
3773 them warn about constructions that users generally do not consider
3774 questionable, but which occasionally you might wish to check for;
3775 others warn about constructions that are necessary or hard to avoid in
3776 some cases, and there is no simple way to modify the code to suppress
3777 the warning. Some of them are enabled by @option{-Wextra} but many of
3778 them must be enabled individually.
3780 @item -Wextra
3781 @opindex W
3782 @opindex Wextra
3783 @opindex Wno-extra
3784 This enables some extra warning flags that are not enabled by
3785 @option{-Wall}. (This option used to be called @option{-W}.  The older
3786 name is still supported, but the newer name is more descriptive.)
3788 @gccoptlist{-Wclobbered  @gol
3789 -Wempty-body  @gol
3790 -Wignored-qualifiers @gol
3791 -Wimplicit-fallthrough=3 @gol
3792 -Wmissing-field-initializers  @gol
3793 -Wmissing-parameter-type @r{(C only)}  @gol
3794 -Wold-style-declaration @r{(C only)}  @gol
3795 -Woverride-init  @gol
3796 -Wsign-compare @r{(C only)} @gol
3797 -Wtype-limits  @gol
3798 -Wuninitialized  @gol
3799 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3800 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3801 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3804 The option @option{-Wextra} also prints warning messages for the
3805 following cases:
3807 @itemize @bullet
3809 @item
3810 A pointer is compared against integer zero with @code{<}, @code{<=},
3811 @code{>}, or @code{>=}.
3813 @item
3814 (C++ only) An enumerator and a non-enumerator both appear in a
3815 conditional expression.
3817 @item
3818 (C++ only) Ambiguous virtual bases.
3820 @item
3821 (C++ only) Subscripting an array that has been declared @code{register}.
3823 @item
3824 (C++ only) Taking the address of a variable that has been declared
3825 @code{register}.
3827 @item
3828 (C++ only) A base class is not initialized in the copy constructor
3829 of a derived class.
3831 @end itemize
3833 @item -Wchar-subscripts
3834 @opindex Wchar-subscripts
3835 @opindex Wno-char-subscripts
3836 Warn if an array subscript has type @code{char}.  This is a common cause
3837 of error, as programmers often forget that this type is signed on some
3838 machines.
3839 This warning is enabled by @option{-Wall}.
3841 @item -Wno-coverage-mismatch
3842 @opindex Wno-coverage-mismatch
3843 Warn if feedback profiles do not match when using the
3844 @option{-fprofile-use} option.
3845 If a source file is changed between compiling with @option{-fprofile-gen} and
3846 with @option{-fprofile-use}, the files with the profile feedback can fail
3847 to match the source file and GCC cannot use the profile feedback
3848 information.  By default, this warning is enabled and is treated as an
3849 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3850 warning or @option{-Wno-error=coverage-mismatch} can be used to
3851 disable the error.  Disabling the error for this warning can result in
3852 poorly optimized code and is useful only in the
3853 case of very minor changes such as bug fixes to an existing code-base.
3854 Completely disabling the warning is not recommended.
3856 @item -Wno-cpp
3857 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3859 Suppress warning messages emitted by @code{#warning} directives.
3861 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3862 @opindex Wdouble-promotion
3863 @opindex Wno-double-promotion
3864 Give a warning when a value of type @code{float} is implicitly
3865 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3866 floating-point unit implement @code{float} in hardware, but emulate
3867 @code{double} in software.  On such a machine, doing computations
3868 using @code{double} values is much more expensive because of the
3869 overhead required for software emulation.
3871 It is easy to accidentally do computations with @code{double} because
3872 floating-point literals are implicitly of type @code{double}.  For
3873 example, in:
3874 @smallexample
3875 @group
3876 float area(float radius)
3878    return 3.14159 * radius * radius;
3880 @end group
3881 @end smallexample
3882 the compiler performs the entire computation with @code{double}
3883 because the floating-point literal is a @code{double}.
3885 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3886 @opindex Wduplicate-decl-specifier
3887 @opindex Wno-duplicate-decl-specifier
3888 Warn if a declaration has duplicate @code{const}, @code{volatile},
3889 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3890 @option{-Wall}.
3892 @item -Wformat
3893 @itemx -Wformat=@var{n}
3894 @opindex Wformat
3895 @opindex Wno-format
3896 @opindex ffreestanding
3897 @opindex fno-builtin
3898 @opindex Wformat=
3899 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3900 the arguments supplied have types appropriate to the format string
3901 specified, and that the conversions specified in the format string make
3902 sense.  This includes standard functions, and others specified by format
3903 attributes (@pxref{Function Attributes}), in the @code{printf},
3904 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3905 not in the C standard) families (or other target-specific families).
3906 Which functions are checked without format attributes having been
3907 specified depends on the standard version selected, and such checks of
3908 functions without the attribute specified are disabled by
3909 @option{-ffreestanding} or @option{-fno-builtin}.
3911 The formats are checked against the format features supported by GNU
3912 libc version 2.2.  These include all ISO C90 and C99 features, as well
3913 as features from the Single Unix Specification and some BSD and GNU
3914 extensions.  Other library implementations may not support all these
3915 features; GCC does not support warning about features that go beyond a
3916 particular library's limitations.  However, if @option{-Wpedantic} is used
3917 with @option{-Wformat}, warnings are given about format features not
3918 in the selected standard version (but not for @code{strfmon} formats,
3919 since those are not in any version of the C standard).  @xref{C Dialect
3920 Options,,Options Controlling C Dialect}.
3922 @table @gcctabopt
3923 @item -Wformat=1
3924 @itemx -Wformat
3925 @opindex Wformat
3926 @opindex Wformat=1
3927 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3928 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3929 @option{-Wformat} also checks for null format arguments for several
3930 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3931 aspects of this level of format checking can be disabled by the
3932 options: @option{-Wno-format-contains-nul},
3933 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3934 @option{-Wformat} is enabled by @option{-Wall}.
3936 @item -Wno-format-contains-nul
3937 @opindex Wno-format-contains-nul
3938 @opindex Wformat-contains-nul
3939 If @option{-Wformat} is specified, do not warn about format strings that
3940 contain NUL bytes.
3942 @item -Wno-format-extra-args
3943 @opindex Wno-format-extra-args
3944 @opindex Wformat-extra-args
3945 If @option{-Wformat} is specified, do not warn about excess arguments to a
3946 @code{printf} or @code{scanf} format function.  The C standard specifies
3947 that such arguments are ignored.
3949 Where the unused arguments lie between used arguments that are
3950 specified with @samp{$} operand number specifications, normally
3951 warnings are still given, since the implementation could not know what
3952 type to pass to @code{va_arg} to skip the unused arguments.  However,
3953 in the case of @code{scanf} formats, this option suppresses the
3954 warning if the unused arguments are all pointers, since the Single
3955 Unix Specification says that such unused arguments are allowed.
3957 @item -Wformat-length
3958 @itemx -Wformat-length=@var{level}
3959 @opindex Wformat-length
3960 @opindex Wno-format-length
3961 Warn about calls to formatted input/output functions such as @code{sprintf}
3962 that might overflow the destination buffer, or about bounded functions such
3963 as @code{snprintf} that might result in output truncation.  When the exact
3964 number of bytes written by a format directive cannot be determined at
3965 compile-time it is estimated based on heuristics that depend on the
3966 @var{level} argument and on optimization.  While enabling optimization
3967 will in most cases improve the accuracy of the warning, it may also
3968 result in false positives.
3970 @table @gcctabopt
3971 @item -Wformat-length
3972 @item -Wformat-length=1
3973 @opindex Wformat-length
3974 @opindex Wno-format-length
3975 Level @var{1} of @option{-Wformat-length} enabled by @option{-Wformat}
3976 employs a conservative approach that warns only about calls that most
3977 likely overflow the buffer or result in output truncation.  At this
3978 level, numeric arguments to format directives with unknown values are
3979 assumed to have the value of one, and strings of unknown length to be
3980 empty.  Numeric arguments that are known to be bounded to a subrange
3981 of their type, or string arguments whose output is bounded either by
3982 their directive's precision or by a finite set of string literals, are
3983 assumed to take on the value within the range that results in the most
3984 bytes on output.  For example, the call to @code{sprintf} below is
3985 diagnosed because even with both @var{a} and @var{b} equal to zero,
3986 the terminating NUL character (@code{'\0'}) appended by the function
3987 to the destination buffer will be written past its end.  Increasing
3988 the size of the buffer by a single byte is sufficient to avoid the
3989 warning, though it may not be sufficient to avoid the overflow.
3991 @smallexample
3992 void f (int a, int b)
3994   char buf [12];
3995   sprintf (buf, "a = %i, b = %i\n", a, b);
3997 @end smallexample
3999 @item -Wformat-length=2
4000 Level @var{2} warns also about calls that might overflow the destination
4001 buffer or result in truncation given an argument of sufficient length
4002 or magnitude.  At level @var{2}, unknown numeric arguments are assumed
4003 to have the minimum representable value for signed types with a precision
4004 greater than 1, and the maximum representable value otherwise.  Unknown
4005 string arguments whose length cannot be assumed to be bounded either by
4006 the directive's precision, or by a finite set of string literals they
4007 may evaluate to, or the character array they may point to, are assumed
4008 to be 1 character long.
4010 At level @var{2}, the call in the example above is again diagnosed, but
4011 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4012 @code{%i} directive will write some of its digits beyond the end of
4013 the destination buffer.  To make the call safe regardless of the values
4014 of the two variables, the size of the destination buffer must be increased
4015 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4016 an informational note following the warning.
4018 An alternative to increasing the size of the destination buffer is to
4019 constrain the range of formatted values.  The maximum length of string
4020 arguments can be bounded by specifying the precision in the format
4021 directive.  When numeric arguments of format directives can be assumed
4022 to be bounded by less than the precision of their type, choosing
4023 an appropriate length modifier to the format specifier will reduce
4024 the required buffer size.  For example, if @var{a} and @var{b} in the
4025 example above can be assumed to be within the precision of
4026 the @code{short int} type then using either the @code{%hi} format
4027 directive or casting the argument to @code{short} reduces the maximum
4028 required size of the buffer to 24 bytes.
4030 @smallexample
4031 void f (int a, int b)
4033   char buf [23];
4034   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4036 @end smallexample
4037 @end table
4039 @item -Wno-format-zero-length
4040 @opindex Wno-format-zero-length
4041 @opindex Wformat-zero-length
4042 If @option{-Wformat} is specified, do not warn about zero-length formats.
4043 The C standard specifies that zero-length formats are allowed.
4046 @item -Wformat=2
4047 @opindex Wformat=2
4048 Enable @option{-Wformat} plus additional format checks.  Currently
4049 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4050 -Wformat-y2k}.
4052 @item -Wformat-nonliteral
4053 @opindex Wformat-nonliteral
4054 @opindex Wno-format-nonliteral
4055 If @option{-Wformat} is specified, also warn if the format string is not a
4056 string literal and so cannot be checked, unless the format function
4057 takes its format arguments as a @code{va_list}.
4059 @item -Wformat-security
4060 @opindex Wformat-security
4061 @opindex Wno-format-security
4062 If @option{-Wformat} is specified, also warn about uses of format
4063 functions that represent possible security problems.  At present, this
4064 warns about calls to @code{printf} and @code{scanf} functions where the
4065 format string is not a string literal and there are no format arguments,
4066 as in @code{printf (foo);}.  This may be a security hole if the format
4067 string came from untrusted input and contains @samp{%n}.  (This is
4068 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4069 in future warnings may be added to @option{-Wformat-security} that are not
4070 included in @option{-Wformat-nonliteral}.)
4072 @item -Wformat-signedness
4073 @opindex Wformat-signedness
4074 @opindex Wno-format-signedness
4075 If @option{-Wformat} is specified, also warn if the format string
4076 requires an unsigned argument and the argument is signed and vice versa.
4078 @item -Wformat-y2k
4079 @opindex Wformat-y2k
4080 @opindex Wno-format-y2k
4081 If @option{-Wformat} is specified, also warn about @code{strftime}
4082 formats that may yield only a two-digit year.
4083 @end table
4085 @item -Wnonnull
4086 @opindex Wnonnull
4087 @opindex Wno-nonnull
4088 Warn about passing a null pointer for arguments marked as
4089 requiring a non-null value by the @code{nonnull} function attribute.
4091 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4092 can be disabled with the @option{-Wno-nonnull} option.
4094 @item -Wnonnull-compare
4095 @opindex Wnonnull-compare
4096 @opindex Wno-nonnull-compare
4097 Warn when comparing an argument marked with the @code{nonnull}
4098 function attribute against null inside the function.
4100 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4101 can be disabled with the @option{-Wno-nonnull-compare} option.
4103 @item -Wnull-dereference
4104 @opindex Wnull-dereference
4105 @opindex Wno-null-dereference
4106 Warn if the compiler detects paths that trigger erroneous or
4107 undefined behavior due to dereferencing a null pointer.  This option
4108 is only active when @option{-fdelete-null-pointer-checks} is active,
4109 which is enabled by optimizations in most targets.  The precision of
4110 the warnings depends on the optimization options used.
4112 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4113 @opindex Winit-self
4114 @opindex Wno-init-self
4115 Warn about uninitialized variables that are initialized with themselves.
4116 Note this option can only be used with the @option{-Wuninitialized} option.
4118 For example, GCC warns about @code{i} being uninitialized in the
4119 following snippet only when @option{-Winit-self} has been specified:
4120 @smallexample
4121 @group
4122 int f()
4124   int i = i;
4125   return i;
4127 @end group
4128 @end smallexample
4130 This warning is enabled by @option{-Wall} in C++.
4132 @item -Wimplicit-int @r{(C and Objective-C only)}
4133 @opindex Wimplicit-int
4134 @opindex Wno-implicit-int
4135 Warn when a declaration does not specify a type.
4136 This warning is enabled by @option{-Wall}.
4138 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4139 @opindex Wimplicit-function-declaration
4140 @opindex Wno-implicit-function-declaration
4141 Give a warning whenever a function is used before being declared. In
4142 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4143 enabled by default and it is made into an error by
4144 @option{-pedantic-errors}. This warning is also enabled by
4145 @option{-Wall}.
4147 @item -Wimplicit @r{(C and Objective-C only)}
4148 @opindex Wimplicit
4149 @opindex Wno-implicit
4150 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4151 This warning is enabled by @option{-Wall}.
4153 @item -Wimplicit-fallthrough
4154 @opindex Wimplicit-fallthrough
4155 @opindex Wno-implicit-fallthrough
4156 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4157 and @option{-Wno-implicit-fallthrough} is the same as
4158 @option{-Wimplicit-fallthrough=0}.
4160 @item -Wimplicit-fallthrough=@var{n}
4161 @opindex Wimplicit-fallthrough=
4162 Warn when a switch case falls through.  For example:
4164 @smallexample
4165 @group
4166 switch (cond)
4167   @{
4168   case 1:
4169     a = 1;
4170     break;
4171   case 2:
4172     a = 2;
4173   case 3:
4174     a = 3;
4175     break;
4176   @}
4177 @end group
4178 @end smallexample
4180 This warning does not warn when the last statement of a case cannot
4181 fall through, e.g. when there is a return statement or a call to function
4182 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4183 also takes into account control flow statements, such as ifs, and only
4184 warns when appropriate.  E.g.@:
4186 @smallexample
4187 @group
4188 switch (cond)
4189   @{
4190   case 1:
4191     if (i > 3) @{
4192       bar (5);
4193       break;
4194     @} else if (i < 1) @{
4195       bar (0);
4196     @} else
4197       return;
4198   default:
4199     @dots{}
4200   @}
4201 @end group
4202 @end smallexample
4204 Since there are occasions where a switch case fall through is desirable,
4205 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4206 to be used along with a null statement to suppress this warning that
4207 would normally occur:
4209 @smallexample
4210 @group
4211 switch (cond)
4212   @{
4213   case 1:
4214     bar (0);
4215     __attribute__ ((fallthrough));
4216   default:
4217     @dots{}
4218   @}
4219 @end group
4220 @end smallexample
4222 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4223 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4224 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4225 Instead of the these attributes, it is also possible to add a fallthrough
4226 comment to silence the warning.  The whole body of the C or C++ style comment
4227 should match the given regular expressions listed below.  The option argument
4228 @var{n} specifies what kind of comments are accepted:
4230 @itemize @bullet
4232 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4234 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4235 expression, any comment is used as fallthrough comment.
4237 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4238 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4240 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4241 following regular expressions:
4243 @itemize @bullet
4245 @item @code{-fallthrough}
4247 @item @code{@@fallthrough@@}
4249 @item @code{lint -fallthrough[ \t]*}
4251 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4253 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4255 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4257 @end itemize
4259 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4260 following regular expressions:
4262 @itemize @bullet
4264 @item @code{-fallthrough}
4266 @item @code{@@fallthrough@@}
4268 @item @code{lint -fallthrough[ \t]*}
4270 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4272 @end itemize
4274 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4275 fallthrough comments, only attributes disable the warning.
4277 @end itemize
4279 The comment needs to be followed after optional whitespace and other comments
4280 by @code{case} or @code{default} keywords or by a user label that preceeds some
4281 @code{case} or @code{default} label.
4283 @smallexample
4284 @group
4285 switch (cond)
4286   @{
4287   case 1:
4288     bar (0);
4289     /* FALLTHRU */
4290   default:
4291     @dots{}
4292   @}
4293 @end group
4294 @end smallexample
4296 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4298 @item -Wignored-qualifiers @r{(C and C++ only)}
4299 @opindex Wignored-qualifiers
4300 @opindex Wno-ignored-qualifiers
4301 Warn if the return type of a function has a type qualifier
4302 such as @code{const}.  For ISO C such a type qualifier has no effect,
4303 since the value returned by a function is not an lvalue.
4304 For C++, the warning is only emitted for scalar types or @code{void}.
4305 ISO C prohibits qualified @code{void} return types on function
4306 definitions, so such return types always receive a warning
4307 even without this option.
4309 This warning is also enabled by @option{-Wextra}.
4311 @item -Wignored-attributes @r{(C and C++ only)}
4312 @opindex Wignored-attributes
4313 @opindex Wno-ignored-attributes
4314 Warn when an attribute is ignored.  This is different from the
4315 @option{-Wattributes} option in that it warns whenever the compiler decides
4316 to drop an attribute, not that the attribute is either unknown, used in a
4317 wrong place, etc.  This warning is enabled by default.
4319 @item -Wmain
4320 @opindex Wmain
4321 @opindex Wno-main
4322 Warn if the type of @code{main} is suspicious.  @code{main} should be
4323 a function with external linkage, returning int, taking either zero
4324 arguments, two, or three arguments of appropriate types.  This warning
4325 is enabled by default in C++ and is enabled by either @option{-Wall}
4326 or @option{-Wpedantic}.
4328 @item -Wmisleading-indentation @r{(C and C++ only)}
4329 @opindex Wmisleading-indentation
4330 @opindex Wno-misleading-indentation
4331 Warn when the indentation of the code does not reflect the block structure.
4332 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4333 @code{for} clauses with a guarded statement that does not use braces,
4334 followed by an unguarded statement with the same indentation.
4336 In the following example, the call to ``bar'' is misleadingly indented as
4337 if it were guarded by the ``if'' conditional.
4339 @smallexample
4340   if (some_condition ())
4341     foo ();
4342     bar ();  /* Gotcha: this is not guarded by the "if".  */
4343 @end smallexample
4345 In the case of mixed tabs and spaces, the warning uses the
4346 @option{-ftabstop=} option to determine if the statements line up
4347 (defaulting to 8).
4349 The warning is not issued for code involving multiline preprocessor logic
4350 such as the following example.
4352 @smallexample
4353   if (flagA)
4354     foo (0);
4355 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4356   if (flagB)
4357 #endif
4358     foo (1);
4359 @end smallexample
4361 The warning is not issued after a @code{#line} directive, since this
4362 typically indicates autogenerated code, and no assumptions can be made
4363 about the layout of the file that the directive references.
4365 This warning is enabled by @option{-Wall} in C and C++.
4367 @item -Wmissing-braces
4368 @opindex Wmissing-braces
4369 @opindex Wno-missing-braces
4370 Warn if an aggregate or union initializer is not fully bracketed.  In
4371 the following example, the initializer for @code{a} is not fully
4372 bracketed, but that for @code{b} is fully bracketed.  This warning is
4373 enabled by @option{-Wall} in C.
4375 @smallexample
4376 int a[2][2] = @{ 0, 1, 2, 3 @};
4377 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4378 @end smallexample
4380 This warning is enabled by @option{-Wall}.
4382 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4383 @opindex Wmissing-include-dirs
4384 @opindex Wno-missing-include-dirs
4385 Warn if a user-supplied include directory does not exist.
4387 @item -Wparentheses
4388 @opindex Wparentheses
4389 @opindex Wno-parentheses
4390 Warn if parentheses are omitted in certain contexts, such
4391 as when there is an assignment in a context where a truth value
4392 is expected, or when operators are nested whose precedence people
4393 often get confused about.
4395 Also warn if a comparison like @code{x<=y<=z} appears; this is
4396 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4397 interpretation from that of ordinary mathematical notation.
4399 Also warn for dangerous uses of the GNU extension to
4400 @code{?:} with omitted middle operand. When the condition
4401 in the @code{?}: operator is a boolean expression, the omitted value is
4402 always 1.  Often programmers expect it to be a value computed
4403 inside the conditional expression instead.
4405 This warning is enabled by @option{-Wall}.
4407 @item -Wsequence-point
4408 @opindex Wsequence-point
4409 @opindex Wno-sequence-point
4410 Warn about code that may have undefined semantics because of violations
4411 of sequence point rules in the C and C++ standards.
4413 The C and C++ standards define the order in which expressions in a C/C++
4414 program are evaluated in terms of @dfn{sequence points}, which represent
4415 a partial ordering between the execution of parts of the program: those
4416 executed before the sequence point, and those executed after it.  These
4417 occur after the evaluation of a full expression (one which is not part
4418 of a larger expression), after the evaluation of the first operand of a
4419 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4420 function is called (but after the evaluation of its arguments and the
4421 expression denoting the called function), and in certain other places.
4422 Other than as expressed by the sequence point rules, the order of
4423 evaluation of subexpressions of an expression is not specified.  All
4424 these rules describe only a partial order rather than a total order,
4425 since, for example, if two functions are called within one expression
4426 with no sequence point between them, the order in which the functions
4427 are called is not specified.  However, the standards committee have
4428 ruled that function calls do not overlap.
4430 It is not specified when between sequence points modifications to the
4431 values of objects take effect.  Programs whose behavior depends on this
4432 have undefined behavior; the C and C++ standards specify that ``Between
4433 the previous and next sequence point an object shall have its stored
4434 value modified at most once by the evaluation of an expression.
4435 Furthermore, the prior value shall be read only to determine the value
4436 to be stored.''.  If a program breaks these rules, the results on any
4437 particular implementation are entirely unpredictable.
4439 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4440 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4441 diagnosed by this option, and it may give an occasional false positive
4442 result, but in general it has been found fairly effective at detecting
4443 this sort of problem in programs.
4445 The C++17 standard will define the order of evaluation of operands in
4446 more cases: in particular it requires that the right-hand side of an
4447 assignment be evaluated before the left-hand side, so the above
4448 examples are no longer undefined.  But this warning will still warn
4449 about them, to help people avoid writing code that is undefined in C
4450 and earlier revisions of C++.
4452 The standard is worded confusingly, therefore there is some debate
4453 over the precise meaning of the sequence point rules in subtle cases.
4454 Links to discussions of the problem, including proposed formal
4455 definitions, may be found on the GCC readings page, at
4456 @uref{http://gcc.gnu.org/@/readings.html}.
4458 This warning is enabled by @option{-Wall} for C and C++.
4460 @item -Wno-return-local-addr
4461 @opindex Wno-return-local-addr
4462 @opindex Wreturn-local-addr
4463 Do not warn about returning a pointer (or in C++, a reference) to a
4464 variable that goes out of scope after the function returns.
4466 @item -Wreturn-type
4467 @opindex Wreturn-type
4468 @opindex Wno-return-type
4469 Warn whenever a function is defined with a return type that defaults
4470 to @code{int}.  Also warn about any @code{return} statement with no
4471 return value in a function whose return type is not @code{void}
4472 (falling off the end of the function body is considered returning
4473 without a value).
4475 For C only, warn about a @code{return} statement with an expression in a
4476 function whose return type is @code{void}, unless the expression type is
4477 also @code{void}.  As a GNU extension, the latter case is accepted
4478 without a warning unless @option{-Wpedantic} is used.
4480 For C++, a function without return type always produces a diagnostic
4481 message, even when @option{-Wno-return-type} is specified.  The only
4482 exceptions are @code{main} and functions defined in system headers.
4484 This warning is enabled by @option{-Wall}.
4486 @item -Wshift-count-negative
4487 @opindex Wshift-count-negative
4488 @opindex Wno-shift-count-negative
4489 Warn if shift count is negative. This warning is enabled by default.
4491 @item -Wshift-count-overflow
4492 @opindex Wshift-count-overflow
4493 @opindex Wno-shift-count-overflow
4494 Warn if shift count >= width of type. This warning is enabled by default.
4496 @item -Wshift-negative-value
4497 @opindex Wshift-negative-value
4498 @opindex Wno-shift-negative-value
4499 Warn if left shifting a negative value.  This warning is enabled by
4500 @option{-Wextra} in C99 and C++11 modes (and newer).
4502 @item -Wshift-overflow
4503 @itemx -Wshift-overflow=@var{n}
4504 @opindex Wshift-overflow
4505 @opindex Wno-shift-overflow
4506 Warn about left shift overflows.  This warning is enabled by
4507 default in C99 and C++11 modes (and newer).
4509 @table @gcctabopt
4510 @item -Wshift-overflow=1
4511 This is the warning level of @option{-Wshift-overflow} and is enabled
4512 by default in C99 and C++11 modes (and newer).  This warning level does
4513 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4514 an overflow is still rejected in contexts where an integer constant expression
4515 is required.)
4517 @item -Wshift-overflow=2
4518 This warning level also warns about left-shifting 1 into the sign bit,
4519 unless C++14 mode is active.
4520 @end table
4522 @item -Wswitch
4523 @opindex Wswitch
4524 @opindex Wno-switch
4525 Warn whenever a @code{switch} statement has an index of enumerated type
4526 and lacks a @code{case} for one or more of the named codes of that
4527 enumeration.  (The presence of a @code{default} label prevents this
4528 warning.)  @code{case} labels outside the enumeration range also
4529 provoke warnings when this option is used (even if there is a
4530 @code{default} label).
4531 This warning is enabled by @option{-Wall}.
4533 @item -Wswitch-default
4534 @opindex Wswitch-default
4535 @opindex Wno-switch-default
4536 Warn whenever a @code{switch} statement does not have a @code{default}
4537 case.
4539 @item -Wswitch-enum
4540 @opindex Wswitch-enum
4541 @opindex Wno-switch-enum
4542 Warn whenever a @code{switch} statement has an index of enumerated type
4543 and lacks a @code{case} for one or more of the named codes of that
4544 enumeration.  @code{case} labels outside the enumeration range also
4545 provoke warnings when this option is used.  The only difference
4546 between @option{-Wswitch} and this option is that this option gives a
4547 warning about an omitted enumeration code even if there is a
4548 @code{default} label.
4550 @item -Wswitch-bool
4551 @opindex Wswitch-bool
4552 @opindex Wno-switch-bool
4553 Warn whenever a @code{switch} statement has an index of boolean type
4554 and the case values are outside the range of a boolean type.
4555 It is possible to suppress this warning by casting the controlling
4556 expression to a type other than @code{bool}.  For example:
4557 @smallexample
4558 @group
4559 switch ((int) (a == 4))
4560   @{
4561   @dots{}
4562   @}
4563 @end group
4564 @end smallexample
4565 This warning is enabled by default for C and C++ programs.
4567 @item -Wswitch-unreachable
4568 @opindex Wswitch-unreachable
4569 @opindex Wno-switch-unreachable
4570 Warn whenever a @code{switch} statement contains statements between the
4571 controlling expression and the first case label, which will never be
4572 executed.  For example:
4573 @smallexample
4574 @group
4575 switch (cond)
4576   @{
4577    i = 15;
4578   @dots{}
4579    case 5:
4580   @dots{}
4581   @}
4582 @end group
4583 @end smallexample
4584 @option{-Wswitch-unreachable} does not warn if the statement between the
4585 controlling expression and the first case label is just a declaration:
4586 @smallexample
4587 @group
4588 switch (cond)
4589   @{
4590    int i;
4591   @dots{}
4592    case 5:
4593    i = 5;
4594   @dots{}
4595   @}
4596 @end group
4597 @end smallexample
4598 This warning is enabled by default for C and C++ programs.
4600 @item -Wsync-nand @r{(C and C++ only)}
4601 @opindex Wsync-nand
4602 @opindex Wno-sync-nand
4603 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4604 built-in functions are used.  These functions changed semantics in GCC 4.4.
4606 @item -Wunused-but-set-parameter
4607 @opindex Wunused-but-set-parameter
4608 @opindex Wno-unused-but-set-parameter
4609 Warn whenever a function parameter is assigned to, but otherwise unused
4610 (aside from its declaration).
4612 To suppress this warning use the @code{unused} attribute
4613 (@pxref{Variable Attributes}).
4615 This warning is also enabled by @option{-Wunused} together with
4616 @option{-Wextra}.
4618 @item -Wunused-but-set-variable
4619 @opindex Wunused-but-set-variable
4620 @opindex Wno-unused-but-set-variable
4621 Warn whenever a local variable is assigned to, but otherwise unused
4622 (aside from its declaration).
4623 This warning is enabled by @option{-Wall}.
4625 To suppress this warning use the @code{unused} attribute
4626 (@pxref{Variable Attributes}).
4628 This warning is also enabled by @option{-Wunused}, which is enabled
4629 by @option{-Wall}.
4631 @item -Wunused-function
4632 @opindex Wunused-function
4633 @opindex Wno-unused-function
4634 Warn whenever a static function is declared but not defined or a
4635 non-inline static function is unused.
4636 This warning is enabled by @option{-Wall}.
4638 @item -Wunused-label
4639 @opindex Wunused-label
4640 @opindex Wno-unused-label
4641 Warn whenever a label is declared but not used.
4642 This warning is enabled by @option{-Wall}.
4644 To suppress this warning use the @code{unused} attribute
4645 (@pxref{Variable Attributes}).
4647 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4648 @opindex Wunused-local-typedefs
4649 Warn when a typedef locally defined in a function is not used.
4650 This warning is enabled by @option{-Wall}.
4652 @item -Wunused-parameter
4653 @opindex Wunused-parameter
4654 @opindex Wno-unused-parameter
4655 Warn whenever a function parameter is unused aside from its declaration.
4657 To suppress this warning use the @code{unused} attribute
4658 (@pxref{Variable Attributes}).
4660 @item -Wno-unused-result
4661 @opindex Wunused-result
4662 @opindex Wno-unused-result
4663 Do not warn if a caller of a function marked with attribute
4664 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4665 its return value. The default is @option{-Wunused-result}.
4667 @item -Wunused-variable
4668 @opindex Wunused-variable
4669 @opindex Wno-unused-variable
4670 Warn whenever a local or static variable is unused aside from its
4671 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4672 but not for C++. This warning is enabled by @option{-Wall}.
4674 To suppress this warning use the @code{unused} attribute
4675 (@pxref{Variable Attributes}).
4677 @item -Wunused-const-variable
4678 @itemx -Wunused-const-variable=@var{n}
4679 @opindex Wunused-const-variable
4680 @opindex Wno-unused-const-variable
4681 Warn whenever a constant static variable is unused aside from its declaration.
4682 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4683 for C, but not for C++. In C this declares variable storage, but in C++ this
4684 is not an error since const variables take the place of @code{#define}s.
4686 To suppress this warning use the @code{unused} attribute
4687 (@pxref{Variable Attributes}).
4689 @table @gcctabopt
4690 @item -Wunused-const-variable=1
4691 This is the warning level that is enabled by @option{-Wunused-variable} for
4692 C.  It warns only about unused static const variables defined in the main
4693 compilation unit, but not about static const variables declared in any
4694 header included.
4696 @item -Wunused-const-variable=2
4697 This warning level also warns for unused constant static variables in
4698 headers (excluding system headers).  This is the warning level of
4699 @option{-Wunused-const-variable} and must be explicitly requested since
4700 in C++ this isn't an error and in C it might be harder to clean up all
4701 headers included.
4702 @end table
4704 @item -Wunused-value
4705 @opindex Wunused-value
4706 @opindex Wno-unused-value
4707 Warn whenever a statement computes a result that is explicitly not
4708 used. To suppress this warning cast the unused expression to
4709 @code{void}. This includes an expression-statement or the left-hand
4710 side of a comma expression that contains no side effects. For example,
4711 an expression such as @code{x[i,j]} causes a warning, while
4712 @code{x[(void)i,j]} does not.
4714 This warning is enabled by @option{-Wall}.
4716 @item -Wunused
4717 @opindex Wunused
4718 @opindex Wno-unused
4719 All the above @option{-Wunused} options combined.
4721 In order to get a warning about an unused function parameter, you must
4722 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4723 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4725 @item -Wuninitialized
4726 @opindex Wuninitialized
4727 @opindex Wno-uninitialized
4728 Warn if an automatic variable is used without first being initialized
4729 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4730 warn if a non-static reference or non-static @code{const} member
4731 appears in a class without constructors.
4733 If you want to warn about code that uses the uninitialized value of the
4734 variable in its own initializer, use the @option{-Winit-self} option.
4736 These warnings occur for individual uninitialized or clobbered
4737 elements of structure, union or array variables as well as for
4738 variables that are uninitialized or clobbered as a whole.  They do
4739 not occur for variables or elements declared @code{volatile}.  Because
4740 these warnings depend on optimization, the exact variables or elements
4741 for which there are warnings depends on the precise optimization
4742 options and version of GCC used.
4744 Note that there may be no warning about a variable that is used only
4745 to compute a value that itself is never used, because such
4746 computations may be deleted by data flow analysis before the warnings
4747 are printed.
4749 @item -Winvalid-memory-model
4750 @opindex Winvalid-memory-model
4751 @opindex Wno-invalid-memory-model
4752 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4753 and the C11 atomic generic functions with a memory consistency argument
4754 that is either invalid for the operation or outside the range of values
4755 of the @code{memory_order} enumeration.  For example, since the
4756 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4757 defined for the relaxed, release, and sequentially consistent memory
4758 orders the following code is diagnosed:
4760 @smallexample
4761 void store (int *i)
4763   __atomic_store_n (i, 0, memory_order_consume);
4765 @end smallexample
4767 @option{-Winvalid-memory-model} is enabled by default.
4769 @item -Wmaybe-uninitialized
4770 @opindex Wmaybe-uninitialized
4771 @opindex Wno-maybe-uninitialized
4772 For an automatic variable, if there exists a path from the function
4773 entry to a use of the variable that is initialized, but there exist
4774 some other paths for which the variable is not initialized, the compiler
4775 emits a warning if it cannot prove the uninitialized paths are not
4776 executed at run time. These warnings are made optional because GCC is
4777 not smart enough to see all the reasons why the code might be correct
4778 in spite of appearing to have an error.  Here is one example of how
4779 this can happen:
4781 @smallexample
4782 @group
4784   int x;
4785   switch (y)
4786     @{
4787     case 1: x = 1;
4788       break;
4789     case 2: x = 4;
4790       break;
4791     case 3: x = 5;
4792     @}
4793   foo (x);
4795 @end group
4796 @end smallexample
4798 @noindent
4799 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4800 always initialized, but GCC doesn't know this. To suppress the
4801 warning, you need to provide a default case with assert(0) or
4802 similar code.
4804 @cindex @code{longjmp} warnings
4805 This option also warns when a non-volatile automatic variable might be
4806 changed by a call to @code{longjmp}.  These warnings as well are possible
4807 only in optimizing compilation.
4809 The compiler sees only the calls to @code{setjmp}.  It cannot know
4810 where @code{longjmp} will be called; in fact, a signal handler could
4811 call it at any point in the code.  As a result, you may get a warning
4812 even when there is in fact no problem because @code{longjmp} cannot
4813 in fact be called at the place that would cause a problem.
4815 Some spurious warnings can be avoided if you declare all the functions
4816 you use that never return as @code{noreturn}.  @xref{Function
4817 Attributes}.
4819 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4821 @item -Wunknown-pragmas
4822 @opindex Wunknown-pragmas
4823 @opindex Wno-unknown-pragmas
4824 @cindex warning for unknown pragmas
4825 @cindex unknown pragmas, warning
4826 @cindex pragmas, warning of unknown
4827 Warn when a @code{#pragma} directive is encountered that is not understood by 
4828 GCC@.  If this command-line option is used, warnings are even issued
4829 for unknown pragmas in system header files.  This is not the case if
4830 the warnings are only enabled by the @option{-Wall} command-line option.
4832 @item -Wno-pragmas
4833 @opindex Wno-pragmas
4834 @opindex Wpragmas
4835 Do not warn about misuses of pragmas, such as incorrect parameters,
4836 invalid syntax, or conflicts between pragmas.  See also
4837 @option{-Wunknown-pragmas}.
4839 @item -Wstrict-aliasing
4840 @opindex Wstrict-aliasing
4841 @opindex Wno-strict-aliasing
4842 This option is only active when @option{-fstrict-aliasing} is active.
4843 It warns about code that might break the strict aliasing rules that the
4844 compiler is using for optimization.  The warning does not catch all
4845 cases, but does attempt to catch the more common pitfalls.  It is
4846 included in @option{-Wall}.
4847 It is equivalent to @option{-Wstrict-aliasing=3}
4849 @item -Wstrict-aliasing=n
4850 @opindex Wstrict-aliasing=n
4851 This option is only active when @option{-fstrict-aliasing} is active.
4852 It warns about code that might break the strict aliasing rules that the
4853 compiler is using for optimization.
4854 Higher levels correspond to higher accuracy (fewer false positives).
4855 Higher levels also correspond to more effort, similar to the way @option{-O} 
4856 works.
4857 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4859 Level 1: Most aggressive, quick, least accurate.
4860 Possibly useful when higher levels
4861 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4862 false negatives.  However, it has many false positives.
4863 Warns for all pointer conversions between possibly incompatible types,
4864 even if never dereferenced.  Runs in the front end only.
4866 Level 2: Aggressive, quick, not too precise.
4867 May still have many false positives (not as many as level 1 though),
4868 and few false negatives (but possibly more than level 1).
4869 Unlike level 1, it only warns when an address is taken.  Warns about
4870 incomplete types.  Runs in the front end only.
4872 Level 3 (default for @option{-Wstrict-aliasing}):
4873 Should have very few false positives and few false
4874 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4875 Takes care of the common pun+dereference pattern in the front end:
4876 @code{*(int*)&some_float}.
4877 If optimization is enabled, it also runs in the back end, where it deals
4878 with multiple statement cases using flow-sensitive points-to information.
4879 Only warns when the converted pointer is dereferenced.
4880 Does not warn about incomplete types.
4882 @item -Wstrict-overflow
4883 @itemx -Wstrict-overflow=@var{n}
4884 @opindex Wstrict-overflow
4885 @opindex Wno-strict-overflow
4886 This option is only active when @option{-fstrict-overflow} is active.
4887 It warns about cases where the compiler optimizes based on the
4888 assumption that signed overflow does not occur.  Note that it does not
4889 warn about all cases where the code might overflow: it only warns
4890 about cases where the compiler implements some optimization.  Thus
4891 this warning depends on the optimization level.
4893 An optimization that assumes that signed overflow does not occur is
4894 perfectly safe if the values of the variables involved are such that
4895 overflow never does, in fact, occur.  Therefore this warning can
4896 easily give a false positive: a warning about code that is not
4897 actually a problem.  To help focus on important issues, several
4898 warning levels are defined.  No warnings are issued for the use of
4899 undefined signed overflow when estimating how many iterations a loop
4900 requires, in particular when determining whether a loop will be
4901 executed at all.
4903 @table @gcctabopt
4904 @item -Wstrict-overflow=1
4905 Warn about cases that are both questionable and easy to avoid.  For
4906 example,  with @option{-fstrict-overflow}, the compiler simplifies
4907 @code{x + 1 > x} to @code{1}.  This level of
4908 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4909 are not, and must be explicitly requested.
4911 @item -Wstrict-overflow=2
4912 Also warn about other cases where a comparison is simplified to a
4913 constant.  For example: @code{abs (x) >= 0}.  This can only be
4914 simplified when @option{-fstrict-overflow} is in effect, because
4915 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4916 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4917 @option{-Wstrict-overflow=2}.
4919 @item -Wstrict-overflow=3
4920 Also warn about other cases where a comparison is simplified.  For
4921 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4923 @item -Wstrict-overflow=4
4924 Also warn about other simplifications not covered by the above cases.
4925 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4927 @item -Wstrict-overflow=5
4928 Also warn about cases where the compiler reduces the magnitude of a
4929 constant involved in a comparison.  For example: @code{x + 2 > y} is
4930 simplified to @code{x + 1 >= y}.  This is reported only at the
4931 highest warning level because this simplification applies to many
4932 comparisons, so this warning level gives a very large number of
4933 false positives.
4934 @end table
4936 @item -Wstringop-overflow
4937 @itemx -Wstringop-overflow=@var{type}
4938 @opindex Wstringop-overflow
4939 @opindex Wno-stringop-overflow
4940 Warn for calls to string manipulation functions such as @code{memcpy} and
4941 @code{strcpy} that are determined to overflow the destination buffer.  The
4942 optional argument is one greater than the type of Object Size Checking to
4943 perform to determine the size of the destination.  @xref{Object Size Checking}.
4944 The argument is meaningful only for functions that operate on character arrays
4945 but not for raw memory functions like @code{memcpy} which always make use
4946 of Object Size type-0.  The option also warns for calls that specify a size
4947 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
4948 The option produces the best results with optimization enabled but can detect
4949 a small subset of simple buffer overflows even without optimization in
4950 calls to the GCC built-in functions like @code{__builtin_memcpy} that
4951 correspond to the standard functions.  In any case, the option warns about
4952 just a subset of buffer overflows detected by the corresponding overflow
4953 checking built-ins.  For example, the option will issue a warning for
4954 the @code{strcpy} call below because it copies at least 5 characters
4955 (the string @code{"blue"} including the terminating NUL) into the buffer
4956 of size 4.
4958 @smallexample
4959 enum Color @{ blue, purple, yellow @};
4960 const char* f (enum Color clr)
4962   static char buf [4];
4963   const char *str;
4964   switch (clr)
4965     @{
4966       case blue: str = "blue"; break;
4967       case purple: str = "purple"; break;
4968       case yellow: str = "yellow"; break;
4969     @}
4971   return strcpy (buf, str);   // warning here
4973 @end smallexample
4975 Option @option{-Wstringop-overflow=2} is enabled by default.
4977 @table @gcctabopt
4978 @item -Wstringop-overflow
4979 @item -Wstringop-overflow=1
4980 @opindex Wstringop-overflow
4981 @opindex Wno-stringop-overflow
4982 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
4983 to determine the sizes of destination objects.  This is the default setting
4984 of the option.  At this setting the option will not warn for writes past
4985 the end of subobjects of larger objects accessed by pointers unless the
4986 size of the largest surrounding object is known.  When the destination may
4987 be one of several objects it is assumed to be the largest one of them.  On
4988 Linux systems, when optimization is enabled at this setting the option warns
4989 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
4990 a non-zero value.
4992 @item -Wstringop-overflow=2
4993 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
4994 to determine the sizes of destination objects.  At this setting the option
4995 will warn about overflows when writing to members of the largest complete
4996 objects whose exact size is known.  It will, however, not warn for excessive
4997 writes to the same members of unknown objects referenced by pointers since
4998 they may point to arrays containing unknown numbers of elements.
5000 @item -Wstringop-overflow=3
5001 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5002 to determine the sizes of destination objects.  At this setting the option
5003 warns about overflowing the smallest object or data member.  This is the
5004 most restrictive setting of the option that may result in warnings for safe
5005 code.
5007 @item -Wstringop-overflow=4
5008 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5009 to determine the sizes of destination objects.  At this setting the option
5010 will warn about overflowing any data members, and when the destination is
5011 one of several objects it uses the size of the largest of them to decide
5012 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5013 setting of the option may result in warnings for benign code.
5014 @end table
5016 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5017 @opindex Wsuggest-attribute=
5018 @opindex Wno-suggest-attribute=
5019 Warn for cases where adding an attribute may be beneficial. The
5020 attributes currently supported are listed below.
5022 @table @gcctabopt
5023 @item -Wsuggest-attribute=pure
5024 @itemx -Wsuggest-attribute=const
5025 @itemx -Wsuggest-attribute=noreturn
5026 @opindex Wsuggest-attribute=pure
5027 @opindex Wno-suggest-attribute=pure
5028 @opindex Wsuggest-attribute=const
5029 @opindex Wno-suggest-attribute=const
5030 @opindex Wsuggest-attribute=noreturn
5031 @opindex Wno-suggest-attribute=noreturn
5033 Warn about functions that might be candidates for attributes
5034 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5035 functions visible in other compilation units or (in the case of @code{pure} and
5036 @code{const}) if it cannot prove that the function returns normally. A function
5037 returns normally if it doesn't contain an infinite loop or return abnormally
5038 by throwing, calling @code{abort} or trapping.  This analysis requires option
5039 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5040 higher.  Higher optimization levels improve the accuracy of the analysis.
5042 @item -Wsuggest-attribute=format
5043 @itemx -Wmissing-format-attribute
5044 @opindex Wsuggest-attribute=format
5045 @opindex Wmissing-format-attribute
5046 @opindex Wno-suggest-attribute=format
5047 @opindex Wno-missing-format-attribute
5048 @opindex Wformat
5049 @opindex Wno-format
5051 Warn about function pointers that might be candidates for @code{format}
5052 attributes.  Note these are only possible candidates, not absolute ones.
5053 GCC guesses that function pointers with @code{format} attributes that
5054 are used in assignment, initialization, parameter passing or return
5055 statements should have a corresponding @code{format} attribute in the
5056 resulting type.  I.e.@: the left-hand side of the assignment or
5057 initialization, the type of the parameter variable, or the return type
5058 of the containing function respectively should also have a @code{format}
5059 attribute to avoid the warning.
5061 GCC also warns about function definitions that might be
5062 candidates for @code{format} attributes.  Again, these are only
5063 possible candidates.  GCC guesses that @code{format} attributes
5064 might be appropriate for any function that calls a function like
5065 @code{vprintf} or @code{vscanf}, but this might not always be the
5066 case, and some functions for which @code{format} attributes are
5067 appropriate may not be detected.
5068 @end table
5070 @item -Wsuggest-final-types
5071 @opindex Wno-suggest-final-types
5072 @opindex Wsuggest-final-types
5073 Warn about types with virtual methods where code quality would be improved
5074 if the type were declared with the C++11 @code{final} specifier, 
5075 or, if possible,
5076 declared in an anonymous namespace. This allows GCC to more aggressively
5077 devirtualize the polymorphic calls. This warning is more effective with link
5078 time optimization, where the information about the class hierarchy graph is
5079 more complete.
5081 @item -Wsuggest-final-methods
5082 @opindex Wno-suggest-final-methods
5083 @opindex Wsuggest-final-methods
5084 Warn about virtual methods where code quality would be improved if the method
5085 were declared with the C++11 @code{final} specifier, 
5086 or, if possible, its type were
5087 declared in an anonymous namespace or with the @code{final} specifier.
5088 This warning is
5089 more effective with link time optimization, where the information about the
5090 class hierarchy graph is more complete. It is recommended to first consider
5091 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5092 annotations.
5094 @item -Wsuggest-override
5095 Warn about overriding virtual functions that are not marked with the override
5096 keyword.
5098 @item -Walloc-zero
5099 @opindex Wno-alloc-zero
5100 @opindex Walloc-zero
5101 Warn about calls to allocation functions decorated with attribute
5102 @code{alloc_size} that specify zero bytes, including those to the built-in
5103 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5104 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5105 when called with a zero size differs among implementations (and in the case
5106 of @code{realloc} has been deprecated) relying on it may result in subtle
5107 portability bugs and should be avoided.
5109 @item -Walloc-size-larger-than=@var{n}
5110 Warn about calls to functions decorated with attribute @code{alloc_size}
5111 that attempt to allocate objects larger than the specified number of bytes,
5112 or where the result of the size computation in an integer type with infinite
5113 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5114 may end in one of the standard suffixes designating a multiple of bytes
5115 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5116 @code{MB} and @code{MiB} for magabyte and mebibyte, and so on.
5117 @xref{Function Attributes}.
5119 @item -Walloca
5120 @opindex Wno-alloca
5121 @opindex Walloca
5122 This option warns on all uses of @code{alloca} in the source.
5124 @item -Walloca-larger-than=@var{n}
5125 This option warns on calls to @code{alloca} that are not bounded by a
5126 controlling predicate limiting its argument of integer type to at most
5127 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5128 Arguments of non-integer types are considered unbounded even if they
5129 appear to be constrained to the expected range.
5131 For example, a bounded case of @code{alloca} could be:
5133 @smallexample
5134 void func (size_t n)
5136   void *p;
5137   if (n <= 1000)
5138     p = alloca (n);
5139   else
5140     p = malloc (n);
5141   f (p);
5143 @end smallexample
5145 In the above example, passing @code{-Walloca-larger-than=1000} would not
5146 issue a warning because the call to @code{alloca} is known to be at most
5147 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5148 the compiler would emit a warning.
5150 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5151 controlling predicate constraining its integer argument.  For example:
5153 @smallexample
5154 void func ()
5156   void *p = alloca (n);
5157   f (p);
5159 @end smallexample
5161 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5162 a warning, but this time because of the lack of bounds checking.
5164 Note, that even seemingly correct code involving signed integers could
5165 cause a warning:
5167 @smallexample
5168 void func (signed int n)
5170   if (n < 500)
5171     @{
5172       p = alloca (n);
5173       f (p);
5174     @}
5176 @end smallexample
5178 In the above example, @var{n} could be negative, causing a larger than
5179 expected argument to be implicitly cast into the @code{alloca} call.
5181 This option also warns when @code{alloca} is used in a loop.
5183 This warning is not enabled by @option{-Wall}, and is only active when
5184 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5186 See also @option{-Wvla-larger-than=@var{n}}.
5188 @item -Warray-bounds
5189 @itemx -Warray-bounds=@var{n}
5190 @opindex Wno-array-bounds
5191 @opindex Warray-bounds
5192 This option is only active when @option{-ftree-vrp} is active
5193 (default for @option{-O2} and above). It warns about subscripts to arrays
5194 that are always out of bounds. This warning is enabled by @option{-Wall}.
5196 @table @gcctabopt
5197 @item -Warray-bounds=1
5198 This is the warning level of @option{-Warray-bounds} and is enabled
5199 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5201 @item -Warray-bounds=2
5202 This warning level also warns about out of bounds access for
5203 arrays at the end of a struct and for arrays accessed through
5204 pointers. This warning level may give a larger number of
5205 false positives and is deactivated by default.
5206 @end table
5208 @item -Wbool-compare
5209 @opindex Wno-bool-compare
5210 @opindex Wbool-compare
5211 Warn about boolean expression compared with an integer value different from
5212 @code{true}/@code{false}.  For instance, the following comparison is
5213 always false:
5214 @smallexample
5215 int n = 5;
5216 @dots{}
5217 if ((n > 1) == 2) @{ @dots{} @}
5218 @end smallexample
5219 This warning is enabled by @option{-Wall}.
5221 @item -Wbool-operation
5222 @opindex Wno-bool-operation
5223 @opindex Wbool-operation
5224 Warn about suspicious operations on expressions of a boolean type.  For
5225 instance, bitwise negation of a boolean is very likely a bug in the program.
5226 For C, this warning also warns about incrementing or decrementing a boolean,
5227 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5228 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5230 This warning is enabled by @option{-Wall}.
5232 @item -Wduplicated-cond
5233 @opindex Wno-duplicated-cond
5234 @opindex Wduplicated-cond
5235 Warn about duplicated conditions in an if-else-if chain.  For instance,
5236 warn for the following code:
5237 @smallexample
5238 if (p->q != NULL) @{ @dots{} @}
5239 else if (p->q != NULL) @{ @dots{} @}
5240 @end smallexample
5242 @item -Wframe-address
5243 @opindex Wno-frame-address
5244 @opindex Wframe-address
5245 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5246 is called with an argument greater than 0.  Such calls may return indeterminate
5247 values or crash the program.  The warning is included in @option{-Wall}.
5249 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5250 @opindex Wno-discarded-qualifiers
5251 @opindex Wdiscarded-qualifiers
5252 Do not warn if type qualifiers on pointers are being discarded.
5253 Typically, the compiler warns if a @code{const char *} variable is
5254 passed to a function that takes a @code{char *} parameter.  This option
5255 can be used to suppress such a warning.
5257 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5258 @opindex Wno-discarded-array-qualifiers
5259 @opindex Wdiscarded-array-qualifiers
5260 Do not warn if type qualifiers on arrays which are pointer targets
5261 are being discarded. Typically, the compiler warns if a
5262 @code{const int (*)[]} variable is passed to a function that
5263 takes a @code{int (*)[]} parameter.  This option can be used to
5264 suppress such a warning.
5266 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5267 @opindex Wno-incompatible-pointer-types
5268 @opindex Wincompatible-pointer-types
5269 Do not warn when there is a conversion between pointers that have incompatible
5270 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5271 which warns for pointer argument passing or assignment with different
5272 signedness.
5274 @item -Wno-int-conversion @r{(C and Objective-C only)}
5275 @opindex Wno-int-conversion
5276 @opindex Wint-conversion
5277 Do not warn about incompatible integer to pointer and pointer to integer
5278 conversions.  This warning is about implicit conversions; for explicit
5279 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5280 @option{-Wno-pointer-to-int-cast} may be used.
5282 @item -Wno-div-by-zero
5283 @opindex Wno-div-by-zero
5284 @opindex Wdiv-by-zero
5285 Do not warn about compile-time integer division by zero.  Floating-point
5286 division by zero is not warned about, as it can be a legitimate way of
5287 obtaining infinities and NaNs.
5289 @item -Wsystem-headers
5290 @opindex Wsystem-headers
5291 @opindex Wno-system-headers
5292 @cindex warnings from system headers
5293 @cindex system headers, warnings from
5294 Print warning messages for constructs found in system header files.
5295 Warnings from system headers are normally suppressed, on the assumption
5296 that they usually do not indicate real problems and would only make the
5297 compiler output harder to read.  Using this command-line option tells
5298 GCC to emit warnings from system headers as if they occurred in user
5299 code.  However, note that using @option{-Wall} in conjunction with this
5300 option does @emph{not} warn about unknown pragmas in system
5301 headers---for that, @option{-Wunknown-pragmas} must also be used.
5303 @item -Wtautological-compare
5304 @opindex Wtautological-compare
5305 @opindex Wno-tautological-compare
5306 Warn if a self-comparison always evaluates to true or false.  This
5307 warning detects various mistakes such as:
5308 @smallexample
5309 int i = 1;
5310 @dots{}
5311 if (i > i) @{ @dots{} @}
5312 @end smallexample
5313 This warning is enabled by @option{-Wall}.
5315 @item -Wtrampolines
5316 @opindex Wtrampolines
5317 @opindex Wno-trampolines
5318 Warn about trampolines generated for pointers to nested functions.
5319 A trampoline is a small piece of data or code that is created at run
5320 time on the stack when the address of a nested function is taken, and is
5321 used to call the nested function indirectly.  For some targets, it is
5322 made up of data only and thus requires no special treatment.  But, for
5323 most targets, it is made up of code and thus requires the stack to be
5324 made executable in order for the program to work properly.
5326 @item -Wfloat-equal
5327 @opindex Wfloat-equal
5328 @opindex Wno-float-equal
5329 Warn if floating-point values are used in equality comparisons.
5331 The idea behind this is that sometimes it is convenient (for the
5332 programmer) to consider floating-point values as approximations to
5333 infinitely precise real numbers.  If you are doing this, then you need
5334 to compute (by analyzing the code, or in some other way) the maximum or
5335 likely maximum error that the computation introduces, and allow for it
5336 when performing comparisons (and when producing output, but that's a
5337 different problem).  In particular, instead of testing for equality, you
5338 should check to see whether the two values have ranges that overlap; and
5339 this is done with the relational operators, so equality comparisons are
5340 probably mistaken.
5342 @item -Wtraditional @r{(C and Objective-C only)}
5343 @opindex Wtraditional
5344 @opindex Wno-traditional
5345 Warn about certain constructs that behave differently in traditional and
5346 ISO C@.  Also warn about ISO C constructs that have no traditional C
5347 equivalent, and/or problematic constructs that should be avoided.
5349 @itemize @bullet
5350 @item
5351 Macro parameters that appear within string literals in the macro body.
5352 In traditional C macro replacement takes place within string literals,
5353 but in ISO C it does not.
5355 @item
5356 In traditional C, some preprocessor directives did not exist.
5357 Traditional preprocessors only considered a line to be a directive
5358 if the @samp{#} appeared in column 1 on the line.  Therefore
5359 @option{-Wtraditional} warns about directives that traditional C
5360 understands but ignores because the @samp{#} does not appear as the
5361 first character on the line.  It also suggests you hide directives like
5362 @code{#pragma} not understood by traditional C by indenting them.  Some
5363 traditional implementations do not recognize @code{#elif}, so this option
5364 suggests avoiding it altogether.
5366 @item
5367 A function-like macro that appears without arguments.
5369 @item
5370 The unary plus operator.
5372 @item
5373 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5374 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5375 constants.)  Note, these suffixes appear in macros defined in the system
5376 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5377 Use of these macros in user code might normally lead to spurious
5378 warnings, however GCC's integrated preprocessor has enough context to
5379 avoid warning in these cases.
5381 @item
5382 A function declared external in one block and then used after the end of
5383 the block.
5385 @item
5386 A @code{switch} statement has an operand of type @code{long}.
5388 @item
5389 A non-@code{static} function declaration follows a @code{static} one.
5390 This construct is not accepted by some traditional C compilers.
5392 @item
5393 The ISO type of an integer constant has a different width or
5394 signedness from its traditional type.  This warning is only issued if
5395 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5396 typically represent bit patterns, are not warned about.
5398 @item
5399 Usage of ISO string concatenation is detected.
5401 @item
5402 Initialization of automatic aggregates.
5404 @item
5405 Identifier conflicts with labels.  Traditional C lacks a separate
5406 namespace for labels.
5408 @item
5409 Initialization of unions.  If the initializer is zero, the warning is
5410 omitted.  This is done under the assumption that the zero initializer in
5411 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5412 initializer warnings and relies on default initialization to zero in the
5413 traditional C case.
5415 @item
5416 Conversions by prototypes between fixed/floating-point values and vice
5417 versa.  The absence of these prototypes when compiling with traditional
5418 C causes serious problems.  This is a subset of the possible
5419 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5421 @item
5422 Use of ISO C style function definitions.  This warning intentionally is
5423 @emph{not} issued for prototype declarations or variadic functions
5424 because these ISO C features appear in your code when using
5425 libiberty's traditional C compatibility macros, @code{PARAMS} and
5426 @code{VPARAMS}.  This warning is also bypassed for nested functions
5427 because that feature is already a GCC extension and thus not relevant to
5428 traditional C compatibility.
5429 @end itemize
5431 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5432 @opindex Wtraditional-conversion
5433 @opindex Wno-traditional-conversion
5434 Warn if a prototype causes a type conversion that is different from what
5435 would happen to the same argument in the absence of a prototype.  This
5436 includes conversions of fixed point to floating and vice versa, and
5437 conversions changing the width or signedness of a fixed-point argument
5438 except when the same as the default promotion.
5440 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5441 @opindex Wdeclaration-after-statement
5442 @opindex Wno-declaration-after-statement
5443 Warn when a declaration is found after a statement in a block.  This
5444 construct, known from C++, was introduced with ISO C99 and is by default
5445 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5447 @item -Wshadow
5448 @opindex Wshadow
5449 @opindex Wno-shadow
5450 Warn whenever a local variable or type declaration shadows another
5451 variable, parameter, type, class member (in C++), or instance variable
5452 (in Objective-C) or whenever a built-in function is shadowed. Note
5453 that in C++, the compiler warns if a local variable shadows an
5454 explicit typedef, but not if it shadows a struct/class/enum.
5455 Same as @option{-Wshadow=global}.
5457 @item -Wno-shadow-ivar @r{(Objective-C only)}
5458 @opindex Wno-shadow-ivar
5459 @opindex Wshadow-ivar
5460 Do not warn whenever a local variable shadows an instance variable in an
5461 Objective-C method.
5463 @item -Wshadow=global
5464 @opindex Wshadow=local
5465 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5467 @item -Wshadow=local
5468 @opindex Wshadow=local
5469 Warn when a local variable shadows another local variable or parameter.
5470 This warning is enabled by @option{-Wshadow=global}.
5472 @item -Wshadow=compatible-local
5473 @opindex Wshadow=compatible-local
5474 Warn when a local variable shadows another local variable or parameter
5475 whose type is compatible with that of the shadowing variable. In C++,
5476 type compatibility here means the type of the shadowing variable can be
5477 converted to that of the shadowed variable. The creation of this flag
5478 (in addition to @option{-Wshadow=local}) is based on the idea that when
5479 a local variable shadows another one of incompatible type, it is most
5480 likely intentional, not a bug or typo, as shown in the following example:
5482 @smallexample
5483 @group
5484 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5486   for (int i = 0; i < N; ++i)
5487   @{
5488     ...
5489   @}
5490   ...
5492 @end group
5493 @end smallexample
5495 Since the two variable @code{i} in the example above have incompatible types,
5496 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5497 Because their types are incompatible, if a programmer accidentally uses one
5498 in place of the other, type checking will catch that and emit an error or
5499 warning. So not warning (about shadowing) in this case will not lead to
5500 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5501 possibly reduce the number of warnings triggered by intentional shadowing.
5503 This warning is enabled by @option{-Wshadow=local}.
5505 @item -Wlarger-than=@var{len}
5506 @opindex Wlarger-than=@var{len}
5507 @opindex Wlarger-than-@var{len}
5508 Warn whenever an object of larger than @var{len} bytes is defined.
5510 @item -Wframe-larger-than=@var{len}
5511 @opindex Wframe-larger-than
5512 Warn if the size of a function frame is larger than @var{len} bytes.
5513 The computation done to determine the stack frame size is approximate
5514 and not conservative.
5515 The actual requirements may be somewhat greater than @var{len}
5516 even if you do not get a warning.  In addition, any space allocated
5517 via @code{alloca}, variable-length arrays, or related constructs
5518 is not included by the compiler when determining
5519 whether or not to issue a warning.
5521 @item -Wno-free-nonheap-object
5522 @opindex Wno-free-nonheap-object
5523 @opindex Wfree-nonheap-object
5524 Do not warn when attempting to free an object that was not allocated
5525 on the heap.
5527 @item -Wstack-usage=@var{len}
5528 @opindex Wstack-usage
5529 Warn if the stack usage of a function might be larger than @var{len} bytes.
5530 The computation done to determine the stack usage is conservative.
5531 Any space allocated via @code{alloca}, variable-length arrays, or related
5532 constructs is included by the compiler when determining whether or not to
5533 issue a warning.
5535 The message is in keeping with the output of @option{-fstack-usage}.
5537 @itemize
5538 @item
5539 If the stack usage is fully static but exceeds the specified amount, it's:
5541 @smallexample
5542   warning: stack usage is 1120 bytes
5543 @end smallexample
5544 @item
5545 If the stack usage is (partly) dynamic but bounded, it's:
5547 @smallexample
5548   warning: stack usage might be 1648 bytes
5549 @end smallexample
5550 @item
5551 If the stack usage is (partly) dynamic and not bounded, it's:
5553 @smallexample
5554   warning: stack usage might be unbounded
5555 @end smallexample
5556 @end itemize
5558 @item -Wunsafe-loop-optimizations
5559 @opindex Wunsafe-loop-optimizations
5560 @opindex Wno-unsafe-loop-optimizations
5561 Warn if the loop cannot be optimized because the compiler cannot
5562 assume anything on the bounds of the loop indices.  With
5563 @option{-funsafe-loop-optimizations} warn if the compiler makes
5564 such assumptions.
5566 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5567 @opindex Wno-pedantic-ms-format
5568 @opindex Wpedantic-ms-format
5569 When used in combination with @option{-Wformat}
5570 and @option{-pedantic} without GNU extensions, this option
5571 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5572 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5573 which depend on the MS runtime.
5575 @item -Waligned-new
5576 @opindex Waligned-new
5577 @opindex Wno-aligned-new
5578 Warn about a new-expression of a type that requires greater alignment
5579 than the @code{alignof(std::max_align_t)} but uses an allocation
5580 function without an explicit alignment parameter. This option is
5581 enabled by @option{-Wall}.
5583 Normally this only warns about global allocation functions, but
5584 @option{-Waligned-new=all} also warns about class member allocation
5585 functions.
5587 @item -Wplacement-new
5588 @itemx -Wplacement-new=@var{n}
5589 @opindex Wplacement-new
5590 @opindex Wno-placement-new
5591 Warn about placement new expressions with undefined behavior, such as
5592 constructing an object in a buffer that is smaller than the type of
5593 the object.  For example, the placement new expression below is diagnosed
5594 because it attempts to construct an array of 64 integers in a buffer only
5595 64 bytes large.
5596 @smallexample
5597 char buf [64];
5598 new (buf) int[64];
5599 @end smallexample
5600 This warning is enabled by default.
5602 @table @gcctabopt
5603 @item -Wplacement-new=1
5604 This is the default warning level of @option{-Wplacement-new}.  At this
5605 level the warning is not issued for some strictly undefined constructs that
5606 GCC allows as extensions for compatibility with legacy code.  For example,
5607 the following @code{new} expression is not diagnosed at this level even
5608 though it has undefined behavior according to the C++ standard because
5609 it writes past the end of the one-element array.
5610 @smallexample
5611 struct S @{ int n, a[1]; @};
5612 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5613 new (s->a)int [32]();
5614 @end smallexample
5616 @item -Wplacement-new=2
5617 At this level, in addition to diagnosing all the same constructs as at level
5618 1, a diagnostic is also issued for placement new expressions that construct
5619 an object in the last member of structure whose type is an array of a single
5620 element and whose size is less than the size of the object being constructed.
5621 While the previous example would be diagnosed, the following construct makes
5622 use of the flexible member array extension to avoid the warning at level 2.
5623 @smallexample
5624 struct S @{ int n, a[]; @};
5625 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5626 new (s->a)int [32]();
5627 @end smallexample
5629 @end table
5631 @item -Wpointer-arith
5632 @opindex Wpointer-arith
5633 @opindex Wno-pointer-arith
5634 Warn about anything that depends on the ``size of'' a function type or
5635 of @code{void}.  GNU C assigns these types a size of 1, for
5636 convenience in calculations with @code{void *} pointers and pointers
5637 to functions.  In C++, warn also when an arithmetic operation involves
5638 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5640 @item -Wtype-limits
5641 @opindex Wtype-limits
5642 @opindex Wno-type-limits
5643 Warn if a comparison is always true or always false due to the limited
5644 range of the data type, but do not warn for constant expressions.  For
5645 example, warn if an unsigned variable is compared against zero with
5646 @code{<} or @code{>=}.  This warning is also enabled by
5647 @option{-Wextra}.
5649 @include cppwarnopts.texi
5651 @item -Wbad-function-cast @r{(C and Objective-C only)}
5652 @opindex Wbad-function-cast
5653 @opindex Wno-bad-function-cast
5654 Warn when a function call is cast to a non-matching type.
5655 For example, warn if a call to a function returning an integer type 
5656 is cast to a pointer type.
5658 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5659 @opindex Wc90-c99-compat
5660 @opindex Wno-c90-c99-compat
5661 Warn about features not present in ISO C90, but present in ISO C99.
5662 For instance, warn about use of variable length arrays, @code{long long}
5663 type, @code{bool} type, compound literals, designated initializers, and so
5664 on.  This option is independent of the standards mode.  Warnings are disabled
5665 in the expression that follows @code{__extension__}.
5667 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5668 @opindex Wc99-c11-compat
5669 @opindex Wno-c99-c11-compat
5670 Warn about features not present in ISO C99, but present in ISO C11.
5671 For instance, warn about use of anonymous structures and unions,
5672 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5673 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5674 and so on.  This option is independent of the standards mode.  Warnings are
5675 disabled in the expression that follows @code{__extension__}.
5677 @item -Wc++-compat @r{(C and Objective-C only)}
5678 @opindex Wc++-compat
5679 Warn about ISO C constructs that are outside of the common subset of
5680 ISO C and ISO C++, e.g.@: request for implicit conversion from
5681 @code{void *} to a pointer to non-@code{void} type.
5683 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5684 @opindex Wc++11-compat
5685 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5686 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5687 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5688 enabled by @option{-Wall}.
5690 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5691 @opindex Wc++14-compat
5692 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5693 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5695 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5696 @opindex Wc++1z-compat
5697 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5698 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5700 @item -Wcast-qual
5701 @opindex Wcast-qual
5702 @opindex Wno-cast-qual
5703 Warn whenever a pointer is cast so as to remove a type qualifier from
5704 the target type.  For example, warn if a @code{const char *} is cast
5705 to an ordinary @code{char *}.
5707 Also warn when making a cast that introduces a type qualifier in an
5708 unsafe way.  For example, casting @code{char **} to @code{const char **}
5709 is unsafe, as in this example:
5711 @smallexample
5712   /* p is char ** value.  */
5713   const char **q = (const char **) p;
5714   /* Assignment of readonly string to const char * is OK.  */
5715   *q = "string";
5716   /* Now char** pointer points to read-only memory.  */
5717   **p = 'b';
5718 @end smallexample
5720 @item -Wcast-align
5721 @opindex Wcast-align
5722 @opindex Wno-cast-align
5723 Warn whenever a pointer is cast such that the required alignment of the
5724 target is increased.  For example, warn if a @code{char *} is cast to
5725 an @code{int *} on machines where integers can only be accessed at
5726 two- or four-byte boundaries.
5728 @item -Wwrite-strings
5729 @opindex Wwrite-strings
5730 @opindex Wno-write-strings
5731 When compiling C, give string constants the type @code{const
5732 char[@var{length}]} so that copying the address of one into a
5733 non-@code{const} @code{char *} pointer produces a warning.  These
5734 warnings help you find at compile time code that can try to write
5735 into a string constant, but only if you have been very careful about
5736 using @code{const} in declarations and prototypes.  Otherwise, it is
5737 just a nuisance. This is why we did not make @option{-Wall} request
5738 these warnings.
5740 When compiling C++, warn about the deprecated conversion from string
5741 literals to @code{char *}.  This warning is enabled by default for C++
5742 programs.
5744 @item -Wclobbered
5745 @opindex Wclobbered
5746 @opindex Wno-clobbered
5747 Warn for variables that might be changed by @code{longjmp} or
5748 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5750 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5751 @opindex Wconditionally-supported
5752 @opindex Wno-conditionally-supported
5753 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5755 @item -Wconversion
5756 @opindex Wconversion
5757 @opindex Wno-conversion
5758 Warn for implicit conversions that may alter a value. This includes
5759 conversions between real and integer, like @code{abs (x)} when
5760 @code{x} is @code{double}; conversions between signed and unsigned,
5761 like @code{unsigned ui = -1}; and conversions to smaller types, like
5762 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5763 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5764 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5765 conversions between signed and unsigned integers can be disabled by
5766 using @option{-Wno-sign-conversion}.
5768 For C++, also warn for confusing overload resolution for user-defined
5769 conversions; and conversions that never use a type conversion
5770 operator: conversions to @code{void}, the same type, a base class or a
5771 reference to them. Warnings about conversions between signed and
5772 unsigned integers are disabled by default in C++ unless
5773 @option{-Wsign-conversion} is explicitly enabled.
5775 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5776 @opindex Wconversion-null
5777 @opindex Wno-conversion-null
5778 Do not warn for conversions between @code{NULL} and non-pointer
5779 types. @option{-Wconversion-null} is enabled by default.
5781 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5782 @opindex Wzero-as-null-pointer-constant
5783 @opindex Wno-zero-as-null-pointer-constant
5784 Warn when a literal @samp{0} is used as null pointer constant.  This can
5785 be useful to facilitate the conversion to @code{nullptr} in C++11.
5787 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5788 @opindex Wsubobject-linkage
5789 @opindex Wno-subobject-linkage
5790 Warn if a class type has a base or a field whose type uses the anonymous
5791 namespace or depends on a type with no linkage.  If a type A depends on
5792 a type B with no or internal linkage, defining it in multiple
5793 translation units would be an ODR violation because the meaning of B
5794 is different in each translation unit.  If A only appears in a single
5795 translation unit, the best way to silence the warning is to give it
5796 internal linkage by putting it in an anonymous namespace as well.  The
5797 compiler doesn't give this warning for types defined in the main .C
5798 file, as those are unlikely to have multiple definitions.
5799 @option{-Wsubobject-linkage} is enabled by default.
5801 @item -Wdangling-else
5802 @opindex Wdangling-else
5803 @opindex Wno-dangling-else
5804 Warn about constructions where there may be confusion to which
5805 @code{if} statement an @code{else} branch belongs.  Here is an example of
5806 such a case:
5808 @smallexample
5809 @group
5811   if (a)
5812     if (b)
5813       foo ();
5814   else
5815     bar ();
5817 @end group
5818 @end smallexample
5820 In C/C++, every @code{else} branch belongs to the innermost possible
5821 @code{if} statement, which in this example is @code{if (b)}.  This is
5822 often not what the programmer expected, as illustrated in the above
5823 example by indentation the programmer chose.  When there is the
5824 potential for this confusion, GCC issues a warning when this flag
5825 is specified.  To eliminate the warning, add explicit braces around
5826 the innermost @code{if} statement so there is no way the @code{else}
5827 can belong to the enclosing @code{if}.  The resulting code
5828 looks like this:
5830 @smallexample
5831 @group
5833   if (a)
5834     @{
5835       if (b)
5836         foo ();
5837       else
5838         bar ();
5839     @}
5841 @end group
5842 @end smallexample
5844 This warning is enabled by @option{-Wparentheses}.
5846 @item -Wdate-time
5847 @opindex Wdate-time
5848 @opindex Wno-date-time
5849 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5850 are encountered as they might prevent bit-wise-identical reproducible
5851 compilations.
5853 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5854 @opindex Wdelete-incomplete
5855 @opindex Wno-delete-incomplete
5856 Warn when deleting a pointer to incomplete type, which may cause
5857 undefined behavior at runtime.  This warning is enabled by default.
5859 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5860 @opindex Wuseless-cast
5861 @opindex Wno-useless-cast
5862 Warn when an expression is casted to its own type.
5864 @item -Wempty-body
5865 @opindex Wempty-body
5866 @opindex Wno-empty-body
5867 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5868 while} statement.  This warning is also enabled by @option{-Wextra}.
5870 @item -Wenum-compare
5871 @opindex Wenum-compare
5872 @opindex Wno-enum-compare
5873 Warn about a comparison between values of different enumerated types.
5874 In C++ enumeral mismatches in conditional expressions are also
5875 diagnosed and the warning is enabled by default.  In C this warning is 
5876 enabled by @option{-Wall}.
5878 @item -Wjump-misses-init @r{(C, Objective-C only)}
5879 @opindex Wjump-misses-init
5880 @opindex Wno-jump-misses-init
5881 Warn if a @code{goto} statement or a @code{switch} statement jumps
5882 forward across the initialization of a variable, or jumps backward to a
5883 label after the variable has been initialized.  This only warns about
5884 variables that are initialized when they are declared.  This warning is
5885 only supported for C and Objective-C; in C++ this sort of branch is an
5886 error in any case.
5888 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5889 can be disabled with the @option{-Wno-jump-misses-init} option.
5891 @item -Wsign-compare
5892 @opindex Wsign-compare
5893 @opindex Wno-sign-compare
5894 @cindex warning for comparison of signed and unsigned values
5895 @cindex comparison of signed and unsigned values, warning
5896 @cindex signed and unsigned values, comparison warning
5897 Warn when a comparison between signed and unsigned values could produce
5898 an incorrect result when the signed value is converted to unsigned.
5899 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
5900 also enabled by @option{-Wextra}.
5902 @item -Wsign-conversion
5903 @opindex Wsign-conversion
5904 @opindex Wno-sign-conversion
5905 Warn for implicit conversions that may change the sign of an integer
5906 value, like assigning a signed integer expression to an unsigned
5907 integer variable. An explicit cast silences the warning. In C, this
5908 option is enabled also by @option{-Wconversion}.
5910 @item -Wfloat-conversion
5911 @opindex Wfloat-conversion
5912 @opindex Wno-float-conversion
5913 Warn for implicit conversions that reduce the precision of a real value.
5914 This includes conversions from real to integer, and from higher precision
5915 real to lower precision real values.  This option is also enabled by
5916 @option{-Wconversion}.
5918 @item -Wno-scalar-storage-order
5919 @opindex -Wno-scalar-storage-order
5920 @opindex -Wscalar-storage-order
5921 Do not warn on suspicious constructs involving reverse scalar storage order.
5923 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
5924 @opindex Wsized-deallocation
5925 @opindex Wno-sized-deallocation
5926 Warn about a definition of an unsized deallocation function
5927 @smallexample
5928 void operator delete (void *) noexcept;
5929 void operator delete[] (void *) noexcept;
5930 @end smallexample
5931 without a definition of the corresponding sized deallocation function
5932 @smallexample
5933 void operator delete (void *, std::size_t) noexcept;
5934 void operator delete[] (void *, std::size_t) noexcept;
5935 @end smallexample
5936 or vice versa.  Enabled by @option{-Wextra} along with
5937 @option{-fsized-deallocation}.
5939 @item -Wsizeof-pointer-memaccess
5940 @opindex Wsizeof-pointer-memaccess
5941 @opindex Wno-sizeof-pointer-memaccess
5942 Warn for suspicious length parameters to certain string and memory built-in
5943 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
5944 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
5945 but a pointer, and suggests a possible fix, or about
5946 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
5947 @option{-Wall}.
5949 @item -Wsizeof-array-argument
5950 @opindex Wsizeof-array-argument
5951 @opindex Wno-sizeof-array-argument
5952 Warn when the @code{sizeof} operator is applied to a parameter that is
5953 declared as an array in a function definition.  This warning is enabled by
5954 default for C and C++ programs.
5956 @item -Wmemset-elt-size
5957 @opindex Wmemset-elt-size
5958 @opindex Wno-memset-elt-size
5959 Warn for suspicious calls to the @code{memset} built-in function, if the
5960 first argument references an array, and the third argument is a number
5961 equal to the number of elements, but not equal to the size of the array
5962 in memory.  This indicates that the user has omitted a multiplication by
5963 the element size.  This warning is enabled by @option{-Wall}.
5965 @item -Wmemset-transposed-args
5966 @opindex Wmemset-transposed-args
5967 @opindex Wno-memset-transposed-args
5968 Warn for suspicious calls to the @code{memset} built-in function, if the
5969 second argument is not zero and the third argument is zero.  This warns e.g.@
5970 about @code{memset (buf, sizeof buf, 0)} where most probably
5971 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
5972 is only emitted if the third argument is literal zero.  If it is some
5973 expression that is folded to zero, a cast of zero to some type, etc., 
5974 it is far less likely that the user has mistakenly exchanged the arguments 
5975 and no warning is emitted.  This warning is enabled by @option{-Wall}.
5977 @item -Waddress
5978 @opindex Waddress
5979 @opindex Wno-address
5980 Warn about suspicious uses of memory addresses. These include using
5981 the address of a function in a conditional expression, such as
5982 @code{void func(void); if (func)}, and comparisons against the memory
5983 address of a string literal, such as @code{if (x == "abc")}.  Such
5984 uses typically indicate a programmer error: the address of a function
5985 always evaluates to true, so their use in a conditional usually
5986 indicate that the programmer forgot the parentheses in a function
5987 call; and comparisons against string literals result in unspecified
5988 behavior and are not portable in C, so they usually indicate that the
5989 programmer intended to use @code{strcmp}.  This warning is enabled by
5990 @option{-Wall}.
5992 @item -Wlogical-op
5993 @opindex Wlogical-op
5994 @opindex Wno-logical-op
5995 Warn about suspicious uses of logical operators in expressions.
5996 This includes using logical operators in contexts where a
5997 bit-wise operator is likely to be expected.  Also warns when
5998 the operands of a logical operator are the same:
5999 @smallexample
6000 extern int a;
6001 if (a < 0 && a < 0) @{ @dots{} @}
6002 @end smallexample
6004 @item -Wlogical-not-parentheses
6005 @opindex Wlogical-not-parentheses
6006 @opindex Wno-logical-not-parentheses
6007 Warn about logical not used on the left hand side operand of a comparison.
6008 This option does not warn if the right operand is considered to be a boolean
6009 expression.  Its purpose is to detect suspicious code like the following:
6010 @smallexample
6011 int a;
6012 @dots{}
6013 if (!a > 1) @{ @dots{} @}
6014 @end smallexample
6016 It is possible to suppress the warning by wrapping the LHS into
6017 parentheses:
6018 @smallexample
6019 if ((!a) > 1) @{ @dots{} @}
6020 @end smallexample
6022 This warning is enabled by @option{-Wall}.
6024 @item -Waggregate-return
6025 @opindex Waggregate-return
6026 @opindex Wno-aggregate-return
6027 Warn if any functions that return structures or unions are defined or
6028 called.  (In languages where you can return an array, this also elicits
6029 a warning.)
6031 @item -Wno-aggressive-loop-optimizations
6032 @opindex Wno-aggressive-loop-optimizations
6033 @opindex Waggressive-loop-optimizations
6034 Warn if in a loop with constant number of iterations the compiler detects
6035 undefined behavior in some statement during one or more of the iterations.
6037 @item -Wno-attributes
6038 @opindex Wno-attributes
6039 @opindex Wattributes
6040 Do not warn if an unexpected @code{__attribute__} is used, such as
6041 unrecognized attributes, function attributes applied to variables,
6042 etc.  This does not stop errors for incorrect use of supported
6043 attributes.
6045 @item -Wno-builtin-declaration-mismatch
6046 @opindex Wno-builtin-declaration-mismatch
6047 @opindex Wbuiltin-declaration-mismatch
6048 Warn if a built-in function is declared with the wrong signature.
6049 This warning is enabled by default.
6051 @item -Wno-builtin-macro-redefined
6052 @opindex Wno-builtin-macro-redefined
6053 @opindex Wbuiltin-macro-redefined
6054 Do not warn if certain built-in macros are redefined.  This suppresses
6055 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6056 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6058 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6059 @opindex Wstrict-prototypes
6060 @opindex Wno-strict-prototypes
6061 Warn if a function is declared or defined without specifying the
6062 argument types.  (An old-style function definition is permitted without
6063 a warning if preceded by a declaration that specifies the argument
6064 types.)
6066 @item -Wold-style-declaration @r{(C and Objective-C only)}
6067 @opindex Wold-style-declaration
6068 @opindex Wno-old-style-declaration
6069 Warn for obsolescent usages, according to the C Standard, in a
6070 declaration. For example, warn if storage-class specifiers like
6071 @code{static} are not the first things in a declaration.  This warning
6072 is also enabled by @option{-Wextra}.
6074 @item -Wold-style-definition @r{(C and Objective-C only)}
6075 @opindex Wold-style-definition
6076 @opindex Wno-old-style-definition
6077 Warn if an old-style function definition is used.  A warning is given
6078 even if there is a previous prototype.
6080 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6081 @opindex Wmissing-parameter-type
6082 @opindex Wno-missing-parameter-type
6083 A function parameter is declared without a type specifier in K&R-style
6084 functions:
6086 @smallexample
6087 void foo(bar) @{ @}
6088 @end smallexample
6090 This warning is also enabled by @option{-Wextra}.
6092 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6093 @opindex Wmissing-prototypes
6094 @opindex Wno-missing-prototypes
6095 Warn if a global function is defined without a previous prototype
6096 declaration.  This warning is issued even if the definition itself
6097 provides a prototype.  Use this option to detect global functions
6098 that do not have a matching prototype declaration in a header file.
6099 This option is not valid for C++ because all function declarations
6100 provide prototypes and a non-matching declaration declares an
6101 overload rather than conflict with an earlier declaration.
6102 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6104 @item -Wmissing-declarations
6105 @opindex Wmissing-declarations
6106 @opindex Wno-missing-declarations
6107 Warn if a global function is defined without a previous declaration.
6108 Do so even if the definition itself provides a prototype.
6109 Use this option to detect global functions that are not declared in
6110 header files.  In C, no warnings are issued for functions with previous
6111 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6112 missing prototypes.  In C++, no warnings are issued for function templates,
6113 or for inline functions, or for functions in anonymous namespaces.
6115 @item -Wmissing-field-initializers
6116 @opindex Wmissing-field-initializers
6117 @opindex Wno-missing-field-initializers
6118 @opindex W
6119 @opindex Wextra
6120 @opindex Wno-extra
6121 Warn if a structure's initializer has some fields missing.  For
6122 example, the following code causes such a warning, because
6123 @code{x.h} is implicitly zero:
6125 @smallexample
6126 struct s @{ int f, g, h; @};
6127 struct s x = @{ 3, 4 @};
6128 @end smallexample
6130 This option does not warn about designated initializers, so the following
6131 modification does not trigger a warning:
6133 @smallexample
6134 struct s @{ int f, g, h; @};
6135 struct s x = @{ .f = 3, .g = 4 @};
6136 @end smallexample
6138 In C++ this option does not warn either about the empty @{ @}
6139 initializer, for example:
6141 @smallexample
6142 struct s @{ int f, g, h; @};
6143 s x = @{ @};
6144 @end smallexample
6146 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6147 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6149 @item -Wno-multichar
6150 @opindex Wno-multichar
6151 @opindex Wmultichar
6152 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6153 Usually they indicate a typo in the user's code, as they have
6154 implementation-defined values, and should not be used in portable code.
6156 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
6157 @opindex Wnormalized=
6158 @opindex Wnormalized
6159 @opindex Wno-normalized
6160 @cindex NFC
6161 @cindex NFKC
6162 @cindex character set, input normalization
6163 In ISO C and ISO C++, two identifiers are different if they are
6164 different sequences of characters.  However, sometimes when characters
6165 outside the basic ASCII character set are used, you can have two
6166 different character sequences that look the same.  To avoid confusion,
6167 the ISO 10646 standard sets out some @dfn{normalization rules} which
6168 when applied ensure that two sequences that look the same are turned into
6169 the same sequence.  GCC can warn you if you are using identifiers that
6170 have not been normalized; this option controls that warning.
6172 There are four levels of warning supported by GCC@.  The default is
6173 @option{-Wnormalized=nfc}, which warns about any identifier that is
6174 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6175 recommended form for most uses.  It is equivalent to
6176 @option{-Wnormalized}.
6178 Unfortunately, there are some characters allowed in identifiers by
6179 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6180 identifiers.  That is, there's no way to use these symbols in portable
6181 ISO C or C++ and have all your identifiers in NFC@.
6182 @option{-Wnormalized=id} suppresses the warning for these characters.
6183 It is hoped that future versions of the standards involved will correct
6184 this, which is why this option is not the default.
6186 You can switch the warning off for all characters by writing
6187 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6188 only do this if you are using some other normalization scheme (like
6189 ``D''), because otherwise you can easily create bugs that are
6190 literally impossible to see.
6192 Some characters in ISO 10646 have distinct meanings but look identical
6193 in some fonts or display methodologies, especially once formatting has
6194 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6195 LETTER N'', displays just like a regular @code{n} that has been
6196 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6197 normalization scheme to convert all these into a standard form as
6198 well, and GCC warns if your code is not in NFKC if you use
6199 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6200 about every identifier that contains the letter O because it might be
6201 confused with the digit 0, and so is not the default, but may be
6202 useful as a local coding convention if the programming environment 
6203 cannot be fixed to display these characters distinctly.
6205 @item -Wno-deprecated
6206 @opindex Wno-deprecated
6207 @opindex Wdeprecated
6208 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6210 @item -Wno-deprecated-declarations
6211 @opindex Wno-deprecated-declarations
6212 @opindex Wdeprecated-declarations
6213 Do not warn about uses of functions (@pxref{Function Attributes}),
6214 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6215 Attributes}) marked as deprecated by using the @code{deprecated}
6216 attribute.
6218 @item -Wno-overflow
6219 @opindex Wno-overflow
6220 @opindex Woverflow
6221 Do not warn about compile-time overflow in constant expressions.
6223 @item -Wno-odr
6224 @opindex Wno-odr
6225 @opindex Wodr
6226 Warn about One Definition Rule violations during link-time optimization.
6227 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6229 @item -Wopenmp-simd
6230 @opindex Wopenm-simd
6231 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6232 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6233 option can be used to relax the cost model.
6235 @item -Woverride-init @r{(C and Objective-C only)}
6236 @opindex Woverride-init
6237 @opindex Wno-override-init
6238 @opindex W
6239 @opindex Wextra
6240 @opindex Wno-extra
6241 Warn if an initialized field without side effects is overridden when
6242 using designated initializers (@pxref{Designated Inits, , Designated
6243 Initializers}).
6245 This warning is included in @option{-Wextra}.  To get other
6246 @option{-Wextra} warnings without this one, use @option{-Wextra
6247 -Wno-override-init}.
6249 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6250 @opindex Woverride-init-side-effects
6251 @opindex Wno-override-init-side-effects
6252 Warn if an initialized field with side effects is overridden when
6253 using designated initializers (@pxref{Designated Inits, , Designated
6254 Initializers}).  This warning is enabled by default.
6256 @item -Wpacked
6257 @opindex Wpacked
6258 @opindex Wno-packed
6259 Warn if a structure is given the packed attribute, but the packed
6260 attribute has no effect on the layout or size of the structure.
6261 Such structures may be mis-aligned for little benefit.  For
6262 instance, in this code, the variable @code{f.x} in @code{struct bar}
6263 is misaligned even though @code{struct bar} does not itself
6264 have the packed attribute:
6266 @smallexample
6267 @group
6268 struct foo @{
6269   int x;
6270   char a, b, c, d;
6271 @} __attribute__((packed));
6272 struct bar @{
6273   char z;
6274   struct foo f;
6276 @end group
6277 @end smallexample
6279 @item -Wpacked-bitfield-compat
6280 @opindex Wpacked-bitfield-compat
6281 @opindex Wno-packed-bitfield-compat
6282 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6283 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6284 the change can lead to differences in the structure layout.  GCC
6285 informs you when the offset of such a field has changed in GCC 4.4.
6286 For example there is no longer a 4-bit padding between field @code{a}
6287 and @code{b} in this structure:
6289 @smallexample
6290 struct foo
6292   char a:4;
6293   char b:8;
6294 @} __attribute__ ((packed));
6295 @end smallexample
6297 This warning is enabled by default.  Use
6298 @option{-Wno-packed-bitfield-compat} to disable this warning.
6300 @item -Wpadded
6301 @opindex Wpadded
6302 @opindex Wno-padded
6303 Warn if padding is included in a structure, either to align an element
6304 of the structure or to align the whole structure.  Sometimes when this
6305 happens it is possible to rearrange the fields of the structure to
6306 reduce the padding and so make the structure smaller.
6308 @item -Wredundant-decls
6309 @opindex Wredundant-decls
6310 @opindex Wno-redundant-decls
6311 Warn if anything is declared more than once in the same scope, even in
6312 cases where multiple declaration is valid and changes nothing.
6314 @item -Wrestrict
6315 @opindex Wrestrict
6316 @opindex Wno-restrict
6317 Warn when an argument passed to a restrict-qualified parameter
6318 aliases with another argument.
6320 @item -Wnested-externs @r{(C and Objective-C only)}
6321 @opindex Wnested-externs
6322 @opindex Wno-nested-externs
6323 Warn if an @code{extern} declaration is encountered within a function.
6325 @item -Wno-inherited-variadic-ctor
6326 @opindex Winherited-variadic-ctor
6327 @opindex Wno-inherited-variadic-ctor
6328 Suppress warnings about use of C++11 inheriting constructors when the
6329 base class inherited from has a C variadic constructor; the warning is
6330 on by default because the ellipsis is not inherited.
6332 @item -Winline
6333 @opindex Winline
6334 @opindex Wno-inline
6335 Warn if a function that is declared as inline cannot be inlined.
6336 Even with this option, the compiler does not warn about failures to
6337 inline functions declared in system headers.
6339 The compiler uses a variety of heuristics to determine whether or not
6340 to inline a function.  For example, the compiler takes into account
6341 the size of the function being inlined and the amount of inlining
6342 that has already been done in the current function.  Therefore,
6343 seemingly insignificant changes in the source program can cause the
6344 warnings produced by @option{-Winline} to appear or disappear.
6346 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6347 @opindex Wno-invalid-offsetof
6348 @opindex Winvalid-offsetof
6349 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6350 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6351 to a non-standard-layout type is undefined.  In existing C++ implementations,
6352 however, @code{offsetof} typically gives meaningful results.
6353 This flag is for users who are aware that they are
6354 writing nonportable code and who have deliberately chosen to ignore the
6355 warning about it.
6357 The restrictions on @code{offsetof} may be relaxed in a future version
6358 of the C++ standard.
6360 @item -Wint-in-bool-context
6361 @opindex Wint-in-bool-context
6362 @opindex Wno-int-in-bool-context
6363 Warn for suspicious use of integer values where boolean values are expected,
6364 such as conditional expressions (?:) using non-boolean integer constants in
6365 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6366 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6367 for all kinds of multiplications regardless of the data type.
6368 This warning is enabled by @option{-Wall}.
6370 @item -Wno-int-to-pointer-cast
6371 @opindex Wno-int-to-pointer-cast
6372 @opindex Wint-to-pointer-cast
6373 Suppress warnings from casts to pointer type of an integer of a
6374 different size. In C++, casting to a pointer type of smaller size is
6375 an error. @option{Wint-to-pointer-cast} is enabled by default.
6378 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6379 @opindex Wno-pointer-to-int-cast
6380 @opindex Wpointer-to-int-cast
6381 Suppress warnings from casts from a pointer to an integer type of a
6382 different size.
6384 @item -Winvalid-pch
6385 @opindex Winvalid-pch
6386 @opindex Wno-invalid-pch
6387 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6388 the search path but can't be used.
6390 @item -Wlong-long
6391 @opindex Wlong-long
6392 @opindex Wno-long-long
6393 Warn if @code{long long} type is used.  This is enabled by either
6394 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6395 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6397 @item -Wvariadic-macros
6398 @opindex Wvariadic-macros
6399 @opindex Wno-variadic-macros
6400 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6401 alternate syntax is used in ISO C99 mode.  This is enabled by either
6402 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6403 messages, use @option{-Wno-variadic-macros}.
6405 @item -Wvarargs
6406 @opindex Wvarargs
6407 @opindex Wno-varargs
6408 Warn upon questionable usage of the macros used to handle variable
6409 arguments like @code{va_start}.  This is default.  To inhibit the
6410 warning messages, use @option{-Wno-varargs}.
6412 @item -Wvector-operation-performance
6413 @opindex Wvector-operation-performance
6414 @opindex Wno-vector-operation-performance
6415 Warn if vector operation is not implemented via SIMD capabilities of the
6416 architecture.  Mainly useful for the performance tuning.
6417 Vector operation can be implemented @code{piecewise}, which means that the
6418 scalar operation is performed on every vector element; 
6419 @code{in parallel}, which means that the vector operation is implemented
6420 using scalars of wider type, which normally is more performance efficient;
6421 and @code{as a single scalar}, which means that vector fits into a
6422 scalar type.
6424 @item -Wno-virtual-move-assign
6425 @opindex Wvirtual-move-assign
6426 @opindex Wno-virtual-move-assign
6427 Suppress warnings about inheriting from a virtual base with a
6428 non-trivial C++11 move assignment operator.  This is dangerous because
6429 if the virtual base is reachable along more than one path, it is
6430 moved multiple times, which can mean both objects end up in the
6431 moved-from state.  If the move assignment operator is written to avoid
6432 moving from a moved-from object, this warning can be disabled.
6434 @item -Wvla
6435 @opindex Wvla
6436 @opindex Wno-vla
6437 Warn if a variable-length array is used in the code.
6438 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6439 the variable-length array.
6441 @item -Wvla-larger-than=@var{n}
6442 If this option is used, the compiler will warn on uses of
6443 variable-length arrays where the size is either unbounded, or bounded
6444 by an argument that can be larger than @var{n} bytes.  This is similar
6445 to how @option{-Walloca-larger-than=@var{n}} works, but with
6446 variable-length arrays.
6448 Note that GCC may optimize small variable-length arrays of a known
6449 value into plain arrays, so this warning may not get triggered for
6450 such arrays.
6452 This warning is not enabled by @option{-Wall}, and is only active when
6453 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6455 See also @option{-Walloca-larger-than=@var{n}}.
6457 @item -Wvolatile-register-var
6458 @opindex Wvolatile-register-var
6459 @opindex Wno-volatile-register-var
6460 Warn if a register variable is declared volatile.  The volatile
6461 modifier does not inhibit all optimizations that may eliminate reads
6462 and/or writes to register variables.  This warning is enabled by
6463 @option{-Wall}.
6465 @item -Wdisabled-optimization
6466 @opindex Wdisabled-optimization
6467 @opindex Wno-disabled-optimization
6468 Warn if a requested optimization pass is disabled.  This warning does
6469 not generally indicate that there is anything wrong with your code; it
6470 merely indicates that GCC's optimizers are unable to handle the code
6471 effectively.  Often, the problem is that your code is too big or too
6472 complex; GCC refuses to optimize programs when the optimization
6473 itself is likely to take inordinate amounts of time.
6475 @item -Wpointer-sign @r{(C and Objective-C only)}
6476 @opindex Wpointer-sign
6477 @opindex Wno-pointer-sign
6478 Warn for pointer argument passing or assignment with different signedness.
6479 This option is only supported for C and Objective-C@.  It is implied by
6480 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6481 @option{-Wno-pointer-sign}.
6483 @item -Wstack-protector
6484 @opindex Wstack-protector
6485 @opindex Wno-stack-protector
6486 This option is only active when @option{-fstack-protector} is active.  It
6487 warns about functions that are not protected against stack smashing.
6489 @item -Woverlength-strings
6490 @opindex Woverlength-strings
6491 @opindex Wno-overlength-strings
6492 Warn about string constants that are longer than the ``minimum
6493 maximum'' length specified in the C standard.  Modern compilers
6494 generally allow string constants that are much longer than the
6495 standard's minimum limit, but very portable programs should avoid
6496 using longer strings.
6498 The limit applies @emph{after} string constant concatenation, and does
6499 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6500 C99, it was raised to 4095.  C++98 does not specify a normative
6501 minimum maximum, so we do not diagnose overlength strings in C++@.
6503 This option is implied by @option{-Wpedantic}, and can be disabled with
6504 @option{-Wno-overlength-strings}.
6506 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6507 @opindex Wunsuffixed-float-constants
6509 Issue a warning for any floating constant that does not have
6510 a suffix.  When used together with @option{-Wsystem-headers} it
6511 warns about such constants in system header files.  This can be useful
6512 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6513 from the decimal floating-point extension to C99.
6515 @item -Wno-designated-init @r{(C and Objective-C only)}
6516 Suppress warnings when a positional initializer is used to initialize
6517 a structure that has been marked with the @code{designated_init}
6518 attribute.
6520 @item -Whsa
6521 Issue a warning when HSAIL cannot be emitted for the compiled function or
6522 OpenMP construct.
6524 @end table
6526 @node Debugging Options
6527 @section Options for Debugging Your Program
6528 @cindex options, debugging
6529 @cindex debugging information options
6531 To tell GCC to emit extra information for use by a debugger, in almost 
6532 all cases you need only to add @option{-g} to your other options.
6534 GCC allows you to use @option{-g} with
6535 @option{-O}.  The shortcuts taken by optimized code may occasionally
6536 be surprising: some variables you declared may not exist
6537 at all; flow of control may briefly move where you did not expect it;
6538 some statements may not be executed because they compute constant
6539 results or their values are already at hand; some statements may
6540 execute in different places because they have been moved out of loops.
6541 Nevertheless it is possible to debug optimized output.  This makes
6542 it reasonable to use the optimizer for programs that might have bugs.
6544 If you are not using some other optimization option, consider
6545 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6546 With no @option{-O} option at all, some compiler passes that collect
6547 information useful for debugging do not run at all, so that
6548 @option{-Og} may result in a better debugging experience.
6550 @table @gcctabopt
6551 @item -g
6552 @opindex g
6553 Produce debugging information in the operating system's native format
6554 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6555 information.
6557 On most systems that use stabs format, @option{-g} enables use of extra
6558 debugging information that only GDB can use; this extra information
6559 makes debugging work better in GDB but probably makes other debuggers
6560 crash or
6561 refuse to read the program.  If you want to control for certain whether
6562 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6563 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6565 @item -ggdb
6566 @opindex ggdb
6567 Produce debugging information for use by GDB@.  This means to use the
6568 most expressive format available (DWARF, stabs, or the native format
6569 if neither of those are supported), including GDB extensions if at all
6570 possible.
6572 @item -gdwarf
6573 @itemx -gdwarf-@var{version}
6574 @opindex gdwarf
6575 Produce debugging information in DWARF format (if that is supported).
6576 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6577 for most targets is 4.  DWARF Version 5 is only experimental.
6579 Note that with DWARF Version 2, some ports require and always
6580 use some non-conflicting DWARF 3 extensions in the unwind tables.
6582 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6583 for maximum benefit.
6585 GCC no longer supports DWARF Version 1, which is substantially
6586 different than Version 2 and later.  For historical reasons, some
6587 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6588 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6589 in their names, but apply to all currently-supported versions of DWARF.
6591 @item -gstabs
6592 @opindex gstabs
6593 Produce debugging information in stabs format (if that is supported),
6594 without GDB extensions.  This is the format used by DBX on most BSD
6595 systems.  On MIPS, Alpha and System V Release 4 systems this option
6596 produces stabs debugging output that is not understood by DBX or SDB@.
6597 On System V Release 4 systems this option requires the GNU assembler.
6599 @item -gstabs+
6600 @opindex gstabs+
6601 Produce debugging information in stabs format (if that is supported),
6602 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6603 use of these extensions is likely to make other debuggers crash or
6604 refuse to read the program.
6606 @item -gcoff
6607 @opindex gcoff
6608 Produce debugging information in COFF format (if that is supported).
6609 This is the format used by SDB on most System V systems prior to
6610 System V Release 4.
6612 @item -gxcoff
6613 @opindex gxcoff
6614 Produce debugging information in XCOFF format (if that is supported).
6615 This is the format used by the DBX debugger on IBM RS/6000 systems.
6617 @item -gxcoff+
6618 @opindex gxcoff+
6619 Produce debugging information in XCOFF format (if that is supported),
6620 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6621 use of these extensions is likely to make other debuggers crash or
6622 refuse to read the program, and may cause assemblers other than the GNU
6623 assembler (GAS) to fail with an error.
6625 @item -gvms
6626 @opindex gvms
6627 Produce debugging information in Alpha/VMS debug format (if that is
6628 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6630 @item -g@var{level}
6631 @itemx -ggdb@var{level}
6632 @itemx -gstabs@var{level}
6633 @itemx -gcoff@var{level}
6634 @itemx -gxcoff@var{level}
6635 @itemx -gvms@var{level}
6636 Request debugging information and also use @var{level} to specify how
6637 much information.  The default level is 2.
6639 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6640 @option{-g}.
6642 Level 1 produces minimal information, enough for making backtraces in
6643 parts of the program that you don't plan to debug.  This includes
6644 descriptions of functions and external variables, and line number
6645 tables, but no information about local variables.
6647 Level 3 includes extra information, such as all the macro definitions
6648 present in the program.  Some debuggers support macro expansion when
6649 you use @option{-g3}.
6651 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6652 confusion with @option{-gdwarf-@var{level}}.
6653 Instead use an additional @option{-g@var{level}} option to change the
6654 debug level for DWARF.
6656 @item -feliminate-unused-debug-symbols
6657 @opindex feliminate-unused-debug-symbols
6658 Produce debugging information in stabs format (if that is supported),
6659 for only symbols that are actually used.
6661 @item -femit-class-debug-always
6662 @opindex femit-class-debug-always
6663 Instead of emitting debugging information for a C++ class in only one
6664 object file, emit it in all object files using the class.  This option
6665 should be used only with debuggers that are unable to handle the way GCC
6666 normally emits debugging information for classes because using this
6667 option increases the size of debugging information by as much as a
6668 factor of two.
6670 @item -fno-merge-debug-strings
6671 @opindex fmerge-debug-strings
6672 @opindex fno-merge-debug-strings
6673 Direct the linker to not merge together strings in the debugging
6674 information that are identical in different object files.  Merging is
6675 not supported by all assemblers or linkers.  Merging decreases the size
6676 of the debug information in the output file at the cost of increasing
6677 link processing time.  Merging is enabled by default.
6679 @item -fdebug-prefix-map=@var{old}=@var{new}
6680 @opindex fdebug-prefix-map
6681 When compiling files in directory @file{@var{old}}, record debugging
6682 information describing them as in @file{@var{new}} instead.
6684 @item -fvar-tracking
6685 @opindex fvar-tracking
6686 Run variable tracking pass.  It computes where variables are stored at each
6687 position in code.  Better debugging information is then generated
6688 (if the debugging information format supports this information).
6690 It is enabled by default when compiling with optimization (@option{-Os},
6691 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6692 the debug info format supports it.
6694 @item -fvar-tracking-assignments
6695 @opindex fvar-tracking-assignments
6696 @opindex fno-var-tracking-assignments
6697 Annotate assignments to user variables early in the compilation and
6698 attempt to carry the annotations over throughout the compilation all the
6699 way to the end, in an attempt to improve debug information while
6700 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6702 It can be enabled even if var-tracking is disabled, in which case
6703 annotations are created and maintained, but discarded at the end.
6704 By default, this flag is enabled together with @option{-fvar-tracking},
6705 except when selective scheduling is enabled.
6707 @item -gsplit-dwarf
6708 @opindex gsplit-dwarf
6709 Separate as much DWARF debugging information as possible into a
6710 separate output file with the extension @file{.dwo}.  This option allows
6711 the build system to avoid linking files with debug information.  To
6712 be useful, this option requires a debugger capable of reading @file{.dwo}
6713 files.
6715 @item -gpubnames
6716 @opindex gpubnames
6717 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6719 @item -ggnu-pubnames
6720 @opindex ggnu-pubnames
6721 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6722 suitable for conversion into a GDB@ index.  This option is only useful
6723 with a linker that can produce GDB@ index version 7.
6725 @item -fdebug-types-section
6726 @opindex fdebug-types-section
6727 @opindex fno-debug-types-section
6728 When using DWARF Version 4 or higher, type DIEs can be put into
6729 their own @code{.debug_types} section instead of making them part of the
6730 @code{.debug_info} section.  It is more efficient to put them in a separate
6731 comdat sections since the linker can then remove duplicates.
6732 But not all DWARF consumers support @code{.debug_types} sections yet
6733 and on some objects @code{.debug_types} produces larger instead of smaller
6734 debugging information.
6736 @item -grecord-gcc-switches
6737 @item -gno-record-gcc-switches
6738 @opindex grecord-gcc-switches
6739 @opindex gno-record-gcc-switches
6740 This switch causes the command-line options used to invoke the
6741 compiler that may affect code generation to be appended to the
6742 DW_AT_producer attribute in DWARF debugging information.  The options
6743 are concatenated with spaces separating them from each other and from
6744 the compiler version.  
6745 It is enabled by default.
6746 See also @option{-frecord-gcc-switches} for another
6747 way of storing compiler options into the object file.  
6749 @item -gstrict-dwarf
6750 @opindex gstrict-dwarf
6751 Disallow using extensions of later DWARF standard version than selected
6752 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6753 DWARF extensions from later standard versions is allowed.
6755 @item -gno-strict-dwarf
6756 @opindex gno-strict-dwarf
6757 Allow using extensions of later DWARF standard version than selected with
6758 @option{-gdwarf-@var{version}}.
6760 @item -gz@r{[}=@var{type}@r{]}
6761 @opindex gz
6762 Produce compressed debug sections in DWARF format, if that is supported.
6763 If @var{type} is not given, the default type depends on the capabilities
6764 of the assembler and linker used.  @var{type} may be one of
6765 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6766 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6767 compression in traditional GNU format).  If the linker doesn't support
6768 writing compressed debug sections, the option is rejected.  Otherwise,
6769 if the assembler does not support them, @option{-gz} is silently ignored
6770 when producing object files.
6772 @item -feliminate-dwarf2-dups
6773 @opindex feliminate-dwarf2-dups
6774 Compress DWARF debugging information by eliminating duplicated
6775 information about each symbol.  This option only makes sense when
6776 generating DWARF debugging information.
6778 @item -femit-struct-debug-baseonly
6779 @opindex femit-struct-debug-baseonly
6780 Emit debug information for struct-like types
6781 only when the base name of the compilation source file
6782 matches the base name of file in which the struct is defined.
6784 This option substantially reduces the size of debugging information,
6785 but at significant potential loss in type information to the debugger.
6786 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6787 See @option{-femit-struct-debug-detailed} for more detailed control.
6789 This option works only with DWARF debug output.
6791 @item -femit-struct-debug-reduced
6792 @opindex femit-struct-debug-reduced
6793 Emit debug information for struct-like types
6794 only when the base name of the compilation source file
6795 matches the base name of file in which the type is defined,
6796 unless the struct is a template or defined in a system header.
6798 This option significantly reduces the size of debugging information,
6799 with some potential loss in type information to the debugger.
6800 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6801 See @option{-femit-struct-debug-detailed} for more detailed control.
6803 This option works only with DWARF debug output.
6805 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6806 @opindex femit-struct-debug-detailed
6807 Specify the struct-like types
6808 for which the compiler generates debug information.
6809 The intent is to reduce duplicate struct debug information
6810 between different object files within the same program.
6812 This option is a detailed version of
6813 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6814 which serves for most needs.
6816 A specification has the syntax@*
6817 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6819 The optional first word limits the specification to
6820 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6821 A struct type is used directly when it is the type of a variable, member.
6822 Indirect uses arise through pointers to structs.
6823 That is, when use of an incomplete struct is valid, the use is indirect.
6824 An example is
6825 @samp{struct one direct; struct two * indirect;}.
6827 The optional second word limits the specification to
6828 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6829 Generic structs are a bit complicated to explain.
6830 For C++, these are non-explicit specializations of template classes,
6831 or non-template classes within the above.
6832 Other programming languages have generics,
6833 but @option{-femit-struct-debug-detailed} does not yet implement them.
6835 The third word specifies the source files for those
6836 structs for which the compiler should emit debug information.
6837 The values @samp{none} and @samp{any} have the normal meaning.
6838 The value @samp{base} means that
6839 the base of name of the file in which the type declaration appears
6840 must match the base of the name of the main compilation file.
6841 In practice, this means that when compiling @file{foo.c}, debug information
6842 is generated for types declared in that file and @file{foo.h},
6843 but not other header files.
6844 The value @samp{sys} means those types satisfying @samp{base}
6845 or declared in system or compiler headers.
6847 You may need to experiment to determine the best settings for your application.
6849 The default is @option{-femit-struct-debug-detailed=all}.
6851 This option works only with DWARF debug output.
6853 @item -fno-dwarf2-cfi-asm
6854 @opindex fdwarf2-cfi-asm
6855 @opindex fno-dwarf2-cfi-asm
6856 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
6857 instead of using GAS @code{.cfi_*} directives.
6859 @item -fno-eliminate-unused-debug-types
6860 @opindex feliminate-unused-debug-types
6861 @opindex fno-eliminate-unused-debug-types
6862 Normally, when producing DWARF output, GCC avoids producing debug symbol 
6863 output for types that are nowhere used in the source file being compiled.
6864 Sometimes it is useful to have GCC emit debugging
6865 information for all types declared in a compilation
6866 unit, regardless of whether or not they are actually used
6867 in that compilation unit, for example 
6868 if, in the debugger, you want to cast a value to a type that is
6869 not actually used in your program (but is declared).  More often,
6870 however, this results in a significant amount of wasted space.
6871 @end table
6873 @node Optimize Options
6874 @section Options That Control Optimization
6875 @cindex optimize options
6876 @cindex options, optimization
6878 These options control various sorts of optimizations.
6880 Without any optimization option, the compiler's goal is to reduce the
6881 cost of compilation and to make debugging produce the expected
6882 results.  Statements are independent: if you stop the program with a
6883 breakpoint between statements, you can then assign a new value to any
6884 variable or change the program counter to any other statement in the
6885 function and get exactly the results you expect from the source
6886 code.
6888 Turning on optimization flags makes the compiler attempt to improve
6889 the performance and/or code size at the expense of compilation time
6890 and possibly the ability to debug the program.
6892 The compiler performs optimization based on the knowledge it has of the
6893 program.  Compiling multiple files at once to a single output file mode allows
6894 the compiler to use information gained from all of the files when compiling
6895 each of them.
6897 Not all optimizations are controlled directly by a flag.  Only
6898 optimizations that have a flag are listed in this section.
6900 Most optimizations are only enabled if an @option{-O} level is set on
6901 the command line.  Otherwise they are disabled, even if individual
6902 optimization flags are specified.
6904 Depending on the target and how GCC was configured, a slightly different
6905 set of optimizations may be enabled at each @option{-O} level than
6906 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6907 to find out the exact set of optimizations that are enabled at each level.
6908 @xref{Overall Options}, for examples.
6910 @table @gcctabopt
6911 @item -O
6912 @itemx -O1
6913 @opindex O
6914 @opindex O1
6915 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6916 more memory for a large function.
6918 With @option{-O}, the compiler tries to reduce code size and execution
6919 time, without performing any optimizations that take a great deal of
6920 compilation time.
6922 @option{-O} turns on the following optimization flags:
6923 @gccoptlist{
6924 -fauto-inc-dec @gol
6925 -fbranch-count-reg @gol
6926 -fcombine-stack-adjustments @gol
6927 -fcompare-elim @gol
6928 -fcprop-registers @gol
6929 -fdce @gol
6930 -fdefer-pop @gol
6931 -fdelayed-branch @gol
6932 -fdse @gol
6933 -fforward-propagate @gol
6934 -fguess-branch-probability @gol
6935 -fif-conversion2 @gol
6936 -fif-conversion @gol
6937 -finline-functions-called-once @gol
6938 -fipa-pure-const @gol
6939 -fipa-profile @gol
6940 -fipa-reference @gol
6941 -fmerge-constants @gol
6942 -fmove-loop-invariants @gol
6943 -freorder-blocks @gol
6944 -fshrink-wrap @gol
6945 -fshrink-wrap-separate @gol
6946 -fsplit-wide-types @gol
6947 -fssa-backprop @gol
6948 -fssa-phiopt @gol
6949 -fstore-merging @gol
6950 -ftree-bit-ccp @gol
6951 -ftree-ccp @gol
6952 -ftree-ch @gol
6953 -ftree-coalesce-vars @gol
6954 -ftree-copy-prop @gol
6955 -ftree-dce @gol
6956 -ftree-dominator-opts @gol
6957 -ftree-dse @gol
6958 -ftree-forwprop @gol
6959 -ftree-fre @gol
6960 -ftree-phiprop @gol
6961 -ftree-sink @gol
6962 -ftree-slsr @gol
6963 -ftree-sra @gol
6964 -ftree-pta @gol
6965 -ftree-ter @gol
6966 -funit-at-a-time}
6968 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6969 where doing so does not interfere with debugging.
6971 @item -O2
6972 @opindex O2
6973 Optimize even more.  GCC performs nearly all supported optimizations
6974 that do not involve a space-speed tradeoff.
6975 As compared to @option{-O}, this option increases both compilation time
6976 and the performance of the generated code.
6978 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6979 also turns on the following optimization flags:
6980 @gccoptlist{-fthread-jumps @gol
6981 -falign-functions  -falign-jumps @gol
6982 -falign-loops  -falign-labels @gol
6983 -fcaller-saves @gol
6984 -fcrossjumping @gol
6985 -fcse-follow-jumps  -fcse-skip-blocks @gol
6986 -fdelete-null-pointer-checks @gol
6987 -fdevirtualize -fdevirtualize-speculatively @gol
6988 -fexpensive-optimizations @gol
6989 -fgcse  -fgcse-lm  @gol
6990 -fhoist-adjacent-loads @gol
6991 -finline-small-functions @gol
6992 -findirect-inlining @gol
6993 -fipa-cp @gol
6994 -fipa-cp-alignment @gol
6995 -fipa-bit-cp @gol
6996 -fipa-sra @gol
6997 -fipa-icf @gol
6998 -fisolate-erroneous-paths-dereference @gol
6999 -flra-remat @gol
7000 -foptimize-sibling-calls @gol
7001 -foptimize-strlen @gol
7002 -fpartial-inlining @gol
7003 -fpeephole2 @gol
7004 -freorder-blocks-algorithm=stc @gol
7005 -freorder-blocks-and-partition -freorder-functions @gol
7006 -frerun-cse-after-loop  @gol
7007 -fsched-interblock  -fsched-spec @gol
7008 -fschedule-insns  -fschedule-insns2 @gol
7009 -fstrict-aliasing -fstrict-overflow @gol
7010 -ftree-builtin-call-dce @gol
7011 -ftree-switch-conversion -ftree-tail-merge @gol
7012 -fcode-hoisting @gol
7013 -ftree-pre @gol
7014 -ftree-vrp @gol
7015 -fipa-ra}
7017 Please note the warning under @option{-fgcse} about
7018 invoking @option{-O2} on programs that use computed gotos.
7020 @item -O3
7021 @opindex O3
7022 Optimize yet more.  @option{-O3} turns on all optimizations specified
7023 by @option{-O2} and also turns on the @option{-finline-functions},
7024 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7025 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7026 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7027 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7028 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7029 and @option{-fipa-cp-clone} options.
7031 @item -O0
7032 @opindex O0
7033 Reduce compilation time and make debugging produce the expected
7034 results.  This is the default.
7036 @item -Os
7037 @opindex Os
7038 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7039 do not typically increase code size.  It also performs further
7040 optimizations designed to reduce code size.
7042 @option{-Os} disables the following optimization flags:
7043 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7044 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7045 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7047 @item -Ofast
7048 @opindex Ofast
7049 Disregard strict standards compliance.  @option{-Ofast} enables all
7050 @option{-O3} optimizations.  It also enables optimizations that are not
7051 valid for all standard-compliant programs.
7052 It turns on @option{-ffast-math} and the Fortran-specific
7053 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7055 @item -Og
7056 @opindex Og
7057 Optimize debugging experience.  @option{-Og} enables optimizations
7058 that do not interfere with debugging. It should be the optimization
7059 level of choice for the standard edit-compile-debug cycle, offering
7060 a reasonable level of optimization while maintaining fast compilation
7061 and a good debugging experience.
7062 @end table
7064 If you use multiple @option{-O} options, with or without level numbers,
7065 the last such option is the one that is effective.
7067 Options of the form @option{-f@var{flag}} specify machine-independent
7068 flags.  Most flags have both positive and negative forms; the negative
7069 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7070 below, only one of the forms is listed---the one you typically 
7071 use.  You can figure out the other form by either removing @samp{no-}
7072 or adding it.
7074 The following options control specific optimizations.  They are either
7075 activated by @option{-O} options or are related to ones that are.  You
7076 can use the following flags in the rare cases when ``fine-tuning'' of
7077 optimizations to be performed is desired.
7079 @table @gcctabopt
7080 @item -fno-defer-pop
7081 @opindex fno-defer-pop
7082 Always pop the arguments to each function call as soon as that function
7083 returns.  For machines that must pop arguments after a function call,
7084 the compiler normally lets arguments accumulate on the stack for several
7085 function calls and pops them all at once.
7087 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7089 @item -fforward-propagate
7090 @opindex fforward-propagate
7091 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7092 instructions and checks if the result can be simplified.  If loop unrolling
7093 is active, two passes are performed and the second is scheduled after
7094 loop unrolling.
7096 This option is enabled by default at optimization levels @option{-O},
7097 @option{-O2}, @option{-O3}, @option{-Os}.
7099 @item -ffp-contract=@var{style}
7100 @opindex ffp-contract
7101 @option{-ffp-contract=off} disables floating-point expression contraction.
7102 @option{-ffp-contract=fast} enables floating-point expression contraction
7103 such as forming of fused multiply-add operations if the target has
7104 native support for them.
7105 @option{-ffp-contract=on} enables floating-point expression contraction
7106 if allowed by the language standard.  This is currently not implemented
7107 and treated equal to @option{-ffp-contract=off}.
7109 The default is @option{-ffp-contract=fast}.
7111 @item -fomit-frame-pointer
7112 @opindex fomit-frame-pointer
7113 Don't keep the frame pointer in a register for functions that
7114 don't need one.  This avoids the instructions to save, set up and
7115 restore frame pointers; it also makes an extra register available
7116 in many functions.  @strong{It also makes debugging impossible on
7117 some machines.}
7119 On some machines, such as the VAX, this flag has no effect, because
7120 the standard calling sequence automatically handles the frame pointer
7121 and nothing is saved by pretending it doesn't exist.  The
7122 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7123 whether a target machine supports this flag.  @xref{Registers,,Register
7124 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7126 The default setting (when not optimizing for
7127 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7128 @option{-fomit-frame-pointer}.  You can configure GCC with the
7129 @option{--enable-frame-pointer} configure option to change the default.
7131 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7133 @item -foptimize-sibling-calls
7134 @opindex foptimize-sibling-calls
7135 Optimize sibling and tail recursive calls.
7137 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7139 @item -foptimize-strlen
7140 @opindex foptimize-strlen
7141 Optimize various standard C string functions (e.g. @code{strlen},
7142 @code{strchr} or @code{strcpy}) and
7143 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7145 Enabled at levels @option{-O2}, @option{-O3}.
7147 @item -fno-inline
7148 @opindex fno-inline
7149 Do not expand any functions inline apart from those marked with
7150 the @code{always_inline} attribute.  This is the default when not
7151 optimizing.
7153 Single functions can be exempted from inlining by marking them
7154 with the @code{noinline} attribute.
7156 @item -finline-small-functions
7157 @opindex finline-small-functions
7158 Integrate functions into their callers when their body is smaller than expected
7159 function call code (so overall size of program gets smaller).  The compiler
7160 heuristically decides which functions are simple enough to be worth integrating
7161 in this way.  This inlining applies to all functions, even those not declared
7162 inline.
7164 Enabled at level @option{-O2}.
7166 @item -findirect-inlining
7167 @opindex findirect-inlining
7168 Inline also indirect calls that are discovered to be known at compile
7169 time thanks to previous inlining.  This option has any effect only
7170 when inlining itself is turned on by the @option{-finline-functions}
7171 or @option{-finline-small-functions} options.
7173 Enabled at level @option{-O2}.
7175 @item -finline-functions
7176 @opindex finline-functions
7177 Consider all functions for inlining, even if they are not declared inline.
7178 The compiler heuristically decides which functions are worth integrating
7179 in this way.
7181 If all calls to a given function are integrated, and the function is
7182 declared @code{static}, then the function is normally not output as
7183 assembler code in its own right.
7185 Enabled at level @option{-O3}.
7187 @item -finline-functions-called-once
7188 @opindex finline-functions-called-once
7189 Consider all @code{static} functions called once for inlining into their
7190 caller even if they are not marked @code{inline}.  If a call to a given
7191 function is integrated, then the function is not output as assembler code
7192 in its own right.
7194 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7196 @item -fearly-inlining
7197 @opindex fearly-inlining
7198 Inline functions marked by @code{always_inline} and functions whose body seems
7199 smaller than the function call overhead early before doing
7200 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7201 makes profiling significantly cheaper and usually inlining faster on programs
7202 having large chains of nested wrapper functions.
7204 Enabled by default.
7206 @item -fipa-sra
7207 @opindex fipa-sra
7208 Perform interprocedural scalar replacement of aggregates, removal of
7209 unused parameters and replacement of parameters passed by reference
7210 by parameters passed by value.
7212 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7214 @item -finline-limit=@var{n}
7215 @opindex finline-limit
7216 By default, GCC limits the size of functions that can be inlined.  This flag
7217 allows coarse control of this limit.  @var{n} is the size of functions that
7218 can be inlined in number of pseudo instructions.
7220 Inlining is actually controlled by a number of parameters, which may be
7221 specified individually by using @option{--param @var{name}=@var{value}}.
7222 The @option{-finline-limit=@var{n}} option sets some of these parameters
7223 as follows:
7225 @table @gcctabopt
7226 @item max-inline-insns-single
7227 is set to @var{n}/2.
7228 @item max-inline-insns-auto
7229 is set to @var{n}/2.
7230 @end table
7232 See below for a documentation of the individual
7233 parameters controlling inlining and for the defaults of these parameters.
7235 @emph{Note:} there may be no value to @option{-finline-limit} that results
7236 in default behavior.
7238 @emph{Note:} pseudo instruction represents, in this particular context, an
7239 abstract measurement of function's size.  In no way does it represent a count
7240 of assembly instructions and as such its exact meaning might change from one
7241 release to an another.
7243 @item -fno-keep-inline-dllexport
7244 @opindex fno-keep-inline-dllexport
7245 This is a more fine-grained version of @option{-fkeep-inline-functions},
7246 which applies only to functions that are declared using the @code{dllexport}
7247 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7248 Functions}.
7250 @item -fkeep-inline-functions
7251 @opindex fkeep-inline-functions
7252 In C, emit @code{static} functions that are declared @code{inline}
7253 into the object file, even if the function has been inlined into all
7254 of its callers.  This switch does not affect functions using the
7255 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7256 inline functions into the object file.
7258 @item -fkeep-static-functions
7259 @opindex fkeep-static-functions
7260 Emit @code{static} functions into the object file, even if the function
7261 is never used.
7263 @item -fkeep-static-consts
7264 @opindex fkeep-static-consts
7265 Emit variables declared @code{static const} when optimization isn't turned
7266 on, even if the variables aren't referenced.
7268 GCC enables this option by default.  If you want to force the compiler to
7269 check if a variable is referenced, regardless of whether or not
7270 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7272 @item -fmerge-constants
7273 @opindex fmerge-constants
7274 Attempt to merge identical constants (string constants and floating-point
7275 constants) across compilation units.
7277 This option is the default for optimized compilation if the assembler and
7278 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7279 behavior.
7281 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7283 @item -fmerge-all-constants
7284 @opindex fmerge-all-constants
7285 Attempt to merge identical constants and identical variables.
7287 This option implies @option{-fmerge-constants}.  In addition to
7288 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7289 arrays or initialized constant variables with integral or floating-point
7290 types.  Languages like C or C++ require each variable, including multiple
7291 instances of the same variable in recursive calls, to have distinct locations,
7292 so using this option results in non-conforming
7293 behavior.
7295 @item -fmodulo-sched
7296 @opindex fmodulo-sched
7297 Perform swing modulo scheduling immediately before the first scheduling
7298 pass.  This pass looks at innermost loops and reorders their
7299 instructions by overlapping different iterations.
7301 @item -fmodulo-sched-allow-regmoves
7302 @opindex fmodulo-sched-allow-regmoves
7303 Perform more aggressive SMS-based modulo scheduling with register moves
7304 allowed.  By setting this flag certain anti-dependences edges are
7305 deleted, which triggers the generation of reg-moves based on the
7306 life-range analysis.  This option is effective only with
7307 @option{-fmodulo-sched} enabled.
7309 @item -fno-branch-count-reg
7310 @opindex fno-branch-count-reg
7311 Avoid running a pass scanning for opportunities to use ``decrement and
7312 branch'' instructions on a count register instead of generating sequences
7313 of instructions that decrement a register, compare it against zero, and
7314 then branch based upon the result.  This option is only meaningful on
7315 architectures that support such instructions, which include x86, PowerPC,
7316 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7317 doesn't remove the decrement and branch instructions from the generated
7318 instruction stream introduced by other optimization passes.
7320 Enabled by default at @option{-O1} and higher.
7322 The default is @option{-fbranch-count-reg}.
7324 @item -fno-function-cse
7325 @opindex fno-function-cse
7326 Do not put function addresses in registers; make each instruction that
7327 calls a constant function contain the function's address explicitly.
7329 This option results in less efficient code, but some strange hacks
7330 that alter the assembler output may be confused by the optimizations
7331 performed when this option is not used.
7333 The default is @option{-ffunction-cse}
7335 @item -fno-zero-initialized-in-bss
7336 @opindex fno-zero-initialized-in-bss
7337 If the target supports a BSS section, GCC by default puts variables that
7338 are initialized to zero into BSS@.  This can save space in the resulting
7339 code.
7341 This option turns off this behavior because some programs explicitly
7342 rely on variables going to the data section---e.g., so that the
7343 resulting executable can find the beginning of that section and/or make
7344 assumptions based on that.
7346 The default is @option{-fzero-initialized-in-bss}.
7348 @item -fthread-jumps
7349 @opindex fthread-jumps
7350 Perform optimizations that check to see if a jump branches to a
7351 location where another comparison subsumed by the first is found.  If
7352 so, the first branch is redirected to either the destination of the
7353 second branch or a point immediately following it, depending on whether
7354 the condition is known to be true or false.
7356 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7358 @item -fsplit-wide-types
7359 @opindex fsplit-wide-types
7360 When using a type that occupies multiple registers, such as @code{long
7361 long} on a 32-bit system, split the registers apart and allocate them
7362 independently.  This normally generates better code for those types,
7363 but may make debugging more difficult.
7365 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7366 @option{-Os}.
7368 @item -fcse-follow-jumps
7369 @opindex fcse-follow-jumps
7370 In common subexpression elimination (CSE), scan through jump instructions
7371 when the target of the jump is not reached by any other path.  For
7372 example, when CSE encounters an @code{if} statement with an
7373 @code{else} clause, CSE follows the jump when the condition
7374 tested is false.
7376 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7378 @item -fcse-skip-blocks
7379 @opindex fcse-skip-blocks
7380 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7381 follow jumps that conditionally skip over blocks.  When CSE
7382 encounters a simple @code{if} statement with no else clause,
7383 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7384 body of the @code{if}.
7386 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7388 @item -frerun-cse-after-loop
7389 @opindex frerun-cse-after-loop
7390 Re-run common subexpression elimination after loop optimizations are
7391 performed.
7393 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7395 @item -fgcse
7396 @opindex fgcse
7397 Perform a global common subexpression elimination pass.
7398 This pass also performs global constant and copy propagation.
7400 @emph{Note:} When compiling a program using computed gotos, a GCC
7401 extension, you may get better run-time performance if you disable
7402 the global common subexpression elimination pass by adding
7403 @option{-fno-gcse} to the command line.
7405 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7407 @item -fgcse-lm
7408 @opindex fgcse-lm
7409 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7410 attempts to move loads that are only killed by stores into themselves.  This
7411 allows a loop containing a load/store sequence to be changed to a load outside
7412 the loop, and a copy/store within the loop.
7414 Enabled by default when @option{-fgcse} is enabled.
7416 @item -fgcse-sm
7417 @opindex fgcse-sm
7418 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7419 global common subexpression elimination.  This pass attempts to move
7420 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7421 loops containing a load/store sequence can be changed to a load before
7422 the loop and a store after the loop.
7424 Not enabled at any optimization level.
7426 @item -fgcse-las
7427 @opindex fgcse-las
7428 When @option{-fgcse-las} is enabled, the global common subexpression
7429 elimination pass eliminates redundant loads that come after stores to the
7430 same memory location (both partial and full redundancies).
7432 Not enabled at any optimization level.
7434 @item -fgcse-after-reload
7435 @opindex fgcse-after-reload
7436 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7437 pass is performed after reload.  The purpose of this pass is to clean up
7438 redundant spilling.
7440 @item -faggressive-loop-optimizations
7441 @opindex faggressive-loop-optimizations
7442 This option tells the loop optimizer to use language constraints to
7443 derive bounds for the number of iterations of a loop.  This assumes that
7444 loop code does not invoke undefined behavior by for example causing signed
7445 integer overflows or out-of-bound array accesses.  The bounds for the
7446 number of iterations of a loop are used to guide loop unrolling and peeling
7447 and loop exit test optimizations.
7448 This option is enabled by default.
7450 @item -funconstrained-commons
7451 @opindex funconstrained-commons
7452 This option tells the compiler that variables declared in common blocks
7453 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7454 prevents certain optimizations that depend on knowing the array bounds.
7456 @item -fcrossjumping
7457 @opindex fcrossjumping
7458 Perform cross-jumping transformation.
7459 This transformation unifies equivalent code and saves code size.  The
7460 resulting code may or may not perform better than without cross-jumping.
7462 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7464 @item -fauto-inc-dec
7465 @opindex fauto-inc-dec
7466 Combine increments or decrements of addresses with memory accesses.
7467 This pass is always skipped on architectures that do not have
7468 instructions to support this.  Enabled by default at @option{-O} and
7469 higher on architectures that support this.
7471 @item -fdce
7472 @opindex fdce
7473 Perform dead code elimination (DCE) on RTL@.
7474 Enabled by default at @option{-O} and higher.
7476 @item -fdse
7477 @opindex fdse
7478 Perform dead store elimination (DSE) on RTL@.
7479 Enabled by default at @option{-O} and higher.
7481 @item -fif-conversion
7482 @opindex fif-conversion
7483 Attempt to transform conditional jumps into branch-less equivalents.  This
7484 includes use of conditional moves, min, max, set flags and abs instructions, and
7485 some tricks doable by standard arithmetics.  The use of conditional execution
7486 on chips where it is available is controlled by @option{-fif-conversion2}.
7488 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7490 @item -fif-conversion2
7491 @opindex fif-conversion2
7492 Use conditional execution (where available) to transform conditional jumps into
7493 branch-less equivalents.
7495 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7497 @item -fdeclone-ctor-dtor
7498 @opindex fdeclone-ctor-dtor
7499 The C++ ABI requires multiple entry points for constructors and
7500 destructors: one for a base subobject, one for a complete object, and
7501 one for a virtual destructor that calls operator delete afterwards.
7502 For a hierarchy with virtual bases, the base and complete variants are
7503 clones, which means two copies of the function.  With this option, the
7504 base and complete variants are changed to be thunks that call a common
7505 implementation.
7507 Enabled by @option{-Os}.
7509 @item -fdelete-null-pointer-checks
7510 @opindex fdelete-null-pointer-checks
7511 Assume that programs cannot safely dereference null pointers, and that
7512 no code or data element resides at address zero.
7513 This option enables simple constant
7514 folding optimizations at all optimization levels.  In addition, other
7515 optimization passes in GCC use this flag to control global dataflow
7516 analyses that eliminate useless checks for null pointers; these assume
7517 that a memory access to address zero always results in a trap, so
7518 that if a pointer is checked after it has already been dereferenced,
7519 it cannot be null.
7521 Note however that in some environments this assumption is not true.
7522 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7523 for programs that depend on that behavior.
7525 This option is enabled by default on most targets.  On Nios II ELF, it
7526 defaults to off.  On AVR and CR16, this option is completely disabled.  
7528 Passes that use the dataflow information
7529 are enabled independently at different optimization levels.
7531 @item -fdevirtualize
7532 @opindex fdevirtualize
7533 Attempt to convert calls to virtual functions to direct calls.  This
7534 is done both within a procedure and interprocedurally as part of
7535 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7536 propagation (@option{-fipa-cp}).
7537 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7539 @item -fdevirtualize-speculatively
7540 @opindex fdevirtualize-speculatively
7541 Attempt to convert calls to virtual functions to speculative direct calls.
7542 Based on the analysis of the type inheritance graph, determine for a given call
7543 the set of likely targets. If the set is small, preferably of size 1, change
7544 the call into a conditional deciding between direct and indirect calls.  The
7545 speculative calls enable more optimizations, such as inlining.  When they seem
7546 useless after further optimization, they are converted back into original form.
7548 @item -fdevirtualize-at-ltrans
7549 @opindex fdevirtualize-at-ltrans
7550 Stream extra information needed for aggressive devirtualization when running
7551 the link-time optimizer in local transformation mode.  
7552 This option enables more devirtualization but
7553 significantly increases the size of streamed data. For this reason it is
7554 disabled by default.
7556 @item -fexpensive-optimizations
7557 @opindex fexpensive-optimizations
7558 Perform a number of minor optimizations that are relatively expensive.
7560 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7562 @item -free
7563 @opindex free
7564 Attempt to remove redundant extension instructions.  This is especially
7565 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7566 registers after writing to their lower 32-bit half.
7568 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7569 @option{-O3}, @option{-Os}.
7571 @item -fno-lifetime-dse
7572 @opindex fno-lifetime-dse
7573 In C++ the value of an object is only affected by changes within its
7574 lifetime: when the constructor begins, the object has an indeterminate
7575 value, and any changes during the lifetime of the object are dead when
7576 the object is destroyed.  Normally dead store elimination will take
7577 advantage of this; if your code relies on the value of the object
7578 storage persisting beyond the lifetime of the object, you can use this
7579 flag to disable this optimization.  To preserve stores before the
7580 constructor starts (e.g. because your operator new clears the object
7581 storage) but still treat the object as dead after the destructor you,
7582 can use @option{-flifetime-dse=1}.  The default behavior can be
7583 explicitly selected with @option{-flifetime-dse=2}.
7584 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7586 @item -flive-range-shrinkage
7587 @opindex flive-range-shrinkage
7588 Attempt to decrease register pressure through register live range
7589 shrinkage.  This is helpful for fast processors with small or moderate
7590 size register sets.
7592 @item -fira-algorithm=@var{algorithm}
7593 @opindex fira-algorithm
7594 Use the specified coloring algorithm for the integrated register
7595 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7596 specifies Chow's priority coloring, or @samp{CB}, which specifies
7597 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7598 for all architectures, but for those targets that do support it, it is
7599 the default because it generates better code.
7601 @item -fira-region=@var{region}
7602 @opindex fira-region
7603 Use specified regions for the integrated register allocator.  The
7604 @var{region} argument should be one of the following:
7606 @table @samp
7608 @item all
7609 Use all loops as register allocation regions.
7610 This can give the best results for machines with a small and/or
7611 irregular register set.
7613 @item mixed
7614 Use all loops except for loops with small register pressure 
7615 as the regions.  This value usually gives
7616 the best results in most cases and for most architectures,
7617 and is enabled by default when compiling with optimization for speed
7618 (@option{-O}, @option{-O2}, @dots{}).
7620 @item one
7621 Use all functions as a single region.  
7622 This typically results in the smallest code size, and is enabled by default for
7623 @option{-Os} or @option{-O0}.
7625 @end table
7627 @item -fira-hoist-pressure
7628 @opindex fira-hoist-pressure
7629 Use IRA to evaluate register pressure in the code hoisting pass for
7630 decisions to hoist expressions.  This option usually results in smaller
7631 code, but it can slow the compiler down.
7633 This option is enabled at level @option{-Os} for all targets.
7635 @item -fira-loop-pressure
7636 @opindex fira-loop-pressure
7637 Use IRA to evaluate register pressure in loops for decisions to move
7638 loop invariants.  This option usually results in generation
7639 of faster and smaller code on machines with large register files (>= 32
7640 registers), but it can slow the compiler down.
7642 This option is enabled at level @option{-O3} for some targets.
7644 @item -fno-ira-share-save-slots
7645 @opindex fno-ira-share-save-slots
7646 Disable sharing of stack slots used for saving call-used hard
7647 registers living through a call.  Each hard register gets a
7648 separate stack slot, and as a result function stack frames are
7649 larger.
7651 @item -fno-ira-share-spill-slots
7652 @opindex fno-ira-share-spill-slots
7653 Disable sharing of stack slots allocated for pseudo-registers.  Each
7654 pseudo-register that does not get a hard register gets a separate
7655 stack slot, and as a result function stack frames are larger.
7657 @item -flra-remat
7658 @opindex flra-remat
7659 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7660 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7661 values if it is profitable.
7663 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7665 @item -fdelayed-branch
7666 @opindex fdelayed-branch
7667 If supported for the target machine, attempt to reorder instructions
7668 to exploit instruction slots available after delayed branch
7669 instructions.
7671 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7673 @item -fschedule-insns
7674 @opindex fschedule-insns
7675 If supported for the target machine, attempt to reorder instructions to
7676 eliminate execution stalls due to required data being unavailable.  This
7677 helps machines that have slow floating point or memory load instructions
7678 by allowing other instructions to be issued until the result of the load
7679 or floating-point instruction is required.
7681 Enabled at levels @option{-O2}, @option{-O3}.
7683 @item -fschedule-insns2
7684 @opindex fschedule-insns2
7685 Similar to @option{-fschedule-insns}, but requests an additional pass of
7686 instruction scheduling after register allocation has been done.  This is
7687 especially useful on machines with a relatively small number of
7688 registers and where memory load instructions take more than one cycle.
7690 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7692 @item -fno-sched-interblock
7693 @opindex fno-sched-interblock
7694 Don't schedule instructions across basic blocks.  This is normally
7695 enabled by default when scheduling before register allocation, i.e.@:
7696 with @option{-fschedule-insns} or at @option{-O2} or higher.
7698 @item -fno-sched-spec
7699 @opindex fno-sched-spec
7700 Don't allow speculative motion of non-load instructions.  This is normally
7701 enabled by default when scheduling before register allocation, i.e.@:
7702 with @option{-fschedule-insns} or at @option{-O2} or higher.
7704 @item -fsched-pressure
7705 @opindex fsched-pressure
7706 Enable register pressure sensitive insn scheduling before register
7707 allocation.  This only makes sense when scheduling before register
7708 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7709 @option{-O2} or higher.  Usage of this option can improve the
7710 generated code and decrease its size by preventing register pressure
7711 increase above the number of available hard registers and subsequent
7712 spills in register allocation.
7714 @item -fsched-spec-load
7715 @opindex fsched-spec-load
7716 Allow speculative motion of some load instructions.  This only makes
7717 sense when scheduling before register allocation, i.e.@: with
7718 @option{-fschedule-insns} or at @option{-O2} or higher.
7720 @item -fsched-spec-load-dangerous
7721 @opindex fsched-spec-load-dangerous
7722 Allow speculative motion of more load instructions.  This only makes
7723 sense when scheduling before register allocation, i.e.@: with
7724 @option{-fschedule-insns} or at @option{-O2} or higher.
7726 @item -fsched-stalled-insns
7727 @itemx -fsched-stalled-insns=@var{n}
7728 @opindex fsched-stalled-insns
7729 Define how many insns (if any) can be moved prematurely from the queue
7730 of stalled insns into the ready list during the second scheduling pass.
7731 @option{-fno-sched-stalled-insns} means that no insns are moved
7732 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7733 on how many queued insns can be moved prematurely.
7734 @option{-fsched-stalled-insns} without a value is equivalent to
7735 @option{-fsched-stalled-insns=1}.
7737 @item -fsched-stalled-insns-dep
7738 @itemx -fsched-stalled-insns-dep=@var{n}
7739 @opindex fsched-stalled-insns-dep
7740 Define how many insn groups (cycles) are examined for a dependency
7741 on a stalled insn that is a candidate for premature removal from the queue
7742 of stalled insns.  This has an effect only during the second scheduling pass,
7743 and only if @option{-fsched-stalled-insns} is used.
7744 @option{-fno-sched-stalled-insns-dep} is equivalent to
7745 @option{-fsched-stalled-insns-dep=0}.
7746 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7747 @option{-fsched-stalled-insns-dep=1}.
7749 @item -fsched2-use-superblocks
7750 @opindex fsched2-use-superblocks
7751 When scheduling after register allocation, use superblock scheduling.
7752 This allows motion across basic block boundaries,
7753 resulting in faster schedules.  This option is experimental, as not all machine
7754 descriptions used by GCC model the CPU closely enough to avoid unreliable
7755 results from the algorithm.
7757 This only makes sense when scheduling after register allocation, i.e.@: with
7758 @option{-fschedule-insns2} or at @option{-O2} or higher.
7760 @item -fsched-group-heuristic
7761 @opindex fsched-group-heuristic
7762 Enable the group heuristic in the scheduler.  This heuristic favors
7763 the instruction that belongs to a schedule group.  This is enabled
7764 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7765 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7767 @item -fsched-critical-path-heuristic
7768 @opindex fsched-critical-path-heuristic
7769 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7770 instructions on the critical path.  This is enabled by default when
7771 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7772 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7774 @item -fsched-spec-insn-heuristic
7775 @opindex fsched-spec-insn-heuristic
7776 Enable the speculative instruction heuristic in the scheduler.  This
7777 heuristic favors speculative instructions with greater dependency weakness.
7778 This is enabled by default when scheduling is enabled, i.e.@:
7779 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7780 or at @option{-O2} or higher.
7782 @item -fsched-rank-heuristic
7783 @opindex fsched-rank-heuristic
7784 Enable the rank heuristic in the scheduler.  This heuristic favors
7785 the instruction belonging to a basic block with greater size or frequency.
7786 This is enabled by default when scheduling is enabled, i.e.@:
7787 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7788 at @option{-O2} or higher.
7790 @item -fsched-last-insn-heuristic
7791 @opindex fsched-last-insn-heuristic
7792 Enable the last-instruction heuristic in the scheduler.  This heuristic
7793 favors the instruction that is less dependent on the last instruction
7794 scheduled.  This is enabled by default when scheduling is enabled,
7795 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7796 at @option{-O2} or higher.
7798 @item -fsched-dep-count-heuristic
7799 @opindex fsched-dep-count-heuristic
7800 Enable the dependent-count heuristic in the scheduler.  This heuristic
7801 favors the instruction that has more instructions depending on it.
7802 This is enabled by default when scheduling is enabled, i.e.@:
7803 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7804 at @option{-O2} or higher.
7806 @item -freschedule-modulo-scheduled-loops
7807 @opindex freschedule-modulo-scheduled-loops
7808 Modulo scheduling is performed before traditional scheduling.  If a loop
7809 is modulo scheduled, later scheduling passes may change its schedule.  
7810 Use this option to control that behavior.
7812 @item -fselective-scheduling
7813 @opindex fselective-scheduling
7814 Schedule instructions using selective scheduling algorithm.  Selective
7815 scheduling runs instead of the first scheduler pass.
7817 @item -fselective-scheduling2
7818 @opindex fselective-scheduling2
7819 Schedule instructions using selective scheduling algorithm.  Selective
7820 scheduling runs instead of the second scheduler pass.
7822 @item -fsel-sched-pipelining
7823 @opindex fsel-sched-pipelining
7824 Enable software pipelining of innermost loops during selective scheduling.
7825 This option has no effect unless one of @option{-fselective-scheduling} or
7826 @option{-fselective-scheduling2} is turned on.
7828 @item -fsel-sched-pipelining-outer-loops
7829 @opindex fsel-sched-pipelining-outer-loops
7830 When pipelining loops during selective scheduling, also pipeline outer loops.
7831 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7833 @item -fsemantic-interposition
7834 @opindex fsemantic-interposition
7835 Some object formats, like ELF, allow interposing of symbols by the 
7836 dynamic linker.
7837 This means that for symbols exported from the DSO, the compiler cannot perform
7838 interprocedural propagation, inlining and other optimizations in anticipation
7839 that the function or variable in question may change. While this feature is
7840 useful, for example, to rewrite memory allocation functions by a debugging
7841 implementation, it is expensive in the terms of code quality.
7842 With @option{-fno-semantic-interposition} the compiler assumes that 
7843 if interposition happens for functions the overwriting function will have 
7844 precisely the same semantics (and side effects). 
7845 Similarly if interposition happens
7846 for variables, the constructor of the variable will be the same. The flag
7847 has no effect for functions explicitly declared inline 
7848 (where it is never allowed for interposition to change semantics) 
7849 and for symbols explicitly declared weak.
7851 @item -fshrink-wrap
7852 @opindex fshrink-wrap
7853 Emit function prologues only before parts of the function that need it,
7854 rather than at the top of the function.  This flag is enabled by default at
7855 @option{-O} and higher.
7857 @item -fshrink-wrap-separate
7858 @opindex fshrink-wrap-separate
7859 Shrink-wrap separate parts of the prologue and epilogue separately, so that
7860 those parts are only executed when needed.
7861 This option is on by default, but has no effect unless @option{-fshrink-wrap}
7862 is also turned on and the target supports this.
7864 @item -fcaller-saves
7865 @opindex fcaller-saves
7866 Enable allocation of values to registers that are clobbered by
7867 function calls, by emitting extra instructions to save and restore the
7868 registers around such calls.  Such allocation is done only when it
7869 seems to result in better code.
7871 This option is always enabled by default on certain machines, usually
7872 those which have no call-preserved registers to use instead.
7874 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7876 @item -fcombine-stack-adjustments
7877 @opindex fcombine-stack-adjustments
7878 Tracks stack adjustments (pushes and pops) and stack memory references
7879 and then tries to find ways to combine them.
7881 Enabled by default at @option{-O1} and higher.
7883 @item -fipa-ra
7884 @opindex fipa-ra
7885 Use caller save registers for allocation if those registers are not used by
7886 any called function.  In that case it is not necessary to save and restore
7887 them around calls.  This is only possible if called functions are part of
7888 same compilation unit as current function and they are compiled before it.
7890 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
7891 is disabled if generated code will be instrumented for profiling
7892 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
7893 exactly (this happens on targets that do not expose prologues
7894 and epilogues in RTL).
7896 @item -fconserve-stack
7897 @opindex fconserve-stack
7898 Attempt to minimize stack usage.  The compiler attempts to use less
7899 stack space, even if that makes the program slower.  This option
7900 implies setting the @option{large-stack-frame} parameter to 100
7901 and the @option{large-stack-frame-growth} parameter to 400.
7903 @item -ftree-reassoc
7904 @opindex ftree-reassoc
7905 Perform reassociation on trees.  This flag is enabled by default
7906 at @option{-O} and higher.
7908 @item -fcode-hoisting
7909 @opindex fcode-hoisting
7910 Perform code hoisting.  Code hoisting tries to move the
7911 evaluation of expressions executed on all paths to the function exit
7912 as early as possible.  This is especially useful as a code size
7913 optimization, but it often helps for code speed as well.
7914 This flag is enabled by default at @option{-O2} and higher.
7916 @item -ftree-pre
7917 @opindex ftree-pre
7918 Perform partial redundancy elimination (PRE) on trees.  This flag is
7919 enabled by default at @option{-O2} and @option{-O3}.
7921 @item -ftree-partial-pre
7922 @opindex ftree-partial-pre
7923 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7924 enabled by default at @option{-O3}.
7926 @item -ftree-forwprop
7927 @opindex ftree-forwprop
7928 Perform forward propagation on trees.  This flag is enabled by default
7929 at @option{-O} and higher.
7931 @item -ftree-fre
7932 @opindex ftree-fre
7933 Perform full redundancy elimination (FRE) on trees.  The difference
7934 between FRE and PRE is that FRE only considers expressions
7935 that are computed on all paths leading to the redundant computation.
7936 This analysis is faster than PRE, though it exposes fewer redundancies.
7937 This flag is enabled by default at @option{-O} and higher.
7939 @item -ftree-phiprop
7940 @opindex ftree-phiprop
7941 Perform hoisting of loads from conditional pointers on trees.  This
7942 pass is enabled by default at @option{-O} and higher.
7944 @item -fhoist-adjacent-loads
7945 @opindex fhoist-adjacent-loads
7946 Speculatively hoist loads from both branches of an if-then-else if the
7947 loads are from adjacent locations in the same structure and the target
7948 architecture has a conditional move instruction.  This flag is enabled
7949 by default at @option{-O2} and higher.
7951 @item -ftree-copy-prop
7952 @opindex ftree-copy-prop
7953 Perform copy propagation on trees.  This pass eliminates unnecessary
7954 copy operations.  This flag is enabled by default at @option{-O} and
7955 higher.
7957 @item -fipa-pure-const
7958 @opindex fipa-pure-const
7959 Discover which functions are pure or constant.
7960 Enabled by default at @option{-O} and higher.
7962 @item -fipa-reference
7963 @opindex fipa-reference
7964 Discover which static variables do not escape the
7965 compilation unit.
7966 Enabled by default at @option{-O} and higher.
7968 @item -fipa-pta
7969 @opindex fipa-pta
7970 Perform interprocedural pointer analysis and interprocedural modification
7971 and reference analysis.  This option can cause excessive memory and
7972 compile-time usage on large compilation units.  It is not enabled by
7973 default at any optimization level.
7975 @item -fipa-profile
7976 @opindex fipa-profile
7977 Perform interprocedural profile propagation.  The functions called only from
7978 cold functions are marked as cold. Also functions executed once (such as
7979 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7980 functions and loop less parts of functions executed once are then optimized for
7981 size.
7982 Enabled by default at @option{-O} and higher.
7984 @item -fipa-cp
7985 @opindex fipa-cp
7986 Perform interprocedural constant propagation.
7987 This optimization analyzes the program to determine when values passed
7988 to functions are constants and then optimizes accordingly.
7989 This optimization can substantially increase performance
7990 if the application has constants passed to functions.
7991 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7993 @item -fipa-cp-clone
7994 @opindex fipa-cp-clone
7995 Perform function cloning to make interprocedural constant propagation stronger.
7996 When enabled, interprocedural constant propagation performs function cloning
7997 when externally visible function can be called with constant arguments.
7998 Because this optimization can create multiple copies of functions,
7999 it may significantly increase code size
8000 (see @option{--param ipcp-unit-growth=@var{value}}).
8001 This flag is enabled by default at @option{-O3}.
8003 @item -fipa-cp-alignment
8004 @opindex -fipa-cp-alignment
8005 When enabled, this optimization propagates alignment of function
8006 parameters to support better vectorization and string operations.
8008 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8009 requires that @option{-fipa-cp} is enabled.
8010 @option{-fipa-cp-alignment} is obsolete, use @option{-fipa-bit-cp} instead.
8012 @item -fipa-bit-cp
8013 @opindex -fipa-bit-cp
8014 When enabled, perform ipa bitwise constant propagation. This flag is
8015 enabled by default at @option{-O2}. It requires that @option{-fipa-cp}
8016 is enabled.
8018 @item -fipa-icf
8019 @opindex fipa-icf
8020 Perform Identical Code Folding for functions and read-only variables.
8021 The optimization reduces code size and may disturb unwind stacks by replacing
8022 a function by equivalent one with a different name. The optimization works
8023 more effectively with link time optimization enabled.
8025 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8026 works on different levels and thus the optimizations are not same - there are
8027 equivalences that are found only by GCC and equivalences found only by Gold.
8029 This flag is enabled by default at @option{-O2} and @option{-Os}.
8031 @item -fisolate-erroneous-paths-dereference
8032 @opindex fisolate-erroneous-paths-dereference
8033 Detect paths that trigger erroneous or undefined behavior due to
8034 dereferencing a null pointer.  Isolate those paths from the main control
8035 flow and turn the statement with erroneous or undefined behavior into a trap.
8036 This flag is enabled by default at @option{-O2} and higher and depends on
8037 @option{-fdelete-null-pointer-checks} also being enabled.
8039 @item -fisolate-erroneous-paths-attribute
8040 @opindex fisolate-erroneous-paths-attribute
8041 Detect paths that trigger erroneous or undefined behavior due a null value
8042 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8043 attribute.  Isolate those paths from the main control flow and turn the
8044 statement with erroneous or undefined behavior into a trap.  This is not
8045 currently enabled, but may be enabled by @option{-O2} in the future.
8047 @item -ftree-sink
8048 @opindex ftree-sink
8049 Perform forward store motion on trees.  This flag is
8050 enabled by default at @option{-O} and higher.
8052 @item -ftree-bit-ccp
8053 @opindex ftree-bit-ccp
8054 Perform sparse conditional bit constant propagation on trees and propagate
8055 pointer alignment information.
8056 This pass only operates on local scalar variables and is enabled by default
8057 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8059 @item -ftree-ccp
8060 @opindex ftree-ccp
8061 Perform sparse conditional constant propagation (CCP) on trees.  This
8062 pass only operates on local scalar variables and is enabled by default
8063 at @option{-O} and higher.
8065 @item -fssa-backprop
8066 @opindex fssa-backprop
8067 Propagate information about uses of a value up the definition chain
8068 in order to simplify the definitions.  For example, this pass strips
8069 sign operations if the sign of a value never matters.  The flag is
8070 enabled by default at @option{-O} and higher.
8072 @item -fssa-phiopt
8073 @opindex fssa-phiopt
8074 Perform pattern matching on SSA PHI nodes to optimize conditional
8075 code.  This pass is enabled by default at @option{-O} and higher.
8077 @item -ftree-switch-conversion
8078 @opindex ftree-switch-conversion
8079 Perform conversion of simple initializations in a switch to
8080 initializations from a scalar array.  This flag is enabled by default
8081 at @option{-O2} and higher.
8083 @item -ftree-tail-merge
8084 @opindex ftree-tail-merge
8085 Look for identical code sequences.  When found, replace one with a jump to the
8086 other.  This optimization is known as tail merging or cross jumping.  This flag
8087 is enabled by default at @option{-O2} and higher.  The compilation time
8088 in this pass can
8089 be limited using @option{max-tail-merge-comparisons} parameter and
8090 @option{max-tail-merge-iterations} parameter.
8092 @item -ftree-dce
8093 @opindex ftree-dce
8094 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8095 default at @option{-O} and higher.
8097 @item -ftree-builtin-call-dce
8098 @opindex ftree-builtin-call-dce
8099 Perform conditional dead code elimination (DCE) for calls to built-in functions
8100 that may set @code{errno} but are otherwise side-effect free.  This flag is
8101 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8102 specified.
8104 @item -ftree-dominator-opts
8105 @opindex ftree-dominator-opts
8106 Perform a variety of simple scalar cleanups (constant/copy
8107 propagation, redundancy elimination, range propagation and expression
8108 simplification) based on a dominator tree traversal.  This also
8109 performs jump threading (to reduce jumps to jumps). This flag is
8110 enabled by default at @option{-O} and higher.
8112 @item -ftree-dse
8113 @opindex ftree-dse
8114 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8115 a memory location that is later overwritten by another store without
8116 any intervening loads.  In this case the earlier store can be deleted.  This
8117 flag is enabled by default at @option{-O} and higher.
8119 @item -ftree-ch
8120 @opindex ftree-ch
8121 Perform loop header copying on trees.  This is beneficial since it increases
8122 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8123 is enabled by default at @option{-O} and higher.  It is not enabled
8124 for @option{-Os}, since it usually increases code size.
8126 @item -ftree-loop-optimize
8127 @opindex ftree-loop-optimize
8128 Perform loop optimizations on trees.  This flag is enabled by default
8129 at @option{-O} and higher.
8131 @item -ftree-loop-linear
8132 @itemx -floop-interchange
8133 @itemx -floop-strip-mine
8134 @itemx -floop-block
8135 @itemx -floop-unroll-and-jam
8136 @opindex ftree-loop-linear
8137 @opindex floop-interchange
8138 @opindex floop-strip-mine
8139 @opindex floop-block
8140 @opindex floop-unroll-and-jam
8141 Perform loop nest optimizations.  Same as
8142 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8143 to be configured with @option{--with-isl} to enable the Graphite loop
8144 transformation infrastructure.
8146 @item -fgraphite-identity
8147 @opindex fgraphite-identity
8148 Enable the identity transformation for graphite.  For every SCoP we generate
8149 the polyhedral representation and transform it back to gimple.  Using
8150 @option{-fgraphite-identity} we can check the costs or benefits of the
8151 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8152 are also performed by the code generator isl, like index splitting and
8153 dead code elimination in loops.
8155 @item -floop-nest-optimize
8156 @opindex floop-nest-optimize
8157 Enable the isl based loop nest optimizer.  This is a generic loop nest
8158 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8159 structure optimized for data-locality and parallelism.  This option
8160 is experimental.
8162 @item -floop-parallelize-all
8163 @opindex floop-parallelize-all
8164 Use the Graphite data dependence analysis to identify loops that can
8165 be parallelized.  Parallelize all the loops that can be analyzed to
8166 not contain loop carried dependences without checking that it is
8167 profitable to parallelize the loops.
8169 @item -ftree-coalesce-vars
8170 @opindex ftree-coalesce-vars
8171 While transforming the program out of the SSA representation, attempt to
8172 reduce copying by coalescing versions of different user-defined
8173 variables, instead of just compiler temporaries.  This may severely
8174 limit the ability to debug an optimized program compiled with
8175 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8176 prevents SSA coalescing of user variables.  This option is enabled by
8177 default if optimization is enabled, and it does very little otherwise.
8179 @item -ftree-loop-if-convert
8180 @opindex ftree-loop-if-convert
8181 Attempt to transform conditional jumps in the innermost loops to
8182 branch-less equivalents.  The intent is to remove control-flow from
8183 the innermost loops in order to improve the ability of the
8184 vectorization pass to handle these loops.  This is enabled by default
8185 if vectorization is enabled.
8187 @item -ftree-loop-distribution
8188 @opindex ftree-loop-distribution
8189 Perform loop distribution.  This flag can improve cache performance on
8190 big loop bodies and allow further loop optimizations, like
8191 parallelization or vectorization, to take place.  For example, the loop
8192 @smallexample
8193 DO I = 1, N
8194   A(I) = B(I) + C
8195   D(I) = E(I) * F
8196 ENDDO
8197 @end smallexample
8198 is transformed to
8199 @smallexample
8200 DO I = 1, N
8201    A(I) = B(I) + C
8202 ENDDO
8203 DO I = 1, N
8204    D(I) = E(I) * F
8205 ENDDO
8206 @end smallexample
8208 @item -ftree-loop-distribute-patterns
8209 @opindex ftree-loop-distribute-patterns
8210 Perform loop distribution of patterns that can be code generated with
8211 calls to a library.  This flag is enabled by default at @option{-O3}.
8213 This pass distributes the initialization loops and generates a call to
8214 memset zero.  For example, the loop
8215 @smallexample
8216 DO I = 1, N
8217   A(I) = 0
8218   B(I) = A(I) + I
8219 ENDDO
8220 @end smallexample
8221 is transformed to
8222 @smallexample
8223 DO I = 1, N
8224    A(I) = 0
8225 ENDDO
8226 DO I = 1, N
8227    B(I) = A(I) + I
8228 ENDDO
8229 @end smallexample
8230 and the initialization loop is transformed into a call to memset zero.
8232 @item -ftree-loop-im
8233 @opindex ftree-loop-im
8234 Perform loop invariant motion on trees.  This pass moves only invariants that
8235 are hard to handle at RTL level (function calls, operations that expand to
8236 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8237 operands of conditions that are invariant out of the loop, so that we can use
8238 just trivial invariantness analysis in loop unswitching.  The pass also includes
8239 store motion.
8241 @item -ftree-loop-ivcanon
8242 @opindex ftree-loop-ivcanon
8243 Create a canonical counter for number of iterations in loops for which
8244 determining number of iterations requires complicated analysis.  Later
8245 optimizations then may determine the number easily.  Useful especially
8246 in connection with unrolling.
8248 @item -fivopts
8249 @opindex fivopts
8250 Perform induction variable optimizations (strength reduction, induction
8251 variable merging and induction variable elimination) on trees.
8253 @item -ftree-parallelize-loops=n
8254 @opindex ftree-parallelize-loops
8255 Parallelize loops, i.e., split their iteration space to run in n threads.
8256 This is only possible for loops whose iterations are independent
8257 and can be arbitrarily reordered.  The optimization is only
8258 profitable on multiprocessor machines, for loops that are CPU-intensive,
8259 rather than constrained e.g.@: by memory bandwidth.  This option
8260 implies @option{-pthread}, and thus is only supported on targets
8261 that have support for @option{-pthread}.
8263 @item -ftree-pta
8264 @opindex ftree-pta
8265 Perform function-local points-to analysis on trees.  This flag is
8266 enabled by default at @option{-O} and higher.
8268 @item -ftree-sra
8269 @opindex ftree-sra
8270 Perform scalar replacement of aggregates.  This pass replaces structure
8271 references with scalars to prevent committing structures to memory too
8272 early.  This flag is enabled by default at @option{-O} and higher.
8274 @item -fstore-merging
8275 @opindex fstore-merging
8276 Perform merging of narrow stores to consecutive memory addresses.  This pass
8277 merges contiguous stores of immediate values narrower than a word into fewer
8278 wider stores to reduce the number of instructions.  This is enabled by default
8279 at @option{-O} and higher.
8281 @item -ftree-ter
8282 @opindex ftree-ter
8283 Perform temporary expression replacement during the SSA->normal phase.  Single
8284 use/single def temporaries are replaced at their use location with their
8285 defining expression.  This results in non-GIMPLE code, but gives the expanders
8286 much more complex trees to work on resulting in better RTL generation.  This is
8287 enabled by default at @option{-O} and higher.
8289 @item -ftree-slsr
8290 @opindex ftree-slsr
8291 Perform straight-line strength reduction on trees.  This recognizes related
8292 expressions involving multiplications and replaces them by less expensive
8293 calculations when possible.  This is enabled by default at @option{-O} and
8294 higher.
8296 @item -ftree-vectorize
8297 @opindex ftree-vectorize
8298 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8299 and @option{-ftree-slp-vectorize} if not explicitly specified.
8301 @item -ftree-loop-vectorize
8302 @opindex ftree-loop-vectorize
8303 Perform loop vectorization on trees. This flag is enabled by default at
8304 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8306 @item -ftree-slp-vectorize
8307 @opindex ftree-slp-vectorize
8308 Perform basic block vectorization on trees. This flag is enabled by default at
8309 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8311 @item -fvect-cost-model=@var{model}
8312 @opindex fvect-cost-model
8313 Alter the cost model used for vectorization.  The @var{model} argument
8314 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8315 With the @samp{unlimited} model the vectorized code-path is assumed
8316 to be profitable while with the @samp{dynamic} model a runtime check
8317 guards the vectorized code-path to enable it only for iteration
8318 counts that will likely execute faster than when executing the original
8319 scalar loop.  The @samp{cheap} model disables vectorization of
8320 loops where doing so would be cost prohibitive for example due to
8321 required runtime checks for data dependence or alignment but otherwise
8322 is equal to the @samp{dynamic} model.
8323 The default cost model depends on other optimization flags and is
8324 either @samp{dynamic} or @samp{cheap}.
8326 @item -fsimd-cost-model=@var{model}
8327 @opindex fsimd-cost-model
8328 Alter the cost model used for vectorization of loops marked with the OpenMP
8329 or Cilk Plus simd directive.  The @var{model} argument should be one of
8330 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8331 have the same meaning as described in @option{-fvect-cost-model} and by
8332 default a cost model defined with @option{-fvect-cost-model} is used.
8334 @item -ftree-vrp
8335 @opindex ftree-vrp
8336 Perform Value Range Propagation on trees.  This is similar to the
8337 constant propagation pass, but instead of values, ranges of values are
8338 propagated.  This allows the optimizers to remove unnecessary range
8339 checks like array bound checks and null pointer checks.  This is
8340 enabled by default at @option{-O2} and higher.  Null pointer check
8341 elimination is only done if @option{-fdelete-null-pointer-checks} is
8342 enabled.
8344 @item -fsplit-paths
8345 @opindex fsplit-paths
8346 Split paths leading to loop backedges.  This can improve dead code
8347 elimination and common subexpression elimination.  This is enabled by
8348 default at @option{-O2} and above.
8350 @item -fsplit-ivs-in-unroller
8351 @opindex fsplit-ivs-in-unroller
8352 Enables expression of values of induction variables in later iterations
8353 of the unrolled loop using the value in the first iteration.  This breaks
8354 long dependency chains, thus improving efficiency of the scheduling passes.
8356 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8357 same effect.  However, that is not reliable in cases where the loop body
8358 is more complicated than a single basic block.  It also does not work at all
8359 on some architectures due to restrictions in the CSE pass.
8361 This optimization is enabled by default.
8363 @item -fvariable-expansion-in-unroller
8364 @opindex fvariable-expansion-in-unroller
8365 With this option, the compiler creates multiple copies of some
8366 local variables when unrolling a loop, which can result in superior code.
8368 @item -fpartial-inlining
8369 @opindex fpartial-inlining
8370 Inline parts of functions.  This option has any effect only
8371 when inlining itself is turned on by the @option{-finline-functions}
8372 or @option{-finline-small-functions} options.
8374 Enabled at level @option{-O2}.
8376 @item -fpredictive-commoning
8377 @opindex fpredictive-commoning
8378 Perform predictive commoning optimization, i.e., reusing computations
8379 (especially memory loads and stores) performed in previous
8380 iterations of loops.
8382 This option is enabled at level @option{-O3}.
8384 @item -fprefetch-loop-arrays
8385 @opindex fprefetch-loop-arrays
8386 If supported by the target machine, generate instructions to prefetch
8387 memory to improve the performance of loops that access large arrays.
8389 This option may generate better or worse code; results are highly
8390 dependent on the structure of loops within the source code.
8392 Disabled at level @option{-Os}.
8394 @item -fno-printf-return-value
8395 @opindex fno-printf-return-value
8396 Do not substitute constants for known return value of formatted output
8397 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8398 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8399 transformation allows GCC to optimize or even eliminate branches based
8400 on the known return value of these functions called with arguments that
8401 are either constant, or whose values are known to be in a range that
8402 makes determining the exact return value possible.  For example, when
8403 @option{-fprintf-return-value} is in effect, both the branch and the
8404 body of the @code{if} statement (but not the call to @code{snprint})
8405 can be optimized away when @code{i} is a 32-bit or smaller integer
8406 because the return value is guaranteed to be at most 8.
8408 @smallexample
8409 char buf[9];
8410 if (snprintf (buf, "%08x", i) >= sizeof buf)
8411   @dots{}
8412 @end smallexample
8414 The @option{-fprintf-return-value} option relies on other optimizations
8415 and yields best results with @option{-O2}.  It works in tandem with the
8416 @option{-Wformat-length} option.  The @option{-fprintf-return-value}
8417 option is enabled by default.
8419 @item -fno-peephole
8420 @itemx -fno-peephole2
8421 @opindex fno-peephole
8422 @opindex fno-peephole2
8423 Disable any machine-specific peephole optimizations.  The difference
8424 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8425 are implemented in the compiler; some targets use one, some use the
8426 other, a few use both.
8428 @option{-fpeephole} is enabled by default.
8429 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8431 @item -fno-guess-branch-probability
8432 @opindex fno-guess-branch-probability
8433 Do not guess branch probabilities using heuristics.
8435 GCC uses heuristics to guess branch probabilities if they are
8436 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8437 heuristics are based on the control flow graph.  If some branch probabilities
8438 are specified by @code{__builtin_expect}, then the heuristics are
8439 used to guess branch probabilities for the rest of the control flow graph,
8440 taking the @code{__builtin_expect} info into account.  The interactions
8441 between the heuristics and @code{__builtin_expect} can be complex, and in
8442 some cases, it may be useful to disable the heuristics so that the effects
8443 of @code{__builtin_expect} are easier to understand.
8445 The default is @option{-fguess-branch-probability} at levels
8446 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8448 @item -freorder-blocks
8449 @opindex freorder-blocks
8450 Reorder basic blocks in the compiled function in order to reduce number of
8451 taken branches and improve code locality.
8453 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8455 @item -freorder-blocks-algorithm=@var{algorithm}
8456 @opindex freorder-blocks-algorithm
8457 Use the specified algorithm for basic block reordering.  The
8458 @var{algorithm} argument can be @samp{simple}, which does not increase
8459 code size (except sometimes due to secondary effects like alignment),
8460 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8461 put all often executed code together, minimizing the number of branches
8462 executed by making extra copies of code.
8464 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8465 @samp{stc} at levels @option{-O2}, @option{-O3}.
8467 @item -freorder-blocks-and-partition
8468 @opindex freorder-blocks-and-partition
8469 In addition to reordering basic blocks in the compiled function, in order
8470 to reduce number of taken branches, partitions hot and cold basic blocks
8471 into separate sections of the assembly and @file{.o} files, to improve
8472 paging and cache locality performance.
8474 This optimization is automatically turned off in the presence of
8475 exception handling, for linkonce sections, for functions with a user-defined
8476 section attribute and on any architecture that does not support named
8477 sections.
8479 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8481 @item -freorder-functions
8482 @opindex freorder-functions
8483 Reorder functions in the object file in order to
8484 improve code locality.  This is implemented by using special
8485 subsections @code{.text.hot} for most frequently executed functions and
8486 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8487 the linker so object file format must support named sections and linker must
8488 place them in a reasonable way.
8490 Also profile feedback must be available to make this option effective.  See
8491 @option{-fprofile-arcs} for details.
8493 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8495 @item -fstrict-aliasing
8496 @opindex fstrict-aliasing
8497 Allow the compiler to assume the strictest aliasing rules applicable to
8498 the language being compiled.  For C (and C++), this activates
8499 optimizations based on the type of expressions.  In particular, an
8500 object of one type is assumed never to reside at the same address as an
8501 object of a different type, unless the types are almost the same.  For
8502 example, an @code{unsigned int} can alias an @code{int}, but not a
8503 @code{void*} or a @code{double}.  A character type may alias any other
8504 type.
8506 @anchor{Type-punning}Pay special attention to code like this:
8507 @smallexample
8508 union a_union @{
8509   int i;
8510   double d;
8513 int f() @{
8514   union a_union t;
8515   t.d = 3.0;
8516   return t.i;
8518 @end smallexample
8519 The practice of reading from a different union member than the one most
8520 recently written to (called ``type-punning'') is common.  Even with
8521 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8522 is accessed through the union type.  So, the code above works as
8523 expected.  @xref{Structures unions enumerations and bit-fields
8524 implementation}.  However, this code might not:
8525 @smallexample
8526 int f() @{
8527   union a_union t;
8528   int* ip;
8529   t.d = 3.0;
8530   ip = &t.i;
8531   return *ip;
8533 @end smallexample
8535 Similarly, access by taking the address, casting the resulting pointer
8536 and dereferencing the result has undefined behavior, even if the cast
8537 uses a union type, e.g.:
8538 @smallexample
8539 int f() @{
8540   double d = 3.0;
8541   return ((union a_union *) &d)->i;
8543 @end smallexample
8545 The @option{-fstrict-aliasing} option is enabled at levels
8546 @option{-O2}, @option{-O3}, @option{-Os}.
8548 @item -fstrict-overflow
8549 @opindex fstrict-overflow
8550 Allow the compiler to assume strict signed overflow rules, depending
8551 on the language being compiled.  For C (and C++) this means that
8552 overflow when doing arithmetic with signed numbers is undefined, which
8553 means that the compiler may assume that it does not happen.  This
8554 permits various optimizations.  For example, the compiler assumes
8555 that an expression like @code{i + 10 > i} is always true for
8556 signed @code{i}.  This assumption is only valid if signed overflow is
8557 undefined, as the expression is false if @code{i + 10} overflows when
8558 using twos complement arithmetic.  When this option is in effect any
8559 attempt to determine whether an operation on signed numbers 
8560 overflows must be written carefully to not actually involve overflow.
8562 This option also allows the compiler to assume strict pointer
8563 semantics: given a pointer to an object, if adding an offset to that
8564 pointer does not produce a pointer to the same object, the addition is
8565 undefined.  This permits the compiler to conclude that @code{p + u >
8566 p} is always true for a pointer @code{p} and unsigned integer
8567 @code{u}.  This assumption is only valid because pointer wraparound is
8568 undefined, as the expression is false if @code{p + u} overflows using
8569 twos complement arithmetic.
8571 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8572 that integer signed overflow is fully defined: it wraps.  When
8573 @option{-fwrapv} is used, there is no difference between
8574 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8575 integers.  With @option{-fwrapv} certain types of overflow are
8576 permitted.  For example, if the compiler gets an overflow when doing
8577 arithmetic on constants, the overflowed value can still be used with
8578 @option{-fwrapv}, but not otherwise.
8580 The @option{-fstrict-overflow} option is enabled at levels
8581 @option{-O2}, @option{-O3}, @option{-Os}.
8583 @item -falign-functions
8584 @itemx -falign-functions=@var{n}
8585 @opindex falign-functions
8586 Align the start of functions to the next power-of-two greater than
8587 @var{n}, skipping up to @var{n} bytes.  For instance,
8588 @option{-falign-functions=32} aligns functions to the next 32-byte
8589 boundary, but @option{-falign-functions=24} aligns to the next
8590 32-byte boundary only if this can be done by skipping 23 bytes or less.
8592 @option{-fno-align-functions} and @option{-falign-functions=1} are
8593 equivalent and mean that functions are not aligned.
8595 Some assemblers only support this flag when @var{n} is a power of two;
8596 in that case, it is rounded up.
8598 If @var{n} is not specified or is zero, use a machine-dependent default.
8600 Enabled at levels @option{-O2}, @option{-O3}.
8602 @item -flimit-function-alignment
8603 If this option is enabled, the compiler tries to avoid unnecessarily
8604 overaligning functions. It attempts to instruct the assembler to align
8605 by the amount specified by @option{-falign-functions}, but not to
8606 skip more bytes than the size of the function.
8608 @item -falign-labels
8609 @itemx -falign-labels=@var{n}
8610 @opindex falign-labels
8611 Align all branch targets to a power-of-two boundary, skipping up to
8612 @var{n} bytes like @option{-falign-functions}.  This option can easily
8613 make code slower, because it must insert dummy operations for when the
8614 branch target is reached in the usual flow of the code.
8616 @option{-fno-align-labels} and @option{-falign-labels=1} are
8617 equivalent and mean that labels are not aligned.
8619 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8620 are greater than this value, then their values are used instead.
8622 If @var{n} is not specified or is zero, use a machine-dependent default
8623 which is very likely to be @samp{1}, meaning no alignment.
8625 Enabled at levels @option{-O2}, @option{-O3}.
8627 @item -falign-loops
8628 @itemx -falign-loops=@var{n}
8629 @opindex falign-loops
8630 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8631 like @option{-falign-functions}.  If the loops are
8632 executed many times, this makes up for any execution of the dummy
8633 operations.
8635 @option{-fno-align-loops} and @option{-falign-loops=1} are
8636 equivalent and mean that loops are not aligned.
8638 If @var{n} is not specified or is zero, use a machine-dependent default.
8640 Enabled at levels @option{-O2}, @option{-O3}.
8642 @item -falign-jumps
8643 @itemx -falign-jumps=@var{n}
8644 @opindex falign-jumps
8645 Align branch targets to a power-of-two boundary, for branch targets
8646 where the targets can only be reached by jumping, skipping up to @var{n}
8647 bytes like @option{-falign-functions}.  In this case, no dummy operations
8648 need be executed.
8650 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8651 equivalent and mean that loops are not aligned.
8653 If @var{n} is not specified or is zero, use a machine-dependent default.
8655 Enabled at levels @option{-O2}, @option{-O3}.
8657 @item -funit-at-a-time
8658 @opindex funit-at-a-time
8659 This option is left for compatibility reasons. @option{-funit-at-a-time}
8660 has no effect, while @option{-fno-unit-at-a-time} implies
8661 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8663 Enabled by default.
8665 @item -fno-toplevel-reorder
8666 @opindex fno-toplevel-reorder
8667 Do not reorder top-level functions, variables, and @code{asm}
8668 statements.  Output them in the same order that they appear in the
8669 input file.  When this option is used, unreferenced static variables
8670 are not removed.  This option is intended to support existing code
8671 that relies on a particular ordering.  For new code, it is better to
8672 use attributes when possible.
8674 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8675 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8676 targets.
8678 @item -fweb
8679 @opindex fweb
8680 Constructs webs as commonly used for register allocation purposes and assign
8681 each web individual pseudo register.  This allows the register allocation pass
8682 to operate on pseudos directly, but also strengthens several other optimization
8683 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8684 however, make debugging impossible, since variables no longer stay in a
8685 ``home register''.
8687 Enabled by default with @option{-funroll-loops}.
8689 @item -fwhole-program
8690 @opindex fwhole-program
8691 Assume that the current compilation unit represents the whole program being
8692 compiled.  All public functions and variables with the exception of @code{main}
8693 and those merged by attribute @code{externally_visible} become static functions
8694 and in effect are optimized more aggressively by interprocedural optimizers.
8696 This option should not be used in combination with @option{-flto}.
8697 Instead relying on a linker plugin should provide safer and more precise
8698 information.
8700 @item -flto[=@var{n}]
8701 @opindex flto
8702 This option runs the standard link-time optimizer.  When invoked
8703 with source code, it generates GIMPLE (one of GCC's internal
8704 representations) and writes it to special ELF sections in the object
8705 file.  When the object files are linked together, all the function
8706 bodies are read from these ELF sections and instantiated as if they
8707 had been part of the same translation unit.
8709 To use the link-time optimizer, @option{-flto} and optimization
8710 options should be specified at compile time and during the final link.
8711 It is recommended that you compile all the files participating in the
8712 same link with the same options and also specify those options at
8713 link time.  
8714 For example:
8716 @smallexample
8717 gcc -c -O2 -flto foo.c
8718 gcc -c -O2 -flto bar.c
8719 gcc -o myprog -flto -O2 foo.o bar.o
8720 @end smallexample
8722 The first two invocations to GCC save a bytecode representation
8723 of GIMPLE into special ELF sections inside @file{foo.o} and
8724 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8725 @file{foo.o} and @file{bar.o}, merges the two files into a single
8726 internal image, and compiles the result as usual.  Since both
8727 @file{foo.o} and @file{bar.o} are merged into a single image, this
8728 causes all the interprocedural analyses and optimizations in GCC to
8729 work across the two files as if they were a single one.  This means,
8730 for example, that the inliner is able to inline functions in
8731 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8733 Another (simpler) way to enable link-time optimization is:
8735 @smallexample
8736 gcc -o myprog -flto -O2 foo.c bar.c
8737 @end smallexample
8739 The above generates bytecode for @file{foo.c} and @file{bar.c},
8740 merges them together into a single GIMPLE representation and optimizes
8741 them as usual to produce @file{myprog}.
8743 The only important thing to keep in mind is that to enable link-time
8744 optimizations you need to use the GCC driver to perform the link step.
8745 GCC then automatically performs link-time optimization if any of the
8746 objects involved were compiled with the @option{-flto} command-line option.  
8747 You generally
8748 should specify the optimization options to be used for link-time
8749 optimization though GCC tries to be clever at guessing an
8750 optimization level to use from the options used at compile time
8751 if you fail to specify one at link time.  You can always override
8752 the automatic decision to do link-time optimization at link time
8753 by passing @option{-fno-lto} to the link command.
8755 To make whole program optimization effective, it is necessary to make
8756 certain whole program assumptions.  The compiler needs to know
8757 what functions and variables can be accessed by libraries and runtime
8758 outside of the link-time optimized unit.  When supported by the linker,
8759 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8760 to the compiler about used and externally visible symbols.  When
8761 the linker plugin is not available, @option{-fwhole-program} should be
8762 used to allow the compiler to make these assumptions, which leads
8763 to more aggressive optimization decisions.
8765 When @option{-fuse-linker-plugin} is not enabled, when a file is
8766 compiled with @option{-flto}, the generated object file is larger than
8767 a regular object file because it contains GIMPLE bytecodes and the usual
8768 final code (see @option{-ffat-lto-objects}.  This means that
8769 object files with LTO information can be linked as normal object
8770 files; if @option{-fno-lto} is passed to the linker, no
8771 interprocedural optimizations are applied.  Note that when
8772 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8773 but you cannot perform a regular, non-LTO link on them.
8775 Additionally, the optimization flags used to compile individual files
8776 are not necessarily related to those used at link time.  For instance,
8778 @smallexample
8779 gcc -c -O0 -ffat-lto-objects -flto foo.c
8780 gcc -c -O0 -ffat-lto-objects -flto bar.c
8781 gcc -o myprog -O3 foo.o bar.o
8782 @end smallexample
8784 This produces individual object files with unoptimized assembler
8785 code, but the resulting binary @file{myprog} is optimized at
8786 @option{-O3}.  If, instead, the final binary is generated with
8787 @option{-fno-lto}, then @file{myprog} is not optimized.
8789 When producing the final binary, GCC only
8790 applies link-time optimizations to those files that contain bytecode.
8791 Therefore, you can mix and match object files and libraries with
8792 GIMPLE bytecodes and final object code.  GCC automatically selects
8793 which files to optimize in LTO mode and which files to link without
8794 further processing.
8796 There are some code generation flags preserved by GCC when
8797 generating bytecodes, as they need to be used during the final link
8798 stage.  Generally options specified at link time override those
8799 specified at compile time.
8801 If you do not specify an optimization level option @option{-O} at
8802 link time, then GCC uses the highest optimization level 
8803 used when compiling the object files.
8805 Currently, the following options and their settings are taken from
8806 the first object file that explicitly specifies them: 
8807 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8808 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8809 and all the @option{-m} target flags.
8811 Certain ABI-changing flags are required to match in all compilation units,
8812 and trying to override this at link time with a conflicting value
8813 is ignored.  This includes options such as @option{-freg-struct-return}
8814 and @option{-fpcc-struct-return}. 
8816 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8817 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8818 are passed through to the link stage and merged conservatively for
8819 conflicting translation units.  Specifically
8820 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8821 precedence; and for example @option{-ffp-contract=off} takes precedence
8822 over @option{-ffp-contract=fast}.  You can override them at link time.
8824 If LTO encounters objects with C linkage declared with incompatible
8825 types in separate translation units to be linked together (undefined
8826 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8827 issued.  The behavior is still undefined at run time.  Similar
8828 diagnostics may be raised for other languages.
8830 Another feature of LTO is that it is possible to apply interprocedural
8831 optimizations on files written in different languages:
8833 @smallexample
8834 gcc -c -flto foo.c
8835 g++ -c -flto bar.cc
8836 gfortran -c -flto baz.f90
8837 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8838 @end smallexample
8840 Notice that the final link is done with @command{g++} to get the C++
8841 runtime libraries and @option{-lgfortran} is added to get the Fortran
8842 runtime libraries.  In general, when mixing languages in LTO mode, you
8843 should use the same link command options as when mixing languages in a
8844 regular (non-LTO) compilation.
8846 If object files containing GIMPLE bytecode are stored in a library archive, say
8847 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8848 are using a linker with plugin support.  To create static libraries suitable
8849 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8850 and @command{ranlib}; 
8851 to show the symbols of object files with GIMPLE bytecode, use
8852 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8853 and @command{nm} have been compiled with plugin support.  At link time, use the the
8854 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8855 the LTO optimization process:
8857 @smallexample
8858 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8859 @end smallexample
8861 With the linker plugin enabled, the linker extracts the needed
8862 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8863 to make them part of the aggregated GIMPLE image to be optimized.
8865 If you are not using a linker with plugin support and/or do not
8866 enable the linker plugin, then the objects inside @file{libfoo.a}
8867 are extracted and linked as usual, but they do not participate
8868 in the LTO optimization process.  In order to make a static library suitable
8869 for both LTO optimization and usual linkage, compile its object files with
8870 @option{-flto} @option{-ffat-lto-objects}.
8872 Link-time optimizations do not require the presence of the whole program to
8873 operate.  If the program does not require any symbols to be exported, it is
8874 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8875 the interprocedural optimizers to use more aggressive assumptions which may
8876 lead to improved optimization opportunities.
8877 Use of @option{-fwhole-program} is not needed when linker plugin is
8878 active (see @option{-fuse-linker-plugin}).
8880 The current implementation of LTO makes no
8881 attempt to generate bytecode that is portable between different
8882 types of hosts.  The bytecode files are versioned and there is a
8883 strict version check, so bytecode files generated in one version of
8884 GCC do not work with an older or newer version of GCC.
8886 Link-time optimization does not work well with generation of debugging
8887 information.  Combining @option{-flto} with
8888 @option{-g} is currently experimental and expected to produce unexpected
8889 results.
8891 If you specify the optional @var{n}, the optimization and code
8892 generation done at link time is executed in parallel using @var{n}
8893 parallel jobs by utilizing an installed @command{make} program.  The
8894 environment variable @env{MAKE} may be used to override the program
8895 used.  The default value for @var{n} is 1.
8897 You can also specify @option{-flto=jobserver} to use GNU make's
8898 job server mode to determine the number of parallel jobs. This
8899 is useful when the Makefile calling GCC is already executing in parallel.
8900 You must prepend a @samp{+} to the command recipe in the parent Makefile
8901 for this to work.  This option likely only works if @env{MAKE} is
8902 GNU make.
8904 @item -flto-partition=@var{alg}
8905 @opindex flto-partition
8906 Specify the partitioning algorithm used by the link-time optimizer.
8907 The value is either @samp{1to1} to specify a partitioning mirroring
8908 the original source files or @samp{balanced} to specify partitioning
8909 into equally sized chunks (whenever possible) or @samp{max} to create
8910 new partition for every symbol where possible.  Specifying @samp{none}
8911 as an algorithm disables partitioning and streaming completely. 
8912 The default value is @samp{balanced}. While @samp{1to1} can be used
8913 as an workaround for various code ordering issues, the @samp{max}
8914 partitioning is intended for internal testing only.
8915 The value @samp{one} specifies that exactly one partition should be
8916 used while the value @samp{none} bypasses partitioning and executes
8917 the link-time optimization step directly from the WPA phase.
8919 @item -flto-odr-type-merging
8920 @opindex flto-odr-type-merging
8921 Enable streaming of mangled types names of C++ types and their unification
8922 at link time.  This increases size of LTO object files, but enables
8923 diagnostics about One Definition Rule violations.
8925 @item -flto-compression-level=@var{n}
8926 @opindex flto-compression-level
8927 This option specifies the level of compression used for intermediate
8928 language written to LTO object files, and is only meaningful in
8929 conjunction with LTO mode (@option{-flto}).  Valid
8930 values are 0 (no compression) to 9 (maximum compression).  Values
8931 outside this range are clamped to either 0 or 9.  If the option is not
8932 given, a default balanced compression setting is used.
8934 @item -fuse-linker-plugin
8935 @opindex fuse-linker-plugin
8936 Enables the use of a linker plugin during link-time optimization.  This
8937 option relies on plugin support in the linker, which is available in gold
8938 or in GNU ld 2.21 or newer.
8940 This option enables the extraction of object files with GIMPLE bytecode out
8941 of library archives. This improves the quality of optimization by exposing
8942 more code to the link-time optimizer.  This information specifies what
8943 symbols can be accessed externally (by non-LTO object or during dynamic
8944 linking).  Resulting code quality improvements on binaries (and shared
8945 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
8946 See @option{-flto} for a description of the effect of this flag and how to
8947 use it.
8949 This option is enabled by default when LTO support in GCC is enabled
8950 and GCC was configured for use with
8951 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8953 @item -ffat-lto-objects
8954 @opindex ffat-lto-objects
8955 Fat LTO objects are object files that contain both the intermediate language
8956 and the object code. This makes them usable for both LTO linking and normal
8957 linking. This option is effective only when compiling with @option{-flto}
8958 and is ignored at link time.
8960 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8961 requires the complete toolchain to be aware of LTO. It requires a linker with
8962 linker plugin support for basic functionality.  Additionally,
8963 @command{nm}, @command{ar} and @command{ranlib}
8964 need to support linker plugins to allow a full-featured build environment
8965 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8966 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8967 to these tools. With non fat LTO makefiles need to be modified to use them.
8969 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
8970 support.
8972 @item -fcompare-elim
8973 @opindex fcompare-elim
8974 After register allocation and post-register allocation instruction splitting,
8975 identify arithmetic instructions that compute processor flags similar to a
8976 comparison operation based on that arithmetic.  If possible, eliminate the
8977 explicit comparison operation.
8979 This pass only applies to certain targets that cannot explicitly represent
8980 the comparison operation before register allocation is complete.
8982 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8984 @item -fcprop-registers
8985 @opindex fcprop-registers
8986 After register allocation and post-register allocation instruction splitting,
8987 perform a copy-propagation pass to try to reduce scheduling dependencies
8988 and occasionally eliminate the copy.
8990 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8992 @item -fprofile-correction
8993 @opindex fprofile-correction
8994 Profiles collected using an instrumented binary for multi-threaded programs may
8995 be inconsistent due to missed counter updates. When this option is specified,
8996 GCC uses heuristics to correct or smooth out such inconsistencies. By
8997 default, GCC emits an error message when an inconsistent profile is detected.
8999 @item -fprofile-use
9000 @itemx -fprofile-use=@var{path}
9001 @opindex fprofile-use
9002 Enable profile feedback-directed optimizations, 
9003 and the following optimizations
9004 which are generally profitable only with profile feedback available:
9005 @option{-fbranch-probabilities}, @option{-fvpt},
9006 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9007 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9009 Before you can use this option, you must first generate profiling information.
9010 @xref{Instrumentation Options}, for information about the
9011 @option{-fprofile-generate} option.
9013 By default, GCC emits an error message if the feedback profiles do not
9014 match the source code.  This error can be turned into a warning by using
9015 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9016 code.
9018 If @var{path} is specified, GCC looks at the @var{path} to find
9019 the profile feedback data files. See @option{-fprofile-dir}.
9021 @item -fauto-profile
9022 @itemx -fauto-profile=@var{path}
9023 @opindex fauto-profile
9024 Enable sampling-based feedback-directed optimizations, 
9025 and the following optimizations
9026 which are generally profitable only with profile feedback available:
9027 @option{-fbranch-probabilities}, @option{-fvpt},
9028 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9029 @option{-ftree-vectorize},
9030 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9031 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9032 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9034 @var{path} is the name of a file containing AutoFDO profile information.
9035 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9037 Producing an AutoFDO profile data file requires running your program
9038 with the @command{perf} utility on a supported GNU/Linux target system.
9039 For more information, see @uref{https://perf.wiki.kernel.org/}.
9041 E.g.
9042 @smallexample
9043 perf record -e br_inst_retired:near_taken -b -o perf.data \
9044     -- your_program
9045 @end smallexample
9047 Then use the @command{create_gcov} tool to convert the raw profile data
9048 to a format that can be used by GCC.@  You must also supply the 
9049 unstripped binary for your program to this tool.  
9050 See @uref{https://github.com/google/autofdo}.
9052 E.g.
9053 @smallexample
9054 create_gcov --binary=your_program.unstripped --profile=perf.data \
9055     --gcov=profile.afdo
9056 @end smallexample
9057 @end table
9059 The following options control compiler behavior regarding floating-point 
9060 arithmetic.  These options trade off between speed and
9061 correctness.  All must be specifically enabled.
9063 @table @gcctabopt
9064 @item -ffloat-store
9065 @opindex ffloat-store
9066 Do not store floating-point variables in registers, and inhibit other
9067 options that might change whether a floating-point value is taken from a
9068 register or memory.
9070 @cindex floating-point precision
9071 This option prevents undesirable excess precision on machines such as
9072 the 68000 where the floating registers (of the 68881) keep more
9073 precision than a @code{double} is supposed to have.  Similarly for the
9074 x86 architecture.  For most programs, the excess precision does only
9075 good, but a few programs rely on the precise definition of IEEE floating
9076 point.  Use @option{-ffloat-store} for such programs, after modifying
9077 them to store all pertinent intermediate computations into variables.
9079 @item -fexcess-precision=@var{style}
9080 @opindex fexcess-precision
9081 This option allows further control over excess precision on machines
9082 where floating-point operations occur in a format with more precision or
9083 range than the IEEE standard and interchange floating-point types.  By
9084 default, @option{-fexcess-precision=fast} is in effect; this means that
9085 operations may be carried out in a wider precision than the types specified
9086 in the source if that would result in faster code, and it is unpredictable
9087 when rounding to the types specified in the source code takes place.
9088 When compiling C, if @option{-fexcess-precision=standard} is specified then
9089 excess precision follows the rules specified in ISO C99; in particular,
9090 both casts and assignments cause values to be rounded to their
9091 semantic types (whereas @option{-ffloat-store} only affects
9092 assignments).  This option is enabled by default for C if a strict
9093 conformance option such as @option{-std=c99} is used.
9094 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9095 regardless of whether a strict conformance option is used.
9097 @opindex mfpmath
9098 @option{-fexcess-precision=standard} is not implemented for languages
9099 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9100 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9101 semantics apply without excess precision, and in the latter, rounding
9102 is unpredictable.
9104 @item -ffast-math
9105 @opindex ffast-math
9106 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9107 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9108 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9109 @option{-fexcess-precision=fast}.
9111 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9113 This option is not turned on by any @option{-O} option besides
9114 @option{-Ofast} since it can result in incorrect output for programs
9115 that depend on an exact implementation of IEEE or ISO rules/specifications
9116 for math functions. It may, however, yield faster code for programs
9117 that do not require the guarantees of these specifications.
9119 @item -fno-math-errno
9120 @opindex fno-math-errno
9121 Do not set @code{errno} after calling math functions that are executed
9122 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9123 IEEE exceptions for math error handling may want to use this flag
9124 for speed while maintaining IEEE arithmetic compatibility.
9126 This option is not turned on by any @option{-O} option since
9127 it can result in incorrect output for programs that depend on
9128 an exact implementation of IEEE or ISO rules/specifications for
9129 math functions. It may, however, yield faster code for programs
9130 that do not require the guarantees of these specifications.
9132 The default is @option{-fmath-errno}.
9134 On Darwin systems, the math library never sets @code{errno}.  There is
9135 therefore no reason for the compiler to consider the possibility that
9136 it might, and @option{-fno-math-errno} is the default.
9138 @item -funsafe-math-optimizations
9139 @opindex funsafe-math-optimizations
9141 Allow optimizations for floating-point arithmetic that (a) assume
9142 that arguments and results are valid and (b) may violate IEEE or
9143 ANSI standards.  When used at link time, it may include libraries
9144 or startup files that change the default FPU control word or other
9145 similar optimizations.
9147 This option is not turned on by any @option{-O} option since
9148 it can result in incorrect output for programs that depend on
9149 an exact implementation of IEEE or ISO rules/specifications for
9150 math functions. It may, however, yield faster code for programs
9151 that do not require the guarantees of these specifications.
9152 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9153 @option{-fassociative-math} and @option{-freciprocal-math}.
9155 The default is @option{-fno-unsafe-math-optimizations}.
9157 @item -fassociative-math
9158 @opindex fassociative-math
9160 Allow re-association of operands in series of floating-point operations.
9161 This violates the ISO C and C++ language standard by possibly changing
9162 computation result.  NOTE: re-ordering may change the sign of zero as
9163 well as ignore NaNs and inhibit or create underflow or overflow (and
9164 thus cannot be used on code that relies on rounding behavior like
9165 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9166 and thus may not be used when ordered comparisons are required.
9167 This option requires that both @option{-fno-signed-zeros} and
9168 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9169 much sense with @option{-frounding-math}. For Fortran the option
9170 is automatically enabled when both @option{-fno-signed-zeros} and
9171 @option{-fno-trapping-math} are in effect.
9173 The default is @option{-fno-associative-math}.
9175 @item -freciprocal-math
9176 @opindex freciprocal-math
9178 Allow the reciprocal of a value to be used instead of dividing by
9179 the value if this enables optimizations.  For example @code{x / y}
9180 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9181 is subject to common subexpression elimination.  Note that this loses
9182 precision and increases the number of flops operating on the value.
9184 The default is @option{-fno-reciprocal-math}.
9186 @item -ffinite-math-only
9187 @opindex ffinite-math-only
9188 Allow optimizations for floating-point arithmetic that assume
9189 that arguments and results are not NaNs or +-Infs.
9191 This option is not turned on by any @option{-O} option since
9192 it can result in incorrect output for programs that depend on
9193 an exact implementation of IEEE or ISO rules/specifications for
9194 math functions. It may, however, yield faster code for programs
9195 that do not require the guarantees of these specifications.
9197 The default is @option{-fno-finite-math-only}.
9199 @item -fno-signed-zeros
9200 @opindex fno-signed-zeros
9201 Allow optimizations for floating-point arithmetic that ignore the
9202 signedness of zero.  IEEE arithmetic specifies the behavior of
9203 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9204 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9205 This option implies that the sign of a zero result isn't significant.
9207 The default is @option{-fsigned-zeros}.
9209 @item -fno-trapping-math
9210 @opindex fno-trapping-math
9211 Compile code assuming that floating-point operations cannot generate
9212 user-visible traps.  These traps include division by zero, overflow,
9213 underflow, inexact result and invalid operation.  This option requires
9214 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9215 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9217 This option should never be turned on by any @option{-O} option since
9218 it can result in incorrect output for programs that depend on
9219 an exact implementation of IEEE or ISO rules/specifications for
9220 math functions.
9222 The default is @option{-ftrapping-math}.
9224 @item -frounding-math
9225 @opindex frounding-math
9226 Disable transformations and optimizations that assume default floating-point
9227 rounding behavior.  This is round-to-zero for all floating point
9228 to integer conversions, and round-to-nearest for all other arithmetic
9229 truncations.  This option should be specified for programs that change
9230 the FP rounding mode dynamically, or that may be executed with a
9231 non-default rounding mode.  This option disables constant folding of
9232 floating-point expressions at compile time (which may be affected by
9233 rounding mode) and arithmetic transformations that are unsafe in the
9234 presence of sign-dependent rounding modes.
9236 The default is @option{-fno-rounding-math}.
9238 This option is experimental and does not currently guarantee to
9239 disable all GCC optimizations that are affected by rounding mode.
9240 Future versions of GCC may provide finer control of this setting
9241 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9242 will be used to specify the default state for @code{FENV_ACCESS}.
9244 @item -fsignaling-nans
9245 @opindex fsignaling-nans
9246 Compile code assuming that IEEE signaling NaNs may generate user-visible
9247 traps during floating-point operations.  Setting this option disables
9248 optimizations that may change the number of exceptions visible with
9249 signaling NaNs.  This option implies @option{-ftrapping-math}.
9251 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9252 be defined.
9254 The default is @option{-fno-signaling-nans}.
9256 This option is experimental and does not currently guarantee to
9257 disable all GCC optimizations that affect signaling NaN behavior.
9259 @item -fno-fp-int-builtin-inexact
9260 @opindex fno-fp-int-builtin-inexact
9261 Do not allow the built-in functions @code{ceil}, @code{floor},
9262 @code{round} and @code{trunc}, and their @code{float} and @code{long
9263 double} variants, to generate code that raises the ``inexact''
9264 floating-point exception for noninteger arguments.  ISO C99 and C11
9265 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9266 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9267 functions to do so.
9269 The default is @option{-ffp-int-builtin-inexact}, allowing the
9270 exception to be raised.  This option does nothing unless
9271 @option{-ftrapping-math} is in effect.
9273 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9274 generate a call to a library function then the ``inexact'' exception
9275 may be raised if the library implementation does not follow TS 18661.
9277 @item -fsingle-precision-constant
9278 @opindex fsingle-precision-constant
9279 Treat floating-point constants as single precision instead of
9280 implicitly converting them to double-precision constants.
9282 @item -fcx-limited-range
9283 @opindex fcx-limited-range
9284 When enabled, this option states that a range reduction step is not
9285 needed when performing complex division.  Also, there is no checking
9286 whether the result of a complex multiplication or division is @code{NaN
9287 + I*NaN}, with an attempt to rescue the situation in that case.  The
9288 default is @option{-fno-cx-limited-range}, but is enabled by
9289 @option{-ffast-math}.
9291 This option controls the default setting of the ISO C99
9292 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9293 all languages.
9295 @item -fcx-fortran-rules
9296 @opindex fcx-fortran-rules
9297 Complex multiplication and division follow Fortran rules.  Range
9298 reduction is done as part of complex division, but there is no checking
9299 whether the result of a complex multiplication or division is @code{NaN
9300 + I*NaN}, with an attempt to rescue the situation in that case.
9302 The default is @option{-fno-cx-fortran-rules}.
9304 @end table
9306 The following options control optimizations that may improve
9307 performance, but are not enabled by any @option{-O} options.  This
9308 section includes experimental options that may produce broken code.
9310 @table @gcctabopt
9311 @item -fbranch-probabilities
9312 @opindex fbranch-probabilities
9313 After running a program compiled with @option{-fprofile-arcs}
9314 (@pxref{Instrumentation Options}),
9315 you can compile it a second time using
9316 @option{-fbranch-probabilities}, to improve optimizations based on
9317 the number of times each branch was taken.  When a program
9318 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9319 counts to a file called @file{@var{sourcename}.gcda} for each source
9320 file.  The information in this data file is very dependent on the
9321 structure of the generated code, so you must use the same source code
9322 and the same optimization options for both compilations.
9324 With @option{-fbranch-probabilities}, GCC puts a
9325 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9326 These can be used to improve optimization.  Currently, they are only
9327 used in one place: in @file{reorg.c}, instead of guessing which path a
9328 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9329 exactly determine which path is taken more often.
9331 @item -fprofile-values
9332 @opindex fprofile-values
9333 If combined with @option{-fprofile-arcs}, it adds code so that some
9334 data about values of expressions in the program is gathered.
9336 With @option{-fbranch-probabilities}, it reads back the data gathered
9337 from profiling values of expressions for usage in optimizations.
9339 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9341 @item -fprofile-reorder-functions
9342 @opindex fprofile-reorder-functions
9343 Function reordering based on profile instrumentation collects
9344 first time of execution of a function and orders these functions
9345 in ascending order.
9347 Enabled with @option{-fprofile-use}.
9349 @item -fvpt
9350 @opindex fvpt
9351 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9352 to add code to gather information about values of expressions.
9354 With @option{-fbranch-probabilities}, it reads back the data gathered
9355 and actually performs the optimizations based on them.
9356 Currently the optimizations include specialization of division operations
9357 using the knowledge about the value of the denominator.
9359 @item -frename-registers
9360 @opindex frename-registers
9361 Attempt to avoid false dependencies in scheduled code by making use
9362 of registers left over after register allocation.  This optimization
9363 most benefits processors with lots of registers.  Depending on the
9364 debug information format adopted by the target, however, it can
9365 make debugging impossible, since variables no longer stay in
9366 a ``home register''.
9368 Enabled by default with @option{-funroll-loops}.
9370 @item -fschedule-fusion
9371 @opindex fschedule-fusion
9372 Performs a target dependent pass over the instruction stream to schedule
9373 instructions of same type together because target machine can execute them
9374 more efficiently if they are adjacent to each other in the instruction flow.
9376 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9378 @item -ftracer
9379 @opindex ftracer
9380 Perform tail duplication to enlarge superblock size.  This transformation
9381 simplifies the control flow of the function allowing other optimizations to do
9382 a better job.
9384 Enabled with @option{-fprofile-use}.
9386 @item -funroll-loops
9387 @opindex funroll-loops
9388 Unroll loops whose number of iterations can be determined at compile time or
9389 upon entry to the loop.  @option{-funroll-loops} implies
9390 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9391 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9392 a small constant number of iterations).  This option makes code larger, and may
9393 or may not make it run faster.
9395 Enabled with @option{-fprofile-use}.
9397 @item -funroll-all-loops
9398 @opindex funroll-all-loops
9399 Unroll all loops, even if their number of iterations is uncertain when
9400 the loop is entered.  This usually makes programs run more slowly.
9401 @option{-funroll-all-loops} implies the same options as
9402 @option{-funroll-loops}.
9404 @item -fpeel-loops
9405 @opindex fpeel-loops
9406 Peels loops for which there is enough information that they do not
9407 roll much (from profile feedback or static analysis).  It also turns on
9408 complete loop peeling (i.e.@: complete removal of loops with small constant
9409 number of iterations).
9411 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9413 @item -fmove-loop-invariants
9414 @opindex fmove-loop-invariants
9415 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9416 at level @option{-O1}
9418 @item -fsplit-loops
9419 @opindex fsplit-loops
9420 Split a loop into two if it contains a condition that's always true
9421 for one side of the iteration space and false for the other.
9423 @item -funswitch-loops
9424 @opindex funswitch-loops
9425 Move branches with loop invariant conditions out of the loop, with duplicates
9426 of the loop on both branches (modified according to result of the condition).
9428 @item -ffunction-sections
9429 @itemx -fdata-sections
9430 @opindex ffunction-sections
9431 @opindex fdata-sections
9432 Place each function or data item into its own section in the output
9433 file if the target supports arbitrary sections.  The name of the
9434 function or the name of the data item determines the section's name
9435 in the output file.
9437 Use these options on systems where the linker can perform optimizations
9438 to improve locality of reference in the instruction space.  Most systems
9439 using the ELF object format and SPARC processors running Solaris 2 have
9440 linkers with such optimizations.  AIX may have these optimizations in
9441 the future.
9443 Only use these options when there are significant benefits from doing
9444 so.  When you specify these options, the assembler and linker
9445 create larger object and executable files and are also slower.
9446 You cannot use @command{gprof} on all systems if you
9447 specify this option, and you may have problems with debugging if
9448 you specify both this option and @option{-g}.
9450 @item -fbranch-target-load-optimize
9451 @opindex fbranch-target-load-optimize
9452 Perform branch target register load optimization before prologue / epilogue
9453 threading.
9454 The use of target registers can typically be exposed only during reload,
9455 thus hoisting loads out of loops and doing inter-block scheduling needs
9456 a separate optimization pass.
9458 @item -fbranch-target-load-optimize2
9459 @opindex fbranch-target-load-optimize2
9460 Perform branch target register load optimization after prologue / epilogue
9461 threading.
9463 @item -fbtr-bb-exclusive
9464 @opindex fbtr-bb-exclusive
9465 When performing branch target register load optimization, don't reuse
9466 branch target registers within any basic block.
9468 @item -fstdarg-opt
9469 @opindex fstdarg-opt
9470 Optimize the prologue of variadic argument functions with respect to usage of
9471 those arguments.
9473 @item -fsection-anchors
9474 @opindex fsection-anchors
9475 Try to reduce the number of symbolic address calculations by using
9476 shared ``anchor'' symbols to address nearby objects.  This transformation
9477 can help to reduce the number of GOT entries and GOT accesses on some
9478 targets.
9480 For example, the implementation of the following function @code{foo}:
9482 @smallexample
9483 static int a, b, c;
9484 int foo (void) @{ return a + b + c; @}
9485 @end smallexample
9487 @noindent
9488 usually calculates the addresses of all three variables, but if you
9489 compile it with @option{-fsection-anchors}, it accesses the variables
9490 from a common anchor point instead.  The effect is similar to the
9491 following pseudocode (which isn't valid C):
9493 @smallexample
9494 int foo (void)
9496   register int *xr = &x;
9497   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9499 @end smallexample
9501 Not all targets support this option.
9503 @item --param @var{name}=@var{value}
9504 @opindex param
9505 In some places, GCC uses various constants to control the amount of
9506 optimization that is done.  For example, GCC does not inline functions
9507 that contain more than a certain number of instructions.  You can
9508 control some of these constants on the command line using the
9509 @option{--param} option.
9511 The names of specific parameters, and the meaning of the values, are
9512 tied to the internals of the compiler, and are subject to change
9513 without notice in future releases.
9515 In each case, the @var{value} is an integer.  The allowable choices for
9516 @var{name} are:
9518 @table @gcctabopt
9519 @item predictable-branch-outcome
9520 When branch is predicted to be taken with probability lower than this threshold
9521 (in percent), then it is considered well predictable. The default is 10.
9523 @item max-rtl-if-conversion-insns
9524 RTL if-conversion tries to remove conditional branches around a block and
9525 replace them with conditionally executed instructions.  This parameter
9526 gives the maximum number of instructions in a block which should be
9527 considered for if-conversion.  The default is 10, though the compiler will
9528 also use other heuristics to decide whether if-conversion is likely to be
9529 profitable.
9531 @item max-rtl-if-conversion-predictable-cost
9532 @item max-rtl-if-conversion-unpredictable-cost
9533 RTL if-conversion will try to remove conditional branches around a block
9534 and replace them with conditionally executed instructions.  These parameters
9535 give the maximum permissible cost for the sequence that would be generated
9536 by if-conversion depending on whether the branch is statically determined
9537 to be predictable or not.  The units for this parameter are the same as
9538 those for the GCC internal seq_cost metric.  The compiler will try to
9539 provide a reasonable default for this parameter using the BRANCH_COST
9540 target macro.
9542 @item max-crossjump-edges
9543 The maximum number of incoming edges to consider for cross-jumping.
9544 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9545 the number of edges incoming to each block.  Increasing values mean
9546 more aggressive optimization, making the compilation time increase with
9547 probably small improvement in executable size.
9549 @item min-crossjump-insns
9550 The minimum number of instructions that must be matched at the end
9551 of two blocks before cross-jumping is performed on them.  This
9552 value is ignored in the case where all instructions in the block being
9553 cross-jumped from are matched.  The default value is 5.
9555 @item max-grow-copy-bb-insns
9556 The maximum code size expansion factor when copying basic blocks
9557 instead of jumping.  The expansion is relative to a jump instruction.
9558 The default value is 8.
9560 @item max-goto-duplication-insns
9561 The maximum number of instructions to duplicate to a block that jumps
9562 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9563 passes, GCC factors computed gotos early in the compilation process,
9564 and unfactors them as late as possible.  Only computed jumps at the
9565 end of a basic blocks with no more than max-goto-duplication-insns are
9566 unfactored.  The default value is 8.
9568 @item max-delay-slot-insn-search
9569 The maximum number of instructions to consider when looking for an
9570 instruction to fill a delay slot.  If more than this arbitrary number of
9571 instructions are searched, the time savings from filling the delay slot
9572 are minimal, so stop searching.  Increasing values mean more
9573 aggressive optimization, making the compilation time increase with probably
9574 small improvement in execution time.
9576 @item max-delay-slot-live-search
9577 When trying to fill delay slots, the maximum number of instructions to
9578 consider when searching for a block with valid live register
9579 information.  Increasing this arbitrarily chosen value means more
9580 aggressive optimization, increasing the compilation time.  This parameter
9581 should be removed when the delay slot code is rewritten to maintain the
9582 control-flow graph.
9584 @item max-gcse-memory
9585 The approximate maximum amount of memory that can be allocated in
9586 order to perform the global common subexpression elimination
9587 optimization.  If more memory than specified is required, the
9588 optimization is not done.
9590 @item max-gcse-insertion-ratio
9591 If the ratio of expression insertions to deletions is larger than this value
9592 for any expression, then RTL PRE inserts or removes the expression and thus
9593 leaves partially redundant computations in the instruction stream.  The default value is 20.
9595 @item max-pending-list-length
9596 The maximum number of pending dependencies scheduling allows
9597 before flushing the current state and starting over.  Large functions
9598 with few branches or calls can create excessively large lists which
9599 needlessly consume memory and resources.
9601 @item max-modulo-backtrack-attempts
9602 The maximum number of backtrack attempts the scheduler should make
9603 when modulo scheduling a loop.  Larger values can exponentially increase
9604 compilation time.
9606 @item max-inline-insns-single
9607 Several parameters control the tree inliner used in GCC@.
9608 This number sets the maximum number of instructions (counted in GCC's
9609 internal representation) in a single function that the tree inliner
9610 considers for inlining.  This only affects functions declared
9611 inline and methods implemented in a class declaration (C++).
9612 The default value is 400.
9614 @item max-inline-insns-auto
9615 When you use @option{-finline-functions} (included in @option{-O3}),
9616 a lot of functions that would otherwise not be considered for inlining
9617 by the compiler are investigated.  To those functions, a different
9618 (more restrictive) limit compared to functions declared inline can
9619 be applied.
9620 The default value is 40.
9622 @item inline-min-speedup
9623 When estimated performance improvement of caller + callee runtime exceeds this
9624 threshold (in precent), the function can be inlined regardless the limit on
9625 @option{--param max-inline-insns-single} and @option{--param
9626 max-inline-insns-auto}.
9628 @item large-function-insns
9629 The limit specifying really large functions.  For functions larger than this
9630 limit after inlining, inlining is constrained by
9631 @option{--param large-function-growth}.  This parameter is useful primarily
9632 to avoid extreme compilation time caused by non-linear algorithms used by the
9633 back end.
9634 The default value is 2700.
9636 @item large-function-growth
9637 Specifies maximal growth of large function caused by inlining in percents.
9638 The default value is 100 which limits large function growth to 2.0 times
9639 the original size.
9641 @item large-unit-insns
9642 The limit specifying large translation unit.  Growth caused by inlining of
9643 units larger than this limit is limited by @option{--param inline-unit-growth}.
9644 For small units this might be too tight.
9645 For example, consider a unit consisting of function A
9646 that is inline and B that just calls A three times.  If B is small relative to
9647 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9648 large units consisting of small inlineable functions, however, the overall unit
9649 growth limit is needed to avoid exponential explosion of code size.  Thus for
9650 smaller units, the size is increased to @option{--param large-unit-insns}
9651 before applying @option{--param inline-unit-growth}.  The default is 10000.
9653 @item inline-unit-growth
9654 Specifies maximal overall growth of the compilation unit caused by inlining.
9655 The default value is 20 which limits unit growth to 1.2 times the original
9656 size. Cold functions (either marked cold via an attribute or by profile
9657 feedback) are not accounted into the unit size.
9659 @item ipcp-unit-growth
9660 Specifies maximal overall growth of the compilation unit caused by
9661 interprocedural constant propagation.  The default value is 10 which limits
9662 unit growth to 1.1 times the original size.
9664 @item large-stack-frame
9665 The limit specifying large stack frames.  While inlining the algorithm is trying
9666 to not grow past this limit too much.  The default value is 256 bytes.
9668 @item large-stack-frame-growth
9669 Specifies maximal growth of large stack frames caused by inlining in percents.
9670 The default value is 1000 which limits large stack frame growth to 11 times
9671 the original size.
9673 @item max-inline-insns-recursive
9674 @itemx max-inline-insns-recursive-auto
9675 Specifies the maximum number of instructions an out-of-line copy of a
9676 self-recursive inline
9677 function can grow into by performing recursive inlining.
9679 @option{--param max-inline-insns-recursive} applies to functions
9680 declared inline.
9681 For functions not declared inline, recursive inlining
9682 happens only when @option{-finline-functions} (included in @option{-O3}) is
9683 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9684 default value is 450.
9686 @item max-inline-recursive-depth
9687 @itemx max-inline-recursive-depth-auto
9688 Specifies the maximum recursion depth used for recursive inlining.
9690 @option{--param max-inline-recursive-depth} applies to functions
9691 declared inline.  For functions not declared inline, recursive inlining
9692 happens only when @option{-finline-functions} (included in @option{-O3}) is
9693 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9694 default value is 8.
9696 @item min-inline-recursive-probability
9697 Recursive inlining is profitable only for function having deep recursion
9698 in average and can hurt for function having little recursion depth by
9699 increasing the prologue size or complexity of function body to other
9700 optimizers.
9702 When profile feedback is available (see @option{-fprofile-generate}) the actual
9703 recursion depth can be guessed from the probability that function recurses
9704 via a given call expression.  This parameter limits inlining only to call
9705 expressions whose probability exceeds the given threshold (in percents).
9706 The default value is 10.
9708 @item early-inlining-insns
9709 Specify growth that the early inliner can make.  In effect it increases
9710 the amount of inlining for code having a large abstraction penalty.
9711 The default value is 14.
9713 @item max-early-inliner-iterations
9714 Limit of iterations of the early inliner.  This basically bounds
9715 the number of nested indirect calls the early inliner can resolve.
9716 Deeper chains are still handled by late inlining.
9718 @item comdat-sharing-probability
9719 Probability (in percent) that C++ inline function with comdat visibility
9720 are shared across multiple compilation units.  The default value is 20.
9722 @item profile-func-internal-id
9723 A parameter to control whether to use function internal id in profile
9724 database lookup. If the value is 0, the compiler uses an id that
9725 is based on function assembler name and filename, which makes old profile
9726 data more tolerant to source changes such as function reordering etc.
9727 The default value is 0.
9729 @item min-vect-loop-bound
9730 The minimum number of iterations under which loops are not vectorized
9731 when @option{-ftree-vectorize} is used.  The number of iterations after
9732 vectorization needs to be greater than the value specified by this option
9733 to allow vectorization.  The default value is 0.
9735 @item gcse-cost-distance-ratio
9736 Scaling factor in calculation of maximum distance an expression
9737 can be moved by GCSE optimizations.  This is currently supported only in the
9738 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9739 is with simple expressions, i.e., the expressions that have cost
9740 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9741 hoisting of simple expressions.  The default value is 10.
9743 @item gcse-unrestricted-cost
9744 Cost, roughly measured as the cost of a single typical machine
9745 instruction, at which GCSE optimizations do not constrain
9746 the distance an expression can travel.  This is currently
9747 supported only in the code hoisting pass.  The lesser the cost,
9748 the more aggressive code hoisting is.  Specifying 0 
9749 allows all expressions to travel unrestricted distances.
9750 The default value is 3.
9752 @item max-hoist-depth
9753 The depth of search in the dominator tree for expressions to hoist.
9754 This is used to avoid quadratic behavior in hoisting algorithm.
9755 The value of 0 does not limit on the search, but may slow down compilation
9756 of huge functions.  The default value is 30.
9758 @item max-tail-merge-comparisons
9759 The maximum amount of similar bbs to compare a bb with.  This is used to
9760 avoid quadratic behavior in tree tail merging.  The default value is 10.
9762 @item max-tail-merge-iterations
9763 The maximum amount of iterations of the pass over the function.  This is used to
9764 limit compilation time in tree tail merging.  The default value is 2.
9766 @item store-merging-allow-unaligned
9767 Allow the store merging pass to introduce unaligned stores if it is legal to
9768 do so.  The default value is 1.
9770 @item max-stores-to-merge
9771 The maximum number of stores to attempt to merge into wider stores in the store
9772 merging pass.  The minimum value is 2 and the default is 64.
9774 @item max-unrolled-insns
9775 The maximum number of instructions that a loop may have to be unrolled.
9776 If a loop is unrolled, this parameter also determines how many times
9777 the loop code is unrolled.
9779 @item max-average-unrolled-insns
9780 The maximum number of instructions biased by probabilities of their execution
9781 that a loop may have to be unrolled.  If a loop is unrolled,
9782 this parameter also determines how many times the loop code is unrolled.
9784 @item max-unroll-times
9785 The maximum number of unrollings of a single loop.
9787 @item max-peeled-insns
9788 The maximum number of instructions that a loop may have to be peeled.
9789 If a loop is peeled, this parameter also determines how many times
9790 the loop code is peeled.
9792 @item max-peel-times
9793 The maximum number of peelings of a single loop.
9795 @item max-peel-branches
9796 The maximum number of branches on the hot path through the peeled sequence.
9798 @item max-completely-peeled-insns
9799 The maximum number of insns of a completely peeled loop.
9801 @item max-completely-peel-times
9802 The maximum number of iterations of a loop to be suitable for complete peeling.
9804 @item max-completely-peel-loop-nest-depth
9805 The maximum depth of a loop nest suitable for complete peeling.
9807 @item max-unswitch-insns
9808 The maximum number of insns of an unswitched loop.
9810 @item max-unswitch-level
9811 The maximum number of branches unswitched in a single loop.
9813 @item max-loop-headers-insns
9814 The maximum number of insns in loop header duplicated by he copy loop headers
9815 pass.
9817 @item lim-expensive
9818 The minimum cost of an expensive expression in the loop invariant motion.
9820 @item iv-consider-all-candidates-bound
9821 Bound on number of candidates for induction variables, below which
9822 all candidates are considered for each use in induction variable
9823 optimizations.  If there are more candidates than this,
9824 only the most relevant ones are considered to avoid quadratic time complexity.
9826 @item iv-max-considered-uses
9827 The induction variable optimizations give up on loops that contain more
9828 induction variable uses.
9830 @item iv-always-prune-cand-set-bound
9831 If the number of candidates in the set is smaller than this value,
9832 always try to remove unnecessary ivs from the set
9833 when adding a new one.
9835 @item avg-loop-niter
9836 Average number of iterations of a loop.
9838 @item scev-max-expr-size
9839 Bound on size of expressions used in the scalar evolutions analyzer.
9840 Large expressions slow the analyzer.
9842 @item scev-max-expr-complexity
9843 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9844 Complex expressions slow the analyzer.
9846 @item max-tree-if-conversion-phi-args
9847 Maximum number of arguments in a PHI supported by TREE if conversion
9848 unless the loop is marked with simd pragma.
9850 @item vect-max-version-for-alignment-checks
9851 The maximum number of run-time checks that can be performed when
9852 doing loop versioning for alignment in the vectorizer.
9854 @item vect-max-version-for-alias-checks
9855 The maximum number of run-time checks that can be performed when
9856 doing loop versioning for alias in the vectorizer.
9858 @item vect-max-peeling-for-alignment
9859 The maximum number of loop peels to enhance access alignment
9860 for vectorizer. Value -1 means no limit.
9862 @item max-iterations-to-track
9863 The maximum number of iterations of a loop the brute-force algorithm
9864 for analysis of the number of iterations of the loop tries to evaluate.
9866 @item hot-bb-count-ws-permille
9867 A basic block profile count is considered hot if it contributes to 
9868 the given permillage (i.e. 0...1000) of the entire profiled execution.
9870 @item hot-bb-frequency-fraction
9871 Select fraction of the entry block frequency of executions of basic block in
9872 function given basic block needs to have to be considered hot.
9874 @item max-predicted-iterations
9875 The maximum number of loop iterations we predict statically.  This is useful
9876 in cases where a function contains a single loop with known bound and
9877 another loop with unknown bound.
9878 The known number of iterations is predicted correctly, while
9879 the unknown number of iterations average to roughly 10.  This means that the
9880 loop without bounds appears artificially cold relative to the other one.
9882 @item builtin-expect-probability
9883 Control the probability of the expression having the specified value. This
9884 parameter takes a percentage (i.e. 0 ... 100) as input.
9885 The default probability of 90 is obtained empirically.
9887 @item align-threshold
9889 Select fraction of the maximal frequency of executions of a basic block in
9890 a function to align the basic block.
9892 @item align-loop-iterations
9894 A loop expected to iterate at least the selected number of iterations is
9895 aligned.
9897 @item tracer-dynamic-coverage
9898 @itemx tracer-dynamic-coverage-feedback
9900 This value is used to limit superblock formation once the given percentage of
9901 executed instructions is covered.  This limits unnecessary code size
9902 expansion.
9904 The @option{tracer-dynamic-coverage-feedback} parameter
9905 is used only when profile
9906 feedback is available.  The real profiles (as opposed to statically estimated
9907 ones) are much less balanced allowing the threshold to be larger value.
9909 @item tracer-max-code-growth
9910 Stop tail duplication once code growth has reached given percentage.  This is
9911 a rather artificial limit, as most of the duplicates are eliminated later in
9912 cross jumping, so it may be set to much higher values than is the desired code
9913 growth.
9915 @item tracer-min-branch-ratio
9917 Stop reverse growth when the reverse probability of best edge is less than this
9918 threshold (in percent).
9920 @item tracer-min-branch-probability
9921 @itemx tracer-min-branch-probability-feedback
9923 Stop forward growth if the best edge has probability lower than this
9924 threshold.
9926 Similarly to @option{tracer-dynamic-coverage} two parameters are
9927 provided.  @option{tracer-min-branch-probability-feedback} is used for
9928 compilation with profile feedback and @option{tracer-min-branch-probability}
9929 compilation without.  The value for compilation with profile feedback
9930 needs to be more conservative (higher) in order to make tracer
9931 effective.
9933 @item max-cse-path-length
9935 The maximum number of basic blocks on path that CSE considers.
9936 The default is 10.
9938 @item max-cse-insns
9939 The maximum number of instructions CSE processes before flushing.
9940 The default is 1000.
9942 @item ggc-min-expand
9944 GCC uses a garbage collector to manage its own memory allocation.  This
9945 parameter specifies the minimum percentage by which the garbage
9946 collector's heap should be allowed to expand between collections.
9947 Tuning this may improve compilation speed; it has no effect on code
9948 generation.
9950 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9951 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9952 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9953 GCC is not able to calculate RAM on a particular platform, the lower
9954 bound of 30% is used.  Setting this parameter and
9955 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9956 every opportunity.  This is extremely slow, but can be useful for
9957 debugging.
9959 @item ggc-min-heapsize
9961 Minimum size of the garbage collector's heap before it begins bothering
9962 to collect garbage.  The first collection occurs after the heap expands
9963 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9964 tuning this may improve compilation speed, and has no effect on code
9965 generation.
9967 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9968 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9969 with a lower bound of 4096 (four megabytes) and an upper bound of
9970 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9971 particular platform, the lower bound is used.  Setting this parameter
9972 very large effectively disables garbage collection.  Setting this
9973 parameter and @option{ggc-min-expand} to zero causes a full collection
9974 to occur at every opportunity.
9976 @item max-reload-search-insns
9977 The maximum number of instruction reload should look backward for equivalent
9978 register.  Increasing values mean more aggressive optimization, making the
9979 compilation time increase with probably slightly better performance.
9980 The default value is 100.
9982 @item max-cselib-memory-locations
9983 The maximum number of memory locations cselib should take into account.
9984 Increasing values mean more aggressive optimization, making the compilation time
9985 increase with probably slightly better performance.  The default value is 500.
9987 @item max-sched-ready-insns
9988 The maximum number of instructions ready to be issued the scheduler should
9989 consider at any given time during the first scheduling pass.  Increasing
9990 values mean more thorough searches, making the compilation time increase
9991 with probably little benefit.  The default value is 100.
9993 @item max-sched-region-blocks
9994 The maximum number of blocks in a region to be considered for
9995 interblock scheduling.  The default value is 10.
9997 @item max-pipeline-region-blocks
9998 The maximum number of blocks in a region to be considered for
9999 pipelining in the selective scheduler.  The default value is 15.
10001 @item max-sched-region-insns
10002 The maximum number of insns in a region to be considered for
10003 interblock scheduling.  The default value is 100.
10005 @item max-pipeline-region-insns
10006 The maximum number of insns in a region to be considered for
10007 pipelining in the selective scheduler.  The default value is 200.
10009 @item min-spec-prob
10010 The minimum probability (in percents) of reaching a source block
10011 for interblock speculative scheduling.  The default value is 40.
10013 @item max-sched-extend-regions-iters
10014 The maximum number of iterations through CFG to extend regions.
10015 A value of 0 (the default) disables region extensions.
10017 @item max-sched-insn-conflict-delay
10018 The maximum conflict delay for an insn to be considered for speculative motion.
10019 The default value is 3.
10021 @item sched-spec-prob-cutoff
10022 The minimal probability of speculation success (in percents), so that
10023 speculative insns are scheduled.
10024 The default value is 40.
10026 @item sched-state-edge-prob-cutoff
10027 The minimum probability an edge must have for the scheduler to save its
10028 state across it.
10029 The default value is 10.
10031 @item sched-mem-true-dep-cost
10032 Minimal distance (in CPU cycles) between store and load targeting same
10033 memory locations.  The default value is 1.
10035 @item selsched-max-lookahead
10036 The maximum size of the lookahead window of selective scheduling.  It is a
10037 depth of search for available instructions.
10038 The default value is 50.
10040 @item selsched-max-sched-times
10041 The maximum number of times that an instruction is scheduled during
10042 selective scheduling.  This is the limit on the number of iterations
10043 through which the instruction may be pipelined.  The default value is 2.
10045 @item selsched-insns-to-rename
10046 The maximum number of best instructions in the ready list that are considered
10047 for renaming in the selective scheduler.  The default value is 2.
10049 @item sms-min-sc
10050 The minimum value of stage count that swing modulo scheduler
10051 generates.  The default value is 2.
10053 @item max-last-value-rtl
10054 The maximum size measured as number of RTLs that can be recorded in an expression
10055 in combiner for a pseudo register as last known value of that register.  The default
10056 is 10000.
10058 @item max-combine-insns
10059 The maximum number of instructions the RTL combiner tries to combine.
10060 The default value is 2 at @option{-Og} and 4 otherwise.
10062 @item integer-share-limit
10063 Small integer constants can use a shared data structure, reducing the
10064 compiler's memory usage and increasing its speed.  This sets the maximum
10065 value of a shared integer constant.  The default value is 256.
10067 @item ssp-buffer-size
10068 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10069 protection when @option{-fstack-protection} is used.
10071 @item min-size-for-stack-sharing
10072 The minimum size of variables taking part in stack slot sharing when not
10073 optimizing. The default value is 32.
10075 @item max-jump-thread-duplication-stmts
10076 Maximum number of statements allowed in a block that needs to be
10077 duplicated when threading jumps.
10079 @item max-fields-for-field-sensitive
10080 Maximum number of fields in a structure treated in
10081 a field sensitive manner during pointer analysis.  The default is zero
10082 for @option{-O0} and @option{-O1},
10083 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10085 @item prefetch-latency
10086 Estimate on average number of instructions that are executed before
10087 prefetch finishes.  The distance prefetched ahead is proportional
10088 to this constant.  Increasing this number may also lead to less
10089 streams being prefetched (see @option{simultaneous-prefetches}).
10091 @item simultaneous-prefetches
10092 Maximum number of prefetches that can run at the same time.
10094 @item l1-cache-line-size
10095 The size of cache line in L1 cache, in bytes.
10097 @item l1-cache-size
10098 The size of L1 cache, in kilobytes.
10100 @item l2-cache-size
10101 The size of L2 cache, in kilobytes.
10103 @item min-insn-to-prefetch-ratio
10104 The minimum ratio between the number of instructions and the
10105 number of prefetches to enable prefetching in a loop.
10107 @item prefetch-min-insn-to-mem-ratio
10108 The minimum ratio between the number of instructions and the
10109 number of memory references to enable prefetching in a loop.
10111 @item use-canonical-types
10112 Whether the compiler should use the ``canonical'' type system.  By
10113 default, this should always be 1, which uses a more efficient internal
10114 mechanism for comparing types in C++ and Objective-C++.  However, if
10115 bugs in the canonical type system are causing compilation failures,
10116 set this value to 0 to disable canonical types.
10118 @item switch-conversion-max-branch-ratio
10119 Switch initialization conversion refuses to create arrays that are
10120 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10121 branches in the switch.
10123 @item max-partial-antic-length
10124 Maximum length of the partial antic set computed during the tree
10125 partial redundancy elimination optimization (@option{-ftree-pre}) when
10126 optimizing at @option{-O3} and above.  For some sorts of source code
10127 the enhanced partial redundancy elimination optimization can run away,
10128 consuming all of the memory available on the host machine.  This
10129 parameter sets a limit on the length of the sets that are computed,
10130 which prevents the runaway behavior.  Setting a value of 0 for
10131 this parameter allows an unlimited set length.
10133 @item sccvn-max-scc-size
10134 Maximum size of a strongly connected component (SCC) during SCCVN
10135 processing.  If this limit is hit, SCCVN processing for the whole
10136 function is not done and optimizations depending on it are
10137 disabled.  The default maximum SCC size is 10000.
10139 @item sccvn-max-alias-queries-per-access
10140 Maximum number of alias-oracle queries we perform when looking for
10141 redundancies for loads and stores.  If this limit is hit the search
10142 is aborted and the load or store is not considered redundant.  The
10143 number of queries is algorithmically limited to the number of
10144 stores on all paths from the load to the function entry.
10145 The default maximum number of queries is 1000.
10147 @item ira-max-loops-num
10148 IRA uses regional register allocation by default.  If a function
10149 contains more loops than the number given by this parameter, only at most
10150 the given number of the most frequently-executed loops form regions
10151 for regional register allocation.  The default value of the
10152 parameter is 100.
10154 @item ira-max-conflict-table-size 
10155 Although IRA uses a sophisticated algorithm to compress the conflict
10156 table, the table can still require excessive amounts of memory for
10157 huge functions.  If the conflict table for a function could be more
10158 than the size in MB given by this parameter, the register allocator
10159 instead uses a faster, simpler, and lower-quality
10160 algorithm that does not require building a pseudo-register conflict table.  
10161 The default value of the parameter is 2000.
10163 @item ira-loop-reserved-regs
10164 IRA can be used to evaluate more accurate register pressure in loops
10165 for decisions to move loop invariants (see @option{-O3}).  The number
10166 of available registers reserved for some other purposes is given
10167 by this parameter.  The default value of the parameter is 2, which is
10168 the minimal number of registers needed by typical instructions.
10169 This value is the best found from numerous experiments.
10171 @item lra-inheritance-ebb-probability-cutoff
10172 LRA tries to reuse values reloaded in registers in subsequent insns.
10173 This optimization is called inheritance.  EBB is used as a region to
10174 do this optimization.  The parameter defines a minimal fall-through
10175 edge probability in percentage used to add BB to inheritance EBB in
10176 LRA.  The default value of the parameter is 40.  The value was chosen
10177 from numerous runs of SPEC2000 on x86-64.
10179 @item loop-invariant-max-bbs-in-loop
10180 Loop invariant motion can be very expensive, both in compilation time and
10181 in amount of needed compile-time memory, with very large loops.  Loops
10182 with more basic blocks than this parameter won't have loop invariant
10183 motion optimization performed on them.  The default value of the
10184 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10186 @item loop-max-datarefs-for-datadeps
10187 Building data dependencies is expensive for very large loops.  This
10188 parameter limits the number of data references in loops that are
10189 considered for data dependence analysis.  These large loops are no
10190 handled by the optimizations using loop data dependencies.
10191 The default value is 1000.
10193 @item max-vartrack-size
10194 Sets a maximum number of hash table slots to use during variable
10195 tracking dataflow analysis of any function.  If this limit is exceeded
10196 with variable tracking at assignments enabled, analysis for that
10197 function is retried without it, after removing all debug insns from
10198 the function.  If the limit is exceeded even without debug insns, var
10199 tracking analysis is completely disabled for the function.  Setting
10200 the parameter to zero makes it unlimited.
10202 @item max-vartrack-expr-depth
10203 Sets a maximum number of recursion levels when attempting to map
10204 variable names or debug temporaries to value expressions.  This trades
10205 compilation time for more complete debug information.  If this is set too
10206 low, value expressions that are available and could be represented in
10207 debug information may end up not being used; setting this higher may
10208 enable the compiler to find more complex debug expressions, but compile
10209 time and memory use may grow.  The default is 12.
10211 @item min-nondebug-insn-uid
10212 Use uids starting at this parameter for nondebug insns.  The range below
10213 the parameter is reserved exclusively for debug insns created by
10214 @option{-fvar-tracking-assignments}, but debug insns may get
10215 (non-overlapping) uids above it if the reserved range is exhausted.
10217 @item ipa-sra-ptr-growth-factor
10218 IPA-SRA replaces a pointer to an aggregate with one or more new
10219 parameters only when their cumulative size is less or equal to
10220 @option{ipa-sra-ptr-growth-factor} times the size of the original
10221 pointer parameter.
10223 @item sra-max-scalarization-size-Ospeed
10224 @item sra-max-scalarization-size-Osize
10225 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10226 replace scalar parts of aggregates with uses of independent scalar
10227 variables.  These parameters control the maximum size, in storage units,
10228 of aggregate which is considered for replacement when compiling for
10229 speed
10230 (@option{sra-max-scalarization-size-Ospeed}) or size
10231 (@option{sra-max-scalarization-size-Osize}) respectively.
10233 @item tm-max-aggregate-size
10234 When making copies of thread-local variables in a transaction, this
10235 parameter specifies the size in bytes after which variables are
10236 saved with the logging functions as opposed to save/restore code
10237 sequence pairs.  This option only applies when using
10238 @option{-fgnu-tm}.
10240 @item graphite-max-nb-scop-params
10241 To avoid exponential effects in the Graphite loop transforms, the
10242 number of parameters in a Static Control Part (SCoP) is bounded.  The
10243 default value is 10 parameters.  A variable whose value is unknown at
10244 compilation time and defined outside a SCoP is a parameter of the SCoP.
10246 @item graphite-max-bbs-per-function
10247 To avoid exponential effects in the detection of SCoPs, the size of
10248 the functions analyzed by Graphite is bounded.  The default value is
10249 100 basic blocks.
10251 @item loop-block-tile-size
10252 Loop blocking or strip mining transforms, enabled with
10253 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10254 loop in the loop nest by a given number of iterations.  The strip
10255 length can be changed using the @option{loop-block-tile-size}
10256 parameter.  The default value is 51 iterations.
10258 @item loop-unroll-jam-size
10259 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10260 default value is 4.
10262 @item loop-unroll-jam-depth
10263 Specify the dimension to be unrolled (counting from the most inner loop)
10264 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10266 @item ipa-cp-value-list-size
10267 IPA-CP attempts to track all possible values and types passed to a function's
10268 parameter in order to propagate them and perform devirtualization.
10269 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10270 stores per one formal parameter of a function.
10272 @item ipa-cp-eval-threshold
10273 IPA-CP calculates its own score of cloning profitability heuristics
10274 and performs those cloning opportunities with scores that exceed
10275 @option{ipa-cp-eval-threshold}.
10277 @item ipa-cp-recursion-penalty
10278 Percentage penalty the recursive functions will receive when they
10279 are evaluated for cloning.
10281 @item ipa-cp-single-call-penalty
10282 Percentage penalty functions containg a single call to another
10283 function will receive when they are evaluated for cloning.
10286 @item ipa-max-agg-items
10287 IPA-CP is also capable to propagate a number of scalar values passed
10288 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10289 number of such values per one parameter.
10291 @item ipa-cp-loop-hint-bonus
10292 When IPA-CP determines that a cloning candidate would make the number
10293 of iterations of a loop known, it adds a bonus of
10294 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10295 the candidate.
10297 @item ipa-cp-array-index-hint-bonus
10298 When IPA-CP determines that a cloning candidate would make the index of
10299 an array access known, it adds a bonus of
10300 @option{ipa-cp-array-index-hint-bonus} to the profitability
10301 score of the candidate.
10303 @item ipa-max-aa-steps
10304 During its analysis of function bodies, IPA-CP employs alias analysis
10305 in order to track values pointed to by function parameters.  In order
10306 not spend too much time analyzing huge functions, it gives up and
10307 consider all memory clobbered after examining
10308 @option{ipa-max-aa-steps} statements modifying memory.
10310 @item lto-partitions
10311 Specify desired number of partitions produced during WHOPR compilation.
10312 The number of partitions should exceed the number of CPUs used for compilation.
10313 The default value is 32.
10315 @item lto-min-partition
10316 Size of minimal partition for WHOPR (in estimated instructions).
10317 This prevents expenses of splitting very small programs into too many
10318 partitions.
10320 @item lto-max-partition
10321 Size of max partition for WHOPR (in estimated instructions).
10322 to provide an upper bound for individual size of partition.
10323 Meant to be used only with balanced partitioning.
10325 @item cxx-max-namespaces-for-diagnostic-help
10326 The maximum number of namespaces to consult for suggestions when C++
10327 name lookup fails for an identifier.  The default is 1000.
10329 @item sink-frequency-threshold
10330 The maximum relative execution frequency (in percents) of the target block
10331 relative to a statement's original block to allow statement sinking of a
10332 statement.  Larger numbers result in more aggressive statement sinking.
10333 The default value is 75.  A small positive adjustment is applied for
10334 statements with memory operands as those are even more profitable so sink.
10336 @item max-stores-to-sink
10337 The maximum number of conditional store pairs that can be sunk.  Set to 0
10338 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10339 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10341 @item allow-store-data-races
10342 Allow optimizers to introduce new data races on stores.
10343 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10344 at optimization level @option{-Ofast}.
10346 @item case-values-threshold
10347 The smallest number of different values for which it is best to use a
10348 jump-table instead of a tree of conditional branches.  If the value is
10349 0, use the default for the machine.  The default is 0.
10351 @item tree-reassoc-width
10352 Set the maximum number of instructions executed in parallel in
10353 reassociated tree. This parameter overrides target dependent
10354 heuristics used by default if has non zero value.
10356 @item sched-pressure-algorithm
10357 Choose between the two available implementations of
10358 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10359 and is the more likely to prevent instructions from being reordered.
10360 Algorithm 2 was designed to be a compromise between the relatively
10361 conservative approach taken by algorithm 1 and the rather aggressive
10362 approach taken by the default scheduler.  It relies more heavily on
10363 having a regular register file and accurate register pressure classes.
10364 See @file{haifa-sched.c} in the GCC sources for more details.
10366 The default choice depends on the target.
10368 @item max-slsr-cand-scan
10369 Set the maximum number of existing candidates that are considered when
10370 seeking a basis for a new straight-line strength reduction candidate.
10372 @item asan-globals
10373 Enable buffer overflow detection for global objects.  This kind
10374 of protection is enabled by default if you are using
10375 @option{-fsanitize=address} option.
10376 To disable global objects protection use @option{--param asan-globals=0}.
10378 @item asan-stack
10379 Enable buffer overflow detection for stack objects.  This kind of
10380 protection is enabled by default when using @option{-fsanitize=address}.
10381 To disable stack protection use @option{--param asan-stack=0} option.
10383 @item asan-instrument-reads
10384 Enable buffer overflow detection for memory reads.  This kind of
10385 protection is enabled by default when using @option{-fsanitize=address}.
10386 To disable memory reads protection use
10387 @option{--param asan-instrument-reads=0}.
10389 @item asan-instrument-writes
10390 Enable buffer overflow detection for memory writes.  This kind of
10391 protection is enabled by default when using @option{-fsanitize=address}.
10392 To disable memory writes protection use
10393 @option{--param asan-instrument-writes=0} option.
10395 @item asan-memintrin
10396 Enable detection for built-in functions.  This kind of protection
10397 is enabled by default when using @option{-fsanitize=address}.
10398 To disable built-in functions protection use
10399 @option{--param asan-memintrin=0}.
10401 @item asan-use-after-return
10402 Enable detection of use-after-return.  This kind of protection
10403 is enabled by default when using @option{-fsanitize=address} option.
10404 To disable use-after-return detection use 
10405 @option{--param asan-use-after-return=0}.
10407 Note: The check is disabled by default at runtime.  To enable the check,
10408 you should set environment variable @env{ASAN_OPTIONS} to
10409 @code{detect_stack_use_after_return=1}.
10411 @item asan-instrumentation-with-call-threshold
10412 If number of memory accesses in function being instrumented
10413 is greater or equal to this number, use callbacks instead of inline checks.
10414 E.g. to disable inline code use
10415 @option{--param asan-instrumentation-with-call-threshold=0}.
10417 @item use-after-scope-direct-emission-threshold
10418 If size of a local variables in bytes is smaller of equal to this number,
10419 direct instruction emission is utilized to poison and unpoison local variables.
10421 @item chkp-max-ctor-size
10422 Static constructors generated by Pointer Bounds Checker may become very
10423 large and significantly increase compile time at optimization level
10424 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10425 in a single generated constructor.  Default value is 5000.
10427 @item max-fsm-thread-path-insns
10428 Maximum number of instructions to copy when duplicating blocks on a
10429 finite state automaton jump thread path.  The default is 100.
10431 @item max-fsm-thread-length
10432 Maximum number of basic blocks on a finite state automaton jump thread
10433 path.  The default is 10.
10435 @item max-fsm-thread-paths
10436 Maximum number of new jump thread paths to create for a finite state
10437 automaton.  The default is 50.
10439 @item parloops-chunk-size
10440 Chunk size of omp schedule for loops parallelized by parloops.  The default
10441 is 0.
10443 @item parloops-schedule
10444 Schedule type of omp schedule for loops parallelized by parloops (static,
10445 dynamic, guided, auto, runtime).  The default is static.
10447 @item max-ssa-name-query-depth
10448 Maximum depth of recursion when querying properties of SSA names in things
10449 like fold routines.  One level of recursion corresponds to following a
10450 use-def chain.
10452 @item hsa-gen-debug-stores
10453 Enable emission of special debug stores within HSA kernels which are
10454 then read and reported by libgomp plugin.  Generation of these stores
10455 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10456 enable it.
10458 @item max-speculative-devirt-maydefs
10459 The maximum number of may-defs we analyze when looking for a must-def
10460 specifying the dynamic type of an object that invokes a virtual call
10461 we may be able to devirtualize speculatively.
10463 @item max-vrp-switch-assertions
10464 The maximum number of assertions to add along the default edge of a switch
10465 statement during VRP.  The default is 10.
10466 @end table
10467 @end table
10469 @node Instrumentation Options
10470 @section Program Instrumentation Options
10471 @cindex instrumentation options
10472 @cindex program instrumentation options
10473 @cindex run-time error checking options
10474 @cindex profiling options
10475 @cindex options, program instrumentation
10476 @cindex options, run-time error checking
10477 @cindex options, profiling
10479 GCC supports a number of command-line options that control adding
10480 run-time instrumentation to the code it normally generates.  
10481 For example, one purpose of instrumentation is collect profiling
10482 statistics for use in finding program hot spots, code coverage
10483 analysis, or profile-guided optimizations.
10484 Another class of program instrumentation is adding run-time checking 
10485 to detect programming errors like invalid pointer
10486 dereferences or out-of-bounds array accesses, as well as deliberately
10487 hostile attacks such as stack smashing or C++ vtable hijacking.
10488 There is also a general hook which can be used to implement other
10489 forms of tracing or function-level instrumentation for debug or
10490 program analysis purposes.
10492 @table @gcctabopt
10493 @cindex @command{prof}
10494 @item -p
10495 @opindex p
10496 Generate extra code to write profile information suitable for the
10497 analysis program @command{prof}.  You must use this option when compiling
10498 the source files you want data about, and you must also use it when
10499 linking.
10501 @cindex @command{gprof}
10502 @item -pg
10503 @opindex pg
10504 Generate extra code to write profile information suitable for the
10505 analysis program @command{gprof}.  You must use this option when compiling
10506 the source files you want data about, and you must also use it when
10507 linking.
10509 @item -fprofile-arcs
10510 @opindex fprofile-arcs
10511 Add code so that program flow @dfn{arcs} are instrumented.  During
10512 execution the program records how many times each branch and call is
10513 executed and how many times it is taken or returns.  When the compiled
10514 program exits it saves this data to a file called
10515 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10516 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10517 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10518 @var{auxname} is generated from the name of the output file, if
10519 explicitly specified and it is not the final executable, otherwise it is
10520 the basename of the source file.  In both cases any suffix is removed
10521 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10522 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10523 @xref{Cross-profiling}.
10525 @cindex @command{gcov}
10526 @item --coverage
10527 @opindex coverage
10529 This option is used to compile and link code instrumented for coverage
10530 analysis.  The option is a synonym for @option{-fprofile-arcs}
10531 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10532 linking).  See the documentation for those options for more details.
10534 @itemize
10536 @item
10537 Compile the source files with @option{-fprofile-arcs} plus optimization
10538 and code generation options.  For test coverage analysis, use the
10539 additional @option{-ftest-coverage} option.  You do not need to profile
10540 every source file in a program.
10542 @item
10543 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10544 (the latter implies the former).
10546 @item
10547 Run the program on a representative workload to generate the arc profile
10548 information.  This may be repeated any number of times.  You can run
10549 concurrent instances of your program, and provided that the file system
10550 supports locking, the data files will be correctly updated.  Also
10551 @code{fork} calls are detected and correctly handled (double counting
10552 will not happen).
10554 @item
10555 For profile-directed optimizations, compile the source files again with
10556 the same optimization and code generation options plus
10557 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10558 Control Optimization}).
10560 @item
10561 For test coverage analysis, use @command{gcov} to produce human readable
10562 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10563 @command{gcov} documentation for further information.
10565 @end itemize
10567 With @option{-fprofile-arcs}, for each function of your program GCC
10568 creates a program flow graph, then finds a spanning tree for the graph.
10569 Only arcs that are not on the spanning tree have to be instrumented: the
10570 compiler adds code to count the number of times that these arcs are
10571 executed.  When an arc is the only exit or only entrance to a block, the
10572 instrumentation code can be added to the block; otherwise, a new basic
10573 block must be created to hold the instrumentation code.
10575 @need 2000
10576 @item -ftest-coverage
10577 @opindex ftest-coverage
10578 Produce a notes file that the @command{gcov} code-coverage utility
10579 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10580 show program coverage.  Each source file's note file is called
10581 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10582 above for a description of @var{auxname} and instructions on how to
10583 generate test coverage data.  Coverage data matches the source files
10584 more closely if you do not optimize.
10586 @item -fprofile-dir=@var{path}
10587 @opindex fprofile-dir
10589 Set the directory to search for the profile data files in to @var{path}.
10590 This option affects only the profile data generated by
10591 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10592 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10593 and its related options.  Both absolute and relative paths can be used.
10594 By default, GCC uses the current directory as @var{path}, thus the
10595 profile data file appears in the same directory as the object file.
10597 @item -fprofile-generate
10598 @itemx -fprofile-generate=@var{path}
10599 @opindex fprofile-generate
10601 Enable options usually used for instrumenting application to produce
10602 profile useful for later recompilation with profile feedback based
10603 optimization.  You must use @option{-fprofile-generate} both when
10604 compiling and when linking your program.
10606 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10608 If @var{path} is specified, GCC looks at the @var{path} to find
10609 the profile feedback data files. See @option{-fprofile-dir}.
10611 To optimize the program based on the collected profile information, use
10612 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10614 @item -fprofile-update=@var{method}
10615 @opindex fprofile-update
10617 Alter the update method for an application instrumented for profile
10618 feedback based optimization.  The @var{method} argument should be one of
10619 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10620 The first one is useful for single-threaded applications,
10621 while the second one prevents profile corruption by emitting thread-safe code.
10623 @strong{Warning:} When an application does not properly join all threads
10624 (or creates an detached thread), a profile file can be still corrupted.
10626 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10627 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10628 automatically selects @samp{prefer-atomic} when @option{-pthread}
10629 is present in the command line.
10631 @item -fsanitize=address
10632 @opindex fsanitize=address
10633 Enable AddressSanitizer, a fast memory error detector.
10634 Memory access instructions are instrumented to detect
10635 out-of-bounds and use-after-free bugs.
10636 The option enables @option{-fsanitize-address-use-after-scope}.
10637 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10638 more details.  The run-time behavior can be influenced using the
10639 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10640 the available options are shown at startup of the instrumented program.  See
10641 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10642 for a list of supported options.
10643 The option can't be combined with @option{-fsanitize=thread}.
10645 @item -fsanitize=kernel-address
10646 @opindex fsanitize=kernel-address
10647 Enable AddressSanitizer for Linux kernel.
10648 See @uref{https://github.com/google/kasan/wiki} for more details.
10650 @item -fsanitize=thread
10651 @opindex fsanitize=thread
10652 Enable ThreadSanitizer, a fast data race detector.
10653 Memory access instructions are instrumented to detect
10654 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10655 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10656 environment variable; see
10657 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10658 supported options.
10659 The option can't be combined with @option{-fsanitize=address}
10660 and/or @option{-fsanitize=leak}.
10662 @item -fsanitize=leak
10663 @opindex fsanitize=leak
10664 Enable LeakSanitizer, a memory leak detector.
10665 This option only matters for linking of executables and
10666 the executable is linked against a library that overrides @code{malloc}
10667 and other allocator functions.  See
10668 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10669 details.  The run-time behavior can be influenced using the
10670 @env{LSAN_OPTIONS} environment variable.
10671 The option can't be combined with @option{-fsanitize=thread}.
10673 @item -fsanitize=undefined
10674 @opindex fsanitize=undefined
10675 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10676 Various computations are instrumented to detect undefined behavior
10677 at runtime.  Current suboptions are:
10679 @table @gcctabopt
10681 @item -fsanitize=shift
10682 @opindex fsanitize=shift
10683 This option enables checking that the result of a shift operation is
10684 not undefined.  Note that what exactly is considered undefined differs
10685 slightly between C and C++, as well as between ISO C90 and C99, etc.
10686 This option has two suboptions, @option{-fsanitize=shift-base} and
10687 @option{-fsanitize=shift-exponent}.
10689 @item -fsanitize=shift-exponent
10690 @opindex fsanitize=shift-exponent
10691 This option enables checking that the second argument of a shift operation
10692 is not negative and is smaller than the precision of the promoted first
10693 argument.
10695 @item -fsanitize=shift-base
10696 @opindex fsanitize=shift-base
10697 If the second argument of a shift operation is within range, check that the
10698 result of a shift operation is not undefined.  Note that what exactly is
10699 considered undefined differs slightly between C and C++, as well as between
10700 ISO C90 and C99, etc.
10702 @item -fsanitize=integer-divide-by-zero
10703 @opindex fsanitize=integer-divide-by-zero
10704 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10706 @item -fsanitize=unreachable
10707 @opindex fsanitize=unreachable
10708 With this option, the compiler turns the @code{__builtin_unreachable}
10709 call into a diagnostics message call instead.  When reaching the
10710 @code{__builtin_unreachable} call, the behavior is undefined.
10712 @item -fsanitize=vla-bound
10713 @opindex fsanitize=vla-bound
10714 This option instructs the compiler to check that the size of a variable
10715 length array is positive.
10717 @item -fsanitize=null
10718 @opindex fsanitize=null
10719 This option enables pointer checking.  Particularly, the application
10720 built with this option turned on will issue an error message when it
10721 tries to dereference a NULL pointer, or if a reference (possibly an
10722 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10723 on an object pointed by a NULL pointer.
10725 @item -fsanitize=return
10726 @opindex fsanitize=return
10727 This option enables return statement checking.  Programs
10728 built with this option turned on will issue an error message
10729 when the end of a non-void function is reached without actually
10730 returning a value.  This option works in C++ only.
10732 @item -fsanitize=signed-integer-overflow
10733 @opindex fsanitize=signed-integer-overflow
10734 This option enables signed integer overflow checking.  We check that
10735 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10736 does not overflow in the signed arithmetics.  Note, integer promotion
10737 rules must be taken into account.  That is, the following is not an
10738 overflow:
10739 @smallexample
10740 signed char a = SCHAR_MAX;
10741 a++;
10742 @end smallexample
10744 @item -fsanitize=bounds
10745 @opindex fsanitize=bounds
10746 This option enables instrumentation of array bounds.  Various out of bounds
10747 accesses are detected.  Flexible array members, flexible array member-like
10748 arrays, and initializers of variables with static storage are not instrumented.
10750 @item -fsanitize=bounds-strict
10751 @opindex fsanitize=bounds-strict
10752 This option enables strict instrumentation of array bounds.  Most out of bounds
10753 accesses are detected, including flexible array members and flexible array
10754 member-like arrays.  Initializers of variables with static storage are not
10755 instrumented.
10757 @item -fsanitize=alignment
10758 @opindex fsanitize=alignment
10760 This option enables checking of alignment of pointers when they are
10761 dereferenced, or when a reference is bound to insufficiently aligned target,
10762 or when a method or constructor is invoked on insufficiently aligned object.
10764 @item -fsanitize=object-size
10765 @opindex fsanitize=object-size
10766 This option enables instrumentation of memory references using the
10767 @code{__builtin_object_size} function.  Various out of bounds pointer
10768 accesses are detected.
10770 @item -fsanitize=float-divide-by-zero
10771 @opindex fsanitize=float-divide-by-zero
10772 Detect floating-point division by zero.  Unlike other similar options,
10773 @option{-fsanitize=float-divide-by-zero} is not enabled by
10774 @option{-fsanitize=undefined}, since floating-point division by zero can
10775 be a legitimate way of obtaining infinities and NaNs.
10777 @item -fsanitize=float-cast-overflow
10778 @opindex fsanitize=float-cast-overflow
10779 This option enables floating-point type to integer conversion checking.
10780 We check that the result of the conversion does not overflow.
10781 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10782 not enabled by @option{-fsanitize=undefined}.
10783 This option does not work well with @code{FE_INVALID} exceptions enabled.
10785 @item -fsanitize=nonnull-attribute
10786 @opindex fsanitize=nonnull-attribute
10788 This option enables instrumentation of calls, checking whether null values
10789 are not passed to arguments marked as requiring a non-null value by the
10790 @code{nonnull} function attribute.
10792 @item -fsanitize=returns-nonnull-attribute
10793 @opindex fsanitize=returns-nonnull-attribute
10795 This option enables instrumentation of return statements in functions
10796 marked with @code{returns_nonnull} function attribute, to detect returning
10797 of null values from such functions.
10799 @item -fsanitize=bool
10800 @opindex fsanitize=bool
10802 This option enables instrumentation of loads from bool.  If a value other
10803 than 0/1 is loaded, a run-time error is issued.
10805 @item -fsanitize=enum
10806 @opindex fsanitize=enum
10808 This option enables instrumentation of loads from an enum type.  If
10809 a value outside the range of values for the enum type is loaded,
10810 a run-time error is issued.
10812 @item -fsanitize=vptr
10813 @opindex fsanitize=vptr
10815 This option enables instrumentation of C++ member function calls, member
10816 accesses and some conversions between pointers to base and derived classes,
10817 to verify the referenced object has the correct dynamic type.
10819 @end table
10821 While @option{-ftrapv} causes traps for signed overflows to be emitted,
10822 @option{-fsanitize=undefined} gives a diagnostic message.
10823 This currently works only for the C family of languages.
10825 @item -fno-sanitize=all
10826 @opindex fno-sanitize=all
10828 This option disables all previously enabled sanitizers.
10829 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
10830 together.
10832 @item -fasan-shadow-offset=@var{number}
10833 @opindex fasan-shadow-offset
10834 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
10835 It is useful for experimenting with different shadow memory layouts in
10836 Kernel AddressSanitizer.
10838 @item -fsanitize-sections=@var{s1},@var{s2},...
10839 @opindex fsanitize-sections
10840 Sanitize global variables in selected user-defined sections.  @var{si} may
10841 contain wildcards.
10843 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
10844 @opindex fsanitize-recover
10845 @opindex fno-sanitize-recover
10846 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
10847 mentioned in comma-separated list of @var{opts}.  Enabling this option
10848 for a sanitizer component causes it to attempt to continue
10849 running the program as if no error happened.  This means multiple
10850 runtime errors can be reported in a single program run, and the exit
10851 code of the program may indicate success even when errors
10852 have been reported.  The @option{-fno-sanitize-recover=} option
10853 can be used to alter
10854 this behavior: only the first detected error is reported
10855 and program then exits with a non-zero exit code.
10857 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
10858 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
10859 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
10860 @option{-fsanitize=bounds-strict},
10861 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
10862 For these sanitizers error recovery is turned on by default,
10863 except @option{-fsanitize=address}, for which this feature is experimental.
10864 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
10865 accepted, the former enables recovery for all sanitizers that support it,
10866 the latter disables recovery for all sanitizers that support it.
10868 Even if a recovery mode is turned on the compiler side, it needs to be also
10869 enabled on the runtime library side, otherwise the failures are still fatal.
10870 The runtime library defaults to @code{halt_on_error=0} for
10871 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
10872 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
10873 setting the @code{halt_on_error} flag in the corresponding environment variable.
10875 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
10876 @smallexample
10877 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
10878 @end smallexample
10879 @noindent
10880 Similarly @option{-fno-sanitize-recover} is equivalent to
10881 @smallexample
10882 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
10883 @end smallexample
10885 @item -fsanitize-address-use-after-scope
10886 @opindex fsanitize-address-use-after-scope
10887 Enable sanitization of local variables to detect use-after-scope bugs.
10888 The option sets @option{-fstack-reuse} to @samp{none}.
10890 @item -fsanitize-undefined-trap-on-error
10891 @opindex fsanitize-undefined-trap-on-error
10892 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
10893 report undefined behavior using @code{__builtin_trap} rather than
10894 a @code{libubsan} library routine.  The advantage of this is that the
10895 @code{libubsan} library is not needed and is not linked in, so this
10896 is usable even in freestanding environments.
10898 @item -fsanitize-coverage=trace-pc
10899 @opindex fsanitize-coverage=trace-pc
10900 Enable coverage-guided fuzzing code instrumentation.
10901 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
10903 @item -fbounds-check
10904 @opindex fbounds-check
10905 For front ends that support it, generate additional code to check that
10906 indices used to access arrays are within the declared range.  This is
10907 currently only supported by the Fortran front end, where this option
10908 defaults to false.
10910 @item -fcheck-pointer-bounds
10911 @opindex fcheck-pointer-bounds
10912 @opindex fno-check-pointer-bounds
10913 @cindex Pointer Bounds Checker options
10914 Enable Pointer Bounds Checker instrumentation.  Each memory reference
10915 is instrumented with checks of the pointer used for memory access against
10916 bounds associated with that pointer.  
10918 Currently there
10919 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
10920 and @option{-mmpx} are required to enable this feature.  
10921 MPX-based instrumentation requires
10922 a runtime library to enable MPX in hardware and handle bounds
10923 violation signals.  By default when @option{-fcheck-pointer-bounds}
10924 and @option{-mmpx} options are used to link a program, the GCC driver
10925 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
10926 Bounds checking on calls to dynamic libraries requires a linker
10927 with @option{-z bndplt} support; if GCC was configured with a linker
10928 without support for this option (including the Gold linker and older
10929 versions of ld), a warning is given if you link with @option{-mmpx}
10930 without also specifying @option{-static}, since the overall effectiveness
10931 of the bounds checking protection is reduced.
10932 See also @option{-static-libmpxwrappers}.
10934 MPX-based instrumentation
10935 may be used for debugging and also may be included in production code
10936 to increase program security.  Depending on usage, you may
10937 have different requirements for the runtime library.  The current version
10938 of the MPX runtime library is more oriented for use as a debugging
10939 tool.  MPX runtime library usage implies @option{-lpthread}.  See
10940 also @option{-static-libmpx}.  The runtime library  behavior can be
10941 influenced using various @env{CHKP_RT_*} environment variables.  See
10942 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
10943 for more details.
10945 Generated instrumentation may be controlled by various
10946 @option{-fchkp-*} options and by the @code{bnd_variable_size}
10947 structure field attribute (@pxref{Type Attributes}) and
10948 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
10949 (@pxref{Function Attributes}).  GCC also provides a number of built-in
10950 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
10951 Bounds Checker builtins}, for more information.
10953 @item -fchkp-check-incomplete-type
10954 @opindex fchkp-check-incomplete-type
10955 @opindex fno-chkp-check-incomplete-type
10956 Generate pointer bounds checks for variables with incomplete type.
10957 Enabled by default.
10959 @item -fchkp-narrow-bounds
10960 @opindex fchkp-narrow-bounds
10961 @opindex fno-chkp-narrow-bounds
10962 Controls bounds used by Pointer Bounds Checker for pointers to object
10963 fields.  If narrowing is enabled then field bounds are used.  Otherwise
10964 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
10965 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
10967 @item -fchkp-first-field-has-own-bounds
10968 @opindex fchkp-first-field-has-own-bounds
10969 @opindex fno-chkp-first-field-has-own-bounds
10970 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
10971 first field in the structure.  By default a pointer to the first field has
10972 the same bounds as a pointer to the whole structure.
10974 @item -fchkp-flexible-struct-trailing-arrays
10975 @opindex fchkp-flexible-struct-trailing-arrays
10976 @opindex fno-chkp-flexible-struct-trailing-arrays
10977 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
10978 possibly flexible.  By default only array fields with zero length or that are
10979 marked with attribute bnd_variable_size are treated as flexible.
10981 @item -fchkp-narrow-to-innermost-array
10982 @opindex fchkp-narrow-to-innermost-array
10983 @opindex fno-chkp-narrow-to-innermost-array
10984 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
10985 case of nested static array access.  By default this option is disabled and
10986 bounds of the outermost array are used.
10988 @item -fchkp-optimize
10989 @opindex fchkp-optimize
10990 @opindex fno-chkp-optimize
10991 Enables Pointer Bounds Checker optimizations.  Enabled by default at
10992 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
10994 @item -fchkp-use-fast-string-functions
10995 @opindex fchkp-use-fast-string-functions
10996 @opindex fno-chkp-use-fast-string-functions
10997 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
10998 by Pointer Bounds Checker.  Disabled by default.
11000 @item -fchkp-use-nochk-string-functions
11001 @opindex fchkp-use-nochk-string-functions
11002 @opindex fno-chkp-use-nochk-string-functions
11003 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11004 by Pointer Bounds Checker.  Disabled by default.
11006 @item -fchkp-use-static-bounds
11007 @opindex fchkp-use-static-bounds
11008 @opindex fno-chkp-use-static-bounds
11009 Allow Pointer Bounds Checker to generate static bounds holding
11010 bounds of static variables.  Enabled by default.
11012 @item -fchkp-use-static-const-bounds
11013 @opindex fchkp-use-static-const-bounds
11014 @opindex fno-chkp-use-static-const-bounds
11015 Use statically-initialized bounds for constant bounds instead of
11016 generating them each time they are required.  By default enabled when
11017 @option{-fchkp-use-static-bounds} is enabled.
11019 @item -fchkp-treat-zero-dynamic-size-as-infinite
11020 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11021 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11022 With this option, objects with incomplete type whose
11023 dynamically-obtained size is zero are treated as having infinite size
11024 instead by Pointer Bounds
11025 Checker.  This option may be helpful if a program is linked with a library
11026 missing size information for some symbols.  Disabled by default.
11028 @item -fchkp-check-read
11029 @opindex fchkp-check-read
11030 @opindex fno-chkp-check-read
11031 Instructs Pointer Bounds Checker to generate checks for all read
11032 accesses to memory.  Enabled by default.
11034 @item -fchkp-check-write
11035 @opindex fchkp-check-write
11036 @opindex fno-chkp-check-write
11037 Instructs Pointer Bounds Checker to generate checks for all write
11038 accesses to memory.  Enabled by default.
11040 @item -fchkp-store-bounds
11041 @opindex fchkp-store-bounds
11042 @opindex fno-chkp-store-bounds
11043 Instructs Pointer Bounds Checker to generate bounds stores for
11044 pointer writes.  Enabled by default.
11046 @item -fchkp-instrument-calls
11047 @opindex fchkp-instrument-calls
11048 @opindex fno-chkp-instrument-calls
11049 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11050 Enabled by default.
11052 @item -fchkp-instrument-marked-only
11053 @opindex fchkp-instrument-marked-only
11054 @opindex fno-chkp-instrument-marked-only
11055 Instructs Pointer Bounds Checker to instrument only functions
11056 marked with the @code{bnd_instrument} attribute
11057 (@pxref{Function Attributes}).  Disabled by default.
11059 @item -fchkp-use-wrappers
11060 @opindex fchkp-use-wrappers
11061 @opindex fno-chkp-use-wrappers
11062 Allows Pointer Bounds Checker to replace calls to built-in functions
11063 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11064 is used to link a program, the GCC driver automatically links
11065 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11066 Enabled by default.
11068 @item -fstack-protector
11069 @opindex fstack-protector
11070 Emit extra code to check for buffer overflows, such as stack smashing
11071 attacks.  This is done by adding a guard variable to functions with
11072 vulnerable objects.  This includes functions that call @code{alloca}, and
11073 functions with buffers larger than 8 bytes.  The guards are initialized
11074 when a function is entered and then checked when the function exits.
11075 If a guard check fails, an error message is printed and the program exits.
11077 @item -fstack-protector-all
11078 @opindex fstack-protector-all
11079 Like @option{-fstack-protector} except that all functions are protected.
11081 @item -fstack-protector-strong
11082 @opindex fstack-protector-strong
11083 Like @option{-fstack-protector} but includes additional functions to
11084 be protected --- those that have local array definitions, or have
11085 references to local frame addresses.
11087 @item -fstack-protector-explicit
11088 @opindex fstack-protector-explicit
11089 Like @option{-fstack-protector} but only protects those functions which
11090 have the @code{stack_protect} attribute.
11092 @item -fstack-check
11093 @opindex fstack-check
11094 Generate code to verify that you do not go beyond the boundary of the
11095 stack.  You should specify this flag if you are running in an
11096 environment with multiple threads, but you only rarely need to specify it in
11097 a single-threaded environment since stack overflow is automatically
11098 detected on nearly all systems if there is only one stack.
11100 Note that this switch does not actually cause checking to be done; the
11101 operating system or the language runtime must do that.  The switch causes
11102 generation of code to ensure that they see the stack being extended.
11104 You can additionally specify a string parameter: @samp{no} means no
11105 checking, @samp{generic} means force the use of old-style checking,
11106 @samp{specific} means use the best checking method and is equivalent
11107 to bare @option{-fstack-check}.
11109 Old-style checking is a generic mechanism that requires no specific
11110 target support in the compiler but comes with the following drawbacks:
11112 @enumerate
11113 @item
11114 Modified allocation strategy for large objects: they are always
11115 allocated dynamically if their size exceeds a fixed threshold.
11117 @item
11118 Fixed limit on the size of the static frame of functions: when it is
11119 topped by a particular function, stack checking is not reliable and
11120 a warning is issued by the compiler.
11122 @item
11123 Inefficiency: because of both the modified allocation strategy and the
11124 generic implementation, code performance is hampered.
11125 @end enumerate
11127 Note that old-style stack checking is also the fallback method for
11128 @samp{specific} if no target support has been added in the compiler.
11130 @item -fstack-limit-register=@var{reg}
11131 @itemx -fstack-limit-symbol=@var{sym}
11132 @itemx -fno-stack-limit
11133 @opindex fstack-limit-register
11134 @opindex fstack-limit-symbol
11135 @opindex fno-stack-limit
11136 Generate code to ensure that the stack does not grow beyond a certain value,
11137 either the value of a register or the address of a symbol.  If a larger
11138 stack is required, a signal is raised at run time.  For most targets,
11139 the signal is raised before the stack overruns the boundary, so
11140 it is possible to catch the signal without taking special precautions.
11142 For instance, if the stack starts at absolute address @samp{0x80000000}
11143 and grows downwards, you can use the flags
11144 @option{-fstack-limit-symbol=__stack_limit} and
11145 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11146 of 128KB@.  Note that this may only work with the GNU linker.
11148 You can locally override stack limit checking by using the
11149 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11151 @item -fsplit-stack
11152 @opindex fsplit-stack
11153 Generate code to automatically split the stack before it overflows.
11154 The resulting program has a discontiguous stack which can only
11155 overflow if the program is unable to allocate any more memory.  This
11156 is most useful when running threaded programs, as it is no longer
11157 necessary to calculate a good stack size to use for each thread.  This
11158 is currently only implemented for the x86 targets running
11159 GNU/Linux.
11161 When code compiled with @option{-fsplit-stack} calls code compiled
11162 without @option{-fsplit-stack}, there may not be much stack space
11163 available for the latter code to run.  If compiling all code,
11164 including library code, with @option{-fsplit-stack} is not an option,
11165 then the linker can fix up these calls so that the code compiled
11166 without @option{-fsplit-stack} always has a large stack.  Support for
11167 this is implemented in the gold linker in GNU binutils release 2.21
11168 and later.
11170 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11171 @opindex fvtable-verify
11172 This option is only available when compiling C++ code.
11173 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11174 feature that verifies at run time, for every virtual call, that
11175 the vtable pointer through which the call is made is valid for the type of
11176 the object, and has not been corrupted or overwritten.  If an invalid vtable
11177 pointer is detected at run time, an error is reported and execution of the
11178 program is immediately halted.
11180 This option causes run-time data structures to be built at program startup,
11181 which are used for verifying the vtable pointers.  
11182 The options @samp{std} and @samp{preinit}
11183 control the timing of when these data structures are built.  In both cases the
11184 data structures are built before execution reaches @code{main}.  Using
11185 @option{-fvtable-verify=std} causes the data structures to be built after
11186 shared libraries have been loaded and initialized.
11187 @option{-fvtable-verify=preinit} causes them to be built before shared
11188 libraries have been loaded and initialized.
11190 If this option appears multiple times in the command line with different
11191 values specified, @samp{none} takes highest priority over both @samp{std} and
11192 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11194 @item -fvtv-debug
11195 @opindex fvtv-debug
11196 When used in conjunction with @option{-fvtable-verify=std} or 
11197 @option{-fvtable-verify=preinit}, causes debug versions of the 
11198 runtime functions for the vtable verification feature to be called.  
11199 This flag also causes the compiler to log information about which 
11200 vtable pointers it finds for each class.
11201 This information is written to a file named @file{vtv_set_ptr_data.log} 
11202 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11203 if that is defined or the current working directory otherwise.
11205 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11206 file, be sure to delete any existing one.
11208 @item -fvtv-counts
11209 @opindex fvtv-counts
11210 This is a debugging flag.  When used in conjunction with
11211 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11212 causes the compiler to keep track of the total number of virtual calls
11213 it encounters and the number of verifications it inserts.  It also
11214 counts the number of calls to certain run-time library functions
11215 that it inserts and logs this information for each compilation unit.
11216 The compiler writes this information to a file named
11217 @file{vtv_count_data.log} in the directory named by the environment
11218 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11219 directory otherwise.  It also counts the size of the vtable pointer sets
11220 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11221 in the same directory.
11223 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11224 files, be sure to delete any existing ones.
11226 @item -finstrument-functions
11227 @opindex finstrument-functions
11228 Generate instrumentation calls for entry and exit to functions.  Just
11229 after function entry and just before function exit, the following
11230 profiling functions are called with the address of the current
11231 function and its call site.  (On some platforms,
11232 @code{__builtin_return_address} does not work beyond the current
11233 function, so the call site information may not be available to the
11234 profiling functions otherwise.)
11236 @smallexample
11237 void __cyg_profile_func_enter (void *this_fn,
11238                                void *call_site);
11239 void __cyg_profile_func_exit  (void *this_fn,
11240                                void *call_site);
11241 @end smallexample
11243 The first argument is the address of the start of the current function,
11244 which may be looked up exactly in the symbol table.
11246 This instrumentation is also done for functions expanded inline in other
11247 functions.  The profiling calls indicate where, conceptually, the
11248 inline function is entered and exited.  This means that addressable
11249 versions of such functions must be available.  If all your uses of a
11250 function are expanded inline, this may mean an additional expansion of
11251 code size.  If you use @code{extern inline} in your C code, an
11252 addressable version of such functions must be provided.  (This is
11253 normally the case anyway, but if you get lucky and the optimizer always
11254 expands the functions inline, you might have gotten away without
11255 providing static copies.)
11257 A function may be given the attribute @code{no_instrument_function}, in
11258 which case this instrumentation is not done.  This can be used, for
11259 example, for the profiling functions listed above, high-priority
11260 interrupt routines, and any functions from which the profiling functions
11261 cannot safely be called (perhaps signal handlers, if the profiling
11262 routines generate output or allocate memory).
11264 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11265 @opindex finstrument-functions-exclude-file-list
11267 Set the list of functions that are excluded from instrumentation (see
11268 the description of @option{-finstrument-functions}).  If the file that
11269 contains a function definition matches with one of @var{file}, then
11270 that function is not instrumented.  The match is done on substrings:
11271 if the @var{file} parameter is a substring of the file name, it is
11272 considered to be a match.
11274 For example:
11276 @smallexample
11277 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11278 @end smallexample
11280 @noindent
11281 excludes any inline function defined in files whose pathnames
11282 contain @file{/bits/stl} or @file{include/sys}.
11284 If, for some reason, you want to include letter @samp{,} in one of
11285 @var{sym}, write @samp{\,}. For example,
11286 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11287 (note the single quote surrounding the option).
11289 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11290 @opindex finstrument-functions-exclude-function-list
11292 This is similar to @option{-finstrument-functions-exclude-file-list},
11293 but this option sets the list of function names to be excluded from
11294 instrumentation.  The function name to be matched is its user-visible
11295 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11296 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11297 match is done on substrings: if the @var{sym} parameter is a substring
11298 of the function name, it is considered to be a match.  For C99 and C++
11299 extended identifiers, the function name must be given in UTF-8, not
11300 using universal character names.
11302 @end table
11305 @node Preprocessor Options
11306 @section Options Controlling the Preprocessor
11307 @cindex preprocessor options
11308 @cindex options, preprocessor
11310 These options control the C preprocessor, which is run on each C source
11311 file before actual compilation.
11313 If you use the @option{-E} option, nothing is done except preprocessing.
11314 Some of these options make sense only together with @option{-E} because
11315 they cause the preprocessor output to be unsuitable for actual
11316 compilation.
11318 In addition to the options listed here, there are a number of options 
11319 to control search paths for include files documented in 
11320 @ref{Directory Options}.  
11321 Options to control preprocessor diagnostics are listed in 
11322 @ref{Warning Options}.
11324 @table @gcctabopt
11325 @include cppopts.texi
11327 @item -Wp,@var{option}
11328 @opindex Wp
11329 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11330 and pass @var{option} directly through to the preprocessor.  If
11331 @var{option} contains commas, it is split into multiple options at the
11332 commas.  However, many options are modified, translated or interpreted
11333 by the compiler driver before being passed to the preprocessor, and
11334 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11335 interface is undocumented and subject to change, so whenever possible
11336 you should avoid using @option{-Wp} and let the driver handle the
11337 options instead.
11339 @item -Xpreprocessor @var{option}
11340 @opindex Xpreprocessor
11341 Pass @var{option} as an option to the preprocessor.  You can use this to
11342 supply system-specific preprocessor options that GCC does not 
11343 recognize.
11345 If you want to pass an option that takes an argument, you must use
11346 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11348 @item -no-integrated-cpp
11349 @opindex no-integrated-cpp
11350 Perform preprocessing as a separate pass before compilation.
11351 By default, GCC performs preprocessing as an integrated part of
11352 input tokenization and parsing.
11353 If this option is provided, the appropriate language front end
11354 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11355 and Objective-C, respectively) is instead invoked twice,
11356 once for preprocessing only and once for actual compilation
11357 of the preprocessed input.
11358 This option may be useful in conjunction with the @option{-B} or
11359 @option{-wrapper} options to specify an alternate preprocessor or
11360 perform additional processing of the program source between
11361 normal preprocessing and compilation.
11363 @end table
11365 @node Assembler Options
11366 @section Passing Options to the Assembler
11368 @c prevent bad page break with this line
11369 You can pass options to the assembler.
11371 @table @gcctabopt
11372 @item -Wa,@var{option}
11373 @opindex Wa
11374 Pass @var{option} as an option to the assembler.  If @var{option}
11375 contains commas, it is split into multiple options at the commas.
11377 @item -Xassembler @var{option}
11378 @opindex Xassembler
11379 Pass @var{option} as an option to the assembler.  You can use this to
11380 supply system-specific assembler options that GCC does not
11381 recognize.
11383 If you want to pass an option that takes an argument, you must use
11384 @option{-Xassembler} twice, once for the option and once for the argument.
11386 @end table
11388 @node Link Options
11389 @section Options for Linking
11390 @cindex link options
11391 @cindex options, linking
11393 These options come into play when the compiler links object files into
11394 an executable output file.  They are meaningless if the compiler is
11395 not doing a link step.
11397 @table @gcctabopt
11398 @cindex file names
11399 @item @var{object-file-name}
11400 A file name that does not end in a special recognized suffix is
11401 considered to name an object file or library.  (Object files are
11402 distinguished from libraries by the linker according to the file
11403 contents.)  If linking is done, these object files are used as input
11404 to the linker.
11406 @item -c
11407 @itemx -S
11408 @itemx -E
11409 @opindex c
11410 @opindex S
11411 @opindex E
11412 If any of these options is used, then the linker is not run, and
11413 object file names should not be used as arguments.  @xref{Overall
11414 Options}.
11416 @item -fuse-ld=bfd
11417 @opindex fuse-ld=bfd
11418 Use the @command{bfd} linker instead of the default linker.
11420 @item -fuse-ld=gold
11421 @opindex fuse-ld=gold
11422 Use the @command{gold} linker instead of the default linker.
11424 @cindex Libraries
11425 @item -l@var{library}
11426 @itemx -l @var{library}
11427 @opindex l
11428 Search the library named @var{library} when linking.  (The second
11429 alternative with the library as a separate argument is only for
11430 POSIX compliance and is not recommended.)
11432 It makes a difference where in the command you write this option; the
11433 linker searches and processes libraries and object files in the order they
11434 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11435 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11436 to functions in @samp{z}, those functions may not be loaded.
11438 The linker searches a standard list of directories for the library,
11439 which is actually a file named @file{lib@var{library}.a}.  The linker
11440 then uses this file as if it had been specified precisely by name.
11442 The directories searched include several standard system directories
11443 plus any that you specify with @option{-L}.
11445 Normally the files found this way are library files---archive files
11446 whose members are object files.  The linker handles an archive file by
11447 scanning through it for members which define symbols that have so far
11448 been referenced but not defined.  But if the file that is found is an
11449 ordinary object file, it is linked in the usual fashion.  The only
11450 difference between using an @option{-l} option and specifying a file name
11451 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11452 and searches several directories.
11454 @item -lobjc
11455 @opindex lobjc
11456 You need this special case of the @option{-l} option in order to
11457 link an Objective-C or Objective-C++ program.
11459 @item -nostartfiles
11460 @opindex nostartfiles
11461 Do not use the standard system startup files when linking.
11462 The standard system libraries are used normally, unless @option{-nostdlib}
11463 or @option{-nodefaultlibs} is used.
11465 @item -nodefaultlibs
11466 @opindex nodefaultlibs
11467 Do not use the standard system libraries when linking.
11468 Only the libraries you specify are passed to the linker, and options
11469 specifying linkage of the system libraries, such as @option{-static-libgcc}
11470 or @option{-shared-libgcc}, are ignored.  
11471 The standard startup files are used normally, unless @option{-nostartfiles}
11472 is used.  
11474 The compiler may generate calls to @code{memcmp},
11475 @code{memset}, @code{memcpy} and @code{memmove}.
11476 These entries are usually resolved by entries in
11477 libc.  These entry points should be supplied through some other
11478 mechanism when this option is specified.
11480 @item -nostdlib
11481 @opindex nostdlib
11482 Do not use the standard system startup files or libraries when linking.
11483 No startup files and only the libraries you specify are passed to
11484 the linker, and options specifying linkage of the system libraries, such as
11485 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11487 The compiler may generate calls to @code{memcmp}, @code{memset},
11488 @code{memcpy} and @code{memmove}.
11489 These entries are usually resolved by entries in
11490 libc.  These entry points should be supplied through some other
11491 mechanism when this option is specified.
11493 @cindex @option{-lgcc}, use with @option{-nostdlib}
11494 @cindex @option{-nostdlib} and unresolved references
11495 @cindex unresolved references and @option{-nostdlib}
11496 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11497 @cindex @option{-nodefaultlibs} and unresolved references
11498 @cindex unresolved references and @option{-nodefaultlibs}
11499 One of the standard libraries bypassed by @option{-nostdlib} and
11500 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11501 which GCC uses to overcome shortcomings of particular machines, or special
11502 needs for some languages.
11503 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11504 Collection (GCC) Internals},
11505 for more discussion of @file{libgcc.a}.)
11506 In most cases, you need @file{libgcc.a} even when you want to avoid
11507 other standard libraries.  In other words, when you specify @option{-nostdlib}
11508 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11509 This ensures that you have no unresolved references to internal GCC
11510 library subroutines.
11511 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11512 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11513 GNU Compiler Collection (GCC) Internals}.)
11515 @item -pie
11516 @opindex pie
11517 Produce a position independent executable on targets that support it.
11518 For predictable results, you must also specify the same set of options
11519 used for compilation (@option{-fpie}, @option{-fPIE},
11520 or model suboptions) when you specify this linker option.
11522 @item -no-pie
11523 @opindex no-pie
11524 Don't produce a position independent executable.
11526 @item -rdynamic
11527 @opindex rdynamic
11528 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11529 that support it. This instructs the linker to add all symbols, not
11530 only used ones, to the dynamic symbol table. This option is needed
11531 for some uses of @code{dlopen} or to allow obtaining backtraces
11532 from within a program.
11534 @item -s
11535 @opindex s
11536 Remove all symbol table and relocation information from the executable.
11538 @item -static
11539 @opindex static
11540 On systems that support dynamic linking, this prevents linking with the shared
11541 libraries.  On other systems, this option has no effect.
11543 @item -shared
11544 @opindex shared
11545 Produce a shared object which can then be linked with other objects to
11546 form an executable.  Not all systems support this option.  For predictable
11547 results, you must also specify the same set of options used for compilation
11548 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11549 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11550 needs to build supplementary stub code for constructors to work.  On
11551 multi-libbed systems, @samp{gcc -shared} must select the correct support
11552 libraries to link against.  Failing to supply the correct flags may lead
11553 to subtle defects.  Supplying them in cases where they are not necessary
11554 is innocuous.}
11556 @item -shared-libgcc
11557 @itemx -static-libgcc
11558 @opindex shared-libgcc
11559 @opindex static-libgcc
11560 On systems that provide @file{libgcc} as a shared library, these options
11561 force the use of either the shared or static version, respectively.
11562 If no shared version of @file{libgcc} was built when the compiler was
11563 configured, these options have no effect.
11565 There are several situations in which an application should use the
11566 shared @file{libgcc} instead of the static version.  The most common
11567 of these is when the application wishes to throw and catch exceptions
11568 across different shared libraries.  In that case, each of the libraries
11569 as well as the application itself should use the shared @file{libgcc}.
11571 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11572  whenever you build a shared library or a main executable, because C++
11573  programs typically use exceptions, so this is the right thing to do.
11575 If, instead, you use the GCC driver to create shared libraries, you may
11576 find that they are not always linked with the shared @file{libgcc}.
11577 If GCC finds, at its configuration time, that you have a non-GNU linker
11578 or a GNU linker that does not support option @option{--eh-frame-hdr},
11579 it links the shared version of @file{libgcc} into shared libraries
11580 by default.  Otherwise, it takes advantage of the linker and optimizes
11581 away the linking with the shared version of @file{libgcc}, linking with
11582 the static version of libgcc by default.  This allows exceptions to
11583 propagate through such shared libraries, without incurring relocation
11584 costs at library load time.
11586 However, if a library or main executable is supposed to throw or catch
11587 exceptions, you must link it using the G++ driver, as appropriate
11588 for the languages used in the program, or using the option
11589 @option{-shared-libgcc}, such that it is linked with the shared
11590 @file{libgcc}.
11592 @item -static-libasan
11593 @opindex static-libasan
11594 When the @option{-fsanitize=address} option is used to link a program,
11595 the GCC driver automatically links against @option{libasan}.  If
11596 @file{libasan} is available as a shared library, and the @option{-static}
11597 option is not used, then this links against the shared version of
11598 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11599 driver to link @file{libasan} statically, without necessarily linking
11600 other libraries statically.
11602 @item -static-libtsan
11603 @opindex static-libtsan
11604 When the @option{-fsanitize=thread} option is used to link a program,
11605 the GCC driver automatically links against @option{libtsan}.  If
11606 @file{libtsan} is available as a shared library, and the @option{-static}
11607 option is not used, then this links against the shared version of
11608 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11609 driver to link @file{libtsan} statically, without necessarily linking
11610 other libraries statically.
11612 @item -static-liblsan
11613 @opindex static-liblsan
11614 When the @option{-fsanitize=leak} option is used to link a program,
11615 the GCC driver automatically links against @option{liblsan}.  If
11616 @file{liblsan} is available as a shared library, and the @option{-static}
11617 option is not used, then this links against the shared version of
11618 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11619 driver to link @file{liblsan} statically, without necessarily linking
11620 other libraries statically.
11622 @item -static-libubsan
11623 @opindex static-libubsan
11624 When the @option{-fsanitize=undefined} option is used to link a program,
11625 the GCC driver automatically links against @option{libubsan}.  If
11626 @file{libubsan} is available as a shared library, and the @option{-static}
11627 option is not used, then this links against the shared version of
11628 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11629 driver to link @file{libubsan} statically, without necessarily linking
11630 other libraries statically.
11632 @item -static-libmpx
11633 @opindex static-libmpx
11634 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11635 used to link a program, the GCC driver automatically links against
11636 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11637 and the @option{-static} option is not used, then this links against
11638 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11639 option directs the GCC driver to link @file{libmpx} statically,
11640 without necessarily linking other libraries statically.
11642 @item -static-libmpxwrappers
11643 @opindex static-libmpxwrappers
11644 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11645 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11646 GCC driver automatically links against @file{libmpxwrappers}.  If
11647 @file{libmpxwrappers} is available as a shared library, and the
11648 @option{-static} option is not used, then this links against the shared
11649 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11650 option directs the GCC driver to link @file{libmpxwrappers} statically,
11651 without necessarily linking other libraries statically.
11653 @item -static-libstdc++
11654 @opindex static-libstdc++
11655 When the @command{g++} program is used to link a C++ program, it
11656 normally automatically links against @option{libstdc++}.  If
11657 @file{libstdc++} is available as a shared library, and the
11658 @option{-static} option is not used, then this links against the
11659 shared version of @file{libstdc++}.  That is normally fine.  However, it
11660 is sometimes useful to freeze the version of @file{libstdc++} used by
11661 the program without going all the way to a fully static link.  The
11662 @option{-static-libstdc++} option directs the @command{g++} driver to
11663 link @file{libstdc++} statically, without necessarily linking other
11664 libraries statically.
11666 @item -symbolic
11667 @opindex symbolic
11668 Bind references to global symbols when building a shared object.  Warn
11669 about any unresolved references (unless overridden by the link editor
11670 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11671 this option.
11673 @item -T @var{script}
11674 @opindex T
11675 @cindex linker script
11676 Use @var{script} as the linker script.  This option is supported by most
11677 systems using the GNU linker.  On some targets, such as bare-board
11678 targets without an operating system, the @option{-T} option may be required
11679 when linking to avoid references to undefined symbols.
11681 @item -Xlinker @var{option}
11682 @opindex Xlinker
11683 Pass @var{option} as an option to the linker.  You can use this to
11684 supply system-specific linker options that GCC does not recognize.
11686 If you want to pass an option that takes a separate argument, you must use
11687 @option{-Xlinker} twice, once for the option and once for the argument.
11688 For example, to pass @option{-assert definitions}, you must write
11689 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11690 @option{-Xlinker "-assert definitions"}, because this passes the entire
11691 string as a single argument, which is not what the linker expects.
11693 When using the GNU linker, it is usually more convenient to pass
11694 arguments to linker options using the @option{@var{option}=@var{value}}
11695 syntax than as separate arguments.  For example, you can specify
11696 @option{-Xlinker -Map=output.map} rather than
11697 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11698 this syntax for command-line options.
11700 @item -Wl,@var{option}
11701 @opindex Wl
11702 Pass @var{option} as an option to the linker.  If @var{option} contains
11703 commas, it is split into multiple options at the commas.  You can use this
11704 syntax to pass an argument to the option.
11705 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11706 linker.  When using the GNU linker, you can also get the same effect with
11707 @option{-Wl,-Map=output.map}.
11709 @item -u @var{symbol}
11710 @opindex u
11711 Pretend the symbol @var{symbol} is undefined, to force linking of
11712 library modules to define it.  You can use @option{-u} multiple times with
11713 different symbols to force loading of additional library modules.
11715 @item -z @var{keyword}
11716 @opindex z
11717 @option{-z} is passed directly on to the linker along with the keyword
11718 @var{keyword}. See the section in the documentation of your linker for
11719 permitted values and their meanings.
11720 @end table
11722 @node Directory Options
11723 @section Options for Directory Search
11724 @cindex directory options
11725 @cindex options, directory search
11726 @cindex search path
11728 These options specify directories to search for header files, for
11729 libraries and for parts of the compiler:
11731 @table @gcctabopt
11732 @include cppdiropts.texi
11734 @item -iplugindir=@var{dir}
11735 @opindex iplugindir=
11736 Set the directory to search for plugins that are passed
11737 by @option{-fplugin=@var{name}} instead of
11738 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11739 to be used by the user, but only passed by the driver.
11741 @item -L@var{dir}
11742 @opindex L
11743 Add directory @var{dir} to the list of directories to be searched
11744 for @option{-l}.
11746 @item -B@var{prefix}
11747 @opindex B
11748 This option specifies where to find the executables, libraries,
11749 include files, and data files of the compiler itself.
11751 The compiler driver program runs one or more of the subprograms
11752 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11753 @var{prefix} as a prefix for each program it tries to run, both with and
11754 without @samp{@var{machine}/@var{version}/} for the corresponding target
11755 machine and compiler version.
11757 For each subprogram to be run, the compiler driver first tries the
11758 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11759 is not specified, the driver tries two standard prefixes, 
11760 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11761 those results in a file name that is found, the unmodified program
11762 name is searched for using the directories specified in your
11763 @env{PATH} environment variable.
11765 The compiler checks to see if the path provided by @option{-B}
11766 refers to a directory, and if necessary it adds a directory
11767 separator character at the end of the path.
11769 @option{-B} prefixes that effectively specify directory names also apply
11770 to libraries in the linker, because the compiler translates these
11771 options into @option{-L} options for the linker.  They also apply to
11772 include files in the preprocessor, because the compiler translates these
11773 options into @option{-isystem} options for the preprocessor.  In this case,
11774 the compiler appends @samp{include} to the prefix.
11776 The runtime support file @file{libgcc.a} can also be searched for using
11777 the @option{-B} prefix, if needed.  If it is not found there, the two
11778 standard prefixes above are tried, and that is all.  The file is left
11779 out of the link if it is not found by those means.
11781 Another way to specify a prefix much like the @option{-B} prefix is to use
11782 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11783 Variables}.
11785 As a special kludge, if the path provided by @option{-B} is
11786 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11787 9, then it is replaced by @file{[dir/]include}.  This is to help
11788 with boot-strapping the compiler.
11790 @item -no-canonical-prefixes
11791 @opindex no-canonical-prefixes
11792 Do not expand any symbolic links, resolve references to @samp{/../}
11793 or @samp{/./}, or make the path absolute when generating a relative
11794 prefix.
11796 @item --sysroot=@var{dir}
11797 @opindex sysroot
11798 Use @var{dir} as the logical root directory for headers and libraries.
11799 For example, if the compiler normally searches for headers in
11800 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11801 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11803 If you use both this option and the @option{-isysroot} option, then
11804 the @option{--sysroot} option applies to libraries, but the
11805 @option{-isysroot} option applies to header files.
11807 The GNU linker (beginning with version 2.16) has the necessary support
11808 for this option.  If your linker does not support this option, the
11809 header file aspect of @option{--sysroot} still works, but the
11810 library aspect does not.
11812 @item --no-sysroot-suffix
11813 @opindex no-sysroot-suffix
11814 For some targets, a suffix is added to the root directory specified
11815 with @option{--sysroot}, depending on the other options used, so that
11816 headers may for example be found in
11817 @file{@var{dir}/@var{suffix}/usr/include} instead of
11818 @file{@var{dir}/usr/include}.  This option disables the addition of
11819 such a suffix.
11821 @end table
11823 @node Code Gen Options
11824 @section Options for Code Generation Conventions
11825 @cindex code generation conventions
11826 @cindex options, code generation
11827 @cindex run-time options
11829 These machine-independent options control the interface conventions
11830 used in code generation.
11832 Most of them have both positive and negative forms; the negative form
11833 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
11834 one of the forms is listed---the one that is not the default.  You
11835 can figure out the other form by either removing @samp{no-} or adding
11838 @table @gcctabopt
11839 @item -fstack-reuse=@var{reuse-level}
11840 @opindex fstack_reuse
11841 This option controls stack space reuse for user declared local/auto variables
11842 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
11843 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
11844 local variables and temporaries, @samp{named_vars} enables the reuse only for
11845 user defined local variables with names, and @samp{none} disables stack reuse
11846 completely. The default value is @samp{all}. The option is needed when the
11847 program extends the lifetime of a scoped local variable or a compiler generated
11848 temporary beyond the end point defined by the language.  When a lifetime of
11849 a variable ends, and if the variable lives in memory, the optimizing compiler
11850 has the freedom to reuse its stack space with other temporaries or scoped
11851 local variables whose live range does not overlap with it. Legacy code extending
11852 local lifetime is likely to break with the stack reuse optimization.
11854 For example,
11856 @smallexample
11857    int *p;
11858    @{
11859      int local1;
11861      p = &local1;
11862      local1 = 10;
11863      ....
11864    @}
11865    @{
11866       int local2;
11867       local2 = 20;
11868       ...
11869    @}
11871    if (*p == 10)  // out of scope use of local1
11872      @{
11874      @}
11875 @end smallexample
11877 Another example:
11878 @smallexample
11880    struct A
11881    @{
11882        A(int k) : i(k), j(k) @{ @}
11883        int i;
11884        int j;
11885    @};
11887    A *ap;
11889    void foo(const A& ar)
11890    @{
11891       ap = &ar;
11892    @}
11894    void bar()
11895    @{
11896       foo(A(10)); // temp object's lifetime ends when foo returns
11898       @{
11899         A a(20);
11900         ....
11901       @}
11902       ap->i+= 10;  // ap references out of scope temp whose space
11903                    // is reused with a. What is the value of ap->i?
11904    @}
11906 @end smallexample
11908 The lifetime of a compiler generated temporary is well defined by the C++
11909 standard. When a lifetime of a temporary ends, and if the temporary lives
11910 in memory, the optimizing compiler has the freedom to reuse its stack
11911 space with other temporaries or scoped local variables whose live range
11912 does not overlap with it. However some of the legacy code relies on
11913 the behavior of older compilers in which temporaries' stack space is
11914 not reused, the aggressive stack reuse can lead to runtime errors. This
11915 option is used to control the temporary stack reuse optimization.
11917 @item -ftrapv
11918 @opindex ftrapv
11919 This option generates traps for signed overflow on addition, subtraction,
11920 multiplication operations.
11921 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
11922 @option{-ftrapv} @option{-fwrapv} on the command-line results in
11923 @option{-fwrapv} being effective.  Note that only active options override, so
11924 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
11925 results in @option{-ftrapv} being effective.
11927 @item -fwrapv
11928 @opindex fwrapv
11929 This option instructs the compiler to assume that signed arithmetic
11930 overflow of addition, subtraction and multiplication wraps around
11931 using twos-complement representation.  This flag enables some optimizations
11932 and disables others.
11933 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
11934 @option{-ftrapv} @option{-fwrapv} on the command-line results in
11935 @option{-fwrapv} being effective.  Note that only active options override, so
11936 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
11937 results in @option{-ftrapv} being effective.
11939 @item -fexceptions
11940 @opindex fexceptions
11941 Enable exception handling.  Generates extra code needed to propagate
11942 exceptions.  For some targets, this implies GCC generates frame
11943 unwind information for all functions, which can produce significant data
11944 size overhead, although it does not affect execution.  If you do not
11945 specify this option, GCC enables it by default for languages like
11946 C++ that normally require exception handling, and disables it for
11947 languages like C that do not normally require it.  However, you may need
11948 to enable this option when compiling C code that needs to interoperate
11949 properly with exception handlers written in C++.  You may also wish to
11950 disable this option if you are compiling older C++ programs that don't
11951 use exception handling.
11953 @item -fnon-call-exceptions
11954 @opindex fnon-call-exceptions
11955 Generate code that allows trapping instructions to throw exceptions.
11956 Note that this requires platform-specific runtime support that does
11957 not exist everywhere.  Moreover, it only allows @emph{trapping}
11958 instructions to throw exceptions, i.e.@: memory references or floating-point
11959 instructions.  It does not allow exceptions to be thrown from
11960 arbitrary signal handlers such as @code{SIGALRM}.
11962 @item -fdelete-dead-exceptions
11963 @opindex fdelete-dead-exceptions
11964 Consider that instructions that may throw exceptions but don't otherwise
11965 contribute to the execution of the program can be optimized away.
11966 This option is enabled by default for the Ada front end, as permitted by
11967 the Ada language specification.
11968 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
11970 @item -funwind-tables
11971 @opindex funwind-tables
11972 Similar to @option{-fexceptions}, except that it just generates any needed
11973 static data, but does not affect the generated code in any other way.
11974 You normally do not need to enable this option; instead, a language processor
11975 that needs this handling enables it on your behalf.
11977 @item -fasynchronous-unwind-tables
11978 @opindex fasynchronous-unwind-tables
11979 Generate unwind table in DWARF format, if supported by target machine.  The
11980 table is exact at each instruction boundary, so it can be used for stack
11981 unwinding from asynchronous events (such as debugger or garbage collector).
11983 @item -fno-gnu-unique
11984 @opindex fno-gnu-unique
11985 On systems with recent GNU assembler and C library, the C++ compiler
11986 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
11987 of template static data members and static local variables in inline
11988 functions are unique even in the presence of @code{RTLD_LOCAL}; this
11989 is necessary to avoid problems with a library used by two different
11990 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
11991 therefore disagreeing with the other one about the binding of the
11992 symbol.  But this causes @code{dlclose} to be ignored for affected
11993 DSOs; if your program relies on reinitialization of a DSO via
11994 @code{dlclose} and @code{dlopen}, you can use
11995 @option{-fno-gnu-unique}.
11997 @item -fpcc-struct-return
11998 @opindex fpcc-struct-return
11999 Return ``short'' @code{struct} and @code{union} values in memory like
12000 longer ones, rather than in registers.  This convention is less
12001 efficient, but it has the advantage of allowing intercallability between
12002 GCC-compiled files and files compiled with other compilers, particularly
12003 the Portable C Compiler (pcc).
12005 The precise convention for returning structures in memory depends
12006 on the target configuration macros.
12008 Short structures and unions are those whose size and alignment match
12009 that of some integer type.
12011 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12012 switch is not binary compatible with code compiled with the
12013 @option{-freg-struct-return} switch.
12014 Use it to conform to a non-default application binary interface.
12016 @item -freg-struct-return
12017 @opindex freg-struct-return
12018 Return @code{struct} and @code{union} values in registers when possible.
12019 This is more efficient for small structures than
12020 @option{-fpcc-struct-return}.
12022 If you specify neither @option{-fpcc-struct-return} nor
12023 @option{-freg-struct-return}, GCC defaults to whichever convention is
12024 standard for the target.  If there is no standard convention, GCC
12025 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12026 the principal compiler.  In those cases, we can choose the standard, and
12027 we chose the more efficient register return alternative.
12029 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12030 switch is not binary compatible with code compiled with the
12031 @option{-fpcc-struct-return} switch.
12032 Use it to conform to a non-default application binary interface.
12034 @item -fshort-enums
12035 @opindex fshort-enums
12036 Allocate to an @code{enum} type only as many bytes as it needs for the
12037 declared range of possible values.  Specifically, the @code{enum} type
12038 is equivalent to the smallest integer type that has enough room.
12040 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12041 code that is not binary compatible with code generated without that switch.
12042 Use it to conform to a non-default application binary interface.
12044 @item -fshort-wchar
12045 @opindex fshort-wchar
12046 Override the underlying type for @code{wchar_t} to be @code{short
12047 unsigned int} instead of the default for the target.  This option is
12048 useful for building programs to run under WINE@.
12050 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12051 code that is not binary compatible with code generated without that switch.
12052 Use it to conform to a non-default application binary interface.
12054 @item -fno-common
12055 @opindex fno-common
12056 @cindex tentative definitions
12057 In C code, this option controls the placement of global variables 
12058 defined without an initializer, known as @dfn{tentative definitions} 
12059 in the C standard.  Tentative definitions are distinct from declarations 
12060 of a variable with the @code{extern} keyword, which do not allocate storage.
12062 Unix C compilers have traditionally allocated storage for
12063 uninitialized global variables in a common block.  This allows the
12064 linker to resolve all tentative definitions of the same variable
12065 in different compilation units to the same object, or to a non-tentative
12066 definition.  
12067 This is the behavior specified by @option{-fcommon}, and is the default for 
12068 GCC on most targets.  
12069 On the other hand, this behavior is not required by ISO
12070 C, and on some targets may carry a speed or code size penalty on
12071 variable references.
12073 The @option{-fno-common} option specifies that the compiler should instead
12074 place uninitialized global variables in the data section of the object file.
12075 This inhibits the merging of tentative definitions by the linker so
12076 you get a multiple-definition error if the same 
12077 variable is defined in more than one compilation unit.
12078 Compiling with @option{-fno-common} is useful on targets for which
12079 it provides better performance, or if you wish to verify that the
12080 program will work on other systems that always treat uninitialized
12081 variable definitions this way.
12083 @item -fno-ident
12084 @opindex fno-ident
12085 Ignore the @code{#ident} directive.
12087 @item -finhibit-size-directive
12088 @opindex finhibit-size-directive
12089 Don't output a @code{.size} assembler directive, or anything else that
12090 would cause trouble if the function is split in the middle, and the
12091 two halves are placed at locations far apart in memory.  This option is
12092 used when compiling @file{crtstuff.c}; you should not need to use it
12093 for anything else.
12095 @item -fverbose-asm
12096 @opindex fverbose-asm
12097 Put extra commentary information in the generated assembly code to
12098 make it more readable.  This option is generally only of use to those
12099 who actually need to read the generated assembly code (perhaps while
12100 debugging the compiler itself).
12102 @option{-fno-verbose-asm}, the default, causes the
12103 extra information to be omitted and is useful when comparing two assembler
12104 files.
12106 The added comments include:
12108 @itemize @bullet
12110 @item
12111 information on the compiler version and command-line options,
12113 @item
12114 the source code lines associated with the assembly instructions,
12115 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12117 @item
12118 hints on which high-level expressions correspond to
12119 the various assembly instruction operands.
12121 @end itemize
12123 For example, given this C source file:
12125 @smallexample
12126 int test (int n)
12128   int i;
12129   int total = 0;
12131   for (i = 0; i < n; i++)
12132     total += i * i;
12134   return total;
12136 @end smallexample
12138 compiling to (x86_64) assembly via @option{-S} and emitting the result
12139 direct to stdout via @option{-o} @option{-}
12141 @smallexample
12142 gcc -S test.c -fverbose-asm -Os -o -
12143 @end smallexample
12145 gives output similar to this:
12147 @smallexample
12148         .file   "test.c"
12149 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12150   [...snip...]
12151 # options passed:
12152   [...snip...]
12154         .text
12155         .globl  test
12156         .type   test, @@function
12157 test:
12158 .LFB0:
12159         .cfi_startproc
12160 # test.c:4:   int total = 0;
12161         xorl    %eax, %eax      # <retval>
12162 # test.c:6:   for (i = 0; i < n; i++)
12163         xorl    %edx, %edx      # i
12164 .L2:
12165 # test.c:6:   for (i = 0; i < n; i++)
12166         cmpl    %edi, %edx      # n, i
12167         jge     .L5     #,
12168 # test.c:7:     total += i * i;
12169         movl    %edx, %ecx      # i, tmp92
12170         imull   %edx, %ecx      # i, tmp92
12171 # test.c:6:   for (i = 0; i < n; i++)
12172         incl    %edx    # i
12173 # test.c:7:     total += i * i;
12174         addl    %ecx, %eax      # tmp92, <retval>
12175         jmp     .L2     #
12176 .L5:
12177 # test.c:10: @}
12178         ret
12179         .cfi_endproc
12180 .LFE0:
12181         .size   test, .-test
12182         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12183         .section        .note.GNU-stack,"",@@progbits
12184 @end smallexample
12186 The comments are intended for humans rather than machines and hence the
12187 precise format of the comments is subject to change.
12189 @item -frecord-gcc-switches
12190 @opindex frecord-gcc-switches
12191 This switch causes the command line used to invoke the
12192 compiler to be recorded into the object file that is being created.
12193 This switch is only implemented on some targets and the exact format
12194 of the recording is target and binary file format dependent, but it
12195 usually takes the form of a section containing ASCII text.  This
12196 switch is related to the @option{-fverbose-asm} switch, but that
12197 switch only records information in the assembler output file as
12198 comments, so it never reaches the object file.
12199 See also @option{-grecord-gcc-switches} for another
12200 way of storing compiler options into the object file.
12202 @item -fpic
12203 @opindex fpic
12204 @cindex global offset table
12205 @cindex PIC
12206 Generate position-independent code (PIC) suitable for use in a shared
12207 library, if supported for the target machine.  Such code accesses all
12208 constant addresses through a global offset table (GOT)@.  The dynamic
12209 loader resolves the GOT entries when the program starts (the dynamic
12210 loader is not part of GCC; it is part of the operating system).  If
12211 the GOT size for the linked executable exceeds a machine-specific
12212 maximum size, you get an error message from the linker indicating that
12213 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12214 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12215 on the m68k and RS/6000.  The x86 has no such limit.)
12217 Position-independent code requires special support, and therefore works
12218 only on certain machines.  For the x86, GCC supports PIC for System V
12219 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12220 position-independent.
12222 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12223 are defined to 1.
12225 @item -fPIC
12226 @opindex fPIC
12227 If supported for the target machine, emit position-independent code,
12228 suitable for dynamic linking and avoiding any limit on the size of the
12229 global offset table.  This option makes a difference on AArch64, m68k,
12230 PowerPC and SPARC@.
12232 Position-independent code requires special support, and therefore works
12233 only on certain machines.
12235 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12236 are defined to 2.
12238 @item -fpie
12239 @itemx -fPIE
12240 @opindex fpie
12241 @opindex fPIE
12242 These options are similar to @option{-fpic} and @option{-fPIC}, but
12243 generated position independent code can be only linked into executables.
12244 Usually these options are used when @option{-pie} GCC option is
12245 used during linking.
12247 @option{-fpie} and @option{-fPIE} both define the macros
12248 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12249 for @option{-fpie} and 2 for @option{-fPIE}.
12251 @item -fno-plt
12252 @opindex fno-plt
12253 Do not use the PLT for external function calls in position-independent code.
12254 Instead, load the callee address at call sites from the GOT and branch to it.
12255 This leads to more efficient code by eliminating PLT stubs and exposing
12256 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12257 PLT stubs expect the GOT pointer in a specific register, this gives more
12258 register allocation freedom to the compiler.
12259 Lazy binding requires use of the PLT; 
12260 with @option{-fno-plt} all external symbols are resolved at load time.
12262 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12263 through the PLT for specific external functions.
12265 In position-dependent code, a few targets also convert calls to
12266 functions that are marked to not use the PLT to use the GOT instead.
12268 @item -fno-jump-tables
12269 @opindex fno-jump-tables
12270 Do not use jump tables for switch statements even where it would be
12271 more efficient than other code generation strategies.  This option is
12272 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12273 building code that forms part of a dynamic linker and cannot
12274 reference the address of a jump table.  On some targets, jump tables
12275 do not require a GOT and this option is not needed.
12277 @item -ffixed-@var{reg}
12278 @opindex ffixed
12279 Treat the register named @var{reg} as a fixed register; generated code
12280 should never refer to it (except perhaps as a stack pointer, frame
12281 pointer or in some other fixed role).
12283 @var{reg} must be the name of a register.  The register names accepted
12284 are machine-specific and are defined in the @code{REGISTER_NAMES}
12285 macro in the machine description macro file.
12287 This flag does not have a negative form, because it specifies a
12288 three-way choice.
12290 @item -fcall-used-@var{reg}
12291 @opindex fcall-used
12292 Treat the register named @var{reg} as an allocable register that is
12293 clobbered by function calls.  It may be allocated for temporaries or
12294 variables that do not live across a call.  Functions compiled this way
12295 do not save and restore the register @var{reg}.
12297 It is an error to use this flag with the frame pointer or stack pointer.
12298 Use of this flag for other registers that have fixed pervasive roles in
12299 the machine's execution model produces disastrous results.
12301 This flag does not have a negative form, because it specifies a
12302 three-way choice.
12304 @item -fcall-saved-@var{reg}
12305 @opindex fcall-saved
12306 Treat the register named @var{reg} as an allocable register saved by
12307 functions.  It may be allocated even for temporaries or variables that
12308 live across a call.  Functions compiled this way save and restore
12309 the register @var{reg} if they use it.
12311 It is an error to use this flag with the frame pointer or stack pointer.
12312 Use of this flag for other registers that have fixed pervasive roles in
12313 the machine's execution model produces disastrous results.
12315 A different sort of disaster results from the use of this flag for
12316 a register in which function values may be returned.
12318 This flag does not have a negative form, because it specifies a
12319 three-way choice.
12321 @item -fpack-struct[=@var{n}]
12322 @opindex fpack-struct
12323 Without a value specified, pack all structure members together without
12324 holes.  When a value is specified (which must be a small power of two), pack
12325 structure members according to this value, representing the maximum
12326 alignment (that is, objects with default alignment requirements larger than
12327 this are output potentially unaligned at the next fitting location.
12329 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12330 code that is not binary compatible with code generated without that switch.
12331 Additionally, it makes the code suboptimal.
12332 Use it to conform to a non-default application binary interface.
12334 @item -fleading-underscore
12335 @opindex fleading-underscore
12336 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12337 change the way C symbols are represented in the object file.  One use
12338 is to help link with legacy assembly code.
12340 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12341 generate code that is not binary compatible with code generated without that
12342 switch.  Use it to conform to a non-default application binary interface.
12343 Not all targets provide complete support for this switch.
12345 @item -ftls-model=@var{model}
12346 @opindex ftls-model
12347 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12348 The @var{model} argument should be one of @samp{global-dynamic},
12349 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12350 Note that the choice is subject to optimization: the compiler may use
12351 a more efficient model for symbols not visible outside of the translation
12352 unit, or if @option{-fpic} is not given on the command line.
12354 The default without @option{-fpic} is @samp{initial-exec}; with
12355 @option{-fpic} the default is @samp{global-dynamic}.
12357 @item -ftrampolines
12358 @opindex ftrampolines
12359 For targets that normally need trampolines for nested functions, always
12360 generate them instead of using descriptors.  Otherwise, for targets that
12361 do not need them, like for example HP-PA or IA-64, do nothing.
12363 A trampoline is a small piece of code that is created at run time on the
12364 stack when the address of a nested function is taken, and is used to call
12365 the nested function indirectly.  Therefore, it requires the stack to be
12366 made executable in order for the program to work properly.
12368 @option{-fno-trampolines} is enabled by default on a language by language
12369 basis to let the compiler avoid generating them, if it computes that this
12370 is safe, and replace them with descriptors.  Descriptors are made up of data
12371 only, but the generated code must be prepared to deal with them.  As of this
12372 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12374 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12375 @option{-fno-trampolines} are not binary compatible if nested functions are
12376 present.  This option must therefore be used on a program-wide basis and be
12377 manipulated with extreme care.
12379 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12380 @opindex fvisibility
12381 Set the default ELF image symbol visibility to the specified option---all
12382 symbols are marked with this unless overridden within the code.
12383 Using this feature can very substantially improve linking and
12384 load times of shared object libraries, produce more optimized
12385 code, provide near-perfect API export and prevent symbol clashes.
12386 It is @strong{strongly} recommended that you use this in any shared objects
12387 you distribute.
12389 Despite the nomenclature, @samp{default} always means public; i.e.,
12390 available to be linked against from outside the shared object.
12391 @samp{protected} and @samp{internal} are pretty useless in real-world
12392 usage so the only other commonly used option is @samp{hidden}.
12393 The default if @option{-fvisibility} isn't specified is
12394 @samp{default}, i.e., make every symbol public.
12396 A good explanation of the benefits offered by ensuring ELF
12397 symbols have the correct visibility is given by ``How To Write
12398 Shared Libraries'' by Ulrich Drepper (which can be found at
12399 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
12400 solution made possible by this option to marking things hidden when
12401 the default is public is to make the default hidden and mark things
12402 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12403 and @code{__attribute__ ((visibility("default")))} instead of
12404 @code{__declspec(dllexport)} you get almost identical semantics with
12405 identical syntax.  This is a great boon to those working with
12406 cross-platform projects.
12408 For those adding visibility support to existing code, you may find
12409 @code{#pragma GCC visibility} of use.  This works by you enclosing
12410 the declarations you wish to set visibility for with (for example)
12411 @code{#pragma GCC visibility push(hidden)} and
12412 @code{#pragma GCC visibility pop}.
12413 Bear in mind that symbol visibility should be viewed @strong{as
12414 part of the API interface contract} and thus all new code should
12415 always specify visibility when it is not the default; i.e., declarations
12416 only for use within the local DSO should @strong{always} be marked explicitly
12417 as hidden as so to avoid PLT indirection overheads---making this
12418 abundantly clear also aids readability and self-documentation of the code.
12419 Note that due to ISO C++ specification requirements, @code{operator new} and
12420 @code{operator delete} must always be of default visibility.
12422 Be aware that headers from outside your project, in particular system
12423 headers and headers from any other library you use, may not be
12424 expecting to be compiled with visibility other than the default.  You
12425 may need to explicitly say @code{#pragma GCC visibility push(default)}
12426 before including any such headers.
12428 @code{extern} declarations are not affected by @option{-fvisibility}, so
12429 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12430 no modifications.  However, this means that calls to @code{extern}
12431 functions with no explicit visibility use the PLT, so it is more
12432 effective to use @code{__attribute ((visibility))} and/or
12433 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12434 declarations should be treated as hidden.
12436 Note that @option{-fvisibility} does affect C++ vague linkage
12437 entities. This means that, for instance, an exception class that is
12438 be thrown between DSOs must be explicitly marked with default
12439 visibility so that the @samp{type_info} nodes are unified between
12440 the DSOs.
12442 An overview of these techniques, their benefits and how to use them
12443 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12445 @item -fstrict-volatile-bitfields
12446 @opindex fstrict-volatile-bitfields
12447 This option should be used if accesses to volatile bit-fields (or other
12448 structure fields, although the compiler usually honors those types
12449 anyway) should use a single access of the width of the
12450 field's type, aligned to a natural alignment if possible.  For
12451 example, targets with memory-mapped peripheral registers might require
12452 all such accesses to be 16 bits wide; with this flag you can
12453 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12454 is 16 bits on these targets) to force GCC to use 16-bit accesses
12455 instead of, perhaps, a more efficient 32-bit access.
12457 If this option is disabled, the compiler uses the most efficient
12458 instruction.  In the previous example, that might be a 32-bit load
12459 instruction, even though that accesses bytes that do not contain
12460 any portion of the bit-field, or memory-mapped registers unrelated to
12461 the one being updated.
12463 In some cases, such as when the @code{packed} attribute is applied to a 
12464 structure field, it may not be possible to access the field with a single
12465 read or write that is correctly aligned for the target machine.  In this
12466 case GCC falls back to generating multiple accesses rather than code that 
12467 will fault or truncate the result at run time.
12469 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12470 not allowed to touch non bit-field members.  It is therefore recommended
12471 to define all bits of the field's type as bit-field members.
12473 The default value of this option is determined by the application binary
12474 interface for the target processor.
12476 @item -fsync-libcalls
12477 @opindex fsync-libcalls
12478 This option controls whether any out-of-line instance of the @code{__sync}
12479 family of functions may be used to implement the C++11 @code{__atomic}
12480 family of functions.
12482 The default value of this option is enabled, thus the only useful form
12483 of the option is @option{-fno-sync-libcalls}.  This option is used in
12484 the implementation of the @file{libatomic} runtime library.
12486 @end table
12488 @node Developer Options
12489 @section GCC Developer Options
12490 @cindex developer options
12491 @cindex debugging GCC
12492 @cindex debug dump options
12493 @cindex dump options
12494 @cindex compilation statistics
12496 This section describes command-line options that are primarily of
12497 interest to GCC developers, including options to support compiler
12498 testing and investigation of compiler bugs and compile-time
12499 performance problems.  This includes options that produce debug dumps
12500 at various points in the compilation; that print statistics such as
12501 memory use and execution time; and that print information about GCC's
12502 configuration, such as where it searches for libraries.  You should
12503 rarely need to use any of these options for ordinary compilation and
12504 linking tasks.
12506 @table @gcctabopt
12508 @item -d@var{letters}
12509 @itemx -fdump-rtl-@var{pass}
12510 @itemx -fdump-rtl-@var{pass}=@var{filename}
12511 @opindex d
12512 @opindex fdump-rtl-@var{pass}
12513 Says to make debugging dumps during compilation at times specified by
12514 @var{letters}.  This is used for debugging the RTL-based passes of the
12515 compiler.  The file names for most of the dumps are made by appending
12516 a pass number and a word to the @var{dumpname}, and the files are
12517 created in the directory of the output file.  In case of
12518 @option{=@var{filename}} option, the dump is output on the given file
12519 instead of the pass numbered dump files.  Note that the pass number is
12520 assigned as passes are registered into the pass manager.  Most passes
12521 are registered in the order that they will execute and for these passes
12522 the number corresponds to the pass execution order.  However, passes
12523 registered by plugins, passes specific to compilation targets, or
12524 passes that are otherwise registered after all the other passes are
12525 numbered higher than a pass named "final", even if they are executed
12526 earlier.  @var{dumpname} is generated from the name of the output
12527 file if explicitly specified and not an executable, otherwise it is
12528 the basename of the source file.  These switches may have different
12529 effects when @option{-E} is used for preprocessing.
12531 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12532 @option{-d} option @var{letters}.  Here are the possible
12533 letters for use in @var{pass} and @var{letters}, and their meanings:
12535 @table @gcctabopt
12537 @item -fdump-rtl-alignments
12538 @opindex fdump-rtl-alignments
12539 Dump after branch alignments have been computed.
12541 @item -fdump-rtl-asmcons
12542 @opindex fdump-rtl-asmcons
12543 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12545 @item -fdump-rtl-auto_inc_dec
12546 @opindex fdump-rtl-auto_inc_dec
12547 Dump after auto-inc-dec discovery.  This pass is only run on
12548 architectures that have auto inc or auto dec instructions.
12550 @item -fdump-rtl-barriers
12551 @opindex fdump-rtl-barriers
12552 Dump after cleaning up the barrier instructions.
12554 @item -fdump-rtl-bbpart
12555 @opindex fdump-rtl-bbpart
12556 Dump after partitioning hot and cold basic blocks.
12558 @item -fdump-rtl-bbro
12559 @opindex fdump-rtl-bbro
12560 Dump after block reordering.
12562 @item -fdump-rtl-btl1
12563 @itemx -fdump-rtl-btl2
12564 @opindex fdump-rtl-btl2
12565 @opindex fdump-rtl-btl2
12566 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12567 after the two branch
12568 target load optimization passes.
12570 @item -fdump-rtl-bypass
12571 @opindex fdump-rtl-bypass
12572 Dump after jump bypassing and control flow optimizations.
12574 @item -fdump-rtl-combine
12575 @opindex fdump-rtl-combine
12576 Dump after the RTL instruction combination pass.
12578 @item -fdump-rtl-compgotos
12579 @opindex fdump-rtl-compgotos
12580 Dump after duplicating the computed gotos.
12582 @item -fdump-rtl-ce1
12583 @itemx -fdump-rtl-ce2
12584 @itemx -fdump-rtl-ce3
12585 @opindex fdump-rtl-ce1
12586 @opindex fdump-rtl-ce2
12587 @opindex fdump-rtl-ce3
12588 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12589 @option{-fdump-rtl-ce3} enable dumping after the three
12590 if conversion passes.
12592 @item -fdump-rtl-cprop_hardreg
12593 @opindex fdump-rtl-cprop_hardreg
12594 Dump after hard register copy propagation.
12596 @item -fdump-rtl-csa
12597 @opindex fdump-rtl-csa
12598 Dump after combining stack adjustments.
12600 @item -fdump-rtl-cse1
12601 @itemx -fdump-rtl-cse2
12602 @opindex fdump-rtl-cse1
12603 @opindex fdump-rtl-cse2
12604 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12605 the two common subexpression elimination passes.
12607 @item -fdump-rtl-dce
12608 @opindex fdump-rtl-dce
12609 Dump after the standalone dead code elimination passes.
12611 @item -fdump-rtl-dbr
12612 @opindex fdump-rtl-dbr
12613 Dump after delayed branch scheduling.
12615 @item -fdump-rtl-dce1
12616 @itemx -fdump-rtl-dce2
12617 @opindex fdump-rtl-dce1
12618 @opindex fdump-rtl-dce2
12619 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12620 the two dead store elimination passes.
12622 @item -fdump-rtl-eh
12623 @opindex fdump-rtl-eh
12624 Dump after finalization of EH handling code.
12626 @item -fdump-rtl-eh_ranges
12627 @opindex fdump-rtl-eh_ranges
12628 Dump after conversion of EH handling range regions.
12630 @item -fdump-rtl-expand
12631 @opindex fdump-rtl-expand
12632 Dump after RTL generation.
12634 @item -fdump-rtl-fwprop1
12635 @itemx -fdump-rtl-fwprop2
12636 @opindex fdump-rtl-fwprop1
12637 @opindex fdump-rtl-fwprop2
12638 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12639 dumping after the two forward propagation passes.
12641 @item -fdump-rtl-gcse1
12642 @itemx -fdump-rtl-gcse2
12643 @opindex fdump-rtl-gcse1
12644 @opindex fdump-rtl-gcse2
12645 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12646 after global common subexpression elimination.
12648 @item -fdump-rtl-init-regs
12649 @opindex fdump-rtl-init-regs
12650 Dump after the initialization of the registers.
12652 @item -fdump-rtl-initvals
12653 @opindex fdump-rtl-initvals
12654 Dump after the computation of the initial value sets.
12656 @item -fdump-rtl-into_cfglayout
12657 @opindex fdump-rtl-into_cfglayout
12658 Dump after converting to cfglayout mode.
12660 @item -fdump-rtl-ira
12661 @opindex fdump-rtl-ira
12662 Dump after iterated register allocation.
12664 @item -fdump-rtl-jump
12665 @opindex fdump-rtl-jump
12666 Dump after the second jump optimization.
12668 @item -fdump-rtl-loop2
12669 @opindex fdump-rtl-loop2
12670 @option{-fdump-rtl-loop2} enables dumping after the rtl
12671 loop optimization passes.
12673 @item -fdump-rtl-mach
12674 @opindex fdump-rtl-mach
12675 Dump after performing the machine dependent reorganization pass, if that
12676 pass exists.
12678 @item -fdump-rtl-mode_sw
12679 @opindex fdump-rtl-mode_sw
12680 Dump after removing redundant mode switches.
12682 @item -fdump-rtl-rnreg
12683 @opindex fdump-rtl-rnreg
12684 Dump after register renumbering.
12686 @item -fdump-rtl-outof_cfglayout
12687 @opindex fdump-rtl-outof_cfglayout
12688 Dump after converting from cfglayout mode.
12690 @item -fdump-rtl-peephole2
12691 @opindex fdump-rtl-peephole2
12692 Dump after the peephole pass.
12694 @item -fdump-rtl-postreload
12695 @opindex fdump-rtl-postreload
12696 Dump after post-reload optimizations.
12698 @item -fdump-rtl-pro_and_epilogue
12699 @opindex fdump-rtl-pro_and_epilogue
12700 Dump after generating the function prologues and epilogues.
12702 @item -fdump-rtl-sched1
12703 @itemx -fdump-rtl-sched2
12704 @opindex fdump-rtl-sched1
12705 @opindex fdump-rtl-sched2
12706 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12707 after the basic block scheduling passes.
12709 @item -fdump-rtl-ree
12710 @opindex fdump-rtl-ree
12711 Dump after sign/zero extension elimination.
12713 @item -fdump-rtl-seqabstr
12714 @opindex fdump-rtl-seqabstr
12715 Dump after common sequence discovery.
12717 @item -fdump-rtl-shorten
12718 @opindex fdump-rtl-shorten
12719 Dump after shortening branches.
12721 @item -fdump-rtl-sibling
12722 @opindex fdump-rtl-sibling
12723 Dump after sibling call optimizations.
12725 @item -fdump-rtl-split1
12726 @itemx -fdump-rtl-split2
12727 @itemx -fdump-rtl-split3
12728 @itemx -fdump-rtl-split4
12729 @itemx -fdump-rtl-split5
12730 @opindex fdump-rtl-split1
12731 @opindex fdump-rtl-split2
12732 @opindex fdump-rtl-split3
12733 @opindex fdump-rtl-split4
12734 @opindex fdump-rtl-split5
12735 These options enable dumping after five rounds of
12736 instruction splitting.
12738 @item -fdump-rtl-sms
12739 @opindex fdump-rtl-sms
12740 Dump after modulo scheduling.  This pass is only run on some
12741 architectures.
12743 @item -fdump-rtl-stack
12744 @opindex fdump-rtl-stack
12745 Dump after conversion from GCC's ``flat register file'' registers to the
12746 x87's stack-like registers.  This pass is only run on x86 variants.
12748 @item -fdump-rtl-subreg1
12749 @itemx -fdump-rtl-subreg2
12750 @opindex fdump-rtl-subreg1
12751 @opindex fdump-rtl-subreg2
12752 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12753 the two subreg expansion passes.
12755 @item -fdump-rtl-unshare
12756 @opindex fdump-rtl-unshare
12757 Dump after all rtl has been unshared.
12759 @item -fdump-rtl-vartrack
12760 @opindex fdump-rtl-vartrack
12761 Dump after variable tracking.
12763 @item -fdump-rtl-vregs
12764 @opindex fdump-rtl-vregs
12765 Dump after converting virtual registers to hard registers.
12767 @item -fdump-rtl-web
12768 @opindex fdump-rtl-web
12769 Dump after live range splitting.
12771 @item -fdump-rtl-regclass
12772 @itemx -fdump-rtl-subregs_of_mode_init
12773 @itemx -fdump-rtl-subregs_of_mode_finish
12774 @itemx -fdump-rtl-dfinit
12775 @itemx -fdump-rtl-dfinish
12776 @opindex fdump-rtl-regclass
12777 @opindex fdump-rtl-subregs_of_mode_init
12778 @opindex fdump-rtl-subregs_of_mode_finish
12779 @opindex fdump-rtl-dfinit
12780 @opindex fdump-rtl-dfinish
12781 These dumps are defined but always produce empty files.
12783 @item -da
12784 @itemx -fdump-rtl-all
12785 @opindex da
12786 @opindex fdump-rtl-all
12787 Produce all the dumps listed above.
12789 @item -dA
12790 @opindex dA
12791 Annotate the assembler output with miscellaneous debugging information.
12793 @item -dD
12794 @opindex dD
12795 Dump all macro definitions, at the end of preprocessing, in addition to
12796 normal output.
12798 @item -dH
12799 @opindex dH
12800 Produce a core dump whenever an error occurs.
12802 @item -dp
12803 @opindex dp
12804 Annotate the assembler output with a comment indicating which
12805 pattern and alternative is used.  The length of each instruction is
12806 also printed.
12808 @item -dP
12809 @opindex dP
12810 Dump the RTL in the assembler output as a comment before each instruction.
12811 Also turns on @option{-dp} annotation.
12813 @item -dx
12814 @opindex dx
12815 Just generate RTL for a function instead of compiling it.  Usually used
12816 with @option{-fdump-rtl-expand}.
12817 @end table
12819 @item -fdump-noaddr
12820 @opindex fdump-noaddr
12821 When doing debugging dumps, suppress address output.  This makes it more
12822 feasible to use diff on debugging dumps for compiler invocations with
12823 different compiler binaries and/or different
12824 text / bss / data / heap / stack / dso start locations.
12826 @item -freport-bug
12827 @opindex freport-bug
12828 Collect and dump debug information into a temporary file if an
12829 internal compiler error (ICE) occurs.
12831 @item -fdump-unnumbered
12832 @opindex fdump-unnumbered
12833 When doing debugging dumps, suppress instruction numbers and address output.
12834 This makes it more feasible to use diff on debugging dumps for compiler
12835 invocations with different options, in particular with and without
12836 @option{-g}.
12838 @item -fdump-unnumbered-links
12839 @opindex fdump-unnumbered-links
12840 When doing debugging dumps (see @option{-d} option above), suppress
12841 instruction numbers for the links to the previous and next instructions
12842 in a sequence.
12844 @item -fdump-translation-unit @r{(C++ only)}
12845 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
12846 @opindex fdump-translation-unit
12847 Dump a representation of the tree structure for the entire translation
12848 unit to a file.  The file name is made by appending @file{.tu} to the
12849 source file name, and the file is created in the same directory as the
12850 output file.  If the @samp{-@var{options}} form is used, @var{options}
12851 controls the details of the dump as described for the
12852 @option{-fdump-tree} options.
12854 @item -fdump-class-hierarchy @r{(C++ only)}
12855 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
12856 @opindex fdump-class-hierarchy
12857 Dump a representation of each class's hierarchy and virtual function
12858 table layout to a file.  The file name is made by appending
12859 @file{.class} to the source file name, and the file is created in the
12860 same directory as the output file.  If the @samp{-@var{options}} form
12861 is used, @var{options} controls the details of the dump as described
12862 for the @option{-fdump-tree} options.
12864 @item -fdump-ipa-@var{switch}
12865 @opindex fdump-ipa
12866 Control the dumping at various stages of inter-procedural analysis
12867 language tree to a file.  The file name is generated by appending a
12868 switch specific suffix to the source file name, and the file is created
12869 in the same directory as the output file.  The following dumps are
12870 possible:
12872 @table @samp
12873 @item all
12874 Enables all inter-procedural analysis dumps.
12876 @item cgraph
12877 Dumps information about call-graph optimization, unused function removal,
12878 and inlining decisions.
12880 @item inline
12881 Dump after function inlining.
12883 @end table
12885 @item -fdump-passes
12886 @opindex fdump-passes
12887 Dump the list of optimization passes that are turned on and off by
12888 the current command-line options.
12890 @item -fdump-statistics-@var{option}
12891 @opindex fdump-statistics
12892 Enable and control dumping of pass statistics in a separate file.  The
12893 file name is generated by appending a suffix ending in
12894 @samp{.statistics} to the source file name, and the file is created in
12895 the same directory as the output file.  If the @samp{-@var{option}}
12896 form is used, @samp{-stats} causes counters to be summed over the
12897 whole compilation unit while @samp{-details} dumps every event as
12898 the passes generate them.  The default with no option is to sum
12899 counters for each function compiled.
12901 @item -fdump-tree-@var{switch}
12902 @itemx -fdump-tree-@var{switch}-@var{options}
12903 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
12904 @opindex fdump-tree
12905 Control the dumping at various stages of processing the intermediate
12906 language tree to a file.  The file name is generated by appending a
12907 switch-specific suffix to the source file name, and the file is
12908 created in the same directory as the output file. In case of
12909 @option{=@var{filename}} option, the dump is output on the given file
12910 instead of the auto named dump files.  If the @samp{-@var{options}}
12911 form is used, @var{options} is a list of @samp{-} separated options
12912 which control the details of the dump.  Not all options are applicable
12913 to all dumps; those that are not meaningful are ignored.  The
12914 following options are available
12916 @table @samp
12917 @item address
12918 Print the address of each node.  Usually this is not meaningful as it
12919 changes according to the environment and source file.  Its primary use
12920 is for tying up a dump file with a debug environment.
12921 @item asmname
12922 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
12923 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
12924 use working backward from mangled names in the assembly file.
12925 @item slim
12926 When dumping front-end intermediate representations, inhibit dumping
12927 of members of a scope or body of a function merely because that scope
12928 has been reached.  Only dump such items when they are directly reachable
12929 by some other path.
12931 When dumping pretty-printed trees, this option inhibits dumping the
12932 bodies of control structures.
12934 When dumping RTL, print the RTL in slim (condensed) form instead of
12935 the default LISP-like representation.
12936 @item raw
12937 Print a raw representation of the tree.  By default, trees are
12938 pretty-printed into a C-like representation.
12939 @item details
12940 Enable more detailed dumps (not honored by every dump option). Also
12941 include information from the optimization passes.
12942 @item stats
12943 Enable dumping various statistics about the pass (not honored by every dump
12944 option).
12945 @item blocks
12946 Enable showing basic block boundaries (disabled in raw dumps).
12947 @item graph
12948 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
12949 dump a representation of the control flow graph suitable for viewing with
12950 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
12951 the file is pretty-printed as a subgraph, so that GraphViz can render them
12952 all in a single plot.
12954 This option currently only works for RTL dumps, and the RTL is always
12955 dumped in slim form.
12956 @item vops
12957 Enable showing virtual operands for every statement.
12958 @item lineno
12959 Enable showing line numbers for statements.
12960 @item uid
12961 Enable showing the unique ID (@code{DECL_UID}) for each variable.
12962 @item verbose
12963 Enable showing the tree dump for each statement.
12964 @item eh
12965 Enable showing the EH region number holding each statement.
12966 @item scev
12967 Enable showing scalar evolution analysis details.
12968 @item optimized
12969 Enable showing optimization information (only available in certain
12970 passes).
12971 @item missed
12972 Enable showing missed optimization information (only available in certain
12973 passes).
12974 @item note
12975 Enable other detailed optimization information (only available in
12976 certain passes).
12977 @item =@var{filename}
12978 Instead of an auto named dump file, output into the given file
12979 name. The file names @file{stdout} and @file{stderr} are treated
12980 specially and are considered already open standard streams. For
12981 example,
12983 @smallexample
12984 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
12985      -fdump-tree-pre=stderr file.c
12986 @end smallexample
12988 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
12989 output on to @file{stderr}. If two conflicting dump filenames are
12990 given for the same pass, then the latter option overrides the earlier
12991 one.
12993 @item split-paths
12994 @opindex fdump-tree-split-paths
12995 Dump each function after splitting paths to loop backedges.  The file
12996 name is made by appending @file{.split-paths} to the source file name.
12998 @item all
12999 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13000 and @option{lineno}.
13002 @item optall
13003 Turn on all optimization options, i.e., @option{optimized},
13004 @option{missed}, and @option{note}.
13005 @end table
13007 The following tree dumps are possible:
13008 @table @samp
13010 @item original
13011 @opindex fdump-tree-original
13012 Dump before any tree based optimization, to @file{@var{file}.original}.
13014 @item optimized
13015 @opindex fdump-tree-optimized
13016 Dump after all tree based optimization, to @file{@var{file}.optimized}.
13018 @item gimple
13019 @opindex fdump-tree-gimple
13020 Dump each function before and after the gimplification pass to a file.  The
13021 file name is made by appending @file{.gimple} to the source file name.
13023 @item cfg
13024 @opindex fdump-tree-cfg
13025 Dump the control flow graph of each function to a file.  The file name is
13026 made by appending @file{.cfg} to the source file name.
13028 @item ch
13029 @opindex fdump-tree-ch
13030 Dump each function after copying loop headers.  The file name is made by
13031 appending @file{.ch} to the source file name.
13033 @item ssa
13034 @opindex fdump-tree-ssa
13035 Dump SSA related information to a file.  The file name is made by appending
13036 @file{.ssa} to the source file name.
13038 @item alias
13039 @opindex fdump-tree-alias
13040 Dump aliasing information for each function.  The file name is made by
13041 appending @file{.alias} to the source file name.
13043 @item ccp
13044 @opindex fdump-tree-ccp
13045 Dump each function after CCP@.  The file name is made by appending
13046 @file{.ccp} to the source file name.
13048 @item storeccp
13049 @opindex fdump-tree-storeccp
13050 Dump each function after STORE-CCP@.  The file name is made by appending
13051 @file{.storeccp} to the source file name.
13053 @item pre
13054 @opindex fdump-tree-pre
13055 Dump trees after partial redundancy elimination and/or code hoisting.
13056 The file name is made by appending @file{.pre} to the source file name.
13058 @item fre
13059 @opindex fdump-tree-fre
13060 Dump trees after full redundancy elimination.  The file name is made
13061 by appending @file{.fre} to the source file name.
13063 @item copyprop
13064 @opindex fdump-tree-copyprop
13065 Dump trees after copy propagation.  The file name is made
13066 by appending @file{.copyprop} to the source file name.
13068 @item store_copyprop
13069 @opindex fdump-tree-store_copyprop
13070 Dump trees after store copy-propagation.  The file name is made
13071 by appending @file{.store_copyprop} to the source file name.
13073 @item dce
13074 @opindex fdump-tree-dce
13075 Dump each function after dead code elimination.  The file name is made by
13076 appending @file{.dce} to the source file name.
13078 @item sra
13079 @opindex fdump-tree-sra
13080 Dump each function after performing scalar replacement of aggregates.  The
13081 file name is made by appending @file{.sra} to the source file name.
13083 @item sink
13084 @opindex fdump-tree-sink
13085 Dump each function after performing code sinking.  The file name is made
13086 by appending @file{.sink} to the source file name.
13088 @item dom
13089 @opindex fdump-tree-dom
13090 Dump each function after applying dominator tree optimizations.  The file
13091 name is made by appending @file{.dom} to the source file name.
13093 @item dse
13094 @opindex fdump-tree-dse
13095 Dump each function after applying dead store elimination.  The file
13096 name is made by appending @file{.dse} to the source file name.
13098 @item phiopt
13099 @opindex fdump-tree-phiopt
13100 Dump each function after optimizing PHI nodes into straightline code.  The file
13101 name is made by appending @file{.phiopt} to the source file name.
13103 @item backprop
13104 @opindex fdump-tree-backprop
13105 Dump each function after back-propagating use information up the definition
13106 chain.  The file name is made by appending @file{.backprop} to the
13107 source file name.
13109 @item forwprop
13110 @opindex fdump-tree-forwprop
13111 Dump each function after forward propagating single use variables.  The file
13112 name is made by appending @file{.forwprop} to the source file name.
13114 @item nrv
13115 @opindex fdump-tree-nrv
13116 Dump each function after applying the named return value optimization on
13117 generic trees.  The file name is made by appending @file{.nrv} to the source
13118 file name.
13120 @item vect
13121 @opindex fdump-tree-vect
13122 Dump each function after applying vectorization of loops.  The file name is
13123 made by appending @file{.vect} to the source file name.
13125 @item slp
13126 @opindex fdump-tree-slp
13127 Dump each function after applying vectorization of basic blocks.  The file name
13128 is made by appending @file{.slp} to the source file name.
13130 @item vrp
13131 @opindex fdump-tree-vrp
13132 Dump each function after Value Range Propagation (VRP).  The file name
13133 is made by appending @file{.vrp} to the source file name.
13135 @item early vrp
13136 @opindex fdump-tree-evrp
13137 Dump each function after Early Value Range Propagation (EVRP).  The file name
13138 is made by appending @file{.evrp} to the source file name.
13140 @item oaccdevlow
13141 @opindex fdump-tree-oaccdevlow
13142 Dump each function after applying device-specific OpenACC transformations.
13143 The file name is made by appending @file{.oaccdevlow} to the source file name.
13145 @item all
13146 @opindex fdump-tree-all
13147 Enable all the available tree dumps with the flags provided in this option.
13148 @end table
13150 @item -fopt-info
13151 @itemx -fopt-info-@var{options}
13152 @itemx -fopt-info-@var{options}=@var{filename}
13153 @opindex fopt-info
13154 Controls optimization dumps from various optimization passes. If the
13155 @samp{-@var{options}} form is used, @var{options} is a list of
13156 @samp{-} separated option keywords to select the dump details and
13157 optimizations.  
13159 The @var{options} can be divided into two groups: options describing the
13160 verbosity of the dump, and options describing which optimizations
13161 should be included. The options from both the groups can be freely
13162 mixed as they are non-overlapping. However, in case of any conflicts,
13163 the later options override the earlier options on the command
13164 line. 
13166 The following options control the dump verbosity:
13168 @table @samp
13169 @item optimized
13170 Print information when an optimization is successfully applied. It is
13171 up to a pass to decide which information is relevant. For example, the
13172 vectorizer passes print the source location of loops which are
13173 successfully vectorized.
13174 @item missed
13175 Print information about missed optimizations. Individual passes
13176 control which information to include in the output. 
13177 @item note
13178 Print verbose information about optimizations, such as certain
13179 transformations, more detailed messages about decisions etc.
13180 @item all
13181 Print detailed optimization information. This includes
13182 @samp{optimized}, @samp{missed}, and @samp{note}.
13183 @end table
13185 One or more of the following option keywords can be used to describe a
13186 group of optimizations:
13188 @table @samp
13189 @item ipa
13190 Enable dumps from all interprocedural optimizations.
13191 @item loop
13192 Enable dumps from all loop optimizations.
13193 @item inline
13194 Enable dumps from all inlining optimizations.
13195 @item vec
13196 Enable dumps from all vectorization optimizations.
13197 @item optall
13198 Enable dumps from all optimizations. This is a superset of
13199 the optimization groups listed above.
13200 @end table
13202 If @var{options} is
13203 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13204 info about successful optimizations from all the passes.  
13206 If the @var{filename} is provided, then the dumps from all the
13207 applicable optimizations are concatenated into the @var{filename}.
13208 Otherwise the dump is output onto @file{stderr}. Though multiple
13209 @option{-fopt-info} options are accepted, only one of them can include
13210 a @var{filename}. If other filenames are provided then all but the
13211 first such option are ignored.
13213 Note that the output @var{filename} is overwritten
13214 in case of multiple translation units. If a combined output from
13215 multiple translation units is desired, @file{stderr} should be used
13216 instead.
13218 In the following example, the optimization info is output to
13219 @file{stderr}:
13221 @smallexample
13222 gcc -O3 -fopt-info
13223 @end smallexample
13225 This example:
13226 @smallexample
13227 gcc -O3 -fopt-info-missed=missed.all
13228 @end smallexample
13230 @noindent
13231 outputs missed optimization report from all the passes into
13232 @file{missed.all}, and this one:
13234 @smallexample
13235 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13236 @end smallexample
13238 @noindent
13239 prints information about missed optimization opportunities from
13240 vectorization passes on @file{stderr}.  
13241 Note that @option{-fopt-info-vec-missed} is equivalent to 
13242 @option{-fopt-info-missed-vec}.
13244 As another example,
13245 @smallexample
13246 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13247 @end smallexample
13249 @noindent
13250 outputs information about missed optimizations as well as
13251 optimized locations from all the inlining passes into
13252 @file{inline.txt}.
13254 Finally, consider:
13256 @smallexample
13257 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13258 @end smallexample
13260 @noindent
13261 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13262 in conflict since only one output file is allowed. In this case, only
13263 the first option takes effect and the subsequent options are
13264 ignored. Thus only @file{vec.miss} is produced which contains
13265 dumps from the vectorizer about missed opportunities.
13267 @item -fsched-verbose=@var{n}
13268 @opindex fsched-verbose
13269 On targets that use instruction scheduling, this option controls the
13270 amount of debugging output the scheduler prints to the dump files.
13272 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13273 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13274 For @var{n} greater than one, it also output basic block probabilities,
13275 detailed ready list information and unit/insn info.  For @var{n} greater
13276 than two, it includes RTL at abort point, control-flow and regions info.
13277 And for @var{n} over four, @option{-fsched-verbose} also includes
13278 dependence info.
13282 @item -fenable-@var{kind}-@var{pass}
13283 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13284 @opindex fdisable-
13285 @opindex fenable-
13287 This is a set of options that are used to explicitly disable/enable
13288 optimization passes.  These options are intended for use for debugging GCC.
13289 Compiler users should use regular options for enabling/disabling
13290 passes instead.
13292 @table @gcctabopt
13294 @item -fdisable-ipa-@var{pass}
13295 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13296 statically invoked in the compiler multiple times, the pass name should be
13297 appended with a sequential number starting from 1.
13299 @item -fdisable-rtl-@var{pass}
13300 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13301 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13302 statically invoked in the compiler multiple times, the pass name should be
13303 appended with a sequential number starting from 1.  @var{range-list} is a 
13304 comma-separated list of function ranges or assembler names.  Each range is a number
13305 pair separated by a colon.  The range is inclusive in both ends.  If the range
13306 is trivial, the number pair can be simplified as a single number.  If the
13307 function's call graph node's @var{uid} falls within one of the specified ranges,
13308 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13309 function header of a dump file, and the pass names can be dumped by using
13310 option @option{-fdump-passes}.
13312 @item -fdisable-tree-@var{pass}
13313 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13314 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13315 option arguments.
13317 @item -fenable-ipa-@var{pass}
13318 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13319 statically invoked in the compiler multiple times, the pass name should be
13320 appended with a sequential number starting from 1.
13322 @item -fenable-rtl-@var{pass}
13323 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13324 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13325 description and examples.
13327 @item -fenable-tree-@var{pass}
13328 @itemx -fenable-tree-@var{pass}=@var{range-list}
13329 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13330 of option arguments.
13332 @end table
13334 Here are some examples showing uses of these options.
13336 @smallexample
13338 # disable ccp1 for all functions
13339    -fdisable-tree-ccp1
13340 # disable complete unroll for function whose cgraph node uid is 1
13341    -fenable-tree-cunroll=1
13342 # disable gcse2 for functions at the following ranges [1,1],
13343 # [300,400], and [400,1000]
13344 # disable gcse2 for functions foo and foo2
13345    -fdisable-rtl-gcse2=foo,foo2
13346 # disable early inlining
13347    -fdisable-tree-einline
13348 # disable ipa inlining
13349    -fdisable-ipa-inline
13350 # enable tree full unroll
13351    -fenable-tree-unroll
13353 @end smallexample
13355 @item -fchecking
13356 @itemx -fchecking=@var{n}
13357 @opindex fchecking
13358 @opindex fno-checking
13359 Enable internal consistency checking.  The default depends on
13360 the compiler configuration.  @option{-fchecking=2} enables further
13361 internal consistency checking that might affect code generation.
13363 @item -frandom-seed=@var{string}
13364 @opindex frandom-seed
13365 This option provides a seed that GCC uses in place of
13366 random numbers in generating certain symbol names
13367 that have to be different in every compiled file.  It is also used to
13368 place unique stamps in coverage data files and the object files that
13369 produce them.  You can use the @option{-frandom-seed} option to produce
13370 reproducibly identical object files.
13372 The @var{string} can either be a number (decimal, octal or hex) or an
13373 arbitrary string (in which case it's converted to a number by
13374 computing CRC32).
13376 The @var{string} should be different for every file you compile.
13378 @item -save-temps
13379 @itemx -save-temps=cwd
13380 @opindex save-temps
13381 Store the usual ``temporary'' intermediate files permanently; place them
13382 in the current directory and name them based on the source file.  Thus,
13383 compiling @file{foo.c} with @option{-c -save-temps} produces files
13384 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13385 preprocessed @file{foo.i} output file even though the compiler now
13386 normally uses an integrated preprocessor.
13388 When used in combination with the @option{-x} command-line option,
13389 @option{-save-temps} is sensible enough to avoid over writing an
13390 input source file with the same extension as an intermediate file.
13391 The corresponding intermediate file may be obtained by renaming the
13392 source file before using @option{-save-temps}.
13394 If you invoke GCC in parallel, compiling several different source
13395 files that share a common base name in different subdirectories or the
13396 same source file compiled for multiple output destinations, it is
13397 likely that the different parallel compilers will interfere with each
13398 other, and overwrite the temporary files.  For instance:
13400 @smallexample
13401 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13402 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13403 @end smallexample
13405 may result in @file{foo.i} and @file{foo.o} being written to
13406 simultaneously by both compilers.
13408 @item -save-temps=obj
13409 @opindex save-temps=obj
13410 Store the usual ``temporary'' intermediate files permanently.  If the
13411 @option{-o} option is used, the temporary files are based on the
13412 object file.  If the @option{-o} option is not used, the
13413 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13415 For example:
13417 @smallexample
13418 gcc -save-temps=obj -c foo.c
13419 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13420 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13421 @end smallexample
13423 @noindent
13424 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13425 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13426 @file{dir2/yfoobar.o}.
13428 @item -time@r{[}=@var{file}@r{]}
13429 @opindex time
13430 Report the CPU time taken by each subprocess in the compilation
13431 sequence.  For C source files, this is the compiler proper and assembler
13432 (plus the linker if linking is done).
13434 Without the specification of an output file, the output looks like this:
13436 @smallexample
13437 # cc1 0.12 0.01
13438 # as 0.00 0.01
13439 @end smallexample
13441 The first number on each line is the ``user time'', that is time spent
13442 executing the program itself.  The second number is ``system time'',
13443 time spent executing operating system routines on behalf of the program.
13444 Both numbers are in seconds.
13446 With the specification of an output file, the output is appended to the
13447 named file, and it looks like this:
13449 @smallexample
13450 0.12 0.01 cc1 @var{options}
13451 0.00 0.01 as @var{options}
13452 @end smallexample
13454 The ``user time'' and the ``system time'' are moved before the program
13455 name, and the options passed to the program are displayed, so that one
13456 can later tell what file was being compiled, and with which options.
13458 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13459 @opindex fdump-final-insns
13460 Dump the final internal representation (RTL) to @var{file}.  If the
13461 optional argument is omitted (or if @var{file} is @code{.}), the name
13462 of the dump file is determined by appending @code{.gkd} to the
13463 compilation output file name.
13465 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13466 @opindex fcompare-debug
13467 @opindex fno-compare-debug
13468 If no error occurs during compilation, run the compiler a second time,
13469 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13470 passed to the second compilation.  Dump the final internal
13471 representation in both compilations, and print an error if they differ.
13473 If the equal sign is omitted, the default @option{-gtoggle} is used.
13475 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13476 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13477 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13478 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13479 is used.
13481 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13482 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13483 of the final representation and the second compilation, preventing even
13484 @env{GCC_COMPARE_DEBUG} from taking effect.
13486 To verify full coverage during @option{-fcompare-debug} testing, set
13487 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13488 which GCC rejects as an invalid option in any actual compilation
13489 (rather than preprocessing, assembly or linking).  To get just a
13490 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13491 not overridden} will do.
13493 @item -fcompare-debug-second
13494 @opindex fcompare-debug-second
13495 This option is implicitly passed to the compiler for the second
13496 compilation requested by @option{-fcompare-debug}, along with options to
13497 silence warnings, and omitting other options that would cause
13498 side-effect compiler outputs to files or to the standard output.  Dump
13499 files and preserved temporary files are renamed so as to contain the
13500 @code{.gk} additional extension during the second compilation, to avoid
13501 overwriting those generated by the first.
13503 When this option is passed to the compiler driver, it causes the
13504 @emph{first} compilation to be skipped, which makes it useful for little
13505 other than debugging the compiler proper.
13507 @item -gtoggle
13508 @opindex gtoggle
13509 Turn off generation of debug info, if leaving out this option
13510 generates it, or turn it on at level 2 otherwise.  The position of this
13511 argument in the command line does not matter; it takes effect after all
13512 other options are processed, and it does so only once, no matter how
13513 many times it is given.  This is mainly intended to be used with
13514 @option{-fcompare-debug}.
13516 @item -fvar-tracking-assignments-toggle
13517 @opindex fvar-tracking-assignments-toggle
13518 @opindex fno-var-tracking-assignments-toggle
13519 Toggle @option{-fvar-tracking-assignments}, in the same way that
13520 @option{-gtoggle} toggles @option{-g}.
13522 @item -Q
13523 @opindex Q
13524 Makes the compiler print out each function name as it is compiled, and
13525 print some statistics about each pass when it finishes.
13527 @item -ftime-report
13528 @opindex ftime-report
13529 Makes the compiler print some statistics about the time consumed by each
13530 pass when it finishes.
13532 @item -ftime-report-details
13533 @opindex ftime-report-details
13534 Record the time consumed by infrastructure parts separately for each pass.
13536 @item -fira-verbose=@var{n}
13537 @opindex fira-verbose
13538 Control the verbosity of the dump file for the integrated register allocator.
13539 The default value is 5.  If the value @var{n} is greater or equal to 10,
13540 the dump output is sent to stderr using the same format as @var{n} minus 10.
13542 @item -flto-report
13543 @opindex flto-report
13544 Prints a report with internal details on the workings of the link-time
13545 optimizer.  The contents of this report vary from version to version.
13546 It is meant to be useful to GCC developers when processing object
13547 files in LTO mode (via @option{-flto}).
13549 Disabled by default.
13551 @item -flto-report-wpa
13552 @opindex flto-report-wpa
13553 Like @option{-flto-report}, but only print for the WPA phase of Link
13554 Time Optimization.
13556 @item -fmem-report
13557 @opindex fmem-report
13558 Makes the compiler print some statistics about permanent memory
13559 allocation when it finishes.
13561 @item -fmem-report-wpa
13562 @opindex fmem-report-wpa
13563 Makes the compiler print some statistics about permanent memory
13564 allocation for the WPA phase only.
13566 @item -fpre-ipa-mem-report
13567 @opindex fpre-ipa-mem-report
13568 @item -fpost-ipa-mem-report
13569 @opindex fpost-ipa-mem-report
13570 Makes the compiler print some statistics about permanent memory
13571 allocation before or after interprocedural optimization.
13573 @item -fprofile-report
13574 @opindex fprofile-report
13575 Makes the compiler print some statistics about consistency of the
13576 (estimated) profile and effect of individual passes.
13578 @item -fstack-usage
13579 @opindex fstack-usage
13580 Makes the compiler output stack usage information for the program, on a
13581 per-function basis.  The filename for the dump is made by appending
13582 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13583 the output file, if explicitly specified and it is not an executable,
13584 otherwise it is the basename of the source file.  An entry is made up
13585 of three fields:
13587 @itemize
13588 @item
13589 The name of the function.
13590 @item
13591 A number of bytes.
13592 @item
13593 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13594 @end itemize
13596 The qualifier @code{static} means that the function manipulates the stack
13597 statically: a fixed number of bytes are allocated for the frame on function
13598 entry and released on function exit; no stack adjustments are otherwise made
13599 in the function.  The second field is this fixed number of bytes.
13601 The qualifier @code{dynamic} means that the function manipulates the stack
13602 dynamically: in addition to the static allocation described above, stack
13603 adjustments are made in the body of the function, for example to push/pop
13604 arguments around function calls.  If the qualifier @code{bounded} is also
13605 present, the amount of these adjustments is bounded at compile time and
13606 the second field is an upper bound of the total amount of stack used by
13607 the function.  If it is not present, the amount of these adjustments is
13608 not bounded at compile time and the second field only represents the
13609 bounded part.
13611 @item -fstats
13612 @opindex fstats
13613 Emit statistics about front-end processing at the end of the compilation.
13614 This option is supported only by the C++ front end, and
13615 the information is generally only useful to the G++ development team.
13617 @item -fdbg-cnt-list
13618 @opindex fdbg-cnt-list
13619 Print the name and the counter upper bound for all debug counters.
13622 @item -fdbg-cnt=@var{counter-value-list}
13623 @opindex fdbg-cnt
13624 Set the internal debug counter upper bound.  @var{counter-value-list}
13625 is a comma-separated list of @var{name}:@var{value} pairs
13626 which sets the upper bound of each debug counter @var{name} to @var{value}.
13627 All debug counters have the initial upper bound of @code{UINT_MAX};
13628 thus @code{dbg_cnt} returns true always unless the upper bound
13629 is set by this option.
13630 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13631 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13633 @item -print-file-name=@var{library}
13634 @opindex print-file-name
13635 Print the full absolute name of the library file @var{library} that
13636 would be used when linking---and don't do anything else.  With this
13637 option, GCC does not compile or link anything; it just prints the
13638 file name.
13640 @item -print-multi-directory
13641 @opindex print-multi-directory
13642 Print the directory name corresponding to the multilib selected by any
13643 other switches present in the command line.  This directory is supposed
13644 to exist in @env{GCC_EXEC_PREFIX}.
13646 @item -print-multi-lib
13647 @opindex print-multi-lib
13648 Print the mapping from multilib directory names to compiler switches
13649 that enable them.  The directory name is separated from the switches by
13650 @samp{;}, and each switch starts with an @samp{@@} instead of the
13651 @samp{-}, without spaces between multiple switches.  This is supposed to
13652 ease shell processing.
13654 @item -print-multi-os-directory
13655 @opindex print-multi-os-directory
13656 Print the path to OS libraries for the selected
13657 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13658 present in the @file{lib} subdirectory and no multilibs are used, this is
13659 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13660 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13661 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13662 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13664 @item -print-multiarch
13665 @opindex print-multiarch
13666 Print the path to OS libraries for the selected multiarch,
13667 relative to some @file{lib} subdirectory.
13669 @item -print-prog-name=@var{program}
13670 @opindex print-prog-name
13671 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13673 @item -print-libgcc-file-name
13674 @opindex print-libgcc-file-name
13675 Same as @option{-print-file-name=libgcc.a}.
13677 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13678 but you do want to link with @file{libgcc.a}.  You can do:
13680 @smallexample
13681 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13682 @end smallexample
13684 @item -print-search-dirs
13685 @opindex print-search-dirs
13686 Print the name of the configured installation directory and a list of
13687 program and library directories @command{gcc} searches---and don't do anything else.
13689 This is useful when @command{gcc} prints the error message
13690 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13691 To resolve this you either need to put @file{cpp0} and the other compiler
13692 components where @command{gcc} expects to find them, or you can set the environment
13693 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13694 Don't forget the trailing @samp{/}.
13695 @xref{Environment Variables}.
13697 @item -print-sysroot
13698 @opindex print-sysroot
13699 Print the target sysroot directory that is used during
13700 compilation.  This is the target sysroot specified either at configure
13701 time or using the @option{--sysroot} option, possibly with an extra
13702 suffix that depends on compilation options.  If no target sysroot is
13703 specified, the option prints nothing.
13705 @item -print-sysroot-headers-suffix
13706 @opindex print-sysroot-headers-suffix
13707 Print the suffix added to the target sysroot when searching for
13708 headers, or give an error if the compiler is not configured with such
13709 a suffix---and don't do anything else.
13711 @item -dumpmachine
13712 @opindex dumpmachine
13713 Print the compiler's target machine (for example,
13714 @samp{i686-pc-linux-gnu})---and don't do anything else.
13716 @item -dumpversion
13717 @opindex dumpversion
13718 Print the compiler version (for example, @code{3.0})---and don't do
13719 anything else.
13721 @item -dumpspecs
13722 @opindex dumpspecs
13723 Print the compiler's built-in specs---and don't do anything else.  (This
13724 is used when GCC itself is being built.)  @xref{Spec Files}.
13725 @end table
13727 @node Submodel Options
13728 @section Machine-Dependent Options
13729 @cindex submodel options
13730 @cindex specifying hardware config
13731 @cindex hardware models and configurations, specifying
13732 @cindex target-dependent options
13733 @cindex machine-dependent options
13735 Each target machine supported by GCC can have its own options---for
13736 example, to allow you to compile for a particular processor variant or
13737 ABI, or to control optimizations specific to that machine.  By
13738 convention, the names of machine-specific options start with
13739 @samp{-m}.
13741 Some configurations of the compiler also support additional target-specific
13742 options, usually for compatibility with other compilers on the same
13743 platform.
13745 @c This list is ordered alphanumerically by subsection name.
13746 @c It should be the same order and spelling as these options are listed
13747 @c in Machine Dependent Options
13749 @menu
13750 * AArch64 Options::
13751 * Adapteva Epiphany Options::
13752 * ARC Options::
13753 * ARM Options::
13754 * AVR Options::
13755 * Blackfin Options::
13756 * C6X Options::
13757 * CRIS Options::
13758 * CR16 Options::
13759 * Darwin Options::
13760 * DEC Alpha Options::
13761 * FR30 Options::
13762 * FT32 Options::
13763 * FRV Options::
13764 * GNU/Linux Options::
13765 * H8/300 Options::
13766 * HPPA Options::
13767 * IA-64 Options::
13768 * LM32 Options::
13769 * M32C Options::
13770 * M32R/D Options::
13771 * M680x0 Options::
13772 * MCore Options::
13773 * MeP Options::
13774 * MicroBlaze Options::
13775 * MIPS Options::
13776 * MMIX Options::
13777 * MN10300 Options::
13778 * Moxie Options::
13779 * MSP430 Options::
13780 * NDS32 Options::
13781 * Nios II Options::
13782 * Nvidia PTX Options::
13783 * PDP-11 Options::
13784 * picoChip Options::
13785 * PowerPC Options::
13786 * RL78 Options::
13787 * RS/6000 and PowerPC Options::
13788 * RX Options::
13789 * S/390 and zSeries Options::
13790 * Score Options::
13791 * SH Options::
13792 * Solaris 2 Options::
13793 * SPARC Options::
13794 * SPU Options::
13795 * System V Options::
13796 * TILE-Gx Options::
13797 * TILEPro Options::
13798 * V850 Options::
13799 * VAX Options::
13800 * Visium Options::
13801 * VMS Options::
13802 * VxWorks Options::
13803 * x86 Options::
13804 * x86 Windows Options::
13805 * Xstormy16 Options::
13806 * Xtensa Options::
13807 * zSeries Options::
13808 @end menu
13810 @node AArch64 Options
13811 @subsection AArch64 Options
13812 @cindex AArch64 Options
13814 These options are defined for AArch64 implementations:
13816 @table @gcctabopt
13818 @item -mabi=@var{name}
13819 @opindex mabi
13820 Generate code for the specified data model.  Permissible values
13821 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13822 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13823 but long int and pointers are 64 bits.
13825 The default depends on the specific target configuration.  Note that
13826 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13827 entire program with the same ABI, and link with a compatible set of libraries.
13829 @item -mbig-endian
13830 @opindex mbig-endian
13831 Generate big-endian code.  This is the default when GCC is configured for an
13832 @samp{aarch64_be-*-*} target.
13834 @item -mgeneral-regs-only
13835 @opindex mgeneral-regs-only
13836 Generate code which uses only the general-purpose registers.  This will prevent
13837 the compiler from using floating-point and Advanced SIMD registers but will not
13838 impose any restrictions on the assembler.
13840 @item -mlittle-endian
13841 @opindex mlittle-endian
13842 Generate little-endian code.  This is the default when GCC is configured for an
13843 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13845 @item -mcmodel=tiny
13846 @opindex mcmodel=tiny
13847 Generate code for the tiny code model.  The program and its statically defined
13848 symbols must be within 1MB of each other.  Programs can be statically or
13849 dynamically linked.
13851 @item -mcmodel=small
13852 @opindex mcmodel=small
13853 Generate code for the small code model.  The program and its statically defined
13854 symbols must be within 4GB of each other.  Programs can be statically or
13855 dynamically linked.  This is the default code model.
13857 @item -mcmodel=large
13858 @opindex mcmodel=large
13859 Generate code for the large code model.  This makes no assumptions about
13860 addresses and sizes of sections.  Programs can be statically linked only.
13862 @item -mstrict-align
13863 @opindex mstrict-align
13864 Avoid generating memory accesses that may not be aligned on a natural object
13865 boundary as described in the architecture specification.
13867 @item -momit-leaf-frame-pointer
13868 @itemx -mno-omit-leaf-frame-pointer
13869 @opindex momit-leaf-frame-pointer
13870 @opindex mno-omit-leaf-frame-pointer
13871 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13872 default.
13874 @item -mtls-dialect=desc
13875 @opindex mtls-dialect=desc
13876 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13877 of TLS variables.  This is the default.
13879 @item -mtls-dialect=traditional
13880 @opindex mtls-dialect=traditional
13881 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13882 of TLS variables.
13884 @item -mtls-size=@var{size}
13885 @opindex mtls-size
13886 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13887 This option requires binutils 2.26 or newer.
13889 @item -mfix-cortex-a53-835769
13890 @itemx -mno-fix-cortex-a53-835769
13891 @opindex mfix-cortex-a53-835769
13892 @opindex mno-fix-cortex-a53-835769
13893 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13894 This involves inserting a NOP instruction between memory instructions and
13895 64-bit integer multiply-accumulate instructions.
13897 @item -mfix-cortex-a53-843419
13898 @itemx -mno-fix-cortex-a53-843419
13899 @opindex mfix-cortex-a53-843419
13900 @opindex mno-fix-cortex-a53-843419
13901 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
13902 This erratum workaround is made at link time and this will only pass the
13903 corresponding flag to the linker.
13905 @item -mlow-precision-recip-sqrt
13906 @item -mno-low-precision-recip-sqrt
13907 @opindex mlow-precision-recip-sqrt
13908 @opindex mno-low-precision-recip-sqrt
13909 Enable or disable the reciprocal square root approximation.
13910 This option only has an effect if @option{-ffast-math} or
13911 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13912 precision of reciprocal square root results to about 16 bits for
13913 single precision and to 32 bits for double precision.
13915 @item -mlow-precision-sqrt
13916 @item -mno-low-precision-sqrt
13917 @opindex -mlow-precision-sqrt
13918 @opindex -mno-low-precision-sqrt
13919 Enable or disable the square root approximation.
13920 This option only has an effect if @option{-ffast-math} or
13921 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13922 precision of square root results to about 16 bits for
13923 single precision and to 32 bits for double precision.
13924 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
13926 @item -mlow-precision-div
13927 @item -mno-low-precision-div
13928 @opindex -mlow-precision-div
13929 @opindex -mno-low-precision-div
13930 Enable or disable the division approximation.
13931 This option only has an effect if @option{-ffast-math} or
13932 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13933 precision of division results to about 16 bits for
13934 single precision and to 32 bits for double precision.
13936 @item -march=@var{name}
13937 @opindex march
13938 Specify the name of the target architecture and, optionally, one or
13939 more feature modifiers.  This option has the form
13940 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
13942 The permissible values for @var{arch} are @samp{armv8-a},
13943 @samp{armv8.1-a}, @samp{armv8.2-a} or @var{native}.
13945 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
13946 support for the ARMv8.2-A architecture extensions.
13948 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
13949 support for the ARMv8.1-A architecture extension.  In particular, it
13950 enables the @samp{+crc} and @samp{+lse} features.
13952 The value @samp{native} is available on native AArch64 GNU/Linux and
13953 causes the compiler to pick the architecture of the host system.  This
13954 option has no effect if the compiler is unable to recognize the
13955 architecture of the host system,
13957 The permissible values for @var{feature} are listed in the sub-section
13958 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13959 Feature Modifiers}.  Where conflicting feature modifiers are
13960 specified, the right-most feature is used.
13962 GCC uses @var{name} to determine what kind of instructions it can emit
13963 when generating assembly code.  If @option{-march} is specified
13964 without either of @option{-mtune} or @option{-mcpu} also being
13965 specified, the code is tuned to perform well across a range of target
13966 processors implementing the target architecture.
13968 @item -mtune=@var{name}
13969 @opindex mtune
13970 Specify the name of the target processor for which GCC should tune the
13971 performance of the code.  Permissible values for this option are:
13972 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
13973 @samp{cortex-a72}, @samp{cortex-a73}, @samp{exynos-m1}, @samp{falkor},
13974 @samp{qdf24xx}, @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
13975 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
13976 @samp{thunderxt83}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
13977 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}, @samp{native}.
13979 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
13980 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}
13981 specify that GCC should tune for a big.LITTLE system.
13983 Additionally on native AArch64 GNU/Linux systems the value
13984 @samp{native} tunes performance to the host system.  This option has no effect
13985 if the compiler is unable to recognize the processor of the host system.
13987 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
13988 are specified, the code is tuned to perform well across a range
13989 of target processors.
13991 This option cannot be suffixed by feature modifiers.
13993 @item -mcpu=@var{name}
13994 @opindex mcpu
13995 Specify the name of the target processor, optionally suffixed by one
13996 or more feature modifiers.  This option has the form
13997 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
13998 the permissible values for @var{cpu} are the same as those available
13999 for @option{-mtune}.  The permissible values for @var{feature} are
14000 documented in the sub-section on
14001 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14002 Feature Modifiers}.  Where conflicting feature modifiers are
14003 specified, the right-most feature is used.
14005 GCC uses @var{name} to determine what kind of instructions it can emit when
14006 generating assembly code (as if by @option{-march}) and to determine
14007 the target processor for which to tune for performance (as if
14008 by @option{-mtune}).  Where this option is used in conjunction
14009 with @option{-march} or @option{-mtune}, those options take precedence
14010 over the appropriate part of this option.
14012 @item -moverride=@var{string}
14013 @opindex moverride
14014 Override tuning decisions made by the back-end in response to a
14015 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14016 for @var{string} in this option are not guaranteed to be consistent
14017 across releases.
14019 This option is only intended to be useful when developing GCC.
14021 @item -mpc-relative-literal-loads
14022 @opindex mpc-relative-literal-loads
14023 Enable PC-relative literal loads.  With this option literal pools are
14024 accessed using a single instruction and emitted after each function.  This
14025 limits the maximum size of functions to 1MB.  This is enabled by default for
14026 @option{-mcmodel=tiny}.
14028 @end table
14030 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14031 @anchor{aarch64-feature-modifiers}
14032 @cindex @option{-march} feature modifiers
14033 @cindex @option{-mcpu} feature modifiers
14034 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14035 the following and their inverses @option{no@var{feature}}:
14037 @table @samp
14038 @item crc
14039 Enable CRC extension.  This is on by default for
14040 @option{-march=armv8.1-a}.
14041 @item crypto
14042 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14043 instructions.
14044 @item fp
14045 Enable floating-point instructions.  This is on by default for all possible
14046 values for options @option{-march} and @option{-mcpu}.
14047 @item simd
14048 Enable Advanced SIMD instructions.  This also enables floating-point
14049 instructions.  This is on by default for all possible values for options
14050 @option{-march} and @option{-mcpu}.
14051 @item lse
14052 Enable Large System Extension instructions.  This is on by default for
14053 @option{-march=armv8.1-a}.
14054 @item fp16
14055 Enable FP16 extension.  This also enables floating-point instructions.
14057 @end table
14059 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14060 Conversely, @option{nofp} implies @option{nosimd}, which implies
14061 @option{nocrypto}.
14063 @node Adapteva Epiphany Options
14064 @subsection Adapteva Epiphany Options
14066 These @samp{-m} options are defined for Adapteva Epiphany:
14068 @table @gcctabopt
14069 @item -mhalf-reg-file
14070 @opindex mhalf-reg-file
14071 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14072 That allows code to run on hardware variants that lack these registers.
14074 @item -mprefer-short-insn-regs
14075 @opindex mprefer-short-insn-regs
14076 Preferentially allocate registers that allow short instruction generation.
14077 This can result in increased instruction count, so this may either reduce or
14078 increase overall code size.
14080 @item -mbranch-cost=@var{num}
14081 @opindex mbranch-cost
14082 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14083 This cost is only a heuristic and is not guaranteed to produce
14084 consistent results across releases.
14086 @item -mcmove
14087 @opindex mcmove
14088 Enable the generation of conditional moves.
14090 @item -mnops=@var{num}
14091 @opindex mnops
14092 Emit @var{num} NOPs before every other generated instruction.
14094 @item -mno-soft-cmpsf
14095 @opindex mno-soft-cmpsf
14096 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14097 and test the flags.  This is faster than a software comparison, but can
14098 get incorrect results in the presence of NaNs, or when two different small
14099 numbers are compared such that their difference is calculated as zero.
14100 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14101 software comparisons.
14103 @item -mstack-offset=@var{num}
14104 @opindex mstack-offset
14105 Set the offset between the top of the stack and the stack pointer.
14106 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14107 can be used by leaf functions without stack allocation.
14108 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14109 Note also that this option changes the ABI; compiling a program with a
14110 different stack offset than the libraries have been compiled with
14111 generally does not work.
14112 This option can be useful if you want to evaluate if a different stack
14113 offset would give you better code, but to actually use a different stack
14114 offset to build working programs, it is recommended to configure the
14115 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14117 @item -mno-round-nearest
14118 @opindex mno-round-nearest
14119 Make the scheduler assume that the rounding mode has been set to
14120 truncating.  The default is @option{-mround-nearest}.
14122 @item -mlong-calls
14123 @opindex mlong-calls
14124 If not otherwise specified by an attribute, assume all calls might be beyond
14125 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14126 function address into a register before performing a (otherwise direct) call.
14127 This is the default.
14129 @item -mshort-calls
14130 @opindex short-calls
14131 If not otherwise specified by an attribute, assume all direct calls are
14132 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14133 for direct calls.  The default is @option{-mlong-calls}.
14135 @item -msmall16
14136 @opindex msmall16
14137 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14138 apply to function addresses for which @option{-mlong-calls} semantics
14139 are in effect.
14141 @item -mfp-mode=@var{mode}
14142 @opindex mfp-mode
14143 Set the prevailing mode of the floating-point unit.
14144 This determines the floating-point mode that is provided and expected
14145 at function call and return time.  Making this mode match the mode you
14146 predominantly need at function start can make your programs smaller and
14147 faster by avoiding unnecessary mode switches.
14149 @var{mode} can be set to one the following values:
14151 @table @samp
14152 @item caller
14153 Any mode at function entry is valid, and retained or restored when
14154 the function returns, and when it calls other functions.
14155 This mode is useful for compiling libraries or other compilation units
14156 you might want to incorporate into different programs with different
14157 prevailing FPU modes, and the convenience of being able to use a single
14158 object file outweighs the size and speed overhead for any extra
14159 mode switching that might be needed, compared with what would be needed
14160 with a more specific choice of prevailing FPU mode.
14162 @item truncate
14163 This is the mode used for floating-point calculations with
14164 truncating (i.e.@: round towards zero) rounding mode.  That includes
14165 conversion from floating point to integer.
14167 @item round-nearest
14168 This is the mode used for floating-point calculations with
14169 round-to-nearest-or-even rounding mode.
14171 @item int
14172 This is the mode used to perform integer calculations in the FPU, e.g.@:
14173 integer multiply, or integer multiply-and-accumulate.
14174 @end table
14176 The default is @option{-mfp-mode=caller}
14178 @item -mnosplit-lohi
14179 @itemx -mno-postinc
14180 @itemx -mno-postmodify
14181 @opindex mnosplit-lohi
14182 @opindex mno-postinc
14183 @opindex mno-postmodify
14184 Code generation tweaks that disable, respectively, splitting of 32-bit
14185 loads, generation of post-increment addresses, and generation of
14186 post-modify addresses.  The defaults are @option{msplit-lohi},
14187 @option{-mpost-inc}, and @option{-mpost-modify}.
14189 @item -mnovect-double
14190 @opindex mno-vect-double
14191 Change the preferred SIMD mode to SImode.  The default is
14192 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14194 @item -max-vect-align=@var{num}
14195 @opindex max-vect-align
14196 The maximum alignment for SIMD vector mode types.
14197 @var{num} may be 4 or 8.  The default is 8.
14198 Note that this is an ABI change, even though many library function
14199 interfaces are unaffected if they don't use SIMD vector modes
14200 in places that affect size and/or alignment of relevant types.
14202 @item -msplit-vecmove-early
14203 @opindex msplit-vecmove-early
14204 Split vector moves into single word moves before reload.  In theory this
14205 can give better register allocation, but so far the reverse seems to be
14206 generally the case.
14208 @item -m1reg-@var{reg}
14209 @opindex m1reg-
14210 Specify a register to hold the constant @minus{}1, which makes loading small negative
14211 constants and certain bitmasks faster.
14212 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14213 which specify use of that register as a fixed register,
14214 and @samp{none}, which means that no register is used for this
14215 purpose.  The default is @option{-m1reg-none}.
14217 @end table
14219 @node ARC Options
14220 @subsection ARC Options
14221 @cindex ARC options
14223 The following options control the architecture variant for which code
14224 is being compiled:
14226 @c architecture variants
14227 @table @gcctabopt
14229 @item -mbarrel-shifter
14230 @opindex mbarrel-shifter
14231 Generate instructions supported by barrel shifter.  This is the default
14232 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14234 @item -mcpu=@var{cpu}
14235 @opindex mcpu
14236 Set architecture type, register usage, and instruction scheduling
14237 parameters for @var{cpu}.  There are also shortcut alias options
14238 available for backward compatibility and convenience.  Supported
14239 values for @var{cpu} are
14241 @table @samp
14242 @opindex mA6
14243 @opindex mARC600
14244 @item arc600
14245 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14247 @item arc601
14248 @opindex mARC601
14249 Compile for ARC601.  Alias: @option{-mARC601}.
14251 @item arc700
14252 @opindex mA7
14253 @opindex mARC700
14254 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14255 This is the default when configured with @option{--with-cpu=arc700}@.
14257 @item arcem
14258 Compile for ARC EM.
14260 @item archs
14261 Compile for ARC HS.
14263 @item em
14264 @opindex em
14265 Compile for ARC EM cpu with no hardware extension.
14267 @item em4
14268 @opindex em4
14269 Compile for ARC EM4 cpu.
14271 @item em4_dmips
14272 @opindex em4_dmips
14273 Compile for ARC EM4 DMIPS cpu.
14275 @item em4_fpus
14276 @opindex em4_fpus
14277 Compile for ARC EM4 DMIPS cpu with single precision floating point
14278 extension.
14280 @item em4_fpuda
14281 @opindex em4_fpuda
14282 Compile for ARC EM4 DMIPS cpu with single precision floating point and
14283 double assists instructions.
14285 @item hs
14286 @opindex hs
14287 Compile for ARC HS cpu with no hardware extension, except the atomic
14288 instructions.
14290 @item hs34
14291 @opindex hs34
14292 Compile for ARC HS34 cpu.
14294 @item hs38
14295 @opindex hs38
14296 Compile for ARC HS38 cpu.
14298 @item hs38_linux
14299 @opindex hs38_linux
14300 Compile for ARC HS38 cpu with all hardware extensions on.
14302 @item arc600_norm
14303 @opindex arc600_norm
14304 Compile for ARC 600 cpu with norm instruction enabled.
14306 @item arc600_mul32x16
14307 @opindex arc600_mul32x16
14308 Compile for ARC 600 cpu with norm and mul32x16 instructions enabled.
14310 @item arc600_mul64
14311 @opindex arc600_mul64
14312 Compile for ARC 600 cpu with norm and mul64 instructions enabled.
14314 @item arc601_norm
14315 @opindex arc601_norm
14316 Compile for ARC 601 cpu with norm instruction enabled.
14318 @item arc601_mul32x16
14319 @opindex arc601_mul32x16
14320 Compile for ARC 601 cpu with norm and mul32x16 instructions enabled.
14322 @item arc601_mul64
14323 @opindex arc601_mul64
14324 Compile for ARC 601 cpu with norm and mul64 instructions enabled.
14326 @item nps400
14327 @opindex nps400
14328 Compile for ARC 700 on NPS400 chip.
14330 @end table
14332 @item -mdpfp
14333 @opindex mdpfp
14334 @itemx -mdpfp-compact
14335 @opindex mdpfp-compact
14336 FPX: Generate Double Precision FPX instructions, tuned for the compact
14337 implementation.
14339 @item -mdpfp-fast
14340 @opindex mdpfp-fast
14341 FPX: Generate Double Precision FPX instructions, tuned for the fast
14342 implementation.
14344 @item -mno-dpfp-lrsr
14345 @opindex mno-dpfp-lrsr
14346 Disable LR and SR instructions from using FPX extension aux registers.
14348 @item -mea
14349 @opindex mea
14350 Generate Extended arithmetic instructions.  Currently only
14351 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14352 supported.  This is always enabled for @option{-mcpu=ARC700}.
14354 @item -mno-mpy
14355 @opindex mno-mpy
14356 Do not generate mpy instructions for ARC700.  This instruction is
14357 deprecated.
14359 @item -mmul32x16
14360 @opindex mmul32x16
14361 Generate 32x16 bit multiply and mac instructions.
14363 @item -mmul64
14364 @opindex mmul64
14365 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
14367 @item -mnorm
14368 @opindex mnorm
14369 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
14370 is in effect.
14372 @item -mspfp
14373 @opindex mspfp
14374 @itemx -mspfp-compact
14375 @opindex mspfp-compact
14376 FPX: Generate Single Precision FPX instructions, tuned for the compact
14377 implementation.
14379 @item -mspfp-fast
14380 @opindex mspfp-fast
14381 FPX: Generate Single Precision FPX instructions, tuned for the fast
14382 implementation.
14384 @item -msimd
14385 @opindex msimd
14386 Enable generation of ARC SIMD instructions via target-specific
14387 builtins.  Only valid for @option{-mcpu=ARC700}.
14389 @item -msoft-float
14390 @opindex msoft-float
14391 This option ignored; it is provided for compatibility purposes only.
14392 Software floating point code is emitted by default, and this default
14393 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
14394 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
14395 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
14397 @item -mswap
14398 @opindex mswap
14399 Generate swap instructions.
14401 @item -matomic
14402 @opindex matomic
14403 This enables Locked Load/Store Conditional extension to implement
14404 atomic memopry built-in functions.  Not available for ARC 6xx or ARC
14405 EM cores.
14407 @item -mdiv-rem
14408 @opindex mdiv-rem
14409 Enable DIV/REM instructions for ARCv2 cores.
14411 @item -mcode-density
14412 @opindex mcode-density
14413 Enable code density instructions for ARC EM, default on for ARC HS.
14415 @item -mll64
14416 @opindex mll64
14417 Enable double load/store operations for ARC HS cores.
14419 @item -mtp-regno=@var{regno}
14420 @opindex mtp-regno
14421 Specify thread pointer register number.
14423 @item -mmpy-option=@var{multo}
14424 @opindex mmpy-option
14425 Compile ARCv2 code with a multiplier design option.  @samp{wlh1} is
14426 the default value.  The recognized values for @var{multo} are:
14428 @table @samp
14429 @item 0
14430 No multiplier available.
14432 @item 1
14433 @opindex w
14434 The multiply option is set to w: 16x16 multiplier, fully pipelined.
14435 The following instructions are enabled: MPYW, and MPYUW.
14437 @item 2
14438 @opindex wlh1
14439 The multiply option is set to wlh1: 32x32 multiplier, fully
14440 pipelined (1 stage).  The following instructions are additionally
14441 enabled: MPY, MPYU, MPYM, MPYMU, and MPY_S.
14443 @item 3
14444 @opindex wlh2
14445 The multiply option is set to wlh2: 32x32 multiplier, fully pipelined
14446 (2 stages).  The following instructions are additionally enabled: MPY,
14447 MPYU, MPYM, MPYMU, and MPY_S.
14449 @item 4
14450 @opindex wlh3
14451 The multiply option is set to wlh3: Two 16x16 multiplier, blocking,
14452 sequential.  The following instructions are additionally enabled: MPY,
14453 MPYU, MPYM, MPYMU, and MPY_S.
14455 @item 5
14456 @opindex wlh4
14457 The multiply option is set to wlh4: One 16x16 multiplier, blocking,
14458 sequential.  The following instructions are additionally enabled: MPY,
14459 MPYU, MPYM, MPYMU, and MPY_S.
14461 @item 6
14462 @opindex wlh5
14463 The multiply option is set to wlh5: One 32x4 multiplier, blocking,
14464 sequential.  The following instructions are additionally enabled: MPY,
14465 MPYU, MPYM, MPYMU, and MPY_S.
14467 @end table
14469 This option is only available for ARCv2 cores@.
14471 @item -mfpu=@var{fpu}
14472 @opindex mfpu
14473 Enables specific floating-point hardware extension for ARCv2
14474 core.  Supported values for @var{fpu} are:
14476 @table @samp
14478 @item fpus
14479 @opindex fpus
14480 Enables support for single precision floating point hardware
14481 extensions@.
14483 @item fpud
14484 @opindex fpud
14485 Enables support for double precision floating point hardware
14486 extensions.  The single precision floating point extension is also
14487 enabled.  Not available for ARC EM@.
14489 @item fpuda
14490 @opindex fpuda
14491 Enables support for double precision floating point hardware
14492 extensions using double precision assist instructions.  The single
14493 precision floating point extension is also enabled.  This option is
14494 only available for ARC EM@.
14496 @item fpuda_div
14497 @opindex fpuda_div
14498 Enables support for double precision floating point hardware
14499 extensions using double precision assist instructions, and simple
14500 precision square-root and divide hardware extensions.  The single
14501 precision floating point extension is also enabled.  This option is
14502 only available for ARC EM@.
14504 @item fpuda_fma
14505 @opindex fpuda_fma
14506 Enables support for double precision floating point hardware
14507 extensions using double precision assist instructions, and simple
14508 precision fused multiple and add hardware extension.  The single
14509 precision floating point extension is also enabled.  This option is
14510 only available for ARC EM@.
14512 @item fpuda_all
14513 @opindex fpuda_all
14514 Enables support for double precision floating point hardware
14515 extensions using double precision assist instructions, and all simple
14516 precision hardware extensions.  The single precision floating point
14517 extension is also enabled.  This option is only available for ARC EM@.
14519 @item fpus_div
14520 @opindex fpus_div
14521 Enables support for single precision floating point, and single
14522 precision square-root and divide hardware extensions@.
14524 @item fpud_div
14525 @opindex fpud_div
14526 Enables support for double precision floating point, and double
14527 precision square-root and divide hardware extensions.  This option
14528 includes option @samp{fpus_div}. Not available for ARC EM@.
14530 @item fpus_fma
14531 @opindex fpus_fma
14532 Enables support for single precision floating point, and single
14533 precision fused multiple and add hardware extensions@.
14535 @item fpud_fma
14536 @opindex fpud_fma
14537 Enables support for double precision floating point, and double
14538 precision fused multiple and add hardware extensions.  This option
14539 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14541 @item fpus_all
14542 @opindex fpus_all
14543 Enables support for all single precision floating point hardware
14544 extensions@.
14546 @item fpud_all
14547 @opindex fpud_all
14548 Enables support for all single and double precision floating point
14549 hardware extensions.  Not available for ARC EM@.
14551 @end table
14553 @end table
14555 The following options are passed through to the assembler, and also
14556 define preprocessor macro symbols.
14558 @c Flags used by the assembler, but for which we define preprocessor
14559 @c macro symbols as well.
14560 @table @gcctabopt
14561 @item -mdsp-packa
14562 @opindex mdsp-packa
14563 Passed down to the assembler to enable the DSP Pack A extensions.
14564 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14565 deprecated.
14567 @item -mdvbf
14568 @opindex mdvbf
14569 Passed down to the assembler to enable the dual viterbi butterfly
14570 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14571 option is deprecated.
14573 @c ARC700 4.10 extension instruction
14574 @item -mlock
14575 @opindex mlock
14576 Passed down to the assembler to enable the Locked Load/Store
14577 Conditional extension.  Also sets the preprocessor symbol
14578 @code{__Xlock}.
14580 @item -mmac-d16
14581 @opindex mmac-d16
14582 Passed down to the assembler.  Also sets the preprocessor symbol
14583 @code{__Xxmac_d16}.  This option is deprecated.
14585 @item -mmac-24
14586 @opindex mmac-24
14587 Passed down to the assembler.  Also sets the preprocessor symbol
14588 @code{__Xxmac_24}.  This option is deprecated.
14590 @c ARC700 4.10 extension instruction
14591 @item -mrtsc
14592 @opindex mrtsc
14593 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
14594 extension instruction.  Also sets the preprocessor symbol
14595 @code{__Xrtsc}.  This option is deprecated.
14597 @c ARC700 4.10 extension instruction
14598 @item -mswape
14599 @opindex mswape
14600 Passed down to the assembler to enable the swap byte ordering
14601 extension instruction.  Also sets the preprocessor symbol
14602 @code{__Xswape}.
14604 @item -mtelephony
14605 @opindex mtelephony
14606 Passed down to the assembler to enable dual and single operand
14607 instructions for telephony.  Also sets the preprocessor symbol
14608 @code{__Xtelephony}.  This option is deprecated.
14610 @item -mxy
14611 @opindex mxy
14612 Passed down to the assembler to enable the XY Memory extension.  Also
14613 sets the preprocessor symbol @code{__Xxy}.
14615 @end table
14617 The following options control how the assembly code is annotated:
14619 @c Assembly annotation options
14620 @table @gcctabopt
14621 @item -misize
14622 @opindex misize
14623 Annotate assembler instructions with estimated addresses.
14625 @item -mannotate-align
14626 @opindex mannotate-align
14627 Explain what alignment considerations lead to the decision to make an
14628 instruction short or long.
14630 @end table
14632 The following options are passed through to the linker:
14634 @c options passed through to the linker
14635 @table @gcctabopt
14636 @item -marclinux
14637 @opindex marclinux
14638 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14639 This option is enabled by default in tool chains built for
14640 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14641 when profiling is not requested.
14643 @item -marclinux_prof
14644 @opindex marclinux_prof
14645 Passed through to the linker, to specify use of the
14646 @code{arclinux_prof} emulation.  This option is enabled by default in
14647 tool chains built for @w{@code{arc-linux-uclibc}} and
14648 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14650 @end table
14652 The following options control the semantics of generated code:
14654 @c semantically relevant code generation options
14655 @table @gcctabopt
14656 @item -mlong-calls
14657 @opindex mlong-calls
14658 Generate call insns as register indirect calls, thus providing access
14659 to the full 32-bit address range.
14661 @item -mmedium-calls
14662 @opindex mmedium-calls
14663 Don't use less than 25 bit addressing range for calls, which is the
14664 offset available for an unconditional branch-and-link
14665 instruction.  Conditional execution of function calls is suppressed, to
14666 allow use of the 25-bit range, rather than the 21-bit range with
14667 conditional branch-and-link.  This is the default for tool chains built
14668 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14670 @item -mno-sdata
14671 @opindex mno-sdata
14672 Do not generate sdata references.  This is the default for tool chains
14673 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14674 targets.
14676 @item -mvolatile-cache
14677 @opindex mvolatile-cache
14678 Use ordinarily cached memory accesses for volatile references.  This is the
14679 default.
14681 @item -mno-volatile-cache
14682 @opindex mno-volatile-cache
14683 Enable cache bypass for volatile references.
14685 @end table
14687 The following options fine tune code generation:
14688 @c code generation tuning options
14689 @table @gcctabopt
14690 @item -malign-call
14691 @opindex malign-call
14692 Do alignment optimizations for call instructions.
14694 @item -mauto-modify-reg
14695 @opindex mauto-modify-reg
14696 Enable the use of pre/post modify with register displacement.
14698 @item -mbbit-peephole
14699 @opindex mbbit-peephole
14700 Enable bbit peephole2.
14702 @item -mno-brcc
14703 @opindex mno-brcc
14704 This option disables a target-specific pass in @file{arc_reorg} to
14705 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
14706 generation driven by the combiner pass.
14708 @item -mcase-vector-pcrel
14709 @opindex mcase-vector-pcrel
14710 Use pc-relative switch case tables - this enables case table shortening.
14711 This is the default for @option{-Os}.
14713 @item -mcompact-casesi
14714 @opindex mcompact-casesi
14715 Enable compact casesi pattern.  This is the default for @option{-Os},
14716 and only available for ARCv1 cores.
14718 @item -mno-cond-exec
14719 @opindex mno-cond-exec
14720 Disable ARCompact specific pass to generate conditional execution instructions.
14721 Due to delay slot scheduling and interactions between operand numbers,
14722 literal sizes, instruction lengths, and the support for conditional execution,
14723 the target-independent pass to generate conditional execution is often lacking,
14724 so the ARC port has kept a special pass around that tries to find more
14725 conditional execution generating opportunities after register allocation,
14726 branch shortening, and delay slot scheduling have been done.  This pass
14727 generally, but not always, improves performance and code size, at the cost of
14728 extra compilation time, which is why there is an option to switch it off.
14729 If you have a problem with call instructions exceeding their allowable
14730 offset range because they are conditionalized, you should consider using
14731 @option{-mmedium-calls} instead.
14733 @item -mearly-cbranchsi
14734 @opindex mearly-cbranchsi
14735 Enable pre-reload use of the cbranchsi pattern.
14737 @item -mexpand-adddi
14738 @opindex mexpand-adddi
14739 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
14740 @code{add.f}, @code{adc} etc.
14742 @item -mindexed-loads
14743 @opindex mindexed-loads
14744 Enable the use of indexed loads.  This can be problematic because some
14745 optimizers then assume that indexed stores exist, which is not
14746 the case.
14748 @opindex mlra
14749 Enable Local Register Allocation.  This is still experimental for ARC,
14750 so by default the compiler uses standard reload
14751 (i.e. @option{-mno-lra}).
14753 @item -mlra-priority-none
14754 @opindex mlra-priority-none
14755 Don't indicate any priority for target registers.
14757 @item -mlra-priority-compact
14758 @opindex mlra-priority-compact
14759 Indicate target register priority for r0..r3 / r12..r15.
14761 @item -mlra-priority-noncompact
14762 @opindex mlra-priority-noncompact
14763 Reduce target register priority for r0..r3 / r12..r15.
14765 @item -mno-millicode
14766 @opindex mno-millicode
14767 When optimizing for size (using @option{-Os}), prologues and epilogues
14768 that have to save or restore a large number of registers are often
14769 shortened by using call to a special function in libgcc; this is
14770 referred to as a @emph{millicode} call.  As these calls can pose
14771 performance issues, and/or cause linking issues when linking in a
14772 nonstandard way, this option is provided to turn off millicode call
14773 generation.
14775 @item -mmixed-code
14776 @opindex mmixed-code
14777 Tweak register allocation to help 16-bit instruction generation.
14778 This generally has the effect of decreasing the average instruction size
14779 while increasing the instruction count.
14781 @item -mq-class
14782 @opindex mq-class
14783 Enable 'q' instruction alternatives.
14784 This is the default for @option{-Os}.
14786 @item -mRcq
14787 @opindex mRcq
14788 Enable Rcq constraint handling - most short code generation depends on this.
14789 This is the default.
14791 @item -mRcw
14792 @opindex mRcw
14793 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
14794 This is the default.
14796 @item -msize-level=@var{level}
14797 @opindex msize-level
14798 Fine-tune size optimization with regards to instruction lengths and alignment.
14799 The recognized values for @var{level} are:
14800 @table @samp
14801 @item 0
14802 No size optimization.  This level is deprecated and treated like @samp{1}.
14804 @item 1
14805 Short instructions are used opportunistically.
14807 @item 2
14808 In addition, alignment of loops and of code after barriers are dropped.
14810 @item 3
14811 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14813 @end table
14815 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14816 the behavior when this is not set is equivalent to level @samp{1}.
14818 @item -mtune=@var{cpu}
14819 @opindex mtune
14820 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14821 by @option{-mcpu=}.
14823 Supported values for @var{cpu} are
14825 @table @samp
14826 @item ARC600
14827 Tune for ARC600 cpu.
14829 @item ARC601
14830 Tune for ARC601 cpu.
14832 @item ARC700
14833 Tune for ARC700 cpu with standard multiplier block.
14835 @item ARC700-xmac
14836 Tune for ARC700 cpu with XMAC block.
14838 @item ARC725D
14839 Tune for ARC725D cpu.
14841 @item ARC750D
14842 Tune for ARC750D cpu.
14844 @end table
14846 @item -mmultcost=@var{num}
14847 @opindex mmultcost
14848 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14849 normal instruction.
14851 @item -munalign-prob-threshold=@var{probability}
14852 @opindex munalign-prob-threshold
14853 Set probability threshold for unaligning branches.
14854 When tuning for @samp{ARC700} and optimizing for speed, branches without
14855 filled delay slot are preferably emitted unaligned and long, unless
14856 profiling indicates that the probability for the branch to be taken
14857 is below @var{probability}.  @xref{Cross-profiling}.
14858 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14860 @end table
14862 The following options are maintained for backward compatibility, but
14863 are now deprecated and will be removed in a future release:
14865 @c Deprecated options
14866 @table @gcctabopt
14868 @item -margonaut
14869 @opindex margonaut
14870 Obsolete FPX.
14872 @item -mbig-endian
14873 @opindex mbig-endian
14874 @itemx -EB
14875 @opindex EB
14876 Compile code for big endian targets.  Use of these options is now
14877 deprecated.  Users wanting big-endian code, should use the
14878 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
14879 building the tool chain, for which big-endian is the default.
14881 @item -mlittle-endian
14882 @opindex mlittle-endian
14883 @itemx -EL
14884 @opindex EL
14885 Compile code for little endian targets.  Use of these options is now
14886 deprecated.  Users wanting little-endian code should use the
14887 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
14888 building the tool chain, for which little-endian is the default.
14890 @item -mbarrel_shifter
14891 @opindex mbarrel_shifter
14892 Replaced by @option{-mbarrel-shifter}.
14894 @item -mdpfp_compact
14895 @opindex mdpfp_compact
14896 Replaced by @option{-mdpfp-compact}.
14898 @item -mdpfp_fast
14899 @opindex mdpfp_fast
14900 Replaced by @option{-mdpfp-fast}.
14902 @item -mdsp_packa
14903 @opindex mdsp_packa
14904 Replaced by @option{-mdsp-packa}.
14906 @item -mEA
14907 @opindex mEA
14908 Replaced by @option{-mea}.
14910 @item -mmac_24
14911 @opindex mmac_24
14912 Replaced by @option{-mmac-24}.
14914 @item -mmac_d16
14915 @opindex mmac_d16
14916 Replaced by @option{-mmac-d16}.
14918 @item -mspfp_compact
14919 @opindex mspfp_compact
14920 Replaced by @option{-mspfp-compact}.
14922 @item -mspfp_fast
14923 @opindex mspfp_fast
14924 Replaced by @option{-mspfp-fast}.
14926 @item -mtune=@var{cpu}
14927 @opindex mtune
14928 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
14929 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
14930 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
14932 @item -multcost=@var{num}
14933 @opindex multcost
14934 Replaced by @option{-mmultcost}.
14936 @end table
14938 @node ARM Options
14939 @subsection ARM Options
14940 @cindex ARM options
14942 These @samp{-m} options are defined for the ARM port:
14944 @table @gcctabopt
14945 @item -mabi=@var{name}
14946 @opindex mabi
14947 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
14948 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
14950 @item -mapcs-frame
14951 @opindex mapcs-frame
14952 Generate a stack frame that is compliant with the ARM Procedure Call
14953 Standard for all functions, even if this is not strictly necessary for
14954 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
14955 with this option causes the stack frames not to be generated for
14956 leaf functions.  The default is @option{-mno-apcs-frame}.
14957 This option is deprecated.
14959 @item -mapcs
14960 @opindex mapcs
14961 This is a synonym for @option{-mapcs-frame} and is deprecated.
14963 @ignore
14964 @c not currently implemented
14965 @item -mapcs-stack-check
14966 @opindex mapcs-stack-check
14967 Generate code to check the amount of stack space available upon entry to
14968 every function (that actually uses some stack space).  If there is
14969 insufficient space available then either the function
14970 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
14971 called, depending upon the amount of stack space required.  The runtime
14972 system is required to provide these functions.  The default is
14973 @option{-mno-apcs-stack-check}, since this produces smaller code.
14975 @c not currently implemented
14976 @item -mapcs-reentrant
14977 @opindex mapcs-reentrant
14978 Generate reentrant, position-independent code.  The default is
14979 @option{-mno-apcs-reentrant}.
14980 @end ignore
14982 @item -mthumb-interwork
14983 @opindex mthumb-interwork
14984 Generate code that supports calling between the ARM and Thumb
14985 instruction sets.  Without this option, on pre-v5 architectures, the
14986 two instruction sets cannot be reliably used inside one program.  The
14987 default is @option{-mno-thumb-interwork}, since slightly larger code
14988 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
14989 configurations this option is meaningless.
14991 @item -mno-sched-prolog
14992 @opindex mno-sched-prolog
14993 Prevent the reordering of instructions in the function prologue, or the
14994 merging of those instruction with the instructions in the function's
14995 body.  This means that all functions start with a recognizable set
14996 of instructions (or in fact one of a choice from a small set of
14997 different function prologues), and this information can be used to
14998 locate the start of functions inside an executable piece of code.  The
14999 default is @option{-msched-prolog}.
15001 @item -mfloat-abi=@var{name}
15002 @opindex mfloat-abi
15003 Specifies which floating-point ABI to use.  Permissible values
15004 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15006 Specifying @samp{soft} causes GCC to generate output containing
15007 library calls for floating-point operations.
15008 @samp{softfp} allows the generation of code using hardware floating-point
15009 instructions, but still uses the soft-float calling conventions.
15010 @samp{hard} allows generation of floating-point instructions
15011 and uses FPU-specific calling conventions.
15013 The default depends on the specific target configuration.  Note that
15014 the hard-float and soft-float ABIs are not link-compatible; you must
15015 compile your entire program with the same ABI, and link with a
15016 compatible set of libraries.
15018 @item -mlittle-endian
15019 @opindex mlittle-endian
15020 Generate code for a processor running in little-endian mode.  This is
15021 the default for all standard configurations.
15023 @item -mbig-endian
15024 @opindex mbig-endian
15025 Generate code for a processor running in big-endian mode; the default is
15026 to compile code for a little-endian processor.
15028 @item -march=@var{name}
15029 @opindex march
15030 This specifies the name of the target ARM architecture.  GCC uses this
15031 name to determine what kind of instructions it can emit when generating
15032 assembly code.  This option can be used in conjunction with or instead
15033 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
15034 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
15035 @samp{armv5}, @samp{armv5e}, @samp{armv5t}, @samp{armv5te},
15036 @samp{armv6}, @samp{armv6-m}, @samp{armv6j}, @samp{armv6k},
15037 @samp{armv6kz}, @samp{armv6s-m},
15038 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk},
15039 @samp{armv7}, @samp{armv7-a}, @samp{armv7-m}, @samp{armv7-r}, @samp{armv7e-m},
15040 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
15041 @samp{armv8.1-a+crc}, @samp{armv8-m.base}, @samp{armv8-m.main},
15042 @samp{armv8-m.main+dsp}, @samp{iwmmxt}, @samp{iwmmxt2}.
15044 Architecture revisions older than @samp{armv4t} are deprecated.
15046 @option{-march=armv6s-m} is the @samp{armv6-m} architecture with support for
15047 the (now mandatory) SVC instruction.
15049 @option{-march=armv6zk} is an alias for @samp{armv6kz}, existing for backwards
15050 compatibility.
15052 @option{-march=armv7ve} is the @samp{armv7-a} architecture with virtualization
15053 extensions.
15055 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
15056 architecture together with the optional CRC32 extensions.
15058 @option{-march=armv8.1-a} enables compiler support for the ARMv8.1-A
15059 architecture.  This also enables the features provided by
15060 @option{-march=armv8-a+crc}.
15062 @option{-march=armv8.2-a} enables compiler support for the ARMv8.2-A
15063 architecture.  This also enables the features provided by
15064 @option{-march=armv8.1-a}.
15066 @option{-march=armv8.2-a+fp16} enables compiler support for the
15067 ARMv8.2-A architecture with the optional FP16 instructions extension.
15068 This also enables the features provided by @option{-march=armv8.1-a}
15069 and implies @option{-mfp16-format=ieee}.
15071 @option{-march=native} causes the compiler to auto-detect the architecture
15072 of the build computer.  At present, this feature is only supported on
15073 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15074 is unsuccessful the option has no effect.
15076 @item -mtune=@var{name}
15077 @opindex mtune
15078 This option specifies the name of the target ARM processor for
15079 which GCC should tune the performance of the code.
15080 For some ARM implementations better performance can be obtained by using
15081 this option.
15082 Permissible names are: @samp{arm2}, @samp{arm250},
15083 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15084 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15085 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15086 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15087 @samp{arm720},
15088 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15089 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15090 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15091 @samp{strongarm1110},
15092 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15093 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15094 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15095 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15096 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15097 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15098 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15099 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15100 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15101 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
15102 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
15103 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15104 @samp{cortex-m33},
15105 @samp{cortex-m23},
15106 @samp{cortex-m7},
15107 @samp{cortex-m4},
15108 @samp{cortex-m3},
15109 @samp{cortex-m1},
15110 @samp{cortex-m0},
15111 @samp{cortex-m0plus},
15112 @samp{cortex-m1.small-multiply},
15113 @samp{cortex-m0.small-multiply},
15114 @samp{cortex-m0plus.small-multiply},
15115 @samp{exynos-m1},
15116 @samp{falkor},
15117 @samp{qdf24xx},
15118 @samp{marvell-pj4},
15119 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15120 @samp{fa526}, @samp{fa626},
15121 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15122 @samp{xgene1}.
15124 Additionally, this option can specify that GCC should tune the performance
15125 of the code for a big.LITTLE system.  Permissible names are:
15126 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15127 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15128 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
15130 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15131 performance for a blend of processors within architecture @var{arch}.
15132 The aim is to generate code that run well on the current most popular
15133 processors, balancing between optimizations that benefit some CPUs in the
15134 range, and avoiding performance pitfalls of other CPUs.  The effects of
15135 this option may change in future GCC versions as CPU models come and go.
15137 @option{-mtune=native} causes the compiler to auto-detect the CPU
15138 of the build computer.  At present, this feature is only supported on
15139 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15140 unsuccessful the option has no effect.
15142 @item -mcpu=@var{name}
15143 @opindex mcpu
15144 This specifies the name of the target ARM processor.  GCC uses this name
15145 to derive the name of the target ARM architecture (as if specified
15146 by @option{-march}) and the ARM processor type for which to tune for
15147 performance (as if specified by @option{-mtune}).  Where this option
15148 is used in conjunction with @option{-march} or @option{-mtune},
15149 those options take precedence over the appropriate part of this option.
15151 Permissible names for this option are the same as those for
15152 @option{-mtune}.
15154 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15155 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15156 See @option{-mtune} for more information.
15158 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15159 of the build computer.  At present, this feature is only supported on
15160 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15161 is unsuccessful the option has no effect.
15163 @item -mfpu=@var{name}
15164 @opindex mfpu
15165 This specifies what floating-point hardware (or hardware emulation) is
15166 available on the target.  Permissible names are: @samp{vfpv2}, @samp{vfpv3},
15167 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15168 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15169 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15170 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15171 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15172 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15173 is an alias for @samp{vfpv2}.
15175 If @option{-msoft-float} is specified this specifies the format of
15176 floating-point values.
15178 If the selected floating-point hardware includes the NEON extension
15179 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
15180 operations are not generated by GCC's auto-vectorization pass unless
15181 @option{-funsafe-math-optimizations} is also specified.  This is
15182 because NEON hardware does not fully implement the IEEE 754 standard for
15183 floating-point arithmetic (in particular denormal values are treated as
15184 zero), so the use of NEON instructions may lead to a loss of precision.
15186 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}).
15188 @item -mfp16-format=@var{name}
15189 @opindex mfp16-format
15190 Specify the format of the @code{__fp16} half-precision floating-point type.
15191 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15192 the default is @samp{none}, in which case the @code{__fp16} type is not
15193 defined.  @xref{Half-Precision}, for more information.
15195 @item -mstructure-size-boundary=@var{n}
15196 @opindex mstructure-size-boundary
15197 The sizes of all structures and unions are rounded up to a multiple
15198 of the number of bits set by this option.  Permissible values are 8, 32
15199 and 64.  The default value varies for different toolchains.  For the COFF
15200 targeted toolchain the default value is 8.  A value of 64 is only allowed
15201 if the underlying ABI supports it.
15203 Specifying a larger number can produce faster, more efficient code, but
15204 can also increase the size of the program.  Different values are potentially
15205 incompatible.  Code compiled with one value cannot necessarily expect to
15206 work with code or libraries compiled with another value, if they exchange
15207 information using structures or unions.
15209 @item -mabort-on-noreturn
15210 @opindex mabort-on-noreturn
15211 Generate a call to the function @code{abort} at the end of a
15212 @code{noreturn} function.  It is executed if the function tries to
15213 return.
15215 @item -mlong-calls
15216 @itemx -mno-long-calls
15217 @opindex mlong-calls
15218 @opindex mno-long-calls
15219 Tells the compiler to perform function calls by first loading the
15220 address of the function into a register and then performing a subroutine
15221 call on this register.  This switch is needed if the target function
15222 lies outside of the 64-megabyte addressing range of the offset-based
15223 version of subroutine call instruction.
15225 Even if this switch is enabled, not all function calls are turned
15226 into long calls.  The heuristic is that static functions, functions
15227 that have the @code{short_call} attribute, functions that are inside
15228 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15229 definitions have already been compiled within the current compilation
15230 unit are not turned into long calls.  The exceptions to this rule are
15231 that weak function definitions, functions with the @code{long_call}
15232 attribute or the @code{section} attribute, and functions that are within
15233 the scope of a @code{#pragma long_calls} directive are always
15234 turned into long calls.
15236 This feature is not enabled by default.  Specifying
15237 @option{-mno-long-calls} restores the default behavior, as does
15238 placing the function calls within the scope of a @code{#pragma
15239 long_calls_off} directive.  Note these switches have no effect on how
15240 the compiler generates code to handle function calls via function
15241 pointers.
15243 @item -msingle-pic-base
15244 @opindex msingle-pic-base
15245 Treat the register used for PIC addressing as read-only, rather than
15246 loading it in the prologue for each function.  The runtime system is
15247 responsible for initializing this register with an appropriate value
15248 before execution begins.
15250 @item -mpic-register=@var{reg}
15251 @opindex mpic-register
15252 Specify the register to be used for PIC addressing.
15253 For standard PIC base case, the default is any suitable register
15254 determined by compiler.  For single PIC base case, the default is
15255 @samp{R9} if target is EABI based or stack-checking is enabled,
15256 otherwise the default is @samp{R10}.
15258 @item -mpic-data-is-text-relative
15259 @opindex mpic-data-is-text-relative
15260 Assume that the displacement between the text and data segments is fixed
15261 at static link time.  This permits using PC-relative addressing
15262 operations to access data known to be in the data segment.  For
15263 non-VxWorks RTP targets, this option is enabled by default.  When
15264 disabled on such targets, it will enable @option{-msingle-pic-base} by
15265 default.
15267 @item -mpoke-function-name
15268 @opindex mpoke-function-name
15269 Write the name of each function into the text section, directly
15270 preceding the function prologue.  The generated code is similar to this:
15272 @smallexample
15273      t0
15274          .ascii "arm_poke_function_name", 0
15275          .align
15276      t1
15277          .word 0xff000000 + (t1 - t0)
15278      arm_poke_function_name
15279          mov     ip, sp
15280          stmfd   sp!, @{fp, ip, lr, pc@}
15281          sub     fp, ip, #4
15282 @end smallexample
15284 When performing a stack backtrace, code can inspect the value of
15285 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15286 location @code{pc - 12} and the top 8 bits are set, then we know that
15287 there is a function name embedded immediately preceding this location
15288 and has length @code{((pc[-3]) & 0xff000000)}.
15290 @item -mthumb
15291 @itemx -marm
15292 @opindex marm
15293 @opindex mthumb
15295 Select between generating code that executes in ARM and Thumb
15296 states.  The default for most configurations is to generate code
15297 that executes in ARM state, but the default can be changed by
15298 configuring GCC with the @option{--with-mode=}@var{state}
15299 configure option.
15301 You can also override the ARM and Thumb mode for each function
15302 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15303 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15305 @item -mtpcs-frame
15306 @opindex mtpcs-frame
15307 Generate a stack frame that is compliant with the Thumb Procedure Call
15308 Standard for all non-leaf functions.  (A leaf function is one that does
15309 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15311 @item -mtpcs-leaf-frame
15312 @opindex mtpcs-leaf-frame
15313 Generate a stack frame that is compliant with the Thumb Procedure Call
15314 Standard for all leaf functions.  (A leaf function is one that does
15315 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15317 @item -mcallee-super-interworking
15318 @opindex mcallee-super-interworking
15319 Gives all externally visible functions in the file being compiled an ARM
15320 instruction set header which switches to Thumb mode before executing the
15321 rest of the function.  This allows these functions to be called from
15322 non-interworking code.  This option is not valid in AAPCS configurations
15323 because interworking is enabled by default.
15325 @item -mcaller-super-interworking
15326 @opindex mcaller-super-interworking
15327 Allows calls via function pointers (including virtual functions) to
15328 execute correctly regardless of whether the target code has been
15329 compiled for interworking or not.  There is a small overhead in the cost
15330 of executing a function pointer if this option is enabled.  This option
15331 is not valid in AAPCS configurations because interworking is enabled
15332 by default.
15334 @item -mtp=@var{name}
15335 @opindex mtp
15336 Specify the access model for the thread local storage pointer.  The valid
15337 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15338 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15339 (supported in the arm6k architecture), and @samp{auto}, which uses the
15340 best available method for the selected processor.  The default setting is
15341 @samp{auto}.
15343 @item -mtls-dialect=@var{dialect}
15344 @opindex mtls-dialect
15345 Specify the dialect to use for accessing thread local storage.  Two
15346 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15347 @samp{gnu} dialect selects the original GNU scheme for supporting
15348 local and global dynamic TLS models.  The @samp{gnu2} dialect
15349 selects the GNU descriptor scheme, which provides better performance
15350 for shared libraries.  The GNU descriptor scheme is compatible with
15351 the original scheme, but does require new assembler, linker and
15352 library support.  Initial and local exec TLS models are unaffected by
15353 this option and always use the original scheme.
15355 @item -mword-relocations
15356 @opindex mword-relocations
15357 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15358 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15359 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15360 is specified.
15362 @item -mfix-cortex-m3-ldrd
15363 @opindex mfix-cortex-m3-ldrd
15364 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15365 with overlapping destination and base registers are used.  This option avoids
15366 generating these instructions.  This option is enabled by default when
15367 @option{-mcpu=cortex-m3} is specified.
15369 @item -munaligned-access
15370 @itemx -mno-unaligned-access
15371 @opindex munaligned-access
15372 @opindex mno-unaligned-access
15373 Enables (or disables) reading and writing of 16- and 32- bit values
15374 from addresses that are not 16- or 32- bit aligned.  By default
15375 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15376 ARMv8-M Baseline architectures, and enabled for all other
15377 architectures.  If unaligned access is not enabled then words in packed
15378 data structures are accessed a byte at a time.
15380 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15381 generated object file to either true or false, depending upon the
15382 setting of this option.  If unaligned access is enabled then the
15383 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15384 defined.
15386 @item -mneon-for-64bits
15387 @opindex mneon-for-64bits
15388 Enables using Neon to handle scalar 64-bits operations. This is
15389 disabled by default since the cost of moving data from core registers
15390 to Neon is high.
15392 @item -mslow-flash-data
15393 @opindex mslow-flash-data
15394 Assume loading data from flash is slower than fetching instruction.
15395 Therefore literal load is minimized for better performance.
15396 This option is only supported when compiling for ARMv7 M-profile and
15397 off by default.
15399 @item -masm-syntax-unified
15400 @opindex masm-syntax-unified
15401 Assume inline assembler is using unified asm syntax.  The default is
15402 currently off which implies divided syntax.  This option has no impact
15403 on Thumb2. However, this may change in future releases of GCC.
15404 Divided syntax should be considered deprecated.
15406 @item -mrestrict-it
15407 @opindex mrestrict-it
15408 Restricts generation of IT blocks to conform to the rules of ARMv8.
15409 IT blocks can only contain a single 16-bit instruction from a select
15410 set of instructions. This option is on by default for ARMv8 Thumb mode.
15412 @item -mprint-tune-info
15413 @opindex mprint-tune-info
15414 Print CPU tuning information as comment in assembler file.  This is
15415 an option used only for regression testing of the compiler and not
15416 intended for ordinary use in compiling code.  This option is disabled
15417 by default.
15419 @item -mpure-code
15420 @opindex mpure-code
15421 Do not allow constant data to be placed in code sections.
15422 Additionally, when compiling for ELF object format give all text sections the
15423 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15424 is only available when generating non-pic code for ARMv7-M targets.
15426 @item -mcmse
15427 @opindex mcmse
15428 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15429 Development Tools Engineering Specification", which can be found on
15430 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15431 @end table
15433 @node AVR Options
15434 @subsection AVR Options
15435 @cindex AVR Options
15437 These options are defined for AVR implementations:
15439 @table @gcctabopt
15440 @item -mmcu=@var{mcu}
15441 @opindex mmcu
15442 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15444 The default for this option is@tie{}@samp{avr2}.
15446 GCC supports the following AVR devices and ISAs:
15448 @include avr-mmcu.texi
15450 @item -mabsdata
15451 @opindex mabsdata
15453 Assume that all data in static storage can be accessed by LDS / STS
15454 instructions.  This option has only an effect on reduced Tiny devices like
15455 ATtiny40.  See also the @code{absdata}
15456 @ref{AVR Variable Attributes,variable attribute}.
15458 @item -maccumulate-args
15459 @opindex maccumulate-args
15460 Accumulate outgoing function arguments and acquire/release the needed
15461 stack space for outgoing function arguments once in function
15462 prologue/epilogue.  Without this option, outgoing arguments are pushed
15463 before calling a function and popped afterwards.
15465 Popping the arguments after the function call can be expensive on
15466 AVR so that accumulating the stack space might lead to smaller
15467 executables because arguments need not to be removed from the
15468 stack after such a function call.
15470 This option can lead to reduced code size for functions that perform
15471 several calls to functions that get their arguments on the stack like
15472 calls to printf-like functions.
15474 @item -mbranch-cost=@var{cost}
15475 @opindex mbranch-cost
15476 Set the branch costs for conditional branch instructions to
15477 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15478 integers. The default branch cost is 0.
15480 @item -mcall-prologues
15481 @opindex mcall-prologues
15482 Functions prologues/epilogues are expanded as calls to appropriate
15483 subroutines.  Code size is smaller.
15485 @item -mint8
15486 @opindex mint8
15487 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15488 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15489 and @code{long long} is 4 bytes.  Please note that this option does not
15490 conform to the C standards, but it results in smaller code
15491 size.
15493 @item -mn-flash=@var{num}
15494 @opindex mn-flash
15495 Assume that the flash memory has a size of 
15496 @var{num} times 64@tie{}KiB.
15498 @item -mno-interrupts
15499 @opindex mno-interrupts
15500 Generated code is not compatible with hardware interrupts.
15501 Code size is smaller.
15503 @item -mrelax
15504 @opindex mrelax
15505 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15506 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15507 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15508 the assembler's command line and the @option{--relax} option to the
15509 linker's command line.
15511 Jump relaxing is performed by the linker because jump offsets are not
15512 known before code is located. Therefore, the assembler code generated by the
15513 compiler is the same, but the instructions in the executable may
15514 differ from instructions in the assembler code.
15516 Relaxing must be turned on if linker stubs are needed, see the
15517 section on @code{EIND} and linker stubs below.
15519 @item -mrmw
15520 @opindex mrmw
15521 Assume that the device supports the Read-Modify-Write
15522 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15524 @item -msp8
15525 @opindex msp8
15526 Treat the stack pointer register as an 8-bit register,
15527 i.e.@: assume the high byte of the stack pointer is zero.
15528 In general, you don't need to set this option by hand.
15530 This option is used internally by the compiler to select and
15531 build multilibs for architectures @code{avr2} and @code{avr25}.
15532 These architectures mix devices with and without @code{SPH}.
15533 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15534 the compiler driver adds or removes this option from the compiler
15535 proper's command line, because the compiler then knows if the device
15536 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15537 register or not.
15539 @item -mstrict-X
15540 @opindex mstrict-X
15541 Use address register @code{X} in a way proposed by the hardware.  This means
15542 that @code{X} is only used in indirect, post-increment or
15543 pre-decrement addressing.
15545 Without this option, the @code{X} register may be used in the same way
15546 as @code{Y} or @code{Z} which then is emulated by additional
15547 instructions.  
15548 For example, loading a value with @code{X+const} addressing with a
15549 small non-negative @code{const < 64} to a register @var{Rn} is
15550 performed as
15552 @example
15553 adiw r26, const   ; X += const
15554 ld   @var{Rn}, X        ; @var{Rn} = *X
15555 sbiw r26, const   ; X -= const
15556 @end example
15558 @item -mtiny-stack
15559 @opindex mtiny-stack
15560 Only change the lower 8@tie{}bits of the stack pointer.
15562 @item -mfract-convert-truncate
15563 @opindex mfract-convert-truncate
15564 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
15566 @item -nodevicelib
15567 @opindex nodevicelib
15568 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
15570 @item -Waddr-space-convert
15571 @opindex Waddr-space-convert
15572 Warn about conversions between address spaces in the case where the
15573 resulting address space is not contained in the incoming address space.
15575 @item -Wmisspelled-isr
15576 @opindex Wmisspelled-isr
15577 Warn if the ISR is misspelled, i.e. without __vector prefix.
15578 Enabled by default.
15579 @end table
15581 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
15582 @cindex @code{EIND}
15583 Pointers in the implementation are 16@tie{}bits wide.
15584 The address of a function or label is represented as word address so
15585 that indirect jumps and calls can target any code address in the
15586 range of 64@tie{}Ki words.
15588 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
15589 bytes of program memory space, there is a special function register called
15590 @code{EIND} that serves as most significant part of the target address
15591 when @code{EICALL} or @code{EIJMP} instructions are used.
15593 Indirect jumps and calls on these devices are handled as follows by
15594 the compiler and are subject to some limitations:
15596 @itemize @bullet
15598 @item
15599 The compiler never sets @code{EIND}.
15601 @item
15602 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
15603 instructions or might read @code{EIND} directly in order to emulate an
15604 indirect call/jump by means of a @code{RET} instruction.
15606 @item
15607 The compiler assumes that @code{EIND} never changes during the startup
15608 code or during the application. In particular, @code{EIND} is not
15609 saved/restored in function or interrupt service routine
15610 prologue/epilogue.
15612 @item
15613 For indirect calls to functions and computed goto, the linker
15614 generates @emph{stubs}. Stubs are jump pads sometimes also called
15615 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
15616 The stub contains a direct jump to the desired address.
15618 @item
15619 Linker relaxation must be turned on so that the linker generates
15620 the stubs correctly in all situations. See the compiler option
15621 @option{-mrelax} and the linker option @option{--relax}.
15622 There are corner cases where the linker is supposed to generate stubs
15623 but aborts without relaxation and without a helpful error message.
15625 @item
15626 The default linker script is arranged for code with @code{EIND = 0}.
15627 If code is supposed to work for a setup with @code{EIND != 0}, a custom
15628 linker script has to be used in order to place the sections whose
15629 name start with @code{.trampolines} into the segment where @code{EIND}
15630 points to.
15632 @item
15633 The startup code from libgcc never sets @code{EIND}.
15634 Notice that startup code is a blend of code from libgcc and AVR-LibC.
15635 For the impact of AVR-LibC on @code{EIND}, see the
15636 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
15638 @item
15639 It is legitimate for user-specific startup code to set up @code{EIND}
15640 early, for example by means of initialization code located in
15641 section @code{.init3}. Such code runs prior to general startup code
15642 that initializes RAM and calls constructors, but after the bit
15643 of startup code from AVR-LibC that sets @code{EIND} to the segment
15644 where the vector table is located.
15645 @example
15646 #include <avr/io.h>
15648 static void
15649 __attribute__((section(".init3"),naked,used,no_instrument_function))
15650 init3_set_eind (void)
15652   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
15653                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
15655 @end example
15657 @noindent
15658 The @code{__trampolines_start} symbol is defined in the linker script.
15660 @item
15661 Stubs are generated automatically by the linker if
15662 the following two conditions are met:
15663 @itemize @minus
15665 @item The address of a label is taken by means of the @code{gs} modifier
15666 (short for @emph{generate stubs}) like so:
15667 @example
15668 LDI r24, lo8(gs(@var{func}))
15669 LDI r25, hi8(gs(@var{func}))
15670 @end example
15671 @item The final location of that label is in a code segment
15672 @emph{outside} the segment where the stubs are located.
15673 @end itemize
15675 @item
15676 The compiler emits such @code{gs} modifiers for code labels in the
15677 following situations:
15678 @itemize @minus
15679 @item Taking address of a function or code label.
15680 @item Computed goto.
15681 @item If prologue-save function is used, see @option{-mcall-prologues}
15682 command-line option.
15683 @item Switch/case dispatch tables. If you do not want such dispatch
15684 tables you can specify the @option{-fno-jump-tables} command-line option.
15685 @item C and C++ constructors/destructors called during startup/shutdown.
15686 @item If the tools hit a @code{gs()} modifier explained above.
15687 @end itemize
15689 @item
15690 Jumping to non-symbolic addresses like so is @emph{not} supported:
15692 @example
15693 int main (void)
15695     /* Call function at word address 0x2 */
15696     return ((int(*)(void)) 0x2)();
15698 @end example
15700 Instead, a stub has to be set up, i.e.@: the function has to be called
15701 through a symbol (@code{func_4} in the example):
15703 @example
15704 int main (void)
15706     extern int func_4 (void);
15708     /* Call function at byte address 0x4 */
15709     return func_4();
15711 @end example
15713 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
15714 Alternatively, @code{func_4} can be defined in the linker script.
15715 @end itemize
15717 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
15718 @cindex @code{RAMPD}
15719 @cindex @code{RAMPX}
15720 @cindex @code{RAMPY}
15721 @cindex @code{RAMPZ}
15722 Some AVR devices support memories larger than the 64@tie{}KiB range
15723 that can be accessed with 16-bit pointers.  To access memory locations
15724 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
15725 register is used as high part of the address:
15726 The @code{X}, @code{Y}, @code{Z} address register is concatenated
15727 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
15728 register, respectively, to get a wide address. Similarly,
15729 @code{RAMPD} is used together with direct addressing.
15731 @itemize
15732 @item
15733 The startup code initializes the @code{RAMP} special function
15734 registers with zero.
15736 @item
15737 If a @ref{AVR Named Address Spaces,named address space} other than
15738 generic or @code{__flash} is used, then @code{RAMPZ} is set
15739 as needed before the operation.
15741 @item
15742 If the device supports RAM larger than 64@tie{}KiB and the compiler
15743 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
15744 is reset to zero after the operation.
15746 @item
15747 If the device comes with a specific @code{RAMP} register, the ISR
15748 prologue/epilogue saves/restores that SFR and initializes it with
15749 zero in case the ISR code might (implicitly) use it.
15751 @item
15752 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
15753 If you use inline assembler to read from locations outside the
15754 16-bit address range and change one of the @code{RAMP} registers,
15755 you must reset it to zero after the access.
15757 @end itemize
15759 @subsubsection AVR Built-in Macros
15761 GCC defines several built-in macros so that the user code can test
15762 for the presence or absence of features.  Almost any of the following
15763 built-in macros are deduced from device capabilities and thus
15764 triggered by the @option{-mmcu=} command-line option.
15766 For even more AVR-specific built-in macros see
15767 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
15769 @table @code
15771 @item __AVR_ARCH__
15772 Build-in macro that resolves to a decimal number that identifies the
15773 architecture and depends on the @option{-mmcu=@var{mcu}} option.
15774 Possible values are:
15776 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
15777 @code{4}, @code{5}, @code{51}, @code{6}
15779 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
15780 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
15782 respectively and
15784 @code{100}, @code{102}, @code{104},
15785 @code{105}, @code{106}, @code{107}
15787 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
15788 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
15789 If @var{mcu} specifies a device, this built-in macro is set
15790 accordingly. For example, with @option{-mmcu=atmega8} the macro is
15791 defined to @code{4}.
15793 @item __AVR_@var{Device}__
15794 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
15795 the device's name. For example, @option{-mmcu=atmega8} defines the
15796 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
15797 @code{__AVR_ATtiny261A__}, etc.
15799 The built-in macros' names follow
15800 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
15801 the device name as from the AVR user manual. The difference between
15802 @var{Device} in the built-in macro and @var{device} in
15803 @option{-mmcu=@var{device}} is that the latter is always lowercase.
15805 If @var{device} is not a device but only a core architecture like
15806 @samp{avr51}, this macro is not defined.
15808 @item __AVR_DEVICE_NAME__
15809 Setting @option{-mmcu=@var{device}} defines this built-in macro to
15810 the device's name. For example, with @option{-mmcu=atmega8} the macro
15811 is defined to @code{atmega8}.
15813 If @var{device} is not a device but only a core architecture like
15814 @samp{avr51}, this macro is not defined.
15816 @item __AVR_XMEGA__
15817 The device / architecture belongs to the XMEGA family of devices.
15819 @item __AVR_HAVE_ELPM__
15820 The device has the @code{ELPM} instruction.
15822 @item __AVR_HAVE_ELPMX__
15823 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
15824 R@var{n},Z+} instructions.
15826 @item __AVR_HAVE_MOVW__
15827 The device has the @code{MOVW} instruction to perform 16-bit
15828 register-register moves.
15830 @item __AVR_HAVE_LPMX__
15831 The device has the @code{LPM R@var{n},Z} and
15832 @code{LPM R@var{n},Z+} instructions.
15834 @item __AVR_HAVE_MUL__
15835 The device has a hardware multiplier. 
15837 @item __AVR_HAVE_JMP_CALL__
15838 The device has the @code{JMP} and @code{CALL} instructions.
15839 This is the case for devices with at least 16@tie{}KiB of program
15840 memory.
15842 @item __AVR_HAVE_EIJMP_EICALL__
15843 @itemx __AVR_3_BYTE_PC__
15844 The device has the @code{EIJMP} and @code{EICALL} instructions.
15845 This is the case for devices with more than 128@tie{}KiB of program memory.
15846 This also means that the program counter
15847 (PC) is 3@tie{}bytes wide.
15849 @item __AVR_2_BYTE_PC__
15850 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
15851 with up to 128@tie{}KiB of program memory.
15853 @item __AVR_HAVE_8BIT_SP__
15854 @itemx __AVR_HAVE_16BIT_SP__
15855 The stack pointer (SP) register is treated as 8-bit respectively
15856 16-bit register by the compiler.
15857 The definition of these macros is affected by @option{-mtiny-stack}.
15859 @item __AVR_HAVE_SPH__
15860 @itemx __AVR_SP8__
15861 The device has the SPH (high part of stack pointer) special function
15862 register or has an 8-bit stack pointer, respectively.
15863 The definition of these macros is affected by @option{-mmcu=} and
15864 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
15865 by @option{-msp8}.
15867 @item __AVR_HAVE_RAMPD__
15868 @itemx __AVR_HAVE_RAMPX__
15869 @itemx __AVR_HAVE_RAMPY__
15870 @itemx __AVR_HAVE_RAMPZ__
15871 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
15872 @code{RAMPZ} special function register, respectively.
15874 @item __NO_INTERRUPTS__
15875 This macro reflects the @option{-mno-interrupts} command-line option.
15877 @item __AVR_ERRATA_SKIP__
15878 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
15879 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
15880 instructions because of a hardware erratum.  Skip instructions are
15881 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
15882 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
15883 set.
15885 @item __AVR_ISA_RMW__
15886 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
15888 @item __AVR_SFR_OFFSET__=@var{offset}
15889 Instructions that can address I/O special function registers directly
15890 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
15891 address as if addressed by an instruction to access RAM like @code{LD}
15892 or @code{STS}. This offset depends on the device architecture and has
15893 to be subtracted from the RAM address in order to get the
15894 respective I/O@tie{}address.
15896 @item __WITH_AVRLIBC__
15897 The compiler is configured to be used together with AVR-Libc.
15898 See the @option{--with-avrlibc} configure option.
15900 @end table
15902 @node Blackfin Options
15903 @subsection Blackfin Options
15904 @cindex Blackfin Options
15906 @table @gcctabopt
15907 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
15908 @opindex mcpu=
15909 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
15910 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
15911 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
15912 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
15913 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
15914 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
15915 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
15916 @samp{bf561}, @samp{bf592}.
15918 The optional @var{sirevision} specifies the silicon revision of the target
15919 Blackfin processor.  Any workarounds available for the targeted silicon revision
15920 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
15921 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
15922 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
15923 hexadecimal digits representing the major and minor numbers in the silicon
15924 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
15925 is not defined.  If @var{sirevision} is @samp{any}, the
15926 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
15927 If this optional @var{sirevision} is not used, GCC assumes the latest known
15928 silicon revision of the targeted Blackfin processor.
15930 GCC defines a preprocessor macro for the specified @var{cpu}.
15931 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
15932 provided by libgloss to be linked in if @option{-msim} is not given.
15934 Without this option, @samp{bf532} is used as the processor by default.
15936 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
15937 only the preprocessor macro is defined.
15939 @item -msim
15940 @opindex msim
15941 Specifies that the program will be run on the simulator.  This causes
15942 the simulator BSP provided by libgloss to be linked in.  This option
15943 has effect only for @samp{bfin-elf} toolchain.
15944 Certain other options, such as @option{-mid-shared-library} and
15945 @option{-mfdpic}, imply @option{-msim}.
15947 @item -momit-leaf-frame-pointer
15948 @opindex momit-leaf-frame-pointer
15949 Don't keep the frame pointer in a register for leaf functions.  This
15950 avoids the instructions to save, set up and restore frame pointers and
15951 makes an extra register available in leaf functions.  The option
15952 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
15953 which might make debugging harder.
15955 @item -mspecld-anomaly
15956 @opindex mspecld-anomaly
15957 When enabled, the compiler ensures that the generated code does not
15958 contain speculative loads after jump instructions. If this option is used,
15959 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
15961 @item -mno-specld-anomaly
15962 @opindex mno-specld-anomaly
15963 Don't generate extra code to prevent speculative loads from occurring.
15965 @item -mcsync-anomaly
15966 @opindex mcsync-anomaly
15967 When enabled, the compiler ensures that the generated code does not
15968 contain CSYNC or SSYNC instructions too soon after conditional branches.
15969 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
15971 @item -mno-csync-anomaly
15972 @opindex mno-csync-anomaly
15973 Don't generate extra code to prevent CSYNC or SSYNC instructions from
15974 occurring too soon after a conditional branch.
15976 @item -mlow-64k
15977 @opindex mlow-64k
15978 When enabled, the compiler is free to take advantage of the knowledge that
15979 the entire program fits into the low 64k of memory.
15981 @item -mno-low-64k
15982 @opindex mno-low-64k
15983 Assume that the program is arbitrarily large.  This is the default.
15985 @item -mstack-check-l1
15986 @opindex mstack-check-l1
15987 Do stack checking using information placed into L1 scratchpad memory by the
15988 uClinux kernel.
15990 @item -mid-shared-library
15991 @opindex mid-shared-library
15992 Generate code that supports shared libraries via the library ID method.
15993 This allows for execute in place and shared libraries in an environment
15994 without virtual memory management.  This option implies @option{-fPIC}.
15995 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15997 @item -mno-id-shared-library
15998 @opindex mno-id-shared-library
15999 Generate code that doesn't assume ID-based shared libraries are being used.
16000 This is the default.
16002 @item -mleaf-id-shared-library
16003 @opindex mleaf-id-shared-library
16004 Generate code that supports shared libraries via the library ID method,
16005 but assumes that this library or executable won't link against any other
16006 ID shared libraries.  That allows the compiler to use faster code for jumps
16007 and calls.
16009 @item -mno-leaf-id-shared-library
16010 @opindex mno-leaf-id-shared-library
16011 Do not assume that the code being compiled won't link against any ID shared
16012 libraries.  Slower code is generated for jump and call insns.
16014 @item -mshared-library-id=n
16015 @opindex mshared-library-id
16016 Specifies the identification number of the ID-based shared library being
16017 compiled.  Specifying a value of 0 generates more compact code; specifying
16018 other values forces the allocation of that number to the current
16019 library but is no more space- or time-efficient than omitting this option.
16021 @item -msep-data
16022 @opindex msep-data
16023 Generate code that allows the data segment to be located in a different
16024 area of memory from the text segment.  This allows for execute in place in
16025 an environment without virtual memory management by eliminating relocations
16026 against the text section.
16028 @item -mno-sep-data
16029 @opindex mno-sep-data
16030 Generate code that assumes that the data segment follows the text segment.
16031 This is the default.
16033 @item -mlong-calls
16034 @itemx -mno-long-calls
16035 @opindex mlong-calls
16036 @opindex mno-long-calls
16037 Tells the compiler to perform function calls by first loading the
16038 address of the function into a register and then performing a subroutine
16039 call on this register.  This switch is needed if the target function
16040 lies outside of the 24-bit addressing range of the offset-based
16041 version of subroutine call instruction.
16043 This feature is not enabled by default.  Specifying
16044 @option{-mno-long-calls} restores the default behavior.  Note these
16045 switches have no effect on how the compiler generates code to handle
16046 function calls via function pointers.
16048 @item -mfast-fp
16049 @opindex mfast-fp
16050 Link with the fast floating-point library. This library relaxes some of
16051 the IEEE floating-point standard's rules for checking inputs against
16052 Not-a-Number (NAN), in the interest of performance.
16054 @item -minline-plt
16055 @opindex minline-plt
16056 Enable inlining of PLT entries in function calls to functions that are
16057 not known to bind locally.  It has no effect without @option{-mfdpic}.
16059 @item -mmulticore
16060 @opindex mmulticore
16061 Build a standalone application for multicore Blackfin processors. 
16062 This option causes proper start files and link scripts supporting 
16063 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16064 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16066 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16067 selects the one-application-per-core programming model.  Without
16068 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16069 programming model is used. In this model, the main function of Core B
16070 should be named as @code{coreb_main}.
16072 If this option is not used, the single-core application programming
16073 model is used.
16075 @item -mcorea
16076 @opindex mcorea
16077 Build a standalone application for Core A of BF561 when using
16078 the one-application-per-core programming model. Proper start files
16079 and link scripts are used to support Core A, and the macro
16080 @code{__BFIN_COREA} is defined.
16081 This option can only be used in conjunction with @option{-mmulticore}.
16083 @item -mcoreb
16084 @opindex mcoreb
16085 Build a standalone application for Core B of BF561 when using
16086 the one-application-per-core programming model. Proper start files
16087 and link scripts are used to support Core B, and the macro
16088 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16089 should be used instead of @code{main}. 
16090 This option can only be used in conjunction with @option{-mmulticore}.
16092 @item -msdram
16093 @opindex msdram
16094 Build a standalone application for SDRAM. Proper start files and
16095 link scripts are used to put the application into SDRAM, and the macro
16096 @code{__BFIN_SDRAM} is defined.
16097 The loader should initialize SDRAM before loading the application.
16099 @item -micplb
16100 @opindex micplb
16101 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16102 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16103 are enabled; for standalone applications the default is off.
16104 @end table
16106 @node C6X Options
16107 @subsection C6X Options
16108 @cindex C6X Options
16110 @table @gcctabopt
16111 @item -march=@var{name}
16112 @opindex march
16113 This specifies the name of the target architecture.  GCC uses this
16114 name to determine what kind of instructions it can emit when generating
16115 assembly code.  Permissible names are: @samp{c62x},
16116 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16118 @item -mbig-endian
16119 @opindex mbig-endian
16120 Generate code for a big-endian target.
16122 @item -mlittle-endian
16123 @opindex mlittle-endian
16124 Generate code for a little-endian target.  This is the default.
16126 @item -msim
16127 @opindex msim
16128 Choose startup files and linker script suitable for the simulator.
16130 @item -msdata=default
16131 @opindex msdata=default
16132 Put small global and static data in the @code{.neardata} section,
16133 which is pointed to by register @code{B14}.  Put small uninitialized
16134 global and static data in the @code{.bss} section, which is adjacent
16135 to the @code{.neardata} section.  Put small read-only data into the
16136 @code{.rodata} section.  The corresponding sections used for large
16137 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16139 @item -msdata=all
16140 @opindex msdata=all
16141 Put all data, not just small objects, into the sections reserved for
16142 small data, and use addressing relative to the @code{B14} register to
16143 access them.
16145 @item -msdata=none
16146 @opindex msdata=none
16147 Make no use of the sections reserved for small data, and use absolute
16148 addresses to access all data.  Put all initialized global and static
16149 data in the @code{.fardata} section, and all uninitialized data in the
16150 @code{.far} section.  Put all constant data into the @code{.const}
16151 section.
16152 @end table
16154 @node CRIS Options
16155 @subsection CRIS Options
16156 @cindex CRIS Options
16158 These options are defined specifically for the CRIS ports.
16160 @table @gcctabopt
16161 @item -march=@var{architecture-type}
16162 @itemx -mcpu=@var{architecture-type}
16163 @opindex march
16164 @opindex mcpu
16165 Generate code for the specified architecture.  The choices for
16166 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16167 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16168 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16169 @samp{v10}.
16171 @item -mtune=@var{architecture-type}
16172 @opindex mtune
16173 Tune to @var{architecture-type} everything applicable about the generated
16174 code, except for the ABI and the set of available instructions.  The
16175 choices for @var{architecture-type} are the same as for
16176 @option{-march=@var{architecture-type}}.
16178 @item -mmax-stack-frame=@var{n}
16179 @opindex mmax-stack-frame
16180 Warn when the stack frame of a function exceeds @var{n} bytes.
16182 @item -metrax4
16183 @itemx -metrax100
16184 @opindex metrax4
16185 @opindex metrax100
16186 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16187 @option{-march=v3} and @option{-march=v8} respectively.
16189 @item -mmul-bug-workaround
16190 @itemx -mno-mul-bug-workaround
16191 @opindex mmul-bug-workaround
16192 @opindex mno-mul-bug-workaround
16193 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16194 models where it applies.  This option is active by default.
16196 @item -mpdebug
16197 @opindex mpdebug
16198 Enable CRIS-specific verbose debug-related information in the assembly
16199 code.  This option also has the effect of turning off the @samp{#NO_APP}
16200 formatted-code indicator to the assembler at the beginning of the
16201 assembly file.
16203 @item -mcc-init
16204 @opindex mcc-init
16205 Do not use condition-code results from previous instruction; always emit
16206 compare and test instructions before use of condition codes.
16208 @item -mno-side-effects
16209 @opindex mno-side-effects
16210 Do not emit instructions with side effects in addressing modes other than
16211 post-increment.
16213 @item -mstack-align
16214 @itemx -mno-stack-align
16215 @itemx -mdata-align
16216 @itemx -mno-data-align
16217 @itemx -mconst-align
16218 @itemx -mno-const-align
16219 @opindex mstack-align
16220 @opindex mno-stack-align
16221 @opindex mdata-align
16222 @opindex mno-data-align
16223 @opindex mconst-align
16224 @opindex mno-const-align
16225 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16226 stack frame, individual data and constants to be aligned for the maximum
16227 single data access size for the chosen CPU model.  The default is to
16228 arrange for 32-bit alignment.  ABI details such as structure layout are
16229 not affected by these options.
16231 @item -m32-bit
16232 @itemx -m16-bit
16233 @itemx -m8-bit
16234 @opindex m32-bit
16235 @opindex m16-bit
16236 @opindex m8-bit
16237 Similar to the stack- data- and const-align options above, these options
16238 arrange for stack frame, writable data and constants to all be 32-bit,
16239 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16241 @item -mno-prologue-epilogue
16242 @itemx -mprologue-epilogue
16243 @opindex mno-prologue-epilogue
16244 @opindex mprologue-epilogue
16245 With @option{-mno-prologue-epilogue}, the normal function prologue and
16246 epilogue which set up the stack frame are omitted and no return
16247 instructions or return sequences are generated in the code.  Use this
16248 option only together with visual inspection of the compiled code: no
16249 warnings or errors are generated when call-saved registers must be saved,
16250 or storage for local variables needs to be allocated.
16252 @item -mno-gotplt
16253 @itemx -mgotplt
16254 @opindex mno-gotplt
16255 @opindex mgotplt
16256 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16257 instruction sequences that load addresses for functions from the PLT part
16258 of the GOT rather than (traditional on other architectures) calls to the
16259 PLT@.  The default is @option{-mgotplt}.
16261 @item -melf
16262 @opindex melf
16263 Legacy no-op option only recognized with the cris-axis-elf and
16264 cris-axis-linux-gnu targets.
16266 @item -mlinux
16267 @opindex mlinux
16268 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16270 @item -sim
16271 @opindex sim
16272 This option, recognized for the cris-axis-elf, arranges
16273 to link with input-output functions from a simulator library.  Code,
16274 initialized data and zero-initialized data are allocated consecutively.
16276 @item -sim2
16277 @opindex sim2
16278 Like @option{-sim}, but pass linker options to locate initialized data at
16279 0x40000000 and zero-initialized data at 0x80000000.
16280 @end table
16282 @node CR16 Options
16283 @subsection CR16 Options
16284 @cindex CR16 Options
16286 These options are defined specifically for the CR16 ports.
16288 @table @gcctabopt
16290 @item -mmac
16291 @opindex mmac
16292 Enable the use of multiply-accumulate instructions. Disabled by default.
16294 @item -mcr16cplus
16295 @itemx -mcr16c
16296 @opindex mcr16cplus
16297 @opindex mcr16c
16298 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16299 is default.
16301 @item -msim
16302 @opindex msim
16303 Links the library libsim.a which is in compatible with simulator. Applicable
16304 to ELF compiler only.
16306 @item -mint32
16307 @opindex mint32
16308 Choose integer type as 32-bit wide.
16310 @item -mbit-ops
16311 @opindex mbit-ops
16312 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16314 @item -mdata-model=@var{model}
16315 @opindex mdata-model
16316 Choose a data model. The choices for @var{model} are @samp{near},
16317 @samp{far} or @samp{medium}. @samp{medium} is default.
16318 However, @samp{far} is not valid with @option{-mcr16c}, as the
16319 CR16C architecture does not support the far data model.
16320 @end table
16322 @node Darwin Options
16323 @subsection Darwin Options
16324 @cindex Darwin options
16326 These options are defined for all architectures running the Darwin operating
16327 system.
16329 FSF GCC on Darwin does not create ``fat'' object files; it creates
16330 an object file for the single architecture that GCC was built to
16331 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16332 @option{-arch} options are used; it does so by running the compiler or
16333 linker multiple times and joining the results together with
16334 @file{lipo}.
16336 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16337 @samp{i686}) is determined by the flags that specify the ISA
16338 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16339 @option{-force_cpusubtype_ALL} option can be used to override this.
16341 The Darwin tools vary in their behavior when presented with an ISA
16342 mismatch.  The assembler, @file{as}, only permits instructions to
16343 be used that are valid for the subtype of the file it is generating,
16344 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16345 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16346 and prints an error if asked to create a shared library with a less
16347 restrictive subtype than its input files (for instance, trying to put
16348 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16349 for executables, @command{ld}, quietly gives the executable the most
16350 restrictive subtype of any of its input files.
16352 @table @gcctabopt
16353 @item -F@var{dir}
16354 @opindex F
16355 Add the framework directory @var{dir} to the head of the list of
16356 directories to be searched for header files.  These directories are
16357 interleaved with those specified by @option{-I} options and are
16358 scanned in a left-to-right order.
16360 A framework directory is a directory with frameworks in it.  A
16361 framework is a directory with a @file{Headers} and/or
16362 @file{PrivateHeaders} directory contained directly in it that ends
16363 in @file{.framework}.  The name of a framework is the name of this
16364 directory excluding the @file{.framework}.  Headers associated with
16365 the framework are found in one of those two directories, with
16366 @file{Headers} being searched first.  A subframework is a framework
16367 directory that is in a framework's @file{Frameworks} directory.
16368 Includes of subframework headers can only appear in a header of a
16369 framework that contains the subframework, or in a sibling subframework
16370 header.  Two subframeworks are siblings if they occur in the same
16371 framework.  A subframework should not have the same name as a
16372 framework; a warning is issued if this is violated.  Currently a
16373 subframework cannot have subframeworks; in the future, the mechanism
16374 may be extended to support this.  The standard frameworks can be found
16375 in @file{/System/Library/Frameworks} and
16376 @file{/Library/Frameworks}.  An example include looks like
16377 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16378 the name of the framework and @file{header.h} is found in the
16379 @file{PrivateHeaders} or @file{Headers} directory.
16381 @item -iframework@var{dir}
16382 @opindex iframework
16383 Like @option{-F} except the directory is a treated as a system
16384 directory.  The main difference between this @option{-iframework} and
16385 @option{-F} is that with @option{-iframework} the compiler does not
16386 warn about constructs contained within header files found via
16387 @var{dir}.  This option is valid only for the C family of languages.
16389 @item -gused
16390 @opindex gused
16391 Emit debugging information for symbols that are used.  For stabs
16392 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16393 This is by default ON@.
16395 @item -gfull
16396 @opindex gfull
16397 Emit debugging information for all symbols and types.
16399 @item -mmacosx-version-min=@var{version}
16400 The earliest version of MacOS X that this executable will run on
16401 is @var{version}.  Typical values of @var{version} include @code{10.1},
16402 @code{10.2}, and @code{10.3.9}.
16404 If the compiler was built to use the system's headers by default,
16405 then the default for this option is the system version on which the
16406 compiler is running, otherwise the default is to make choices that
16407 are compatible with as many systems and code bases as possible.
16409 @item -mkernel
16410 @opindex mkernel
16411 Enable kernel development mode.  The @option{-mkernel} option sets
16412 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16413 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16414 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16415 applicable.  This mode also sets @option{-mno-altivec},
16416 @option{-msoft-float}, @option{-fno-builtin} and
16417 @option{-mlong-branch} for PowerPC targets.
16419 @item -mone-byte-bool
16420 @opindex mone-byte-bool
16421 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16422 By default @code{sizeof(bool)} is @code{4} when compiling for
16423 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16424 option has no effect on x86.
16426 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16427 to generate code that is not binary compatible with code generated
16428 without that switch.  Using this switch may require recompiling all
16429 other modules in a program, including system libraries.  Use this
16430 switch to conform to a non-default data model.
16432 @item -mfix-and-continue
16433 @itemx -ffix-and-continue
16434 @itemx -findirect-data
16435 @opindex mfix-and-continue
16436 @opindex ffix-and-continue
16437 @opindex findirect-data
16438 Generate code suitable for fast turnaround development, such as to
16439 allow GDB to dynamically load @file{.o} files into already-running
16440 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16441 are provided for backwards compatibility.
16443 @item -all_load
16444 @opindex all_load
16445 Loads all members of static archive libraries.
16446 See man ld(1) for more information.
16448 @item -arch_errors_fatal
16449 @opindex arch_errors_fatal
16450 Cause the errors having to do with files that have the wrong architecture
16451 to be fatal.
16453 @item -bind_at_load
16454 @opindex bind_at_load
16455 Causes the output file to be marked such that the dynamic linker will
16456 bind all undefined references when the file is loaded or launched.
16458 @item -bundle
16459 @opindex bundle
16460 Produce a Mach-o bundle format file.
16461 See man ld(1) for more information.
16463 @item -bundle_loader @var{executable}
16464 @opindex bundle_loader
16465 This option specifies the @var{executable} that will load the build
16466 output file being linked.  See man ld(1) for more information.
16468 @item -dynamiclib
16469 @opindex dynamiclib
16470 When passed this option, GCC produces a dynamic library instead of
16471 an executable when linking, using the Darwin @file{libtool} command.
16473 @item -force_cpusubtype_ALL
16474 @opindex force_cpusubtype_ALL
16475 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16476 one controlled by the @option{-mcpu} or @option{-march} option.
16478 @item -allowable_client  @var{client_name}
16479 @itemx -client_name
16480 @itemx -compatibility_version
16481 @itemx -current_version
16482 @itemx -dead_strip
16483 @itemx -dependency-file
16484 @itemx -dylib_file
16485 @itemx -dylinker_install_name
16486 @itemx -dynamic
16487 @itemx -exported_symbols_list
16488 @itemx -filelist
16489 @need 800
16490 @itemx -flat_namespace
16491 @itemx -force_flat_namespace
16492 @itemx -headerpad_max_install_names
16493 @itemx -image_base
16494 @itemx -init
16495 @itemx -install_name
16496 @itemx -keep_private_externs
16497 @itemx -multi_module
16498 @itemx -multiply_defined
16499 @itemx -multiply_defined_unused
16500 @need 800
16501 @itemx -noall_load
16502 @itemx -no_dead_strip_inits_and_terms
16503 @itemx -nofixprebinding
16504 @itemx -nomultidefs
16505 @itemx -noprebind
16506 @itemx -noseglinkedit
16507 @itemx -pagezero_size
16508 @itemx -prebind
16509 @itemx -prebind_all_twolevel_modules
16510 @itemx -private_bundle
16511 @need 800
16512 @itemx -read_only_relocs
16513 @itemx -sectalign
16514 @itemx -sectobjectsymbols
16515 @itemx -whyload
16516 @itemx -seg1addr
16517 @itemx -sectcreate
16518 @itemx -sectobjectsymbols
16519 @itemx -sectorder
16520 @itemx -segaddr
16521 @itemx -segs_read_only_addr
16522 @need 800
16523 @itemx -segs_read_write_addr
16524 @itemx -seg_addr_table
16525 @itemx -seg_addr_table_filename
16526 @itemx -seglinkedit
16527 @itemx -segprot
16528 @itemx -segs_read_only_addr
16529 @itemx -segs_read_write_addr
16530 @itemx -single_module
16531 @itemx -static
16532 @itemx -sub_library
16533 @need 800
16534 @itemx -sub_umbrella
16535 @itemx -twolevel_namespace
16536 @itemx -umbrella
16537 @itemx -undefined
16538 @itemx -unexported_symbols_list
16539 @itemx -weak_reference_mismatches
16540 @itemx -whatsloaded
16541 @opindex allowable_client
16542 @opindex client_name
16543 @opindex compatibility_version
16544 @opindex current_version
16545 @opindex dead_strip
16546 @opindex dependency-file
16547 @opindex dylib_file
16548 @opindex dylinker_install_name
16549 @opindex dynamic
16550 @opindex exported_symbols_list
16551 @opindex filelist
16552 @opindex flat_namespace
16553 @opindex force_flat_namespace
16554 @opindex headerpad_max_install_names
16555 @opindex image_base
16556 @opindex init
16557 @opindex install_name
16558 @opindex keep_private_externs
16559 @opindex multi_module
16560 @opindex multiply_defined
16561 @opindex multiply_defined_unused
16562 @opindex noall_load
16563 @opindex no_dead_strip_inits_and_terms
16564 @opindex nofixprebinding
16565 @opindex nomultidefs
16566 @opindex noprebind
16567 @opindex noseglinkedit
16568 @opindex pagezero_size
16569 @opindex prebind
16570 @opindex prebind_all_twolevel_modules
16571 @opindex private_bundle
16572 @opindex read_only_relocs
16573 @opindex sectalign
16574 @opindex sectobjectsymbols
16575 @opindex whyload
16576 @opindex seg1addr
16577 @opindex sectcreate
16578 @opindex sectobjectsymbols
16579 @opindex sectorder
16580 @opindex segaddr
16581 @opindex segs_read_only_addr
16582 @opindex segs_read_write_addr
16583 @opindex seg_addr_table
16584 @opindex seg_addr_table_filename
16585 @opindex seglinkedit
16586 @opindex segprot
16587 @opindex segs_read_only_addr
16588 @opindex segs_read_write_addr
16589 @opindex single_module
16590 @opindex static
16591 @opindex sub_library
16592 @opindex sub_umbrella
16593 @opindex twolevel_namespace
16594 @opindex umbrella
16595 @opindex undefined
16596 @opindex unexported_symbols_list
16597 @opindex weak_reference_mismatches
16598 @opindex whatsloaded
16599 These options are passed to the Darwin linker.  The Darwin linker man page
16600 describes them in detail.
16601 @end table
16603 @node DEC Alpha Options
16604 @subsection DEC Alpha Options
16606 These @samp{-m} options are defined for the DEC Alpha implementations:
16608 @table @gcctabopt
16609 @item -mno-soft-float
16610 @itemx -msoft-float
16611 @opindex mno-soft-float
16612 @opindex msoft-float
16613 Use (do not use) the hardware floating-point instructions for
16614 floating-point operations.  When @option{-msoft-float} is specified,
16615 functions in @file{libgcc.a} are used to perform floating-point
16616 operations.  Unless they are replaced by routines that emulate the
16617 floating-point operations, or compiled in such a way as to call such
16618 emulations routines, these routines issue floating-point
16619 operations.   If you are compiling for an Alpha without floating-point
16620 operations, you must ensure that the library is built so as not to call
16621 them.
16623 Note that Alpha implementations without floating-point operations are
16624 required to have floating-point registers.
16626 @item -mfp-reg
16627 @itemx -mno-fp-regs
16628 @opindex mfp-reg
16629 @opindex mno-fp-regs
16630 Generate code that uses (does not use) the floating-point register set.
16631 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
16632 register set is not used, floating-point operands are passed in integer
16633 registers as if they were integers and floating-point results are passed
16634 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
16635 so any function with a floating-point argument or return value called by code
16636 compiled with @option{-mno-fp-regs} must also be compiled with that
16637 option.
16639 A typical use of this option is building a kernel that does not use,
16640 and hence need not save and restore, any floating-point registers.
16642 @item -mieee
16643 @opindex mieee
16644 The Alpha architecture implements floating-point hardware optimized for
16645 maximum performance.  It is mostly compliant with the IEEE floating-point
16646 standard.  However, for full compliance, software assistance is
16647 required.  This option generates code fully IEEE-compliant code
16648 @emph{except} that the @var{inexact-flag} is not maintained (see below).
16649 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
16650 defined during compilation.  The resulting code is less efficient but is
16651 able to correctly support denormalized numbers and exceptional IEEE
16652 values such as not-a-number and plus/minus infinity.  Other Alpha
16653 compilers call this option @option{-ieee_with_no_inexact}.
16655 @item -mieee-with-inexact
16656 @opindex mieee-with-inexact
16657 This is like @option{-mieee} except the generated code also maintains
16658 the IEEE @var{inexact-flag}.  Turning on this option causes the
16659 generated code to implement fully-compliant IEEE math.  In addition to
16660 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
16661 macro.  On some Alpha implementations the resulting code may execute
16662 significantly slower than the code generated by default.  Since there is
16663 very little code that depends on the @var{inexact-flag}, you should
16664 normally not specify this option.  Other Alpha compilers call this
16665 option @option{-ieee_with_inexact}.
16667 @item -mfp-trap-mode=@var{trap-mode}
16668 @opindex mfp-trap-mode
16669 This option controls what floating-point related traps are enabled.
16670 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
16671 The trap mode can be set to one of four values:
16673 @table @samp
16674 @item n
16675 This is the default (normal) setting.  The only traps that are enabled
16676 are the ones that cannot be disabled in software (e.g., division by zero
16677 trap).
16679 @item u
16680 In addition to the traps enabled by @samp{n}, underflow traps are enabled
16681 as well.
16683 @item su
16684 Like @samp{u}, but the instructions are marked to be safe for software
16685 completion (see Alpha architecture manual for details).
16687 @item sui
16688 Like @samp{su}, but inexact traps are enabled as well.
16689 @end table
16691 @item -mfp-rounding-mode=@var{rounding-mode}
16692 @opindex mfp-rounding-mode
16693 Selects the IEEE rounding mode.  Other Alpha compilers call this option
16694 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
16697 @table @samp
16698 @item n
16699 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
16700 the nearest machine number or towards the even machine number in case
16701 of a tie.
16703 @item m
16704 Round towards minus infinity.
16706 @item c
16707 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
16709 @item d
16710 Dynamic rounding mode.  A field in the floating-point control register
16711 (@var{fpcr}, see Alpha architecture reference manual) controls the
16712 rounding mode in effect.  The C library initializes this register for
16713 rounding towards plus infinity.  Thus, unless your program modifies the
16714 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
16715 @end table
16717 @item -mtrap-precision=@var{trap-precision}
16718 @opindex mtrap-precision
16719 In the Alpha architecture, floating-point traps are imprecise.  This
16720 means without software assistance it is impossible to recover from a
16721 floating trap and program execution normally needs to be terminated.
16722 GCC can generate code that can assist operating system trap handlers
16723 in determining the exact location that caused a floating-point trap.
16724 Depending on the requirements of an application, different levels of
16725 precisions can be selected:
16727 @table @samp
16728 @item p
16729 Program precision.  This option is the default and means a trap handler
16730 can only identify which program caused a floating-point exception.
16732 @item f
16733 Function precision.  The trap handler can determine the function that
16734 caused a floating-point exception.
16736 @item i
16737 Instruction precision.  The trap handler can determine the exact
16738 instruction that caused a floating-point exception.
16739 @end table
16741 Other Alpha compilers provide the equivalent options called
16742 @option{-scope_safe} and @option{-resumption_safe}.
16744 @item -mieee-conformant
16745 @opindex mieee-conformant
16746 This option marks the generated code as IEEE conformant.  You must not
16747 use this option unless you also specify @option{-mtrap-precision=i} and either
16748 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
16749 is to emit the line @samp{.eflag 48} in the function prologue of the
16750 generated assembly file.
16752 @item -mbuild-constants
16753 @opindex mbuild-constants
16754 Normally GCC examines a 32- or 64-bit integer constant to
16755 see if it can construct it from smaller constants in two or three
16756 instructions.  If it cannot, it outputs the constant as a literal and
16757 generates code to load it from the data segment at run time.
16759 Use this option to require GCC to construct @emph{all} integer constants
16760 using code, even if it takes more instructions (the maximum is six).
16762 You typically use this option to build a shared library dynamic
16763 loader.  Itself a shared library, it must relocate itself in memory
16764 before it can find the variables and constants in its own data segment.
16766 @item -mbwx
16767 @itemx -mno-bwx
16768 @itemx -mcix
16769 @itemx -mno-cix
16770 @itemx -mfix
16771 @itemx -mno-fix
16772 @itemx -mmax
16773 @itemx -mno-max
16774 @opindex mbwx
16775 @opindex mno-bwx
16776 @opindex mcix
16777 @opindex mno-cix
16778 @opindex mfix
16779 @opindex mno-fix
16780 @opindex mmax
16781 @opindex mno-max
16782 Indicate whether GCC should generate code to use the optional BWX,
16783 CIX, FIX and MAX instruction sets.  The default is to use the instruction
16784 sets supported by the CPU type specified via @option{-mcpu=} option or that
16785 of the CPU on which GCC was built if none is specified.
16787 @item -mfloat-vax
16788 @itemx -mfloat-ieee
16789 @opindex mfloat-vax
16790 @opindex mfloat-ieee
16791 Generate code that uses (does not use) VAX F and G floating-point
16792 arithmetic instead of IEEE single and double precision.
16794 @item -mexplicit-relocs
16795 @itemx -mno-explicit-relocs
16796 @opindex mexplicit-relocs
16797 @opindex mno-explicit-relocs
16798 Older Alpha assemblers provided no way to generate symbol relocations
16799 except via assembler macros.  Use of these macros does not allow
16800 optimal instruction scheduling.  GNU binutils as of version 2.12
16801 supports a new syntax that allows the compiler to explicitly mark
16802 which relocations should apply to which instructions.  This option
16803 is mostly useful for debugging, as GCC detects the capabilities of
16804 the assembler when it is built and sets the default accordingly.
16806 @item -msmall-data
16807 @itemx -mlarge-data
16808 @opindex msmall-data
16809 @opindex mlarge-data
16810 When @option{-mexplicit-relocs} is in effect, static data is
16811 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
16812 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
16813 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
16814 16-bit relocations off of the @code{$gp} register.  This limits the
16815 size of the small data area to 64KB, but allows the variables to be
16816 directly accessed via a single instruction.
16818 The default is @option{-mlarge-data}.  With this option the data area
16819 is limited to just below 2GB@.  Programs that require more than 2GB of
16820 data must use @code{malloc} or @code{mmap} to allocate the data in the
16821 heap instead of in the program's data segment.
16823 When generating code for shared libraries, @option{-fpic} implies
16824 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
16826 @item -msmall-text
16827 @itemx -mlarge-text
16828 @opindex msmall-text
16829 @opindex mlarge-text
16830 When @option{-msmall-text} is used, the compiler assumes that the
16831 code of the entire program (or shared library) fits in 4MB, and is
16832 thus reachable with a branch instruction.  When @option{-msmall-data}
16833 is used, the compiler can assume that all local symbols share the
16834 same @code{$gp} value, and thus reduce the number of instructions
16835 required for a function call from 4 to 1.
16837 The default is @option{-mlarge-text}.
16839 @item -mcpu=@var{cpu_type}
16840 @opindex mcpu
16841 Set the instruction set and instruction scheduling parameters for
16842 machine type @var{cpu_type}.  You can specify either the @samp{EV}
16843 style name or the corresponding chip number.  GCC supports scheduling
16844 parameters for the EV4, EV5 and EV6 family of processors and
16845 chooses the default values for the instruction set from the processor
16846 you specify.  If you do not specify a processor type, GCC defaults
16847 to the processor on which the compiler was built.
16849 Supported values for @var{cpu_type} are
16851 @table @samp
16852 @item ev4
16853 @itemx ev45
16854 @itemx 21064
16855 Schedules as an EV4 and has no instruction set extensions.
16857 @item ev5
16858 @itemx 21164
16859 Schedules as an EV5 and has no instruction set extensions.
16861 @item ev56
16862 @itemx 21164a
16863 Schedules as an EV5 and supports the BWX extension.
16865 @item pca56
16866 @itemx 21164pc
16867 @itemx 21164PC
16868 Schedules as an EV5 and supports the BWX and MAX extensions.
16870 @item ev6
16871 @itemx 21264
16872 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
16874 @item ev67
16875 @itemx 21264a
16876 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
16877 @end table
16879 Native toolchains also support the value @samp{native},
16880 which selects the best architecture option for the host processor.
16881 @option{-mcpu=native} has no effect if GCC does not recognize
16882 the processor.
16884 @item -mtune=@var{cpu_type}
16885 @opindex mtune
16886 Set only the instruction scheduling parameters for machine type
16887 @var{cpu_type}.  The instruction set is not changed.
16889 Native toolchains also support the value @samp{native},
16890 which selects the best architecture option for the host processor.
16891 @option{-mtune=native} has no effect if GCC does not recognize
16892 the processor.
16894 @item -mmemory-latency=@var{time}
16895 @opindex mmemory-latency
16896 Sets the latency the scheduler should assume for typical memory
16897 references as seen by the application.  This number is highly
16898 dependent on the memory access patterns used by the application
16899 and the size of the external cache on the machine.
16901 Valid options for @var{time} are
16903 @table @samp
16904 @item @var{number}
16905 A decimal number representing clock cycles.
16907 @item L1
16908 @itemx L2
16909 @itemx L3
16910 @itemx main
16911 The compiler contains estimates of the number of clock cycles for
16912 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
16913 (also called Dcache, Scache, and Bcache), as well as to main memory.
16914 Note that L3 is only valid for EV5.
16916 @end table
16917 @end table
16919 @node FR30 Options
16920 @subsection FR30 Options
16921 @cindex FR30 Options
16923 These options are defined specifically for the FR30 port.
16925 @table @gcctabopt
16927 @item -msmall-model
16928 @opindex msmall-model
16929 Use the small address space model.  This can produce smaller code, but
16930 it does assume that all symbolic values and addresses fit into a
16931 20-bit range.
16933 @item -mno-lsim
16934 @opindex mno-lsim
16935 Assume that runtime support has been provided and so there is no need
16936 to include the simulator library (@file{libsim.a}) on the linker
16937 command line.
16939 @end table
16941 @node FT32 Options
16942 @subsection FT32 Options
16943 @cindex FT32 Options
16945 These options are defined specifically for the FT32 port.
16947 @table @gcctabopt
16949 @item -msim
16950 @opindex msim
16951 Specifies that the program will be run on the simulator.  This causes
16952 an alternate runtime startup and library to be linked.
16953 You must not use this option when generating programs that will run on
16954 real hardware; you must provide your own runtime library for whatever
16955 I/O functions are needed.
16957 @item -mlra
16958 @opindex mlra
16959 Enable Local Register Allocation.  This is still experimental for FT32,
16960 so by default the compiler uses standard reload.
16962 @item -mnodiv
16963 @opindex mnodiv
16964 Do not use div and mod instructions.
16966 @end table
16968 @node FRV Options
16969 @subsection FRV Options
16970 @cindex FRV Options
16972 @table @gcctabopt
16973 @item -mgpr-32
16974 @opindex mgpr-32
16976 Only use the first 32 general-purpose registers.
16978 @item -mgpr-64
16979 @opindex mgpr-64
16981 Use all 64 general-purpose registers.
16983 @item -mfpr-32
16984 @opindex mfpr-32
16986 Use only the first 32 floating-point registers.
16988 @item -mfpr-64
16989 @opindex mfpr-64
16991 Use all 64 floating-point registers.
16993 @item -mhard-float
16994 @opindex mhard-float
16996 Use hardware instructions for floating-point operations.
16998 @item -msoft-float
16999 @opindex msoft-float
17001 Use library routines for floating-point operations.
17003 @item -malloc-cc
17004 @opindex malloc-cc
17006 Dynamically allocate condition code registers.
17008 @item -mfixed-cc
17009 @opindex mfixed-cc
17011 Do not try to dynamically allocate condition code registers, only
17012 use @code{icc0} and @code{fcc0}.
17014 @item -mdword
17015 @opindex mdword
17017 Change ABI to use double word insns.
17019 @item -mno-dword
17020 @opindex mno-dword
17022 Do not use double word instructions.
17024 @item -mdouble
17025 @opindex mdouble
17027 Use floating-point double instructions.
17029 @item -mno-double
17030 @opindex mno-double
17032 Do not use floating-point double instructions.
17034 @item -mmedia
17035 @opindex mmedia
17037 Use media instructions.
17039 @item -mno-media
17040 @opindex mno-media
17042 Do not use media instructions.
17044 @item -mmuladd
17045 @opindex mmuladd
17047 Use multiply and add/subtract instructions.
17049 @item -mno-muladd
17050 @opindex mno-muladd
17052 Do not use multiply and add/subtract instructions.
17054 @item -mfdpic
17055 @opindex mfdpic
17057 Select the FDPIC ABI, which uses function descriptors to represent
17058 pointers to functions.  Without any PIC/PIE-related options, it
17059 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17060 assumes GOT entries and small data are within a 12-bit range from the
17061 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17062 are computed with 32 bits.
17063 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17065 @item -minline-plt
17066 @opindex minline-plt
17068 Enable inlining of PLT entries in function calls to functions that are
17069 not known to bind locally.  It has no effect without @option{-mfdpic}.
17070 It's enabled by default if optimizing for speed and compiling for
17071 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17072 optimization option such as @option{-O3} or above is present in the
17073 command line.
17075 @item -mTLS
17076 @opindex mTLS
17078 Assume a large TLS segment when generating thread-local code.
17080 @item -mtls
17081 @opindex mtls
17083 Do not assume a large TLS segment when generating thread-local code.
17085 @item -mgprel-ro
17086 @opindex mgprel-ro
17088 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17089 that is known to be in read-only sections.  It's enabled by default,
17090 except for @option{-fpic} or @option{-fpie}: even though it may help
17091 make the global offset table smaller, it trades 1 instruction for 4.
17092 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17093 one of which may be shared by multiple symbols, and it avoids the need
17094 for a GOT entry for the referenced symbol, so it's more likely to be a
17095 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17097 @item -multilib-library-pic
17098 @opindex multilib-library-pic
17100 Link with the (library, not FD) pic libraries.  It's implied by
17101 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17102 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17103 it explicitly.
17105 @item -mlinked-fp
17106 @opindex mlinked-fp
17108 Follow the EABI requirement of always creating a frame pointer whenever
17109 a stack frame is allocated.  This option is enabled by default and can
17110 be disabled with @option{-mno-linked-fp}.
17112 @item -mlong-calls
17113 @opindex mlong-calls
17115 Use indirect addressing to call functions outside the current
17116 compilation unit.  This allows the functions to be placed anywhere
17117 within the 32-bit address space.
17119 @item -malign-labels
17120 @opindex malign-labels
17122 Try to align labels to an 8-byte boundary by inserting NOPs into the
17123 previous packet.  This option only has an effect when VLIW packing
17124 is enabled.  It doesn't create new packets; it merely adds NOPs to
17125 existing ones.
17127 @item -mlibrary-pic
17128 @opindex mlibrary-pic
17130 Generate position-independent EABI code.
17132 @item -macc-4
17133 @opindex macc-4
17135 Use only the first four media accumulator registers.
17137 @item -macc-8
17138 @opindex macc-8
17140 Use all eight media accumulator registers.
17142 @item -mpack
17143 @opindex mpack
17145 Pack VLIW instructions.
17147 @item -mno-pack
17148 @opindex mno-pack
17150 Do not pack VLIW instructions.
17152 @item -mno-eflags
17153 @opindex mno-eflags
17155 Do not mark ABI switches in e_flags.
17157 @item -mcond-move
17158 @opindex mcond-move
17160 Enable the use of conditional-move instructions (default).
17162 This switch is mainly for debugging the compiler and will likely be removed
17163 in a future version.
17165 @item -mno-cond-move
17166 @opindex mno-cond-move
17168 Disable the use of conditional-move instructions.
17170 This switch is mainly for debugging the compiler and will likely be removed
17171 in a future version.
17173 @item -mscc
17174 @opindex mscc
17176 Enable the use of conditional set instructions (default).
17178 This switch is mainly for debugging the compiler and will likely be removed
17179 in a future version.
17181 @item -mno-scc
17182 @opindex mno-scc
17184 Disable the use of conditional set instructions.
17186 This switch is mainly for debugging the compiler and will likely be removed
17187 in a future version.
17189 @item -mcond-exec
17190 @opindex mcond-exec
17192 Enable the use of conditional execution (default).
17194 This switch is mainly for debugging the compiler and will likely be removed
17195 in a future version.
17197 @item -mno-cond-exec
17198 @opindex mno-cond-exec
17200 Disable the use of conditional execution.
17202 This switch is mainly for debugging the compiler and will likely be removed
17203 in a future version.
17205 @item -mvliw-branch
17206 @opindex mvliw-branch
17208 Run a pass to pack branches into VLIW instructions (default).
17210 This switch is mainly for debugging the compiler and will likely be removed
17211 in a future version.
17213 @item -mno-vliw-branch
17214 @opindex mno-vliw-branch
17216 Do not run a pass to pack branches into VLIW instructions.
17218 This switch is mainly for debugging the compiler and will likely be removed
17219 in a future version.
17221 @item -mmulti-cond-exec
17222 @opindex mmulti-cond-exec
17224 Enable optimization of @code{&&} and @code{||} in conditional execution
17225 (default).
17227 This switch is mainly for debugging the compiler and will likely be removed
17228 in a future version.
17230 @item -mno-multi-cond-exec
17231 @opindex mno-multi-cond-exec
17233 Disable optimization of @code{&&} and @code{||} in conditional execution.
17235 This switch is mainly for debugging the compiler and will likely be removed
17236 in a future version.
17238 @item -mnested-cond-exec
17239 @opindex mnested-cond-exec
17241 Enable nested conditional execution optimizations (default).
17243 This switch is mainly for debugging the compiler and will likely be removed
17244 in a future version.
17246 @item -mno-nested-cond-exec
17247 @opindex mno-nested-cond-exec
17249 Disable nested conditional execution optimizations.
17251 This switch is mainly for debugging the compiler and will likely be removed
17252 in a future version.
17254 @item -moptimize-membar
17255 @opindex moptimize-membar
17257 This switch removes redundant @code{membar} instructions from the
17258 compiler-generated code.  It is enabled by default.
17260 @item -mno-optimize-membar
17261 @opindex mno-optimize-membar
17263 This switch disables the automatic removal of redundant @code{membar}
17264 instructions from the generated code.
17266 @item -mtomcat-stats
17267 @opindex mtomcat-stats
17269 Cause gas to print out tomcat statistics.
17271 @item -mcpu=@var{cpu}
17272 @opindex mcpu
17274 Select the processor type for which to generate code.  Possible values are
17275 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17276 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17278 @end table
17280 @node GNU/Linux Options
17281 @subsection GNU/Linux Options
17283 These @samp{-m} options are defined for GNU/Linux targets:
17285 @table @gcctabopt
17286 @item -mglibc
17287 @opindex mglibc
17288 Use the GNU C library.  This is the default except
17289 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17290 @samp{*-*-linux-*android*} targets.
17292 @item -muclibc
17293 @opindex muclibc
17294 Use uClibc C library.  This is the default on
17295 @samp{*-*-linux-*uclibc*} targets.
17297 @item -mmusl
17298 @opindex mmusl
17299 Use the musl C library.  This is the default on
17300 @samp{*-*-linux-*musl*} targets.
17302 @item -mbionic
17303 @opindex mbionic
17304 Use Bionic C library.  This is the default on
17305 @samp{*-*-linux-*android*} targets.
17307 @item -mandroid
17308 @opindex mandroid
17309 Compile code compatible with Android platform.  This is the default on
17310 @samp{*-*-linux-*android*} targets.
17312 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17313 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17314 this option makes the GCC driver pass Android-specific options to the linker.
17315 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17316 to be defined.
17318 @item -tno-android-cc
17319 @opindex tno-android-cc
17320 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17321 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17322 @option{-fno-rtti} by default.
17324 @item -tno-android-ld
17325 @opindex tno-android-ld
17326 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17327 linking options to the linker.
17329 @end table
17331 @node H8/300 Options
17332 @subsection H8/300 Options
17334 These @samp{-m} options are defined for the H8/300 implementations:
17336 @table @gcctabopt
17337 @item -mrelax
17338 @opindex mrelax
17339 Shorten some address references at link time, when possible; uses the
17340 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17341 ld, Using ld}, for a fuller description.
17343 @item -mh
17344 @opindex mh
17345 Generate code for the H8/300H@.
17347 @item -ms
17348 @opindex ms
17349 Generate code for the H8S@.
17351 @item -mn
17352 @opindex mn
17353 Generate code for the H8S and H8/300H in the normal mode.  This switch
17354 must be used either with @option{-mh} or @option{-ms}.
17356 @item -ms2600
17357 @opindex ms2600
17358 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17360 @item -mexr
17361 @opindex mexr
17362 Extended registers are stored on stack before execution of function
17363 with monitor attribute. Default option is @option{-mexr}.
17364 This option is valid only for H8S targets.
17366 @item -mno-exr
17367 @opindex mno-exr
17368 Extended registers are not stored on stack before execution of function 
17369 with monitor attribute. Default option is @option{-mno-exr}. 
17370 This option is valid only for H8S targets.
17372 @item -mint32
17373 @opindex mint32
17374 Make @code{int} data 32 bits by default.
17376 @item -malign-300
17377 @opindex malign-300
17378 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17379 The default for the H8/300H and H8S is to align longs and floats on
17380 4-byte boundaries.
17381 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17382 This option has no effect on the H8/300.
17383 @end table
17385 @node HPPA Options
17386 @subsection HPPA Options
17387 @cindex HPPA Options
17389 These @samp{-m} options are defined for the HPPA family of computers:
17391 @table @gcctabopt
17392 @item -march=@var{architecture-type}
17393 @opindex march
17394 Generate code for the specified architecture.  The choices for
17395 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17396 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17397 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17398 architecture option for your machine.  Code compiled for lower numbered
17399 architectures runs on higher numbered architectures, but not the
17400 other way around.
17402 @item -mpa-risc-1-0
17403 @itemx -mpa-risc-1-1
17404 @itemx -mpa-risc-2-0
17405 @opindex mpa-risc-1-0
17406 @opindex mpa-risc-1-1
17407 @opindex mpa-risc-2-0
17408 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17410 @item -mcaller-copies
17411 @opindex mcaller-copies
17412 The caller copies function arguments passed by hidden reference.  This
17413 option should be used with care as it is not compatible with the default
17414 32-bit runtime.  However, only aggregates larger than eight bytes are
17415 passed by hidden reference and the option provides better compatibility
17416 with OpenMP.
17418 @item -mjump-in-delay
17419 @opindex mjump-in-delay
17420 This option is ignored and provided for compatibility purposes only.
17422 @item -mdisable-fpregs
17423 @opindex mdisable-fpregs
17424 Prevent floating-point registers from being used in any manner.  This is
17425 necessary for compiling kernels that perform lazy context switching of
17426 floating-point registers.  If you use this option and attempt to perform
17427 floating-point operations, the compiler aborts.
17429 @item -mdisable-indexing
17430 @opindex mdisable-indexing
17431 Prevent the compiler from using indexing address modes.  This avoids some
17432 rather obscure problems when compiling MIG generated code under MACH@.
17434 @item -mno-space-regs
17435 @opindex mno-space-regs
17436 Generate code that assumes the target has no space registers.  This allows
17437 GCC to generate faster indirect calls and use unscaled index address modes.
17439 Such code is suitable for level 0 PA systems and kernels.
17441 @item -mfast-indirect-calls
17442 @opindex mfast-indirect-calls
17443 Generate code that assumes calls never cross space boundaries.  This
17444 allows GCC to emit code that performs faster indirect calls.
17446 This option does not work in the presence of shared libraries or nested
17447 functions.
17449 @item -mfixed-range=@var{register-range}
17450 @opindex mfixed-range
17451 Generate code treating the given register range as fixed registers.
17452 A fixed register is one that the register allocator cannot use.  This is
17453 useful when compiling kernel code.  A register range is specified as
17454 two registers separated by a dash.  Multiple register ranges can be
17455 specified separated by a comma.
17457 @item -mlong-load-store
17458 @opindex mlong-load-store
17459 Generate 3-instruction load and store sequences as sometimes required by
17460 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17461 the HP compilers.
17463 @item -mportable-runtime
17464 @opindex mportable-runtime
17465 Use the portable calling conventions proposed by HP for ELF systems.
17467 @item -mgas
17468 @opindex mgas
17469 Enable the use of assembler directives only GAS understands.
17471 @item -mschedule=@var{cpu-type}
17472 @opindex mschedule
17473 Schedule code according to the constraints for the machine type
17474 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17475 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17476 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17477 proper scheduling option for your machine.  The default scheduling is
17478 @samp{8000}.
17480 @item -mlinker-opt
17481 @opindex mlinker-opt
17482 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17483 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17484 linkers in which they give bogus error messages when linking some programs.
17486 @item -msoft-float
17487 @opindex msoft-float
17488 Generate output containing library calls for floating point.
17489 @strong{Warning:} the requisite libraries are not available for all HPPA
17490 targets.  Normally the facilities of the machine's usual C compiler are
17491 used, but this cannot be done directly in cross-compilation.  You must make
17492 your own arrangements to provide suitable library functions for
17493 cross-compilation.
17495 @option{-msoft-float} changes the calling convention in the output file;
17496 therefore, it is only useful if you compile @emph{all} of a program with
17497 this option.  In particular, you need to compile @file{libgcc.a}, the
17498 library that comes with GCC, with @option{-msoft-float} in order for
17499 this to work.
17501 @item -msio
17502 @opindex msio
17503 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17504 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17505 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17506 options are available under HP-UX and HI-UX@.
17508 @item -mgnu-ld
17509 @opindex mgnu-ld
17510 Use options specific to GNU @command{ld}.
17511 This passes @option{-shared} to @command{ld} when
17512 building a shared library.  It is the default when GCC is configured,
17513 explicitly or implicitly, with the GNU linker.  This option does not
17514 affect which @command{ld} is called; it only changes what parameters
17515 are passed to that @command{ld}.
17516 The @command{ld} that is called is determined by the
17517 @option{--with-ld} configure option, GCC's program search path, and
17518 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17519 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17520 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17522 @item -mhp-ld
17523 @opindex mhp-ld
17524 Use options specific to HP @command{ld}.
17525 This passes @option{-b} to @command{ld} when building
17526 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17527 links.  It is the default when GCC is configured, explicitly or
17528 implicitly, with the HP linker.  This option does not affect
17529 which @command{ld} is called; it only changes what parameters are passed to that
17530 @command{ld}.
17531 The @command{ld} that is called is determined by the @option{--with-ld}
17532 configure option, GCC's program search path, and finally by the user's
17533 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17534 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17535 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17537 @item -mlong-calls
17538 @opindex mno-long-calls
17539 Generate code that uses long call sequences.  This ensures that a call
17540 is always able to reach linker generated stubs.  The default is to generate
17541 long calls only when the distance from the call site to the beginning
17542 of the function or translation unit, as the case may be, exceeds a
17543 predefined limit set by the branch type being used.  The limits for
17544 normal calls are 7,600,000 and 240,000 bytes, respectively for the
17545 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
17546 240,000 bytes.
17548 Distances are measured from the beginning of functions when using the
17549 @option{-ffunction-sections} option, or when using the @option{-mgas}
17550 and @option{-mno-portable-runtime} options together under HP-UX with
17551 the SOM linker.
17553 It is normally not desirable to use this option as it degrades
17554 performance.  However, it may be useful in large applications,
17555 particularly when partial linking is used to build the application.
17557 The types of long calls used depends on the capabilities of the
17558 assembler and linker, and the type of code being generated.  The
17559 impact on systems that support long absolute calls, and long pic
17560 symbol-difference or pc-relative calls should be relatively small.
17561 However, an indirect call is used on 32-bit ELF systems in pic code
17562 and it is quite long.
17564 @item -munix=@var{unix-std}
17565 @opindex march
17566 Generate compiler predefines and select a startfile for the specified
17567 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
17568 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
17569 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
17570 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
17571 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
17572 and later.
17574 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
17575 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
17576 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
17577 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
17578 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
17579 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
17581 It is @emph{important} to note that this option changes the interfaces
17582 for various library routines.  It also affects the operational behavior
17583 of the C library.  Thus, @emph{extreme} care is needed in using this
17584 option.
17586 Library code that is intended to operate with more than one UNIX
17587 standard must test, set and restore the variable @code{__xpg4_extended_mask}
17588 as appropriate.  Most GNU software doesn't provide this capability.
17590 @item -nolibdld
17591 @opindex nolibdld
17592 Suppress the generation of link options to search libdld.sl when the
17593 @option{-static} option is specified on HP-UX 10 and later.
17595 @item -static
17596 @opindex static
17597 The HP-UX implementation of setlocale in libc has a dependency on
17598 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
17599 when the @option{-static} option is specified, special link options
17600 are needed to resolve this dependency.
17602 On HP-UX 10 and later, the GCC driver adds the necessary options to
17603 link with libdld.sl when the @option{-static} option is specified.
17604 This causes the resulting binary to be dynamic.  On the 64-bit port,
17605 the linkers generate dynamic binaries by default in any case.  The
17606 @option{-nolibdld} option can be used to prevent the GCC driver from
17607 adding these link options.
17609 @item -threads
17610 @opindex threads
17611 Add support for multithreading with the @dfn{dce thread} library
17612 under HP-UX@.  This option sets flags for both the preprocessor and
17613 linker.
17614 @end table
17616 @node IA-64 Options
17617 @subsection IA-64 Options
17618 @cindex IA-64 Options
17620 These are the @samp{-m} options defined for the Intel IA-64 architecture.
17622 @table @gcctabopt
17623 @item -mbig-endian
17624 @opindex mbig-endian
17625 Generate code for a big-endian target.  This is the default for HP-UX@.
17627 @item -mlittle-endian
17628 @opindex mlittle-endian
17629 Generate code for a little-endian target.  This is the default for AIX5
17630 and GNU/Linux.
17632 @item -mgnu-as
17633 @itemx -mno-gnu-as
17634 @opindex mgnu-as
17635 @opindex mno-gnu-as
17636 Generate (or don't) code for the GNU assembler.  This is the default.
17637 @c Also, this is the default if the configure option @option{--with-gnu-as}
17638 @c is used.
17640 @item -mgnu-ld
17641 @itemx -mno-gnu-ld
17642 @opindex mgnu-ld
17643 @opindex mno-gnu-ld
17644 Generate (or don't) code for the GNU linker.  This is the default.
17645 @c Also, this is the default if the configure option @option{--with-gnu-ld}
17646 @c is used.
17648 @item -mno-pic
17649 @opindex mno-pic
17650 Generate code that does not use a global pointer register.  The result
17651 is not position independent code, and violates the IA-64 ABI@.
17653 @item -mvolatile-asm-stop
17654 @itemx -mno-volatile-asm-stop
17655 @opindex mvolatile-asm-stop
17656 @opindex mno-volatile-asm-stop
17657 Generate (or don't) a stop bit immediately before and after volatile asm
17658 statements.
17660 @item -mregister-names
17661 @itemx -mno-register-names
17662 @opindex mregister-names
17663 @opindex mno-register-names
17664 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
17665 the stacked registers.  This may make assembler output more readable.
17667 @item -mno-sdata
17668 @itemx -msdata
17669 @opindex mno-sdata
17670 @opindex msdata
17671 Disable (or enable) optimizations that use the small data section.  This may
17672 be useful for working around optimizer bugs.
17674 @item -mconstant-gp
17675 @opindex mconstant-gp
17676 Generate code that uses a single constant global pointer value.  This is
17677 useful when compiling kernel code.
17679 @item -mauto-pic
17680 @opindex mauto-pic
17681 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
17682 This is useful when compiling firmware code.
17684 @item -minline-float-divide-min-latency
17685 @opindex minline-float-divide-min-latency
17686 Generate code for inline divides of floating-point values
17687 using the minimum latency algorithm.
17689 @item -minline-float-divide-max-throughput
17690 @opindex minline-float-divide-max-throughput
17691 Generate code for inline divides of floating-point values
17692 using the maximum throughput algorithm.
17694 @item -mno-inline-float-divide
17695 @opindex mno-inline-float-divide
17696 Do not generate inline code for divides of floating-point values.
17698 @item -minline-int-divide-min-latency
17699 @opindex minline-int-divide-min-latency
17700 Generate code for inline divides of integer values
17701 using the minimum latency algorithm.
17703 @item -minline-int-divide-max-throughput
17704 @opindex minline-int-divide-max-throughput
17705 Generate code for inline divides of integer values
17706 using the maximum throughput algorithm.
17708 @item -mno-inline-int-divide
17709 @opindex mno-inline-int-divide
17710 Do not generate inline code for divides of integer values.
17712 @item -minline-sqrt-min-latency
17713 @opindex minline-sqrt-min-latency
17714 Generate code for inline square roots
17715 using the minimum latency algorithm.
17717 @item -minline-sqrt-max-throughput
17718 @opindex minline-sqrt-max-throughput
17719 Generate code for inline square roots
17720 using the maximum throughput algorithm.
17722 @item -mno-inline-sqrt
17723 @opindex mno-inline-sqrt
17724 Do not generate inline code for @code{sqrt}.
17726 @item -mfused-madd
17727 @itemx -mno-fused-madd
17728 @opindex mfused-madd
17729 @opindex mno-fused-madd
17730 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
17731 instructions.  The default is to use these instructions.
17733 @item -mno-dwarf2-asm
17734 @itemx -mdwarf2-asm
17735 @opindex mno-dwarf2-asm
17736 @opindex mdwarf2-asm
17737 Don't (or do) generate assembler code for the DWARF line number debugging
17738 info.  This may be useful when not using the GNU assembler.
17740 @item -mearly-stop-bits
17741 @itemx -mno-early-stop-bits
17742 @opindex mearly-stop-bits
17743 @opindex mno-early-stop-bits
17744 Allow stop bits to be placed earlier than immediately preceding the
17745 instruction that triggered the stop bit.  This can improve instruction
17746 scheduling, but does not always do so.
17748 @item -mfixed-range=@var{register-range}
17749 @opindex mfixed-range
17750 Generate code treating the given register range as fixed registers.
17751 A fixed register is one that the register allocator cannot use.  This is
17752 useful when compiling kernel code.  A register range is specified as
17753 two registers separated by a dash.  Multiple register ranges can be
17754 specified separated by a comma.
17756 @item -mtls-size=@var{tls-size}
17757 @opindex mtls-size
17758 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
17761 @item -mtune=@var{cpu-type}
17762 @opindex mtune
17763 Tune the instruction scheduling for a particular CPU, Valid values are
17764 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
17765 and @samp{mckinley}.
17767 @item -milp32
17768 @itemx -mlp64
17769 @opindex milp32
17770 @opindex mlp64
17771 Generate code for a 32-bit or 64-bit environment.
17772 The 32-bit environment sets int, long and pointer to 32 bits.
17773 The 64-bit environment sets int to 32 bits and long and pointer
17774 to 64 bits.  These are HP-UX specific flags.
17776 @item -mno-sched-br-data-spec
17777 @itemx -msched-br-data-spec
17778 @opindex mno-sched-br-data-spec
17779 @opindex msched-br-data-spec
17780 (Dis/En)able data speculative scheduling before reload.
17781 This results in generation of @code{ld.a} instructions and
17782 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17783 The default setting is disabled.
17785 @item -msched-ar-data-spec
17786 @itemx -mno-sched-ar-data-spec
17787 @opindex msched-ar-data-spec
17788 @opindex mno-sched-ar-data-spec
17789 (En/Dis)able data speculative scheduling after reload.
17790 This results in generation of @code{ld.a} instructions and
17791 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17792 The default setting is enabled.
17794 @item -mno-sched-control-spec
17795 @itemx -msched-control-spec
17796 @opindex mno-sched-control-spec
17797 @opindex msched-control-spec
17798 (Dis/En)able control speculative scheduling.  This feature is
17799 available only during region scheduling (i.e.@: before reload).
17800 This results in generation of the @code{ld.s} instructions and
17801 the corresponding check instructions @code{chk.s}.
17802 The default setting is disabled.
17804 @item -msched-br-in-data-spec
17805 @itemx -mno-sched-br-in-data-spec
17806 @opindex msched-br-in-data-spec
17807 @opindex mno-sched-br-in-data-spec
17808 (En/Dis)able speculative scheduling of the instructions that
17809 are dependent on the data speculative loads before reload.
17810 This is effective only with @option{-msched-br-data-spec} enabled.
17811 The default setting is enabled.
17813 @item -msched-ar-in-data-spec
17814 @itemx -mno-sched-ar-in-data-spec
17815 @opindex msched-ar-in-data-spec
17816 @opindex mno-sched-ar-in-data-spec
17817 (En/Dis)able speculative scheduling of the instructions that
17818 are dependent on the data speculative loads after reload.
17819 This is effective only with @option{-msched-ar-data-spec} enabled.
17820 The default setting is enabled.
17822 @item -msched-in-control-spec
17823 @itemx -mno-sched-in-control-spec
17824 @opindex msched-in-control-spec
17825 @opindex mno-sched-in-control-spec
17826 (En/Dis)able speculative scheduling of the instructions that
17827 are dependent on the control speculative loads.
17828 This is effective only with @option{-msched-control-spec} enabled.
17829 The default setting is enabled.
17831 @item -mno-sched-prefer-non-data-spec-insns
17832 @itemx -msched-prefer-non-data-spec-insns
17833 @opindex mno-sched-prefer-non-data-spec-insns
17834 @opindex msched-prefer-non-data-spec-insns
17835 If enabled, data-speculative instructions are chosen for schedule
17836 only if there are no other choices at the moment.  This makes
17837 the use of the data speculation much more conservative.
17838 The default setting is disabled.
17840 @item -mno-sched-prefer-non-control-spec-insns
17841 @itemx -msched-prefer-non-control-spec-insns
17842 @opindex mno-sched-prefer-non-control-spec-insns
17843 @opindex msched-prefer-non-control-spec-insns
17844 If enabled, control-speculative instructions are chosen for schedule
17845 only if there are no other choices at the moment.  This makes
17846 the use of the control speculation much more conservative.
17847 The default setting is disabled.
17849 @item -mno-sched-count-spec-in-critical-path
17850 @itemx -msched-count-spec-in-critical-path
17851 @opindex mno-sched-count-spec-in-critical-path
17852 @opindex msched-count-spec-in-critical-path
17853 If enabled, speculative dependencies are considered during
17854 computation of the instructions priorities.  This makes the use of the
17855 speculation a bit more conservative.
17856 The default setting is disabled.
17858 @item -msched-spec-ldc
17859 @opindex msched-spec-ldc
17860 Use a simple data speculation check.  This option is on by default.
17862 @item -msched-control-spec-ldc
17863 @opindex msched-spec-ldc
17864 Use a simple check for control speculation.  This option is on by default.
17866 @item -msched-stop-bits-after-every-cycle
17867 @opindex msched-stop-bits-after-every-cycle
17868 Place a stop bit after every cycle when scheduling.  This option is on
17869 by default.
17871 @item -msched-fp-mem-deps-zero-cost
17872 @opindex msched-fp-mem-deps-zero-cost
17873 Assume that floating-point stores and loads are not likely to cause a conflict
17874 when placed into the same instruction group.  This option is disabled by
17875 default.
17877 @item -msel-sched-dont-check-control-spec
17878 @opindex msel-sched-dont-check-control-spec
17879 Generate checks for control speculation in selective scheduling.
17880 This flag is disabled by default.
17882 @item -msched-max-memory-insns=@var{max-insns}
17883 @opindex msched-max-memory-insns
17884 Limit on the number of memory insns per instruction group, giving lower
17885 priority to subsequent memory insns attempting to schedule in the same
17886 instruction group. Frequently useful to prevent cache bank conflicts.
17887 The default value is 1.
17889 @item -msched-max-memory-insns-hard-limit
17890 @opindex msched-max-memory-insns-hard-limit
17891 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
17892 disallowing more than that number in an instruction group.
17893 Otherwise, the limit is ``soft'', meaning that non-memory operations
17894 are preferred when the limit is reached, but memory operations may still
17895 be scheduled.
17897 @end table
17899 @node LM32 Options
17900 @subsection LM32 Options
17901 @cindex LM32 options
17903 These @option{-m} options are defined for the LatticeMico32 architecture:
17905 @table @gcctabopt
17906 @item -mbarrel-shift-enabled
17907 @opindex mbarrel-shift-enabled
17908 Enable barrel-shift instructions.
17910 @item -mdivide-enabled
17911 @opindex mdivide-enabled
17912 Enable divide and modulus instructions.
17914 @item -mmultiply-enabled
17915 @opindex multiply-enabled
17916 Enable multiply instructions.
17918 @item -msign-extend-enabled
17919 @opindex msign-extend-enabled
17920 Enable sign extend instructions.
17922 @item -muser-enabled
17923 @opindex muser-enabled
17924 Enable user-defined instructions.
17926 @end table
17928 @node M32C Options
17929 @subsection M32C Options
17930 @cindex M32C options
17932 @table @gcctabopt
17933 @item -mcpu=@var{name}
17934 @opindex mcpu=
17935 Select the CPU for which code is generated.  @var{name} may be one of
17936 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
17937 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
17938 the M32C/80 series.
17940 @item -msim
17941 @opindex msim
17942 Specifies that the program will be run on the simulator.  This causes
17943 an alternate runtime library to be linked in which supports, for
17944 example, file I/O@.  You must not use this option when generating
17945 programs that will run on real hardware; you must provide your own
17946 runtime library for whatever I/O functions are needed.
17948 @item -memregs=@var{number}
17949 @opindex memregs=
17950 Specifies the number of memory-based pseudo-registers GCC uses
17951 during code generation.  These pseudo-registers are used like real
17952 registers, so there is a tradeoff between GCC's ability to fit the
17953 code into available registers, and the performance penalty of using
17954 memory instead of registers.  Note that all modules in a program must
17955 be compiled with the same value for this option.  Because of that, you
17956 must not use this option with GCC's default runtime libraries.
17958 @end table
17960 @node M32R/D Options
17961 @subsection M32R/D Options
17962 @cindex M32R/D options
17964 These @option{-m} options are defined for Renesas M32R/D architectures:
17966 @table @gcctabopt
17967 @item -m32r2
17968 @opindex m32r2
17969 Generate code for the M32R/2@.
17971 @item -m32rx
17972 @opindex m32rx
17973 Generate code for the M32R/X@.
17975 @item -m32r
17976 @opindex m32r
17977 Generate code for the M32R@.  This is the default.
17979 @item -mmodel=small
17980 @opindex mmodel=small
17981 Assume all objects live in the lower 16MB of memory (so that their addresses
17982 can be loaded with the @code{ld24} instruction), and assume all subroutines
17983 are reachable with the @code{bl} instruction.
17984 This is the default.
17986 The addressability of a particular object can be set with the
17987 @code{model} attribute.
17989 @item -mmodel=medium
17990 @opindex mmodel=medium
17991 Assume objects may be anywhere in the 32-bit address space (the compiler
17992 generates @code{seth/add3} instructions to load their addresses), and
17993 assume all subroutines are reachable with the @code{bl} instruction.
17995 @item -mmodel=large
17996 @opindex mmodel=large
17997 Assume objects may be anywhere in the 32-bit address space (the compiler
17998 generates @code{seth/add3} instructions to load their addresses), and
17999 assume subroutines may not be reachable with the @code{bl} instruction
18000 (the compiler generates the much slower @code{seth/add3/jl}
18001 instruction sequence).
18003 @item -msdata=none
18004 @opindex msdata=none
18005 Disable use of the small data area.  Variables are put into
18006 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18007 @code{section} attribute has been specified).
18008 This is the default.
18010 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18011 Objects may be explicitly put in the small data area with the
18012 @code{section} attribute using one of these sections.
18014 @item -msdata=sdata
18015 @opindex msdata=sdata
18016 Put small global and static data in the small data area, but do not
18017 generate special code to reference them.
18019 @item -msdata=use
18020 @opindex msdata=use
18021 Put small global and static data in the small data area, and generate
18022 special instructions to reference them.
18024 @item -G @var{num}
18025 @opindex G
18026 @cindex smaller data references
18027 Put global and static objects less than or equal to @var{num} bytes
18028 into the small data or BSS sections instead of the normal data or BSS
18029 sections.  The default value of @var{num} is 8.
18030 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18031 for this option to have any effect.
18033 All modules should be compiled with the same @option{-G @var{num}} value.
18034 Compiling with different values of @var{num} may or may not work; if it
18035 doesn't the linker gives an error message---incorrect code is not
18036 generated.
18038 @item -mdebug
18039 @opindex mdebug
18040 Makes the M32R-specific code in the compiler display some statistics
18041 that might help in debugging programs.
18043 @item -malign-loops
18044 @opindex malign-loops
18045 Align all loops to a 32-byte boundary.
18047 @item -mno-align-loops
18048 @opindex mno-align-loops
18049 Do not enforce a 32-byte alignment for loops.  This is the default.
18051 @item -missue-rate=@var{number}
18052 @opindex missue-rate=@var{number}
18053 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18054 or 2.
18056 @item -mbranch-cost=@var{number}
18057 @opindex mbranch-cost=@var{number}
18058 @var{number} can only be 1 or 2.  If it is 1 then branches are
18059 preferred over conditional code, if it is 2, then the opposite applies.
18061 @item -mflush-trap=@var{number}
18062 @opindex mflush-trap=@var{number}
18063 Specifies the trap number to use to flush the cache.  The default is
18064 12.  Valid numbers are between 0 and 15 inclusive.
18066 @item -mno-flush-trap
18067 @opindex mno-flush-trap
18068 Specifies that the cache cannot be flushed by using a trap.
18070 @item -mflush-func=@var{name}
18071 @opindex mflush-func=@var{name}
18072 Specifies the name of the operating system function to call to flush
18073 the cache.  The default is @samp{_flush_cache}, but a function call
18074 is only used if a trap is not available.
18076 @item -mno-flush-func
18077 @opindex mno-flush-func
18078 Indicates that there is no OS function for flushing the cache.
18080 @end table
18082 @node M680x0 Options
18083 @subsection M680x0 Options
18084 @cindex M680x0 options
18086 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18087 The default settings depend on which architecture was selected when
18088 the compiler was configured; the defaults for the most common choices
18089 are given below.
18091 @table @gcctabopt
18092 @item -march=@var{arch}
18093 @opindex march
18094 Generate code for a specific M680x0 or ColdFire instruction set
18095 architecture.  Permissible values of @var{arch} for M680x0
18096 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18097 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18098 architectures are selected according to Freescale's ISA classification
18099 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18100 @samp{isab} and @samp{isac}.
18102 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18103 code for a ColdFire target.  The @var{arch} in this macro is one of the
18104 @option{-march} arguments given above.
18106 When used together, @option{-march} and @option{-mtune} select code
18107 that runs on a family of similar processors but that is optimized
18108 for a particular microarchitecture.
18110 @item -mcpu=@var{cpu}
18111 @opindex mcpu
18112 Generate code for a specific M680x0 or ColdFire processor.
18113 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18114 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18115 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18116 below, which also classifies the CPUs into families:
18118 @multitable @columnfractions 0.20 0.80
18119 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18120 @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}
18121 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18122 @item @samp{5206e} @tab @samp{5206e}
18123 @item @samp{5208} @tab @samp{5207} @samp{5208}
18124 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18125 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18126 @item @samp{5216} @tab @samp{5214} @samp{5216}
18127 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18128 @item @samp{5225} @tab @samp{5224} @samp{5225}
18129 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18130 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18131 @item @samp{5249} @tab @samp{5249}
18132 @item @samp{5250} @tab @samp{5250}
18133 @item @samp{5271} @tab @samp{5270} @samp{5271}
18134 @item @samp{5272} @tab @samp{5272}
18135 @item @samp{5275} @tab @samp{5274} @samp{5275}
18136 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18137 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18138 @item @samp{5307} @tab @samp{5307}
18139 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18140 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18141 @item @samp{5407} @tab @samp{5407}
18142 @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}
18143 @end multitable
18145 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18146 @var{arch} is compatible with @var{cpu}.  Other combinations of
18147 @option{-mcpu} and @option{-march} are rejected.
18149 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18150 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18151 where the value of @var{family} is given by the table above.
18153 @item -mtune=@var{tune}
18154 @opindex mtune
18155 Tune the code for a particular microarchitecture within the
18156 constraints set by @option{-march} and @option{-mcpu}.
18157 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18158 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18159 and @samp{cpu32}.  The ColdFire microarchitectures
18160 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18162 You can also use @option{-mtune=68020-40} for code that needs
18163 to run relatively well on 68020, 68030 and 68040 targets.
18164 @option{-mtune=68020-60} is similar but includes 68060 targets
18165 as well.  These two options select the same tuning decisions as
18166 @option{-m68020-40} and @option{-m68020-60} respectively.
18168 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18169 when tuning for 680x0 architecture @var{arch}.  It also defines
18170 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18171 option is used.  If GCC is tuning for a range of architectures,
18172 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18173 it defines the macros for every architecture in the range.
18175 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18176 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18177 of the arguments given above.
18179 @item -m68000
18180 @itemx -mc68000
18181 @opindex m68000
18182 @opindex mc68000
18183 Generate output for a 68000.  This is the default
18184 when the compiler is configured for 68000-based systems.
18185 It is equivalent to @option{-march=68000}.
18187 Use this option for microcontrollers with a 68000 or EC000 core,
18188 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18190 @item -m68010
18191 @opindex m68010
18192 Generate output for a 68010.  This is the default
18193 when the compiler is configured for 68010-based systems.
18194 It is equivalent to @option{-march=68010}.
18196 @item -m68020
18197 @itemx -mc68020
18198 @opindex m68020
18199 @opindex mc68020
18200 Generate output for a 68020.  This is the default
18201 when the compiler is configured for 68020-based systems.
18202 It is equivalent to @option{-march=68020}.
18204 @item -m68030
18205 @opindex m68030
18206 Generate output for a 68030.  This is the default when the compiler is
18207 configured for 68030-based systems.  It is equivalent to
18208 @option{-march=68030}.
18210 @item -m68040
18211 @opindex m68040
18212 Generate output for a 68040.  This is the default when the compiler is
18213 configured for 68040-based systems.  It is equivalent to
18214 @option{-march=68040}.
18216 This option inhibits the use of 68881/68882 instructions that have to be
18217 emulated by software on the 68040.  Use this option if your 68040 does not
18218 have code to emulate those instructions.
18220 @item -m68060
18221 @opindex m68060
18222 Generate output for a 68060.  This is the default when the compiler is
18223 configured for 68060-based systems.  It is equivalent to
18224 @option{-march=68060}.
18226 This option inhibits the use of 68020 and 68881/68882 instructions that
18227 have to be emulated by software on the 68060.  Use this option if your 68060
18228 does not have code to emulate those instructions.
18230 @item -mcpu32
18231 @opindex mcpu32
18232 Generate output for a CPU32.  This is the default
18233 when the compiler is configured for CPU32-based systems.
18234 It is equivalent to @option{-march=cpu32}.
18236 Use this option for microcontrollers with a
18237 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18238 68336, 68340, 68341, 68349 and 68360.
18240 @item -m5200
18241 @opindex m5200
18242 Generate output for a 520X ColdFire CPU@.  This is the default
18243 when the compiler is configured for 520X-based systems.
18244 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18245 in favor of that option.
18247 Use this option for microcontroller with a 5200 core, including
18248 the MCF5202, MCF5203, MCF5204 and MCF5206.
18250 @item -m5206e
18251 @opindex m5206e
18252 Generate output for a 5206e ColdFire CPU@.  The option is now
18253 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18255 @item -m528x
18256 @opindex m528x
18257 Generate output for a member of the ColdFire 528X family.
18258 The option is now deprecated in favor of the equivalent
18259 @option{-mcpu=528x}.
18261 @item -m5307
18262 @opindex m5307
18263 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18264 in favor of the equivalent @option{-mcpu=5307}.
18266 @item -m5407
18267 @opindex m5407
18268 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18269 in favor of the equivalent @option{-mcpu=5407}.
18271 @item -mcfv4e
18272 @opindex mcfv4e
18273 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18274 This includes use of hardware floating-point instructions.
18275 The option is equivalent to @option{-mcpu=547x}, and is now
18276 deprecated in favor of that option.
18278 @item -m68020-40
18279 @opindex m68020-40
18280 Generate output for a 68040, without using any of the new instructions.
18281 This results in code that can run relatively efficiently on either a
18282 68020/68881 or a 68030 or a 68040.  The generated code does use the
18283 68881 instructions that are emulated on the 68040.
18285 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18287 @item -m68020-60
18288 @opindex m68020-60
18289 Generate output for a 68060, without using any of the new instructions.
18290 This results in code that can run relatively efficiently on either a
18291 68020/68881 or a 68030 or a 68040.  The generated code does use the
18292 68881 instructions that are emulated on the 68060.
18294 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18296 @item -mhard-float
18297 @itemx -m68881
18298 @opindex mhard-float
18299 @opindex m68881
18300 Generate floating-point instructions.  This is the default for 68020
18301 and above, and for ColdFire devices that have an FPU@.  It defines the
18302 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18303 on ColdFire targets.
18305 @item -msoft-float
18306 @opindex msoft-float
18307 Do not generate floating-point instructions; use library calls instead.
18308 This is the default for 68000, 68010, and 68832 targets.  It is also
18309 the default for ColdFire devices that have no FPU.
18311 @item -mdiv
18312 @itemx -mno-div
18313 @opindex mdiv
18314 @opindex mno-div
18315 Generate (do not generate) ColdFire hardware divide and remainder
18316 instructions.  If @option{-march} is used without @option{-mcpu},
18317 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18318 architectures.  Otherwise, the default is taken from the target CPU
18319 (either the default CPU, or the one specified by @option{-mcpu}).  For
18320 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18321 @option{-mcpu=5206e}.
18323 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18325 @item -mshort
18326 @opindex mshort
18327 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18328 Additionally, parameters passed on the stack are also aligned to a
18329 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18331 @item -mno-short
18332 @opindex mno-short
18333 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18335 @item -mnobitfield
18336 @itemx -mno-bitfield
18337 @opindex mnobitfield
18338 @opindex mno-bitfield
18339 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18340 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18342 @item -mbitfield
18343 @opindex mbitfield
18344 Do use the bit-field instructions.  The @option{-m68020} option implies
18345 @option{-mbitfield}.  This is the default if you use a configuration
18346 designed for a 68020.
18348 @item -mrtd
18349 @opindex mrtd
18350 Use a different function-calling convention, in which functions
18351 that take a fixed number of arguments return with the @code{rtd}
18352 instruction, which pops their arguments while returning.  This
18353 saves one instruction in the caller since there is no need to pop
18354 the arguments there.
18356 This calling convention is incompatible with the one normally
18357 used on Unix, so you cannot use it if you need to call libraries
18358 compiled with the Unix compiler.
18360 Also, you must provide function prototypes for all functions that
18361 take variable numbers of arguments (including @code{printf});
18362 otherwise incorrect code is generated for calls to those
18363 functions.
18365 In addition, seriously incorrect code results if you call a
18366 function with too many arguments.  (Normally, extra arguments are
18367 harmlessly ignored.)
18369 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18370 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18372 @item -mno-rtd
18373 @opindex mno-rtd
18374 Do not use the calling conventions selected by @option{-mrtd}.
18375 This is the default.
18377 @item -malign-int
18378 @itemx -mno-align-int
18379 @opindex malign-int
18380 @opindex mno-align-int
18381 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18382 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18383 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18384 Aligning variables on 32-bit boundaries produces code that runs somewhat
18385 faster on processors with 32-bit busses at the expense of more memory.
18387 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18388 aligns structures containing the above types differently than
18389 most published application binary interface specifications for the m68k.
18391 @item -mpcrel
18392 @opindex mpcrel
18393 Use the pc-relative addressing mode of the 68000 directly, instead of
18394 using a global offset table.  At present, this option implies @option{-fpic},
18395 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18396 not presently supported with @option{-mpcrel}, though this could be supported for
18397 68020 and higher processors.
18399 @item -mno-strict-align
18400 @itemx -mstrict-align
18401 @opindex mno-strict-align
18402 @opindex mstrict-align
18403 Do not (do) assume that unaligned memory references are handled by
18404 the system.
18406 @item -msep-data
18407 Generate code that allows the data segment to be located in a different
18408 area of memory from the text segment.  This allows for execute-in-place in
18409 an environment without virtual memory management.  This option implies
18410 @option{-fPIC}.
18412 @item -mno-sep-data
18413 Generate code that assumes that the data segment follows the text segment.
18414 This is the default.
18416 @item -mid-shared-library
18417 Generate code that supports shared libraries via the library ID method.
18418 This allows for execute-in-place and shared libraries in an environment
18419 without virtual memory management.  This option implies @option{-fPIC}.
18421 @item -mno-id-shared-library
18422 Generate code that doesn't assume ID-based shared libraries are being used.
18423 This is the default.
18425 @item -mshared-library-id=n
18426 Specifies the identification number of the ID-based shared library being
18427 compiled.  Specifying a value of 0 generates more compact code; specifying
18428 other values forces the allocation of that number to the current
18429 library, but is no more space- or time-efficient than omitting this option.
18431 @item -mxgot
18432 @itemx -mno-xgot
18433 @opindex mxgot
18434 @opindex mno-xgot
18435 When generating position-independent code for ColdFire, generate code
18436 that works if the GOT has more than 8192 entries.  This code is
18437 larger and slower than code generated without this option.  On M680x0
18438 processors, this option is not needed; @option{-fPIC} suffices.
18440 GCC normally uses a single instruction to load values from the GOT@.
18441 While this is relatively efficient, it only works if the GOT
18442 is smaller than about 64k.  Anything larger causes the linker
18443 to report an error such as:
18445 @cindex relocation truncated to fit (ColdFire)
18446 @smallexample
18447 relocation truncated to fit: R_68K_GOT16O foobar
18448 @end smallexample
18450 If this happens, you should recompile your code with @option{-mxgot}.
18451 It should then work with very large GOTs.  However, code generated with
18452 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18453 the value of a global symbol.
18455 Note that some linkers, including newer versions of the GNU linker,
18456 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18457 you should only need to use @option{-mxgot} when compiling a single
18458 object file that accesses more than 8192 GOT entries.  Very few do.
18460 These options have no effect unless GCC is generating
18461 position-independent code.
18463 @end table
18465 @node MCore Options
18466 @subsection MCore Options
18467 @cindex MCore options
18469 These are the @samp{-m} options defined for the Motorola M*Core
18470 processors.
18472 @table @gcctabopt
18474 @item -mhardlit
18475 @itemx -mno-hardlit
18476 @opindex mhardlit
18477 @opindex mno-hardlit
18478 Inline constants into the code stream if it can be done in two
18479 instructions or less.
18481 @item -mdiv
18482 @itemx -mno-div
18483 @opindex mdiv
18484 @opindex mno-div
18485 Use the divide instruction.  (Enabled by default).
18487 @item -mrelax-immediate
18488 @itemx -mno-relax-immediate
18489 @opindex mrelax-immediate
18490 @opindex mno-relax-immediate
18491 Allow arbitrary-sized immediates in bit operations.
18493 @item -mwide-bitfields
18494 @itemx -mno-wide-bitfields
18495 @opindex mwide-bitfields
18496 @opindex mno-wide-bitfields
18497 Always treat bit-fields as @code{int}-sized.
18499 @item -m4byte-functions
18500 @itemx -mno-4byte-functions
18501 @opindex m4byte-functions
18502 @opindex mno-4byte-functions
18503 Force all functions to be aligned to a 4-byte boundary.
18505 @item -mcallgraph-data
18506 @itemx -mno-callgraph-data
18507 @opindex mcallgraph-data
18508 @opindex mno-callgraph-data
18509 Emit callgraph information.
18511 @item -mslow-bytes
18512 @itemx -mno-slow-bytes
18513 @opindex mslow-bytes
18514 @opindex mno-slow-bytes
18515 Prefer word access when reading byte quantities.
18517 @item -mlittle-endian
18518 @itemx -mbig-endian
18519 @opindex mlittle-endian
18520 @opindex mbig-endian
18521 Generate code for a little-endian target.
18523 @item -m210
18524 @itemx -m340
18525 @opindex m210
18526 @opindex m340
18527 Generate code for the 210 processor.
18529 @item -mno-lsim
18530 @opindex mno-lsim
18531 Assume that runtime support has been provided and so omit the
18532 simulator library (@file{libsim.a)} from the linker command line.
18534 @item -mstack-increment=@var{size}
18535 @opindex mstack-increment
18536 Set the maximum amount for a single stack increment operation.  Large
18537 values can increase the speed of programs that contain functions
18538 that need a large amount of stack space, but they can also trigger a
18539 segmentation fault if the stack is extended too much.  The default
18540 value is 0x1000.
18542 @end table
18544 @node MeP Options
18545 @subsection MeP Options
18546 @cindex MeP options
18548 @table @gcctabopt
18550 @item -mabsdiff
18551 @opindex mabsdiff
18552 Enables the @code{abs} instruction, which is the absolute difference
18553 between two registers.
18555 @item -mall-opts
18556 @opindex mall-opts
18557 Enables all the optional instructions---average, multiply, divide, bit
18558 operations, leading zero, absolute difference, min/max, clip, and
18559 saturation.
18562 @item -maverage
18563 @opindex maverage
18564 Enables the @code{ave} instruction, which computes the average of two
18565 registers.
18567 @item -mbased=@var{n}
18568 @opindex mbased=
18569 Variables of size @var{n} bytes or smaller are placed in the
18570 @code{.based} section by default.  Based variables use the @code{$tp}
18571 register as a base register, and there is a 128-byte limit to the
18572 @code{.based} section.
18574 @item -mbitops
18575 @opindex mbitops
18576 Enables the bit operation instructions---bit test (@code{btstm}), set
18577 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
18578 test-and-set (@code{tas}).
18580 @item -mc=@var{name}
18581 @opindex mc=
18582 Selects which section constant data is placed in.  @var{name} may
18583 be @samp{tiny}, @samp{near}, or @samp{far}.
18585 @item -mclip
18586 @opindex mclip
18587 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
18588 useful unless you also provide @option{-mminmax}.
18590 @item -mconfig=@var{name}
18591 @opindex mconfig=
18592 Selects one of the built-in core configurations.  Each MeP chip has
18593 one or more modules in it; each module has a core CPU and a variety of
18594 coprocessors, optional instructions, and peripherals.  The
18595 @code{MeP-Integrator} tool, not part of GCC, provides these
18596 configurations through this option; using this option is the same as
18597 using all the corresponding command-line options.  The default
18598 configuration is @samp{default}.
18600 @item -mcop
18601 @opindex mcop
18602 Enables the coprocessor instructions.  By default, this is a 32-bit
18603 coprocessor.  Note that the coprocessor is normally enabled via the
18604 @option{-mconfig=} option.
18606 @item -mcop32
18607 @opindex mcop32
18608 Enables the 32-bit coprocessor's instructions.
18610 @item -mcop64
18611 @opindex mcop64
18612 Enables the 64-bit coprocessor's instructions.
18614 @item -mivc2
18615 @opindex mivc2
18616 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
18618 @item -mdc
18619 @opindex mdc
18620 Causes constant variables to be placed in the @code{.near} section.
18622 @item -mdiv
18623 @opindex mdiv
18624 Enables the @code{div} and @code{divu} instructions.
18626 @item -meb
18627 @opindex meb
18628 Generate big-endian code.
18630 @item -mel
18631 @opindex mel
18632 Generate little-endian code.
18634 @item -mio-volatile
18635 @opindex mio-volatile
18636 Tells the compiler that any variable marked with the @code{io}
18637 attribute is to be considered volatile.
18639 @item -ml
18640 @opindex ml
18641 Causes variables to be assigned to the @code{.far} section by default.
18643 @item -mleadz
18644 @opindex mleadz
18645 Enables the @code{leadz} (leading zero) instruction.
18647 @item -mm
18648 @opindex mm
18649 Causes variables to be assigned to the @code{.near} section by default.
18651 @item -mminmax
18652 @opindex mminmax
18653 Enables the @code{min} and @code{max} instructions.
18655 @item -mmult
18656 @opindex mmult
18657 Enables the multiplication and multiply-accumulate instructions.
18659 @item -mno-opts
18660 @opindex mno-opts
18661 Disables all the optional instructions enabled by @option{-mall-opts}.
18663 @item -mrepeat
18664 @opindex mrepeat
18665 Enables the @code{repeat} and @code{erepeat} instructions, used for
18666 low-overhead looping.
18668 @item -ms
18669 @opindex ms
18670 Causes all variables to default to the @code{.tiny} section.  Note
18671 that there is a 65536-byte limit to this section.  Accesses to these
18672 variables use the @code{%gp} base register.
18674 @item -msatur
18675 @opindex msatur
18676 Enables the saturation instructions.  Note that the compiler does not
18677 currently generate these itself, but this option is included for
18678 compatibility with other tools, like @code{as}.
18680 @item -msdram
18681 @opindex msdram
18682 Link the SDRAM-based runtime instead of the default ROM-based runtime.
18684 @item -msim
18685 @opindex msim
18686 Link the simulator run-time libraries.
18688 @item -msimnovec
18689 @opindex msimnovec
18690 Link the simulator runtime libraries, excluding built-in support
18691 for reset and exception vectors and tables.
18693 @item -mtf
18694 @opindex mtf
18695 Causes all functions to default to the @code{.far} section.  Without
18696 this option, functions default to the @code{.near} section.
18698 @item -mtiny=@var{n}
18699 @opindex mtiny=
18700 Variables that are @var{n} bytes or smaller are allocated to the
18701 @code{.tiny} section.  These variables use the @code{$gp} base
18702 register.  The default for this option is 4, but note that there's a
18703 65536-byte limit to the @code{.tiny} section.
18705 @end table
18707 @node MicroBlaze Options
18708 @subsection MicroBlaze Options
18709 @cindex MicroBlaze Options
18711 @table @gcctabopt
18713 @item -msoft-float
18714 @opindex msoft-float
18715 Use software emulation for floating point (default).
18717 @item -mhard-float
18718 @opindex mhard-float
18719 Use hardware floating-point instructions.
18721 @item -mmemcpy
18722 @opindex mmemcpy
18723 Do not optimize block moves, use @code{memcpy}.
18725 @item -mno-clearbss
18726 @opindex mno-clearbss
18727 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
18729 @item -mcpu=@var{cpu-type}
18730 @opindex mcpu=
18731 Use features of, and schedule code for, the given CPU.
18732 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
18733 where @var{X} is a major version, @var{YY} is the minor version, and
18734 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
18735 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
18737 @item -mxl-soft-mul
18738 @opindex mxl-soft-mul
18739 Use software multiply emulation (default).
18741 @item -mxl-soft-div
18742 @opindex mxl-soft-div
18743 Use software emulation for divides (default).
18745 @item -mxl-barrel-shift
18746 @opindex mxl-barrel-shift
18747 Use the hardware barrel shifter.
18749 @item -mxl-pattern-compare
18750 @opindex mxl-pattern-compare
18751 Use pattern compare instructions.
18753 @item -msmall-divides
18754 @opindex msmall-divides
18755 Use table lookup optimization for small signed integer divisions.
18757 @item -mxl-stack-check
18758 @opindex mxl-stack-check
18759 This option is deprecated.  Use @option{-fstack-check} instead.
18761 @item -mxl-gp-opt
18762 @opindex mxl-gp-opt
18763 Use GP-relative @code{.sdata}/@code{.sbss} sections.
18765 @item -mxl-multiply-high
18766 @opindex mxl-multiply-high
18767 Use multiply high instructions for high part of 32x32 multiply.
18769 @item -mxl-float-convert
18770 @opindex mxl-float-convert
18771 Use hardware floating-point conversion instructions.
18773 @item -mxl-float-sqrt
18774 @opindex mxl-float-sqrt
18775 Use hardware floating-point square root instruction.
18777 @item -mbig-endian
18778 @opindex mbig-endian
18779 Generate code for a big-endian target.
18781 @item -mlittle-endian
18782 @opindex mlittle-endian
18783 Generate code for a little-endian target.
18785 @item -mxl-reorder
18786 @opindex mxl-reorder
18787 Use reorder instructions (swap and byte reversed load/store).
18789 @item -mxl-mode-@var{app-model}
18790 Select application model @var{app-model}.  Valid models are
18791 @table @samp
18792 @item executable
18793 normal executable (default), uses startup code @file{crt0.o}.
18795 @item xmdstub
18796 for use with Xilinx Microprocessor Debugger (XMD) based
18797 software intrusive debug agent called xmdstub. This uses startup file
18798 @file{crt1.o} and sets the start address of the program to 0x800.
18800 @item bootstrap
18801 for applications that are loaded using a bootloader.
18802 This model uses startup file @file{crt2.o} which does not contain a processor
18803 reset vector handler. This is suitable for transferring control on a
18804 processor reset to the bootloader rather than the application.
18806 @item novectors
18807 for applications that do not require any of the
18808 MicroBlaze vectors. This option may be useful for applications running
18809 within a monitoring application. This model uses @file{crt3.o} as a startup file.
18810 @end table
18812 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
18813 @option{-mxl-mode-@var{app-model}}.
18815 @end table
18817 @node MIPS Options
18818 @subsection MIPS Options
18819 @cindex MIPS options
18821 @table @gcctabopt
18823 @item -EB
18824 @opindex EB
18825 Generate big-endian code.
18827 @item -EL
18828 @opindex EL
18829 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
18830 configurations.
18832 @item -march=@var{arch}
18833 @opindex march
18834 Generate code that runs on @var{arch}, which can be the name of a
18835 generic MIPS ISA, or the name of a particular processor.
18836 The ISA names are:
18837 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
18838 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
18839 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
18840 @samp{mips64r5} and @samp{mips64r6}.
18841 The processor names are:
18842 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
18843 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
18844 @samp{5kc}, @samp{5kf},
18845 @samp{20kc},
18846 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
18847 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
18848 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
18849 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
18850 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
18851 @samp{i6400},
18852 @samp{interaptiv},
18853 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
18854 @samp{m4k},
18855 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
18856 @samp{m5100}, @samp{m5101},
18857 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
18858 @samp{orion},
18859 @samp{p5600},
18860 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
18861 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
18862 @samp{rm7000}, @samp{rm9000},
18863 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
18864 @samp{sb1},
18865 @samp{sr71000},
18866 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
18867 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
18868 @samp{xlr} and @samp{xlp}.
18869 The special value @samp{from-abi} selects the
18870 most compatible architecture for the selected ABI (that is,
18871 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
18873 The native Linux/GNU toolchain also supports the value @samp{native},
18874 which selects the best architecture option for the host processor.
18875 @option{-march=native} has no effect if GCC does not recognize
18876 the processor.
18878 In processor names, a final @samp{000} can be abbreviated as @samp{k}
18879 (for example, @option{-march=r2k}).  Prefixes are optional, and
18880 @samp{vr} may be written @samp{r}.
18882 Names of the form @samp{@var{n}f2_1} refer to processors with
18883 FPUs clocked at half the rate of the core, names of the form
18884 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
18885 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
18886 processors with FPUs clocked a ratio of 3:2 with respect to the core.
18887 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
18888 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
18889 accepted as synonyms for @samp{@var{n}f1_1}.
18891 GCC defines two macros based on the value of this option.  The first
18892 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
18893 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
18894 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
18895 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
18896 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
18898 Note that the @code{_MIPS_ARCH} macro uses the processor names given
18899 above.  In other words, it has the full prefix and does not
18900 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
18901 the macro names the resolved architecture (either @code{"mips1"} or
18902 @code{"mips3"}).  It names the default architecture when no
18903 @option{-march} option is given.
18905 @item -mtune=@var{arch}
18906 @opindex mtune
18907 Optimize for @var{arch}.  Among other things, this option controls
18908 the way instructions are scheduled, and the perceived cost of arithmetic
18909 operations.  The list of @var{arch} values is the same as for
18910 @option{-march}.
18912 When this option is not used, GCC optimizes for the processor
18913 specified by @option{-march}.  By using @option{-march} and
18914 @option{-mtune} together, it is possible to generate code that
18915 runs on a family of processors, but optimize the code for one
18916 particular member of that family.
18918 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
18919 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
18920 @option{-march} ones described above.
18922 @item -mips1
18923 @opindex mips1
18924 Equivalent to @option{-march=mips1}.
18926 @item -mips2
18927 @opindex mips2
18928 Equivalent to @option{-march=mips2}.
18930 @item -mips3
18931 @opindex mips3
18932 Equivalent to @option{-march=mips3}.
18934 @item -mips4
18935 @opindex mips4
18936 Equivalent to @option{-march=mips4}.
18938 @item -mips32
18939 @opindex mips32
18940 Equivalent to @option{-march=mips32}.
18942 @item -mips32r3
18943 @opindex mips32r3
18944 Equivalent to @option{-march=mips32r3}.
18946 @item -mips32r5
18947 @opindex mips32r5
18948 Equivalent to @option{-march=mips32r5}.
18950 @item -mips32r6
18951 @opindex mips32r6
18952 Equivalent to @option{-march=mips32r6}.
18954 @item -mips64
18955 @opindex mips64
18956 Equivalent to @option{-march=mips64}.
18958 @item -mips64r2
18959 @opindex mips64r2
18960 Equivalent to @option{-march=mips64r2}.
18962 @item -mips64r3
18963 @opindex mips64r3
18964 Equivalent to @option{-march=mips64r3}.
18966 @item -mips64r5
18967 @opindex mips64r5
18968 Equivalent to @option{-march=mips64r5}.
18970 @item -mips64r6
18971 @opindex mips64r6
18972 Equivalent to @option{-march=mips64r6}.
18974 @item -mips16
18975 @itemx -mno-mips16
18976 @opindex mips16
18977 @opindex mno-mips16
18978 Generate (do not generate) MIPS16 code.  If GCC is targeting a
18979 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
18981 MIPS16 code generation can also be controlled on a per-function basis
18982 by means of @code{mips16} and @code{nomips16} attributes.
18983 @xref{Function Attributes}, for more information.
18985 @item -mflip-mips16
18986 @opindex mflip-mips16
18987 Generate MIPS16 code on alternating functions.  This option is provided
18988 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
18989 not intended for ordinary use in compiling user code.
18991 @item -minterlink-compressed
18992 @item -mno-interlink-compressed
18993 @opindex minterlink-compressed
18994 @opindex mno-interlink-compressed
18995 Require (do not require) that code using the standard (uncompressed) MIPS ISA
18996 be link-compatible with MIPS16 and microMIPS code, and vice versa.
18998 For example, code using the standard ISA encoding cannot jump directly
18999 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19000 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19001 knows that the target of the jump is not compressed.
19003 @item -minterlink-mips16
19004 @itemx -mno-interlink-mips16
19005 @opindex minterlink-mips16
19006 @opindex mno-interlink-mips16
19007 Aliases of @option{-minterlink-compressed} and
19008 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19009 and are retained for backwards compatibility.
19011 @item -mabi=32
19012 @itemx -mabi=o64
19013 @itemx -mabi=n32
19014 @itemx -mabi=64
19015 @itemx -mabi=eabi
19016 @opindex mabi=32
19017 @opindex mabi=o64
19018 @opindex mabi=n32
19019 @opindex mabi=64
19020 @opindex mabi=eabi
19021 Generate code for the given ABI@.
19023 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19024 generates 64-bit code when you select a 64-bit architecture, but you
19025 can use @option{-mgp32} to get 32-bit code instead.
19027 For information about the O64 ABI, see
19028 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19030 GCC supports a variant of the o32 ABI in which floating-point registers
19031 are 64 rather than 32 bits wide.  You can select this combination with
19032 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19033 and @code{mfhc1} instructions and is therefore only supported for
19034 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19036 The register assignments for arguments and return values remain the
19037 same, but each scalar value is passed in a single 64-bit register
19038 rather than a pair of 32-bit registers.  For example, scalar
19039 floating-point values are returned in @samp{$f0} only, not a
19040 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19041 remains the same in that the even-numbered double-precision registers
19042 are saved.
19044 Two additional variants of the o32 ABI are supported to enable
19045 a transition from 32-bit to 64-bit registers.  These are FPXX
19046 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19047 The FPXX extension mandates that all code must execute correctly
19048 when run using 32-bit or 64-bit registers.  The code can be interlinked
19049 with either FP32 or FP64, but not both.
19050 The FP64A extension is similar to the FP64 extension but forbids the
19051 use of odd-numbered single-precision registers.  This can be used
19052 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19053 processors and allows both FP32 and FP64A code to interlink and
19054 run in the same process without changing FPU modes.
19056 @item -mabicalls
19057 @itemx -mno-abicalls
19058 @opindex mabicalls
19059 @opindex mno-abicalls
19060 Generate (do not generate) code that is suitable for SVR4-style
19061 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19062 systems.
19064 @item -mshared
19065 @itemx -mno-shared
19066 Generate (do not generate) code that is fully position-independent,
19067 and that can therefore be linked into shared libraries.  This option
19068 only affects @option{-mabicalls}.
19070 All @option{-mabicalls} code has traditionally been position-independent,
19071 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19072 as an extension, the GNU toolchain allows executables to use absolute
19073 accesses for locally-binding symbols.  It can also use shorter GP
19074 initialization sequences and generate direct calls to locally-defined
19075 functions.  This mode is selected by @option{-mno-shared}.
19077 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19078 objects that can only be linked by the GNU linker.  However, the option
19079 does not affect the ABI of the final executable; it only affects the ABI
19080 of relocatable objects.  Using @option{-mno-shared} generally makes
19081 executables both smaller and quicker.
19083 @option{-mshared} is the default.
19085 @item -mplt
19086 @itemx -mno-plt
19087 @opindex mplt
19088 @opindex mno-plt
19089 Assume (do not assume) that the static and dynamic linkers
19090 support PLTs and copy relocations.  This option only affects
19091 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19092 has no effect without @option{-msym32}.
19094 You can make @option{-mplt} the default by configuring
19095 GCC with @option{--with-mips-plt}.  The default is
19096 @option{-mno-plt} otherwise.
19098 @item -mxgot
19099 @itemx -mno-xgot
19100 @opindex mxgot
19101 @opindex mno-xgot
19102 Lift (do not lift) the usual restrictions on the size of the global
19103 offset table.
19105 GCC normally uses a single instruction to load values from the GOT@.
19106 While this is relatively efficient, it only works if the GOT
19107 is smaller than about 64k.  Anything larger causes the linker
19108 to report an error such as:
19110 @cindex relocation truncated to fit (MIPS)
19111 @smallexample
19112 relocation truncated to fit: R_MIPS_GOT16 foobar
19113 @end smallexample
19115 If this happens, you should recompile your code with @option{-mxgot}.
19116 This works with very large GOTs, although the code is also
19117 less efficient, since it takes three instructions to fetch the
19118 value of a global symbol.
19120 Note that some linkers can create multiple GOTs.  If you have such a
19121 linker, you should only need to use @option{-mxgot} when a single object
19122 file accesses more than 64k's worth of GOT entries.  Very few do.
19124 These options have no effect unless GCC is generating position
19125 independent code.
19127 @item -mgp32
19128 @opindex mgp32
19129 Assume that general-purpose registers are 32 bits wide.
19131 @item -mgp64
19132 @opindex mgp64
19133 Assume that general-purpose registers are 64 bits wide.
19135 @item -mfp32
19136 @opindex mfp32
19137 Assume that floating-point registers are 32 bits wide.
19139 @item -mfp64
19140 @opindex mfp64
19141 Assume that floating-point registers are 64 bits wide.
19143 @item -mfpxx
19144 @opindex mfpxx
19145 Do not assume the width of floating-point registers.
19147 @item -mhard-float
19148 @opindex mhard-float
19149 Use floating-point coprocessor instructions.
19151 @item -msoft-float
19152 @opindex msoft-float
19153 Do not use floating-point coprocessor instructions.  Implement
19154 floating-point calculations using library calls instead.
19156 @item -mno-float
19157 @opindex mno-float
19158 Equivalent to @option{-msoft-float}, but additionally asserts that the
19159 program being compiled does not perform any floating-point operations.
19160 This option is presently supported only by some bare-metal MIPS
19161 configurations, where it may select a special set of libraries
19162 that lack all floating-point support (including, for example, the
19163 floating-point @code{printf} formats).  
19164 If code compiled with @option{-mno-float} accidentally contains
19165 floating-point operations, it is likely to suffer a link-time
19166 or run-time failure.
19168 @item -msingle-float
19169 @opindex msingle-float
19170 Assume that the floating-point coprocessor only supports single-precision
19171 operations.
19173 @item -mdouble-float
19174 @opindex mdouble-float
19175 Assume that the floating-point coprocessor supports double-precision
19176 operations.  This is the default.
19178 @item -modd-spreg
19179 @itemx -mno-odd-spreg
19180 @opindex modd-spreg
19181 @opindex mno-odd-spreg
19182 Enable the use of odd-numbered single-precision floating-point registers
19183 for the o32 ABI.  This is the default for processors that are known to
19184 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19185 is set by default.
19187 @item -mabs=2008
19188 @itemx -mabs=legacy
19189 @opindex mabs=2008
19190 @opindex mabs=legacy
19191 These options control the treatment of the special not-a-number (NaN)
19192 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19193 @code{neg.@i{fmt}} machine instructions.
19195 By default or when @option{-mabs=legacy} is used the legacy
19196 treatment is selected.  In this case these instructions are considered
19197 arithmetic and avoided where correct operation is required and the
19198 input operand might be a NaN.  A longer sequence of instructions that
19199 manipulate the sign bit of floating-point datum manually is used
19200 instead unless the @option{-ffinite-math-only} option has also been
19201 specified.
19203 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19204 this case these instructions are considered non-arithmetic and therefore
19205 operating correctly in all cases, including in particular where the
19206 input operand is a NaN.  These instructions are therefore always used
19207 for the respective operations.
19209 @item -mnan=2008
19210 @itemx -mnan=legacy
19211 @opindex mnan=2008
19212 @opindex mnan=legacy
19213 These options control the encoding of the special not-a-number (NaN)
19214 IEEE 754 floating-point data.
19216 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19217 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19218 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19219 by the first bit of their trailing significand field being 1.
19221 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19222 this case qNaNs are denoted by the first bit of their trailing
19223 significand field being 1, whereas sNaNs are denoted by the first bit of
19224 their trailing significand field being 0.
19226 The default is @option{-mnan=legacy} unless GCC has been configured with
19227 @option{--with-nan=2008}.
19229 @item -mllsc
19230 @itemx -mno-llsc
19231 @opindex mllsc
19232 @opindex mno-llsc
19233 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19234 implement atomic memory built-in functions.  When neither option is
19235 specified, GCC uses the instructions if the target architecture
19236 supports them.
19238 @option{-mllsc} is useful if the runtime environment can emulate the
19239 instructions and @option{-mno-llsc} can be useful when compiling for
19240 nonstandard ISAs.  You can make either option the default by
19241 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19242 respectively.  @option{--with-llsc} is the default for some
19243 configurations; see the installation documentation for details.
19245 @item -mdsp
19246 @itemx -mno-dsp
19247 @opindex mdsp
19248 @opindex mno-dsp
19249 Use (do not use) revision 1 of the MIPS DSP ASE@.
19250 @xref{MIPS DSP Built-in Functions}.  This option defines the
19251 preprocessor macro @code{__mips_dsp}.  It also defines
19252 @code{__mips_dsp_rev} to 1.
19254 @item -mdspr2
19255 @itemx -mno-dspr2
19256 @opindex mdspr2
19257 @opindex mno-dspr2
19258 Use (do not use) revision 2 of the MIPS DSP ASE@.
19259 @xref{MIPS DSP Built-in Functions}.  This option defines the
19260 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19261 It also defines @code{__mips_dsp_rev} to 2.
19263 @item -msmartmips
19264 @itemx -mno-smartmips
19265 @opindex msmartmips
19266 @opindex mno-smartmips
19267 Use (do not use) the MIPS SmartMIPS ASE.
19269 @item -mpaired-single
19270 @itemx -mno-paired-single
19271 @opindex mpaired-single
19272 @opindex mno-paired-single
19273 Use (do not use) paired-single floating-point instructions.
19274 @xref{MIPS Paired-Single Support}.  This option requires
19275 hardware floating-point support to be enabled.
19277 @item -mdmx
19278 @itemx -mno-mdmx
19279 @opindex mdmx
19280 @opindex mno-mdmx
19281 Use (do not use) MIPS Digital Media Extension instructions.
19282 This option can only be used when generating 64-bit code and requires
19283 hardware floating-point support to be enabled.
19285 @item -mips3d
19286 @itemx -mno-mips3d
19287 @opindex mips3d
19288 @opindex mno-mips3d
19289 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19290 The option @option{-mips3d} implies @option{-mpaired-single}.
19292 @item -mmicromips
19293 @itemx -mno-micromips
19294 @opindex mmicromips
19295 @opindex mno-mmicromips
19296 Generate (do not generate) microMIPS code.
19298 MicroMIPS code generation can also be controlled on a per-function basis
19299 by means of @code{micromips} and @code{nomicromips} attributes.
19300 @xref{Function Attributes}, for more information.
19302 @item -mmt
19303 @itemx -mno-mt
19304 @opindex mmt
19305 @opindex mno-mt
19306 Use (do not use) MT Multithreading instructions.
19308 @item -mmcu
19309 @itemx -mno-mcu
19310 @opindex mmcu
19311 @opindex mno-mcu
19312 Use (do not use) the MIPS MCU ASE instructions.
19314 @item -meva
19315 @itemx -mno-eva
19316 @opindex meva
19317 @opindex mno-eva
19318 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19320 @item -mvirt
19321 @itemx -mno-virt
19322 @opindex mvirt
19323 @opindex mno-virt
19324 Use (do not use) the MIPS Virtualization Application Specific instructions.
19326 @item -mxpa
19327 @itemx -mno-xpa
19328 @opindex mxpa
19329 @opindex mno-xpa
19330 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19332 @item -mlong64
19333 @opindex mlong64
19334 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19335 an explanation of the default and the way that the pointer size is
19336 determined.
19338 @item -mlong32
19339 @opindex mlong32
19340 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19342 The default size of @code{int}s, @code{long}s and pointers depends on
19343 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19344 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19345 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19346 or the same size as integer registers, whichever is smaller.
19348 @item -msym32
19349 @itemx -mno-sym32
19350 @opindex msym32
19351 @opindex mno-sym32
19352 Assume (do not assume) that all symbols have 32-bit values, regardless
19353 of the selected ABI@.  This option is useful in combination with
19354 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19355 to generate shorter and faster references to symbolic addresses.
19357 @item -G @var{num}
19358 @opindex G
19359 Put definitions of externally-visible data in a small data section
19360 if that data is no bigger than @var{num} bytes.  GCC can then generate
19361 more efficient accesses to the data; see @option{-mgpopt} for details.
19363 The default @option{-G} option depends on the configuration.
19365 @item -mlocal-sdata
19366 @itemx -mno-local-sdata
19367 @opindex mlocal-sdata
19368 @opindex mno-local-sdata
19369 Extend (do not extend) the @option{-G} behavior to local data too,
19370 such as to static variables in C@.  @option{-mlocal-sdata} is the
19371 default for all configurations.
19373 If the linker complains that an application is using too much small data,
19374 you might want to try rebuilding the less performance-critical parts with
19375 @option{-mno-local-sdata}.  You might also want to build large
19376 libraries with @option{-mno-local-sdata}, so that the libraries leave
19377 more room for the main program.
19379 @item -mextern-sdata
19380 @itemx -mno-extern-sdata
19381 @opindex mextern-sdata
19382 @opindex mno-extern-sdata
19383 Assume (do not assume) that externally-defined data is in
19384 a small data section if the size of that data is within the @option{-G} limit.
19385 @option{-mextern-sdata} is the default for all configurations.
19387 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19388 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19389 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19390 is placed in a small data section.  If @var{Var} is defined by another
19391 module, you must either compile that module with a high-enough
19392 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19393 definition.  If @var{Var} is common, you must link the application
19394 with a high-enough @option{-G} setting.
19396 The easiest way of satisfying these restrictions is to compile
19397 and link every module with the same @option{-G} option.  However,
19398 you may wish to build a library that supports several different
19399 small data limits.  You can do this by compiling the library with
19400 the highest supported @option{-G} setting and additionally using
19401 @option{-mno-extern-sdata} to stop the library from making assumptions
19402 about externally-defined data.
19404 @item -mgpopt
19405 @itemx -mno-gpopt
19406 @opindex mgpopt
19407 @opindex mno-gpopt
19408 Use (do not use) GP-relative accesses for symbols that are known to be
19409 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19410 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19411 configurations.
19413 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19414 might not hold the value of @code{_gp}.  For example, if the code is
19415 part of a library that might be used in a boot monitor, programs that
19416 call boot monitor routines pass an unknown value in @code{$gp}.
19417 (In such situations, the boot monitor itself is usually compiled
19418 with @option{-G0}.)
19420 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19421 @option{-mno-extern-sdata}.
19423 @item -membedded-data
19424 @itemx -mno-embedded-data
19425 @opindex membedded-data
19426 @opindex mno-embedded-data
19427 Allocate variables to the read-only data section first if possible, then
19428 next in the small data section if possible, otherwise in data.  This gives
19429 slightly slower code than the default, but reduces the amount of RAM required
19430 when executing, and thus may be preferred for some embedded systems.
19432 @item -muninit-const-in-rodata
19433 @itemx -mno-uninit-const-in-rodata
19434 @opindex muninit-const-in-rodata
19435 @opindex mno-uninit-const-in-rodata
19436 Put uninitialized @code{const} variables in the read-only data section.
19437 This option is only meaningful in conjunction with @option{-membedded-data}.
19439 @item -mcode-readable=@var{setting}
19440 @opindex mcode-readable
19441 Specify whether GCC may generate code that reads from executable sections.
19442 There are three possible settings:
19444 @table @gcctabopt
19445 @item -mcode-readable=yes
19446 Instructions may freely access executable sections.  This is the
19447 default setting.
19449 @item -mcode-readable=pcrel
19450 MIPS16 PC-relative load instructions can access executable sections,
19451 but other instructions must not do so.  This option is useful on 4KSc
19452 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19453 It is also useful on processors that can be configured to have a dual
19454 instruction/data SRAM interface and that, like the M4K, automatically
19455 redirect PC-relative loads to the instruction RAM.
19457 @item -mcode-readable=no
19458 Instructions must not access executable sections.  This option can be
19459 useful on targets that are configured to have a dual instruction/data
19460 SRAM interface but that (unlike the M4K) do not automatically redirect
19461 PC-relative loads to the instruction RAM.
19462 @end table
19464 @item -msplit-addresses
19465 @itemx -mno-split-addresses
19466 @opindex msplit-addresses
19467 @opindex mno-split-addresses
19468 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19469 relocation operators.  This option has been superseded by
19470 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19472 @item -mexplicit-relocs
19473 @itemx -mno-explicit-relocs
19474 @opindex mexplicit-relocs
19475 @opindex mno-explicit-relocs
19476 Use (do not use) assembler relocation operators when dealing with symbolic
19477 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19478 is to use assembler macros instead.
19480 @option{-mexplicit-relocs} is the default if GCC was configured
19481 to use an assembler that supports relocation operators.
19483 @item -mcheck-zero-division
19484 @itemx -mno-check-zero-division
19485 @opindex mcheck-zero-division
19486 @opindex mno-check-zero-division
19487 Trap (do not trap) on integer division by zero.
19489 The default is @option{-mcheck-zero-division}.
19491 @item -mdivide-traps
19492 @itemx -mdivide-breaks
19493 @opindex mdivide-traps
19494 @opindex mdivide-breaks
19495 MIPS systems check for division by zero by generating either a
19496 conditional trap or a break instruction.  Using traps results in
19497 smaller code, but is only supported on MIPS II and later.  Also, some
19498 versions of the Linux kernel have a bug that prevents trap from
19499 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19500 allow conditional traps on architectures that support them and
19501 @option{-mdivide-breaks} to force the use of breaks.
19503 The default is usually @option{-mdivide-traps}, but this can be
19504 overridden at configure time using @option{--with-divide=breaks}.
19505 Divide-by-zero checks can be completely disabled using
19506 @option{-mno-check-zero-division}.
19508 @item -mmemcpy
19509 @itemx -mno-memcpy
19510 @opindex mmemcpy
19511 @opindex mno-memcpy
19512 Force (do not force) the use of @code{memcpy} for non-trivial block
19513 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19514 most constant-sized copies.
19516 @item -mlong-calls
19517 @itemx -mno-long-calls
19518 @opindex mlong-calls
19519 @opindex mno-long-calls
19520 Disable (do not disable) use of the @code{jal} instruction.  Calling
19521 functions using @code{jal} is more efficient but requires the caller
19522 and callee to be in the same 256 megabyte segment.
19524 This option has no effect on abicalls code.  The default is
19525 @option{-mno-long-calls}.
19527 @item -mmad
19528 @itemx -mno-mad
19529 @opindex mmad
19530 @opindex mno-mad
19531 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
19532 instructions, as provided by the R4650 ISA@.
19534 @item -mimadd
19535 @itemx -mno-imadd
19536 @opindex mimadd
19537 @opindex mno-imadd
19538 Enable (disable) use of the @code{madd} and @code{msub} integer
19539 instructions.  The default is @option{-mimadd} on architectures
19540 that support @code{madd} and @code{msub} except for the 74k 
19541 architecture where it was found to generate slower code.
19543 @item -mfused-madd
19544 @itemx -mno-fused-madd
19545 @opindex mfused-madd
19546 @opindex mno-fused-madd
19547 Enable (disable) use of the floating-point multiply-accumulate
19548 instructions, when they are available.  The default is
19549 @option{-mfused-madd}.
19551 On the R8000 CPU when multiply-accumulate instructions are used,
19552 the intermediate product is calculated to infinite precision
19553 and is not subject to the FCSR Flush to Zero bit.  This may be
19554 undesirable in some circumstances.  On other processors the result
19555 is numerically identical to the equivalent computation using
19556 separate multiply, add, subtract and negate instructions.
19558 @item -nocpp
19559 @opindex nocpp
19560 Tell the MIPS assembler to not run its preprocessor over user
19561 assembler files (with a @samp{.s} suffix) when assembling them.
19563 @item -mfix-24k
19564 @item -mno-fix-24k
19565 @opindex mfix-24k
19566 @opindex mno-fix-24k
19567 Work around the 24K E48 (lost data on stores during refill) errata.
19568 The workarounds are implemented by the assembler rather than by GCC@.
19570 @item -mfix-r4000
19571 @itemx -mno-fix-r4000
19572 @opindex mfix-r4000
19573 @opindex mno-fix-r4000
19574 Work around certain R4000 CPU errata:
19575 @itemize @minus
19576 @item
19577 A double-word or a variable shift may give an incorrect result if executed
19578 immediately after starting an integer division.
19579 @item
19580 A double-word or a variable shift may give an incorrect result if executed
19581 while an integer multiplication is in progress.
19582 @item
19583 An integer division may give an incorrect result if started in a delay slot
19584 of a taken branch or a jump.
19585 @end itemize
19587 @item -mfix-r4400
19588 @itemx -mno-fix-r4400
19589 @opindex mfix-r4400
19590 @opindex mno-fix-r4400
19591 Work around certain R4400 CPU errata:
19592 @itemize @minus
19593 @item
19594 A double-word or a variable shift may give an incorrect result if executed
19595 immediately after starting an integer division.
19596 @end itemize
19598 @item -mfix-r10000
19599 @itemx -mno-fix-r10000
19600 @opindex mfix-r10000
19601 @opindex mno-fix-r10000
19602 Work around certain R10000 errata:
19603 @itemize @minus
19604 @item
19605 @code{ll}/@code{sc} sequences may not behave atomically on revisions
19606 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
19607 @end itemize
19609 This option can only be used if the target architecture supports
19610 branch-likely instructions.  @option{-mfix-r10000} is the default when
19611 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
19612 otherwise.
19614 @item -mfix-rm7000
19615 @itemx -mno-fix-rm7000
19616 @opindex mfix-rm7000
19617 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
19618 workarounds are implemented by the assembler rather than by GCC@.
19620 @item -mfix-vr4120
19621 @itemx -mno-fix-vr4120
19622 @opindex mfix-vr4120
19623 Work around certain VR4120 errata:
19624 @itemize @minus
19625 @item
19626 @code{dmultu} does not always produce the correct result.
19627 @item
19628 @code{div} and @code{ddiv} do not always produce the correct result if one
19629 of the operands is negative.
19630 @end itemize
19631 The workarounds for the division errata rely on special functions in
19632 @file{libgcc.a}.  At present, these functions are only provided by
19633 the @code{mips64vr*-elf} configurations.
19635 Other VR4120 errata require a NOP to be inserted between certain pairs of
19636 instructions.  These errata are handled by the assembler, not by GCC itself.
19638 @item -mfix-vr4130
19639 @opindex mfix-vr4130
19640 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
19641 workarounds are implemented by the assembler rather than by GCC,
19642 although GCC avoids using @code{mflo} and @code{mfhi} if the
19643 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
19644 instructions are available instead.
19646 @item -mfix-sb1
19647 @itemx -mno-fix-sb1
19648 @opindex mfix-sb1
19649 Work around certain SB-1 CPU core errata.
19650 (This flag currently works around the SB-1 revision 2
19651 ``F1'' and ``F2'' floating-point errata.)
19653 @item -mr10k-cache-barrier=@var{setting}
19654 @opindex mr10k-cache-barrier
19655 Specify whether GCC should insert cache barriers to avoid the
19656 side-effects of speculation on R10K processors.
19658 In common with many processors, the R10K tries to predict the outcome
19659 of a conditional branch and speculatively executes instructions from
19660 the ``taken'' branch.  It later aborts these instructions if the
19661 predicted outcome is wrong.  However, on the R10K, even aborted
19662 instructions can have side effects.
19664 This problem only affects kernel stores and, depending on the system,
19665 kernel loads.  As an example, a speculatively-executed store may load
19666 the target memory into cache and mark the cache line as dirty, even if
19667 the store itself is later aborted.  If a DMA operation writes to the
19668 same area of memory before the ``dirty'' line is flushed, the cached
19669 data overwrites the DMA-ed data.  See the R10K processor manual
19670 for a full description, including other potential problems.
19672 One workaround is to insert cache barrier instructions before every memory
19673 access that might be speculatively executed and that might have side
19674 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
19675 controls GCC's implementation of this workaround.  It assumes that
19676 aborted accesses to any byte in the following regions does not have
19677 side effects:
19679 @enumerate
19680 @item
19681 the memory occupied by the current function's stack frame;
19683 @item
19684 the memory occupied by an incoming stack argument;
19686 @item
19687 the memory occupied by an object with a link-time-constant address.
19688 @end enumerate
19690 It is the kernel's responsibility to ensure that speculative
19691 accesses to these regions are indeed safe.
19693 If the input program contains a function declaration such as:
19695 @smallexample
19696 void foo (void);
19697 @end smallexample
19699 then the implementation of @code{foo} must allow @code{j foo} and
19700 @code{jal foo} to be executed speculatively.  GCC honors this
19701 restriction for functions it compiles itself.  It expects non-GCC
19702 functions (such as hand-written assembly code) to do the same.
19704 The option has three forms:
19706 @table @gcctabopt
19707 @item -mr10k-cache-barrier=load-store
19708 Insert a cache barrier before a load or store that might be
19709 speculatively executed and that might have side effects even
19710 if aborted.
19712 @item -mr10k-cache-barrier=store
19713 Insert a cache barrier before a store that might be speculatively
19714 executed and that might have side effects even if aborted.
19716 @item -mr10k-cache-barrier=none
19717 Disable the insertion of cache barriers.  This is the default setting.
19718 @end table
19720 @item -mflush-func=@var{func}
19721 @itemx -mno-flush-func
19722 @opindex mflush-func
19723 Specifies the function to call to flush the I and D caches, or to not
19724 call any such function.  If called, the function must take the same
19725 arguments as the common @code{_flush_func}, that is, the address of the
19726 memory range for which the cache is being flushed, the size of the
19727 memory range, and the number 3 (to flush both caches).  The default
19728 depends on the target GCC was configured for, but commonly is either
19729 @code{_flush_func} or @code{__cpu_flush}.
19731 @item mbranch-cost=@var{num}
19732 @opindex mbranch-cost
19733 Set the cost of branches to roughly @var{num} ``simple'' instructions.
19734 This cost is only a heuristic and is not guaranteed to produce
19735 consistent results across releases.  A zero cost redundantly selects
19736 the default, which is based on the @option{-mtune} setting.
19738 @item -mbranch-likely
19739 @itemx -mno-branch-likely
19740 @opindex mbranch-likely
19741 @opindex mno-branch-likely
19742 Enable or disable use of Branch Likely instructions, regardless of the
19743 default for the selected architecture.  By default, Branch Likely
19744 instructions may be generated if they are supported by the selected
19745 architecture.  An exception is for the MIPS32 and MIPS64 architectures
19746 and processors that implement those architectures; for those, Branch
19747 Likely instructions are not be generated by default because the MIPS32
19748 and MIPS64 architectures specifically deprecate their use.
19750 @item -mcompact-branches=never
19751 @itemx -mcompact-branches=optimal
19752 @itemx -mcompact-branches=always
19753 @opindex mcompact-branches=never
19754 @opindex mcompact-branches=optimal
19755 @opindex mcompact-branches=always
19756 These options control which form of branches will be generated.  The
19757 default is @option{-mcompact-branches=optimal}.
19759 The @option{-mcompact-branches=never} option ensures that compact branch
19760 instructions will never be generated.
19762 The @option{-mcompact-branches=always} option ensures that a compact
19763 branch instruction will be generated if available.  If a compact branch
19764 instruction is not available, a delay slot form of the branch will be
19765 used instead.
19767 This option is supported from MIPS Release 6 onwards.
19769 The @option{-mcompact-branches=optimal} option will cause a delay slot
19770 branch to be used if one is available in the current ISA and the delay
19771 slot is successfully filled.  If the delay slot is not filled, a compact
19772 branch will be chosen if one is available.
19774 @item -mfp-exceptions
19775 @itemx -mno-fp-exceptions
19776 @opindex mfp-exceptions
19777 Specifies whether FP exceptions are enabled.  This affects how
19778 FP instructions are scheduled for some processors.
19779 The default is that FP exceptions are
19780 enabled.
19782 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
19783 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
19784 FP pipe.
19786 @item -mvr4130-align
19787 @itemx -mno-vr4130-align
19788 @opindex mvr4130-align
19789 The VR4130 pipeline is two-way superscalar, but can only issue two
19790 instructions together if the first one is 8-byte aligned.  When this
19791 option is enabled, GCC aligns pairs of instructions that it
19792 thinks should execute in parallel.
19794 This option only has an effect when optimizing for the VR4130.
19795 It normally makes code faster, but at the expense of making it bigger.
19796 It is enabled by default at optimization level @option{-O3}.
19798 @item -msynci
19799 @itemx -mno-synci
19800 @opindex msynci
19801 Enable (disable) generation of @code{synci} instructions on
19802 architectures that support it.  The @code{synci} instructions (if
19803 enabled) are generated when @code{__builtin___clear_cache} is
19804 compiled.
19806 This option defaults to @option{-mno-synci}, but the default can be
19807 overridden by configuring GCC with @option{--with-synci}.
19809 When compiling code for single processor systems, it is generally safe
19810 to use @code{synci}.  However, on many multi-core (SMP) systems, it
19811 does not invalidate the instruction caches on all cores and may lead
19812 to undefined behavior.
19814 @item -mrelax-pic-calls
19815 @itemx -mno-relax-pic-calls
19816 @opindex mrelax-pic-calls
19817 Try to turn PIC calls that are normally dispatched via register
19818 @code{$25} into direct calls.  This is only possible if the linker can
19819 resolve the destination at link time and if the destination is within
19820 range for a direct call.
19822 @option{-mrelax-pic-calls} is the default if GCC was configured to use
19823 an assembler and a linker that support the @code{.reloc} assembly
19824 directive and @option{-mexplicit-relocs} is in effect.  With
19825 @option{-mno-explicit-relocs}, this optimization can be performed by the
19826 assembler and the linker alone without help from the compiler.
19828 @item -mmcount-ra-address
19829 @itemx -mno-mcount-ra-address
19830 @opindex mmcount-ra-address
19831 @opindex mno-mcount-ra-address
19832 Emit (do not emit) code that allows @code{_mcount} to modify the
19833 calling function's return address.  When enabled, this option extends
19834 the usual @code{_mcount} interface with a new @var{ra-address}
19835 parameter, which has type @code{intptr_t *} and is passed in register
19836 @code{$12}.  @code{_mcount} can then modify the return address by
19837 doing both of the following:
19838 @itemize
19839 @item
19840 Returning the new address in register @code{$31}.
19841 @item
19842 Storing the new address in @code{*@var{ra-address}},
19843 if @var{ra-address} is nonnull.
19844 @end itemize
19846 The default is @option{-mno-mcount-ra-address}.
19848 @item -mframe-header-opt
19849 @itemx -mno-frame-header-opt
19850 @opindex mframe-header-opt
19851 Enable (disable) frame header optimization in the o32 ABI.  When using the
19852 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
19853 function to write out register arguments.  When enabled, this optimization
19854 will suppress the allocation of the frame header if it can be determined that
19855 it is unused.
19857 This optimization is off by default at all optimization levels.
19859 @end table
19861 @node MMIX Options
19862 @subsection MMIX Options
19863 @cindex MMIX Options
19865 These options are defined for the MMIX:
19867 @table @gcctabopt
19868 @item -mlibfuncs
19869 @itemx -mno-libfuncs
19870 @opindex mlibfuncs
19871 @opindex mno-libfuncs
19872 Specify that intrinsic library functions are being compiled, passing all
19873 values in registers, no matter the size.
19875 @item -mepsilon
19876 @itemx -mno-epsilon
19877 @opindex mepsilon
19878 @opindex mno-epsilon
19879 Generate floating-point comparison instructions that compare with respect
19880 to the @code{rE} epsilon register.
19882 @item -mabi=mmixware
19883 @itemx -mabi=gnu
19884 @opindex mabi=mmixware
19885 @opindex mabi=gnu
19886 Generate code that passes function parameters and return values that (in
19887 the called function) are seen as registers @code{$0} and up, as opposed to
19888 the GNU ABI which uses global registers @code{$231} and up.
19890 @item -mzero-extend
19891 @itemx -mno-zero-extend
19892 @opindex mzero-extend
19893 @opindex mno-zero-extend
19894 When reading data from memory in sizes shorter than 64 bits, use (do not
19895 use) zero-extending load instructions by default, rather than
19896 sign-extending ones.
19898 @item -mknuthdiv
19899 @itemx -mno-knuthdiv
19900 @opindex mknuthdiv
19901 @opindex mno-knuthdiv
19902 Make the result of a division yielding a remainder have the same sign as
19903 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
19904 remainder follows the sign of the dividend.  Both methods are
19905 arithmetically valid, the latter being almost exclusively used.
19907 @item -mtoplevel-symbols
19908 @itemx -mno-toplevel-symbols
19909 @opindex mtoplevel-symbols
19910 @opindex mno-toplevel-symbols
19911 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
19912 code can be used with the @code{PREFIX} assembly directive.
19914 @item -melf
19915 @opindex melf
19916 Generate an executable in the ELF format, rather than the default
19917 @samp{mmo} format used by the @command{mmix} simulator.
19919 @item -mbranch-predict
19920 @itemx -mno-branch-predict
19921 @opindex mbranch-predict
19922 @opindex mno-branch-predict
19923 Use (do not use) the probable-branch instructions, when static branch
19924 prediction indicates a probable branch.
19926 @item -mbase-addresses
19927 @itemx -mno-base-addresses
19928 @opindex mbase-addresses
19929 @opindex mno-base-addresses
19930 Generate (do not generate) code that uses @emph{base addresses}.  Using a
19931 base address automatically generates a request (handled by the assembler
19932 and the linker) for a constant to be set up in a global register.  The
19933 register is used for one or more base address requests within the range 0
19934 to 255 from the value held in the register.  The generally leads to short
19935 and fast code, but the number of different data items that can be
19936 addressed is limited.  This means that a program that uses lots of static
19937 data may require @option{-mno-base-addresses}.
19939 @item -msingle-exit
19940 @itemx -mno-single-exit
19941 @opindex msingle-exit
19942 @opindex mno-single-exit
19943 Force (do not force) generated code to have a single exit point in each
19944 function.
19945 @end table
19947 @node MN10300 Options
19948 @subsection MN10300 Options
19949 @cindex MN10300 options
19951 These @option{-m} options are defined for Matsushita MN10300 architectures:
19953 @table @gcctabopt
19954 @item -mmult-bug
19955 @opindex mmult-bug
19956 Generate code to avoid bugs in the multiply instructions for the MN10300
19957 processors.  This is the default.
19959 @item -mno-mult-bug
19960 @opindex mno-mult-bug
19961 Do not generate code to avoid bugs in the multiply instructions for the
19962 MN10300 processors.
19964 @item -mam33
19965 @opindex mam33
19966 Generate code using features specific to the AM33 processor.
19968 @item -mno-am33
19969 @opindex mno-am33
19970 Do not generate code using features specific to the AM33 processor.  This
19971 is the default.
19973 @item -mam33-2
19974 @opindex mam33-2
19975 Generate code using features specific to the AM33/2.0 processor.
19977 @item -mam34
19978 @opindex mam34
19979 Generate code using features specific to the AM34 processor.
19981 @item -mtune=@var{cpu-type}
19982 @opindex mtune
19983 Use the timing characteristics of the indicated CPU type when
19984 scheduling instructions.  This does not change the targeted processor
19985 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
19986 @samp{am33-2} or @samp{am34}.
19988 @item -mreturn-pointer-on-d0
19989 @opindex mreturn-pointer-on-d0
19990 When generating a function that returns a pointer, return the pointer
19991 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
19992 only in @code{a0}, and attempts to call such functions without a prototype
19993 result in errors.  Note that this option is on by default; use
19994 @option{-mno-return-pointer-on-d0} to disable it.
19996 @item -mno-crt0
19997 @opindex mno-crt0
19998 Do not link in the C run-time initialization object file.
20000 @item -mrelax
20001 @opindex mrelax
20002 Indicate to the linker that it should perform a relaxation optimization pass
20003 to shorten branches, calls and absolute memory addresses.  This option only
20004 has an effect when used on the command line for the final link step.
20006 This option makes symbolic debugging impossible.
20008 @item -mliw
20009 @opindex mliw
20010 Allow the compiler to generate @emph{Long Instruction Word}
20011 instructions if the target is the @samp{AM33} or later.  This is the
20012 default.  This option defines the preprocessor macro @code{__LIW__}.
20014 @item -mnoliw
20015 @opindex mnoliw
20016 Do not allow the compiler to generate @emph{Long Instruction Word}
20017 instructions.  This option defines the preprocessor macro
20018 @code{__NO_LIW__}.
20020 @item -msetlb
20021 @opindex msetlb
20022 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20023 instructions if the target is the @samp{AM33} or later.  This is the
20024 default.  This option defines the preprocessor macro @code{__SETLB__}.
20026 @item -mnosetlb
20027 @opindex mnosetlb
20028 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20029 instructions.  This option defines the preprocessor macro
20030 @code{__NO_SETLB__}.
20032 @end table
20034 @node Moxie Options
20035 @subsection Moxie Options
20036 @cindex Moxie Options
20038 @table @gcctabopt
20040 @item -meb
20041 @opindex meb
20042 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20043 configurations.
20045 @item -mel
20046 @opindex mel
20047 Generate little-endian code.
20049 @item -mmul.x
20050 @opindex mmul.x
20051 Generate mul.x and umul.x instructions.  This is the default for
20052 @samp{moxiebox-*-*} configurations.
20054 @item -mno-crt0
20055 @opindex mno-crt0
20056 Do not link in the C run-time initialization object file.
20058 @end table
20060 @node MSP430 Options
20061 @subsection MSP430 Options
20062 @cindex MSP430 Options
20064 These options are defined for the MSP430:
20066 @table @gcctabopt
20068 @item -masm-hex
20069 @opindex masm-hex
20070 Force assembly output to always use hex constants.  Normally such
20071 constants are signed decimals, but this option is available for
20072 testsuite and/or aesthetic purposes.
20074 @item -mmcu=
20075 @opindex mmcu=
20076 Select the MCU to target.  This is used to create a C preprocessor
20077 symbol based upon the MCU name, converted to upper case and pre- and
20078 post-fixed with @samp{__}.  This in turn is used by the
20079 @file{msp430.h} header file to select an MCU-specific supplementary
20080 header file.
20082 The option also sets the ISA to use.  If the MCU name is one that is
20083 known to only support the 430 ISA then that is selected, otherwise the
20084 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20085 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20086 name selects the 430X ISA.
20088 In addition an MCU-specific linker script is added to the linker
20089 command line.  The script's name is the name of the MCU with
20090 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20091 command line defines the C preprocessor symbol @code{__XXX__} and
20092 cause the linker to search for a script called @file{xxx.ld}.
20094 This option is also passed on to the assembler.
20096 @item -mwarn-mcu
20097 @itemx -mno-warn-mcu
20098 @opindex mwarn-mcu
20099 @opindex mno-warn-mcu
20100 This option enables or disables warnings about conflicts between the
20101 MCU name specified by the @option{-mmcu} option and the ISA set by the
20102 @option{-mcpu} option and/or the hardware multiply support set by the
20103 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20104 MCU names.  This option is on by default.
20106 @item -mcpu=
20107 @opindex mcpu=
20108 Specifies the ISA to use.  Accepted values are @samp{msp430},
20109 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20110 @option{-mmcu=} option should be used to select the ISA.
20112 @item -msim
20113 @opindex msim
20114 Link to the simulator runtime libraries and linker script.  Overrides
20115 any scripts that would be selected by the @option{-mmcu=} option.
20117 @item -mlarge
20118 @opindex mlarge
20119 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20121 @item -msmall
20122 @opindex msmall
20123 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20125 @item -mrelax
20126 @opindex mrelax
20127 This option is passed to the assembler and linker, and allows the
20128 linker to perform certain optimizations that cannot be done until
20129 the final link.
20131 @item mhwmult=
20132 @opindex mhwmult=
20133 Describes the type of hardware multiply supported by the target.
20134 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20135 for the original 16-bit-only multiply supported by early MCUs.
20136 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20137 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20138 A value of @samp{auto} can also be given.  This tells GCC to deduce
20139 the hardware multiply support based upon the MCU name provided by the
20140 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20141 the MCU name is not recognized then no hardware multiply support is
20142 assumed.  @code{auto} is the default setting.
20144 Hardware multiplies are normally performed by calling a library
20145 routine.  This saves space in the generated code.  When compiling at
20146 @option{-O3} or higher however the hardware multiplier is invoked
20147 inline.  This makes for bigger, but faster code.
20149 The hardware multiply routines disable interrupts whilst running and
20150 restore the previous interrupt state when they finish.  This makes
20151 them safe to use inside interrupt handlers as well as in normal code.
20153 @item -minrt
20154 @opindex minrt
20155 Enable the use of a minimum runtime environment - no static
20156 initializers or constructors.  This is intended for memory-constrained
20157 devices.  The compiler includes special symbols in some objects
20158 that tell the linker and runtime which code fragments are required.
20160 @item -mcode-region=
20161 @itemx -mdata-region=
20162 @opindex mcode-region
20163 @opindex mdata-region
20164 These options tell the compiler where to place functions and data that
20165 do not have one of the @code{lower}, @code{upper}, @code{either} or
20166 @code{section} attributes.  Possible values are @code{lower},
20167 @code{upper}, @code{either} or @code{any}.  The first three behave
20168 like the corresponding attribute.  The fourth possible value -
20169 @code{any} - is the default.  It leaves placement entirely up to the
20170 linker script and how it assigns the standard sections
20171 (@code{.text}, @code{.data}, etc) to the memory regions.
20173 @item -msilicon-errata=
20174 @opindex msilicon-errata
20175 This option passes on a request to assembler to enable the fixes for
20176 the named silicon errata.
20178 @item -msilicon-errata-warn=
20179 @opindex msilicon-errata-warn
20180 This option passes on a request to the assembler to enable warning
20181 messages when a silicon errata might need to be applied.
20183 @end table
20185 @node NDS32 Options
20186 @subsection NDS32 Options
20187 @cindex NDS32 Options
20189 These options are defined for NDS32 implementations:
20191 @table @gcctabopt
20193 @item -mbig-endian
20194 @opindex mbig-endian
20195 Generate code in big-endian mode.
20197 @item -mlittle-endian
20198 @opindex mlittle-endian
20199 Generate code in little-endian mode.
20201 @item -mreduced-regs
20202 @opindex mreduced-regs
20203 Use reduced-set registers for register allocation.
20205 @item -mfull-regs
20206 @opindex mfull-regs
20207 Use full-set registers for register allocation.
20209 @item -mcmov
20210 @opindex mcmov
20211 Generate conditional move instructions.
20213 @item -mno-cmov
20214 @opindex mno-cmov
20215 Do not generate conditional move instructions.
20217 @item -mperf-ext
20218 @opindex mperf-ext
20219 Generate performance extension instructions.
20221 @item -mno-perf-ext
20222 @opindex mno-perf-ext
20223 Do not generate performance extension instructions.
20225 @item -mv3push
20226 @opindex mv3push
20227 Generate v3 push25/pop25 instructions.
20229 @item -mno-v3push
20230 @opindex mno-v3push
20231 Do not generate v3 push25/pop25 instructions.
20233 @item -m16-bit
20234 @opindex m16-bit
20235 Generate 16-bit instructions.
20237 @item -mno-16-bit
20238 @opindex mno-16-bit
20239 Do not generate 16-bit instructions.
20241 @item -misr-vector-size=@var{num}
20242 @opindex misr-vector-size
20243 Specify the size of each interrupt vector, which must be 4 or 16.
20245 @item -mcache-block-size=@var{num}
20246 @opindex mcache-block-size
20247 Specify the size of each cache block,
20248 which must be a power of 2 between 4 and 512.
20250 @item -march=@var{arch}
20251 @opindex march
20252 Specify the name of the target architecture.
20254 @item -mcmodel=@var{code-model}
20255 @opindex mcmodel
20256 Set the code model to one of
20257 @table @asis
20258 @item @samp{small}
20259 All the data and read-only data segments must be within 512KB addressing space.
20260 The text segment must be within 16MB addressing space.
20261 @item @samp{medium}
20262 The data segment must be within 512KB while the read-only data segment can be
20263 within 4GB addressing space.  The text segment should be still within 16MB
20264 addressing space.
20265 @item @samp{large}
20266 All the text and data segments can be within 4GB addressing space.
20267 @end table
20269 @item -mctor-dtor
20270 @opindex mctor-dtor
20271 Enable constructor/destructor feature.
20273 @item -mrelax
20274 @opindex mrelax
20275 Guide linker to relax instructions.
20277 @end table
20279 @node Nios II Options
20280 @subsection Nios II Options
20281 @cindex Nios II options
20282 @cindex Altera Nios II options
20284 These are the options defined for the Altera Nios II processor.
20286 @table @gcctabopt
20288 @item -G @var{num}
20289 @opindex G
20290 @cindex smaller data references
20291 Put global and static objects less than or equal to @var{num} bytes
20292 into the small data or BSS sections instead of the normal data or BSS
20293 sections.  The default value of @var{num} is 8.
20295 @item -mgpopt=@var{option}
20296 @item -mgpopt
20297 @itemx -mno-gpopt
20298 @opindex mgpopt
20299 @opindex mno-gpopt
20300 Generate (do not generate) GP-relative accesses.  The following 
20301 @var{option} names are recognized:
20303 @table @samp
20305 @item none
20306 Do not generate GP-relative accesses.
20308 @item local
20309 Generate GP-relative accesses for small data objects that are not 
20310 external, weak, or uninitialized common symbols.  
20311 Also use GP-relative addressing for objects that
20312 have been explicitly placed in a small data section via a @code{section}
20313 attribute.
20315 @item global
20316 As for @samp{local}, but also generate GP-relative accesses for
20317 small data objects that are external, weak, or common.  If you use this option,
20318 you must ensure that all parts of your program (including libraries) are
20319 compiled with the same @option{-G} setting.
20321 @item data
20322 Generate GP-relative accesses for all data objects in the program.  If you
20323 use this option, the entire data and BSS segments
20324 of your program must fit in 64K of memory and you must use an appropriate
20325 linker script to allocate them within the addressable range of the
20326 global pointer.
20328 @item all
20329 Generate GP-relative addresses for function pointers as well as data
20330 pointers.  If you use this option, the entire text, data, and BSS segments
20331 of your program must fit in 64K of memory and you must use an appropriate
20332 linker script to allocate them within the addressable range of the
20333 global pointer.
20335 @end table
20337 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20338 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20340 The default is @option{-mgpopt} except when @option{-fpic} or
20341 @option{-fPIC} is specified to generate position-independent code.
20342 Note that the Nios II ABI does not permit GP-relative accesses from
20343 shared libraries.
20345 You may need to specify @option{-mno-gpopt} explicitly when building
20346 programs that include large amounts of small data, including large
20347 GOT data sections.  In this case, the 16-bit offset for GP-relative
20348 addressing may not be large enough to allow access to the entire 
20349 small data section.
20351 @item -mel
20352 @itemx -meb
20353 @opindex mel
20354 @opindex meb
20355 Generate little-endian (default) or big-endian (experimental) code,
20356 respectively.
20358 @item -march=@var{arch}
20359 @opindex march
20360 This specifies the name of the target Nios II architecture.  GCC uses this
20361 name to determine what kind of instructions it can emit when generating
20362 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20364 The preprocessor macro @code{__nios2_arch__} is available to programs,
20365 with value 1 or 2, indicating the targeted ISA level.
20367 @item -mbypass-cache
20368 @itemx -mno-bypass-cache
20369 @opindex mno-bypass-cache
20370 @opindex mbypass-cache
20371 Force all load and store instructions to always bypass cache by 
20372 using I/O variants of the instructions. The default is not to
20373 bypass the cache.
20375 @item -mno-cache-volatile 
20376 @itemx -mcache-volatile       
20377 @opindex mcache-volatile 
20378 @opindex mno-cache-volatile
20379 Volatile memory access bypass the cache using the I/O variants of 
20380 the load and store instructions. The default is not to bypass the cache.
20382 @item -mno-fast-sw-div
20383 @itemx -mfast-sw-div
20384 @opindex mno-fast-sw-div
20385 @opindex mfast-sw-div
20386 Do not use table-based fast divide for small numbers. The default 
20387 is to use the fast divide at @option{-O3} and above.
20389 @item -mno-hw-mul
20390 @itemx -mhw-mul
20391 @itemx -mno-hw-mulx
20392 @itemx -mhw-mulx
20393 @itemx -mno-hw-div
20394 @itemx -mhw-div
20395 @opindex mno-hw-mul
20396 @opindex mhw-mul
20397 @opindex mno-hw-mulx
20398 @opindex mhw-mulx
20399 @opindex mno-hw-div
20400 @opindex mhw-div
20401 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20402 instructions by the compiler. The default is to emit @code{mul}
20403 and not emit @code{div} and @code{mulx}.
20405 @item -mbmx
20406 @itemx -mno-bmx
20407 @itemx -mcdx
20408 @itemx -mno-cdx
20409 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20410 CDX (code density) instructions.  Enabling these instructions also
20411 requires @option{-march=r2}.  Since these instructions are optional
20412 extensions to the R2 architecture, the default is not to emit them.
20414 @item -mcustom-@var{insn}=@var{N}
20415 @itemx -mno-custom-@var{insn}
20416 @opindex mcustom-@var{insn}
20417 @opindex mno-custom-@var{insn}
20418 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20419 custom instruction with encoding @var{N} when generating code that uses 
20420 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20421 instruction 253 for single-precision floating-point add operations instead
20422 of the default behavior of using a library call.
20424 The following values of @var{insn} are supported.  Except as otherwise
20425 noted, floating-point operations are expected to be implemented with
20426 normal IEEE 754 semantics and correspond directly to the C operators or the
20427 equivalent GCC built-in functions (@pxref{Other Builtins}).
20429 Single-precision floating point:
20430 @table @asis
20432 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20433 Binary arithmetic operations.
20435 @item @samp{fnegs}
20436 Unary negation.
20438 @item @samp{fabss}
20439 Unary absolute value.
20441 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20442 Comparison operations.
20444 @item @samp{fmins}, @samp{fmaxs}
20445 Floating-point minimum and maximum.  These instructions are only
20446 generated if @option{-ffinite-math-only} is specified.
20448 @item @samp{fsqrts}
20449 Unary square root operation.
20451 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20452 Floating-point trigonometric and exponential functions.  These instructions
20453 are only generated if @option{-funsafe-math-optimizations} is also specified.
20455 @end table
20457 Double-precision floating point:
20458 @table @asis
20460 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20461 Binary arithmetic operations.
20463 @item @samp{fnegd}
20464 Unary negation.
20466 @item @samp{fabsd}
20467 Unary absolute value.
20469 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20470 Comparison operations.
20472 @item @samp{fmind}, @samp{fmaxd}
20473 Double-precision minimum and maximum.  These instructions are only
20474 generated if @option{-ffinite-math-only} is specified.
20476 @item @samp{fsqrtd}
20477 Unary square root operation.
20479 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20480 Double-precision trigonometric and exponential functions.  These instructions
20481 are only generated if @option{-funsafe-math-optimizations} is also specified.
20483 @end table
20485 Conversions:
20486 @table @asis
20487 @item @samp{fextsd}
20488 Conversion from single precision to double precision.
20490 @item @samp{ftruncds}
20491 Conversion from double precision to single precision.
20493 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20494 Conversion from floating point to signed or unsigned integer types, with
20495 truncation towards zero.
20497 @item @samp{round}
20498 Conversion from single-precision floating point to signed integer,
20499 rounding to the nearest integer and ties away from zero.
20500 This corresponds to the @code{__builtin_lroundf} function when
20501 @option{-fno-math-errno} is used.
20503 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20504 Conversion from signed or unsigned integer types to floating-point types.
20506 @end table
20508 In addition, all of the following transfer instructions for internal
20509 registers X and Y must be provided to use any of the double-precision
20510 floating-point instructions.  Custom instructions taking two
20511 double-precision source operands expect the first operand in the
20512 64-bit register X.  The other operand (or only operand of a unary
20513 operation) is given to the custom arithmetic instruction with the
20514 least significant half in source register @var{src1} and the most
20515 significant half in @var{src2}.  A custom instruction that returns a
20516 double-precision result returns the most significant 32 bits in the
20517 destination register and the other half in 32-bit register Y.  
20518 GCC automatically generates the necessary code sequences to write
20519 register X and/or read register Y when double-precision floating-point
20520 instructions are used.
20522 @table @asis
20524 @item @samp{fwrx}
20525 Write @var{src1} into the least significant half of X and @var{src2} into
20526 the most significant half of X.
20528 @item @samp{fwry}
20529 Write @var{src1} into Y.
20531 @item @samp{frdxhi}, @samp{frdxlo}
20532 Read the most or least (respectively) significant half of X and store it in
20533 @var{dest}.
20535 @item @samp{frdy}
20536 Read the value of Y and store it into @var{dest}.
20537 @end table
20539 Note that you can gain more local control over generation of Nios II custom
20540 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
20541 and @code{target("no-custom-@var{insn}")} function attributes
20542 (@pxref{Function Attributes})
20543 or pragmas (@pxref{Function Specific Option Pragmas}).
20545 @item -mcustom-fpu-cfg=@var{name}
20546 @opindex mcustom-fpu-cfg
20548 This option enables a predefined, named set of custom instruction encodings
20549 (see @option{-mcustom-@var{insn}} above).  
20550 Currently, the following sets are defined:
20552 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
20553 @gccoptlist{-mcustom-fmuls=252 @gol
20554 -mcustom-fadds=253 @gol
20555 -mcustom-fsubs=254 @gol
20556 -fsingle-precision-constant}
20558 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
20559 @gccoptlist{-mcustom-fmuls=252 @gol
20560 -mcustom-fadds=253 @gol
20561 -mcustom-fsubs=254 @gol
20562 -mcustom-fdivs=255 @gol
20563 -fsingle-precision-constant}
20565 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
20566 @gccoptlist{-mcustom-floatus=243 @gol
20567 -mcustom-fixsi=244 @gol
20568 -mcustom-floatis=245 @gol
20569 -mcustom-fcmpgts=246 @gol
20570 -mcustom-fcmples=249 @gol
20571 -mcustom-fcmpeqs=250 @gol
20572 -mcustom-fcmpnes=251 @gol
20573 -mcustom-fmuls=252 @gol
20574 -mcustom-fadds=253 @gol
20575 -mcustom-fsubs=254 @gol
20576 -mcustom-fdivs=255 @gol
20577 -fsingle-precision-constant}
20579 Custom instruction assignments given by individual
20580 @option{-mcustom-@var{insn}=} options override those given by
20581 @option{-mcustom-fpu-cfg=}, regardless of the
20582 order of the options on the command line.
20584 Note that you can gain more local control over selection of a FPU
20585 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
20586 function attribute (@pxref{Function Attributes})
20587 or pragma (@pxref{Function Specific Option Pragmas}).
20589 @end table
20591 These additional @samp{-m} options are available for the Altera Nios II
20592 ELF (bare-metal) target:
20594 @table @gcctabopt
20596 @item -mhal
20597 @opindex mhal
20598 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
20599 startup and termination code, and is typically used in conjunction with
20600 @option{-msys-crt0=} to specify the location of the alternate startup code
20601 provided by the HAL BSP.
20603 @item -msmallc
20604 @opindex msmallc
20605 Link with a limited version of the C library, @option{-lsmallc}, rather than
20606 Newlib.
20608 @item -msys-crt0=@var{startfile}
20609 @opindex msys-crt0
20610 @var{startfile} is the file name of the startfile (crt0) to use 
20611 when linking.  This option is only useful in conjunction with @option{-mhal}.
20613 @item -msys-lib=@var{systemlib}
20614 @opindex msys-lib
20615 @var{systemlib} is the library name of the library that provides
20616 low-level system calls required by the C library,
20617 e.g. @code{read} and @code{write}.
20618 This option is typically used to link with a library provided by a HAL BSP.
20620 @end table
20622 @node Nvidia PTX Options
20623 @subsection Nvidia PTX Options
20624 @cindex Nvidia PTX options
20625 @cindex nvptx options
20627 These options are defined for Nvidia PTX:
20629 @table @gcctabopt
20631 @item -m32
20632 @itemx -m64
20633 @opindex m32
20634 @opindex m64
20635 Generate code for 32-bit or 64-bit ABI.
20637 @item -mmainkernel
20638 @opindex mmainkernel
20639 Link in code for a __main kernel.  This is for stand-alone instead of
20640 offloading execution.
20642 @item -moptimize
20643 @opindex moptimize
20644 Apply partitioned execution optimizations.  This is the default when any
20645 level of optimization is selected.
20647 @item -msoft-stack
20648 @opindex msoft-stack
20649 Generate code that does not use @code{.local} memory
20650 directly for stack storage. Instead, a per-warp stack pointer is
20651 maintained explicitly. This enables variable-length stack allocation (with
20652 variable-length arrays or @code{alloca}), and when global memory is used for
20653 underlying storage, makes it possible to access automatic variables from other
20654 threads, or with atomic instructions. This code generation variant is used
20655 for OpenMP offloading, but the option is exposed on its own for the purpose
20656 of testing the compiler; to generate code suitable for linking into programs
20657 using OpenMP offloading, use option @option{-mgomp}.
20659 @item -muniform-simt
20660 @opindex muniform-simt
20661 Switch to code generation variant that allows to execute all threads in each
20662 warp, while maintaining memory state and side effects as if only one thread
20663 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
20664 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
20665 current lane index equals the master lane index), and the register being
20666 assigned is copied via a shuffle instruction from the master lane.  Outside of
20667 SIMD regions lane 0 is the master; inside, each thread sees itself as the
20668 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
20669 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
20670 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
20671 with current lane index to compute the master lane index.
20673 @item -mgomp
20674 @opindex mgomp
20675 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
20676 @option{-muniform-simt} options, and selects corresponding multilib variant.
20678 @end table
20680 @node PDP-11 Options
20681 @subsection PDP-11 Options
20682 @cindex PDP-11 Options
20684 These options are defined for the PDP-11:
20686 @table @gcctabopt
20687 @item -mfpu
20688 @opindex mfpu
20689 Use hardware FPP floating point.  This is the default.  (FIS floating
20690 point on the PDP-11/40 is not supported.)
20692 @item -msoft-float
20693 @opindex msoft-float
20694 Do not use hardware floating point.
20696 @item -mac0
20697 @opindex mac0
20698 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
20700 @item -mno-ac0
20701 @opindex mno-ac0
20702 Return floating-point results in memory.  This is the default.
20704 @item -m40
20705 @opindex m40
20706 Generate code for a PDP-11/40.
20708 @item -m45
20709 @opindex m45
20710 Generate code for a PDP-11/45.  This is the default.
20712 @item -m10
20713 @opindex m10
20714 Generate code for a PDP-11/10.
20716 @item -mbcopy-builtin
20717 @opindex mbcopy-builtin
20718 Use inline @code{movmemhi} patterns for copying memory.  This is the
20719 default.
20721 @item -mbcopy
20722 @opindex mbcopy
20723 Do not use inline @code{movmemhi} patterns for copying memory.
20725 @item -mint16
20726 @itemx -mno-int32
20727 @opindex mint16
20728 @opindex mno-int32
20729 Use 16-bit @code{int}.  This is the default.
20731 @item -mint32
20732 @itemx -mno-int16
20733 @opindex mint32
20734 @opindex mno-int16
20735 Use 32-bit @code{int}.
20737 @item -mfloat64
20738 @itemx -mno-float32
20739 @opindex mfloat64
20740 @opindex mno-float32
20741 Use 64-bit @code{float}.  This is the default.
20743 @item -mfloat32
20744 @itemx -mno-float64
20745 @opindex mfloat32
20746 @opindex mno-float64
20747 Use 32-bit @code{float}.
20749 @item -mabshi
20750 @opindex mabshi
20751 Use @code{abshi2} pattern.  This is the default.
20753 @item -mno-abshi
20754 @opindex mno-abshi
20755 Do not use @code{abshi2} pattern.
20757 @item -mbranch-expensive
20758 @opindex mbranch-expensive
20759 Pretend that branches are expensive.  This is for experimenting with
20760 code generation only.
20762 @item -mbranch-cheap
20763 @opindex mbranch-cheap
20764 Do not pretend that branches are expensive.  This is the default.
20766 @item -munix-asm
20767 @opindex munix-asm
20768 Use Unix assembler syntax.  This is the default when configured for
20769 @samp{pdp11-*-bsd}.
20771 @item -mdec-asm
20772 @opindex mdec-asm
20773 Use DEC assembler syntax.  This is the default when configured for any
20774 PDP-11 target other than @samp{pdp11-*-bsd}.
20775 @end table
20777 @node picoChip Options
20778 @subsection picoChip Options
20779 @cindex picoChip options
20781 These @samp{-m} options are defined for picoChip implementations:
20783 @table @gcctabopt
20785 @item -mae=@var{ae_type}
20786 @opindex mcpu
20787 Set the instruction set, register set, and instruction scheduling
20788 parameters for array element type @var{ae_type}.  Supported values
20789 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
20791 @option{-mae=ANY} selects a completely generic AE type.  Code
20792 generated with this option runs on any of the other AE types.  The
20793 code is not as efficient as it would be if compiled for a specific
20794 AE type, and some types of operation (e.g., multiplication) do not
20795 work properly on all types of AE.
20797 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
20798 for compiled code, and is the default.
20800 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
20801 option may suffer from poor performance of byte (char) manipulation,
20802 since the DSP AE does not provide hardware support for byte load/stores.
20804 @item -msymbol-as-address
20805 Enable the compiler to directly use a symbol name as an address in a
20806 load/store instruction, without first loading it into a
20807 register.  Typically, the use of this option generates larger
20808 programs, which run faster than when the option isn't used.  However, the
20809 results vary from program to program, so it is left as a user option,
20810 rather than being permanently enabled.
20812 @item -mno-inefficient-warnings
20813 Disables warnings about the generation of inefficient code.  These
20814 warnings can be generated, for example, when compiling code that
20815 performs byte-level memory operations on the MAC AE type.  The MAC AE has
20816 no hardware support for byte-level memory operations, so all byte
20817 load/stores must be synthesized from word load/store operations.  This is
20818 inefficient and a warning is generated to indicate
20819 that you should rewrite the code to avoid byte operations, or to target
20820 an AE type that has the necessary hardware support.  This option disables
20821 these warnings.
20823 @end table
20825 @node PowerPC Options
20826 @subsection PowerPC Options
20827 @cindex PowerPC options
20829 These are listed under @xref{RS/6000 and PowerPC Options}.
20831 @node RL78 Options
20832 @subsection RL78 Options
20833 @cindex RL78 Options
20835 @table @gcctabopt
20837 @item -msim
20838 @opindex msim
20839 Links in additional target libraries to support operation within a
20840 simulator.
20842 @item -mmul=none
20843 @itemx -mmul=g10
20844 @itemx -mmul=g13
20845 @itemx -mmul=g14
20846 @itemx -mmul=rl78
20847 @opindex mmul
20848 Specifies the type of hardware multiplication and division support to
20849 be used.  The simplest is @code{none}, which uses software for both
20850 multiplication and division.  This is the default.  The @code{g13}
20851 value is for the hardware multiply/divide peripheral found on the
20852 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
20853 the multiplication and division instructions supported by the RL78/G14
20854 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
20855 the value @code{mg10} is an alias for @code{none}.
20857 In addition a C preprocessor macro is defined, based upon the setting
20858 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
20859 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
20861 @item -mcpu=g10
20862 @itemx -mcpu=g13
20863 @itemx -mcpu=g14
20864 @itemx -mcpu=rl78
20865 @opindex mcpu
20866 Specifies the RL78 core to target.  The default is the G14 core, also
20867 known as an S3 core or just RL78.  The G13 or S2 core does not have
20868 multiply or divide instructions, instead it uses a hardware peripheral
20869 for these operations.  The G10 or S1 core does not have register
20870 banks, so it uses a different calling convention.
20872 If this option is set it also selects the type of hardware multiply
20873 support to use, unless this is overridden by an explicit
20874 @option{-mmul=none} option on the command line.  Thus specifying
20875 @option{-mcpu=g13} enables the use of the G13 hardware multiply
20876 peripheral and specifying @option{-mcpu=g10} disables the use of
20877 hardware multiplications altogether.
20879 Note, although the RL78/G14 core is the default target, specifying
20880 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
20881 change the behavior of the toolchain since it also enables G14
20882 hardware multiply support.  If these options are not specified on the
20883 command line then software multiplication routines will be used even
20884 though the code targets the RL78 core.  This is for backwards
20885 compatibility with older toolchains which did not have hardware
20886 multiply and divide support.
20888 In addition a C preprocessor macro is defined, based upon the setting
20889 of this option.  Possible values are: @code{__RL78_G10__},
20890 @code{__RL78_G13__} or @code{__RL78_G14__}.
20892 @item -mg10
20893 @itemx -mg13
20894 @itemx -mg14
20895 @itemx -mrl78
20896 @opindex mg10
20897 @opindex mg13
20898 @opindex mg14
20899 @opindex mrl78
20900 These are aliases for the corresponding @option{-mcpu=} option.  They
20901 are provided for backwards compatibility.
20903 @item -mallregs
20904 @opindex mallregs
20905 Allow the compiler to use all of the available registers.  By default
20906 registers @code{r24..r31} are reserved for use in interrupt handlers.
20907 With this option enabled these registers can be used in ordinary
20908 functions as well.
20910 @item -m64bit-doubles
20911 @itemx -m32bit-doubles
20912 @opindex m64bit-doubles
20913 @opindex m32bit-doubles
20914 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20915 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20916 @option{-m32bit-doubles}.
20918 @item -msave-mduc-in-interrupts
20919 @item -mno-save-mduc-in-interrupts
20920 @opindex msave-mduc-in-interrupts
20921 @opindex mno-save-mduc-in-interrupts
20922 Specifies that interrupt handler functions should preserve the
20923 MDUC registers.  This is only necessary if normal code might use
20924 the MDUC registers, for example because it performs multiplication
20925 and division operations.  The default is to ignore the MDUC registers
20926 as this makes the interrupt handlers faster.  The target option -mg13
20927 needs to be passed for this to work as this feature is only available
20928 on the G13 target (S2 core).  The MDUC registers will only be saved
20929 if the interrupt handler performs a multiplication or division
20930 operation or it calls another function.
20932 @end table
20934 @node RS/6000 and PowerPC Options
20935 @subsection IBM RS/6000 and PowerPC Options
20936 @cindex RS/6000 and PowerPC Options
20937 @cindex IBM RS/6000 and PowerPC Options
20939 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
20940 @table @gcctabopt
20941 @item -mpowerpc-gpopt
20942 @itemx -mno-powerpc-gpopt
20943 @itemx -mpowerpc-gfxopt
20944 @itemx -mno-powerpc-gfxopt
20945 @need 800
20946 @itemx -mpowerpc64
20947 @itemx -mno-powerpc64
20948 @itemx -mmfcrf
20949 @itemx -mno-mfcrf
20950 @itemx -mpopcntb
20951 @itemx -mno-popcntb
20952 @itemx -mpopcntd
20953 @itemx -mno-popcntd
20954 @itemx -mfprnd
20955 @itemx -mno-fprnd
20956 @need 800
20957 @itemx -mcmpb
20958 @itemx -mno-cmpb
20959 @itemx -mmfpgpr
20960 @itemx -mno-mfpgpr
20961 @itemx -mhard-dfp
20962 @itemx -mno-hard-dfp
20963 @opindex mpowerpc-gpopt
20964 @opindex mno-powerpc-gpopt
20965 @opindex mpowerpc-gfxopt
20966 @opindex mno-powerpc-gfxopt
20967 @opindex mpowerpc64
20968 @opindex mno-powerpc64
20969 @opindex mmfcrf
20970 @opindex mno-mfcrf
20971 @opindex mpopcntb
20972 @opindex mno-popcntb
20973 @opindex mpopcntd
20974 @opindex mno-popcntd
20975 @opindex mfprnd
20976 @opindex mno-fprnd
20977 @opindex mcmpb
20978 @opindex mno-cmpb
20979 @opindex mmfpgpr
20980 @opindex mno-mfpgpr
20981 @opindex mhard-dfp
20982 @opindex mno-hard-dfp
20983 You use these options to specify which instructions are available on the
20984 processor you are using.  The default value of these options is
20985 determined when configuring GCC@.  Specifying the
20986 @option{-mcpu=@var{cpu_type}} overrides the specification of these
20987 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
20988 rather than the options listed above.
20990 Specifying @option{-mpowerpc-gpopt} allows
20991 GCC to use the optional PowerPC architecture instructions in the
20992 General Purpose group, including floating-point square root.  Specifying
20993 @option{-mpowerpc-gfxopt} allows GCC to
20994 use the optional PowerPC architecture instructions in the Graphics
20995 group, including floating-point select.
20997 The @option{-mmfcrf} option allows GCC to generate the move from
20998 condition register field instruction implemented on the POWER4
20999 processor and other processors that support the PowerPC V2.01
21000 architecture.
21001 The @option{-mpopcntb} option allows GCC to generate the popcount and
21002 double-precision FP reciprocal estimate instruction implemented on the
21003 POWER5 processor and other processors that support the PowerPC V2.02
21004 architecture.
21005 The @option{-mpopcntd} option allows GCC to generate the popcount
21006 instruction implemented on the POWER7 processor and other processors
21007 that support the PowerPC V2.06 architecture.
21008 The @option{-mfprnd} option allows GCC to generate the FP round to
21009 integer instructions implemented on the POWER5+ processor and other
21010 processors that support the PowerPC V2.03 architecture.
21011 The @option{-mcmpb} option allows GCC to generate the compare bytes
21012 instruction implemented on the POWER6 processor and other processors
21013 that support the PowerPC V2.05 architecture.
21014 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21015 general-purpose register instructions implemented on the POWER6X
21016 processor and other processors that support the extended PowerPC V2.05
21017 architecture.
21018 The @option{-mhard-dfp} option allows GCC to generate the decimal
21019 floating-point instructions implemented on some POWER processors.
21021 The @option{-mpowerpc64} option allows GCC to generate the additional
21022 64-bit instructions that are found in the full PowerPC64 architecture
21023 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21024 @option{-mno-powerpc64}.
21026 @item -mcpu=@var{cpu_type}
21027 @opindex mcpu
21028 Set architecture type, register usage, and
21029 instruction scheduling parameters for machine type @var{cpu_type}.
21030 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21031 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21032 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21033 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21034 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21035 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21036 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21037 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21038 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21039 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21040 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21041 and @samp{rs64}.
21043 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21044 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21045 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21046 architecture machine types, with an appropriate, generic processor
21047 model assumed for scheduling purposes.
21049 The other options specify a specific processor.  Code generated under
21050 those options runs best on that processor, and may not run at all on
21051 others.
21053 The @option{-mcpu} options automatically enable or disable the
21054 following options:
21056 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21057 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21058 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21059 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21060 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21061 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21063 The particular options set for any particular CPU varies between
21064 compiler versions, depending on what setting seems to produce optimal
21065 code for that CPU; it doesn't necessarily reflect the actual hardware's
21066 capabilities.  If you wish to set an individual option to a particular
21067 value, you may specify it after the @option{-mcpu} option, like
21068 @option{-mcpu=970 -mno-altivec}.
21070 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21071 not enabled or disabled by the @option{-mcpu} option at present because
21072 AIX does not have full support for these options.  You may still
21073 enable or disable them individually if you're sure it'll work in your
21074 environment.
21076 @item -mtune=@var{cpu_type}
21077 @opindex mtune
21078 Set the instruction scheduling parameters for machine type
21079 @var{cpu_type}, but do not set the architecture type or register usage,
21080 as @option{-mcpu=@var{cpu_type}} does.  The same
21081 values for @var{cpu_type} are used for @option{-mtune} as for
21082 @option{-mcpu}.  If both are specified, the code generated uses the
21083 architecture and registers set by @option{-mcpu}, but the
21084 scheduling parameters set by @option{-mtune}.
21086 @item -mcmodel=small
21087 @opindex mcmodel=small
21088 Generate PowerPC64 code for the small model: The TOC is limited to
21089 64k.
21091 @item -mcmodel=medium
21092 @opindex mcmodel=medium
21093 Generate PowerPC64 code for the medium model: The TOC and other static
21094 data may be up to a total of 4G in size.
21096 @item -mcmodel=large
21097 @opindex mcmodel=large
21098 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21099 in size.  Other data and code is only limited by the 64-bit address
21100 space.
21102 @item -maltivec
21103 @itemx -mno-altivec
21104 @opindex maltivec
21105 @opindex mno-altivec
21106 Generate code that uses (does not use) AltiVec instructions, and also
21107 enable the use of built-in functions that allow more direct access to
21108 the AltiVec instruction set.  You may also need to set
21109 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21110 enhancements.
21112 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21113 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21114 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21115 match array element order corresponding to the endianness of the
21116 target.  That is, element zero identifies the leftmost element in a
21117 vector register when targeting a big-endian platform, and identifies
21118 the rightmost element in a vector register when targeting a
21119 little-endian platform.
21121 @item -maltivec=be
21122 @opindex maltivec=be
21123 Generate AltiVec instructions using big-endian element order,
21124 regardless of whether the target is big- or little-endian.  This is
21125 the default when targeting a big-endian platform.
21127 The element order is used to interpret element numbers in AltiVec
21128 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21129 @code{vec_insert}.  By default, these match array element order
21130 corresponding to the endianness for the target.
21132 @item -maltivec=le
21133 @opindex maltivec=le
21134 Generate AltiVec instructions using little-endian element order,
21135 regardless of whether the target is big- or little-endian.  This is
21136 the default when targeting a little-endian platform.  This option is
21137 currently ignored when targeting a big-endian platform.
21139 The element order is used to interpret element numbers in AltiVec
21140 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21141 @code{vec_insert}.  By default, these match array element order
21142 corresponding to the endianness for the target.
21144 @item -mvrsave
21145 @itemx -mno-vrsave
21146 @opindex mvrsave
21147 @opindex mno-vrsave
21148 Generate VRSAVE instructions when generating AltiVec code.
21150 @item -mgen-cell-microcode
21151 @opindex mgen-cell-microcode
21152 Generate Cell microcode instructions.
21154 @item -mwarn-cell-microcode
21155 @opindex mwarn-cell-microcode
21156 Warn when a Cell microcode instruction is emitted.  An example
21157 of a Cell microcode instruction is a variable shift.
21159 @item -msecure-plt
21160 @opindex msecure-plt
21161 Generate code that allows @command{ld} and @command{ld.so}
21162 to build executables and shared
21163 libraries with non-executable @code{.plt} and @code{.got} sections.
21164 This is a PowerPC
21165 32-bit SYSV ABI option.
21167 @item -mbss-plt
21168 @opindex mbss-plt
21169 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21170 fills in, and
21171 requires @code{.plt} and @code{.got}
21172 sections that are both writable and executable.
21173 This is a PowerPC 32-bit SYSV ABI option.
21175 @item -misel
21176 @itemx -mno-isel
21177 @opindex misel
21178 @opindex mno-isel
21179 This switch enables or disables the generation of ISEL instructions.
21181 @item -misel=@var{yes/no}
21182 This switch has been deprecated.  Use @option{-misel} and
21183 @option{-mno-isel} instead.
21185 @item -mlra
21186 @opindex mlra
21187 Enable Local Register Allocation. By default the port uses LRA.
21188 (i.e. @option{-mno-lra}).
21190 @item -mspe
21191 @itemx -mno-spe
21192 @opindex mspe
21193 @opindex mno-spe
21194 This switch enables or disables the generation of SPE simd
21195 instructions.
21197 @item -mpaired
21198 @itemx -mno-paired
21199 @opindex mpaired
21200 @opindex mno-paired
21201 This switch enables or disables the generation of PAIRED simd
21202 instructions.
21204 @item -mspe=@var{yes/no}
21205 This option has been deprecated.  Use @option{-mspe} and
21206 @option{-mno-spe} instead.
21208 @item -mvsx
21209 @itemx -mno-vsx
21210 @opindex mvsx
21211 @opindex mno-vsx
21212 Generate code that uses (does not use) vector/scalar (VSX)
21213 instructions, and also enable the use of built-in functions that allow
21214 more direct access to the VSX instruction set.
21216 @item -mcrypto
21217 @itemx -mno-crypto
21218 @opindex mcrypto
21219 @opindex mno-crypto
21220 Enable the use (disable) of the built-in functions that allow direct
21221 access to the cryptographic instructions that were added in version
21222 2.07 of the PowerPC ISA.
21224 @item -mdirect-move
21225 @itemx -mno-direct-move
21226 @opindex mdirect-move
21227 @opindex mno-direct-move
21228 Generate code that uses (does not use) the instructions to move data
21229 between the general purpose registers and the vector/scalar (VSX)
21230 registers that were added in version 2.07 of the PowerPC ISA.
21232 @item -mhtm
21233 @itemx -mno-htm
21234 @opindex mhtm
21235 @opindex mno-htm
21236 Enable (disable) the use of the built-in functions that allow direct
21237 access to the Hardware Transactional Memory (HTM) instructions that
21238 were added in version 2.07 of the PowerPC ISA.
21240 @item -mpower8-fusion
21241 @itemx -mno-power8-fusion
21242 @opindex mpower8-fusion
21243 @opindex mno-power8-fusion
21244 Generate code that keeps (does not keeps) some integer operations
21245 adjacent so that the instructions can be fused together on power8 and
21246 later processors.
21248 @item -mpower8-vector
21249 @itemx -mno-power8-vector
21250 @opindex mpower8-vector
21251 @opindex mno-power8-vector
21252 Generate code that uses (does not use) the vector and scalar
21253 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21254 enable the use of built-in functions that allow more direct access to
21255 the vector instructions.
21257 @item -mquad-memory
21258 @itemx -mno-quad-memory
21259 @opindex mquad-memory
21260 @opindex mno-quad-memory
21261 Generate code that uses (does not use) the non-atomic quad word memory
21262 instructions.  The @option{-mquad-memory} option requires use of
21263 64-bit mode.
21265 @item -mquad-memory-atomic
21266 @itemx -mno-quad-memory-atomic
21267 @opindex mquad-memory-atomic
21268 @opindex mno-quad-memory-atomic
21269 Generate code that uses (does not use) the atomic quad word memory
21270 instructions.  The @option{-mquad-memory-atomic} option requires use of
21271 64-bit mode.
21273 @item -mupper-regs-di
21274 @itemx -mno-upper-regs-di
21275 @opindex mupper-regs-di
21276 @opindex mno-upper-regs-di
21277 Generate code that uses (does not use) the scalar instructions that
21278 target all 64 registers in the vector/scalar floating point register
21279 set that were added in version 2.06 of the PowerPC ISA when processing
21280 integers.  @option{-mupper-regs-di} is turned on by default if you use
21281 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21282 @option{-mcpu=power9}, or @option{-mvsx} options.
21284 @item -mupper-regs-df
21285 @itemx -mno-upper-regs-df
21286 @opindex mupper-regs-df
21287 @opindex mno-upper-regs-df
21288 Generate code that uses (does not use) the scalar double precision
21289 instructions that target all 64 registers in the vector/scalar
21290 floating point register set that were added in version 2.06 of the
21291 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21292 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21293 @option{-mcpu=power9}, or @option{-mvsx} options.
21295 @item -mupper-regs-sf
21296 @itemx -mno-upper-regs-sf
21297 @opindex mupper-regs-sf
21298 @opindex mno-upper-regs-sf
21299 Generate code that uses (does not use) the scalar single precision
21300 instructions that target all 64 registers in the vector/scalar
21301 floating point register set that were added in version 2.07 of the
21302 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21303 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21304 @option{-mcpu=power9} options.
21306 @item -mupper-regs
21307 @itemx -mno-upper-regs
21308 @opindex mupper-regs
21309 @opindex mno-upper-regs
21310 Generate code that uses (does not use) the scalar
21311 instructions that target all 64 registers in the vector/scalar
21312 floating point register set, depending on the model of the machine.
21314 If the @option{-mno-upper-regs} option is used, it turns off both
21315 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21317 @item -mfloat128
21318 @itemx -mno-float128
21319 @opindex mfloat128
21320 @opindex mno-float128
21321 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21322 and use either software emulation for IEEE 128-bit floating point or
21323 hardware instructions.
21325 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21326 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21327 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21328 Linux systems.
21330 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21331 @option{-mfloat128} option will also enable the generation of ISA 3.0
21332 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21333 floating point will be done with software emulation.
21335 @item -mfloat128-hardware
21336 @itemx -mno-float128-hardware
21337 @opindex mfloat128-hardware
21338 @opindex mno-float128-hardware
21339 Enable/disable using ISA 3.0 hardware instructions to support the
21340 @var{__float128} data type.
21342 If you use @option{-mfloat128-hardware}, it will enable the option
21343 @option{-mfloat128} as well.
21345 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21346 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21347 the IEEE 128-bit floating point support will not be enabled.
21349 @item -mfloat-gprs=@var{yes/single/double/no}
21350 @itemx -mfloat-gprs
21351 @opindex mfloat-gprs
21352 This switch enables or disables the generation of floating-point
21353 operations on the general-purpose registers for architectures that
21354 support it.
21356 The argument @samp{yes} or @samp{single} enables the use of
21357 single-precision floating-point operations.
21359 The argument @samp{double} enables the use of single and
21360 double-precision floating-point operations.
21362 The argument @samp{no} disables floating-point operations on the
21363 general-purpose registers.
21365 This option is currently only available on the MPC854x.
21367 @item -m32
21368 @itemx -m64
21369 @opindex m32
21370 @opindex m64
21371 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21372 targets (including GNU/Linux).  The 32-bit environment sets int, long
21373 and pointer to 32 bits and generates code that runs on any PowerPC
21374 variant.  The 64-bit environment sets int to 32 bits and long and
21375 pointer to 64 bits, and generates code for PowerPC64, as for
21376 @option{-mpowerpc64}.
21378 @item -mfull-toc
21379 @itemx -mno-fp-in-toc
21380 @itemx -mno-sum-in-toc
21381 @itemx -mminimal-toc
21382 @opindex mfull-toc
21383 @opindex mno-fp-in-toc
21384 @opindex mno-sum-in-toc
21385 @opindex mminimal-toc
21386 Modify generation of the TOC (Table Of Contents), which is created for
21387 every executable file.  The @option{-mfull-toc} option is selected by
21388 default.  In that case, GCC allocates at least one TOC entry for
21389 each unique non-automatic variable reference in your program.  GCC
21390 also places floating-point constants in the TOC@.  However, only
21391 16,384 entries are available in the TOC@.
21393 If you receive a linker error message that saying you have overflowed
21394 the available TOC space, you can reduce the amount of TOC space used
21395 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21396 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21397 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21398 generate code to calculate the sum of an address and a constant at
21399 run time instead of putting that sum into the TOC@.  You may specify one
21400 or both of these options.  Each causes GCC to produce very slightly
21401 slower and larger code at the expense of conserving TOC space.
21403 If you still run out of space in the TOC even when you specify both of
21404 these options, specify @option{-mminimal-toc} instead.  This option causes
21405 GCC to make only one TOC entry for every file.  When you specify this
21406 option, GCC produces code that is slower and larger but which
21407 uses extremely little TOC space.  You may wish to use this option
21408 only on files that contain less frequently-executed code.
21410 @item -maix64
21411 @itemx -maix32
21412 @opindex maix64
21413 @opindex maix32
21414 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21415 @code{long} type, and the infrastructure needed to support them.
21416 Specifying @option{-maix64} implies @option{-mpowerpc64},
21417 while @option{-maix32} disables the 64-bit ABI and
21418 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21420 @item -mxl-compat
21421 @itemx -mno-xl-compat
21422 @opindex mxl-compat
21423 @opindex mno-xl-compat
21424 Produce code that conforms more closely to IBM XL compiler semantics
21425 when using AIX-compatible ABI@.  Pass floating-point arguments to
21426 prototyped functions beyond the register save area (RSA) on the stack
21427 in addition to argument FPRs.  Do not assume that most significant
21428 double in 128-bit long double value is properly rounded when comparing
21429 values and converting to double.  Use XL symbol names for long double
21430 support routines.
21432 The AIX calling convention was extended but not initially documented to
21433 handle an obscure K&R C case of calling a function that takes the
21434 address of its arguments with fewer arguments than declared.  IBM XL
21435 compilers access floating-point arguments that do not fit in the
21436 RSA from the stack when a subroutine is compiled without
21437 optimization.  Because always storing floating-point arguments on the
21438 stack is inefficient and rarely needed, this option is not enabled by
21439 default and only is necessary when calling subroutines compiled by IBM
21440 XL compilers without optimization.
21442 @item -mpe
21443 @opindex mpe
21444 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21445 application written to use message passing with special startup code to
21446 enable the application to run.  The system must have PE installed in the
21447 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21448 must be overridden with the @option{-specs=} option to specify the
21449 appropriate directory location.  The Parallel Environment does not
21450 support threads, so the @option{-mpe} option and the @option{-pthread}
21451 option are incompatible.
21453 @item -malign-natural
21454 @itemx -malign-power
21455 @opindex malign-natural
21456 @opindex malign-power
21457 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
21458 @option{-malign-natural} overrides the ABI-defined alignment of larger
21459 types, such as floating-point doubles, on their natural size-based boundary.
21460 The option @option{-malign-power} instructs GCC to follow the ABI-specified
21461 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
21463 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
21464 is not supported.
21466 @item -msoft-float
21467 @itemx -mhard-float
21468 @opindex msoft-float
21469 @opindex mhard-float
21470 Generate code that does not use (uses) the floating-point register set.
21471 Software floating-point emulation is provided if you use the
21472 @option{-msoft-float} option, and pass the option to GCC when linking.
21474 @item -msingle-float
21475 @itemx -mdouble-float
21476 @opindex msingle-float
21477 @opindex mdouble-float
21478 Generate code for single- or double-precision floating-point operations.
21479 @option{-mdouble-float} implies @option{-msingle-float}.
21481 @item -msimple-fpu
21482 @opindex msimple-fpu
21483 Do not generate @code{sqrt} and @code{div} instructions for hardware
21484 floating-point unit.
21486 @item -mfpu=@var{name}
21487 @opindex mfpu
21488 Specify type of floating-point unit.  Valid values for @var{name} are
21489 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
21490 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
21491 @samp{sp_full} (equivalent to @option{-msingle-float}),
21492 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
21494 @item -mxilinx-fpu
21495 @opindex mxilinx-fpu
21496 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
21498 @item -mmultiple
21499 @itemx -mno-multiple
21500 @opindex mmultiple
21501 @opindex mno-multiple
21502 Generate code that uses (does not use) the load multiple word
21503 instructions and the store multiple word instructions.  These
21504 instructions are generated by default on POWER systems, and not
21505 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
21506 PowerPC systems, since those instructions do not work when the
21507 processor is in little-endian mode.  The exceptions are PPC740 and
21508 PPC750 which permit these instructions in little-endian mode.
21510 @item -mstring
21511 @itemx -mno-string
21512 @opindex mstring
21513 @opindex mno-string
21514 Generate code that uses (does not use) the load string instructions
21515 and the store string word instructions to save multiple registers and
21516 do small block moves.  These instructions are generated by default on
21517 POWER systems, and not generated on PowerPC systems.  Do not use
21518 @option{-mstring} on little-endian PowerPC systems, since those
21519 instructions do not work when the processor is in little-endian mode.
21520 The exceptions are PPC740 and PPC750 which permit these instructions
21521 in little-endian mode.
21523 @item -mupdate
21524 @itemx -mno-update
21525 @opindex mupdate
21526 @opindex mno-update
21527 Generate code that uses (does not use) the load or store instructions
21528 that update the base register to the address of the calculated memory
21529 location.  These instructions are generated by default.  If you use
21530 @option{-mno-update}, there is a small window between the time that the
21531 stack pointer is updated and the address of the previous frame is
21532 stored, which means code that walks the stack frame across interrupts or
21533 signals may get corrupted data.
21535 @item -mavoid-indexed-addresses
21536 @itemx -mno-avoid-indexed-addresses
21537 @opindex mavoid-indexed-addresses
21538 @opindex mno-avoid-indexed-addresses
21539 Generate code that tries to avoid (not avoid) the use of indexed load
21540 or store instructions. These instructions can incur a performance
21541 penalty on Power6 processors in certain situations, such as when
21542 stepping through large arrays that cross a 16M boundary.  This option
21543 is enabled by default when targeting Power6 and disabled otherwise.
21545 @item -mfused-madd
21546 @itemx -mno-fused-madd
21547 @opindex mfused-madd
21548 @opindex mno-fused-madd
21549 Generate code that uses (does not use) the floating-point multiply and
21550 accumulate instructions.  These instructions are generated by default
21551 if hardware floating point is used.  The machine-dependent
21552 @option{-mfused-madd} option is now mapped to the machine-independent
21553 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21554 mapped to @option{-ffp-contract=off}.
21556 @item -mmulhw
21557 @itemx -mno-mulhw
21558 @opindex mmulhw
21559 @opindex mno-mulhw
21560 Generate code that uses (does not use) the half-word multiply and
21561 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
21562 These instructions are generated by default when targeting those
21563 processors.
21565 @item -mdlmzb
21566 @itemx -mno-dlmzb
21567 @opindex mdlmzb
21568 @opindex mno-dlmzb
21569 Generate code that uses (does not use) the string-search @samp{dlmzb}
21570 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
21571 generated by default when targeting those processors.
21573 @item -mno-bit-align
21574 @itemx -mbit-align
21575 @opindex mno-bit-align
21576 @opindex mbit-align
21577 On System V.4 and embedded PowerPC systems do not (do) force structures
21578 and unions that contain bit-fields to be aligned to the base type of the
21579 bit-field.
21581 For example, by default a structure containing nothing but 8
21582 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
21583 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
21584 the structure is aligned to a 1-byte boundary and is 1 byte in
21585 size.
21587 @item -mno-strict-align
21588 @itemx -mstrict-align
21589 @opindex mno-strict-align
21590 @opindex mstrict-align
21591 On System V.4 and embedded PowerPC systems do not (do) assume that
21592 unaligned memory references are handled by the system.
21594 @item -mrelocatable
21595 @itemx -mno-relocatable
21596 @opindex mrelocatable
21597 @opindex mno-relocatable
21598 Generate code that allows (does not allow) a static executable to be
21599 relocated to a different address at run time.  A simple embedded
21600 PowerPC system loader should relocate the entire contents of
21601 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
21602 a table of 32-bit addresses generated by this option.  For this to
21603 work, all objects linked together must be compiled with
21604 @option{-mrelocatable} or @option{-mrelocatable-lib}.
21605 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
21607 @item -mrelocatable-lib
21608 @itemx -mno-relocatable-lib
21609 @opindex mrelocatable-lib
21610 @opindex mno-relocatable-lib
21611 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
21612 @code{.fixup} section to allow static executables to be relocated at
21613 run time, but @option{-mrelocatable-lib} does not use the smaller stack
21614 alignment of @option{-mrelocatable}.  Objects compiled with
21615 @option{-mrelocatable-lib} may be linked with objects compiled with
21616 any combination of the @option{-mrelocatable} options.
21618 @item -mno-toc
21619 @itemx -mtoc
21620 @opindex mno-toc
21621 @opindex mtoc
21622 On System V.4 and embedded PowerPC systems do not (do) assume that
21623 register 2 contains a pointer to a global area pointing to the addresses
21624 used in the program.
21626 @item -mlittle
21627 @itemx -mlittle-endian
21628 @opindex mlittle
21629 @opindex mlittle-endian
21630 On System V.4 and embedded PowerPC systems compile code for the
21631 processor in little-endian mode.  The @option{-mlittle-endian} option is
21632 the same as @option{-mlittle}.
21634 @item -mbig
21635 @itemx -mbig-endian
21636 @opindex mbig
21637 @opindex mbig-endian
21638 On System V.4 and embedded PowerPC systems compile code for the
21639 processor in big-endian mode.  The @option{-mbig-endian} option is
21640 the same as @option{-mbig}.
21642 @item -mdynamic-no-pic
21643 @opindex mdynamic-no-pic
21644 On Darwin and Mac OS X systems, compile code so that it is not
21645 relocatable, but that its external references are relocatable.  The
21646 resulting code is suitable for applications, but not shared
21647 libraries.
21649 @item -msingle-pic-base
21650 @opindex msingle-pic-base
21651 Treat the register used for PIC addressing as read-only, rather than
21652 loading it in the prologue for each function.  The runtime system is
21653 responsible for initializing this register with an appropriate value
21654 before execution begins.
21656 @item -mprioritize-restricted-insns=@var{priority}
21657 @opindex mprioritize-restricted-insns
21658 This option controls the priority that is assigned to
21659 dispatch-slot restricted instructions during the second scheduling
21660 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
21661 or @samp{2} to assign no, highest, or second-highest (respectively) 
21662 priority to dispatch-slot restricted
21663 instructions.
21665 @item -msched-costly-dep=@var{dependence_type}
21666 @opindex msched-costly-dep
21667 This option controls which dependences are considered costly
21668 by the target during instruction scheduling.  The argument
21669 @var{dependence_type} takes one of the following values:
21671 @table @asis
21672 @item @samp{no}
21673 No dependence is costly.
21675 @item @samp{all}
21676 All dependences are costly.
21678 @item @samp{true_store_to_load}
21679 A true dependence from store to load is costly.
21681 @item @samp{store_to_load}
21682 Any dependence from store to load is costly.
21684 @item @var{number}
21685 Any dependence for which the latency is greater than or equal to 
21686 @var{number} is costly.
21687 @end table
21689 @item -minsert-sched-nops=@var{scheme}
21690 @opindex minsert-sched-nops
21691 This option controls which NOP insertion scheme is used during
21692 the second scheduling pass.  The argument @var{scheme} takes one of the
21693 following values:
21695 @table @asis
21696 @item @samp{no}
21697 Don't insert NOPs.
21699 @item @samp{pad}
21700 Pad with NOPs any dispatch group that has vacant issue slots,
21701 according to the scheduler's grouping.
21703 @item @samp{regroup_exact}
21704 Insert NOPs to force costly dependent insns into
21705 separate groups.  Insert exactly as many NOPs as needed to force an insn
21706 to a new group, according to the estimated processor grouping.
21708 @item @var{number}
21709 Insert NOPs to force costly dependent insns into
21710 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
21711 @end table
21713 @item -mcall-sysv
21714 @opindex mcall-sysv
21715 On System V.4 and embedded PowerPC systems compile code using calling
21716 conventions that adhere to the March 1995 draft of the System V
21717 Application Binary Interface, PowerPC processor supplement.  This is the
21718 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
21720 @item -mcall-sysv-eabi
21721 @itemx -mcall-eabi
21722 @opindex mcall-sysv-eabi
21723 @opindex mcall-eabi
21724 Specify both @option{-mcall-sysv} and @option{-meabi} options.
21726 @item -mcall-sysv-noeabi
21727 @opindex mcall-sysv-noeabi
21728 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
21730 @item -mcall-aixdesc
21731 @opindex m
21732 On System V.4 and embedded PowerPC systems compile code for the AIX
21733 operating system.
21735 @item -mcall-linux
21736 @opindex mcall-linux
21737 On System V.4 and embedded PowerPC systems compile code for the
21738 Linux-based GNU system.
21740 @item -mcall-freebsd
21741 @opindex mcall-freebsd
21742 On System V.4 and embedded PowerPC systems compile code for the
21743 FreeBSD operating system.
21745 @item -mcall-netbsd
21746 @opindex mcall-netbsd
21747 On System V.4 and embedded PowerPC systems compile code for the
21748 NetBSD operating system.
21750 @item -mcall-openbsd
21751 @opindex mcall-netbsd
21752 On System V.4 and embedded PowerPC systems compile code for the
21753 OpenBSD operating system.
21755 @item -maix-struct-return
21756 @opindex maix-struct-return
21757 Return all structures in memory (as specified by the AIX ABI)@.
21759 @item -msvr4-struct-return
21760 @opindex msvr4-struct-return
21761 Return structures smaller than 8 bytes in registers (as specified by the
21762 SVR4 ABI)@.
21764 @item -mabi=@var{abi-type}
21765 @opindex mabi
21766 Extend the current ABI with a particular extension, or remove such extension.
21767 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
21768 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
21769 @samp{elfv1}, @samp{elfv2}@.
21771 @item -mabi=spe
21772 @opindex mabi=spe
21773 Extend the current ABI with SPE ABI extensions.  This does not change
21774 the default ABI, instead it adds the SPE ABI extensions to the current
21775 ABI@.
21777 @item -mabi=no-spe
21778 @opindex mabi=no-spe
21779 Disable Book-E SPE ABI extensions for the current ABI@.
21781 @item -mabi=ibmlongdouble
21782 @opindex mabi=ibmlongdouble
21783 Change the current ABI to use IBM extended-precision long double.
21784 This is a PowerPC 32-bit SYSV ABI option.
21786 @item -mabi=ieeelongdouble
21787 @opindex mabi=ieeelongdouble
21788 Change the current ABI to use IEEE extended-precision long double.
21789 This is a PowerPC 32-bit Linux ABI option.
21791 @item -mabi=elfv1
21792 @opindex mabi=elfv1
21793 Change the current ABI to use the ELFv1 ABI.
21794 This is the default ABI for big-endian PowerPC 64-bit Linux.
21795 Overriding the default ABI requires special system support and is
21796 likely to fail in spectacular ways.
21798 @item -mabi=elfv2
21799 @opindex mabi=elfv2
21800 Change the current ABI to use the ELFv2 ABI.
21801 This is the default ABI for little-endian PowerPC 64-bit Linux.
21802 Overriding the default ABI requires special system support and is
21803 likely to fail in spectacular ways.
21805 @item -mgnu-attribute
21806 @itemx -mno-gnu-attribute
21807 @opindex mgnu-attribute
21808 @opindex mno-gnu-attribute
21809 Emit .gnu_attribute assembly directives to set tag/value pairs in a
21810 .gnu.attributes section that specify ABI variations in function
21811 parameters or return values.
21813 @item -mprototype
21814 @itemx -mno-prototype
21815 @opindex mprototype
21816 @opindex mno-prototype
21817 On System V.4 and embedded PowerPC systems assume that all calls to
21818 variable argument functions are properly prototyped.  Otherwise, the
21819 compiler must insert an instruction before every non-prototyped call to
21820 set or clear bit 6 of the condition code register (@code{CR}) to
21821 indicate whether floating-point values are passed in the floating-point
21822 registers in case the function takes variable arguments.  With
21823 @option{-mprototype}, only calls to prototyped variable argument functions
21824 set or clear the bit.
21826 @item -msim
21827 @opindex msim
21828 On embedded PowerPC systems, assume that the startup module is called
21829 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
21830 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
21831 configurations.
21833 @item -mmvme
21834 @opindex mmvme
21835 On embedded PowerPC systems, assume that the startup module is called
21836 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
21837 @file{libc.a}.
21839 @item -mads
21840 @opindex mads
21841 On embedded PowerPC systems, assume that the startup module is called
21842 @file{crt0.o} and the standard C libraries are @file{libads.a} and
21843 @file{libc.a}.
21845 @item -myellowknife
21846 @opindex myellowknife
21847 On embedded PowerPC systems, assume that the startup module is called
21848 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
21849 @file{libc.a}.
21851 @item -mvxworks
21852 @opindex mvxworks
21853 On System V.4 and embedded PowerPC systems, specify that you are
21854 compiling for a VxWorks system.
21856 @item -memb
21857 @opindex memb
21858 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
21859 header to indicate that @samp{eabi} extended relocations are used.
21861 @item -meabi
21862 @itemx -mno-eabi
21863 @opindex meabi
21864 @opindex mno-eabi
21865 On System V.4 and embedded PowerPC systems do (do not) adhere to the
21866 Embedded Applications Binary Interface (EABI), which is a set of
21867 modifications to the System V.4 specifications.  Selecting @option{-meabi}
21868 means that the stack is aligned to an 8-byte boundary, a function
21869 @code{__eabi} is called from @code{main} to set up the EABI
21870 environment, and the @option{-msdata} option can use both @code{r2} and
21871 @code{r13} to point to two separate small data areas.  Selecting
21872 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
21873 no EABI initialization function is called from @code{main}, and the
21874 @option{-msdata} option only uses @code{r13} to point to a single
21875 small data area.  The @option{-meabi} option is on by default if you
21876 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
21878 @item -msdata=eabi
21879 @opindex msdata=eabi
21880 On System V.4 and embedded PowerPC systems, put small initialized
21881 @code{const} global and static data in the @code{.sdata2} section, which
21882 is pointed to by register @code{r2}.  Put small initialized
21883 non-@code{const} global and static data in the @code{.sdata} section,
21884 which is pointed to by register @code{r13}.  Put small uninitialized
21885 global and static data in the @code{.sbss} section, which is adjacent to
21886 the @code{.sdata} section.  The @option{-msdata=eabi} option is
21887 incompatible with the @option{-mrelocatable} option.  The
21888 @option{-msdata=eabi} option also sets the @option{-memb} option.
21890 @item -msdata=sysv
21891 @opindex msdata=sysv
21892 On System V.4 and embedded PowerPC systems, put small global and static
21893 data in the @code{.sdata} section, which is pointed to by register
21894 @code{r13}.  Put small uninitialized global and static data in the
21895 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
21896 The @option{-msdata=sysv} option is incompatible with the
21897 @option{-mrelocatable} option.
21899 @item -msdata=default
21900 @itemx -msdata
21901 @opindex msdata=default
21902 @opindex msdata
21903 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
21904 compile code the same as @option{-msdata=eabi}, otherwise compile code the
21905 same as @option{-msdata=sysv}.
21907 @item -msdata=data
21908 @opindex msdata=data
21909 On System V.4 and embedded PowerPC systems, put small global
21910 data in the @code{.sdata} section.  Put small uninitialized global
21911 data in the @code{.sbss} section.  Do not use register @code{r13}
21912 to address small data however.  This is the default behavior unless
21913 other @option{-msdata} options are used.
21915 @item -msdata=none
21916 @itemx -mno-sdata
21917 @opindex msdata=none
21918 @opindex mno-sdata
21919 On embedded PowerPC systems, put all initialized global and static data
21920 in the @code{.data} section, and all uninitialized data in the
21921 @code{.bss} section.
21923 @item -mblock-move-inline-limit=@var{num}
21924 @opindex mblock-move-inline-limit
21925 Inline all block moves (such as calls to @code{memcpy} or structure
21926 copies) less than or equal to @var{num} bytes.  The minimum value for
21927 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
21928 targets.  The default value is target-specific.
21930 @item -G @var{num}
21931 @opindex G
21932 @cindex smaller data references (PowerPC)
21933 @cindex .sdata/.sdata2 references (PowerPC)
21934 On embedded PowerPC systems, put global and static items less than or
21935 equal to @var{num} bytes into the small data or BSS sections instead of
21936 the normal data or BSS section.  By default, @var{num} is 8.  The
21937 @option{-G @var{num}} switch is also passed to the linker.
21938 All modules should be compiled with the same @option{-G @var{num}} value.
21940 @item -mregnames
21941 @itemx -mno-regnames
21942 @opindex mregnames
21943 @opindex mno-regnames
21944 On System V.4 and embedded PowerPC systems do (do not) emit register
21945 names in the assembly language output using symbolic forms.
21947 @item -mlongcall
21948 @itemx -mno-longcall
21949 @opindex mlongcall
21950 @opindex mno-longcall
21951 By default assume that all calls are far away so that a longer and more
21952 expensive calling sequence is required.  This is required for calls
21953 farther than 32 megabytes (33,554,432 bytes) from the current location.
21954 A short call is generated if the compiler knows
21955 the call cannot be that far away.  This setting can be overridden by
21956 the @code{shortcall} function attribute, or by @code{#pragma
21957 longcall(0)}.
21959 Some linkers are capable of detecting out-of-range calls and generating
21960 glue code on the fly.  On these systems, long calls are unnecessary and
21961 generate slower code.  As of this writing, the AIX linker can do this,
21962 as can the GNU linker for PowerPC/64.  It is planned to add this feature
21963 to the GNU linker for 32-bit PowerPC systems as well.
21965 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
21966 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
21967 addresses represent the callee and the branch island.  The
21968 Darwin/PPC linker prefers the first address and generates a @code{bl
21969 callee} if the PPC @code{bl} instruction reaches the callee directly;
21970 otherwise, the linker generates @code{bl L42} to call the branch
21971 island.  The branch island is appended to the body of the
21972 calling function; it computes the full 32-bit address of the callee
21973 and jumps to it.
21975 On Mach-O (Darwin) systems, this option directs the compiler emit to
21976 the glue for every direct call, and the Darwin linker decides whether
21977 to use or discard it.
21979 In the future, GCC may ignore all longcall specifications
21980 when the linker is known to generate glue.
21982 @item -mtls-markers
21983 @itemx -mno-tls-markers
21984 @opindex mtls-markers
21985 @opindex mno-tls-markers
21986 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
21987 specifying the function argument.  The relocation allows the linker to
21988 reliably associate function call with argument setup instructions for
21989 TLS optimization, which in turn allows GCC to better schedule the
21990 sequence.
21992 @item -pthread
21993 @opindex pthread
21994 Adds support for multithreading with the @dfn{pthreads} library.
21995 This option sets flags for both the preprocessor and linker.
21997 @item -mrecip
21998 @itemx -mno-recip
21999 @opindex mrecip
22000 This option enables use of the reciprocal estimate and
22001 reciprocal square root estimate instructions with additional
22002 Newton-Raphson steps to increase precision instead of doing a divide or
22003 square root and divide for floating-point arguments.  You should use
22004 the @option{-ffast-math} option when using @option{-mrecip} (or at
22005 least @option{-funsafe-math-optimizations},
22006 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22007 @option{-fno-trapping-math}).  Note that while the throughput of the
22008 sequence is generally higher than the throughput of the non-reciprocal
22009 instruction, the precision of the sequence can be decreased by up to 2
22010 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22011 roots.
22013 @item -mrecip=@var{opt}
22014 @opindex mrecip=opt
22015 This option controls which reciprocal estimate instructions
22016 may be used.  @var{opt} is a comma-separated list of options, which may
22017 be preceded by a @code{!} to invert the option:
22019 @table @samp
22021 @item all
22022 Enable all estimate instructions.
22024 @item default 
22025 Enable the default instructions, equivalent to @option{-mrecip}.
22027 @item none 
22028 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22030 @item div 
22031 Enable the reciprocal approximation instructions for both 
22032 single and double precision.
22034 @item divf 
22035 Enable the single-precision reciprocal approximation instructions.
22037 @item divd 
22038 Enable the double-precision reciprocal approximation instructions.
22040 @item rsqrt 
22041 Enable the reciprocal square root approximation instructions for both
22042 single and double precision.
22044 @item rsqrtf 
22045 Enable the single-precision reciprocal square root approximation instructions.
22047 @item rsqrtd 
22048 Enable the double-precision reciprocal square root approximation instructions.
22050 @end table
22052 So, for example, @option{-mrecip=all,!rsqrtd} enables
22053 all of the reciprocal estimate instructions, except for the
22054 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22055 which handle the double-precision reciprocal square root calculations.
22057 @item -mrecip-precision
22058 @itemx -mno-recip-precision
22059 @opindex mrecip-precision
22060 Assume (do not assume) that the reciprocal estimate instructions
22061 provide higher-precision estimates than is mandated by the PowerPC
22062 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22063 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22064 The double-precision square root estimate instructions are not generated by
22065 default on low-precision machines, since they do not provide an
22066 estimate that converges after three steps.
22068 @item -mveclibabi=@var{type}
22069 @opindex mveclibabi
22070 Specifies the ABI type to use for vectorizing intrinsics using an
22071 external library.  The only type supported at present is @samp{mass},
22072 which specifies to use IBM's Mathematical Acceleration Subsystem
22073 (MASS) libraries for vectorizing intrinsics using external libraries.
22074 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22075 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22076 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22077 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22078 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22079 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22080 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22081 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22082 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22083 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22084 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22085 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22086 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22087 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22088 for power7.  Both @option{-ftree-vectorize} and
22089 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22090 libraries must be specified at link time.
22092 @item -mfriz
22093 @itemx -mno-friz
22094 @opindex mfriz
22095 Generate (do not generate) the @code{friz} instruction when the
22096 @option{-funsafe-math-optimizations} option is used to optimize
22097 rounding of floating-point values to 64-bit integer and back to floating
22098 point.  The @code{friz} instruction does not return the same value if
22099 the floating-point number is too large to fit in an integer.
22101 @item -mpointers-to-nested-functions
22102 @itemx -mno-pointers-to-nested-functions
22103 @opindex mpointers-to-nested-functions
22104 Generate (do not generate) code to load up the static chain register
22105 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22106 systems where a function pointer points to a 3-word descriptor giving
22107 the function address, TOC value to be loaded in register @code{r2}, and
22108 static chain value to be loaded in register @code{r11}.  The
22109 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22110 call through pointers to nested functions or pointers
22111 to functions compiled in other languages that use the static chain if
22112 you use @option{-mno-pointers-to-nested-functions}.
22114 @item -msave-toc-indirect
22115 @itemx -mno-save-toc-indirect
22116 @opindex msave-toc-indirect
22117 Generate (do not generate) code to save the TOC value in the reserved
22118 stack location in the function prologue if the function calls through
22119 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22120 saved in the prologue, it is saved just before the call through the
22121 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22123 @item -mcompat-align-parm
22124 @itemx -mno-compat-align-parm
22125 @opindex mcompat-align-parm
22126 Generate (do not generate) code to pass structure parameters with a
22127 maximum alignment of 64 bits, for compatibility with older versions
22128 of GCC.
22130 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22131 structure parameter on a 128-bit boundary when that structure contained
22132 a member requiring 128-bit alignment.  This is corrected in more
22133 recent versions of GCC.  This option may be used to generate code
22134 that is compatible with functions compiled with older versions of
22135 GCC.
22137 The @option{-mno-compat-align-parm} option is the default.
22138 @end table
22140 @node RX Options
22141 @subsection RX Options
22142 @cindex RX Options
22144 These command-line options are defined for RX targets:
22146 @table @gcctabopt
22147 @item -m64bit-doubles
22148 @itemx -m32bit-doubles
22149 @opindex m64bit-doubles
22150 @opindex m32bit-doubles
22151 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22152 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22153 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22154 works on 32-bit values, which is why the default is
22155 @option{-m32bit-doubles}.
22157 @item -fpu
22158 @itemx -nofpu
22159 @opindex fpu
22160 @opindex nofpu
22161 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22162 floating-point hardware.  The default is enabled for the RX600
22163 series and disabled for the RX200 series.
22165 Floating-point instructions are only generated for 32-bit floating-point 
22166 values, however, so the FPU hardware is not used for doubles if the
22167 @option{-m64bit-doubles} option is used.
22169 @emph{Note} If the @option{-fpu} option is enabled then
22170 @option{-funsafe-math-optimizations} is also enabled automatically.
22171 This is because the RX FPU instructions are themselves unsafe.
22173 @item -mcpu=@var{name}
22174 @opindex mcpu
22175 Selects the type of RX CPU to be targeted.  Currently three types are
22176 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22177 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22179 The only difference between @samp{RX600} and @samp{RX610} is that the
22180 @samp{RX610} does not support the @code{MVTIPL} instruction.
22182 The @samp{RX200} series does not have a hardware floating-point unit
22183 and so @option{-nofpu} is enabled by default when this type is
22184 selected.
22186 @item -mbig-endian-data
22187 @itemx -mlittle-endian-data
22188 @opindex mbig-endian-data
22189 @opindex mlittle-endian-data
22190 Store data (but not code) in the big-endian format.  The default is
22191 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22192 format.
22194 @item -msmall-data-limit=@var{N}
22195 @opindex msmall-data-limit
22196 Specifies the maximum size in bytes of global and static variables
22197 which can be placed into the small data area.  Using the small data
22198 area can lead to smaller and faster code, but the size of area is
22199 limited and it is up to the programmer to ensure that the area does
22200 not overflow.  Also when the small data area is used one of the RX's
22201 registers (usually @code{r13}) is reserved for use pointing to this
22202 area, so it is no longer available for use by the compiler.  This
22203 could result in slower and/or larger code if variables are pushed onto
22204 the stack instead of being held in this register.
22206 Note, common variables (variables that have not been initialized) and
22207 constants are not placed into the small data area as they are assigned
22208 to other sections in the output executable.
22210 The default value is zero, which disables this feature.  Note, this
22211 feature is not enabled by default with higher optimization levels
22212 (@option{-O2} etc) because of the potentially detrimental effects of
22213 reserving a register.  It is up to the programmer to experiment and
22214 discover whether this feature is of benefit to their program.  See the
22215 description of the @option{-mpid} option for a description of how the
22216 actual register to hold the small data area pointer is chosen.
22218 @item -msim
22219 @itemx -mno-sim
22220 @opindex msim
22221 @opindex mno-sim
22222 Use the simulator runtime.  The default is to use the libgloss
22223 board-specific runtime.
22225 @item -mas100-syntax
22226 @itemx -mno-as100-syntax
22227 @opindex mas100-syntax
22228 @opindex mno-as100-syntax
22229 When generating assembler output use a syntax that is compatible with
22230 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22231 assembler, but it has some restrictions so it is not generated by default.
22233 @item -mmax-constant-size=@var{N}
22234 @opindex mmax-constant-size
22235 Specifies the maximum size, in bytes, of a constant that can be used as
22236 an operand in a RX instruction.  Although the RX instruction set does
22237 allow constants of up to 4 bytes in length to be used in instructions,
22238 a longer value equates to a longer instruction.  Thus in some
22239 circumstances it can be beneficial to restrict the size of constants
22240 that are used in instructions.  Constants that are too big are instead
22241 placed into a constant pool and referenced via register indirection.
22243 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22244 or 4 means that constants of any size are allowed.
22246 @item -mrelax
22247 @opindex mrelax
22248 Enable linker relaxation.  Linker relaxation is a process whereby the
22249 linker attempts to reduce the size of a program by finding shorter
22250 versions of various instructions.  Disabled by default.
22252 @item -mint-register=@var{N}
22253 @opindex mint-register
22254 Specify the number of registers to reserve for fast interrupt handler
22255 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22256 means that register @code{r13} is reserved for the exclusive use
22257 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22258 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22259 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22260 A value of 0, the default, does not reserve any registers.
22262 @item -msave-acc-in-interrupts
22263 @opindex msave-acc-in-interrupts
22264 Specifies that interrupt handler functions should preserve the
22265 accumulator register.  This is only necessary if normal code might use
22266 the accumulator register, for example because it performs 64-bit
22267 multiplications.  The default is to ignore the accumulator as this
22268 makes the interrupt handlers faster.
22270 @item -mpid
22271 @itemx -mno-pid
22272 @opindex mpid
22273 @opindex mno-pid
22274 Enables the generation of position independent data.  When enabled any
22275 access to constant data is done via an offset from a base address
22276 held in a register.  This allows the location of constant data to be
22277 determined at run time without requiring the executable to be
22278 relocated, which is a benefit to embedded applications with tight
22279 memory constraints.  Data that can be modified is not affected by this
22280 option.
22282 Note, using this feature reserves a register, usually @code{r13}, for
22283 the constant data base address.  This can result in slower and/or
22284 larger code, especially in complicated functions.
22286 The actual register chosen to hold the constant data base address
22287 depends upon whether the @option{-msmall-data-limit} and/or the
22288 @option{-mint-register} command-line options are enabled.  Starting
22289 with register @code{r13} and proceeding downwards, registers are
22290 allocated first to satisfy the requirements of @option{-mint-register},
22291 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22292 is possible for the small data area register to be @code{r8} if both
22293 @option{-mint-register=4} and @option{-mpid} are specified on the
22294 command line.
22296 By default this feature is not enabled.  The default can be restored
22297 via the @option{-mno-pid} command-line option.
22299 @item -mno-warn-multiple-fast-interrupts
22300 @itemx -mwarn-multiple-fast-interrupts
22301 @opindex mno-warn-multiple-fast-interrupts
22302 @opindex mwarn-multiple-fast-interrupts
22303 Prevents GCC from issuing a warning message if it finds more than one
22304 fast interrupt handler when it is compiling a file.  The default is to
22305 issue a warning for each extra fast interrupt handler found, as the RX
22306 only supports one such interrupt.
22308 @item -mallow-string-insns
22309 @itemx -mno-allow-string-insns
22310 @opindex mallow-string-insns
22311 @opindex mno-allow-string-insns
22312 Enables or disables the use of the string manipulation instructions
22313 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22314 @code{SWHILE} and also the @code{RMPA} instruction.  These
22315 instructions may prefetch data, which is not safe to do if accessing
22316 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22317 for more information).
22319 The default is to allow these instructions, but it is not possible for
22320 GCC to reliably detect all circumstances where a string instruction
22321 might be used to access an I/O register, so their use cannot be
22322 disabled automatically.  Instead it is reliant upon the programmer to
22323 use the @option{-mno-allow-string-insns} option if their program
22324 accesses I/O space.
22326 When the instructions are enabled GCC defines the C preprocessor
22327 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22328 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22330 @item -mjsr
22331 @itemx -mno-jsr
22332 @opindex mjsr
22333 @opindex mno-jsr
22334 Use only (or not only) @code{JSR} instructions to access functions.
22335 This option can be used when code size exceeds the range of @code{BSR}
22336 instructions.  Note that @option{-mno-jsr} does not mean to not use
22337 @code{JSR} but instead means that any type of branch may be used.
22338 @end table
22340 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22341 has special significance to the RX port when used with the
22342 @code{interrupt} function attribute.  This attribute indicates a
22343 function intended to process fast interrupts.  GCC ensures
22344 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22345 and/or @code{r13} and only provided that the normal use of the
22346 corresponding registers have been restricted via the
22347 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22348 options.
22350 @node S/390 and zSeries Options
22351 @subsection S/390 and zSeries Options
22352 @cindex S/390 and zSeries Options
22354 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22356 @table @gcctabopt
22357 @item -mhard-float
22358 @itemx -msoft-float
22359 @opindex mhard-float
22360 @opindex msoft-float
22361 Use (do not use) the hardware floating-point instructions and registers
22362 for floating-point operations.  When @option{-msoft-float} is specified,
22363 functions in @file{libgcc.a} are used to perform floating-point
22364 operations.  When @option{-mhard-float} is specified, the compiler
22365 generates IEEE floating-point instructions.  This is the default.
22367 @item -mhard-dfp
22368 @itemx -mno-hard-dfp
22369 @opindex mhard-dfp
22370 @opindex mno-hard-dfp
22371 Use (do not use) the hardware decimal-floating-point instructions for
22372 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22373 specified, functions in @file{libgcc.a} are used to perform
22374 decimal-floating-point operations.  When @option{-mhard-dfp} is
22375 specified, the compiler generates decimal-floating-point hardware
22376 instructions.  This is the default for @option{-march=z9-ec} or higher.
22378 @item -mlong-double-64
22379 @itemx -mlong-double-128
22380 @opindex mlong-double-64
22381 @opindex mlong-double-128
22382 These switches control the size of @code{long double} type. A size
22383 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22384 type. This is the default.
22386 @item -mbackchain
22387 @itemx -mno-backchain
22388 @opindex mbackchain
22389 @opindex mno-backchain
22390 Store (do not store) the address of the caller's frame as backchain pointer
22391 into the callee's stack frame.
22392 A backchain may be needed to allow debugging using tools that do not understand
22393 DWARF call frame information.
22394 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22395 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22396 the backchain is placed into the topmost word of the 96/160 byte register
22397 save area.
22399 In general, code compiled with @option{-mbackchain} is call-compatible with
22400 code compiled with @option{-mmo-backchain}; however, use of the backchain
22401 for debugging purposes usually requires that the whole binary is built with
22402 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22403 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22404 to build a linux kernel use @option{-msoft-float}.
22406 The default is to not maintain the backchain.
22408 @item -mpacked-stack
22409 @itemx -mno-packed-stack
22410 @opindex mpacked-stack
22411 @opindex mno-packed-stack
22412 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22413 specified, the compiler uses the all fields of the 96/160 byte register save
22414 area only for their default purpose; unused fields still take up stack space.
22415 When @option{-mpacked-stack} is specified, register save slots are densely
22416 packed at the top of the register save area; unused space is reused for other
22417 purposes, allowing for more efficient use of the available stack space.
22418 However, when @option{-mbackchain} is also in effect, the topmost word of
22419 the save area is always used to store the backchain, and the return address
22420 register is always saved two words below the backchain.
22422 As long as the stack frame backchain is not used, code generated with
22423 @option{-mpacked-stack} is call-compatible with code generated with
22424 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22425 S/390 or zSeries generated code that uses the stack frame backchain at run
22426 time, not just for debugging purposes.  Such code is not call-compatible
22427 with code compiled with @option{-mpacked-stack}.  Also, note that the
22428 combination of @option{-mbackchain},
22429 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22430 to build a linux kernel use @option{-msoft-float}.
22432 The default is to not use the packed stack layout.
22434 @item -msmall-exec
22435 @itemx -mno-small-exec
22436 @opindex msmall-exec
22437 @opindex mno-small-exec
22438 Generate (or do not generate) code using the @code{bras} instruction
22439 to do subroutine calls.
22440 This only works reliably if the total executable size does not
22441 exceed 64k.  The default is to use the @code{basr} instruction instead,
22442 which does not have this limitation.
22444 @item -m64
22445 @itemx -m31
22446 @opindex m64
22447 @opindex m31
22448 When @option{-m31} is specified, generate code compliant to the
22449 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
22450 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
22451 particular to generate 64-bit instructions.  For the @samp{s390}
22452 targets, the default is @option{-m31}, while the @samp{s390x}
22453 targets default to @option{-m64}.
22455 @item -mzarch
22456 @itemx -mesa
22457 @opindex mzarch
22458 @opindex mesa
22459 When @option{-mzarch} is specified, generate code using the
22460 instructions available on z/Architecture.
22461 When @option{-mesa} is specified, generate code using the
22462 instructions available on ESA/390.  Note that @option{-mesa} is
22463 not possible with @option{-m64}.
22464 When generating code compliant to the GNU/Linux for S/390 ABI,
22465 the default is @option{-mesa}.  When generating code compliant
22466 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
22468 @item -mhtm
22469 @itemx -mno-htm
22470 @opindex mhtm
22471 @opindex mno-htm
22472 The @option{-mhtm} option enables a set of builtins making use of
22473 instructions available with the transactional execution facility
22474 introduced with the IBM zEnterprise EC12 machine generation
22475 @ref{S/390 System z Built-in Functions}.
22476 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
22478 @item -mvx
22479 @itemx -mno-vx
22480 @opindex mvx
22481 @opindex mno-vx
22482 When @option{-mvx} is specified, generate code using the instructions
22483 available with the vector extension facility introduced with the IBM
22484 z13 machine generation.
22485 This option changes the ABI for some vector type values with regard to
22486 alignment and calling conventions.  In case vector type values are
22487 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
22488 command will be added to mark the resulting binary with the ABI used.
22489 @option{-mvx} is enabled by default when using @option{-march=z13}.
22491 @item -mzvector
22492 @itemx -mno-zvector
22493 @opindex mzvector
22494 @opindex mno-zvector
22495 The @option{-mzvector} option enables vector language extensions and
22496 builtins using instructions available with the vector extension
22497 facility introduced with the IBM z13 machine generation.
22498 This option adds support for @samp{vector} to be used as a keyword to
22499 define vector type variables and arguments.  @samp{vector} is only
22500 available when GNU extensions are enabled.  It will not be expanded
22501 when requesting strict standard compliance e.g. with @option{-std=c99}.
22502 In addition to the GCC low-level builtins @option{-mzvector} enables
22503 a set of builtins added for compatibility with AltiVec-style
22504 implementations like Power and Cell.  In order to make use of these
22505 builtins the header file @file{vecintrin.h} needs to be included.
22506 @option{-mzvector} is disabled by default.
22508 @item -mmvcle
22509 @itemx -mno-mvcle
22510 @opindex mmvcle
22511 @opindex mno-mvcle
22512 Generate (or do not generate) code using the @code{mvcle} instruction
22513 to perform block moves.  When @option{-mno-mvcle} is specified,
22514 use a @code{mvc} loop instead.  This is the default unless optimizing for
22515 size.
22517 @item -mdebug
22518 @itemx -mno-debug
22519 @opindex mdebug
22520 @opindex mno-debug
22521 Print (or do not print) additional debug information when compiling.
22522 The default is to not print debug information.
22524 @item -march=@var{cpu-type}
22525 @opindex march
22526 Generate code that runs on @var{cpu-type}, which is the name of a
22527 system representing a certain processor type.  Possible values for
22528 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
22529 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
22530 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
22531 @samp{native}.
22533 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
22534 @samp{g6} are deprecated and will be removed with future releases.
22536 Specifying @samp{native} as cpu type can be used to select the best
22537 architecture option for the host processor.
22538 @option{-march=native} has no effect if GCC does not recognize the
22539 processor.
22541 @item -mtune=@var{cpu-type}
22542 @opindex mtune
22543 Tune to @var{cpu-type} everything applicable about the generated code,
22544 except for the ABI and the set of available instructions.
22545 The list of @var{cpu-type} values is the same as for @option{-march}.
22546 The default is the value used for @option{-march}.
22548 @item -mtpf-trace
22549 @itemx -mno-tpf-trace
22550 @opindex mtpf-trace
22551 @opindex mno-tpf-trace
22552 Generate code that adds (does not add) in TPF OS specific branches to trace
22553 routines in the operating system.  This option is off by default, even
22554 when compiling for the TPF OS@.
22556 @item -mfused-madd
22557 @itemx -mno-fused-madd
22558 @opindex mfused-madd
22559 @opindex mno-fused-madd
22560 Generate code that uses (does not use) the floating-point multiply and
22561 accumulate instructions.  These instructions are generated by default if
22562 hardware floating point is used.
22564 @item -mwarn-framesize=@var{framesize}
22565 @opindex mwarn-framesize
22566 Emit a warning if the current function exceeds the given frame size.  Because
22567 this is a compile-time check it doesn't need to be a real problem when the program
22568 runs.  It is intended to identify functions that most probably cause
22569 a stack overflow.  It is useful to be used in an environment with limited stack
22570 size e.g.@: the linux kernel.
22572 @item -mwarn-dynamicstack
22573 @opindex mwarn-dynamicstack
22574 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
22575 arrays.  This is generally a bad idea with a limited stack size.
22577 @item -mstack-guard=@var{stack-guard}
22578 @itemx -mstack-size=@var{stack-size}
22579 @opindex mstack-guard
22580 @opindex mstack-size
22581 If these options are provided the S/390 back end emits additional instructions in
22582 the function prologue that trigger a trap if the stack size is @var{stack-guard}
22583 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
22584 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
22585 the frame size of the compiled function is chosen.
22586 These options are intended to be used to help debugging stack overflow problems.
22587 The additionally emitted code causes only little overhead and hence can also be
22588 used in production-like systems without greater performance degradation.  The given
22589 values have to be exact powers of 2 and @var{stack-size} has to be greater than
22590 @var{stack-guard} without exceeding 64k.
22591 In order to be efficient the extra code makes the assumption that the stack starts
22592 at an address aligned to the value given by @var{stack-size}.
22593 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
22595 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
22596 @opindex mhotpatch
22597 If the hotpatch option is enabled, a ``hot-patching'' function
22598 prologue is generated for all functions in the compilation unit.
22599 The funtion label is prepended with the given number of two-byte
22600 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
22601 the label, 2 * @var{post-halfwords} bytes are appended, using the
22602 largest NOP like instructions the architecture allows (maximum
22603 1000000).
22605 If both arguments are zero, hotpatching is disabled.
22607 This option can be overridden for individual functions with the
22608 @code{hotpatch} attribute.
22609 @end table
22611 @node Score Options
22612 @subsection Score Options
22613 @cindex Score Options
22615 These options are defined for Score implementations:
22617 @table @gcctabopt
22618 @item -meb
22619 @opindex meb
22620 Compile code for big-endian mode.  This is the default.
22622 @item -mel
22623 @opindex mel
22624 Compile code for little-endian mode.
22626 @item -mnhwloop
22627 @opindex mnhwloop
22628 Disable generation of @code{bcnz} instructions.
22630 @item -muls
22631 @opindex muls
22632 Enable generation of unaligned load and store instructions.
22634 @item -mmac
22635 @opindex mmac
22636 Enable the use of multiply-accumulate instructions. Disabled by default.
22638 @item -mscore5
22639 @opindex mscore5
22640 Specify the SCORE5 as the target architecture.
22642 @item -mscore5u
22643 @opindex mscore5u
22644 Specify the SCORE5U of the target architecture.
22646 @item -mscore7
22647 @opindex mscore7
22648 Specify the SCORE7 as the target architecture. This is the default.
22650 @item -mscore7d
22651 @opindex mscore7d
22652 Specify the SCORE7D as the target architecture.
22653 @end table
22655 @node SH Options
22656 @subsection SH Options
22658 These @samp{-m} options are defined for the SH implementations:
22660 @table @gcctabopt
22661 @item -m1
22662 @opindex m1
22663 Generate code for the SH1.
22665 @item -m2
22666 @opindex m2
22667 Generate code for the SH2.
22669 @item -m2e
22670 Generate code for the SH2e.
22672 @item -m2a-nofpu
22673 @opindex m2a-nofpu
22674 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
22675 that the floating-point unit is not used.
22677 @item -m2a-single-only
22678 @opindex m2a-single-only
22679 Generate code for the SH2a-FPU, in such a way that no double-precision
22680 floating-point operations are used.
22682 @item -m2a-single
22683 @opindex m2a-single
22684 Generate code for the SH2a-FPU assuming the floating-point unit is in
22685 single-precision mode by default.
22687 @item -m2a
22688 @opindex m2a
22689 Generate code for the SH2a-FPU assuming the floating-point unit is in
22690 double-precision mode by default.
22692 @item -m3
22693 @opindex m3
22694 Generate code for the SH3.
22696 @item -m3e
22697 @opindex m3e
22698 Generate code for the SH3e.
22700 @item -m4-nofpu
22701 @opindex m4-nofpu
22702 Generate code for the SH4 without a floating-point unit.
22704 @item -m4-single-only
22705 @opindex m4-single-only
22706 Generate code for the SH4 with a floating-point unit that only
22707 supports single-precision arithmetic.
22709 @item -m4-single
22710 @opindex m4-single
22711 Generate code for the SH4 assuming the floating-point unit is in
22712 single-precision mode by default.
22714 @item -m4
22715 @opindex m4
22716 Generate code for the SH4.
22718 @item -m4-100
22719 @opindex m4-100
22720 Generate code for SH4-100.
22722 @item -m4-100-nofpu
22723 @opindex m4-100-nofpu
22724 Generate code for SH4-100 in such a way that the
22725 floating-point unit is not used.
22727 @item -m4-100-single
22728 @opindex m4-100-single
22729 Generate code for SH4-100 assuming the floating-point unit is in
22730 single-precision mode by default.
22732 @item -m4-100-single-only
22733 @opindex m4-100-single-only
22734 Generate code for SH4-100 in such a way that no double-precision
22735 floating-point operations are used.
22737 @item -m4-200
22738 @opindex m4-200
22739 Generate code for SH4-200.
22741 @item -m4-200-nofpu
22742 @opindex m4-200-nofpu
22743 Generate code for SH4-200 without in such a way that the
22744 floating-point unit is not used.
22746 @item -m4-200-single
22747 @opindex m4-200-single
22748 Generate code for SH4-200 assuming the floating-point unit is in
22749 single-precision mode by default.
22751 @item -m4-200-single-only
22752 @opindex m4-200-single-only
22753 Generate code for SH4-200 in such a way that no double-precision
22754 floating-point operations are used.
22756 @item -m4-300
22757 @opindex m4-300
22758 Generate code for SH4-300.
22760 @item -m4-300-nofpu
22761 @opindex m4-300-nofpu
22762 Generate code for SH4-300 without in such a way that the
22763 floating-point unit is not used.
22765 @item -m4-300-single
22766 @opindex m4-300-single
22767 Generate code for SH4-300 in such a way that no double-precision
22768 floating-point operations are used.
22770 @item -m4-300-single-only
22771 @opindex m4-300-single-only
22772 Generate code for SH4-300 in such a way that no double-precision
22773 floating-point operations are used.
22775 @item -m4-340
22776 @opindex m4-340
22777 Generate code for SH4-340 (no MMU, no FPU).
22779 @item -m4-500
22780 @opindex m4-500
22781 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
22782 assembler.
22784 @item -m4a-nofpu
22785 @opindex m4a-nofpu
22786 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
22787 floating-point unit is not used.
22789 @item -m4a-single-only
22790 @opindex m4a-single-only
22791 Generate code for the SH4a, in such a way that no double-precision
22792 floating-point operations are used.
22794 @item -m4a-single
22795 @opindex m4a-single
22796 Generate code for the SH4a assuming the floating-point unit is in
22797 single-precision mode by default.
22799 @item -m4a
22800 @opindex m4a
22801 Generate code for the SH4a.
22803 @item -m4al
22804 @opindex m4al
22805 Same as @option{-m4a-nofpu}, except that it implicitly passes
22806 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
22807 instructions at the moment.
22809 @item -mb
22810 @opindex mb
22811 Compile code for the processor in big-endian mode.
22813 @item -ml
22814 @opindex ml
22815 Compile code for the processor in little-endian mode.
22817 @item -mdalign
22818 @opindex mdalign
22819 Align doubles at 64-bit boundaries.  Note that this changes the calling
22820 conventions, and thus some functions from the standard C library do
22821 not work unless you recompile it first with @option{-mdalign}.
22823 @item -mrelax
22824 @opindex mrelax
22825 Shorten some address references at link time, when possible; uses the
22826 linker option @option{-relax}.
22828 @item -mbigtable
22829 @opindex mbigtable
22830 Use 32-bit offsets in @code{switch} tables.  The default is to use
22831 16-bit offsets.
22833 @item -mbitops
22834 @opindex mbitops
22835 Enable the use of bit manipulation instructions on SH2A.
22837 @item -mfmovd
22838 @opindex mfmovd
22839 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
22840 alignment constraints.
22842 @item -mrenesas
22843 @opindex mrenesas
22844 Comply with the calling conventions defined by Renesas.
22846 @item -mno-renesas
22847 @opindex mno-renesas
22848 Comply with the calling conventions defined for GCC before the Renesas
22849 conventions were available.  This option is the default for all
22850 targets of the SH toolchain.
22852 @item -mnomacsave
22853 @opindex mnomacsave
22854 Mark the @code{MAC} register as call-clobbered, even if
22855 @option{-mrenesas} is given.
22857 @item -mieee
22858 @itemx -mno-ieee
22859 @opindex mieee
22860 @opindex mno-ieee
22861 Control the IEEE compliance of floating-point comparisons, which affects the
22862 handling of cases where the result of a comparison is unordered.  By default
22863 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
22864 enabled @option{-mno-ieee} is implicitly set, which results in faster
22865 floating-point greater-equal and less-equal comparisons.  The implicit settings
22866 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
22868 @item -minline-ic_invalidate
22869 @opindex minline-ic_invalidate
22870 Inline code to invalidate instruction cache entries after setting up
22871 nested function trampolines.
22872 This option has no effect if @option{-musermode} is in effect and the selected
22873 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
22874 instruction.
22875 If the selected code generation option does not allow the use of the @code{icbi}
22876 instruction, and @option{-musermode} is not in effect, the inlined code
22877 manipulates the instruction cache address array directly with an associative
22878 write.  This not only requires privileged mode at run time, but it also
22879 fails if the cache line had been mapped via the TLB and has become unmapped.
22881 @item -misize
22882 @opindex misize
22883 Dump instruction size and location in the assembly code.
22885 @item -mpadstruct
22886 @opindex mpadstruct
22887 This option is deprecated.  It pads structures to multiple of 4 bytes,
22888 which is incompatible with the SH ABI@.
22890 @item -matomic-model=@var{model}
22891 @opindex matomic-model=@var{model}
22892 Sets the model of atomic operations and additional parameters as a comma
22893 separated list.  For details on the atomic built-in functions see
22894 @ref{__atomic Builtins}.  The following models and parameters are supported:
22896 @table @samp
22898 @item none
22899 Disable compiler generated atomic sequences and emit library calls for atomic
22900 operations.  This is the default if the target is not @code{sh*-*-linux*}.
22902 @item soft-gusa
22903 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
22904 built-in functions.  The generated atomic sequences require additional support
22905 from the interrupt/exception handling code of the system and are only suitable
22906 for SH3* and SH4* single-core systems.  This option is enabled by default when
22907 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
22908 this option also partially utilizes the hardware atomic instructions
22909 @code{movli.l} and @code{movco.l} to create more efficient code, unless
22910 @samp{strict} is specified.  
22912 @item soft-tcb
22913 Generate software atomic sequences that use a variable in the thread control
22914 block.  This is a variation of the gUSA sequences which can also be used on
22915 SH1* and SH2* targets.  The generated atomic sequences require additional
22916 support from the interrupt/exception handling code of the system and are only
22917 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
22918 parameter has to be specified as well.
22920 @item soft-imask
22921 Generate software atomic sequences that temporarily disable interrupts by
22922 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
22923 in privileged mode and is only suitable for single-core systems.  Additional
22924 support from the interrupt/exception handling code of the system is not
22925 required.  This model is enabled by default when the target is
22926 @code{sh*-*-linux*} and SH1* or SH2*.
22928 @item hard-llcs
22929 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
22930 instructions only.  This is only available on SH4A and is suitable for
22931 multi-core systems.  Since the hardware instructions support only 32 bit atomic
22932 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
22933 Code compiled with this option is also compatible with other software
22934 atomic model interrupt/exception handling systems if executed on an SH4A
22935 system.  Additional support from the interrupt/exception handling code of the
22936 system is not required for this model.
22938 @item gbr-offset=
22939 This parameter specifies the offset in bytes of the variable in the thread
22940 control block structure that should be used by the generated atomic sequences
22941 when the @samp{soft-tcb} model has been selected.  For other models this
22942 parameter is ignored.  The specified value must be an integer multiple of four
22943 and in the range 0-1020.
22945 @item strict
22946 This parameter prevents mixed usage of multiple atomic models, even if they
22947 are compatible, and makes the compiler generate atomic sequences of the
22948 specified model only.
22950 @end table
22952 @item -mtas
22953 @opindex mtas
22954 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
22955 Notice that depending on the particular hardware and software configuration
22956 this can degrade overall performance due to the operand cache line flushes
22957 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
22958 processors the @code{tas.b} instruction must be used with caution since it
22959 can result in data corruption for certain cache configurations.
22961 @item -mprefergot
22962 @opindex mprefergot
22963 When generating position-independent code, emit function calls using
22964 the Global Offset Table instead of the Procedure Linkage Table.
22966 @item -musermode
22967 @itemx -mno-usermode
22968 @opindex musermode
22969 @opindex mno-usermode
22970 Don't allow (allow) the compiler generating privileged mode code.  Specifying
22971 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
22972 inlined code would not work in user mode.  @option{-musermode} is the default
22973 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
22974 @option{-musermode} has no effect, since there is no user mode.
22976 @item -multcost=@var{number}
22977 @opindex multcost=@var{number}
22978 Set the cost to assume for a multiply insn.
22980 @item -mdiv=@var{strategy}
22981 @opindex mdiv=@var{strategy}
22982 Set the division strategy to be used for integer division operations.
22983 @var{strategy} can be one of: 
22985 @table @samp
22987 @item call-div1
22988 Calls a library function that uses the single-step division instruction
22989 @code{div1} to perform the operation.  Division by zero calculates an
22990 unspecified result and does not trap.  This is the default except for SH4,
22991 SH2A and SHcompact.
22993 @item call-fp
22994 Calls a library function that performs the operation in double precision
22995 floating point.  Division by zero causes a floating-point exception.  This is
22996 the default for SHcompact with FPU.  Specifying this for targets that do not
22997 have a double precision FPU defaults to @code{call-div1}.
22999 @item call-table
23000 Calls a library function that uses a lookup table for small divisors and
23001 the @code{div1} instruction with case distinction for larger divisors.  Division
23002 by zero calculates an unspecified result and does not trap.  This is the default
23003 for SH4.  Specifying this for targets that do not have dynamic shift
23004 instructions defaults to @code{call-div1}.
23006 @end table
23008 When a division strategy has not been specified the default strategy is
23009 selected based on the current target.  For SH2A the default strategy is to
23010 use the @code{divs} and @code{divu} instructions instead of library function
23011 calls.
23013 @item -maccumulate-outgoing-args
23014 @opindex maccumulate-outgoing-args
23015 Reserve space once for outgoing arguments in the function prologue rather
23016 than around each call.  Generally beneficial for performance and size.  Also
23017 needed for unwinding to avoid changing the stack frame around conditional code.
23019 @item -mdivsi3_libfunc=@var{name}
23020 @opindex mdivsi3_libfunc=@var{name}
23021 Set the name of the library function used for 32-bit signed division to
23022 @var{name}.
23023 This only affects the name used in the @samp{call} division strategies, and
23024 the compiler still expects the same sets of input/output/clobbered registers as
23025 if this option were not present.
23027 @item -mfixed-range=@var{register-range}
23028 @opindex mfixed-range
23029 Generate code treating the given register range as fixed registers.
23030 A fixed register is one that the register allocator can not use.  This is
23031 useful when compiling kernel code.  A register range is specified as
23032 two registers separated by a dash.  Multiple register ranges can be
23033 specified separated by a comma.
23035 @item -mbranch-cost=@var{num}
23036 @opindex mbranch-cost=@var{num}
23037 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23038 make the compiler try to generate more branch-free code if possible.  
23039 If not specified the value is selected depending on the processor type that
23040 is being compiled for.
23042 @item -mzdcbranch
23043 @itemx -mno-zdcbranch
23044 @opindex mzdcbranch
23045 @opindex mno-zdcbranch
23046 Assume (do not assume) that zero displacement conditional branch instructions
23047 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23048 compiler prefers zero displacement branch code sequences.  This is
23049 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23050 disabled by specifying @option{-mno-zdcbranch}.
23052 @item -mcbranch-force-delay-slot
23053 @opindex mcbranch-force-delay-slot
23054 Force the usage of delay slots for conditional branches, which stuffs the delay
23055 slot with a @code{nop} if a suitable instruction can't be found.  By default
23056 this option is disabled.  It can be enabled to work around hardware bugs as
23057 found in the original SH7055.
23059 @item -mfused-madd
23060 @itemx -mno-fused-madd
23061 @opindex mfused-madd
23062 @opindex mno-fused-madd
23063 Generate code that uses (does not use) the floating-point multiply and
23064 accumulate instructions.  These instructions are generated by default
23065 if hardware floating point is used.  The machine-dependent
23066 @option{-mfused-madd} option is now mapped to the machine-independent
23067 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23068 mapped to @option{-ffp-contract=off}.
23070 @item -mfsca
23071 @itemx -mno-fsca
23072 @opindex mfsca
23073 @opindex mno-fsca
23074 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23075 and cosine approximations.  The option @option{-mfsca} must be used in
23076 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23077 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23078 approximations even if @option{-funsafe-math-optimizations} is in effect.
23080 @item -mfsrra
23081 @itemx -mno-fsrra
23082 @opindex mfsrra
23083 @opindex mno-fsrra
23084 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23085 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23086 in combination with @option{-funsafe-math-optimizations} and
23087 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23088 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23089 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23090 in effect.
23092 @item -mpretend-cmove
23093 @opindex mpretend-cmove
23094 Prefer zero-displacement conditional branches for conditional move instruction
23095 patterns.  This can result in faster code on the SH4 processor.
23097 @item -mfdpic
23098 @opindex fdpic
23099 Generate code using the FDPIC ABI.
23101 @end table
23103 @node Solaris 2 Options
23104 @subsection Solaris 2 Options
23105 @cindex Solaris 2 options
23107 These @samp{-m} options are supported on Solaris 2:
23109 @table @gcctabopt
23110 @item -mclear-hwcap
23111 @opindex mclear-hwcap
23112 @option{-mclear-hwcap} tells the compiler to remove the hardware
23113 capabilities generated by the Solaris assembler.  This is only necessary
23114 when object files use ISA extensions not supported by the current
23115 machine, but check at runtime whether or not to use them.
23117 @item -mimpure-text
23118 @opindex mimpure-text
23119 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23120 the compiler to not pass @option{-z text} to the linker when linking a
23121 shared object.  Using this option, you can link position-dependent
23122 code into a shared object.
23124 @option{-mimpure-text} suppresses the ``relocations remain against
23125 allocatable but non-writable sections'' linker error message.
23126 However, the necessary relocations trigger copy-on-write, and the
23127 shared object is not actually shared across processes.  Instead of
23128 using @option{-mimpure-text}, you should compile all source code with
23129 @option{-fpic} or @option{-fPIC}.
23131 @end table
23133 These switches are supported in addition to the above on Solaris 2:
23135 @table @gcctabopt
23136 @item -pthreads
23137 @opindex pthreads
23138 Add support for multithreading using the POSIX threads library.  This
23139 option sets flags for both the preprocessor and linker.  This option does
23140 not affect the thread safety of object code produced  by the compiler or
23141 that of libraries supplied with it.
23143 @item -pthread
23144 @opindex pthread
23145 This is a synonym for @option{-pthreads}.
23146 @end table
23148 @node SPARC Options
23149 @subsection SPARC Options
23150 @cindex SPARC options
23152 These @samp{-m} options are supported on the SPARC:
23154 @table @gcctabopt
23155 @item -mno-app-regs
23156 @itemx -mapp-regs
23157 @opindex mno-app-regs
23158 @opindex mapp-regs
23159 Specify @option{-mapp-regs} to generate output using the global registers
23160 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23161 global register 1, each global register 2 through 4 is then treated as an
23162 allocable register that is clobbered by function calls.  This is the default.
23164 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23165 specify @option{-mno-app-regs}.  You should compile libraries and system
23166 software with this option.
23168 @item -mflat
23169 @itemx -mno-flat
23170 @opindex mflat
23171 @opindex mno-flat
23172 With @option{-mflat}, the compiler does not generate save/restore instructions
23173 and uses a ``flat'' or single register window model.  This model is compatible
23174 with the regular register window model.  The local registers and the input
23175 registers (0--5) are still treated as ``call-saved'' registers and are
23176 saved on the stack as needed.
23178 With @option{-mno-flat} (the default), the compiler generates save/restore
23179 instructions (except for leaf functions).  This is the normal operating mode.
23181 @item -mfpu
23182 @itemx -mhard-float
23183 @opindex mfpu
23184 @opindex mhard-float
23185 Generate output containing floating-point instructions.  This is the
23186 default.
23188 @item -mno-fpu
23189 @itemx -msoft-float
23190 @opindex mno-fpu
23191 @opindex msoft-float
23192 Generate output containing library calls for floating point.
23193 @strong{Warning:} the requisite libraries are not available for all SPARC
23194 targets.  Normally the facilities of the machine's usual C compiler are
23195 used, but this cannot be done directly in cross-compilation.  You must make
23196 your own arrangements to provide suitable library functions for
23197 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23198 @samp{sparclite-*-*} do provide software floating-point support.
23200 @option{-msoft-float} changes the calling convention in the output file;
23201 therefore, it is only useful if you compile @emph{all} of a program with
23202 this option.  In particular, you need to compile @file{libgcc.a}, the
23203 library that comes with GCC, with @option{-msoft-float} in order for
23204 this to work.
23206 @item -mhard-quad-float
23207 @opindex mhard-quad-float
23208 Generate output containing quad-word (long double) floating-point
23209 instructions.
23211 @item -msoft-quad-float
23212 @opindex msoft-quad-float
23213 Generate output containing library calls for quad-word (long double)
23214 floating-point instructions.  The functions called are those specified
23215 in the SPARC ABI@.  This is the default.
23217 As of this writing, there are no SPARC implementations that have hardware
23218 support for the quad-word floating-point instructions.  They all invoke
23219 a trap handler for one of these instructions, and then the trap handler
23220 emulates the effect of the instruction.  Because of the trap handler overhead,
23221 this is much slower than calling the ABI library routines.  Thus the
23222 @option{-msoft-quad-float} option is the default.
23224 @item -mno-unaligned-doubles
23225 @itemx -munaligned-doubles
23226 @opindex mno-unaligned-doubles
23227 @opindex munaligned-doubles
23228 Assume that doubles have 8-byte alignment.  This is the default.
23230 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23231 alignment only if they are contained in another type, or if they have an
23232 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23233 Specifying this option avoids some rare compatibility problems with code
23234 generated by other compilers.  It is not the default because it results
23235 in a performance loss, especially for floating-point code.
23237 @item -muser-mode
23238 @itemx -mno-user-mode
23239 @opindex muser-mode
23240 @opindex mno-user-mode
23241 Do not generate code that can only run in supervisor mode.  This is relevant
23242 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23243 is the default.
23245 @item -mfaster-structs
23246 @itemx -mno-faster-structs
23247 @opindex mfaster-structs
23248 @opindex mno-faster-structs
23249 With @option{-mfaster-structs}, the compiler assumes that structures
23250 should have 8-byte alignment.  This enables the use of pairs of
23251 @code{ldd} and @code{std} instructions for copies in structure
23252 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23253 However, the use of this changed alignment directly violates the SPARC
23254 ABI@.  Thus, it's intended only for use on targets where the developer
23255 acknowledges that their resulting code is not directly in line with
23256 the rules of the ABI@.
23258 @item -mstd-struct-return
23259 @itemx -mno-std-struct-return
23260 @opindex mstd-struct-return
23261 @opindex mno-std-struct-return
23262 With @option{-mstd-struct-return}, the compiler generates checking code
23263 in functions returning structures or unions to detect size mismatches
23264 between the two sides of function calls, as per the 32-bit ABI@.
23266 The default is @option{-mno-std-struct-return}.  This option has no effect
23267 in 64-bit mode.
23269 @item -mlra
23270 @itemx -mno-lra
23271 @opindex mlra
23272 @opindex mno-lra
23273 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23274 so @option{-mno-lra} needs to be passed to get old Reload.
23276 @item -mcpu=@var{cpu_type}
23277 @opindex mcpu
23278 Set the instruction set, register set, and instruction scheduling parameters
23279 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23280 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23281 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23282 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23283 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23284 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23286 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23287 which selects the best architecture option for the host processor.
23288 @option{-mcpu=native} has no effect if GCC does not recognize
23289 the processor.
23291 Default instruction scheduling parameters are used for values that select
23292 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23293 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23295 Here is a list of each supported architecture and their supported
23296 implementations.
23298 @table @asis
23299 @item v7
23300 cypress, leon3v7
23302 @item v8
23303 supersparc, hypersparc, leon, leon3
23305 @item sparclite
23306 f930, f934, sparclite86x
23308 @item sparclet
23309 tsc701
23311 @item v9
23312 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23313 @end table
23315 By default (unless configured otherwise), GCC generates code for the V7
23316 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23317 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23318 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23319 SPARCStation 1, 2, IPX etc.
23321 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23322 architecture.  The only difference from V7 code is that the compiler emits
23323 the integer multiply and integer divide instructions which exist in SPARC-V8
23324 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23325 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23326 2000 series.
23328 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23329 the SPARC architecture.  This adds the integer multiply, integer divide step
23330 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23331 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23332 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23333 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23334 MB86934 chip, which is the more recent SPARClite with FPU@.
23336 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23337 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23338 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23339 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23340 optimizes it for the TEMIC SPARClet chip.
23342 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23343 architecture.  This adds 64-bit integer and floating-point move instructions,
23344 3 additional floating-point condition code registers and conditional move
23345 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23346 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23347 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23348 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23349 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23350 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23351 additionally optimizes it for Sun UltraSPARC T2 chips. With
23352 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23353 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23354 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23355 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23356 Oracle SPARC M7 chips.
23358 @item -mtune=@var{cpu_type}
23359 @opindex mtune
23360 Set the instruction scheduling parameters for machine type
23361 @var{cpu_type}, but do not set the instruction set or register set that the
23362 option @option{-mcpu=@var{cpu_type}} does.
23364 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23365 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23366 that select a particular CPU implementation.  Those are
23367 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23368 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23369 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23370 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23371 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23372 GNU/Linux toolchains, @samp{native} can also be used.
23374 @item -mv8plus
23375 @itemx -mno-v8plus
23376 @opindex mv8plus
23377 @opindex mno-v8plus
23378 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23379 difference from the V8 ABI is that the global and out registers are
23380 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23381 mode for all SPARC-V9 processors.
23383 @item -mvis
23384 @itemx -mno-vis
23385 @opindex mvis
23386 @opindex mno-vis
23387 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23388 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23390 @item -mvis2
23391 @itemx -mno-vis2
23392 @opindex mvis2
23393 @opindex mno-vis2
23394 With @option{-mvis2}, GCC generates code that takes advantage of
23395 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23396 default is @option{-mvis2} when targeting a cpu that supports such
23397 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23398 also sets @option{-mvis}.
23400 @item -mvis3
23401 @itemx -mno-vis3
23402 @opindex mvis3
23403 @opindex mno-vis3
23404 With @option{-mvis3}, GCC generates code that takes advantage of
23405 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23406 default is @option{-mvis3} when targeting a cpu that supports such
23407 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23408 also sets @option{-mvis2} and @option{-mvis}.
23410 @item -mvis4
23411 @itemx -mno-vis4
23412 @opindex mvis4
23413 @opindex mno-vis4
23414 With @option{-mvis4}, GCC generates code that takes advantage of
23415 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23416 default is @option{-mvis4} when targeting a cpu that supports such
23417 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23418 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23420 @item -mcbcond
23421 @itemx -mno-cbcond
23422 @opindex mcbcond
23423 @opindex mno-cbcond
23424 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23425 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23426 when targeting a CPU that supports such instructions, such as Niagara-4 and
23427 later.
23429 @item -mfmaf
23430 @itemx -mno-fmaf
23431 @opindex mfmaf
23432 @opindex mno-fmaf
23433 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23434 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23435 when targeting a CPU that supports such instructions, such as Niagara-3 and
23436 later.
23438 @item -mpopc
23439 @itemx -mno-popc
23440 @opindex mpopc
23441 @opindex mno-popc
23442 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23443 Population Count instruction.  The default is @option{-mpopc}
23444 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23445 later.
23447 @item -msubxc
23448 @itemx -mno-subxc
23449 @opindex msubxc
23450 @opindex mno-subxc
23451 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
23452 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
23453 when targeting a CPU that supports such an instruction, such as Niagara-7 and
23454 later.
23456 @item -mfix-at697f
23457 @opindex mfix-at697f
23458 Enable the documented workaround for the single erratum of the Atmel AT697F
23459 processor (which corresponds to erratum #13 of the AT697E processor).
23461 @item -mfix-ut699
23462 @opindex mfix-ut699
23463 Enable the documented workarounds for the floating-point errata and the data
23464 cache nullify errata of the UT699 processor.
23465 @end table
23467 These @samp{-m} options are supported in addition to the above
23468 on SPARC-V9 processors in 64-bit environments:
23470 @table @gcctabopt
23471 @item -m32
23472 @itemx -m64
23473 @opindex m32
23474 @opindex m64
23475 Generate code for a 32-bit or 64-bit environment.
23476 The 32-bit environment sets int, long and pointer to 32 bits.
23477 The 64-bit environment sets int to 32 bits and long and pointer
23478 to 64 bits.
23480 @item -mcmodel=@var{which}
23481 @opindex mcmodel
23482 Set the code model to one of
23484 @table @samp
23485 @item medlow
23486 The Medium/Low code model: 64-bit addresses, programs
23487 must be linked in the low 32 bits of memory.  Programs can be statically
23488 or dynamically linked.
23490 @item medmid
23491 The Medium/Middle code model: 64-bit addresses, programs
23492 must be linked in the low 44 bits of memory, the text and data segments must
23493 be less than 2GB in size and the data segment must be located within 2GB of
23494 the text segment.
23496 @item medany
23497 The Medium/Anywhere code model: 64-bit addresses, programs
23498 may be linked anywhere in memory, the text and data segments must be less
23499 than 2GB in size and the data segment must be located within 2GB of the
23500 text segment.
23502 @item embmedany
23503 The Medium/Anywhere code model for embedded systems:
23504 64-bit addresses, the text and data segments must be less than 2GB in
23505 size, both starting anywhere in memory (determined at link time).  The
23506 global register %g4 points to the base of the data segment.  Programs
23507 are statically linked and PIC is not supported.
23508 @end table
23510 @item -mmemory-model=@var{mem-model}
23511 @opindex mmemory-model
23512 Set the memory model in force on the processor to one of
23514 @table @samp
23515 @item default
23516 The default memory model for the processor and operating system.
23518 @item rmo
23519 Relaxed Memory Order
23521 @item pso
23522 Partial Store Order
23524 @item tso
23525 Total Store Order
23527 @item sc
23528 Sequential Consistency
23529 @end table
23531 These memory models are formally defined in Appendix D of the SPARC-V9
23532 architecture manual, as set in the processor's @code{PSTATE.MM} field.
23534 @item -mstack-bias
23535 @itemx -mno-stack-bias
23536 @opindex mstack-bias
23537 @opindex mno-stack-bias
23538 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
23539 frame pointer if present, are offset by @minus{}2047 which must be added back
23540 when making stack frame references.  This is the default in 64-bit mode.
23541 Otherwise, assume no such offset is present.
23542 @end table
23544 @node SPU Options
23545 @subsection SPU Options
23546 @cindex SPU options
23548 These @samp{-m} options are supported on the SPU:
23550 @table @gcctabopt
23551 @item -mwarn-reloc
23552 @itemx -merror-reloc
23553 @opindex mwarn-reloc
23554 @opindex merror-reloc
23556 The loader for SPU does not handle dynamic relocations.  By default, GCC
23557 gives an error when it generates code that requires a dynamic
23558 relocation.  @option{-mno-error-reloc} disables the error,
23559 @option{-mwarn-reloc} generates a warning instead.
23561 @item -msafe-dma
23562 @itemx -munsafe-dma
23563 @opindex msafe-dma
23564 @opindex munsafe-dma
23566 Instructions that initiate or test completion of DMA must not be
23567 reordered with respect to loads and stores of the memory that is being
23568 accessed.
23569 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
23570 memory accesses, but that can lead to inefficient code in places where the
23571 memory is known to not change.  Rather than mark the memory as volatile,
23572 you can use @option{-msafe-dma} to tell the compiler to treat
23573 the DMA instructions as potentially affecting all memory.  
23575 @item -mbranch-hints
23576 @opindex mbranch-hints
23578 By default, GCC generates a branch hint instruction to avoid
23579 pipeline stalls for always-taken or probably-taken branches.  A hint
23580 is not generated closer than 8 instructions away from its branch.
23581 There is little reason to disable them, except for debugging purposes,
23582 or to make an object a little bit smaller.
23584 @item -msmall-mem
23585 @itemx -mlarge-mem
23586 @opindex msmall-mem
23587 @opindex mlarge-mem
23589 By default, GCC generates code assuming that addresses are never larger
23590 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
23591 a full 32-bit address.
23593 @item -mstdmain
23594 @opindex mstdmain
23596 By default, GCC links against startup code that assumes the SPU-style
23597 main function interface (which has an unconventional parameter list).
23598 With @option{-mstdmain}, GCC links your program against startup
23599 code that assumes a C99-style interface to @code{main}, including a
23600 local copy of @code{argv} strings.
23602 @item -mfixed-range=@var{register-range}
23603 @opindex mfixed-range
23604 Generate code treating the given register range as fixed registers.
23605 A fixed register is one that the register allocator cannot use.  This is
23606 useful when compiling kernel code.  A register range is specified as
23607 two registers separated by a dash.  Multiple register ranges can be
23608 specified separated by a comma.
23610 @item -mea32
23611 @itemx -mea64
23612 @opindex mea32
23613 @opindex mea64
23614 Compile code assuming that pointers to the PPU address space accessed
23615 via the @code{__ea} named address space qualifier are either 32 or 64
23616 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
23617 all object code in an executable must be compiled with the same setting.
23619 @item -maddress-space-conversion
23620 @itemx -mno-address-space-conversion
23621 @opindex maddress-space-conversion
23622 @opindex mno-address-space-conversion
23623 Allow/disallow treating the @code{__ea} address space as superset
23624 of the generic address space.  This enables explicit type casts
23625 between @code{__ea} and generic pointer as well as implicit
23626 conversions of generic pointers to @code{__ea} pointers.  The
23627 default is to allow address space pointer conversions.
23629 @item -mcache-size=@var{cache-size}
23630 @opindex mcache-size
23631 This option controls the version of libgcc that the compiler links to an
23632 executable and selects a software-managed cache for accessing variables
23633 in the @code{__ea} address space with a particular cache size.  Possible
23634 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
23635 and @samp{128}.  The default cache size is 64KB.
23637 @item -matomic-updates
23638 @itemx -mno-atomic-updates
23639 @opindex matomic-updates
23640 @opindex mno-atomic-updates
23641 This option controls the version of libgcc that the compiler links to an
23642 executable and selects whether atomic updates to the software-managed
23643 cache of PPU-side variables are used.  If you use atomic updates, changes
23644 to a PPU variable from SPU code using the @code{__ea} named address space
23645 qualifier do not interfere with changes to other PPU variables residing
23646 in the same cache line from PPU code.  If you do not use atomic updates,
23647 such interference may occur; however, writing back cache lines is
23648 more efficient.  The default behavior is to use atomic updates.
23650 @item -mdual-nops
23651 @itemx -mdual-nops=@var{n}
23652 @opindex mdual-nops
23653 By default, GCC inserts NOPs to increase dual issue when it expects
23654 it to increase performance.  @var{n} can be a value from 0 to 10.  A
23655 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
23656 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
23658 @item -mhint-max-nops=@var{n}
23659 @opindex mhint-max-nops
23660 Maximum number of NOPs to insert for a branch hint.  A branch hint must
23661 be at least 8 instructions away from the branch it is affecting.  GCC
23662 inserts up to @var{n} NOPs to enforce this, otherwise it does not
23663 generate the branch hint.
23665 @item -mhint-max-distance=@var{n}
23666 @opindex mhint-max-distance
23667 The encoding of the branch hint instruction limits the hint to be within
23668 256 instructions of the branch it is affecting.  By default, GCC makes
23669 sure it is within 125.
23671 @item -msafe-hints
23672 @opindex msafe-hints
23673 Work around a hardware bug that causes the SPU to stall indefinitely.
23674 By default, GCC inserts the @code{hbrp} instruction to make sure
23675 this stall won't happen.
23677 @end table
23679 @node System V Options
23680 @subsection Options for System V
23682 These additional options are available on System V Release 4 for
23683 compatibility with other compilers on those systems:
23685 @table @gcctabopt
23686 @item -G
23687 @opindex G
23688 Create a shared object.
23689 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
23691 @item -Qy
23692 @opindex Qy
23693 Identify the versions of each tool used by the compiler, in a
23694 @code{.ident} assembler directive in the output.
23696 @item -Qn
23697 @opindex Qn
23698 Refrain from adding @code{.ident} directives to the output file (this is
23699 the default).
23701 @item -YP,@var{dirs}
23702 @opindex YP
23703 Search the directories @var{dirs}, and no others, for libraries
23704 specified with @option{-l}.
23706 @item -Ym,@var{dir}
23707 @opindex Ym
23708 Look in the directory @var{dir} to find the M4 preprocessor.
23709 The assembler uses this option.
23710 @c This is supposed to go with a -Yd for predefined M4 macro files, but
23711 @c the generic assembler that comes with Solaris takes just -Ym.
23712 @end table
23714 @node TILE-Gx Options
23715 @subsection TILE-Gx Options
23716 @cindex TILE-Gx options
23718 These @samp{-m} options are supported on the TILE-Gx:
23720 @table @gcctabopt
23721 @item -mcmodel=small
23722 @opindex mcmodel=small
23723 Generate code for the small model.  The distance for direct calls is
23724 limited to 500M in either direction.  PC-relative addresses are 32
23725 bits.  Absolute addresses support the full address range.
23727 @item -mcmodel=large
23728 @opindex mcmodel=large
23729 Generate code for the large model.  There is no limitation on call
23730 distance, pc-relative addresses, or absolute addresses.
23732 @item -mcpu=@var{name}
23733 @opindex mcpu
23734 Selects the type of CPU to be targeted.  Currently the only supported
23735 type is @samp{tilegx}.
23737 @item -m32
23738 @itemx -m64
23739 @opindex m32
23740 @opindex m64
23741 Generate code for a 32-bit or 64-bit environment.  The 32-bit
23742 environment sets int, long, and pointer to 32 bits.  The 64-bit
23743 environment sets int to 32 bits and long and pointer to 64 bits.
23745 @item -mbig-endian
23746 @itemx -mlittle-endian
23747 @opindex mbig-endian
23748 @opindex mlittle-endian
23749 Generate code in big/little endian mode, respectively.
23750 @end table
23752 @node TILEPro Options
23753 @subsection TILEPro Options
23754 @cindex TILEPro options
23756 These @samp{-m} options are supported on the TILEPro:
23758 @table @gcctabopt
23759 @item -mcpu=@var{name}
23760 @opindex mcpu
23761 Selects the type of CPU to be targeted.  Currently the only supported
23762 type is @samp{tilepro}.
23764 @item -m32
23765 @opindex m32
23766 Generate code for a 32-bit environment, which sets int, long, and
23767 pointer to 32 bits.  This is the only supported behavior so the flag
23768 is essentially ignored.
23769 @end table
23771 @node V850 Options
23772 @subsection V850 Options
23773 @cindex V850 Options
23775 These @samp{-m} options are defined for V850 implementations:
23777 @table @gcctabopt
23778 @item -mlong-calls
23779 @itemx -mno-long-calls
23780 @opindex mlong-calls
23781 @opindex mno-long-calls
23782 Treat all calls as being far away (near).  If calls are assumed to be
23783 far away, the compiler always loads the function's address into a
23784 register, and calls indirect through the pointer.
23786 @item -mno-ep
23787 @itemx -mep
23788 @opindex mno-ep
23789 @opindex mep
23790 Do not optimize (do optimize) basic blocks that use the same index
23791 pointer 4 or more times to copy pointer into the @code{ep} register, and
23792 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
23793 option is on by default if you optimize.
23795 @item -mno-prolog-function
23796 @itemx -mprolog-function
23797 @opindex mno-prolog-function
23798 @opindex mprolog-function
23799 Do not use (do use) external functions to save and restore registers
23800 at the prologue and epilogue of a function.  The external functions
23801 are slower, but use less code space if more than one function saves
23802 the same number of registers.  The @option{-mprolog-function} option
23803 is on by default if you optimize.
23805 @item -mspace
23806 @opindex mspace
23807 Try to make the code as small as possible.  At present, this just turns
23808 on the @option{-mep} and @option{-mprolog-function} options.
23810 @item -mtda=@var{n}
23811 @opindex mtda
23812 Put static or global variables whose size is @var{n} bytes or less into
23813 the tiny data area that register @code{ep} points to.  The tiny data
23814 area can hold up to 256 bytes in total (128 bytes for byte references).
23816 @item -msda=@var{n}
23817 @opindex msda
23818 Put static or global variables whose size is @var{n} bytes or less into
23819 the small data area that register @code{gp} points to.  The small data
23820 area can hold up to 64 kilobytes.
23822 @item -mzda=@var{n}
23823 @opindex mzda
23824 Put static or global variables whose size is @var{n} bytes or less into
23825 the first 32 kilobytes of memory.
23827 @item -mv850
23828 @opindex mv850
23829 Specify that the target processor is the V850.
23831 @item -mv850e3v5
23832 @opindex mv850e3v5
23833 Specify that the target processor is the V850E3V5.  The preprocessor
23834 constant @code{__v850e3v5__} is defined if this option is used.
23836 @item -mv850e2v4
23837 @opindex mv850e2v4
23838 Specify that the target processor is the V850E3V5.  This is an alias for
23839 the @option{-mv850e3v5} option.
23841 @item -mv850e2v3
23842 @opindex mv850e2v3
23843 Specify that the target processor is the V850E2V3.  The preprocessor
23844 constant @code{__v850e2v3__} is defined if this option is used.
23846 @item -mv850e2
23847 @opindex mv850e2
23848 Specify that the target processor is the V850E2.  The preprocessor
23849 constant @code{__v850e2__} is defined if this option is used.
23851 @item -mv850e1
23852 @opindex mv850e1
23853 Specify that the target processor is the V850E1.  The preprocessor
23854 constants @code{__v850e1__} and @code{__v850e__} are defined if
23855 this option is used.
23857 @item -mv850es
23858 @opindex mv850es
23859 Specify that the target processor is the V850ES.  This is an alias for
23860 the @option{-mv850e1} option.
23862 @item -mv850e
23863 @opindex mv850e
23864 Specify that the target processor is the V850E@.  The preprocessor
23865 constant @code{__v850e__} is defined if this option is used.
23867 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
23868 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
23869 are defined then a default target processor is chosen and the
23870 relevant @samp{__v850*__} preprocessor constant is defined.
23872 The preprocessor constants @code{__v850} and @code{__v851__} are always
23873 defined, regardless of which processor variant is the target.
23875 @item -mdisable-callt
23876 @itemx -mno-disable-callt
23877 @opindex mdisable-callt
23878 @opindex mno-disable-callt
23879 This option suppresses generation of the @code{CALLT} instruction for the
23880 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
23881 architecture.
23883 This option is enabled by default when the RH850 ABI is
23884 in use (see @option{-mrh850-abi}), and disabled by default when the
23885 GCC ABI is in use.  If @code{CALLT} instructions are being generated
23886 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
23888 @item -mrelax
23889 @itemx -mno-relax
23890 @opindex mrelax
23891 @opindex mno-relax
23892 Pass on (or do not pass on) the @option{-mrelax} command-line option
23893 to the assembler.
23895 @item -mlong-jumps
23896 @itemx -mno-long-jumps
23897 @opindex mlong-jumps
23898 @opindex mno-long-jumps
23899 Disable (or re-enable) the generation of PC-relative jump instructions.
23901 @item -msoft-float
23902 @itemx -mhard-float
23903 @opindex msoft-float
23904 @opindex mhard-float
23905 Disable (or re-enable) the generation of hardware floating point
23906 instructions.  This option is only significant when the target
23907 architecture is @samp{V850E2V3} or higher.  If hardware floating point
23908 instructions are being generated then the C preprocessor symbol
23909 @code{__FPU_OK__} is defined, otherwise the symbol
23910 @code{__NO_FPU__} is defined.
23912 @item -mloop
23913 @opindex mloop
23914 Enables the use of the e3v5 LOOP instruction.  The use of this
23915 instruction is not enabled by default when the e3v5 architecture is
23916 selected because its use is still experimental.
23918 @item -mrh850-abi
23919 @itemx -mghs
23920 @opindex mrh850-abi
23921 @opindex mghs
23922 Enables support for the RH850 version of the V850 ABI.  This is the
23923 default.  With this version of the ABI the following rules apply:
23925 @itemize
23926 @item
23927 Integer sized structures and unions are returned via a memory pointer
23928 rather than a register.
23930 @item
23931 Large structures and unions (more than 8 bytes in size) are passed by
23932 value.
23934 @item
23935 Functions are aligned to 16-bit boundaries.
23937 @item
23938 The @option{-m8byte-align} command-line option is supported.
23940 @item
23941 The @option{-mdisable-callt} command-line option is enabled by
23942 default.  The @option{-mno-disable-callt} command-line option is not
23943 supported.
23944 @end itemize
23946 When this version of the ABI is enabled the C preprocessor symbol
23947 @code{__V850_RH850_ABI__} is defined.
23949 @item -mgcc-abi
23950 @opindex mgcc-abi
23951 Enables support for the old GCC version of the V850 ABI.  With this
23952 version of the ABI the following rules apply:
23954 @itemize
23955 @item
23956 Integer sized structures and unions are returned in register @code{r10}.
23958 @item
23959 Large structures and unions (more than 8 bytes in size) are passed by
23960 reference.
23962 @item
23963 Functions are aligned to 32-bit boundaries, unless optimizing for
23964 size.
23966 @item
23967 The @option{-m8byte-align} command-line option is not supported.
23969 @item
23970 The @option{-mdisable-callt} command-line option is supported but not
23971 enabled by default.
23972 @end itemize
23974 When this version of the ABI is enabled the C preprocessor symbol
23975 @code{__V850_GCC_ABI__} is defined.
23977 @item -m8byte-align
23978 @itemx -mno-8byte-align
23979 @opindex m8byte-align
23980 @opindex mno-8byte-align
23981 Enables support for @code{double} and @code{long long} types to be
23982 aligned on 8-byte boundaries.  The default is to restrict the
23983 alignment of all objects to at most 4-bytes.  When
23984 @option{-m8byte-align} is in effect the C preprocessor symbol
23985 @code{__V850_8BYTE_ALIGN__} is defined.
23987 @item -mbig-switch
23988 @opindex mbig-switch
23989 Generate code suitable for big switch tables.  Use this option only if
23990 the assembler/linker complain about out of range branches within a switch
23991 table.
23993 @item -mapp-regs
23994 @opindex mapp-regs
23995 This option causes r2 and r5 to be used in the code generated by
23996 the compiler.  This setting is the default.
23998 @item -mno-app-regs
23999 @opindex mno-app-regs
24000 This option causes r2 and r5 to be treated as fixed registers.
24002 @end table
24004 @node VAX Options
24005 @subsection VAX Options
24006 @cindex VAX options
24008 These @samp{-m} options are defined for the VAX:
24010 @table @gcctabopt
24011 @item -munix
24012 @opindex munix
24013 Do not output certain jump instructions (@code{aobleq} and so on)
24014 that the Unix assembler for the VAX cannot handle across long
24015 ranges.
24017 @item -mgnu
24018 @opindex mgnu
24019 Do output those jump instructions, on the assumption that the
24020 GNU assembler is being used.
24022 @item -mg
24023 @opindex mg
24024 Output code for G-format floating-point numbers instead of D-format.
24025 @end table
24027 @node Visium Options
24028 @subsection Visium Options
24029 @cindex Visium options
24031 @table @gcctabopt
24033 @item -mdebug
24034 @opindex mdebug
24035 A program which performs file I/O and is destined to run on an MCM target
24036 should be linked with this option.  It causes the libraries libc.a and
24037 libdebug.a to be linked.  The program should be run on the target under
24038 the control of the GDB remote debugging stub.
24040 @item -msim
24041 @opindex msim
24042 A program which performs file I/O and is destined to run on the simulator
24043 should be linked with option.  This causes libraries libc.a and libsim.a to
24044 be linked.
24046 @item -mfpu
24047 @itemx -mhard-float
24048 @opindex mfpu
24049 @opindex mhard-float
24050 Generate code containing floating-point instructions.  This is the
24051 default.
24053 @item -mno-fpu
24054 @itemx -msoft-float
24055 @opindex mno-fpu
24056 @opindex msoft-float
24057 Generate code containing library calls for floating-point.
24059 @option{-msoft-float} changes the calling convention in the output file;
24060 therefore, it is only useful if you compile @emph{all} of a program with
24061 this option.  In particular, you need to compile @file{libgcc.a}, the
24062 library that comes with GCC, with @option{-msoft-float} in order for
24063 this to work.
24065 @item -mcpu=@var{cpu_type}
24066 @opindex mcpu
24067 Set the instruction set, register set, and instruction scheduling parameters
24068 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24069 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24071 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24073 By default (unless configured otherwise), GCC generates code for the GR5
24074 variant of the Visium architecture.  
24076 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24077 architecture.  The only difference from GR5 code is that the compiler will
24078 generate block move instructions.
24080 @item -mtune=@var{cpu_type}
24081 @opindex mtune
24082 Set the instruction scheduling parameters for machine type @var{cpu_type},
24083 but do not set the instruction set or register set that the option
24084 @option{-mcpu=@var{cpu_type}} would.
24086 @item -msv-mode
24087 @opindex msv-mode
24088 Generate code for the supervisor mode, where there are no restrictions on
24089 the access to general registers.  This is the default.
24091 @item -muser-mode
24092 @opindex muser-mode
24093 Generate code for the user mode, where the access to some general registers
24094 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24095 mode; on the GR6, only registers r29 to r31 are affected.
24096 @end table
24098 @node VMS Options
24099 @subsection VMS Options
24101 These @samp{-m} options are defined for the VMS implementations:
24103 @table @gcctabopt
24104 @item -mvms-return-codes
24105 @opindex mvms-return-codes
24106 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24107 condition (e.g.@ error) codes.
24109 @item -mdebug-main=@var{prefix}
24110 @opindex mdebug-main=@var{prefix}
24111 Flag the first routine whose name starts with @var{prefix} as the main
24112 routine for the debugger.
24114 @item -mmalloc64
24115 @opindex mmalloc64
24116 Default to 64-bit memory allocation routines.
24118 @item -mpointer-size=@var{size}
24119 @opindex mpointer-size=@var{size}
24120 Set the default size of pointers. Possible options for @var{size} are
24121 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24122 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24123 The later option disables @code{pragma pointer_size}.
24124 @end table
24126 @node VxWorks Options
24127 @subsection VxWorks Options
24128 @cindex VxWorks Options
24130 The options in this section are defined for all VxWorks targets.
24131 Options specific to the target hardware are listed with the other
24132 options for that target.
24134 @table @gcctabopt
24135 @item -mrtp
24136 @opindex mrtp
24137 GCC can generate code for both VxWorks kernels and real time processes
24138 (RTPs).  This option switches from the former to the latter.  It also
24139 defines the preprocessor macro @code{__RTP__}.
24141 @item -non-static
24142 @opindex non-static
24143 Link an RTP executable against shared libraries rather than static
24144 libraries.  The options @option{-static} and @option{-shared} can
24145 also be used for RTPs (@pxref{Link Options}); @option{-static}
24146 is the default.
24148 @item -Bstatic
24149 @itemx -Bdynamic
24150 @opindex Bstatic
24151 @opindex Bdynamic
24152 These options are passed down to the linker.  They are defined for
24153 compatibility with Diab.
24155 @item -Xbind-lazy
24156 @opindex Xbind-lazy
24157 Enable lazy binding of function calls.  This option is equivalent to
24158 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24160 @item -Xbind-now
24161 @opindex Xbind-now
24162 Disable lazy binding of function calls.  This option is the default and
24163 is defined for compatibility with Diab.
24164 @end table
24166 @node x86 Options
24167 @subsection x86 Options
24168 @cindex x86 Options
24170 These @samp{-m} options are defined for the x86 family of computers.
24172 @table @gcctabopt
24174 @item -march=@var{cpu-type}
24175 @opindex march
24176 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24177 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24178 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24179 to generate code that may not run at all on processors other than the one
24180 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24181 @option{-mtune=@var{cpu-type}}.
24183 The choices for @var{cpu-type} are:
24185 @table @samp
24186 @item native
24187 This selects the CPU to generate code for at compilation time by determining
24188 the processor type of the compiling machine.  Using @option{-march=native}
24189 enables all instruction subsets supported by the local machine (hence
24190 the result might not run on different machines).  Using @option{-mtune=native}
24191 produces code optimized for the local machine under the constraints
24192 of the selected instruction set.  
24194 @item i386
24195 Original Intel i386 CPU@.
24197 @item i486
24198 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24200 @item i586
24201 @itemx pentium
24202 Intel Pentium CPU with no MMX support.
24204 @item lakemont
24205 Intel Lakemont MCU, based on Intel Pentium CPU.
24207 @item pentium-mmx
24208 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24210 @item pentiumpro
24211 Intel Pentium Pro CPU@.
24213 @item i686
24214 When used with @option{-march}, the Pentium Pro
24215 instruction set is used, so the code runs on all i686 family chips.
24216 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24218 @item pentium2
24219 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24220 support.
24222 @item pentium3
24223 @itemx pentium3m
24224 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24225 set support.
24227 @item pentium-m
24228 Intel Pentium M; low-power version of Intel Pentium III CPU
24229 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24231 @item pentium4
24232 @itemx pentium4m
24233 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24235 @item prescott
24236 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24237 set support.
24239 @item nocona
24240 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24241 SSE2 and SSE3 instruction set support.
24243 @item core2
24244 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24245 instruction set support.
24247 @item nehalem
24248 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24249 SSE4.1, SSE4.2 and POPCNT instruction set support.
24251 @item westmere
24252 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24253 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24255 @item sandybridge
24256 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24257 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24259 @item ivybridge
24260 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24261 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24262 instruction set support.
24264 @item haswell
24265 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24266 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24267 BMI, BMI2 and F16C instruction set support.
24269 @item broadwell
24270 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24271 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24272 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24274 @item skylake
24275 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24276 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24277 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24278 XSAVES instruction set support.
24280 @item bonnell
24281 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24282 instruction set support.
24284 @item silvermont
24285 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24286 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24288 @item knl
24289 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24290 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24291 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24292 AVX512CD instruction set support.
24294 @item skylake-avx512
24295 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24296 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24297 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24298 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24300 @item k6
24301 AMD K6 CPU with MMX instruction set support.
24303 @item k6-2
24304 @itemx k6-3
24305 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24307 @item athlon
24308 @itemx athlon-tbird
24309 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24310 support.
24312 @item athlon-4
24313 @itemx athlon-xp
24314 @itemx athlon-mp
24315 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24316 instruction set support.
24318 @item k8
24319 @itemx opteron
24320 @itemx athlon64
24321 @itemx athlon-fx
24322 Processors based on the AMD K8 core with x86-64 instruction set support,
24323 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24324 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24325 instruction set extensions.)
24327 @item k8-sse3
24328 @itemx opteron-sse3
24329 @itemx athlon64-sse3
24330 Improved versions of AMD K8 cores with SSE3 instruction set support.
24332 @item amdfam10
24333 @itemx barcelona
24334 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24335 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24336 instruction set extensions.)
24338 @item bdver1
24339 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24340 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24341 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24342 @item bdver2
24343 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24344 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24345 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24346 extensions.)
24347 @item bdver3
24348 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24349 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24350 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24351 64-bit instruction set extensions.
24352 @item bdver4
24353 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24354 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24355 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24356 SSE4.2, ABM and 64-bit instruction set extensions.
24358 @item znver1
24359 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24360 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24361 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24362 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24363 instruction set extensions.
24365 @item btver1
24366 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24367 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24368 instruction set extensions.)
24370 @item btver2
24371 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24372 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24373 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24375 @item winchip-c6
24376 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24377 set support.
24379 @item winchip2
24380 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24381 instruction set support.
24383 @item c3
24384 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24385 (No scheduling is implemented for this chip.)
24387 @item c3-2
24388 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24389 (No scheduling is implemented for this chip.)
24391 @item c7
24392 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24393 (No scheduling is implemented for this chip.)
24395 @item samuel-2
24396 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24397 (No scheduling is implemented for this chip.)
24399 @item nehemiah
24400 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24401 (No scheduling is implemented for this chip.)
24403 @item esther
24404 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24405 (No scheduling is implemented for this chip.)
24407 @item eden-x2
24408 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24409 (No scheduling is implemented for this chip.)
24411 @item eden-x4
24412 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24413 AVX and AVX2 instruction set support.
24414 (No scheduling is implemented for this chip.)
24416 @item nano
24417 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24418 instruction set support.
24419 (No scheduling is implemented for this chip.)
24421 @item nano-1000
24422 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24423 instruction set support.
24424 (No scheduling is implemented for this chip.)
24426 @item nano-2000
24427 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24428 instruction set support.
24429 (No scheduling is implemented for this chip.)
24431 @item nano-3000
24432 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24433 instruction set support.
24434 (No scheduling is implemented for this chip.)
24436 @item nano-x2
24437 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24438 instruction set support.
24439 (No scheduling is implemented for this chip.)
24441 @item nano-x4
24442 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24443 instruction set support.
24444 (No scheduling is implemented for this chip.)
24446 @item geode
24447 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
24448 @end table
24450 @item -mtune=@var{cpu-type}
24451 @opindex mtune
24452 Tune to @var{cpu-type} everything applicable about the generated code, except
24453 for the ABI and the set of available instructions.  
24454 While picking a specific @var{cpu-type} schedules things appropriately
24455 for that particular chip, the compiler does not generate any code that
24456 cannot run on the default machine type unless you use a
24457 @option{-march=@var{cpu-type}} option.
24458 For example, if GCC is configured for i686-pc-linux-gnu
24459 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
24460 but still runs on i686 machines.
24462 The choices for @var{cpu-type} are the same as for @option{-march}.
24463 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
24465 @table @samp
24466 @item generic
24467 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
24468 If you know the CPU on which your code will run, then you should use
24469 the corresponding @option{-mtune} or @option{-march} option instead of
24470 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
24471 of your application will have, then you should use this option.
24473 As new processors are deployed in the marketplace, the behavior of this
24474 option will change.  Therefore, if you upgrade to a newer version of
24475 GCC, code generation controlled by this option will change to reflect
24476 the processors
24477 that are most common at the time that version of GCC is released.
24479 There is no @option{-march=generic} option because @option{-march}
24480 indicates the instruction set the compiler can use, and there is no
24481 generic instruction set applicable to all processors.  In contrast,
24482 @option{-mtune} indicates the processor (or, in this case, collection of
24483 processors) for which the code is optimized.
24485 @item intel
24486 Produce code optimized for the most current Intel processors, which are
24487 Haswell and Silvermont for this version of GCC.  If you know the CPU
24488 on which your code will run, then you should use the corresponding
24489 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
24490 But, if you want your application performs better on both Haswell and
24491 Silvermont, then you should use this option.
24493 As new Intel processors are deployed in the marketplace, the behavior of
24494 this option will change.  Therefore, if you upgrade to a newer version of
24495 GCC, code generation controlled by this option will change to reflect
24496 the most current Intel processors at the time that version of GCC is
24497 released.
24499 There is no @option{-march=intel} option because @option{-march} indicates
24500 the instruction set the compiler can use, and there is no common
24501 instruction set applicable to all processors.  In contrast,
24502 @option{-mtune} indicates the processor (or, in this case, collection of
24503 processors) for which the code is optimized.
24504 @end table
24506 @item -mcpu=@var{cpu-type}
24507 @opindex mcpu
24508 A deprecated synonym for @option{-mtune}.
24510 @item -mfpmath=@var{unit}
24511 @opindex mfpmath
24512 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
24513 for @var{unit} are:
24515 @table @samp
24516 @item 387
24517 Use the standard 387 floating-point coprocessor present on the majority of chips and
24518 emulated otherwise.  Code compiled with this option runs almost everywhere.
24519 The temporary results are computed in 80-bit precision instead of the precision
24520 specified by the type, resulting in slightly different results compared to most
24521 of other chips.  See @option{-ffloat-store} for more detailed description.
24523 This is the default choice for x86-32 targets.
24525 @item sse
24526 Use scalar floating-point instructions present in the SSE instruction set.
24527 This instruction set is supported by Pentium III and newer chips,
24528 and in the AMD line
24529 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
24530 instruction set supports only single-precision arithmetic, thus the double and
24531 extended-precision arithmetic are still done using 387.  A later version, present
24532 only in Pentium 4 and AMD x86-64 chips, supports double-precision
24533 arithmetic too.
24535 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
24536 or @option{-msse2} switches to enable SSE extensions and make this option
24537 effective.  For the x86-64 compiler, these extensions are enabled by default.
24539 The resulting code should be considerably faster in the majority of cases and avoid
24540 the numerical instability problems of 387 code, but may break some existing
24541 code that expects temporaries to be 80 bits.
24543 This is the default choice for the x86-64 compiler.
24545 @item sse,387
24546 @itemx sse+387
24547 @itemx both
24548 Attempt to utilize both instruction sets at once.  This effectively doubles the
24549 amount of available registers, and on chips with separate execution units for
24550 387 and SSE the execution resources too.  Use this option with care, as it is
24551 still experimental, because the GCC register allocator does not model separate
24552 functional units well, resulting in unstable performance.
24553 @end table
24555 @item -masm=@var{dialect}
24556 @opindex masm=@var{dialect}
24557 Output assembly instructions using selected @var{dialect}.  Also affects
24558 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
24559 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
24560 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
24561 not support @samp{intel}.
24563 @item -mieee-fp
24564 @itemx -mno-ieee-fp
24565 @opindex mieee-fp
24566 @opindex mno-ieee-fp
24567 Control whether or not the compiler uses IEEE floating-point
24568 comparisons.  These correctly handle the case where the result of a
24569 comparison is unordered.
24571 @item -m80387
24572 @item -mhard-float
24573 @opindex 80387
24574 @opindex mhard-float
24575 Generate output containing 80387 instructions for floating point.
24577 @item -mno-80387
24578 @item -msoft-float
24579 @opindex no-80387
24580 @opindex msoft-float
24581 Generate output containing library calls for floating point.
24583 @strong{Warning:} the requisite libraries are not part of GCC@.
24584 Normally the facilities of the machine's usual C compiler are used, but
24585 this can't be done directly in cross-compilation.  You must make your
24586 own arrangements to provide suitable library functions for
24587 cross-compilation.
24589 On machines where a function returns floating-point results in the 80387
24590 register stack, some floating-point opcodes may be emitted even if
24591 @option{-msoft-float} is used.
24593 @item -mno-fp-ret-in-387
24594 @opindex mno-fp-ret-in-387
24595 Do not use the FPU registers for return values of functions.
24597 The usual calling convention has functions return values of types
24598 @code{float} and @code{double} in an FPU register, even if there
24599 is no FPU@.  The idea is that the operating system should emulate
24600 an FPU@.
24602 The option @option{-mno-fp-ret-in-387} causes such values to be returned
24603 in ordinary CPU registers instead.
24605 @item -mno-fancy-math-387
24606 @opindex mno-fancy-math-387
24607 Some 387 emulators do not support the @code{sin}, @code{cos} and
24608 @code{sqrt} instructions for the 387.  Specify this option to avoid
24609 generating those instructions.  This option is the default on
24610 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
24611 indicates that the target CPU always has an FPU and so the
24612 instruction does not need emulation.  These
24613 instructions are not generated unless you also use the
24614 @option{-funsafe-math-optimizations} switch.
24616 @item -malign-double
24617 @itemx -mno-align-double
24618 @opindex malign-double
24619 @opindex mno-align-double
24620 Control whether GCC aligns @code{double}, @code{long double}, and
24621 @code{long long} variables on a two-word boundary or a one-word
24622 boundary.  Aligning @code{double} variables on a two-word boundary
24623 produces code that runs somewhat faster on a Pentium at the
24624 expense of more memory.
24626 On x86-64, @option{-malign-double} is enabled by default.
24628 @strong{Warning:} if you use the @option{-malign-double} switch,
24629 structures containing the above types are aligned differently than
24630 the published application binary interface specifications for the x86-32
24631 and are not binary compatible with structures in code compiled
24632 without that switch.
24634 @item -m96bit-long-double
24635 @itemx -m128bit-long-double
24636 @opindex m96bit-long-double
24637 @opindex m128bit-long-double
24638 These switches control the size of @code{long double} type.  The x86-32
24639 application binary interface specifies the size to be 96 bits,
24640 so @option{-m96bit-long-double} is the default in 32-bit mode.
24642 Modern architectures (Pentium and newer) prefer @code{long double}
24643 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
24644 conforming to the ABI, this is not possible.  So specifying
24645 @option{-m128bit-long-double} aligns @code{long double}
24646 to a 16-byte boundary by padding the @code{long double} with an additional
24647 32-bit zero.
24649 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
24650 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
24652 Notice that neither of these options enable any extra precision over the x87
24653 standard of 80 bits for a @code{long double}.
24655 @strong{Warning:} if you override the default value for your target ABI, this
24656 changes the size of 
24657 structures and arrays containing @code{long double} variables,
24658 as well as modifying the function calling convention for functions taking
24659 @code{long double}.  Hence they are not binary-compatible
24660 with code compiled without that switch.
24662 @item -mlong-double-64
24663 @itemx -mlong-double-80
24664 @itemx -mlong-double-128
24665 @opindex mlong-double-64
24666 @opindex mlong-double-80
24667 @opindex mlong-double-128
24668 These switches control the size of @code{long double} type. A size
24669 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24670 type. This is the default for 32-bit Bionic C library.  A size
24671 of 128 bits makes the @code{long double} type equivalent to the
24672 @code{__float128} type. This is the default for 64-bit Bionic C library.
24674 @strong{Warning:} if you override the default value for your target ABI, this
24675 changes the size of
24676 structures and arrays containing @code{long double} variables,
24677 as well as modifying the function calling convention for functions taking
24678 @code{long double}.  Hence they are not binary-compatible
24679 with code compiled without that switch.
24681 @item -malign-data=@var{type}
24682 @opindex malign-data
24683 Control how GCC aligns variables.  Supported values for @var{type} are
24684 @samp{compat} uses increased alignment value compatible uses GCC 4.8
24685 and earlier, @samp{abi} uses alignment value as specified by the
24686 psABI, and @samp{cacheline} uses increased alignment value to match
24687 the cache line size.  @samp{compat} is the default.
24689 @item -mlarge-data-threshold=@var{threshold}
24690 @opindex mlarge-data-threshold
24691 When @option{-mcmodel=medium} is specified, data objects larger than
24692 @var{threshold} are placed in the large data section.  This value must be the
24693 same across all objects linked into the binary, and defaults to 65535.
24695 @item -mrtd
24696 @opindex mrtd
24697 Use a different function-calling convention, in which functions that
24698 take a fixed number of arguments return with the @code{ret @var{num}}
24699 instruction, which pops their arguments while returning.  This saves one
24700 instruction in the caller since there is no need to pop the arguments
24701 there.
24703 You can specify that an individual function is called with this calling
24704 sequence with the function attribute @code{stdcall}.  You can also
24705 override the @option{-mrtd} option by using the function attribute
24706 @code{cdecl}.  @xref{Function Attributes}.
24708 @strong{Warning:} this calling convention is incompatible with the one
24709 normally used on Unix, so you cannot use it if you need to call
24710 libraries compiled with the Unix compiler.
24712 Also, you must provide function prototypes for all functions that
24713 take variable numbers of arguments (including @code{printf});
24714 otherwise incorrect code is generated for calls to those
24715 functions.
24717 In addition, seriously incorrect code results if you call a
24718 function with too many arguments.  (Normally, extra arguments are
24719 harmlessly ignored.)
24721 @item -mregparm=@var{num}
24722 @opindex mregparm
24723 Control how many registers are used to pass integer arguments.  By
24724 default, no registers are used to pass arguments, and at most 3
24725 registers can be used.  You can control this behavior for a specific
24726 function by using the function attribute @code{regparm}.
24727 @xref{Function Attributes}.
24729 @strong{Warning:} if you use this switch, and
24730 @var{num} is nonzero, then you must build all modules with the same
24731 value, including any libraries.  This includes the system libraries and
24732 startup modules.
24734 @item -msseregparm
24735 @opindex msseregparm
24736 Use SSE register passing conventions for float and double arguments
24737 and return values.  You can control this behavior for a specific
24738 function by using the function attribute @code{sseregparm}.
24739 @xref{Function Attributes}.
24741 @strong{Warning:} if you use this switch then you must build all
24742 modules with the same value, including any libraries.  This includes
24743 the system libraries and startup modules.
24745 @item -mvect8-ret-in-mem
24746 @opindex mvect8-ret-in-mem
24747 Return 8-byte vectors in memory instead of MMX registers.  This is the
24748 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
24749 Studio compilers until version 12.  Later compiler versions (starting
24750 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
24751 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
24752 you need to remain compatible with existing code produced by those
24753 previous compiler versions or older versions of GCC@.
24755 @item -mpc32
24756 @itemx -mpc64
24757 @itemx -mpc80
24758 @opindex mpc32
24759 @opindex mpc64
24760 @opindex mpc80
24762 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
24763 is specified, the significands of results of floating-point operations are
24764 rounded to 24 bits (single precision); @option{-mpc64} rounds the
24765 significands of results of floating-point operations to 53 bits (double
24766 precision) and @option{-mpc80} rounds the significands of results of
24767 floating-point operations to 64 bits (extended double precision), which is
24768 the default.  When this option is used, floating-point operations in higher
24769 precisions are not available to the programmer without setting the FPU
24770 control word explicitly.
24772 Setting the rounding of floating-point operations to less than the default
24773 80 bits can speed some programs by 2% or more.  Note that some mathematical
24774 libraries assume that extended-precision (80-bit) floating-point operations
24775 are enabled by default; routines in such libraries could suffer significant
24776 loss of accuracy, typically through so-called ``catastrophic cancellation'',
24777 when this option is used to set the precision to less than extended precision.
24779 @item -mstackrealign
24780 @opindex mstackrealign
24781 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
24782 option generates an alternate prologue and epilogue that realigns the
24783 run-time stack if necessary.  This supports mixing legacy codes that keep
24784 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
24785 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
24786 applicable to individual functions.
24788 @item -mpreferred-stack-boundary=@var{num}
24789 @opindex mpreferred-stack-boundary
24790 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
24791 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
24792 the default is 4 (16 bytes or 128 bits).
24794 @strong{Warning:} When generating code for the x86-64 architecture with
24795 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
24796 used to keep the stack boundary aligned to 8 byte boundary.  Since
24797 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
24798 intended to be used in controlled environment where stack space is
24799 important limitation.  This option leads to wrong code when functions
24800 compiled with 16 byte stack alignment (such as functions from a standard
24801 library) are called with misaligned stack.  In this case, SSE
24802 instructions may lead to misaligned memory access traps.  In addition,
24803 variable arguments are handled incorrectly for 16 byte aligned
24804 objects (including x87 long double and __int128), leading to wrong
24805 results.  You must build all modules with
24806 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
24807 includes the system libraries and startup modules.
24809 @item -mincoming-stack-boundary=@var{num}
24810 @opindex mincoming-stack-boundary
24811 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
24812 boundary.  If @option{-mincoming-stack-boundary} is not specified,
24813 the one specified by @option{-mpreferred-stack-boundary} is used.
24815 On Pentium and Pentium Pro, @code{double} and @code{long double} values
24816 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
24817 suffer significant run time performance penalties.  On Pentium III, the
24818 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
24819 properly if it is not 16-byte aligned.
24821 To ensure proper alignment of this values on the stack, the stack boundary
24822 must be as aligned as that required by any value stored on the stack.
24823 Further, every function must be generated such that it keeps the stack
24824 aligned.  Thus calling a function compiled with a higher preferred
24825 stack boundary from a function compiled with a lower preferred stack
24826 boundary most likely misaligns the stack.  It is recommended that
24827 libraries that use callbacks always use the default setting.
24829 This extra alignment does consume extra stack space, and generally
24830 increases code size.  Code that is sensitive to stack space usage, such
24831 as embedded systems and operating system kernels, may want to reduce the
24832 preferred alignment to @option{-mpreferred-stack-boundary=2}.
24834 @need 200
24835 @item -mmmx
24836 @opindex mmmx
24837 @need 200
24838 @itemx -msse
24839 @opindex msse
24840 @need 200
24841 @itemx -msse2
24842 @opindex msse2
24843 @need 200
24844 @itemx -msse3
24845 @opindex msse3
24846 @need 200
24847 @itemx -mssse3
24848 @opindex mssse3
24849 @need 200
24850 @itemx -msse4
24851 @opindex msse4
24852 @need 200
24853 @itemx -msse4a
24854 @opindex msse4a
24855 @need 200
24856 @itemx -msse4.1
24857 @opindex msse4.1
24858 @need 200
24859 @itemx -msse4.2
24860 @opindex msse4.2
24861 @need 200
24862 @itemx -mavx
24863 @opindex mavx
24864 @need 200
24865 @itemx -mavx2
24866 @opindex mavx2
24867 @need 200
24868 @itemx -mavx512f
24869 @opindex mavx512f
24870 @need 200
24871 @itemx -mavx512pf
24872 @opindex mavx512pf
24873 @need 200
24874 @itemx -mavx512er
24875 @opindex mavx512er
24876 @need 200
24877 @itemx -mavx512cd
24878 @opindex mavx512cd
24879 @need 200
24880 @itemx -mavx512vl
24881 @opindex mavx512vl
24882 @need 200
24883 @itemx -mavx512bw
24884 @opindex mavx512bw
24885 @need 200
24886 @itemx -mavx512dq
24887 @opindex mavx512dq
24888 @need 200
24889 @itemx -mavx512ifma
24890 @opindex mavx512ifma
24891 @need 200
24892 @itemx -mavx512vbmi
24893 @opindex mavx512vbmi
24894 @need 200
24895 @itemx -msha
24896 @opindex msha
24897 @need 200
24898 @itemx -maes
24899 @opindex maes
24900 @need 200
24901 @itemx -mpclmul
24902 @opindex mpclmul
24903 @need 200
24904 @itemx -mclfushopt
24905 @opindex mclfushopt
24906 @need 200
24907 @itemx -mfsgsbase
24908 @opindex mfsgsbase
24909 @need 200
24910 @itemx -mrdrnd
24911 @opindex mrdrnd
24912 @need 200
24913 @itemx -mf16c
24914 @opindex mf16c
24915 @need 200
24916 @itemx -mfma
24917 @opindex mfma
24918 @need 200
24919 @itemx -mfma4
24920 @opindex mfma4
24921 @need 200
24922 @itemx -mprefetchwt1
24923 @opindex mprefetchwt1
24924 @need 200
24925 @itemx -mxop
24926 @opindex mxop
24927 @need 200
24928 @itemx -mlwp
24929 @opindex mlwp
24930 @need 200
24931 @itemx -m3dnow
24932 @opindex m3dnow
24933 @need 200
24934 @itemx -mpopcnt
24935 @opindex mpopcnt
24936 @need 200
24937 @itemx -mabm
24938 @opindex mabm
24939 @need 200
24940 @itemx -mbmi
24941 @opindex mbmi
24942 @need 200
24943 @itemx -mbmi2
24944 @need 200
24945 @itemx -mlzcnt
24946 @opindex mlzcnt
24947 @need 200
24948 @itemx -mfxsr
24949 @opindex mfxsr
24950 @need 200
24951 @itemx -mxsave
24952 @opindex mxsave
24953 @need 200
24954 @itemx -mxsaveopt
24955 @opindex mxsaveopt
24956 @need 200
24957 @itemx -mxsavec
24958 @opindex mxsavec
24959 @need 200
24960 @itemx -mxsaves
24961 @opindex mxsaves
24962 @need 200
24963 @itemx -mrtm
24964 @opindex mrtm
24965 @need 200
24966 @itemx -mtbm
24967 @opindex mtbm
24968 @need 200
24969 @itemx -mmpx
24970 @opindex mmpx
24971 @need 200
24972 @itemx -mmwaitx
24973 @opindex mmwaitx
24974 @need 200
24975 @itemx -mclzero
24976 @opindex mclzero
24977 @itemx -mpku
24978 @opindex mpku
24979 These switches enable the use of instructions in the MMX, SSE,
24980 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
24981 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
24982 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
24983 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU or 3DNow!@:
24984 extended instruction sets.  Each has a corresponding @option{-mno-} option
24985 to disable use of these instructions.
24987 These extensions are also available as built-in functions: see
24988 @ref{x86 Built-in Functions}, for details of the functions enabled and
24989 disabled by these switches.
24991 To generate SSE/SSE2 instructions automatically from floating-point
24992 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
24994 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
24995 generates new AVX instructions or AVX equivalence for all SSEx instructions
24996 when needed.
24998 These options enable GCC to use these extended instructions in
24999 generated code, even without @option{-mfpmath=sse}.  Applications that
25000 perform run-time CPU detection must compile separate files for each
25001 supported architecture, using the appropriate flags.  In particular,
25002 the file containing the CPU detection code should be compiled without
25003 these options.
25005 @item -mdump-tune-features
25006 @opindex mdump-tune-features
25007 This option instructs GCC to dump the names of the x86 performance 
25008 tuning features and default settings. The names can be used in 
25009 @option{-mtune-ctrl=@var{feature-list}}.
25011 @item -mtune-ctrl=@var{feature-list}
25012 @opindex mtune-ctrl=@var{feature-list}
25013 This option is used to do fine grain control of x86 code generation features.
25014 @var{feature-list} is a comma separated list of @var{feature} names. See also
25015 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25016 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25017 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25018 developers. Using it may lead to code paths not covered by testing and can
25019 potentially result in compiler ICEs or runtime errors.
25021 @item -mno-default
25022 @opindex mno-default
25023 This option instructs GCC to turn off all tunable features. See also 
25024 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25026 @item -mcld
25027 @opindex mcld
25028 This option instructs GCC to emit a @code{cld} instruction in the prologue
25029 of functions that use string instructions.  String instructions depend on
25030 the DF flag to select between autoincrement or autodecrement mode.  While the
25031 ABI specifies the DF flag to be cleared on function entry, some operating
25032 systems violate this specification by not clearing the DF flag in their
25033 exception dispatchers.  The exception handler can be invoked with the DF flag
25034 set, which leads to wrong direction mode when string instructions are used.
25035 This option can be enabled by default on 32-bit x86 targets by configuring
25036 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25037 instructions can be suppressed with the @option{-mno-cld} compiler option
25038 in this case.
25040 @item -mvzeroupper
25041 @opindex mvzeroupper
25042 This option instructs GCC to emit a @code{vzeroupper} instruction
25043 before a transfer of control flow out of the function to minimize
25044 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25045 intrinsics.
25047 @item -mprefer-avx128
25048 @opindex mprefer-avx128
25049 This option instructs GCC to use 128-bit AVX instructions instead of
25050 256-bit AVX instructions in the auto-vectorizer.
25052 @item -mcx16
25053 @opindex mcx16
25054 This option enables GCC to generate @code{CMPXCHG16B} instructions.
25055 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
25056 (or oword) data types.  
25057 This is useful for high-resolution counters that can be updated
25058 by multiple processors (or cores).  This instruction is generated as part of
25059 atomic built-in functions: see @ref{__sync Builtins} or
25060 @ref{__atomic Builtins} for details.
25062 @item -msahf
25063 @opindex msahf
25064 This option enables generation of @code{SAHF} instructions in 64-bit code.
25065 Early Intel Pentium 4 CPUs with Intel 64 support,
25066 prior to the introduction of Pentium 4 G1 step in December 2005,
25067 lacked the @code{LAHF} and @code{SAHF} instructions
25068 which are supported by AMD64.
25069 These are load and store instructions, respectively, for certain status flags.
25070 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25071 @code{drem}, and @code{remainder} built-in functions;
25072 see @ref{Other Builtins} for details.
25074 @item -mmovbe
25075 @opindex mmovbe
25076 This option enables use of the @code{movbe} instruction to implement
25077 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25079 @item -mcrc32
25080 @opindex mcrc32
25081 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25082 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25083 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25085 @item -mrecip
25086 @opindex mrecip
25087 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25088 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25089 with an additional Newton-Raphson step
25090 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25091 (and their vectorized
25092 variants) for single-precision floating-point arguments.  These instructions
25093 are generated only when @option{-funsafe-math-optimizations} is enabled
25094 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25095 Note that while the throughput of the sequence is higher than the throughput
25096 of the non-reciprocal instruction, the precision of the sequence can be
25097 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25099 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25100 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25101 combination), and doesn't need @option{-mrecip}.
25103 Also note that GCC emits the above sequence with additional Newton-Raphson step
25104 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25105 already with @option{-ffast-math} (or the above option combination), and
25106 doesn't need @option{-mrecip}.
25108 @item -mrecip=@var{opt}
25109 @opindex mrecip=opt
25110 This option controls which reciprocal estimate instructions
25111 may be used.  @var{opt} is a comma-separated list of options, which may
25112 be preceded by a @samp{!} to invert the option:
25114 @table @samp
25115 @item all
25116 Enable all estimate instructions.
25118 @item default
25119 Enable the default instructions, equivalent to @option{-mrecip}.
25121 @item none
25122 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25124 @item div
25125 Enable the approximation for scalar division.
25127 @item vec-div
25128 Enable the approximation for vectorized division.
25130 @item sqrt
25131 Enable the approximation for scalar square root.
25133 @item vec-sqrt
25134 Enable the approximation for vectorized square root.
25135 @end table
25137 So, for example, @option{-mrecip=all,!sqrt} enables
25138 all of the reciprocal approximations, except for square root.
25140 @item -mveclibabi=@var{type}
25141 @opindex mveclibabi
25142 Specifies the ABI type to use for vectorizing intrinsics using an
25143 external library.  Supported values for @var{type} are @samp{svml} 
25144 for the Intel short
25145 vector math library and @samp{acml} for the AMD math core library.
25146 To use this option, both @option{-ftree-vectorize} and
25147 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25148 ABI-compatible library must be specified at link time.
25150 GCC currently emits calls to @code{vmldExp2},
25151 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25152 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25153 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25154 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25155 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25156 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25157 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25158 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25159 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25160 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25161 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25162 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25163 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25164 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25165 when @option{-mveclibabi=acml} is used.  
25167 @item -mabi=@var{name}
25168 @opindex mabi
25169 Generate code for the specified calling convention.  Permissible values
25170 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25171 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25172 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25173 You can control this behavior for specific functions by
25174 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25175 @xref{Function Attributes}.
25177 @item -mtls-dialect=@var{type}
25178 @opindex mtls-dialect
25179 Generate code to access thread-local storage using the @samp{gnu} or
25180 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25181 @samp{gnu2} is more efficient, but it may add compile- and run-time
25182 requirements that cannot be satisfied on all systems.
25184 @item -mpush-args
25185 @itemx -mno-push-args
25186 @opindex mpush-args
25187 @opindex mno-push-args
25188 Use PUSH operations to store outgoing parameters.  This method is shorter
25189 and usually equally fast as method using SUB/MOV operations and is enabled
25190 by default.  In some cases disabling it may improve performance because of
25191 improved scheduling and reduced dependencies.
25193 @item -maccumulate-outgoing-args
25194 @opindex maccumulate-outgoing-args
25195 If enabled, the maximum amount of space required for outgoing arguments is
25196 computed in the function prologue.  This is faster on most modern CPUs
25197 because of reduced dependencies, improved scheduling and reduced stack usage
25198 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25199 increase in code size.  This switch implies @option{-mno-push-args}.
25201 @item -mthreads
25202 @opindex mthreads
25203 Support thread-safe exception handling on MinGW.  Programs that rely
25204 on thread-safe exception handling must compile and link all code with the
25205 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25206 @option{-D_MT}; when linking, it links in a special thread helper library
25207 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25209 @item -mms-bitfields
25210 @itemx -mno-ms-bitfields
25211 @opindex mms-bitfields
25212 @opindex mno-ms-bitfields
25214 Enable/disable bit-field layout compatible with the native Microsoft
25215 Windows compiler.  
25217 If @code{packed} is used on a structure, or if bit-fields are used,
25218 it may be that the Microsoft ABI lays out the structure differently
25219 than the way GCC normally does.  Particularly when moving packed
25220 data between functions compiled with GCC and the native Microsoft compiler
25221 (either via function call or as data in a file), it may be necessary to access
25222 either format.
25224 This option is enabled by default for Microsoft Windows
25225 targets.  This behavior can also be controlled locally by use of variable
25226 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25227 and @ref{x86 Type Attributes}.
25229 The Microsoft structure layout algorithm is fairly simple with the exception
25230 of the bit-field packing.  
25231 The padding and alignment of members of structures and whether a bit-field 
25232 can straddle a storage-unit boundary are determine by these rules:
25234 @enumerate
25235 @item Structure members are stored sequentially in the order in which they are
25236 declared: the first member has the lowest memory address and the last member
25237 the highest.
25239 @item Every data object has an alignment requirement.  The alignment requirement
25240 for all data except structures, unions, and arrays is either the size of the
25241 object or the current packing size (specified with either the
25242 @code{aligned} attribute or the @code{pack} pragma),
25243 whichever is less.  For structures, unions, and arrays,
25244 the alignment requirement is the largest alignment requirement of its members.
25245 Every object is allocated an offset so that:
25247 @smallexample
25248 offset % alignment_requirement == 0
25249 @end smallexample
25251 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25252 unit if the integral types are the same size and if the next bit-field fits
25253 into the current allocation unit without crossing the boundary imposed by the
25254 common alignment requirements of the bit-fields.
25255 @end enumerate
25257 MSVC interprets zero-length bit-fields in the following ways:
25259 @enumerate
25260 @item If a zero-length bit-field is inserted between two bit-fields that
25261 are normally coalesced, the bit-fields are not coalesced.
25263 For example:
25265 @smallexample
25266 struct
25267  @{
25268    unsigned long bf_1 : 12;
25269    unsigned long : 0;
25270    unsigned long bf_2 : 12;
25271  @} t1;
25272 @end smallexample
25274 @noindent
25275 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25276 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25278 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25279 alignment of the zero-length bit-field is greater than the member that follows it,
25280 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25282 For example:
25284 @smallexample
25285 struct
25286  @{
25287    char foo : 4;
25288    short : 0;
25289    char bar;
25290  @} t2;
25292 struct
25293  @{
25294    char foo : 4;
25295    short : 0;
25296    double bar;
25297  @} t3;
25298 @end smallexample
25300 @noindent
25301 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25302 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25303 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25304 of the structure.
25306 Taking this into account, it is important to note the following:
25308 @enumerate
25309 @item If a zero-length bit-field follows a normal bit-field, the type of the
25310 zero-length bit-field may affect the alignment of the structure as whole. For
25311 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25312 normal bit-field, and is of type short.
25314 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25315 still affect the alignment of the structure:
25317 @smallexample
25318 struct
25319  @{
25320    char foo : 6;
25321    long : 0;
25322  @} t4;
25323 @end smallexample
25325 @noindent
25326 Here, @code{t4} takes up 4 bytes.
25327 @end enumerate
25329 @item Zero-length bit-fields following non-bit-field members are ignored:
25331 @smallexample
25332 struct
25333  @{
25334    char foo;
25335    long : 0;
25336    char bar;
25337  @} t5;
25338 @end smallexample
25340 @noindent
25341 Here, @code{t5} takes up 2 bytes.
25342 @end enumerate
25345 @item -mno-align-stringops
25346 @opindex mno-align-stringops
25347 Do not align the destination of inlined string operations.  This switch reduces
25348 code size and improves performance in case the destination is already aligned,
25349 but GCC doesn't know about it.
25351 @item -minline-all-stringops
25352 @opindex minline-all-stringops
25353 By default GCC inlines string operations only when the destination is 
25354 known to be aligned to least a 4-byte boundary.  
25355 This enables more inlining and increases code
25356 size, but may improve performance of code that depends on fast
25357 @code{memcpy}, @code{strlen},
25358 and @code{memset} for short lengths.
25360 @item -minline-stringops-dynamically
25361 @opindex minline-stringops-dynamically
25362 For string operations of unknown size, use run-time checks with
25363 inline code for small blocks and a library call for large blocks.
25365 @item -mstringop-strategy=@var{alg}
25366 @opindex mstringop-strategy=@var{alg}
25367 Override the internal decision heuristic for the particular algorithm to use
25368 for inlining string operations.  The allowed values for @var{alg} are:
25370 @table @samp
25371 @item rep_byte
25372 @itemx rep_4byte
25373 @itemx rep_8byte
25374 Expand using i386 @code{rep} prefix of the specified size.
25376 @item byte_loop
25377 @itemx loop
25378 @itemx unrolled_loop
25379 Expand into an inline loop.
25381 @item libcall
25382 Always use a library call.
25383 @end table
25385 @item -mmemcpy-strategy=@var{strategy}
25386 @opindex mmemcpy-strategy=@var{strategy}
25387 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25388 should be inlined and what inline algorithm to use when the expected size
25389 of the copy operation is known. @var{strategy} 
25390 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25391 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25392 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25393 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25394 in the list must be specified in increasing order.  The minimal byte size for 
25395 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25396 preceding range.
25398 @item -mmemset-strategy=@var{strategy}
25399 @opindex mmemset-strategy=@var{strategy}
25400 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25401 @code{__builtin_memset} expansion.
25403 @item -momit-leaf-frame-pointer
25404 @opindex momit-leaf-frame-pointer
25405 Don't keep the frame pointer in a register for leaf functions.  This
25406 avoids the instructions to save, set up, and restore frame pointers and
25407 makes an extra register available in leaf functions.  The option
25408 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25409 which might make debugging harder.
25411 @item -mtls-direct-seg-refs
25412 @itemx -mno-tls-direct-seg-refs
25413 @opindex mtls-direct-seg-refs
25414 Controls whether TLS variables may be accessed with offsets from the
25415 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25416 or whether the thread base pointer must be added.  Whether or not this
25417 is valid depends on the operating system, and whether it maps the
25418 segment to cover the entire TLS area.
25420 For systems that use the GNU C Library, the default is on.
25422 @item -msse2avx
25423 @itemx -mno-sse2avx
25424 @opindex msse2avx
25425 Specify that the assembler should encode SSE instructions with VEX
25426 prefix.  The option @option{-mavx} turns this on by default.
25428 @item -mfentry
25429 @itemx -mno-fentry
25430 @opindex mfentry
25431 If profiling is active (@option{-pg}), put the profiling
25432 counter call before the prologue.
25433 Note: On x86 architectures the attribute @code{ms_hook_prologue}
25434 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
25436 @item -mrecord-mcount
25437 @itemx -mno-record-mcount
25438 @opindex mrecord-mcount
25439 If profiling is active (@option{-pg}), generate a __mcount_loc section
25440 that contains pointers to each profiling call. This is useful for
25441 automatically patching and out calls.
25443 @item -mnop-mcount
25444 @itemx -mno-nop-mcount
25445 @opindex mnop-mcount
25446 If profiling is active (@option{-pg}), generate the calls to
25447 the profiling functions as NOPs. This is useful when they
25448 should be patched in later dynamically. This is likely only
25449 useful together with @option{-mrecord-mcount}.
25451 @item -mskip-rax-setup
25452 @itemx -mno-skip-rax-setup
25453 @opindex mskip-rax-setup
25454 When generating code for the x86-64 architecture with SSE extensions
25455 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
25456 register when there are no variable arguments passed in vector registers.
25458 @strong{Warning:} Since RAX register is used to avoid unnecessarily
25459 saving vector registers on stack when passing variable arguments, the
25460 impacts of this option are callees may waste some stack space,
25461 misbehave or jump to a random location.  GCC 4.4 or newer don't have
25462 those issues, regardless the RAX register value.
25464 @item -m8bit-idiv
25465 @itemx -mno-8bit-idiv
25466 @opindex m8bit-idiv
25467 On some processors, like Intel Atom, 8-bit unsigned integer divide is
25468 much faster than 32-bit/64-bit integer divide.  This option generates a
25469 run-time check.  If both dividend and divisor are within range of 0
25470 to 255, 8-bit unsigned integer divide is used instead of
25471 32-bit/64-bit integer divide.
25473 @item -mavx256-split-unaligned-load
25474 @itemx -mavx256-split-unaligned-store
25475 @opindex mavx256-split-unaligned-load
25476 @opindex mavx256-split-unaligned-store
25477 Split 32-byte AVX unaligned load and store.
25479 @item -mstack-protector-guard=@var{guard}
25480 @opindex mstack-protector-guard=@var{guard}
25481 Generate stack protection code using canary at @var{guard}.  Supported
25482 locations are @samp{global} for global canary or @samp{tls} for per-thread
25483 canary in the TLS block (the default).  This option has effect only when
25484 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
25486 @item -mmitigate-rop
25487 @opindex mmitigate-rop
25488 Try to avoid generating code sequences that contain unintended return
25489 opcodes, to mitigate against certain forms of attack. At the moment,
25490 this option is limited in what it can do and should not be relied
25491 on to provide serious protection.
25493 @item -mgeneral-regs-only
25494 @opindex mgeneral-regs-only
25495 Generate code that uses only the general-purpose registers.  This
25496 prevents the compiler from using floating-point, vector, mask and bound
25497 registers.
25499 @end table
25501 These @samp{-m} switches are supported in addition to the above
25502 on x86-64 processors in 64-bit environments.
25504 @table @gcctabopt
25505 @item -m32
25506 @itemx -m64
25507 @itemx -mx32
25508 @itemx -m16
25509 @itemx -miamcu
25510 @opindex m32
25511 @opindex m64
25512 @opindex mx32
25513 @opindex m16
25514 @opindex miamcu
25515 Generate code for a 16-bit, 32-bit or 64-bit environment.
25516 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
25517 to 32 bits, and
25518 generates code that runs on any i386 system.
25520 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
25521 types to 64 bits, and generates code for the x86-64 architecture.
25522 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
25523 and @option{-mdynamic-no-pic} options.
25525 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
25526 to 32 bits, and
25527 generates code for the x86-64 architecture.
25529 The @option{-m16} option is the same as @option{-m32}, except for that
25530 it outputs the @code{.code16gcc} assembly directive at the beginning of
25531 the assembly output so that the binary can run in 16-bit mode.
25533 The @option{-miamcu} option generates code which conforms to Intel MCU
25534 psABI.  It requires the @option{-m32} option to be turned on.
25536 @item -mno-red-zone
25537 @opindex mno-red-zone
25538 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
25539 by the x86-64 ABI; it is a 128-byte area beyond the location of the
25540 stack pointer that is not modified by signal or interrupt handlers
25541 and therefore can be used for temporary data without adjusting the stack
25542 pointer.  The flag @option{-mno-red-zone} disables this red zone.
25544 @item -mcmodel=small
25545 @opindex mcmodel=small
25546 Generate code for the small code model: the program and its symbols must
25547 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
25548 Programs can be statically or dynamically linked.  This is the default
25549 code model.
25551 @item -mcmodel=kernel
25552 @opindex mcmodel=kernel
25553 Generate code for the kernel code model.  The kernel runs in the
25554 negative 2 GB of the address space.
25555 This model has to be used for Linux kernel code.
25557 @item -mcmodel=medium
25558 @opindex mcmodel=medium
25559 Generate code for the medium model: the program is linked in the lower 2
25560 GB of the address space.  Small symbols are also placed there.  Symbols
25561 with sizes larger than @option{-mlarge-data-threshold} are put into
25562 large data or BSS sections and can be located above 2GB.  Programs can
25563 be statically or dynamically linked.
25565 @item -mcmodel=large
25566 @opindex mcmodel=large
25567 Generate code for the large model.  This model makes no assumptions
25568 about addresses and sizes of sections.
25570 @item -maddress-mode=long
25571 @opindex maddress-mode=long
25572 Generate code for long address mode.  This is only supported for 64-bit
25573 and x32 environments.  It is the default address mode for 64-bit
25574 environments.
25576 @item -maddress-mode=short
25577 @opindex maddress-mode=short
25578 Generate code for short address mode.  This is only supported for 32-bit
25579 and x32 environments.  It is the default address mode for 32-bit and
25580 x32 environments.
25581 @end table
25583 @node x86 Windows Options
25584 @subsection x86 Windows Options
25585 @cindex x86 Windows Options
25586 @cindex Windows Options for x86
25588 These additional options are available for Microsoft Windows targets:
25590 @table @gcctabopt
25591 @item -mconsole
25592 @opindex mconsole
25593 This option
25594 specifies that a console application is to be generated, by
25595 instructing the linker to set the PE header subsystem type
25596 required for console applications.
25597 This option is available for Cygwin and MinGW targets and is
25598 enabled by default on those targets.
25600 @item -mdll
25601 @opindex mdll
25602 This option is available for Cygwin and MinGW targets.  It
25603 specifies that a DLL---a dynamic link library---is to be
25604 generated, enabling the selection of the required runtime
25605 startup object and entry point.
25607 @item -mnop-fun-dllimport
25608 @opindex mnop-fun-dllimport
25609 This option is available for Cygwin and MinGW targets.  It
25610 specifies that the @code{dllimport} attribute should be ignored.
25612 @item -mthread
25613 @opindex mthread
25614 This option is available for MinGW targets. It specifies
25615 that MinGW-specific thread support is to be used.
25617 @item -municode
25618 @opindex municode
25619 This option is available for MinGW-w64 targets.  It causes
25620 the @code{UNICODE} preprocessor macro to be predefined, and
25621 chooses Unicode-capable runtime startup code.
25623 @item -mwin32
25624 @opindex mwin32
25625 This option is available for Cygwin and MinGW targets.  It
25626 specifies that the typical Microsoft Windows predefined macros are to
25627 be set in the pre-processor, but does not influence the choice
25628 of runtime library/startup code.
25630 @item -mwindows
25631 @opindex mwindows
25632 This option is available for Cygwin and MinGW targets.  It
25633 specifies that a GUI application is to be generated by
25634 instructing the linker to set the PE header subsystem type
25635 appropriately.
25637 @item -fno-set-stack-executable
25638 @opindex fno-set-stack-executable
25639 This option is available for MinGW targets. It specifies that
25640 the executable flag for the stack used by nested functions isn't
25641 set. This is necessary for binaries running in kernel mode of
25642 Microsoft Windows, as there the User32 API, which is used to set executable
25643 privileges, isn't available.
25645 @item -fwritable-relocated-rdata
25646 @opindex fno-writable-relocated-rdata
25647 This option is available for MinGW and Cygwin targets.  It specifies
25648 that relocated-data in read-only section is put into the @code{.data}
25649 section.  This is a necessary for older runtimes not supporting
25650 modification of @code{.rdata} sections for pseudo-relocation.
25652 @item -mpe-aligned-commons
25653 @opindex mpe-aligned-commons
25654 This option is available for Cygwin and MinGW targets.  It
25655 specifies that the GNU extension to the PE file format that
25656 permits the correct alignment of COMMON variables should be
25657 used when generating code.  It is enabled by default if
25658 GCC detects that the target assembler found during configuration
25659 supports the feature.
25660 @end table
25662 See also under @ref{x86 Options} for standard options.
25664 @node Xstormy16 Options
25665 @subsection Xstormy16 Options
25666 @cindex Xstormy16 Options
25668 These options are defined for Xstormy16:
25670 @table @gcctabopt
25671 @item -msim
25672 @opindex msim
25673 Choose startup files and linker script suitable for the simulator.
25674 @end table
25676 @node Xtensa Options
25677 @subsection Xtensa Options
25678 @cindex Xtensa Options
25680 These options are supported for Xtensa targets:
25682 @table @gcctabopt
25683 @item -mconst16
25684 @itemx -mno-const16
25685 @opindex mconst16
25686 @opindex mno-const16
25687 Enable or disable use of @code{CONST16} instructions for loading
25688 constant values.  The @code{CONST16} instruction is currently not a
25689 standard option from Tensilica.  When enabled, @code{CONST16}
25690 instructions are always used in place of the standard @code{L32R}
25691 instructions.  The use of @code{CONST16} is enabled by default only if
25692 the @code{L32R} instruction is not available.
25694 @item -mfused-madd
25695 @itemx -mno-fused-madd
25696 @opindex mfused-madd
25697 @opindex mno-fused-madd
25698 Enable or disable use of fused multiply/add and multiply/subtract
25699 instructions in the floating-point option.  This has no effect if the
25700 floating-point option is not also enabled.  Disabling fused multiply/add
25701 and multiply/subtract instructions forces the compiler to use separate
25702 instructions for the multiply and add/subtract operations.  This may be
25703 desirable in some cases where strict IEEE 754-compliant results are
25704 required: the fused multiply add/subtract instructions do not round the
25705 intermediate result, thereby producing results with @emph{more} bits of
25706 precision than specified by the IEEE standard.  Disabling fused multiply
25707 add/subtract instructions also ensures that the program output is not
25708 sensitive to the compiler's ability to combine multiply and add/subtract
25709 operations.
25711 @item -mserialize-volatile
25712 @itemx -mno-serialize-volatile
25713 @opindex mserialize-volatile
25714 @opindex mno-serialize-volatile
25715 When this option is enabled, GCC inserts @code{MEMW} instructions before
25716 @code{volatile} memory references to guarantee sequential consistency.
25717 The default is @option{-mserialize-volatile}.  Use
25718 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
25720 @item -mforce-no-pic
25721 @opindex mforce-no-pic
25722 For targets, like GNU/Linux, where all user-mode Xtensa code must be
25723 position-independent code (PIC), this option disables PIC for compiling
25724 kernel code.
25726 @item -mtext-section-literals
25727 @itemx -mno-text-section-literals
25728 @opindex mtext-section-literals
25729 @opindex mno-text-section-literals
25730 These options control the treatment of literal pools.  The default is
25731 @option{-mno-text-section-literals}, which places literals in a separate
25732 section in the output file.  This allows the literal pool to be placed
25733 in a data RAM/ROM, and it also allows the linker to combine literal
25734 pools from separate object files to remove redundant literals and
25735 improve code size.  With @option{-mtext-section-literals}, the literals
25736 are interspersed in the text section in order to keep them as close as
25737 possible to their references.  This may be necessary for large assembly
25738 files.  Literals for each function are placed right before that function.
25740 @item -mauto-litpools
25741 @itemx -mno-auto-litpools
25742 @opindex mauto-litpools
25743 @opindex mno-auto-litpools
25744 These options control the treatment of literal pools.  The default is
25745 @option{-mno-auto-litpools}, which places literals in a separate
25746 section in the output file unless @option{-mtext-section-literals} is
25747 used.  With @option{-mauto-litpools} the literals are interspersed in
25748 the text section by the assembler.  Compiler does not produce explicit
25749 @code{.literal} directives and loads literals into registers with
25750 @code{MOVI} instructions instead of @code{L32R} to let the assembler
25751 do relaxation and place literals as necessary.  This option allows
25752 assembler to create several literal pools per function and assemble
25753 very big functions, which may not be possible with
25754 @option{-mtext-section-literals}.
25756 @item -mtarget-align
25757 @itemx -mno-target-align
25758 @opindex mtarget-align
25759 @opindex mno-target-align
25760 When this option is enabled, GCC instructs the assembler to
25761 automatically align instructions to reduce branch penalties at the
25762 expense of some code density.  The assembler attempts to widen density
25763 instructions to align branch targets and the instructions following call
25764 instructions.  If there are not enough preceding safe density
25765 instructions to align a target, no widening is performed.  The
25766 default is @option{-mtarget-align}.  These options do not affect the
25767 treatment of auto-aligned instructions like @code{LOOP}, which the
25768 assembler always aligns, either by widening density instructions or
25769 by inserting NOP instructions.
25771 @item -mlongcalls
25772 @itemx -mno-longcalls
25773 @opindex mlongcalls
25774 @opindex mno-longcalls
25775 When this option is enabled, GCC instructs the assembler to translate
25776 direct calls to indirect calls unless it can determine that the target
25777 of a direct call is in the range allowed by the call instruction.  This
25778 translation typically occurs for calls to functions in other source
25779 files.  Specifically, the assembler translates a direct @code{CALL}
25780 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
25781 The default is @option{-mno-longcalls}.  This option should be used in
25782 programs where the call target can potentially be out of range.  This
25783 option is implemented in the assembler, not the compiler, so the
25784 assembly code generated by GCC still shows direct call
25785 instructions---look at the disassembled object code to see the actual
25786 instructions.  Note that the assembler uses an indirect call for
25787 every cross-file call, not just those that really are out of range.
25788 @end table
25790 @node zSeries Options
25791 @subsection zSeries Options
25792 @cindex zSeries options
25794 These are listed under @xref{S/390 and zSeries Options}.
25797 @c man end
25799 @node Spec Files
25800 @section Specifying Subprocesses and the Switches to Pass to Them
25801 @cindex Spec Files
25803 @command{gcc} is a driver program.  It performs its job by invoking a
25804 sequence of other programs to do the work of compiling, assembling and
25805 linking.  GCC interprets its command-line parameters and uses these to
25806 deduce which programs it should invoke, and which command-line options
25807 it ought to place on their command lines.  This behavior is controlled
25808 by @dfn{spec strings}.  In most cases there is one spec string for each
25809 program that GCC can invoke, but a few programs have multiple spec
25810 strings to control their behavior.  The spec strings built into GCC can
25811 be overridden by using the @option{-specs=} command-line switch to specify
25812 a spec file.
25814 @dfn{Spec files} are plain-text files that are used to construct spec
25815 strings.  They consist of a sequence of directives separated by blank
25816 lines.  The type of directive is determined by the first non-whitespace
25817 character on the line, which can be one of the following:
25819 @table @code
25820 @item %@var{command}
25821 Issues a @var{command} to the spec file processor.  The commands that can
25822 appear here are:
25824 @table @code
25825 @item %include <@var{file}>
25826 @cindex @code{%include}
25827 Search for @var{file} and insert its text at the current point in the
25828 specs file.
25830 @item %include_noerr <@var{file}>
25831 @cindex @code{%include_noerr}
25832 Just like @samp{%include}, but do not generate an error message if the include
25833 file cannot be found.
25835 @item %rename @var{old_name} @var{new_name}
25836 @cindex @code{%rename}
25837 Rename the spec string @var{old_name} to @var{new_name}.
25839 @end table
25841 @item *[@var{spec_name}]:
25842 This tells the compiler to create, override or delete the named spec
25843 string.  All lines after this directive up to the next directive or
25844 blank line are considered to be the text for the spec string.  If this
25845 results in an empty string then the spec is deleted.  (Or, if the
25846 spec did not exist, then nothing happens.)  Otherwise, if the spec
25847 does not currently exist a new spec is created.  If the spec does
25848 exist then its contents are overridden by the text of this
25849 directive, unless the first character of that text is the @samp{+}
25850 character, in which case the text is appended to the spec.
25852 @item [@var{suffix}]:
25853 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
25854 and up to the next directive or blank line are considered to make up the
25855 spec string for the indicated suffix.  When the compiler encounters an
25856 input file with the named suffix, it processes the spec string in
25857 order to work out how to compile that file.  For example:
25859 @smallexample
25860 .ZZ:
25861 z-compile -input %i
25862 @end smallexample
25864 This says that any input file whose name ends in @samp{.ZZ} should be
25865 passed to the program @samp{z-compile}, which should be invoked with the
25866 command-line switch @option{-input} and with the result of performing the
25867 @samp{%i} substitution.  (See below.)
25869 As an alternative to providing a spec string, the text following a
25870 suffix directive can be one of the following:
25872 @table @code
25873 @item @@@var{language}
25874 This says that the suffix is an alias for a known @var{language}.  This is
25875 similar to using the @option{-x} command-line switch to GCC to specify a
25876 language explicitly.  For example:
25878 @smallexample
25879 .ZZ:
25880 @@c++
25881 @end smallexample
25883 Says that .ZZ files are, in fact, C++ source files.
25885 @item #@var{name}
25886 This causes an error messages saying:
25888 @smallexample
25889 @var{name} compiler not installed on this system.
25890 @end smallexample
25891 @end table
25893 GCC already has an extensive list of suffixes built into it.
25894 This directive adds an entry to the end of the list of suffixes, but
25895 since the list is searched from the end backwards, it is effectively
25896 possible to override earlier entries using this technique.
25898 @end table
25900 GCC has the following spec strings built into it.  Spec files can
25901 override these strings or create their own.  Note that individual
25902 targets can also add their own spec strings to this list.
25904 @smallexample
25905 asm          Options to pass to the assembler
25906 asm_final    Options to pass to the assembler post-processor
25907 cpp          Options to pass to the C preprocessor
25908 cc1          Options to pass to the C compiler
25909 cc1plus      Options to pass to the C++ compiler
25910 endfile      Object files to include at the end of the link
25911 link         Options to pass to the linker
25912 lib          Libraries to include on the command line to the linker
25913 libgcc       Decides which GCC support library to pass to the linker
25914 linker       Sets the name of the linker
25915 predefines   Defines to be passed to the C preprocessor
25916 signed_char  Defines to pass to CPP to say whether @code{char} is signed
25917              by default
25918 startfile    Object files to include at the start of the link
25919 @end smallexample
25921 Here is a small example of a spec file:
25923 @smallexample
25924 %rename lib                 old_lib
25926 *lib:
25927 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
25928 @end smallexample
25930 This example renames the spec called @samp{lib} to @samp{old_lib} and
25931 then overrides the previous definition of @samp{lib} with a new one.
25932 The new definition adds in some extra command-line options before
25933 including the text of the old definition.
25935 @dfn{Spec strings} are a list of command-line options to be passed to their
25936 corresponding program.  In addition, the spec strings can contain
25937 @samp{%}-prefixed sequences to substitute variable text or to
25938 conditionally insert text into the command line.  Using these constructs
25939 it is possible to generate quite complex command lines.
25941 Here is a table of all defined @samp{%}-sequences for spec
25942 strings.  Note that spaces are not generated automatically around the
25943 results of expanding these sequences.  Therefore you can concatenate them
25944 together or combine them with constant text in a single argument.
25946 @table @code
25947 @item %%
25948 Substitute one @samp{%} into the program name or argument.
25950 @item %i
25951 Substitute the name of the input file being processed.
25953 @item %b
25954 Substitute the basename of the input file being processed.
25955 This is the substring up to (and not including) the last period
25956 and not including the directory.
25958 @item %B
25959 This is the same as @samp{%b}, but include the file suffix (text after
25960 the last period).
25962 @item %d
25963 Marks the argument containing or following the @samp{%d} as a
25964 temporary file name, so that that file is deleted if GCC exits
25965 successfully.  Unlike @samp{%g}, this contributes no text to the
25966 argument.
25968 @item %g@var{suffix}
25969 Substitute a file name that has suffix @var{suffix} and is chosen
25970 once per compilation, and mark the argument in the same way as
25971 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
25972 name is now chosen in a way that is hard to predict even when previously
25973 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
25974 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
25975 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
25976 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
25977 was simply substituted with a file name chosen once per compilation,
25978 without regard to any appended suffix (which was therefore treated
25979 just like ordinary text), making such attacks more likely to succeed.
25981 @item %u@var{suffix}
25982 Like @samp{%g}, but generates a new temporary file name
25983 each time it appears instead of once per compilation.
25985 @item %U@var{suffix}
25986 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
25987 new one if there is no such last file name.  In the absence of any
25988 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
25989 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
25990 involves the generation of two distinct file names, one
25991 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
25992 simply substituted with a file name chosen for the previous @samp{%u},
25993 without regard to any appended suffix.
25995 @item %j@var{suffix}
25996 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
25997 writable, and if @option{-save-temps} is not used; 
25998 otherwise, substitute the name
25999 of a temporary file, just like @samp{%u}.  This temporary file is not
26000 meant for communication between processes, but rather as a junk
26001 disposal mechanism.
26003 @item %|@var{suffix}
26004 @itemx %m@var{suffix}
26005 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26006 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26007 all.  These are the two most common ways to instruct a program that it
26008 should read from standard input or write to standard output.  If you
26009 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26010 construct: see for example @file{f/lang-specs.h}.
26012 @item %.@var{SUFFIX}
26013 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26014 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26015 terminated by the next space or %.
26017 @item %w
26018 Marks the argument containing or following the @samp{%w} as the
26019 designated output file of this compilation.  This puts the argument
26020 into the sequence of arguments that @samp{%o} substitutes.
26022 @item %o
26023 Substitutes the names of all the output files, with spaces
26024 automatically placed around them.  You should write spaces
26025 around the @samp{%o} as well or the results are undefined.
26026 @samp{%o} is for use in the specs for running the linker.
26027 Input files whose names have no recognized suffix are not compiled
26028 at all, but they are included among the output files, so they are
26029 linked.
26031 @item %O
26032 Substitutes the suffix for object files.  Note that this is
26033 handled specially when it immediately follows @samp{%g, %u, or %U},
26034 because of the need for those to form complete file names.  The
26035 handling is such that @samp{%O} is treated exactly as if it had already
26036 been substituted, except that @samp{%g, %u, and %U} do not currently
26037 support additional @var{suffix} characters following @samp{%O} as they do
26038 following, for example, @samp{.o}.
26040 @item %p
26041 Substitutes the standard macro predefinitions for the
26042 current target machine.  Use this when running @command{cpp}.
26044 @item %P
26045 Like @samp{%p}, but puts @samp{__} before and after the name of each
26046 predefined macro, except for macros that start with @samp{__} or with
26047 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26050 @item %I
26051 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26052 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26053 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26054 and @option{-imultilib} as necessary.
26056 @item %s
26057 Current argument is the name of a library or startup file of some sort.
26058 Search for that file in a standard list of directories and substitute
26059 the full name found.  The current working directory is included in the
26060 list of directories scanned.
26062 @item %T
26063 Current argument is the name of a linker script.  Search for that file
26064 in the current list of directories to scan for libraries. If the file
26065 is located insert a @option{--script} option into the command line
26066 followed by the full path name found.  If the file is not found then
26067 generate an error message.  Note: the current working directory is not
26068 searched.
26070 @item %e@var{str}
26071 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26072 Use this when inconsistent options are detected.
26074 @item %(@var{name})
26075 Substitute the contents of spec string @var{name} at this point.
26077 @item %x@{@var{option}@}
26078 Accumulate an option for @samp{%X}.
26080 @item %X
26081 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26082 spec string.
26084 @item %Y
26085 Output the accumulated assembler options specified by @option{-Wa}.
26087 @item %Z
26088 Output the accumulated preprocessor options specified by @option{-Wp}.
26090 @item %a
26091 Process the @code{asm} spec.  This is used to compute the
26092 switches to be passed to the assembler.
26094 @item %A
26095 Process the @code{asm_final} spec.  This is a spec string for
26096 passing switches to an assembler post-processor, if such a program is
26097 needed.
26099 @item %l
26100 Process the @code{link} spec.  This is the spec for computing the
26101 command line passed to the linker.  Typically it makes use of the
26102 @samp{%L %G %S %D and %E} sequences.
26104 @item %D
26105 Dump out a @option{-L} option for each directory that GCC believes might
26106 contain startup files.  If the target supports multilibs then the
26107 current multilib directory is prepended to each of these paths.
26109 @item %L
26110 Process the @code{lib} spec.  This is a spec string for deciding which
26111 libraries are included on the command line to the linker.
26113 @item %G
26114 Process the @code{libgcc} spec.  This is a spec string for deciding
26115 which GCC support library is included on the command line to the linker.
26117 @item %S
26118 Process the @code{startfile} spec.  This is a spec for deciding which
26119 object files are the first ones passed to the linker.  Typically
26120 this might be a file named @file{crt0.o}.
26122 @item %E
26123 Process the @code{endfile} spec.  This is a spec string that specifies
26124 the last object files that are passed to the linker.
26126 @item %C
26127 Process the @code{cpp} spec.  This is used to construct the arguments
26128 to be passed to the C preprocessor.
26130 @item %1
26131 Process the @code{cc1} spec.  This is used to construct the options to be
26132 passed to the actual C compiler (@command{cc1}).
26134 @item %2
26135 Process the @code{cc1plus} spec.  This is used to construct the options to be
26136 passed to the actual C++ compiler (@command{cc1plus}).
26138 @item %*
26139 Substitute the variable part of a matched option.  See below.
26140 Note that each comma in the substituted string is replaced by
26141 a single space.
26143 @item %<@code{S}
26144 Remove all occurrences of @code{-S} from the command line.  Note---this
26145 command is position dependent.  @samp{%} commands in the spec string
26146 before this one see @code{-S}, @samp{%} commands in the spec string
26147 after this one do not.
26149 @item %:@var{function}(@var{args})
26150 Call the named function @var{function}, passing it @var{args}.
26151 @var{args} is first processed as a nested spec string, then split
26152 into an argument vector in the usual fashion.  The function returns
26153 a string which is processed as if it had appeared literally as part
26154 of the current spec.
26156 The following built-in spec functions are provided:
26158 @table @code
26159 @item @code{getenv}
26160 The @code{getenv} spec function takes two arguments: an environment
26161 variable name and a string.  If the environment variable is not
26162 defined, a fatal error is issued.  Otherwise, the return value is the
26163 value of the environment variable concatenated with the string.  For
26164 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26166 @smallexample
26167 %:getenv(TOPDIR /include)
26168 @end smallexample
26170 expands to @file{/path/to/top/include}.
26172 @item @code{if-exists}
26173 The @code{if-exists} spec function takes one argument, an absolute
26174 pathname to a file.  If the file exists, @code{if-exists} returns the
26175 pathname.  Here is a small example of its usage:
26177 @smallexample
26178 *startfile:
26179 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26180 @end smallexample
26182 @item @code{if-exists-else}
26183 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26184 spec function, except that it takes two arguments.  The first argument is
26185 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26186 returns the pathname.  If it does not exist, it returns the second argument.
26187 This way, @code{if-exists-else} can be used to select one file or another,
26188 based on the existence of the first.  Here is a small example of its usage:
26190 @smallexample
26191 *startfile:
26192 crt0%O%s %:if-exists(crti%O%s) \
26193 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26194 @end smallexample
26196 @item @code{replace-outfile}
26197 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26198 first argument in the outfiles array and replaces it with the second argument.  Here
26199 is a small example of its usage:
26201 @smallexample
26202 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26203 @end smallexample
26205 @item @code{remove-outfile}
26206 The @code{remove-outfile} spec function takes one argument.  It looks for the
26207 first argument in the outfiles array and removes it.  Here is a small example
26208 its usage:
26210 @smallexample
26211 %:remove-outfile(-lm)
26212 @end smallexample
26214 @item @code{pass-through-libs}
26215 The @code{pass-through-libs} spec function takes any number of arguments.  It
26216 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26217 assumes are the names of linker input library archive files) and returns a
26218 result containing all the found arguments each prepended by
26219 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26220 intended to be passed to the LTO linker plugin.
26222 @smallexample
26223 %:pass-through-libs(%G %L %G)
26224 @end smallexample
26226 @item @code{print-asm-header}
26227 The @code{print-asm-header} function takes no arguments and simply
26228 prints a banner like:
26230 @smallexample
26231 Assembler options
26232 =================
26234 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26235 @end smallexample
26237 It is used to separate compiler options from assembler options
26238 in the @option{--target-help} output.
26239 @end table
26241 @item %@{@code{S}@}
26242 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26243 If that switch is not specified, this substitutes nothing.  Note that
26244 the leading dash is omitted when specifying this option, and it is
26245 automatically inserted if the substitution is performed.  Thus the spec
26246 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26247 and outputs the command-line option @option{-foo}.
26249 @item %W@{@code{S}@}
26250 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26251 deleted on failure.
26253 @item %@{@code{S}*@}
26254 Substitutes all the switches specified to GCC whose names start
26255 with @code{-S}, but which also take an argument.  This is used for
26256 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26257 GCC considers @option{-o foo} as being
26258 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26259 text, including the space.  Thus two arguments are generated.
26261 @item %@{@code{S}*&@code{T}*@}
26262 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26263 (the order of @code{S} and @code{T} in the spec is not significant).
26264 There can be any number of ampersand-separated variables; for each the
26265 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26267 @item %@{@code{S}:@code{X}@}
26268 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26270 @item %@{!@code{S}:@code{X}@}
26271 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26273 @item %@{@code{S}*:@code{X}@}
26274 Substitutes @code{X} if one or more switches whose names start with
26275 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26276 once, no matter how many such switches appeared.  However, if @code{%*}
26277 appears somewhere in @code{X}, then @code{X} is substituted once
26278 for each matching switch, with the @code{%*} replaced by the part of
26279 that switch matching the @code{*}.
26281 If @code{%*} appears as the last part of a spec sequence then a space
26282 is added after the end of the last substitution.  If there is more
26283 text in the sequence, however, then a space is not generated.  This
26284 allows the @code{%*} substitution to be used as part of a larger
26285 string.  For example, a spec string like this:
26287 @smallexample
26288 %@{mcu=*:--script=%*/memory.ld@}
26289 @end smallexample
26291 @noindent
26292 when matching an option like @option{-mcu=newchip} produces:
26294 @smallexample
26295 --script=newchip/memory.ld
26296 @end smallexample
26298 @item %@{.@code{S}:@code{X}@}
26299 Substitutes @code{X}, if processing a file with suffix @code{S}.
26301 @item %@{!.@code{S}:@code{X}@}
26302 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26304 @item %@{,@code{S}:@code{X}@}
26305 Substitutes @code{X}, if processing a file for language @code{S}.
26307 @item %@{!,@code{S}:@code{X}@}
26308 Substitutes @code{X}, if not processing a file for language @code{S}.
26310 @item %@{@code{S}|@code{P}:@code{X}@}
26311 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26312 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26313 @code{*} sequences as well, although they have a stronger binding than
26314 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26315 alternatives must be starred, and only the first matching alternative
26316 is substituted.
26318 For example, a spec string like this:
26320 @smallexample
26321 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26322 @end smallexample
26324 @noindent
26325 outputs the following command-line options from the following input
26326 command-line options:
26328 @smallexample
26329 fred.c        -foo -baz
26330 jim.d         -bar -boggle
26331 -d fred.c     -foo -baz -boggle
26332 -d jim.d      -bar -baz -boggle
26333 @end smallexample
26335 @item %@{S:X; T:Y; :D@}
26337 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26338 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26339 be as many clauses as you need.  This may be combined with @code{.},
26340 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26343 @end table
26345 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
26346 construct may contain other nested @samp{%} constructs or spaces, or
26347 even newlines.  They are processed as usual, as described above.
26348 Trailing white space in @code{X} is ignored.  White space may also
26349 appear anywhere on the left side of the colon in these constructs,
26350 except between @code{.} or @code{*} and the corresponding word.
26352 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26353 handled specifically in these constructs.  If another value of
26354 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26355 @option{-W} switch is found later in the command line, the earlier
26356 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26357 just one letter, which passes all matching options.
26359 The character @samp{|} at the beginning of the predicate text is used to
26360 indicate that a command should be piped to the following command, but
26361 only if @option{-pipe} is specified.
26363 It is built into GCC which switches take arguments and which do not.
26364 (You might think it would be useful to generalize this to allow each
26365 compiler's spec to say which switches take arguments.  But this cannot
26366 be done in a consistent fashion.  GCC cannot even decide which input
26367 files have been specified without knowing which switches take arguments,
26368 and it must know which input files to compile in order to tell which
26369 compilers to run).
26371 GCC also knows implicitly that arguments starting in @option{-l} are to be
26372 treated as compiler output files, and passed to the linker in their
26373 proper position among the other output files.
26375 @node Environment Variables
26376 @section Environment Variables Affecting GCC
26377 @cindex environment variables
26379 @c man begin ENVIRONMENT
26380 This section describes several environment variables that affect how GCC
26381 operates.  Some of them work by specifying directories or prefixes to use
26382 when searching for various kinds of files.  Some are used to specify other
26383 aspects of the compilation environment.
26385 Note that you can also specify places to search using options such as
26386 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26387 take precedence over places specified using environment variables, which
26388 in turn take precedence over those specified by the configuration of GCC@.
26389 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26390 GNU Compiler Collection (GCC) Internals}.
26392 @table @env
26393 @item LANG
26394 @itemx LC_CTYPE
26395 @c @itemx LC_COLLATE
26396 @itemx LC_MESSAGES
26397 @c @itemx LC_MONETARY
26398 @c @itemx LC_NUMERIC
26399 @c @itemx LC_TIME
26400 @itemx LC_ALL
26401 @findex LANG
26402 @findex LC_CTYPE
26403 @c @findex LC_COLLATE
26404 @findex LC_MESSAGES
26405 @c @findex LC_MONETARY
26406 @c @findex LC_NUMERIC
26407 @c @findex LC_TIME
26408 @findex LC_ALL
26409 @cindex locale
26410 These environment variables control the way that GCC uses
26411 localization information which allows GCC to work with different
26412 national conventions.  GCC inspects the locale categories
26413 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26414 so.  These locale categories can be set to any value supported by your
26415 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26416 Kingdom encoded in UTF-8.
26418 The @env{LC_CTYPE} environment variable specifies character
26419 classification.  GCC uses it to determine the character boundaries in
26420 a string; this is needed for some multibyte encodings that contain quote
26421 and escape characters that are otherwise interpreted as a string
26422 end or escape.
26424 The @env{LC_MESSAGES} environment variable specifies the language to
26425 use in diagnostic messages.
26427 If the @env{LC_ALL} environment variable is set, it overrides the value
26428 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
26429 and @env{LC_MESSAGES} default to the value of the @env{LANG}
26430 environment variable.  If none of these variables are set, GCC
26431 defaults to traditional C English behavior.
26433 @item TMPDIR
26434 @findex TMPDIR
26435 If @env{TMPDIR} is set, it specifies the directory to use for temporary
26436 files.  GCC uses temporary files to hold the output of one stage of
26437 compilation which is to be used as input to the next stage: for example,
26438 the output of the preprocessor, which is the input to the compiler
26439 proper.
26441 @item GCC_COMPARE_DEBUG
26442 @findex GCC_COMPARE_DEBUG
26443 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
26444 @option{-fcompare-debug} to the compiler driver.  See the documentation
26445 of this option for more details.
26447 @item GCC_EXEC_PREFIX
26448 @findex GCC_EXEC_PREFIX
26449 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
26450 names of the subprograms executed by the compiler.  No slash is added
26451 when this prefix is combined with the name of a subprogram, but you can
26452 specify a prefix that ends with a slash if you wish.
26454 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
26455 an appropriate prefix to use based on the pathname it is invoked with.
26457 If GCC cannot find the subprogram using the specified prefix, it
26458 tries looking in the usual places for the subprogram.
26460 The default value of @env{GCC_EXEC_PREFIX} is
26461 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
26462 the installed compiler. In many cases @var{prefix} is the value
26463 of @code{prefix} when you ran the @file{configure} script.
26465 Other prefixes specified with @option{-B} take precedence over this prefix.
26467 This prefix is also used for finding files such as @file{crt0.o} that are
26468 used for linking.
26470 In addition, the prefix is used in an unusual way in finding the
26471 directories to search for header files.  For each of the standard
26472 directories whose name normally begins with @samp{/usr/local/lib/gcc}
26473 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
26474 replacing that beginning with the specified prefix to produce an
26475 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
26476 @file{foo/bar} just before it searches the standard directory 
26477 @file{/usr/local/lib/bar}.
26478 If a standard directory begins with the configured
26479 @var{prefix} then the value of @var{prefix} is replaced by
26480 @env{GCC_EXEC_PREFIX} when looking for header files.
26482 @item COMPILER_PATH
26483 @findex COMPILER_PATH
26484 The value of @env{COMPILER_PATH} is a colon-separated list of
26485 directories, much like @env{PATH}.  GCC tries the directories thus
26486 specified when searching for subprograms, if it can't find the
26487 subprograms using @env{GCC_EXEC_PREFIX}.
26489 @item LIBRARY_PATH
26490 @findex LIBRARY_PATH
26491 The value of @env{LIBRARY_PATH} is a colon-separated list of
26492 directories, much like @env{PATH}.  When configured as a native compiler,
26493 GCC tries the directories thus specified when searching for special
26494 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
26495 using GCC also uses these directories when searching for ordinary
26496 libraries for the @option{-l} option (but directories specified with
26497 @option{-L} come first).
26499 @item LANG
26500 @findex LANG
26501 @cindex locale definition
26502 This variable is used to pass locale information to the compiler.  One way in
26503 which this information is used is to determine the character set to be used
26504 when character literals, string literals and comments are parsed in C and C++.
26505 When the compiler is configured to allow multibyte characters,
26506 the following values for @env{LANG} are recognized:
26508 @table @samp
26509 @item C-JIS
26510 Recognize JIS characters.
26511 @item C-SJIS
26512 Recognize SJIS characters.
26513 @item C-EUCJP
26514 Recognize EUCJP characters.
26515 @end table
26517 If @env{LANG} is not defined, or if it has some other value, then the
26518 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
26519 recognize and translate multibyte characters.
26520 @end table
26522 @noindent
26523 Some additional environment variables affect the behavior of the
26524 preprocessor.
26526 @include cppenv.texi
26528 @c man end
26530 @node Precompiled Headers
26531 @section Using Precompiled Headers
26532 @cindex precompiled headers
26533 @cindex speed of compilation
26535 Often large projects have many header files that are included in every
26536 source file.  The time the compiler takes to process these header files
26537 over and over again can account for nearly all of the time required to
26538 build the project.  To make builds faster, GCC allows you to
26539 @dfn{precompile} a header file.
26541 To create a precompiled header file, simply compile it as you would any
26542 other file, if necessary using the @option{-x} option to make the driver
26543 treat it as a C or C++ header file.  You may want to use a
26544 tool like @command{make} to keep the precompiled header up-to-date when
26545 the headers it contains change.
26547 A precompiled header file is searched for when @code{#include} is
26548 seen in the compilation.  As it searches for the included file
26549 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
26550 compiler looks for a precompiled header in each directory just before it
26551 looks for the include file in that directory.  The name searched for is
26552 the name specified in the @code{#include} with @samp{.gch} appended.  If
26553 the precompiled header file can't be used, it is ignored.
26555 For instance, if you have @code{#include "all.h"}, and you have
26556 @file{all.h.gch} in the same directory as @file{all.h}, then the
26557 precompiled header file is used if possible, and the original
26558 header is used otherwise.
26560 Alternatively, you might decide to put the precompiled header file in a
26561 directory and use @option{-I} to ensure that directory is searched
26562 before (or instead of) the directory containing the original header.
26563 Then, if you want to check that the precompiled header file is always
26564 used, you can put a file of the same name as the original header in this
26565 directory containing an @code{#error} command.
26567 This also works with @option{-include}.  So yet another way to use
26568 precompiled headers, good for projects not designed with precompiled
26569 header files in mind, is to simply take most of the header files used by
26570 a project, include them from another header file, precompile that header
26571 file, and @option{-include} the precompiled header.  If the header files
26572 have guards against multiple inclusion, they are skipped because
26573 they've already been included (in the precompiled header).
26575 If you need to precompile the same header file for different
26576 languages, targets, or compiler options, you can instead make a
26577 @emph{directory} named like @file{all.h.gch}, and put each precompiled
26578 header in the directory, perhaps using @option{-o}.  It doesn't matter
26579 what you call the files in the directory; every precompiled header in
26580 the directory is considered.  The first precompiled header
26581 encountered in the directory that is valid for this compilation is
26582 used; they're searched in no particular order.
26584 There are many other possibilities, limited only by your imagination,
26585 good sense, and the constraints of your build system.
26587 A precompiled header file can be used only when these conditions apply:
26589 @itemize
26590 @item
26591 Only one precompiled header can be used in a particular compilation.
26593 @item
26594 A precompiled header can't be used once the first C token is seen.  You
26595 can have preprocessor directives before a precompiled header; you cannot
26596 include a precompiled header from inside another header.
26598 @item
26599 The precompiled header file must be produced for the same language as
26600 the current compilation.  You can't use a C precompiled header for a C++
26601 compilation.
26603 @item
26604 The precompiled header file must have been produced by the same compiler
26605 binary as the current compilation is using.
26607 @item
26608 Any macros defined before the precompiled header is included must
26609 either be defined in the same way as when the precompiled header was
26610 generated, or must not affect the precompiled header, which usually
26611 means that they don't appear in the precompiled header at all.
26613 The @option{-D} option is one way to define a macro before a
26614 precompiled header is included; using a @code{#define} can also do it.
26615 There are also some options that define macros implicitly, like
26616 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
26617 defined this way.
26619 @item If debugging information is output when using the precompiled
26620 header, using @option{-g} or similar, the same kind of debugging information
26621 must have been output when building the precompiled header.  However,
26622 a precompiled header built using @option{-g} can be used in a compilation
26623 when no debugging information is being output.
26625 @item The same @option{-m} options must generally be used when building
26626 and using the precompiled header.  @xref{Submodel Options},
26627 for any cases where this rule is relaxed.
26629 @item Each of the following options must be the same when building and using
26630 the precompiled header:
26632 @gccoptlist{-fexceptions}
26634 @item
26635 Some other command-line options starting with @option{-f},
26636 @option{-p}, or @option{-O} must be defined in the same way as when
26637 the precompiled header was generated.  At present, it's not clear
26638 which options are safe to change and which are not; the safest choice
26639 is to use exactly the same options when generating and using the
26640 precompiled header.  The following are known to be safe:
26642 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
26643 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
26644 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
26645 -pedantic-errors}
26647 @end itemize
26649 For all of these except the last, the compiler automatically
26650 ignores the precompiled header if the conditions aren't met.  If you
26651 find an option combination that doesn't work and doesn't cause the
26652 precompiled header to be ignored, please consider filing a bug report,
26653 see @ref{Bugs}.
26655 If you do use differing options when generating and using the
26656 precompiled header, the actual behavior is a mixture of the
26657 behavior for the options.  For instance, if you use @option{-g} to
26658 generate the precompiled header but not when using it, you may or may
26659 not get debugging information for routines in the precompiled header.