match.pd: Relax some tree_nop_conversion_p
[official-gcc.git] / gcc / doc / invoke.texi
blobd2dfdd9914f951457749fc01d042780e83d08086
1 @c Copyright (C) 1988-2016 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-2016 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 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
182 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
183 -fhosted  -ffreestanding -fopenacc -fopenmp -fopenmp-simd @gol
184 -fms-extensions -fplan9-extensions -fsso-struct=@var{endianness}
185 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
186 -fsigned-bitfields  -fsigned-char @gol
187 -funsigned-bitfields  -funsigned-char @gol
188 -trigraphs -traditional -traditional-cpp}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
193 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
194 -fno-elide-constructors @gol
195 -fno-enforce-eh-specs @gol
196 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
197 -fno-implicit-templates @gol
198 -fno-implicit-inline-templates @gol
199 -fno-implement-inlines  -fms-extensions @gol
200 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
201 -fno-optional-diags  -fpermissive @gol
202 -fno-pretty-templates @gol
203 -frepo  -fno-rtti -fsized-deallocation @gol
204 -ftemplate-backtrace-limit=@var{n} @gol
205 -ftemplate-depth=@var{n} @gol
206 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
207 -fno-weak  -nostdinc++ @gol
208 -fvisibility-inlines-hidden @gol
209 -fvisibility-ms-compat @gol
210 -fext-numeric-literals @gol
211 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
212 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wmultiple-inheritance @gol
213 -Wnamespaces -Wnarrowing @gol
214 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
215 -Weffc++  -Wstrict-null-sentinel -Wtemplates @gol
216 -Wno-non-template-friend  -Wold-style-cast @gol
217 -Woverloaded-virtual  -Wno-pmf-conversions @gol
218 -Wsign-promo -Wvirtual-inheritance}
220 @item Objective-C and Objective-C++ Language Options
221 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
222 Objective-C and Objective-C++ Dialects}.
223 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
224 -fgnu-runtime  -fnext-runtime @gol
225 -fno-nil-receivers @gol
226 -fobjc-abi-version=@var{n} @gol
227 -fobjc-call-cxx-cdtors @gol
228 -fobjc-direct-dispatch @gol
229 -fobjc-exceptions @gol
230 -fobjc-gc @gol
231 -fobjc-nilcheck @gol
232 -fobjc-std=objc1 @gol
233 -fno-local-ivars @gol
234 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
235 -freplace-objc-classes @gol
236 -fzero-link @gol
237 -gen-decls @gol
238 -Wassign-intercept @gol
239 -Wno-protocol  -Wselector @gol
240 -Wstrict-selector-match @gol
241 -Wundeclared-selector}
243 @item Diagnostic Message Formatting Options
244 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
245 @gccoptlist{-fmessage-length=@var{n}  @gol
246 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
247 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
248 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
250 @item Warning Options
251 @xref{Warning Options,,Options to Request or Suppress Warnings}.
252 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
253 -pedantic-errors @gol
254 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
255 -Wno-aggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
256 -Wno-attributes -Wbool-compare -Wno-builtin-macro-redefined @gol
257 -Wc90-c99-compat -Wc99-c11-compat @gol
258 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
259 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
260 -Wconversion -Wcoverage-mismatch -Wno-cpp -Wdangling-else -Wdate-time @gol
261 -Wdelete-incomplete @gol
262 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
263 -Wdisabled-optimization @gol
264 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
265 -Wno-div-by-zero -Wdouble-promotion -Wduplicated-cond @gol
266 -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
267 -Werror  -Werror=* -Wfatal-errors -Wfloat-equal  -Wformat  -Wformat=2 @gol
268 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
269 -Wformat-security  -Wformat-signedness  -Wformat-y2k -Wframe-address @gol
270 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
271 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
272 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
273 -Winit-self  -Winline  -Wno-int-conversion @gol
274 -Wno-int-to-pointer-cast -Winvalid-memory-model -Wno-invalid-offsetof @gol
275 -Winvalid-pch -Wlarger-than=@var{len} @gol
276 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
277 -Wmain -Wmaybe-uninitialized -Wmemset-elt-size -Wmemset-transposed-args @gol
278 -Wmisleading-indentation -Wmissing-braces @gol
279 -Wmissing-field-initializers -Wmissing-include-dirs @gol
280 -Wno-multichar -Wnonnull -Wnonnull-compare @gol
281 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
282 -Wnull-dereference -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
283 -Woverride-init-side-effects -Woverlength-strings @gol
284 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
285 -Wparentheses -Wno-pedantic-ms-format @gol
286 -Wplacement-new -Wplacement-new=@var{n} @gol
287 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
288 -Wno-pragmas -Wredundant-decls  -Wno-return-local-addr @gol
289 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
290 -Wshift-overflow -Wshift-overflow=@var{n} @gol
291 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
292 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
293 -Wno-scalar-storage-order @gol
294 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
295 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
296 -Wstrict-aliasing=n -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
297 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
298 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
299 -Wmissing-format-attribute -Wsubobject-linkage @gol
300 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
301 -Wswitch-unreachable  -Wsync-nand @gol
302 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
303 -Wtype-limits  -Wundef @gol
304 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
305 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
306 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
307 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
308 -Wunused-const-variable -Wunused-const-variable=@var{n} @gol
309 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
310 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
311 -Wvla -Wvolatile-register-var  -Wwrite-strings @gol
312 -Wzero-as-null-pointer-constant -Whsa}
314 @item C and Objective-C-only Warning Options
315 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
316 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
317 -Wold-style-declaration  -Wold-style-definition @gol
318 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
319 -Wdeclaration-after-statement -Wpointer-sign}
321 @item Debugging Options
322 @xref{Debugging Options,,Options for Debugging Your Program}.
323 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf -gdwarf-@var{version} @gol
324 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
325 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
326 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
327 -fdebug-prefix-map=@var{old}=@var{new} -fdebug-types-section @gol
328 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
329 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
330 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
331 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
332 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
333 -fvar-tracking -fvar-tracking-assignments}
335 @item Optimization Options
336 @xref{Optimize Options,,Options that Control Optimization}.
337 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
338 -falign-jumps[=@var{n}] @gol
339 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
340 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
341 -fauto-inc-dec -fbranch-probabilities @gol
342 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
343 -fbtr-bb-exclusive -fcaller-saves @gol
344 -fcombine-stack-adjustments -fconserve-stack @gol
345 -fcompare-elim -fcprop-registers -fcrossjumping @gol
346 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
347 -fcx-limited-range @gol
348 -fdata-sections -fdce -fdelayed-branch @gol
349 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
350 -fdevirtualize-at-ltrans -fdse @gol
351 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
352 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
353 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
354 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
355 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
356 -fif-conversion2 -findirect-inlining @gol
357 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
358 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment @gol
359 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
360 -fira-algorithm=@var{algorithm} @gol
361 -fira-region=@var{region} -fira-hoist-pressure @gol
362 -fira-loop-pressure -fno-ira-share-save-slots @gol
363 -fno-ira-share-spill-slots @gol
364 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
365 -fivopts -fkeep-inline-functions -fkeep-static-functions @gol
366 -fkeep-static-consts -flive-range-shrinkage @gol
367 -floop-block -floop-interchange -floop-strip-mine @gol
368 -floop-unroll-and-jam -floop-nest-optimize @gol
369 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
370 -flto-partition=@var{alg} -fmerge-all-constants @gol
371 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
372 -fmove-loop-invariants -fno-branch-count-reg @gol
373 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
374 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
375 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
376 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
377 -fomit-frame-pointer -foptimize-sibling-calls @gol
378 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
379 -fprefetch-loop-arrays @gol
380 -fprofile-correction @gol
381 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
382 -fprofile-reorder-functions @gol
383 -freciprocal-math -free -frename-registers -freorder-blocks @gol
384 -freorder-blocks-algorithm=@var{algorithm} @gol
385 -freorder-blocks-and-partition -freorder-functions @gol
386 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
387 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
388 -fsched-spec-load -fsched-spec-load-dangerous @gol
389 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
390 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
391 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
392 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
393 -fschedule-fusion @gol
394 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
395 -fselective-scheduling -fselective-scheduling2 @gol
396 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
397 -fsemantic-interposition -fshrink-wrap -fsignaling-nans @gol
398 -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
399 -fsplit-paths @gol
400 -fsplit-wide-types -fssa-backprop -fssa-phiopt @gol
401 -fstdarg-opt -fstrict-aliasing @gol
402 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
403 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
404 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
405 -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
406 -ftree-loop-if-convert-stores -ftree-loop-im @gol
407 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
408 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
409 -ftree-loop-vectorize @gol
410 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
411 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
412 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
413 -ftree-vectorize -ftree-vrp -funconstrained-commons @gol
414 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
415 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
416 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
417 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
418 --param @var{name}=@var{value}
419 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
421 @item Program Instrumentation Options
422 @xref{Instrumentation Options,,Program Instrumentation Options}.
423 @gccoptlist{-p  -pg  -fprofile-arcs --coverage -ftest-coverage @gol
424 -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
425 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
426 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
427 -fsanitize-undefined-trap-on-error -fbounds-check @gol
428 -fcheck-pointer-bounds -fchkp-check-incomplete-type @gol
429 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
430 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
431 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
432 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
433 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
434 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
435 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
436 -fchkp-use-wrappers @gol
437 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
438 -fstack-protector-explicit -fstack-check @gol
439 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
440 -fno-stack-limit -fsplit-stack @gol
441 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
442 -fvtv-counts -fvtv-debug @gol
443 -finstrument-functions @gol
444 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
445 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
447 @item Preprocessor Options
448 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
449 @gccoptlist{-A@var{question}=@var{answer} @gol
450 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
451 -C  -dD  -dI  -dM  -dN @gol
452 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
453 -idirafter @var{dir} @gol
454 -include @var{file}  -imacros @var{file} @gol
455 -iprefix @var{file}  -iwithprefix @var{dir} @gol
456 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
457 -imultilib @var{dir} -isysroot @var{dir} @gol
458 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
459 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
460 -remap -trigraphs  -undef  -U@var{macro}  @gol
461 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
463 @item Assembler Option
464 @xref{Assembler Options,,Passing Options to the Assembler}.
465 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
467 @item Linker Options
468 @xref{Link Options,,Options for Linking}.
469 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
470 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
471 -s  -static -static-libgcc -static-libstdc++ @gol
472 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
473 -static-libmpx -static-libmpxwrappers @gol
474 -shared -shared-libgcc  -symbolic @gol
475 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
476 -u @var{symbol} -z @var{keyword}}
478 @item Directory Options
479 @xref{Directory Options,,Options for Directory Search}.
480 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
481 -iquote@var{dir} -L@var{dir} -no-canonical-prefixes -I- @gol
482 --sysroot=@var{dir} --no-sysroot-suffix}
484 @item Code Generation Options
485 @xref{Code Gen Options,,Options for Code Generation Conventions}.
486 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
487 -ffixed-@var{reg}  -fexceptions @gol
488 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
489 -fasynchronous-unwind-tables @gol
490 -fno-gnu-unique @gol
491 -finhibit-size-directive  -fno-common  -fno-ident @gol
492 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
493 -fno-jump-tables @gol
494 -frecord-gcc-switches @gol
495 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
496 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
497 -fleading-underscore  -ftls-model=@var{model} @gol
498 -fstack-reuse=@var{reuse_level} @gol
499 -ftrapv  -fwrapv @gol
500 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
501 -fstrict-volatile-bitfields -fsync-libcalls}
503 @item Developer Options
504 @xref{Developer Options,,GCC Developer Options}.
505 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
506 -fchecking -fchecking=@var{n} -fdbg-cnt-list @gol
507 -fdbg-cnt=@var{counter-value-list} @gol
508 -fdisable-ipa-@var{pass_name} @gol
509 -fdisable-rtl-@var{pass_name} @gol
510 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
511 -fdisable-tree-@var{pass_name} @gol
512 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
513 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
514 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
515 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
516 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
517 -fdump-passes @gol
518 -fdump-rtl-@var{pass} -fdump-rtl-@var{pass}=@var{filename} @gol
519 -fdump-statistics @gol
520 -fdump-tree-all @gol
521 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
522 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
523 -fdump-tree-cfg -fdump-tree-alias @gol
524 -fdump-tree-ch @gol
525 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
526 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
527 -fdump-tree-gimple@r{[}-raw@r{]} @gol
528 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
529 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
530 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
531 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
532 -fdump-tree-backprop@r{[}-@var{n}@r{]} @gol
533 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
534 -fdump-tree-nrv -fdump-tree-vect @gol
535 -fdump-tree-sink @gol
536 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
537 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
538 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
539 -fdump-tree-vtable-verify @gol
540 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
541 -fdump-tree-split-paths@r{[}-@var{n}@r{]} @gol
542 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
543 -fdump-final-insns=@var{file} @gol
544 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
545 -fenable-@var{kind}-@var{pass} @gol
546 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
547 -fira-verbose=@var{n} @gol
548 -flto-report -flto-report-wpa -fmem-report-wpa @gol
549 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report @gol
550 -fopt-info -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
551 -fprofile-report @gol
552 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
553 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
554 -fstats  -fstack-usage  -ftime-report @gol
555 -fvar-tracking-assignments-toggle -gtoggle @gol
556 -print-file-name=@var{library}  -print-libgcc-file-name @gol
557 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
558 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
559 -print-sysroot -print-sysroot-headers-suffix @gol
560 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
562 @item Machine-Dependent Options
563 @xref{Submodel Options,,Machine-Dependent Options}.
564 @c This list is ordered alphanumerically by subsection name.
565 @c Try and put the significant identifier (CPU or system) first,
566 @c so users have a clue at guessing where the ones they want will be.
568 @emph{AArch64 Options}
569 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
570 -mgeneral-regs-only @gol
571 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
572 -mstrict-align @gol
573 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
574 -mtls-dialect=desc  -mtls-dialect=traditional @gol
575 -mtls-size=@var{size} @gol
576 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
577 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
578 -mlow-precision-recip-sqrt -mno-low-precision-recip-sqrt@gol
579 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
581 @emph{Adapteva Epiphany Options}
582 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
583 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
584 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
585 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
586 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
587 -msplit-vecmove-early -m1reg-@var{reg}}
589 @emph{ARC Options}
590 @gccoptlist{-mbarrel-shifter @gol
591 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
592 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
593 -mea -mno-mpy -mmul32x16 -mmul64 -matomic @gol
594 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
595 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
596 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
597 -mlong-calls -mmedium-calls -msdata @gol
598 -mucb-mcount -mvolatile-cache -mtp-regno=@var{regno} @gol
599 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
600 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
601 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
602 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
603 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
604 -mtune=@var{cpu} -mmultcost=@var{num} @gol
605 -munalign-prob-threshold=@var{probability} -mmpy-option=@var{multo} @gol
606 -mdiv-rem -mcode-density -mll64 -mfpu=@var{fpu}}
608 @emph{ARM Options}
609 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
610 -mabi=@var{name} @gol
611 -mapcs-stack-check  -mno-apcs-stack-check @gol
612 -mapcs-float  -mno-apcs-float @gol
613 -mapcs-reentrant  -mno-apcs-reentrant @gol
614 -msched-prolog  -mno-sched-prolog @gol
615 -mlittle-endian  -mbig-endian @gol
616 -mfloat-abi=@var{name} @gol
617 -mfp16-format=@var{name}
618 -mthumb-interwork  -mno-thumb-interwork @gol
619 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
620 -mtune=@var{name} -mprint-tune-info @gol
621 -mstructure-size-boundary=@var{n} @gol
622 -mabort-on-noreturn @gol
623 -mlong-calls  -mno-long-calls @gol
624 -msingle-pic-base  -mno-single-pic-base @gol
625 -mpic-register=@var{reg} @gol
626 -mnop-fun-dllimport @gol
627 -mpoke-function-name @gol
628 -mthumb  -marm @gol
629 -mtpcs-frame  -mtpcs-leaf-frame @gol
630 -mcaller-super-interworking  -mcallee-super-interworking @gol
631 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
632 -mword-relocations @gol
633 -mfix-cortex-m3-ldrd @gol
634 -munaligned-access @gol
635 -mneon-for-64bits @gol
636 -mslow-flash-data @gol
637 -masm-syntax-unified @gol
638 -mrestrict-it}
640 @emph{AVR Options}
641 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
642 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
643 -mrelax -mrmw -mstrict-X -mtiny-stack -nodevicelib -Waddr-space-convert}
645 @emph{Blackfin Options}
646 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
647 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
648 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
649 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
650 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
651 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
652 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
653 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
654 -micplb}
656 @emph{C6X Options}
657 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
658 -msim -msdata=@var{sdata-type}}
660 @emph{CRIS Options}
661 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
662 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
663 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
664 -mstack-align  -mdata-align  -mconst-align @gol
665 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
666 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
667 -mmul-bug-workaround  -mno-mul-bug-workaround}
669 @emph{CR16 Options}
670 @gccoptlist{-mmac @gol
671 -mcr16cplus -mcr16c @gol
672 -msim -mint32 -mbit-ops
673 -mdata-model=@var{model}}
675 @emph{Darwin Options}
676 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
677 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
678 -client_name  -compatibility_version  -current_version @gol
679 -dead_strip @gol
680 -dependency-file  -dylib_file  -dylinker_install_name @gol
681 -dynamic  -dynamiclib  -exported_symbols_list @gol
682 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
683 -force_flat_namespace  -headerpad_max_install_names @gol
684 -iframework @gol
685 -image_base  -init  -install_name  -keep_private_externs @gol
686 -multi_module  -multiply_defined  -multiply_defined_unused @gol
687 -noall_load   -no_dead_strip_inits_and_terms @gol
688 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
689 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
690 -private_bundle  -read_only_relocs  -sectalign @gol
691 -sectobjectsymbols  -whyload  -seg1addr @gol
692 -sectcreate  -sectobjectsymbols  -sectorder @gol
693 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
694 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
695 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
696 -single_module  -static  -sub_library  -sub_umbrella @gol
697 -twolevel_namespace  -umbrella  -undefined @gol
698 -unexported_symbols_list  -weak_reference_mismatches @gol
699 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
700 -mkernel -mone-byte-bool}
702 @emph{DEC Alpha Options}
703 @gccoptlist{-mno-fp-regs  -msoft-float @gol
704 -mieee  -mieee-with-inexact  -mieee-conformant @gol
705 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
706 -mtrap-precision=@var{mode}  -mbuild-constants @gol
707 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
708 -mbwx  -mmax  -mfix  -mcix @gol
709 -mfloat-vax  -mfloat-ieee @gol
710 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
711 -msmall-text  -mlarge-text @gol
712 -mmemory-latency=@var{time}}
714 @emph{FR30 Options}
715 @gccoptlist{-msmall-model -mno-lsim}
717 @emph{FT32 Options}
718 @gccoptlist{-msim -mlra -mnodiv}
720 @emph{FRV Options}
721 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
722 -mhard-float  -msoft-float @gol
723 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
724 -mdouble  -mno-double @gol
725 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
726 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
727 -mlinked-fp  -mlong-calls  -malign-labels @gol
728 -mlibrary-pic  -macc-4  -macc-8 @gol
729 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
730 -moptimize-membar -mno-optimize-membar @gol
731 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
732 -mvliw-branch  -mno-vliw-branch @gol
733 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
734 -mno-nested-cond-exec  -mtomcat-stats @gol
735 -mTLS -mtls @gol
736 -mcpu=@var{cpu}}
738 @emph{GNU/Linux Options}
739 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
740 -tno-android-cc -tno-android-ld}
742 @emph{H8/300 Options}
743 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
745 @emph{HPPA Options}
746 @gccoptlist{-march=@var{architecture-type} @gol
747 -mdisable-fpregs  -mdisable-indexing @gol
748 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
749 -mfixed-range=@var{register-range} @gol
750 -mjump-in-delay -mlinker-opt -mlong-calls @gol
751 -mlong-load-store  -mno-disable-fpregs @gol
752 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
753 -mno-jump-in-delay  -mno-long-load-store @gol
754 -mno-portable-runtime  -mno-soft-float @gol
755 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
756 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
757 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
758 -munix=@var{unix-std}  -nolibdld  -static  -threads}
760 @emph{IA-64 Options}
761 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
762 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
763 -mconstant-gp  -mauto-pic  -mfused-madd @gol
764 -minline-float-divide-min-latency @gol
765 -minline-float-divide-max-throughput @gol
766 -mno-inline-float-divide @gol
767 -minline-int-divide-min-latency @gol
768 -minline-int-divide-max-throughput  @gol
769 -mno-inline-int-divide @gol
770 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
771 -mno-inline-sqrt @gol
772 -mdwarf2-asm -mearly-stop-bits @gol
773 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
774 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
775 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
776 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
777 -msched-spec-ldc -msched-spec-control-ldc @gol
778 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
779 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
780 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
781 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
783 @emph{LM32 Options}
784 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
785 -msign-extend-enabled -muser-enabled}
787 @emph{M32R/D Options}
788 @gccoptlist{-m32r2 -m32rx -m32r @gol
789 -mdebug @gol
790 -malign-loops -mno-align-loops @gol
791 -missue-rate=@var{number} @gol
792 -mbranch-cost=@var{number} @gol
793 -mmodel=@var{code-size-model-type} @gol
794 -msdata=@var{sdata-type} @gol
795 -mno-flush-func -mflush-func=@var{name} @gol
796 -mno-flush-trap -mflush-trap=@var{number} @gol
797 -G @var{num}}
799 @emph{M32C Options}
800 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
802 @emph{M680x0 Options}
803 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
804 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
805 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
806 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
807 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
808 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
809 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
810 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
811 -mxgot -mno-xgot}
813 @emph{MCore Options}
814 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
815 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
816 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
817 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
818 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
820 @emph{MeP Options}
821 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
822 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
823 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
824 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
825 -mtiny=@var{n}}
827 @emph{MicroBlaze Options}
828 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
829 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
830 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
831 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
832 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
834 @emph{MIPS Options}
835 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
836 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
837 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
838 -mips16  -mno-mips16  -mflip-mips16 @gol
839 -minterlink-compressed -mno-interlink-compressed @gol
840 -minterlink-mips16  -mno-interlink-mips16 @gol
841 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
842 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
843 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
844 -mno-float  -msingle-float  -mdouble-float @gol
845 -modd-spreg -mno-odd-spreg @gol
846 -mabs=@var{mode}  -mnan=@var{encoding} @gol
847 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
848 -mmcu -mmno-mcu @gol
849 -meva -mno-eva @gol
850 -mvirt -mno-virt @gol
851 -mxpa -mno-xpa @gol
852 -mmicromips -mno-micromips @gol
853 -mmsa -mno-msa @gol
854 -mfpu=@var{fpu-type} @gol
855 -msmartmips  -mno-smartmips @gol
856 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
857 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
858 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
859 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
860 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
861 -membedded-data  -mno-embedded-data @gol
862 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
863 -mcode-readable=@var{setting} @gol
864 -msplit-addresses  -mno-split-addresses @gol
865 -mexplicit-relocs  -mno-explicit-relocs @gol
866 -mcheck-zero-division  -mno-check-zero-division @gol
867 -mdivide-traps  -mdivide-breaks @gol
868 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
869 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
870 -mfix-24k -mno-fix-24k @gol
871 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
872 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
873 -mfix-vr4120  -mno-fix-vr4120 @gol
874 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
875 -mflush-func=@var{func}  -mno-flush-func @gol
876 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
877 -mcompact-branches=@var{policy} @gol
878 -mfp-exceptions -mno-fp-exceptions @gol
879 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
880 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address @gol
881 -mframe-header-opt -mno-frame-header-opt}
883 @emph{MMIX Options}
884 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
885 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
886 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
887 -mno-base-addresses  -msingle-exit  -mno-single-exit}
889 @emph{MN10300 Options}
890 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
891 -mno-am33 -mam33 -mam33-2 -mam34 @gol
892 -mtune=@var{cpu-type} @gol
893 -mreturn-pointer-on-d0 @gol
894 -mno-crt0  -mrelax -mliw -msetlb}
896 @emph{Moxie Options}
897 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
899 @emph{MSP430 Options}
900 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
901 -mwarn-mcu @gol
902 -mcode-region= -mdata-region= @gol
903 -msilicon-errata= -msilicon-errata-warn= @gol
904 -mhwmult= -minrt}
906 @emph{NDS32 Options}
907 @gccoptlist{-mbig-endian -mlittle-endian @gol
908 -mreduced-regs -mfull-regs @gol
909 -mcmov -mno-cmov @gol
910 -mperf-ext -mno-perf-ext @gol
911 -mv3push -mno-v3push @gol
912 -m16bit -mno-16bit @gol
913 -misr-vector-size=@var{num} @gol
914 -mcache-block-size=@var{num} @gol
915 -march=@var{arch} @gol
916 -mcmodel=@var{code-model} @gol
917 -mctor-dtor -mrelax}
919 @emph{Nios II Options}
920 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
921 -mel -meb @gol
922 -mno-bypass-cache -mbypass-cache @gol
923 -mno-cache-volatile -mcache-volatile @gol
924 -mno-fast-sw-div -mfast-sw-div @gol
925 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
926 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
927 -mcustom-fpu-cfg=@var{name} @gol
928 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
929 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
931 @emph{Nvidia PTX Options}
932 @gccoptlist{-m32 -m64 -mmainkernel -moptimize}
934 @emph{PDP-11 Options}
935 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
936 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
937 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
938 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
939 -mbranch-expensive  -mbranch-cheap @gol
940 -munix-asm  -mdec-asm}
942 @emph{picoChip Options}
943 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
944 -msymbol-as-address -mno-inefficient-warnings}
946 @emph{PowerPC Options}
947 See RS/6000 and PowerPC Options.
949 @emph{RL78 Options}
950 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
951 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
952 -m64bit-doubles -m32bit-doubles -msave-mduc-in-interrupts}
954 @emph{RS/6000 and PowerPC Options}
955 @gccoptlist{-mcpu=@var{cpu-type} @gol
956 -mtune=@var{cpu-type} @gol
957 -mcmodel=@var{code-model} @gol
958 -mpowerpc64 @gol
959 -maltivec  -mno-altivec @gol
960 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
961 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
962 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
963 -mfprnd  -mno-fprnd @gol
964 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
965 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
966 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
967 -malign-power  -malign-natural @gol
968 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
969 -msingle-float -mdouble-float -msimple-fpu @gol
970 -mstring  -mno-string  -mupdate  -mno-update @gol
971 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
972 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
973 -mstrict-align  -mno-strict-align  -mrelocatable @gol
974 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
975 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
976 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
977 -mprioritize-restricted-insns=@var{priority} @gol
978 -msched-costly-dep=@var{dependence_type} @gol
979 -minsert-sched-nops=@var{scheme} @gol
980 -mcall-sysv  -mcall-netbsd @gol
981 -maix-struct-return  -msvr4-struct-return @gol
982 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
983 -mblock-move-inline-limit=@var{num} @gol
984 -misel -mno-isel @gol
985 -misel=yes  -misel=no @gol
986 -mspe -mno-spe @gol
987 -mspe=yes  -mspe=no @gol
988 -mpaired @gol
989 -mgen-cell-microcode -mwarn-cell-microcode @gol
990 -mvrsave -mno-vrsave @gol
991 -mmulhw -mno-mulhw @gol
992 -mdlmzb -mno-dlmzb @gol
993 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
994 -mprototype  -mno-prototype @gol
995 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
996 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
997 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
998 -mno-recip-precision @gol
999 -mveclibabi=@var{type} -mfriz -mno-friz @gol
1000 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
1001 -msave-toc-indirect -mno-save-toc-indirect @gol
1002 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
1003 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
1004 -mquad-memory -mno-quad-memory @gol
1005 -mquad-memory-atomic -mno-quad-memory-atomic @gol
1006 -mcompat-align-parm -mno-compat-align-parm @gol
1007 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
1008 -mupper-regs -mno-upper-regs -mmodulo -mno-modulo @gol
1009 -mfloat128 -mno-float128 -mfloat128-hardware -mno-float128-hardware @gol
1010 -mpower9-fusion -mno-mpower9-fusion -mpower9-vector -mno-power9-vector @gol
1011 -mpower9-dform -mno-power9-dform -mlra -mno-lra}
1013 @emph{RX Options}
1014 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1015 -mcpu=@gol
1016 -mbig-endian-data -mlittle-endian-data @gol
1017 -msmall-data @gol
1018 -msim  -mno-sim@gol
1019 -mas100-syntax -mno-as100-syntax@gol
1020 -mrelax@gol
1021 -mmax-constant-size=@gol
1022 -mint-register=@gol
1023 -mpid@gol
1024 -mallow-string-insns -mno-allow-string-insns@gol
1025 -mjsr@gol
1026 -mno-warn-multiple-fast-interrupts@gol
1027 -msave-acc-in-interrupts}
1029 @emph{S/390 and zSeries Options}
1030 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1031 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
1032 -mlong-double-64 -mlong-double-128 @gol
1033 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
1034 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
1035 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1036 -mhtm -mvx -mzvector @gol
1037 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1038 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
1039 -mhotpatch=@var{halfwords},@var{halfwords}}
1041 @emph{Score Options}
1042 @gccoptlist{-meb -mel @gol
1043 -mnhwloop @gol
1044 -muls @gol
1045 -mmac @gol
1046 -mscore5 -mscore5u -mscore7 -mscore7d}
1048 @emph{SH Options}
1049 @gccoptlist{-m1  -m2  -m2e @gol
1050 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
1051 -m3  -m3e @gol
1052 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1053 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
1054 -mb  -ml  -mdalign  -mrelax @gol
1055 -mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave @gol
1056 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
1057 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
1058 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
1059 -maccumulate-outgoing-args @gol
1060 -matomic-model=@var{atomic-model} @gol
1061 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
1062 -mcbranch-force-delay-slot @gol
1063 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1064 -mpretend-cmove -mtas}
1066 @emph{Solaris 2 Options}
1067 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1068 -pthreads -pthread}
1070 @emph{SPARC Options}
1071 @gccoptlist{-mcpu=@var{cpu-type} @gol
1072 -mtune=@var{cpu-type} @gol
1073 -mcmodel=@var{code-model} @gol
1074 -mmemory-model=@var{mem-model} @gol
1075 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1076 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1077 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1078 -mhard-quad-float  -msoft-quad-float @gol
1079 -mstack-bias  -mno-stack-bias @gol
1080 -mstd-struct-return  -mno-std-struct-return @gol
1081 -munaligned-doubles  -mno-unaligned-doubles @gol
1082 -muser-mode  -mno-user-mode @gol
1083 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1084 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1085 -mcbcond -mno-cbcond @gol
1086 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1087 -mfix-at697f -mfix-ut699}
1089 @emph{SPU Options}
1090 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1091 -msafe-dma -munsafe-dma @gol
1092 -mbranch-hints @gol
1093 -msmall-mem -mlarge-mem -mstdmain @gol
1094 -mfixed-range=@var{register-range} @gol
1095 -mea32 -mea64 @gol
1096 -maddress-space-conversion -mno-address-space-conversion @gol
1097 -mcache-size=@var{cache-size} @gol
1098 -matomic-updates -mno-atomic-updates}
1100 @emph{System V Options}
1101 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1103 @emph{TILE-Gx Options}
1104 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1105 -mcmodel=@var{code-model}}
1107 @emph{TILEPro Options}
1108 @gccoptlist{-mcpu=@var{cpu} -m32}
1110 @emph{V850 Options}
1111 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1112 -mprolog-function  -mno-prolog-function  -mspace @gol
1113 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1114 -mapp-regs  -mno-app-regs @gol
1115 -mdisable-callt  -mno-disable-callt @gol
1116 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1117 -mv850e -mv850 -mv850e3v5 @gol
1118 -mloop @gol
1119 -mrelax @gol
1120 -mlong-jumps @gol
1121 -msoft-float @gol
1122 -mhard-float @gol
1123 -mgcc-abi @gol
1124 -mrh850-abi @gol
1125 -mbig-switch}
1127 @emph{VAX Options}
1128 @gccoptlist{-mg  -mgnu  -munix}
1130 @emph{Visium Options}
1131 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1132 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1134 @emph{VMS Options}
1135 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1136 -mpointer-size=@var{size}}
1138 @emph{VxWorks Options}
1139 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1140 -Xbind-lazy  -Xbind-now}
1142 @emph{x86 Options}
1143 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1144 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1145 -mfpmath=@var{unit} @gol
1146 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1147 -mno-fp-ret-in-387  -msoft-float @gol
1148 -mno-wide-multiply  -mrtd  -malign-double @gol
1149 -mpreferred-stack-boundary=@var{num} @gol
1150 -mincoming-stack-boundary=@var{num} @gol
1151 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1152 -mrecip -mrecip=@var{opt} @gol
1153 -mvzeroupper -mprefer-avx128 @gol
1154 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1155 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl @gol
1156 -mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes @gol
1157 -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
1158 -mprefetchwt1 -mclflushopt -mxsavec -mxsaves @gol
1159 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1160 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mclzero
1161 -mpku -mthreads @gol
1162 -mms-bitfields -mno-align-stringops  -minline-all-stringops @gol
1163 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1164 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1165 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1166 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1167 -mregparm=@var{num}  -msseregparm @gol
1168 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1169 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1170 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1171 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1172 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1173 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1174 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1175 -malign-data=@var{type} -mstack-protector-guard=@var{guard} @gol
1176 -mmitigate-rop}
1178 @emph{x86 Windows Options}
1179 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1180 -mnop-fun-dllimport -mthread @gol
1181 -municode -mwin32 -mwindows -fno-set-stack-executable}
1183 @emph{Xstormy16 Options}
1184 @gccoptlist{-msim}
1186 @emph{Xtensa Options}
1187 @gccoptlist{-mconst16 -mno-const16 @gol
1188 -mfused-madd  -mno-fused-madd @gol
1189 -mforce-no-pic @gol
1190 -mserialize-volatile  -mno-serialize-volatile @gol
1191 -mtext-section-literals  -mno-text-section-literals @gol
1192 -mauto-litpools  -mno-auto-litpools @gol
1193 -mtarget-align  -mno-target-align @gol
1194 -mlongcalls  -mno-longcalls}
1196 @emph{zSeries Options}
1197 See S/390 and zSeries Options.
1198 @end table
1201 @node Overall Options
1202 @section Options Controlling the Kind of Output
1204 Compilation can involve up to four stages: preprocessing, compilation
1205 proper, assembly and linking, always in that order.  GCC is capable of
1206 preprocessing and compiling several files either into several
1207 assembler input files, or into one assembler input file; then each
1208 assembler input file produces an object file, and linking combines all
1209 the object files (those newly compiled, and those specified as input)
1210 into an executable file.
1212 @cindex file name suffix
1213 For any given input file, the file name suffix determines what kind of
1214 compilation is done:
1216 @table @gcctabopt
1217 @item @var{file}.c
1218 C source code that must be preprocessed.
1220 @item @var{file}.i
1221 C source code that should not be preprocessed.
1223 @item @var{file}.ii
1224 C++ source code that should not be preprocessed.
1226 @item @var{file}.m
1227 Objective-C source code.  Note that you must link with the @file{libobjc}
1228 library to make an Objective-C program work.
1230 @item @var{file}.mi
1231 Objective-C source code that should not be preprocessed.
1233 @item @var{file}.mm
1234 @itemx @var{file}.M
1235 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1236 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1237 to a literal capital M@.
1239 @item @var{file}.mii
1240 Objective-C++ source code that should not be preprocessed.
1242 @item @var{file}.h
1243 C, C++, Objective-C or Objective-C++ header file to be turned into a
1244 precompiled header (default), or C, C++ header file to be turned into an
1245 Ada spec (via the @option{-fdump-ada-spec} switch).
1247 @item @var{file}.cc
1248 @itemx @var{file}.cp
1249 @itemx @var{file}.cxx
1250 @itemx @var{file}.cpp
1251 @itemx @var{file}.CPP
1252 @itemx @var{file}.c++
1253 @itemx @var{file}.C
1254 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1255 the last two letters must both be literally @samp{x}.  Likewise,
1256 @samp{.C} refers to a literal capital C@.
1258 @item @var{file}.mm
1259 @itemx @var{file}.M
1260 Objective-C++ source code that must be preprocessed.
1262 @item @var{file}.mii
1263 Objective-C++ source code that should not be preprocessed.
1265 @item @var{file}.hh
1266 @itemx @var{file}.H
1267 @itemx @var{file}.hp
1268 @itemx @var{file}.hxx
1269 @itemx @var{file}.hpp
1270 @itemx @var{file}.HPP
1271 @itemx @var{file}.h++
1272 @itemx @var{file}.tcc
1273 C++ header file to be turned into a precompiled header or Ada spec.
1275 @item @var{file}.f
1276 @itemx @var{file}.for
1277 @itemx @var{file}.ftn
1278 Fixed form Fortran source code that should not be preprocessed.
1280 @item @var{file}.F
1281 @itemx @var{file}.FOR
1282 @itemx @var{file}.fpp
1283 @itemx @var{file}.FPP
1284 @itemx @var{file}.FTN
1285 Fixed form Fortran source code that must be preprocessed (with the traditional
1286 preprocessor).
1288 @item @var{file}.f90
1289 @itemx @var{file}.f95
1290 @itemx @var{file}.f03
1291 @itemx @var{file}.f08
1292 Free form Fortran source code that should not be preprocessed.
1294 @item @var{file}.F90
1295 @itemx @var{file}.F95
1296 @itemx @var{file}.F03
1297 @itemx @var{file}.F08
1298 Free form Fortran source code that must be preprocessed (with the
1299 traditional preprocessor).
1301 @item @var{file}.go
1302 Go source code.
1304 @c FIXME: Descriptions of Java file types.
1305 @c @var{file}.java
1306 @c @var{file}.class
1307 @c @var{file}.zip
1308 @c @var{file}.jar
1310 @item @var{file}.ads
1311 Ada source code file that contains a library unit declaration (a
1312 declaration of a package, subprogram, or generic, or a generic
1313 instantiation), or a library unit renaming declaration (a package,
1314 generic, or subprogram renaming declaration).  Such files are also
1315 called @dfn{specs}.
1317 @item @var{file}.adb
1318 Ada source code file containing a library unit body (a subprogram or
1319 package body).  Such files are also called @dfn{bodies}.
1321 @c GCC also knows about some suffixes for languages not yet included:
1322 @c Pascal:
1323 @c @var{file}.p
1324 @c @var{file}.pas
1325 @c Ratfor:
1326 @c @var{file}.r
1328 @item @var{file}.s
1329 Assembler code.
1331 @item @var{file}.S
1332 @itemx @var{file}.sx
1333 Assembler code that must be preprocessed.
1335 @item @var{other}
1336 An object file to be fed straight into linking.
1337 Any file name with no recognized suffix is treated this way.
1338 @end table
1340 @opindex x
1341 You can specify the input language explicitly with the @option{-x} option:
1343 @table @gcctabopt
1344 @item -x @var{language}
1345 Specify explicitly the @var{language} for the following input files
1346 (rather than letting the compiler choose a default based on the file
1347 name suffix).  This option applies to all following input files until
1348 the next @option{-x} option.  Possible values for @var{language} are:
1349 @smallexample
1350 c  c-header  cpp-output
1351 c++  c++-header  c++-cpp-output
1352 objective-c  objective-c-header  objective-c-cpp-output
1353 objective-c++ objective-c++-header objective-c++-cpp-output
1354 assembler  assembler-with-cpp
1356 f77  f77-cpp-input f95  f95-cpp-input
1358 java
1359 @end smallexample
1361 @item -x none
1362 Turn off any specification of a language, so that subsequent files are
1363 handled according to their file name suffixes (as they are if @option{-x}
1364 has not been used at all).
1365 @end table
1367 If you only want some of the stages of compilation, you can use
1368 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1369 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1370 @command{gcc} is to stop.  Note that some combinations (for example,
1371 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1373 @table @gcctabopt
1374 @item -c
1375 @opindex c
1376 Compile or assemble the source files, but do not link.  The linking
1377 stage simply is not done.  The ultimate output is in the form of an
1378 object file for each source file.
1380 By default, the object file name for a source file is made by replacing
1381 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1383 Unrecognized input files, not requiring compilation or assembly, are
1384 ignored.
1386 @item -S
1387 @opindex S
1388 Stop after the stage of compilation proper; do not assemble.  The output
1389 is in the form of an assembler code file for each non-assembler input
1390 file specified.
1392 By default, the assembler file name for a source file is made by
1393 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1395 Input files that don't require compilation are ignored.
1397 @item -E
1398 @opindex E
1399 Stop after the preprocessing stage; do not run the compiler proper.  The
1400 output is in the form of preprocessed source code, which is sent to the
1401 standard output.
1403 Input files that don't require preprocessing are ignored.
1405 @cindex output file option
1406 @item -o @var{file}
1407 @opindex o
1408 Place output in file @var{file}.  This applies to whatever
1409 sort of output is being produced, whether it be an executable file,
1410 an object file, an assembler file or preprocessed C code.
1412 If @option{-o} is not specified, the default is to put an executable
1413 file in @file{a.out}, the object file for
1414 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1415 assembler file in @file{@var{source}.s}, a precompiled header file in
1416 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1417 standard output.
1419 @item -v
1420 @opindex v
1421 Print (on standard error output) the commands executed to run the stages
1422 of compilation.  Also print the version number of the compiler driver
1423 program and of the preprocessor and the compiler proper.
1425 @item -###
1426 @opindex ###
1427 Like @option{-v} except the commands are not executed and arguments
1428 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1429 This is useful for shell scripts to capture the driver-generated command lines.
1431 @item --help
1432 @opindex help
1433 Print (on the standard output) a description of the command-line options
1434 understood by @command{gcc}.  If the @option{-v} option is also specified
1435 then @option{--help} is also passed on to the various processes
1436 invoked by @command{gcc}, so that they can display the command-line options
1437 they accept.  If the @option{-Wextra} option has also been specified
1438 (prior to the @option{--help} option), then command-line options that
1439 have no documentation associated with them are also displayed.
1441 @item --target-help
1442 @opindex target-help
1443 Print (on the standard output) a description of target-specific command-line
1444 options for each tool.  For some targets extra target-specific
1445 information may also be printed.
1447 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1448 Print (on the standard output) a description of the command-line
1449 options understood by the compiler that fit into all specified classes
1450 and qualifiers.  These are the supported classes:
1452 @table @asis
1453 @item @samp{optimizers}
1454 Display all of the optimization options supported by the
1455 compiler.
1457 @item @samp{warnings}
1458 Display all of the options controlling warning messages
1459 produced by the compiler.
1461 @item @samp{target}
1462 Display target-specific options.  Unlike the
1463 @option{--target-help} option however, target-specific options of the
1464 linker and assembler are not displayed.  This is because those
1465 tools do not currently support the extended @option{--help=} syntax.
1467 @item @samp{params}
1468 Display the values recognized by the @option{--param}
1469 option.
1471 @item @var{language}
1472 Display the options supported for @var{language}, where
1473 @var{language} is the name of one of the languages supported in this
1474 version of GCC@.
1476 @item @samp{common}
1477 Display the options that are common to all languages.
1478 @end table
1480 These are the supported qualifiers:
1482 @table @asis
1483 @item @samp{undocumented}
1484 Display only those options that are undocumented.
1486 @item @samp{joined}
1487 Display options taking an argument that appears after an equal
1488 sign in the same continuous piece of text, such as:
1489 @samp{--help=target}.
1491 @item @samp{separate}
1492 Display options taking an argument that appears as a separate word
1493 following the original option, such as: @samp{-o output-file}.
1494 @end table
1496 Thus for example to display all the undocumented target-specific
1497 switches supported by the compiler, use:
1499 @smallexample
1500 --help=target,undocumented
1501 @end smallexample
1503 The sense of a qualifier can be inverted by prefixing it with the
1504 @samp{^} character, so for example to display all binary warning
1505 options (i.e., ones that are either on or off and that do not take an
1506 argument) that have a description, use:
1508 @smallexample
1509 --help=warnings,^joined,^undocumented
1510 @end smallexample
1512 The argument to @option{--help=} should not consist solely of inverted
1513 qualifiers.
1515 Combining several classes is possible, although this usually
1516 restricts the output so much that there is nothing to display.  One
1517 case where it does work, however, is when one of the classes is
1518 @var{target}.  For example, to display all the target-specific
1519 optimization options, use:
1521 @smallexample
1522 --help=target,optimizers
1523 @end smallexample
1525 The @option{--help=} option can be repeated on the command line.  Each
1526 successive use displays its requested class of options, skipping
1527 those that have already been displayed.
1529 If the @option{-Q} option appears on the command line before the
1530 @option{--help=} option, then the descriptive text displayed by
1531 @option{--help=} is changed.  Instead of describing the displayed
1532 options, an indication is given as to whether the option is enabled,
1533 disabled or set to a specific value (assuming that the compiler
1534 knows this at the point where the @option{--help=} option is used).
1536 Here is a truncated example from the ARM port of @command{gcc}:
1538 @smallexample
1539   % gcc -Q -mabi=2 --help=target -c
1540   The following options are target specific:
1541   -mabi=                                2
1542   -mabort-on-noreturn                   [disabled]
1543   -mapcs                                [disabled]
1544 @end smallexample
1546 The output is sensitive to the effects of previous command-line
1547 options, so for example it is possible to find out which optimizations
1548 are enabled at @option{-O2} by using:
1550 @smallexample
1551 -Q -O2 --help=optimizers
1552 @end smallexample
1554 Alternatively you can discover which binary optimizations are enabled
1555 by @option{-O3} by using:
1557 @smallexample
1558 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1559 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1560 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1561 @end smallexample
1563 @item --version
1564 @opindex version
1565 Display the version number and copyrights of the invoked GCC@.
1567 @item -pass-exit-codes
1568 @opindex pass-exit-codes
1569 Normally the @command{gcc} program exits with the code of 1 if any
1570 phase of the compiler returns a non-success return code.  If you specify
1571 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1572 the numerically highest error produced by any phase returning an error
1573 indication.  The C, C++, and Fortran front ends return 4 if an internal
1574 compiler error is encountered.
1576 @item -pipe
1577 @opindex pipe
1578 Use pipes rather than temporary files for communication between the
1579 various stages of compilation.  This fails to work on some systems where
1580 the assembler is unable to read from a pipe; but the GNU assembler has
1581 no trouble.
1583 @item -specs=@var{file}
1584 @opindex specs
1585 Process @var{file} after the compiler reads in the standard @file{specs}
1586 file, in order to override the defaults which the @command{gcc} driver
1587 program uses when determining what switches to pass to @command{cc1},
1588 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1589 @option{-specs=@var{file}} can be specified on the command line, and they
1590 are processed in order, from left to right.  @xref{Spec Files}, for
1591 information about the format of the @var{file}.
1593 @item -wrapper
1594 @opindex wrapper
1595 Invoke all subcommands under a wrapper program.  The name of the
1596 wrapper program and its parameters are passed as a comma separated
1597 list.
1599 @smallexample
1600 gcc -c t.c -wrapper gdb,--args
1601 @end smallexample
1603 @noindent
1604 This invokes all subprograms of @command{gcc} under
1605 @samp{gdb --args}, thus the invocation of @command{cc1} is
1606 @samp{gdb --args cc1 @dots{}}.
1608 @item -fplugin=@var{name}.so
1609 @opindex fplugin
1610 Load the plugin code in file @var{name}.so, assumed to be a
1611 shared object to be dlopen'd by the compiler.  The base name of
1612 the shared object file is used to identify the plugin for the
1613 purposes of argument parsing (See
1614 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1615 Each plugin should define the callback functions specified in the
1616 Plugins API.
1618 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1619 @opindex fplugin-arg
1620 Define an argument called @var{key} with a value of @var{value}
1621 for the plugin called @var{name}.
1623 @item -fdump-ada-spec@r{[}-slim@r{]}
1624 @opindex fdump-ada-spec
1625 For C and C++ source and include files, generate corresponding Ada specs.
1626 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1627 GNAT User's Guide}, which provides detailed documentation on this feature.
1629 @item -fada-spec-parent=@var{unit}
1630 @opindex fada-spec-parent
1631 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1632 Ada specs as child units of parent @var{unit}.
1634 @item -fdump-go-spec=@var{file}
1635 @opindex fdump-go-spec
1636 For input files in any language, generate corresponding Go
1637 declarations in @var{file}.  This generates Go @code{const},
1638 @code{type}, @code{var}, and @code{func} declarations which may be a
1639 useful way to start writing a Go interface to code written in some
1640 other language.
1642 @include @value{srcdir}/../libiberty/at-file.texi
1643 @end table
1645 @node Invoking G++
1646 @section Compiling C++ Programs
1648 @cindex suffixes for C++ source
1649 @cindex C++ source file suffixes
1650 C++ source files conventionally use one of the suffixes @samp{.C},
1651 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1652 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1653 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1654 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1655 files with these names and compiles them as C++ programs even if you
1656 call the compiler the same way as for compiling C programs (usually
1657 with the name @command{gcc}).
1659 @findex g++
1660 @findex c++
1661 However, the use of @command{gcc} does not add the C++ library.
1662 @command{g++} is a program that calls GCC and automatically specifies linking
1663 against the C++ library.  It treats @samp{.c},
1664 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1665 files unless @option{-x} is used.  This program is also useful when
1666 precompiling a C header file with a @samp{.h} extension for use in C++
1667 compilations.  On many systems, @command{g++} is also installed with
1668 the name @command{c++}.
1670 @cindex invoking @command{g++}
1671 When you compile C++ programs, you may specify many of the same
1672 command-line options that you use for compiling programs in any
1673 language; or command-line options meaningful for C and related
1674 languages; or options that are meaningful only for C++ programs.
1675 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1676 explanations of options for languages related to C@.
1677 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1678 explanations of options that are meaningful only for C++ programs.
1680 @node C Dialect Options
1681 @section Options Controlling C Dialect
1682 @cindex dialect options
1683 @cindex language dialect options
1684 @cindex options, dialect
1686 The following options control the dialect of C (or languages derived
1687 from C, such as C++, Objective-C and Objective-C++) that the compiler
1688 accepts:
1690 @table @gcctabopt
1691 @cindex ANSI support
1692 @cindex ISO support
1693 @item -ansi
1694 @opindex ansi
1695 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1696 equivalent to @option{-std=c++98}.
1698 This turns off certain features of GCC that are incompatible with ISO
1699 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1700 such as the @code{asm} and @code{typeof} keywords, and
1701 predefined macros such as @code{unix} and @code{vax} that identify the
1702 type of system you are using.  It also enables the undesirable and
1703 rarely used ISO trigraph feature.  For the C compiler,
1704 it disables recognition of C++ style @samp{//} comments as well as
1705 the @code{inline} keyword.
1707 The alternate keywords @code{__asm__}, @code{__extension__},
1708 @code{__inline__} and @code{__typeof__} continue to work despite
1709 @option{-ansi}.  You would not want to use them in an ISO C program, of
1710 course, but it is useful to put them in header files that might be included
1711 in compilations done with @option{-ansi}.  Alternate predefined macros
1712 such as @code{__unix__} and @code{__vax__} are also available, with or
1713 without @option{-ansi}.
1715 The @option{-ansi} option does not cause non-ISO programs to be
1716 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1717 addition to @option{-ansi}.  @xref{Warning Options}.
1719 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1720 option is used.  Some header files may notice this macro and refrain
1721 from declaring certain functions or defining certain macros that the
1722 ISO standard doesn't call for; this is to avoid interfering with any
1723 programs that might use these names for other things.
1725 Functions that are normally built in but do not have semantics
1726 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1727 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1728 built-in functions provided by GCC}, for details of the functions
1729 affected.
1731 @item -std=
1732 @opindex std
1733 Determine the language standard. @xref{Standards,,Language Standards
1734 Supported by GCC}, for details of these standard versions.  This option
1735 is currently only supported when compiling C or C++.
1737 The compiler can accept several base standards, such as @samp{c90} or
1738 @samp{c++98}, and GNU dialects of those standards, such as
1739 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1740 compiler accepts all programs following that standard plus those
1741 using GNU extensions that do not contradict it.  For example,
1742 @option{-std=c90} turns off certain features of GCC that are
1743 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1744 keywords, but not other GNU extensions that do not have a meaning in
1745 ISO C90, such as omitting the middle term of a @code{?:}
1746 expression. On the other hand, when a GNU dialect of a standard is
1747 specified, all features supported by the compiler are enabled, even when
1748 those features change the meaning of the base standard.  As a result, some
1749 strict-conforming programs may be rejected.  The particular standard
1750 is used by @option{-Wpedantic} to identify which features are GNU
1751 extensions given that version of the standard. For example
1752 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1753 comments, while @option{-std=gnu99 -Wpedantic} does not.
1755 A value for this option must be provided; possible values are
1757 @table @samp
1758 @item c90
1759 @itemx c89
1760 @itemx iso9899:1990
1761 Support all ISO C90 programs (certain GNU extensions that conflict
1762 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1764 @item iso9899:199409
1765 ISO C90 as modified in amendment 1.
1767 @item c99
1768 @itemx c9x
1769 @itemx iso9899:1999
1770 @itemx iso9899:199x
1771 ISO C99.  This standard is substantially completely supported, modulo
1772 bugs and floating-point issues
1773 (mainly but not entirely relating to optional C99 features from
1774 Annexes F and G).  See
1775 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1776 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1778 @item c11
1779 @itemx c1x
1780 @itemx iso9899:2011
1781 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1782 substantially completely supported, modulo bugs, floating-point issues
1783 (mainly but not entirely relating to optional C11 features from
1784 Annexes F and G) and the optional Annexes K (Bounds-checking
1785 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1787 @item gnu90
1788 @itemx gnu89
1789 GNU dialect of ISO C90 (including some C99 features).
1791 @item gnu99
1792 @itemx gnu9x
1793 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1795 @item gnu11
1796 @itemx gnu1x
1797 GNU dialect of ISO C11.  This is the default for C code.
1798 The name @samp{gnu1x} is deprecated.
1800 @item c++98
1801 @itemx c++03
1802 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1803 additional defect reports. Same as @option{-ansi} for C++ code.
1805 @item gnu++98
1806 @itemx gnu++03
1807 GNU dialect of @option{-std=c++98}.
1809 @item c++11
1810 @itemx c++0x
1811 The 2011 ISO C++ standard plus amendments.
1812 The name @samp{c++0x} is deprecated.
1814 @item gnu++11
1815 @itemx gnu++0x
1816 GNU dialect of @option{-std=c++11}.
1817 The name @samp{gnu++0x} is deprecated.
1819 @item c++14
1820 @itemx c++1y
1821 The 2014 ISO C++ standard plus amendments.
1822 The name @samp{c++1y} is deprecated.
1824 @item gnu++14
1825 @itemx gnu++1y
1826 GNU dialect of @option{-std=c++14}.
1827 This is the default for C++ code.
1828 The name @samp{gnu++1y} is deprecated.
1830 @item c++1z
1831 The next revision of the ISO C++ standard, tentatively planned for
1832 2017.  Support is highly experimental, and will almost certainly
1833 change in incompatible ways in future releases.
1835 @item gnu++1z
1836 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1837 and will almost certainly change in incompatible ways in future
1838 releases.
1839 @end table
1841 @item -fgnu89-inline
1842 @opindex fgnu89-inline
1843 The option @option{-fgnu89-inline} tells GCC to use the traditional
1844 GNU semantics for @code{inline} functions when in C99 mode.
1845 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1846 Using this option is roughly equivalent to adding the
1847 @code{gnu_inline} function attribute to all inline functions
1848 (@pxref{Function Attributes}).
1850 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1851 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1852 specifies the default behavior).
1853 This option is not supported in @option{-std=c90} or
1854 @option{-std=gnu90} mode.
1856 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1857 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1858 in effect for @code{inline} functions.  @xref{Common Predefined
1859 Macros,,,cpp,The C Preprocessor}.
1861 @item -aux-info @var{filename}
1862 @opindex aux-info
1863 Output to the given filename prototyped declarations for all functions
1864 declared and/or defined in a translation unit, including those in header
1865 files.  This option is silently ignored in any language other than C@.
1867 Besides declarations, the file indicates, in comments, the origin of
1868 each declaration (source file and line), whether the declaration was
1869 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1870 @samp{O} for old, respectively, in the first character after the line
1871 number and the colon), and whether it came from a declaration or a
1872 definition (@samp{C} or @samp{F}, respectively, in the following
1873 character).  In the case of function definitions, a K&R-style list of
1874 arguments followed by their declarations is also provided, inside
1875 comments, after the declaration.
1877 @item -fallow-parameterless-variadic-functions
1878 @opindex fallow-parameterless-variadic-functions
1879 Accept variadic functions without named parameters.
1881 Although it is possible to define such a function, this is not very
1882 useful as it is not possible to read the arguments.  This is only
1883 supported for C as this construct is allowed by C++.
1885 @item -fno-asm
1886 @opindex fno-asm
1887 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1888 keyword, so that code can use these words as identifiers.  You can use
1889 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1890 instead.  @option{-ansi} implies @option{-fno-asm}.
1892 In C++, this switch only affects the @code{typeof} keyword, since
1893 @code{asm} and @code{inline} are standard keywords.  You may want to
1894 use the @option{-fno-gnu-keywords} flag instead, which has the same
1895 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1896 switch only affects the @code{asm} and @code{typeof} keywords, since
1897 @code{inline} is a standard keyword in ISO C99.
1899 @item -fno-builtin
1900 @itemx -fno-builtin-@var{function}
1901 @opindex fno-builtin
1902 @cindex built-in functions
1903 Don't recognize built-in functions that do not begin with
1904 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1905 functions provided by GCC}, for details of the functions affected,
1906 including those which are not built-in functions when @option{-ansi} or
1907 @option{-std} options for strict ISO C conformance are used because they
1908 do not have an ISO standard meaning.
1910 GCC normally generates special code to handle certain built-in functions
1911 more efficiently; for instance, calls to @code{alloca} may become single
1912 instructions which adjust the stack directly, and calls to @code{memcpy}
1913 may become inline copy loops.  The resulting code is often both smaller
1914 and faster, but since the function calls no longer appear as such, you
1915 cannot set a breakpoint on those calls, nor can you change the behavior
1916 of the functions by linking with a different library.  In addition,
1917 when a function is recognized as a built-in function, GCC may use
1918 information about that function to warn about problems with calls to
1919 that function, or to generate more efficient code, even if the
1920 resulting code still contains calls to that function.  For example,
1921 warnings are given with @option{-Wformat} for bad calls to
1922 @code{printf} when @code{printf} is built in and @code{strlen} is
1923 known not to modify global memory.
1925 With the @option{-fno-builtin-@var{function}} option
1926 only the built-in function @var{function} is
1927 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1928 function is named that is not built-in in this version of GCC, this
1929 option is ignored.  There is no corresponding
1930 @option{-fbuiltin-@var{function}} option; if you wish to enable
1931 built-in functions selectively when using @option{-fno-builtin} or
1932 @option{-ffreestanding}, you may define macros such as:
1934 @smallexample
1935 #define abs(n)          __builtin_abs ((n))
1936 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1937 @end smallexample
1939 @item -fhosted
1940 @opindex fhosted
1941 @cindex hosted environment
1943 Assert that compilation targets a hosted environment.  This implies
1944 @option{-fbuiltin}.  A hosted environment is one in which the
1945 entire standard library is available, and in which @code{main} has a return
1946 type of @code{int}.  Examples are nearly everything except a kernel.
1947 This is equivalent to @option{-fno-freestanding}.
1949 @item -ffreestanding
1950 @opindex ffreestanding
1951 @cindex hosted environment
1953 Assert that compilation targets a freestanding environment.  This
1954 implies @option{-fno-builtin}.  A freestanding environment
1955 is one in which the standard library may not exist, and program startup may
1956 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1957 This is equivalent to @option{-fno-hosted}.
1959 @xref{Standards,,Language Standards Supported by GCC}, for details of
1960 freestanding and hosted environments.
1962 @item -fopenacc
1963 @opindex fopenacc
1964 @cindex OpenACC accelerator programming
1965 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1966 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1967 compiler generates accelerated code according to the OpenACC Application
1968 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1969 implies @option{-pthread}, and thus is only supported on targets that
1970 have support for @option{-pthread}.
1972 @item -fopenacc-dim=@var{geom}
1973 @opindex fopenacc-dim
1974 @cindex OpenACC accelerator programming
1975 Specify default compute dimensions for parallel offload regions that do
1976 not explicitly specify.  The @var{geom} value is a triple of
1977 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
1978 can be omitted, to use a target-specific default value.
1980 @item -fopenmp
1981 @opindex fopenmp
1982 @cindex OpenMP parallel
1983 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1984 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1985 compiler generates parallel code according to the OpenMP Application
1986 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1987 implies @option{-pthread}, and thus is only supported on targets that
1988 have support for @option{-pthread}. @option{-fopenmp} implies
1989 @option{-fopenmp-simd}.
1991 @item -fopenmp-simd
1992 @opindex fopenmp-simd
1993 @cindex OpenMP SIMD
1994 @cindex SIMD
1995 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1996 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1997 are ignored.
1999 @item -fcilkplus
2000 @opindex fcilkplus
2001 @cindex Enable Cilk Plus
2002 Enable the usage of Cilk Plus language extension features for C/C++.
2003 When the option @option{-fcilkplus} is specified, enable the usage of
2004 the Cilk Plus Language extension features for C/C++.  The present
2005 implementation follows ABI version 1.2.  This is an experimental
2006 feature that is only partially complete, and whose interface may
2007 change in future versions of GCC as the official specification
2008 changes.  Currently, all features but @code{_Cilk_for} have been
2009 implemented.
2011 @item -fgnu-tm
2012 @opindex fgnu-tm
2013 When the option @option{-fgnu-tm} is specified, the compiler
2014 generates code for the Linux variant of Intel's current Transactional
2015 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2016 an experimental feature whose interface may change in future versions
2017 of GCC, as the official specification changes.  Please note that not
2018 all architectures are supported for this feature.
2020 For more information on GCC's support for transactional memory,
2021 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2022 Transactional Memory Library}.
2024 Note that the transactional memory feature is not supported with
2025 non-call exceptions (@option{-fnon-call-exceptions}).
2027 @item -fms-extensions
2028 @opindex fms-extensions
2029 Accept some non-standard constructs used in Microsoft header files.
2031 In C++ code, this allows member names in structures to be similar
2032 to previous types declarations.
2034 @smallexample
2035 typedef int UOW;
2036 struct ABC @{
2037   UOW UOW;
2039 @end smallexample
2041 Some cases of unnamed fields in structures and unions are only
2042 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2043 fields within structs/unions}, for details.
2045 Note that this option is off for all targets but x86 
2046 targets using ms-abi.
2048 @item -fplan9-extensions
2049 @opindex fplan9-extensions
2050 Accept some non-standard constructs used in Plan 9 code.
2052 This enables @option{-fms-extensions}, permits passing pointers to
2053 structures with anonymous fields to functions that expect pointers to
2054 elements of the type of the field, and permits referring to anonymous
2055 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2056 struct/union fields within structs/unions}, for details.  This is only
2057 supported for C, not C++.
2059 @item -trigraphs
2060 @opindex trigraphs
2061 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2062 options for strict ISO C conformance) implies @option{-trigraphs}.
2064 @cindex traditional C language
2065 @cindex C language, traditional
2066 @item -traditional
2067 @itemx -traditional-cpp
2068 @opindex traditional-cpp
2069 @opindex traditional
2070 Formerly, these options caused GCC to attempt to emulate a pre-standard
2071 C compiler.  They are now only supported with the @option{-E} switch.
2072 The preprocessor continues to support a pre-standard mode.  See the GNU
2073 CPP manual for details.
2075 @item -fcond-mismatch
2076 @opindex fcond-mismatch
2077 Allow conditional expressions with mismatched types in the second and
2078 third arguments.  The value of such an expression is void.  This option
2079 is not supported for C++.
2081 @item -flax-vector-conversions
2082 @opindex flax-vector-conversions
2083 Allow implicit conversions between vectors with differing numbers of
2084 elements and/or incompatible element types.  This option should not be
2085 used for new code.
2087 @item -funsigned-char
2088 @opindex funsigned-char
2089 Let the type @code{char} be unsigned, like @code{unsigned char}.
2091 Each kind of machine has a default for what @code{char} should
2092 be.  It is either like @code{unsigned char} by default or like
2093 @code{signed char} by default.
2095 Ideally, a portable program should always use @code{signed char} or
2096 @code{unsigned char} when it depends on the signedness of an object.
2097 But many programs have been written to use plain @code{char} and
2098 expect it to be signed, or expect it to be unsigned, depending on the
2099 machines they were written for.  This option, and its inverse, let you
2100 make such a program work with the opposite default.
2102 The type @code{char} is always a distinct type from each of
2103 @code{signed char} or @code{unsigned char}, even though its behavior
2104 is always just like one of those two.
2106 @item -fsigned-char
2107 @opindex fsigned-char
2108 Let the type @code{char} be signed, like @code{signed char}.
2110 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2111 the negative form of @option{-funsigned-char}.  Likewise, the option
2112 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2114 @item -fsigned-bitfields
2115 @itemx -funsigned-bitfields
2116 @itemx -fno-signed-bitfields
2117 @itemx -fno-unsigned-bitfields
2118 @opindex fsigned-bitfields
2119 @opindex funsigned-bitfields
2120 @opindex fno-signed-bitfields
2121 @opindex fno-unsigned-bitfields
2122 These options control whether a bit-field is signed or unsigned, when the
2123 declaration does not use either @code{signed} or @code{unsigned}.  By
2124 default, such a bit-field is signed, because this is consistent: the
2125 basic integer types such as @code{int} are signed types.
2127 @item -fsso-struct=@var{endianness}
2128 @opindex fsso-struct
2129 Set the default scalar storage order of structures and unions to the
2130 specified endianness.  The accepted values are @samp{big-endian} and
2131 @samp{little-endian}.  If the option is not passed, the compiler uses
2132 the native endianness of the target.  This option is not supported for C++.
2134 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2135 code that is not binary compatible with code generated without it if the
2136 specified endianness is not the native endianness of the target.
2137 @end table
2139 @node C++ Dialect Options
2140 @section Options Controlling C++ Dialect
2142 @cindex compiler options, C++
2143 @cindex C++ options, command-line
2144 @cindex options, C++
2145 This section describes the command-line options that are only meaningful
2146 for C++ programs.  You can also use most of the GNU compiler options
2147 regardless of what language your program is in.  For example, you
2148 might compile a file @file{firstClass.C} like this:
2150 @smallexample
2151 g++ -g -fstrict-enums -O -c firstClass.C
2152 @end smallexample
2154 @noindent
2155 In this example, only @option{-fstrict-enums} is an option meant
2156 only for C++ programs; you can use the other options with any
2157 language supported by GCC@.
2159 Some options for compiling C programs, such as @option{-std}, are also
2160 relevant for C++ programs.
2161 @xref{C Dialect Options,,Options Controlling C Dialect}.
2163 Here is a list of options that are @emph{only} for compiling C++ programs:
2165 @table @gcctabopt
2167 @item -fabi-version=@var{n}
2168 @opindex fabi-version
2169 Use version @var{n} of the C++ ABI@.  The default is version 0.
2171 Version 0 refers to the version conforming most closely to
2172 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2173 will change in different versions of G++ as ABI bugs are fixed.
2175 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2177 Version 2 is the version of the C++ ABI that first appeared in G++
2178 3.4, and was the default through G++ 4.9.
2180 Version 3 corrects an error in mangling a constant address as a
2181 template argument.
2183 Version 4, which first appeared in G++ 4.5, implements a standard
2184 mangling for vector types.
2186 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2187 attribute const/volatile on function pointer types, decltype of a
2188 plain decl, and use of a function parameter in the declaration of
2189 another parameter.
2191 Version 6, which first appeared in G++ 4.7, corrects the promotion
2192 behavior of C++11 scoped enums and the mangling of template argument
2193 packs, const/static_cast, prefix ++ and --, and a class scope function
2194 used as a template argument.
2196 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2197 builtin type and corrects the mangling of lambdas in default argument
2198 scope.
2200 Version 8, which first appeared in G++ 4.9, corrects the substitution
2201 behavior of function types with function-cv-qualifiers.
2203 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2204 @code{nullptr_t}.
2206 Version 10, which first appeared in G++ 6.1, adds mangling of
2207 attributes that affect type identity, such as ia32 calling convention
2208 attributes (e.g. @samp{stdcall}).
2210 See also @option{-Wabi}.
2212 @item -fabi-compat-version=@var{n}
2213 @opindex fabi-compat-version
2214 On targets that support strong aliases, G++
2215 works around mangling changes by creating an alias with the correct
2216 mangled name when defining a symbol with an incorrect mangled name.
2217 This switch specifies which ABI version to use for the alias.
2219 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2220 compatibility).  If another ABI version is explicitly selected, this
2221 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2222 use @option{-fabi-compat-version=2}.
2224 If this option is not provided but @option{-Wabi=@var{n}} is, that
2225 version is used for compatibility aliases.  If this option is provided
2226 along with @option{-Wabi} (without the version), the version from this
2227 option is used for the warning.
2229 @item -fno-access-control
2230 @opindex fno-access-control
2231 Turn off all access checking.  This switch is mainly useful for working
2232 around bugs in the access control code.
2234 @item -fcheck-new
2235 @opindex fcheck-new
2236 Check that the pointer returned by @code{operator new} is non-null
2237 before attempting to modify the storage allocated.  This check is
2238 normally unnecessary because the C++ standard specifies that
2239 @code{operator new} only returns @code{0} if it is declared
2240 @code{throw()}, in which case the compiler always checks the
2241 return value even without this option.  In all other cases, when
2242 @code{operator new} has a non-empty exception specification, memory
2243 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2244 @samp{new (nothrow)}.
2246 @item -fconcepts
2247 @opindex fconcepts
2248 Enable support for the C++ Extensions for Concepts Technical
2249 Specification, ISO 19217 (2015), which allows code like
2251 @smallexample
2252 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2253 template <Addable T> T add (T a, T b) @{ return a + b; @}
2254 @end smallexample
2256 @item -fconstexpr-depth=@var{n}
2257 @opindex fconstexpr-depth
2258 Set the maximum nested evaluation depth for C++11 constexpr functions
2259 to @var{n}.  A limit is needed to detect endless recursion during
2260 constant expression evaluation.  The minimum specified by the standard
2261 is 512.
2263 @item -fdeduce-init-list
2264 @opindex fdeduce-init-list
2265 Enable deduction of a template type parameter as
2266 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2268 @smallexample
2269 template <class T> auto forward(T t) -> decltype (realfn (t))
2271   return realfn (t);
2274 void f()
2276   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2278 @end smallexample
2280 This deduction was implemented as a possible extension to the
2281 originally proposed semantics for the C++11 standard, but was not part
2282 of the final standard, so it is disabled by default.  This option is
2283 deprecated, and may be removed in a future version of G++.
2285 @item -ffriend-injection
2286 @opindex ffriend-injection
2287 Inject friend functions into the enclosing namespace, so that they are
2288 visible outside the scope of the class in which they are declared.
2289 Friend functions were documented to work this way in the old Annotated
2290 C++ Reference Manual.  
2291 However, in ISO C++ a friend function that is not declared
2292 in an enclosing scope can only be found using argument dependent
2293 lookup.  GCC defaults to the standard behavior.
2295 This option is for compatibility, and may be removed in a future
2296 release of G++.
2298 @item -fno-elide-constructors
2299 @opindex fno-elide-constructors
2300 The C++ standard allows an implementation to omit creating a temporary
2301 that is only used to initialize another object of the same type.
2302 Specifying this option disables that optimization, and forces G++ to
2303 call the copy constructor in all cases.
2305 @item -fno-enforce-eh-specs
2306 @opindex fno-enforce-eh-specs
2307 Don't generate code to check for violation of exception specifications
2308 at run time.  This option violates the C++ standard, but may be useful
2309 for reducing code size in production builds, much like defining
2310 @code{NDEBUG}.  This does not give user code permission to throw
2311 exceptions in violation of the exception specifications; the compiler
2312 still optimizes based on the specifications, so throwing an
2313 unexpected exception results in undefined behavior at run time.
2315 @item -fextern-tls-init
2316 @itemx -fno-extern-tls-init
2317 @opindex fextern-tls-init
2318 @opindex fno-extern-tls-init
2319 The C++11 and OpenMP standards allow @code{thread_local} and
2320 @code{threadprivate} variables to have dynamic (runtime)
2321 initialization.  To support this, any use of such a variable goes
2322 through a wrapper function that performs any necessary initialization.
2323 When the use and definition of the variable are in the same
2324 translation unit, this overhead can be optimized away, but when the
2325 use is in a different translation unit there is significant overhead
2326 even if the variable doesn't actually need dynamic initialization.  If
2327 the programmer can be sure that no use of the variable in a
2328 non-defining TU needs to trigger dynamic initialization (either
2329 because the variable is statically initialized, or a use of the
2330 variable in the defining TU will be executed before any uses in
2331 another TU), they can avoid this overhead with the
2332 @option{-fno-extern-tls-init} option.
2334 On targets that support symbol aliases, the default is
2335 @option{-fextern-tls-init}.  On targets that do not support symbol
2336 aliases, the default is @option{-fno-extern-tls-init}.
2338 @item -ffor-scope
2339 @itemx -fno-for-scope
2340 @opindex ffor-scope
2341 @opindex fno-for-scope
2342 If @option{-ffor-scope} is specified, the scope of variables declared in
2343 a @i{for-init-statement} is limited to the @code{for} loop itself,
2344 as specified by the C++ standard.
2345 If @option{-fno-for-scope} is specified, the scope of variables declared in
2346 a @i{for-init-statement} extends to the end of the enclosing scope,
2347 as was the case in old versions of G++, and other (traditional)
2348 implementations of C++.
2350 If neither flag is given, the default is to follow the standard,
2351 but to allow and give a warning for old-style code that would
2352 otherwise be invalid, or have different behavior.
2354 @item -fno-gnu-keywords
2355 @opindex fno-gnu-keywords
2356 Do not recognize @code{typeof} as a keyword, so that code can use this
2357 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2358 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2359 @option{-std=c++98}, @option{-std=c++11}, etc.
2361 @item -fno-implicit-templates
2362 @opindex fno-implicit-templates
2363 Never emit code for non-inline templates that are instantiated
2364 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2365 @xref{Template Instantiation}, for more information.
2367 @item -fno-implicit-inline-templates
2368 @opindex fno-implicit-inline-templates
2369 Don't emit code for implicit instantiations of inline templates, either.
2370 The default is to handle inlines differently so that compiles with and
2371 without optimization need the same set of explicit instantiations.
2373 @item -fno-implement-inlines
2374 @opindex fno-implement-inlines
2375 To save space, do not emit out-of-line copies of inline functions
2376 controlled by @code{#pragma implementation}.  This causes linker
2377 errors if these functions are not inlined everywhere they are called.
2379 @item -fms-extensions
2380 @opindex fms-extensions
2381 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2382 int and getting a pointer to member function via non-standard syntax.
2384 @item -fno-nonansi-builtins
2385 @opindex fno-nonansi-builtins
2386 Disable built-in declarations of functions that are not mandated by
2387 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2388 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2390 @item -fnothrow-opt
2391 @opindex fnothrow-opt
2392 Treat a @code{throw()} exception specification as if it were a
2393 @code{noexcept} specification to reduce or eliminate the text size
2394 overhead relative to a function with no exception specification.  If
2395 the function has local variables of types with non-trivial
2396 destructors, the exception specification actually makes the
2397 function smaller because the EH cleanups for those variables can be
2398 optimized away.  The semantic effect is that an exception thrown out of
2399 a function with such an exception specification results in a call
2400 to @code{terminate} rather than @code{unexpected}.
2402 @item -fno-operator-names
2403 @opindex fno-operator-names
2404 Do not treat the operator name keywords @code{and}, @code{bitand},
2405 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2406 synonyms as keywords.
2408 @item -fno-optional-diags
2409 @opindex fno-optional-diags
2410 Disable diagnostics that the standard says a compiler does not need to
2411 issue.  Currently, the only such diagnostic issued by G++ is the one for
2412 a name having multiple meanings within a class.
2414 @item -fpermissive
2415 @opindex fpermissive
2416 Downgrade some diagnostics about nonconformant code from errors to
2417 warnings.  Thus, using @option{-fpermissive} allows some
2418 nonconforming code to compile.
2420 @item -fno-pretty-templates
2421 @opindex fno-pretty-templates
2422 When an error message refers to a specialization of a function
2423 template, the compiler normally prints the signature of the
2424 template followed by the template arguments and any typedefs or
2425 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2426 rather than @code{void f(int)}) so that it's clear which template is
2427 involved.  When an error message refers to a specialization of a class
2428 template, the compiler omits any template arguments that match
2429 the default template arguments for that template.  If either of these
2430 behaviors make it harder to understand the error message rather than
2431 easier, you can use @option{-fno-pretty-templates} to disable them.
2433 @item -frepo
2434 @opindex frepo
2435 Enable automatic template instantiation at link time.  This option also
2436 implies @option{-fno-implicit-templates}.  @xref{Template
2437 Instantiation}, for more information.
2439 @item -fno-rtti
2440 @opindex fno-rtti
2441 Disable generation of information about every class with virtual
2442 functions for use by the C++ run-time type identification features
2443 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2444 of the language, you can save some space by using this flag.  Note that
2445 exception handling uses the same information, but G++ generates it as
2446 needed. The @code{dynamic_cast} operator can still be used for casts that
2447 do not require run-time type information, i.e.@: casts to @code{void *} or to
2448 unambiguous base classes.
2450 @item -fsized-deallocation
2451 @opindex fsized-deallocation
2452 Enable the built-in global declarations
2453 @smallexample
2454 void operator delete (void *, std::size_t) noexcept;
2455 void operator delete[] (void *, std::size_t) noexcept;
2456 @end smallexample
2457 as introduced in C++14.  This is useful for user-defined replacement
2458 deallocation functions that, for example, use the size of the object
2459 to make deallocation faster.  Enabled by default under
2460 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2461 warns about places that might want to add a definition.
2463 @item -fstrict-enums
2464 @opindex fstrict-enums
2465 Allow the compiler to optimize using the assumption that a value of
2466 enumerated type can only be one of the values of the enumeration (as
2467 defined in the C++ standard; basically, a value that can be
2468 represented in the minimum number of bits needed to represent all the
2469 enumerators).  This assumption may not be valid if the program uses a
2470 cast to convert an arbitrary integer value to the enumerated type.
2472 @item -ftemplate-backtrace-limit=@var{n}
2473 @opindex ftemplate-backtrace-limit
2474 Set the maximum number of template instantiation notes for a single
2475 warning or error to @var{n}.  The default value is 10.
2477 @item -ftemplate-depth=@var{n}
2478 @opindex ftemplate-depth
2479 Set the maximum instantiation depth for template classes to @var{n}.
2480 A limit on the template instantiation depth is needed to detect
2481 endless recursions during template class instantiation.  ANSI/ISO C++
2482 conforming programs must not rely on a maximum depth greater than 17
2483 (changed to 1024 in C++11).  The default value is 900, as the compiler
2484 can run out of stack space before hitting 1024 in some situations.
2486 @item -fno-threadsafe-statics
2487 @opindex fno-threadsafe-statics
2488 Do not emit the extra code to use the routines specified in the C++
2489 ABI for thread-safe initialization of local statics.  You can use this
2490 option to reduce code size slightly in code that doesn't need to be
2491 thread-safe.
2493 @item -fuse-cxa-atexit
2494 @opindex fuse-cxa-atexit
2495 Register destructors for objects with static storage duration with the
2496 @code{__cxa_atexit} function rather than the @code{atexit} function.
2497 This option is required for fully standards-compliant handling of static
2498 destructors, but only works if your C library supports
2499 @code{__cxa_atexit}.
2501 @item -fno-use-cxa-get-exception-ptr
2502 @opindex fno-use-cxa-get-exception-ptr
2503 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2504 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2505 if the runtime routine is not available.
2507 @item -fvisibility-inlines-hidden
2508 @opindex fvisibility-inlines-hidden
2509 This switch declares that the user does not attempt to compare
2510 pointers to inline functions or methods where the addresses of the two functions
2511 are taken in different shared objects.
2513 The effect of this is that GCC may, effectively, mark inline methods with
2514 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2515 appear in the export table of a DSO and do not require a PLT indirection
2516 when used within the DSO@.  Enabling this option can have a dramatic effect
2517 on load and link times of a DSO as it massively reduces the size of the
2518 dynamic export table when the library makes heavy use of templates.
2520 The behavior of this switch is not quite the same as marking the
2521 methods as hidden directly, because it does not affect static variables
2522 local to the function or cause the compiler to deduce that
2523 the function is defined in only one shared object.
2525 You may mark a method as having a visibility explicitly to negate the
2526 effect of the switch for that method.  For example, if you do want to
2527 compare pointers to a particular inline method, you might mark it as
2528 having default visibility.  Marking the enclosing class with explicit
2529 visibility has no effect.
2531 Explicitly instantiated inline methods are unaffected by this option
2532 as their linkage might otherwise cross a shared library boundary.
2533 @xref{Template Instantiation}.
2535 @item -fvisibility-ms-compat
2536 @opindex fvisibility-ms-compat
2537 This flag attempts to use visibility settings to make GCC's C++
2538 linkage model compatible with that of Microsoft Visual Studio.
2540 The flag makes these changes to GCC's linkage model:
2542 @enumerate
2543 @item
2544 It sets the default visibility to @code{hidden}, like
2545 @option{-fvisibility=hidden}.
2547 @item
2548 Types, but not their members, are not hidden by default.
2550 @item
2551 The One Definition Rule is relaxed for types without explicit
2552 visibility specifications that are defined in more than one
2553 shared object: those declarations are permitted if they are
2554 permitted when this option is not used.
2555 @end enumerate
2557 In new code it is better to use @option{-fvisibility=hidden} and
2558 export those classes that are intended to be externally visible.
2559 Unfortunately it is possible for code to rely, perhaps accidentally,
2560 on the Visual Studio behavior.
2562 Among the consequences of these changes are that static data members
2563 of the same type with the same name but defined in different shared
2564 objects are different, so changing one does not change the other;
2565 and that pointers to function members defined in different shared
2566 objects may not compare equal.  When this flag is given, it is a
2567 violation of the ODR to define types with the same name differently.
2569 @item -fno-weak
2570 @opindex fno-weak
2571 Do not use weak symbol support, even if it is provided by the linker.
2572 By default, G++ uses weak symbols if they are available.  This
2573 option exists only for testing, and should not be used by end-users;
2574 it results in inferior code and has no benefits.  This option may
2575 be removed in a future release of G++.
2577 @item -nostdinc++
2578 @opindex nostdinc++
2579 Do not search for header files in the standard directories specific to
2580 C++, but do still search the other standard directories.  (This option
2581 is used when building the C++ library.)
2582 @end table
2584 In addition, these optimization, warning, and code generation options
2585 have meanings only for C++ programs:
2587 @table @gcctabopt
2588 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2589 @opindex Wabi
2590 @opindex Wno-abi
2591 Warn when G++ it generates code that is probably not compatible with
2592 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2593 ABI with each major release, normally @option{-Wabi} will warn only if
2594 there is a check added later in a release series for an ABI issue
2595 discovered since the initial release.  @option{-Wabi} will warn about
2596 more things if an older ABI version is selected (with
2597 @option{-fabi-version=@var{n}}).
2599 @option{-Wabi} can also be used with an explicit version number to
2600 warn about compatibility with a particular @option{-fabi-version}
2601 level, e.g. @option{-Wabi=2} to warn about changes relative to
2602 @option{-fabi-version=2}.
2604 If an explicit version number is provided and
2605 @option{-fabi-compat-version} is not specified, the version number
2606 from this option is used for compatibility aliases.  If no explicit
2607 version number is provided with this option, but
2608 @option{-fabi-compat-version} is specified, that version number is
2609 used for ABI warnings.
2611 Although an effort has been made to warn about
2612 all such cases, there are probably some cases that are not warned about,
2613 even though G++ is generating incompatible code.  There may also be
2614 cases where warnings are emitted even though the code that is generated
2615 is compatible.
2617 You should rewrite your code to avoid these warnings if you are
2618 concerned about the fact that code generated by G++ may not be binary
2619 compatible with code generated by other compilers.
2621 Known incompatibilities in @option{-fabi-version=2} (which was the
2622 default from GCC 3.4 to 4.9) include:
2624 @itemize @bullet
2626 @item
2627 A template with a non-type template parameter of reference type was
2628 mangled incorrectly:
2629 @smallexample
2630 extern int N;
2631 template <int &> struct S @{@};
2632 void n (S<N>) @{2@}
2633 @end smallexample
2635 This was fixed in @option{-fabi-version=3}.
2637 @item
2638 SIMD vector types declared using @code{__attribute ((vector_size))} were
2639 mangled in a non-standard way that does not allow for overloading of
2640 functions taking vectors of different sizes.
2642 The mangling was changed in @option{-fabi-version=4}.
2644 @item
2645 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2646 qualifiers, and @code{decltype} of a plain declaration was folded away.
2648 These mangling issues were fixed in @option{-fabi-version=5}.
2650 @item
2651 Scoped enumerators passed as arguments to a variadic function are
2652 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2653 On most targets this does not actually affect the parameter passing
2654 ABI, as there is no way to pass an argument smaller than @code{int}.
2656 Also, the ABI changed the mangling of template argument packs,
2657 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2658 a class scope function used as a template argument.
2660 These issues were corrected in @option{-fabi-version=6}.
2662 @item
2663 Lambdas in default argument scope were mangled incorrectly, and the
2664 ABI changed the mangling of @code{nullptr_t}.
2666 These issues were corrected in @option{-fabi-version=7}.
2668 @item
2669 When mangling a function type with function-cv-qualifiers, the
2670 un-qualified function type was incorrectly treated as a substitution
2671 candidate.
2673 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2675 @item
2676 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2677 unaligned accesses.  Note that this did not affect the ABI of a
2678 function with a @code{nullptr_t} parameter, as parameters have a
2679 minimum alignment.
2681 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2683 @item
2684 Target-specific attributes that affect the identity of a type, such as
2685 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2686 did not affect the mangled name, leading to name collisions when
2687 function pointers were used as template arguments.
2689 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2691 @end itemize
2693 It also warns about psABI-related changes.  The known psABI changes at this
2694 point include:
2696 @itemize @bullet
2698 @item
2699 For SysV/x86-64, unions with @code{long double} members are 
2700 passed in memory as specified in psABI.  For example:
2702 @smallexample
2703 union U @{
2704   long double ld;
2705   int i;
2707 @end smallexample
2709 @noindent
2710 @code{union U} is always passed in memory.
2712 @end itemize
2714 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2715 @opindex Wabi-tag
2716 @opindex -Wabi-tag
2717 Warn when a type with an ABI tag is used in a context that does not
2718 have that ABI tag.  See @ref{C++ Attributes} for more information
2719 about ABI tags.
2721 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2722 @opindex Wctor-dtor-privacy
2723 @opindex Wno-ctor-dtor-privacy
2724 Warn when a class seems unusable because all the constructors or
2725 destructors in that class are private, and it has neither friends nor
2726 public static member functions.  Also warn if there are no non-private
2727 methods, and there's at least one private member function that isn't
2728 a constructor or destructor.
2730 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2731 @opindex Wdelete-non-virtual-dtor
2732 @opindex Wno-delete-non-virtual-dtor
2733 Warn when @code{delete} is used to destroy an instance of a class that
2734 has virtual functions and non-virtual destructor. It is unsafe to delete
2735 an instance of a derived class through a pointer to a base class if the
2736 base class does not have a virtual destructor.  This warning is enabled
2737 by @option{-Wall}.
2739 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2740 @opindex Wliteral-suffix
2741 @opindex Wno-literal-suffix
2742 Warn when a string or character literal is followed by a ud-suffix which does
2743 not begin with an underscore.  As a conforming extension, GCC treats such
2744 suffixes as separate preprocessing tokens in order to maintain backwards
2745 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2746 For example:
2748 @smallexample
2749 #define __STDC_FORMAT_MACROS
2750 #include <inttypes.h>
2751 #include <stdio.h>
2753 int main() @{
2754   int64_t i64 = 123;
2755   printf("My int64: %" PRId64"\n", i64);
2757 @end smallexample
2759 In this case, @code{PRId64} is treated as a separate preprocessing token.
2761 This warning is enabled by default.
2763 @item -Wlto-type-mismatch
2764 @opindex Wlto-type-mismatch
2765 @opindex Wno-lto-type-mismatch
2767 During the link-time optimization warn about type mismatches in
2768 global declarations from different compilation units.
2769 Requires @option{-flto} to be enabled.  Enabled by default.
2771 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2772 @opindex Wnarrowing
2773 @opindex Wno-narrowing
2774 With @option{-std=gnu++98} or @option{-std=c++98}, warn when a narrowing
2775 conversion prohibited by C++11 occurs within
2776 @samp{@{ @}}, e.g.
2778 @smallexample
2779 int i = @{ 2.2 @}; // error: narrowing from double to int
2780 @end smallexample
2782 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2784 When a later standard is in effect, e.g. when using @option{-std=c++11},
2785 narrowing conversions are diagnosed by default, as required by the standard.
2786 A narrowing conversion from a constant produces an error,
2787 and a narrowing conversion from a non-constant produces a warning,
2788 but @option{-Wno-narrowing} suppresses the diagnostic.
2789 Note that this does not affect the meaning of well-formed code;
2790 narrowing conversions are still considered ill-formed in SFINAE contexts.
2792 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2793 @opindex Wnoexcept
2794 @opindex Wno-noexcept
2795 Warn when a noexcept-expression evaluates to false because of a call
2796 to a function that does not have a non-throwing exception
2797 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2798 the compiler to never throw an exception.
2800 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2801 @opindex Wnon-virtual-dtor
2802 @opindex Wno-non-virtual-dtor
2803 Warn when a class has virtual functions and an accessible non-virtual
2804 destructor itself or in an accessible polymorphic base class, in which
2805 case it is possible but unsafe to delete an instance of a derived
2806 class through a pointer to the class itself or base class.  This
2807 warning is automatically enabled if @option{-Weffc++} is specified.
2809 @item -Wreorder @r{(C++ and Objective-C++ only)}
2810 @opindex Wreorder
2811 @opindex Wno-reorder
2812 @cindex reordering, warning
2813 @cindex warning for reordering of member initializers
2814 Warn when the order of member initializers given in the code does not
2815 match the order in which they must be executed.  For instance:
2817 @smallexample
2818 struct A @{
2819   int i;
2820   int j;
2821   A(): j (0), i (1) @{ @}
2823 @end smallexample
2825 @noindent
2826 The compiler rearranges the member initializers for @code{i}
2827 and @code{j} to match the declaration order of the members, emitting
2828 a warning to that effect.  This warning is enabled by @option{-Wall}.
2830 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2831 @opindex fext-numeric-literals
2832 @opindex fno-ext-numeric-literals
2833 Accept imaginary, fixed-point, or machine-defined
2834 literal number suffixes as GNU extensions.
2835 When this option is turned off these suffixes are treated
2836 as C++11 user-defined literal numeric suffixes.
2837 This is on by default for all pre-C++11 dialects and all GNU dialects:
2838 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2839 @option{-std=gnu++14}.
2840 This option is off by default
2841 for ISO C++11 onwards (@option{-std=c++11}, ...).
2842 @end table
2844 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2846 @table @gcctabopt
2847 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2848 @opindex Weffc++
2849 @opindex Wno-effc++
2850 Warn about violations of the following style guidelines from Scott Meyers'
2851 @cite{Effective C++} series of books:
2853 @itemize @bullet
2854 @item
2855 Define a copy constructor and an assignment operator for classes
2856 with dynamically-allocated memory.
2858 @item
2859 Prefer initialization to assignment in constructors.
2861 @item
2862 Have @code{operator=} return a reference to @code{*this}.
2864 @item
2865 Don't try to return a reference when you must return an object.
2867 @item
2868 Distinguish between prefix and postfix forms of increment and
2869 decrement operators.
2871 @item
2872 Never overload @code{&&}, @code{||}, or @code{,}.
2874 @end itemize
2876 This option also enables @option{-Wnon-virtual-dtor}, which is also
2877 one of the effective C++ recommendations.  However, the check is
2878 extended to warn about the lack of virtual destructor in accessible
2879 non-polymorphic bases classes too.
2881 When selecting this option, be aware that the standard library
2882 headers do not obey all of these guidelines; use @samp{grep -v}
2883 to filter out those warnings.
2885 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2886 @opindex Wstrict-null-sentinel
2887 @opindex Wno-strict-null-sentinel
2888 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2889 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2890 to @code{__null}.  Although it is a null pointer constant rather than a
2891 null pointer, it is guaranteed to be of the same size as a pointer.
2892 But this use is not portable across different compilers.
2894 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2895 @opindex Wno-non-template-friend
2896 @opindex Wnon-template-friend
2897 Disable warnings when non-templatized friend functions are declared
2898 within a template.  Since the advent of explicit template specification
2899 support in G++, if the name of the friend is an unqualified-id (i.e.,
2900 @samp{friend foo(int)}), the C++ language specification demands that the
2901 friend declare or define an ordinary, nontemplate function.  (Section
2902 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2903 could be interpreted as a particular specialization of a templatized
2904 function.  Because this non-conforming behavior is no longer the default
2905 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2906 check existing code for potential trouble spots and is on by default.
2907 This new compiler behavior can be turned off with
2908 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2909 but disables the helpful warning.
2911 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2912 @opindex Wold-style-cast
2913 @opindex Wno-old-style-cast
2914 Warn if an old-style (C-style) cast to a non-void type is used within
2915 a C++ program.  The new-style casts (@code{dynamic_cast},
2916 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2917 less vulnerable to unintended effects and much easier to search for.
2919 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2920 @opindex Woverloaded-virtual
2921 @opindex Wno-overloaded-virtual
2922 @cindex overloaded virtual function, warning
2923 @cindex warning for overloaded virtual function
2924 Warn when a function declaration hides virtual functions from a
2925 base class.  For example, in:
2927 @smallexample
2928 struct A @{
2929   virtual void f();
2932 struct B: public A @{
2933   void f(int);
2935 @end smallexample
2937 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2938 like:
2940 @smallexample
2941 B* b;
2942 b->f();
2943 @end smallexample
2945 @noindent
2946 fails to compile.
2948 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2949 @opindex Wno-pmf-conversions
2950 @opindex Wpmf-conversions
2951 Disable the diagnostic for converting a bound pointer to member function
2952 to a plain pointer.
2954 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2955 @opindex Wsign-promo
2956 @opindex Wno-sign-promo
2957 Warn when overload resolution chooses a promotion from unsigned or
2958 enumerated type to a signed type, over a conversion to an unsigned type of
2959 the same size.  Previous versions of G++ tried to preserve
2960 unsignedness, but the standard mandates the current behavior.
2962 @item -Wtemplates @r{(C++ and Objective-C++ only)}
2963 @opindex Wtemplates
2964 Warn when a primary template declaration is encountered.  Some coding
2965 rules disallow templates, and this may be used to enforce that rule.
2966 The warning is inactive inside a system header file, such as the STL, so
2967 one can still use the STL.  One may also instantiate or specialize
2968 templates.
2970 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
2971 @opindex Wmultiple-inheritance
2972 Warn when a class is defined with multiple direct base classes.  Some
2973 coding rules disallow multiple inheritance, and this may be used to
2974 enforce that rule.  The warning is inactive inside a system header file,
2975 such as the STL, so one can still use the STL.  One may also define
2976 classes that indirectly use multiple inheritance.
2978 @item -Wvirtual-inheritance
2979 @opindex Wvirtual-inheritance
2980 Warn when a class is defined with a virtual direct base classe.  Some
2981 coding rules disallow multiple inheritance, and this may be used to
2982 enforce that rule.  The warning is inactive inside a system header file,
2983 such as the STL, so one can still use the STL.  One may also define
2984 classes that indirectly use virtual inheritance.
2986 @item -Wnamespaces
2987 @opindex Wnamespaces
2988 Warn when a namespace definition is opened.  Some coding rules disallow
2989 namespaces, and this may be used to enforce that rule.  The warning is
2990 inactive inside a system header file, such as the STL, so one can still
2991 use the STL.  One may also use using directives and qualified names.
2993 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
2994 @opindex Wterminate
2995 @opindex Wno-terminate
2996 Disable the warning about a throw-expression that will immediately
2997 result in a call to @code{terminate}.
2998 @end table
3000 @node Objective-C and Objective-C++ Dialect Options
3001 @section Options Controlling Objective-C and Objective-C++ Dialects
3003 @cindex compiler options, Objective-C and Objective-C++
3004 @cindex Objective-C and Objective-C++ options, command-line
3005 @cindex options, Objective-C and Objective-C++
3006 (NOTE: This manual does not describe the Objective-C and Objective-C++
3007 languages themselves.  @xref{Standards,,Language Standards
3008 Supported by GCC}, for references.)
3010 This section describes the command-line options that are only meaningful
3011 for Objective-C and Objective-C++ programs.  You can also use most of
3012 the language-independent GNU compiler options.
3013 For example, you might compile a file @file{some_class.m} like this:
3015 @smallexample
3016 gcc -g -fgnu-runtime -O -c some_class.m
3017 @end smallexample
3019 @noindent
3020 In this example, @option{-fgnu-runtime} is an option meant only for
3021 Objective-C and Objective-C++ programs; you can use the other options with
3022 any language supported by GCC@.
3024 Note that since Objective-C is an extension of the C language, Objective-C
3025 compilations may also use options specific to the C front-end (e.g.,
3026 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3027 C++-specific options (e.g., @option{-Wabi}).
3029 Here is a list of options that are @emph{only} for compiling Objective-C
3030 and Objective-C++ programs:
3032 @table @gcctabopt
3033 @item -fconstant-string-class=@var{class-name}
3034 @opindex fconstant-string-class
3035 Use @var{class-name} as the name of the class to instantiate for each
3036 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3037 class name is @code{NXConstantString} if the GNU runtime is being used, and
3038 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3039 @option{-fconstant-cfstrings} option, if also present, overrides the
3040 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3041 to be laid out as constant CoreFoundation strings.
3043 @item -fgnu-runtime
3044 @opindex fgnu-runtime
3045 Generate object code compatible with the standard GNU Objective-C
3046 runtime.  This is the default for most types of systems.
3048 @item -fnext-runtime
3049 @opindex fnext-runtime
3050 Generate output compatible with the NeXT runtime.  This is the default
3051 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3052 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3053 used.
3055 @item -fno-nil-receivers
3056 @opindex fno-nil-receivers
3057 Assume that all Objective-C message dispatches (@code{[receiver
3058 message:arg]}) in this translation unit ensure that the receiver is
3059 not @code{nil}.  This allows for more efficient entry points in the
3060 runtime to be used.  This option is only available in conjunction with
3061 the NeXT runtime and ABI version 0 or 1.
3063 @item -fobjc-abi-version=@var{n}
3064 @opindex fobjc-abi-version
3065 Use version @var{n} of the Objective-C ABI for the selected runtime.
3066 This option is currently supported only for the NeXT runtime.  In that
3067 case, Version 0 is the traditional (32-bit) ABI without support for
3068 properties and other Objective-C 2.0 additions.  Version 1 is the
3069 traditional (32-bit) ABI with support for properties and other
3070 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3071 nothing is specified, the default is Version 0 on 32-bit target
3072 machines, and Version 2 on 64-bit target machines.
3074 @item -fobjc-call-cxx-cdtors
3075 @opindex fobjc-call-cxx-cdtors
3076 For each Objective-C class, check if any of its instance variables is a
3077 C++ object with a non-trivial default constructor.  If so, synthesize a
3078 special @code{- (id) .cxx_construct} instance method which runs
3079 non-trivial default constructors on any such instance variables, in order,
3080 and then return @code{self}.  Similarly, check if any instance variable
3081 is a C++ object with a non-trivial destructor, and if so, synthesize a
3082 special @code{- (void) .cxx_destruct} method which runs
3083 all such default destructors, in reverse order.
3085 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3086 methods thusly generated only operate on instance variables
3087 declared in the current Objective-C class, and not those inherited
3088 from superclasses.  It is the responsibility of the Objective-C
3089 runtime to invoke all such methods in an object's inheritance
3090 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3091 by the runtime immediately after a new object instance is allocated;
3092 the @code{- (void) .cxx_destruct} methods are invoked immediately
3093 before the runtime deallocates an object instance.
3095 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3096 support for invoking the @code{- (id) .cxx_construct} and
3097 @code{- (void) .cxx_destruct} methods.
3099 @item -fobjc-direct-dispatch
3100 @opindex fobjc-direct-dispatch
3101 Allow fast jumps to the message dispatcher.  On Darwin this is
3102 accomplished via the comm page.
3104 @item -fobjc-exceptions
3105 @opindex fobjc-exceptions
3106 Enable syntactic support for structured exception handling in
3107 Objective-C, similar to what is offered by C++ and Java.  This option
3108 is required to use the Objective-C keywords @code{@@try},
3109 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3110 @code{@@synchronized}.  This option is available with both the GNU
3111 runtime and the NeXT runtime (but not available in conjunction with
3112 the NeXT runtime on Mac OS X 10.2 and earlier).
3114 @item -fobjc-gc
3115 @opindex fobjc-gc
3116 Enable garbage collection (GC) in Objective-C and Objective-C++
3117 programs.  This option is only available with the NeXT runtime; the
3118 GNU runtime has a different garbage collection implementation that
3119 does not require special compiler flags.
3121 @item -fobjc-nilcheck
3122 @opindex fobjc-nilcheck
3123 For the NeXT runtime with version 2 of the ABI, check for a nil
3124 receiver in method invocations before doing the actual method call.
3125 This is the default and can be disabled using
3126 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3127 checked for nil in this way no matter what this flag is set to.
3128 Currently this flag does nothing when the GNU runtime, or an older
3129 version of the NeXT runtime ABI, is used.
3131 @item -fobjc-std=objc1
3132 @opindex fobjc-std
3133 Conform to the language syntax of Objective-C 1.0, the language
3134 recognized by GCC 4.0.  This only affects the Objective-C additions to
3135 the C/C++ language; it does not affect conformance to C/C++ standards,
3136 which is controlled by the separate C/C++ dialect option flags.  When
3137 this option is used with the Objective-C or Objective-C++ compiler,
3138 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3139 This is useful if you need to make sure that your Objective-C code can
3140 be compiled with older versions of GCC@.
3142 @item -freplace-objc-classes
3143 @opindex freplace-objc-classes
3144 Emit a special marker instructing @command{ld(1)} not to statically link in
3145 the resulting object file, and allow @command{dyld(1)} to load it in at
3146 run time instead.  This is used in conjunction with the Fix-and-Continue
3147 debugging mode, where the object file in question may be recompiled and
3148 dynamically reloaded in the course of program execution, without the need
3149 to restart the program itself.  Currently, Fix-and-Continue functionality
3150 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3151 and later.
3153 @item -fzero-link
3154 @opindex fzero-link
3155 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3156 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3157 compile time) with static class references that get initialized at load time,
3158 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3159 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3160 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3161 for individual class implementations to be modified during program execution.
3162 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3163 regardless of command-line options.
3165 @item -fno-local-ivars
3166 @opindex fno-local-ivars
3167 @opindex flocal-ivars
3168 By default instance variables in Objective-C can be accessed as if
3169 they were local variables from within the methods of the class they're
3170 declared in.  This can lead to shadowing between instance variables
3171 and other variables declared either locally inside a class method or
3172 globally with the same name.  Specifying the @option{-fno-local-ivars}
3173 flag disables this behavior thus avoiding variable shadowing issues.
3175 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3176 @opindex fivar-visibility
3177 Set the default instance variable visibility to the specified option
3178 so that instance variables declared outside the scope of any access
3179 modifier directives default to the specified visibility.
3181 @item -gen-decls
3182 @opindex gen-decls
3183 Dump interface declarations for all classes seen in the source file to a
3184 file named @file{@var{sourcename}.decl}.
3186 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3187 @opindex Wassign-intercept
3188 @opindex Wno-assign-intercept
3189 Warn whenever an Objective-C assignment is being intercepted by the
3190 garbage collector.
3192 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3193 @opindex Wno-protocol
3194 @opindex Wprotocol
3195 If a class is declared to implement a protocol, a warning is issued for
3196 every method in the protocol that is not implemented by the class.  The
3197 default behavior is to issue a warning for every method not explicitly
3198 implemented in the class, even if a method implementation is inherited
3199 from the superclass.  If you use the @option{-Wno-protocol} option, then
3200 methods inherited from the superclass are considered to be implemented,
3201 and no warning is issued for them.
3203 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3204 @opindex Wselector
3205 @opindex Wno-selector
3206 Warn if multiple methods of different types for the same selector are
3207 found during compilation.  The check is performed on the list of methods
3208 in the final stage of compilation.  Additionally, a check is performed
3209 for each selector appearing in a @code{@@selector(@dots{})}
3210 expression, and a corresponding method for that selector has been found
3211 during compilation.  Because these checks scan the method table only at
3212 the end of compilation, these warnings are not produced if the final
3213 stage of compilation is not reached, for example because an error is
3214 found during compilation, or because the @option{-fsyntax-only} option is
3215 being used.
3217 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3218 @opindex Wstrict-selector-match
3219 @opindex Wno-strict-selector-match
3220 Warn if multiple methods with differing argument and/or return types are
3221 found for a given selector when attempting to send a message using this
3222 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3223 is off (which is the default behavior), the compiler omits such warnings
3224 if any differences found are confined to types that share the same size
3225 and alignment.
3227 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3228 @opindex Wundeclared-selector
3229 @opindex Wno-undeclared-selector
3230 Warn if a @code{@@selector(@dots{})} expression referring to an
3231 undeclared selector is found.  A selector is considered undeclared if no
3232 method with that name has been declared before the
3233 @code{@@selector(@dots{})} expression, either explicitly in an
3234 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3235 an @code{@@implementation} section.  This option always performs its
3236 checks as soon as a @code{@@selector(@dots{})} expression is found,
3237 while @option{-Wselector} only performs its checks in the final stage of
3238 compilation.  This also enforces the coding style convention
3239 that methods and selectors must be declared before being used.
3241 @item -print-objc-runtime-info
3242 @opindex print-objc-runtime-info
3243 Generate C header describing the largest structure that is passed by
3244 value, if any.
3246 @end table
3248 @node Diagnostic Message Formatting Options
3249 @section Options to Control Diagnostic Messages Formatting
3250 @cindex options to control diagnostics formatting
3251 @cindex diagnostic messages
3252 @cindex message formatting
3254 Traditionally, diagnostic messages have been formatted irrespective of
3255 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3256 options described below
3257 to control the formatting algorithm for diagnostic messages, 
3258 e.g.@: how many characters per line, how often source location
3259 information should be reported.  Note that some language front ends may not
3260 honor these options.
3262 @table @gcctabopt
3263 @item -fmessage-length=@var{n}
3264 @opindex fmessage-length
3265 Try to format error messages so that they fit on lines of about
3266 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3267 done; each error message appears on a single line.  This is the
3268 default for all front ends.
3270 @item -fdiagnostics-show-location=once
3271 @opindex fdiagnostics-show-location
3272 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3273 reporter to emit source location information @emph{once}; that is, in
3274 case the message is too long to fit on a single physical line and has to
3275 be wrapped, the source location won't be emitted (as prefix) again,
3276 over and over, in subsequent continuation lines.  This is the default
3277 behavior.
3279 @item -fdiagnostics-show-location=every-line
3280 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3281 messages reporter to emit the same source location information (as
3282 prefix) for physical lines that result from the process of breaking
3283 a message which is too long to fit on a single line.
3285 @item -fdiagnostics-color[=@var{WHEN}]
3286 @itemx -fno-diagnostics-color
3287 @opindex fdiagnostics-color
3288 @cindex highlight, color
3289 @vindex GCC_COLORS @r{environment variable}
3290 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3291 or @samp{auto}.  The default depends on how the compiler has been configured,
3292 it can be any of the above @var{WHEN} options or also @samp{never}
3293 if @env{GCC_COLORS} environment variable isn't present in the environment,
3294 and @samp{auto} otherwise.
3295 @samp{auto} means to use color only when the standard error is a terminal.
3296 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3297 aliases for @option{-fdiagnostics-color=always} and
3298 @option{-fdiagnostics-color=never}, respectively.
3300 The colors are defined by the environment variable @env{GCC_COLORS}.
3301 Its value is a colon-separated list of capabilities and Select Graphic
3302 Rendition (SGR) substrings. SGR commands are interpreted by the
3303 terminal or terminal emulator.  (See the section in the documentation
3304 of your text terminal for permitted values and their meanings as
3305 character attributes.)  These substring values are integers in decimal
3306 representation and can be concatenated with semicolons.
3307 Common values to concatenate include
3308 @samp{1} for bold,
3309 @samp{4} for underline,
3310 @samp{5} for blink,
3311 @samp{7} for inverse,
3312 @samp{39} for default foreground color,
3313 @samp{30} to @samp{37} for foreground colors,
3314 @samp{90} to @samp{97} for 16-color mode foreground colors,
3315 @samp{38;5;0} to @samp{38;5;255}
3316 for 88-color and 256-color modes foreground colors,
3317 @samp{49} for default background color,
3318 @samp{40} to @samp{47} for background colors,
3319 @samp{100} to @samp{107} for 16-color mode background colors,
3320 and @samp{48;5;0} to @samp{48;5;255}
3321 for 88-color and 256-color modes background colors.
3323 The default @env{GCC_COLORS} is
3324 @smallexample
3325 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3326 @end smallexample
3327 @noindent
3328 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3329 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3330 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3331 string disables colors.
3332 Supported capabilities are as follows.
3334 @table @code
3335 @item error=
3336 @vindex error GCC_COLORS @r{capability}
3337 SGR substring for error: markers.
3339 @item warning=
3340 @vindex warning GCC_COLORS @r{capability}
3341 SGR substring for warning: markers.
3343 @item note=
3344 @vindex note GCC_COLORS @r{capability}
3345 SGR substring for note: markers.
3347 @item caret=
3348 @vindex caret GCC_COLORS @r{capability}
3349 SGR substring for caret line.
3351 @item locus=
3352 @vindex locus GCC_COLORS @r{capability}
3353 SGR substring for location information, @samp{file:line} or
3354 @samp{file:line:column} etc.
3356 @item quote=
3357 @vindex quote GCC_COLORS @r{capability}
3358 SGR substring for information printed within quotes.
3359 @end table
3361 @item -fno-diagnostics-show-option
3362 @opindex fno-diagnostics-show-option
3363 @opindex fdiagnostics-show-option
3364 By default, each diagnostic emitted includes text indicating the
3365 command-line option that directly controls the diagnostic (if such an
3366 option is known to the diagnostic machinery).  Specifying the
3367 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3369 @item -fno-diagnostics-show-caret
3370 @opindex fno-diagnostics-show-caret
3371 @opindex fdiagnostics-show-caret
3372 By default, each diagnostic emitted includes the original source line
3373 and a caret @samp{^} indicating the column.  This option suppresses this
3374 information.  The source line is truncated to @var{n} characters, if
3375 the @option{-fmessage-length=n} option is given.  When the output is done
3376 to the terminal, the width is limited to the width given by the
3377 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3379 @end table
3381 @node Warning Options
3382 @section Options to Request or Suppress Warnings
3383 @cindex options to control warnings
3384 @cindex warning messages
3385 @cindex messages, warning
3386 @cindex suppressing warnings
3388 Warnings are diagnostic messages that report constructions that
3389 are not inherently erroneous but that are risky or suggest there
3390 may have been an error.
3392 The following language-independent options do not enable specific
3393 warnings but control the kinds of diagnostics produced by GCC@.
3395 @table @gcctabopt
3396 @cindex syntax checking
3397 @item -fsyntax-only
3398 @opindex fsyntax-only
3399 Check the code for syntax errors, but don't do anything beyond that.
3401 @item -fmax-errors=@var{n}
3402 @opindex fmax-errors
3403 Limits the maximum number of error messages to @var{n}, at which point
3404 GCC bails out rather than attempting to continue processing the source
3405 code.  If @var{n} is 0 (the default), there is no limit on the number
3406 of error messages produced.  If @option{-Wfatal-errors} is also
3407 specified, then @option{-Wfatal-errors} takes precedence over this
3408 option.
3410 @item -w
3411 @opindex w
3412 Inhibit all warning messages.
3414 @item -Werror
3415 @opindex Werror
3416 @opindex Wno-error
3417 Make all warnings into errors.
3419 @item -Werror=
3420 @opindex Werror=
3421 @opindex Wno-error=
3422 Make the specified warning into an error.  The specifier for a warning
3423 is appended; for example @option{-Werror=switch} turns the warnings
3424 controlled by @option{-Wswitch} into errors.  This switch takes a
3425 negative form, to be used to negate @option{-Werror} for specific
3426 warnings; for example @option{-Wno-error=switch} makes
3427 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3428 is in effect.
3430 The warning message for each controllable warning includes the
3431 option that controls the warning.  That option can then be used with
3432 @option{-Werror=} and @option{-Wno-error=} as described above.
3433 (Printing of the option in the warning message can be disabled using the
3434 @option{-fno-diagnostics-show-option} flag.)
3436 Note that specifying @option{-Werror=}@var{foo} automatically implies
3437 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3438 imply anything.
3440 @item -Wfatal-errors
3441 @opindex Wfatal-errors
3442 @opindex Wno-fatal-errors
3443 This option causes the compiler to abort compilation on the first error
3444 occurred rather than trying to keep going and printing further error
3445 messages.
3447 @end table
3449 You can request many specific warnings with options beginning with
3450 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3451 implicit declarations.  Each of these specific warning options also
3452 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3453 example, @option{-Wno-implicit}.  This manual lists only one of the
3454 two forms, whichever is not the default.  For further
3455 language-specific options also refer to @ref{C++ Dialect Options} and
3456 @ref{Objective-C and Objective-C++ Dialect Options}.
3458 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3459 options, such as @option{-Wunused}, which may turn on further options,
3460 such as @option{-Wunused-value}. The combined effect of positive and
3461 negative forms is that more specific options have priority over less
3462 specific ones, independently of their position in the command-line. For
3463 options of the same specificity, the last one takes effect. Options
3464 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3465 as if they appeared at the end of the command-line.
3467 When an unrecognized warning option is requested (e.g.,
3468 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3469 that the option is not recognized.  However, if the @option{-Wno-} form
3470 is used, the behavior is slightly different: no diagnostic is
3471 produced for @option{-Wno-unknown-warning} unless other diagnostics
3472 are being produced.  This allows the use of new @option{-Wno-} options
3473 with old compilers, but if something goes wrong, the compiler
3474 warns that an unrecognized option is present.
3476 @table @gcctabopt
3477 @item -Wpedantic
3478 @itemx -pedantic
3479 @opindex pedantic
3480 @opindex Wpedantic
3481 Issue all the warnings demanded by strict ISO C and ISO C++;
3482 reject all programs that use forbidden extensions, and some other
3483 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3484 version of the ISO C standard specified by any @option{-std} option used.
3486 Valid ISO C and ISO C++ programs should compile properly with or without
3487 this option (though a rare few require @option{-ansi} or a
3488 @option{-std} option specifying the required version of ISO C)@.  However,
3489 without this option, certain GNU extensions and traditional C and C++
3490 features are supported as well.  With this option, they are rejected.
3492 @option{-Wpedantic} does not cause warning messages for use of the
3493 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3494 warnings are also disabled in the expression that follows
3495 @code{__extension__}.  However, only system header files should use
3496 these escape routes; application programs should avoid them.
3497 @xref{Alternate Keywords}.
3499 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3500 C conformance.  They soon find that it does not do quite what they want:
3501 it finds some non-ISO practices, but not all---only those for which
3502 ISO C @emph{requires} a diagnostic, and some others for which
3503 diagnostics have been added.
3505 A feature to report any failure to conform to ISO C might be useful in
3506 some instances, but would require considerable additional work and would
3507 be quite different from @option{-Wpedantic}.  We don't have plans to
3508 support such a feature in the near future.
3510 Where the standard specified with @option{-std} represents a GNU
3511 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3512 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3513 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3514 where they are required by the base standard.  (It does not make sense
3515 for such warnings to be given only for features not in the specified GNU
3516 C dialect, since by definition the GNU dialects of C include all
3517 features the compiler supports with the given option, and there would be
3518 nothing to warn about.)
3520 @item -pedantic-errors
3521 @opindex pedantic-errors
3522 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3523 requires a diagnostic, in some cases where there is undefined behavior
3524 at compile-time and in some other cases that do not prevent compilation
3525 of programs that are valid according to the standard. This is not
3526 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3527 by this option and not enabled by the latter and vice versa.
3529 @item -Wall
3530 @opindex Wall
3531 @opindex Wno-all
3532 This enables all the warnings about constructions that some users
3533 consider questionable, and that are easy to avoid (or modify to
3534 prevent the warning), even in conjunction with macros.  This also
3535 enables some language-specific warnings described in @ref{C++ Dialect
3536 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3538 @option{-Wall} turns on the following warning flags:
3540 @gccoptlist{-Waddress   @gol
3541 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3542 -Wbool-compare  @gol
3543 -Wc++11-compat  -Wc++14-compat@gol
3544 -Wchar-subscripts  @gol
3545 -Wcomment  @gol
3546 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3547 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3548 -Wformat   @gol
3549 -Wimplicit @r{(C and Objective-C only)} @gol
3550 -Wimplicit-int @r{(C and Objective-C only)} @gol
3551 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3552 -Winit-self @r{(only for C++)} @gol
3553 -Wlogical-not-parentheses
3554 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3555 -Wmaybe-uninitialized @gol
3556 -Wmemset-elt-size @gol
3557 -Wmemset-transposed-args @gol
3558 -Wmisleading-indentation @r{(only for C/C++)} @gol
3559 -Wmissing-braces @r{(only for C/ObjC)} @gol
3560 -Wnarrowing @r{(only for C++)}  @gol
3561 -Wnonnull  @gol
3562 -Wnonnull-compare  @gol
3563 -Wopenmp-simd @gol
3564 -Wparentheses  @gol
3565 -Wpointer-sign  @gol
3566 -Wreorder   @gol
3567 -Wreturn-type  @gol
3568 -Wsequence-point  @gol
3569 -Wsign-compare @r{(only in C++)}  @gol
3570 -Wsizeof-pointer-memaccess @gol
3571 -Wstrict-aliasing  @gol
3572 -Wstrict-overflow=1  @gol
3573 -Wswitch  @gol
3574 -Wtautological-compare  @gol
3575 -Wtrigraphs  @gol
3576 -Wuninitialized  @gol
3577 -Wunknown-pragmas  @gol
3578 -Wunused-function  @gol
3579 -Wunused-label     @gol
3580 -Wunused-value     @gol
3581 -Wunused-variable  @gol
3582 -Wvolatile-register-var @gol
3585 Note that some warning flags are not implied by @option{-Wall}.  Some of
3586 them warn about constructions that users generally do not consider
3587 questionable, but which occasionally you might wish to check for;
3588 others warn about constructions that are necessary or hard to avoid in
3589 some cases, and there is no simple way to modify the code to suppress
3590 the warning. Some of them are enabled by @option{-Wextra} but many of
3591 them must be enabled individually.
3593 @item -Wextra
3594 @opindex W
3595 @opindex Wextra
3596 @opindex Wno-extra
3597 This enables some extra warning flags that are not enabled by
3598 @option{-Wall}. (This option used to be called @option{-W}.  The older
3599 name is still supported, but the newer name is more descriptive.)
3601 @gccoptlist{-Wclobbered  @gol
3602 -Wempty-body  @gol
3603 -Wignored-qualifiers @gol
3604 -Wmissing-field-initializers  @gol
3605 -Wmissing-parameter-type @r{(C only)}  @gol
3606 -Wold-style-declaration @r{(C only)}  @gol
3607 -Woverride-init  @gol
3608 -Wsign-compare @r{(C only)} @gol
3609 -Wtype-limits  @gol
3610 -Wuninitialized  @gol
3611 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3612 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3613 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3616 The option @option{-Wextra} also prints warning messages for the
3617 following cases:
3619 @itemize @bullet
3621 @item
3622 A pointer is compared against integer zero with @code{<}, @code{<=},
3623 @code{>}, or @code{>=}.
3625 @item
3626 (C++ only) An enumerator and a non-enumerator both appear in a
3627 conditional expression.
3629 @item
3630 (C++ only) Ambiguous virtual bases.
3632 @item
3633 (C++ only) Subscripting an array that has been declared @code{register}.
3635 @item
3636 (C++ only) Taking the address of a variable that has been declared
3637 @code{register}.
3639 @item
3640 (C++ only) A base class is not initialized in a derived class's copy
3641 constructor.
3643 @end itemize
3645 @item -Wchar-subscripts
3646 @opindex Wchar-subscripts
3647 @opindex Wno-char-subscripts
3648 Warn if an array subscript has type @code{char}.  This is a common cause
3649 of error, as programmers often forget that this type is signed on some
3650 machines.
3651 This warning is enabled by @option{-Wall}.
3653 @item -Wcomment
3654 @opindex Wcomment
3655 @opindex Wno-comment
3656 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3657 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3658 This warning is enabled by @option{-Wall}.
3660 @item -Wno-coverage-mismatch
3661 @opindex Wno-coverage-mismatch
3662 Warn if feedback profiles do not match when using the
3663 @option{-fprofile-use} option.
3664 If a source file is changed between compiling with @option{-fprofile-gen} and
3665 with @option{-fprofile-use}, the files with the profile feedback can fail
3666 to match the source file and GCC cannot use the profile feedback
3667 information.  By default, this warning is enabled and is treated as an
3668 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3669 warning or @option{-Wno-error=coverage-mismatch} can be used to
3670 disable the error.  Disabling the error for this warning can result in
3671 poorly optimized code and is useful only in the
3672 case of very minor changes such as bug fixes to an existing code-base.
3673 Completely disabling the warning is not recommended.
3675 @item -Wno-cpp
3676 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3678 Suppress warning messages emitted by @code{#warning} directives.
3680 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3681 @opindex Wdouble-promotion
3682 @opindex Wno-double-promotion
3683 Give a warning when a value of type @code{float} is implicitly
3684 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3685 floating-point unit implement @code{float} in hardware, but emulate
3686 @code{double} in software.  On such a machine, doing computations
3687 using @code{double} values is much more expensive because of the
3688 overhead required for software emulation.
3690 It is easy to accidentally do computations with @code{double} because
3691 floating-point literals are implicitly of type @code{double}.  For
3692 example, in:
3693 @smallexample
3694 @group
3695 float area(float radius)
3697    return 3.14159 * radius * radius;
3699 @end group
3700 @end smallexample
3701 the compiler performs the entire computation with @code{double}
3702 because the floating-point literal is a @code{double}.
3704 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3705 @opindex Wduplicate-decl-specifier
3706 @opindex Wno-duplicate-decl-specifier
3707 Warn if a declaration has duplicate @code{const}, @code{volatile},
3708 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3709 @option{-Wall}.
3711 @item -Wformat
3712 @itemx -Wformat=@var{n}
3713 @opindex Wformat
3714 @opindex Wno-format
3715 @opindex ffreestanding
3716 @opindex fno-builtin
3717 @opindex Wformat=
3718 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3719 the arguments supplied have types appropriate to the format string
3720 specified, and that the conversions specified in the format string make
3721 sense.  This includes standard functions, and others specified by format
3722 attributes (@pxref{Function Attributes}), in the @code{printf},
3723 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3724 not in the C standard) families (or other target-specific families).
3725 Which functions are checked without format attributes having been
3726 specified depends on the standard version selected, and such checks of
3727 functions without the attribute specified are disabled by
3728 @option{-ffreestanding} or @option{-fno-builtin}.
3730 The formats are checked against the format features supported by GNU
3731 libc version 2.2.  These include all ISO C90 and C99 features, as well
3732 as features from the Single Unix Specification and some BSD and GNU
3733 extensions.  Other library implementations may not support all these
3734 features; GCC does not support warning about features that go beyond a
3735 particular library's limitations.  However, if @option{-Wpedantic} is used
3736 with @option{-Wformat}, warnings are given about format features not
3737 in the selected standard version (but not for @code{strfmon} formats,
3738 since those are not in any version of the C standard).  @xref{C Dialect
3739 Options,,Options Controlling C Dialect}.
3741 @table @gcctabopt
3742 @item -Wformat=1
3743 @itemx -Wformat
3744 @opindex Wformat
3745 @opindex Wformat=1
3746 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3747 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3748 @option{-Wformat} also checks for null format arguments for several
3749 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3750 aspects of this level of format checking can be disabled by the
3751 options: @option{-Wno-format-contains-nul},
3752 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3753 @option{-Wformat} is enabled by @option{-Wall}.
3755 @item -Wno-format-contains-nul
3756 @opindex Wno-format-contains-nul
3757 @opindex Wformat-contains-nul
3758 If @option{-Wformat} is specified, do not warn about format strings that
3759 contain NUL bytes.
3761 @item -Wno-format-extra-args
3762 @opindex Wno-format-extra-args
3763 @opindex Wformat-extra-args
3764 If @option{-Wformat} is specified, do not warn about excess arguments to a
3765 @code{printf} or @code{scanf} format function.  The C standard specifies
3766 that such arguments are ignored.
3768 Where the unused arguments lie between used arguments that are
3769 specified with @samp{$} operand number specifications, normally
3770 warnings are still given, since the implementation could not know what
3771 type to pass to @code{va_arg} to skip the unused arguments.  However,
3772 in the case of @code{scanf} formats, this option suppresses the
3773 warning if the unused arguments are all pointers, since the Single
3774 Unix Specification says that such unused arguments are allowed.
3776 @item -Wno-format-zero-length
3777 @opindex Wno-format-zero-length
3778 @opindex Wformat-zero-length
3779 If @option{-Wformat} is specified, do not warn about zero-length formats.
3780 The C standard specifies that zero-length formats are allowed.
3783 @item -Wformat=2
3784 @opindex Wformat=2
3785 Enable @option{-Wformat} plus additional format checks.  Currently
3786 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3787 -Wformat-y2k}.
3789 @item -Wformat-nonliteral
3790 @opindex Wformat-nonliteral
3791 @opindex Wno-format-nonliteral
3792 If @option{-Wformat} is specified, also warn if the format string is not a
3793 string literal and so cannot be checked, unless the format function
3794 takes its format arguments as a @code{va_list}.
3796 @item -Wformat-security
3797 @opindex Wformat-security
3798 @opindex Wno-format-security
3799 If @option{-Wformat} is specified, also warn about uses of format
3800 functions that represent possible security problems.  At present, this
3801 warns about calls to @code{printf} and @code{scanf} functions where the
3802 format string is not a string literal and there are no format arguments,
3803 as in @code{printf (foo);}.  This may be a security hole if the format
3804 string came from untrusted input and contains @samp{%n}.  (This is
3805 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3806 in future warnings may be added to @option{-Wformat-security} that are not
3807 included in @option{-Wformat-nonliteral}.)
3809 @item -Wformat-signedness
3810 @opindex Wformat-signedness
3811 @opindex Wno-format-signedness
3812 If @option{-Wformat} is specified, also warn if the format string
3813 requires an unsigned argument and the argument is signed and vice versa.
3815 @item -Wformat-y2k
3816 @opindex Wformat-y2k
3817 @opindex Wno-format-y2k
3818 If @option{-Wformat} is specified, also warn about @code{strftime}
3819 formats that may yield only a two-digit year.
3820 @end table
3822 @item -Wnonnull
3823 @opindex Wnonnull
3824 @opindex Wno-nonnull
3825 Warn about passing a null pointer for arguments marked as
3826 requiring a non-null value by the @code{nonnull} function attribute.
3828 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3829 can be disabled with the @option{-Wno-nonnull} option.
3831 @item -Wnonnull-compare
3832 @opindex Wnonnull-compare
3833 @opindex Wno-nonnull-compare
3834 Warn when comparing an argument marked with the @code{nonnull}
3835 function attribute against null inside the function.
3837 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
3838 can be disabled with the @option{-Wno-nonnull-compare} option.
3840 @item -Wnull-dereference
3841 @opindex Wnull-dereference
3842 @opindex Wno-null-dereference
3843 Warn if the compiler detects paths that trigger erroneous or
3844 undefined behavior due to dereferencing a null pointer.  This option
3845 is only active when @option{-fdelete-null-pointer-checks} is active,
3846 which is enabled by optimizations in most targets.  The precision of
3847 the warnings depends on the optimization options used.
3849 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3850 @opindex Winit-self
3851 @opindex Wno-init-self
3852 Warn about uninitialized variables that are initialized with themselves.
3853 Note this option can only be used with the @option{-Wuninitialized} option.
3855 For example, GCC warns about @code{i} being uninitialized in the
3856 following snippet only when @option{-Winit-self} has been specified:
3857 @smallexample
3858 @group
3859 int f()
3861   int i = i;
3862   return i;
3864 @end group
3865 @end smallexample
3867 This warning is enabled by @option{-Wall} in C++.
3869 @item -Wimplicit-int @r{(C and Objective-C only)}
3870 @opindex Wimplicit-int
3871 @opindex Wno-implicit-int
3872 Warn when a declaration does not specify a type.
3873 This warning is enabled by @option{-Wall}.
3875 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3876 @opindex Wimplicit-function-declaration
3877 @opindex Wno-implicit-function-declaration
3878 Give a warning whenever a function is used before being declared. In
3879 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3880 enabled by default and it is made into an error by
3881 @option{-pedantic-errors}. This warning is also enabled by
3882 @option{-Wall}.
3884 @item -Wimplicit @r{(C and Objective-C only)}
3885 @opindex Wimplicit
3886 @opindex Wno-implicit
3887 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3888 This warning is enabled by @option{-Wall}.
3890 @item -Wignored-qualifiers @r{(C and C++ only)}
3891 @opindex Wignored-qualifiers
3892 @opindex Wno-ignored-qualifiers
3893 Warn if the return type of a function has a type qualifier
3894 such as @code{const}.  For ISO C such a type qualifier has no effect,
3895 since the value returned by a function is not an lvalue.
3896 For C++, the warning is only emitted for scalar types or @code{void}.
3897 ISO C prohibits qualified @code{void} return types on function
3898 definitions, so such return types always receive a warning
3899 even without this option.
3901 This warning is also enabled by @option{-Wextra}.
3903 @item -Wignored-attributes @r{(C and C++ only)}
3904 @opindex Wignored-attributes
3905 @opindex Wno-ignored-attributes
3906 Warn when an attribute is ignored.  This is different from the
3907 @option{-Wattributes} option in that it warns whenever the compiler decides
3908 to drop an attribute, not that the attribute is either unknown, used in a
3909 wrong place, etc.  This warning is enabled by default.
3911 @item -Wmain
3912 @opindex Wmain
3913 @opindex Wno-main
3914 Warn if the type of @code{main} is suspicious.  @code{main} should be
3915 a function with external linkage, returning int, taking either zero
3916 arguments, two, or three arguments of appropriate types.  This warning
3917 is enabled by default in C++ and is enabled by either @option{-Wall}
3918 or @option{-Wpedantic}.
3920 @item -Wmisleading-indentation @r{(C and C++ only)}
3921 @opindex Wmisleading-indentation
3922 @opindex Wno-misleading-indentation
3923 Warn when the indentation of the code does not reflect the block structure.
3924 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
3925 @code{for} clauses with a guarded statement that does not use braces,
3926 followed by an unguarded statement with the same indentation.
3928 In the following example, the call to ``bar'' is misleadingly indented as
3929 if it were guarded by the ``if'' conditional.
3931 @smallexample
3932   if (some_condition ())
3933     foo ();
3934     bar ();  /* Gotcha: this is not guarded by the "if".  */
3935 @end smallexample
3937 In the case of mixed tabs and spaces, the warning uses the
3938 @option{-ftabstop=} option to determine if the statements line up
3939 (defaulting to 8).
3941 The warning is not issued for code involving multiline preprocessor logic
3942 such as the following example.
3944 @smallexample
3945   if (flagA)
3946     foo (0);
3947 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
3948   if (flagB)
3949 #endif
3950     foo (1);
3951 @end smallexample
3953 The warning is not issued after a @code{#line} directive, since this
3954 typically indicates autogenerated code, and no assumptions can be made
3955 about the layout of the file that the directive references.
3957 This warning is enabled by @option{-Wall} in C and C++.
3959 @item -Wmissing-braces
3960 @opindex Wmissing-braces
3961 @opindex Wno-missing-braces
3962 Warn if an aggregate or union initializer is not fully bracketed.  In
3963 the following example, the initializer for @code{a} is not fully
3964 bracketed, but that for @code{b} is fully bracketed.  This warning is
3965 enabled by @option{-Wall} in C.
3967 @smallexample
3968 int a[2][2] = @{ 0, 1, 2, 3 @};
3969 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3970 @end smallexample
3972 This warning is enabled by @option{-Wall}.
3974 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3975 @opindex Wmissing-include-dirs
3976 @opindex Wno-missing-include-dirs
3977 Warn if a user-supplied include directory does not exist.
3979 @item -Wparentheses
3980 @opindex Wparentheses
3981 @opindex Wno-parentheses
3982 Warn if parentheses are omitted in certain contexts, such
3983 as when there is an assignment in a context where a truth value
3984 is expected, or when operators are nested whose precedence people
3985 often get confused about.
3987 Also warn if a comparison like @code{x<=y<=z} appears; this is
3988 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3989 interpretation from that of ordinary mathematical notation.
3991 Also warn for dangerous uses of the GNU extension to
3992 @code{?:} with omitted middle operand. When the condition
3993 in the @code{?}: operator is a boolean expression, the omitted value is
3994 always 1.  Often programmers expect it to be a value computed
3995 inside the conditional expression instead.
3997 This warning is enabled by @option{-Wall}.
3999 @item -Wsequence-point
4000 @opindex Wsequence-point
4001 @opindex Wno-sequence-point
4002 Warn about code that may have undefined semantics because of violations
4003 of sequence point rules in the C and C++ standards.
4005 The C and C++ standards define the order in which expressions in a C/C++
4006 program are evaluated in terms of @dfn{sequence points}, which represent
4007 a partial ordering between the execution of parts of the program: those
4008 executed before the sequence point, and those executed after it.  These
4009 occur after the evaluation of a full expression (one which is not part
4010 of a larger expression), after the evaluation of the first operand of a
4011 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4012 function is called (but after the evaluation of its arguments and the
4013 expression denoting the called function), and in certain other places.
4014 Other than as expressed by the sequence point rules, the order of
4015 evaluation of subexpressions of an expression is not specified.  All
4016 these rules describe only a partial order rather than a total order,
4017 since, for example, if two functions are called within one expression
4018 with no sequence point between them, the order in which the functions
4019 are called is not specified.  However, the standards committee have
4020 ruled that function calls do not overlap.
4022 It is not specified when between sequence points modifications to the
4023 values of objects take effect.  Programs whose behavior depends on this
4024 have undefined behavior; the C and C++ standards specify that ``Between
4025 the previous and next sequence point an object shall have its stored
4026 value modified at most once by the evaluation of an expression.
4027 Furthermore, the prior value shall be read only to determine the value
4028 to be stored.''.  If a program breaks these rules, the results on any
4029 particular implementation are entirely unpredictable.
4031 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4032 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4033 diagnosed by this option, and it may give an occasional false positive
4034 result, but in general it has been found fairly effective at detecting
4035 this sort of problem in programs.
4037 The standard is worded confusingly, therefore there is some debate
4038 over the precise meaning of the sequence point rules in subtle cases.
4039 Links to discussions of the problem, including proposed formal
4040 definitions, may be found on the GCC readings page, at
4041 @uref{http://gcc.gnu.org/@/readings.html}.
4043 This warning is enabled by @option{-Wall} for C and C++.
4045 @item -Wno-return-local-addr
4046 @opindex Wno-return-local-addr
4047 @opindex Wreturn-local-addr
4048 Do not warn about returning a pointer (or in C++, a reference) to a
4049 variable that goes out of scope after the function returns.
4051 @item -Wreturn-type
4052 @opindex Wreturn-type
4053 @opindex Wno-return-type
4054 Warn whenever a function is defined with a return type that defaults
4055 to @code{int}.  Also warn about any @code{return} statement with no
4056 return value in a function whose return type is not @code{void}
4057 (falling off the end of the function body is considered returning
4058 without a value), and about a @code{return} statement with an
4059 expression in a function whose return type is @code{void}.
4061 For C++, a function without return type always produces a diagnostic
4062 message, even when @option{-Wno-return-type} is specified.  The only
4063 exceptions are @code{main} and functions defined in system headers.
4065 This warning is enabled by @option{-Wall}.
4067 @item -Wshift-count-negative
4068 @opindex Wshift-count-negative
4069 @opindex Wno-shift-count-negative
4070 Warn if shift count is negative. This warning is enabled by default.
4072 @item -Wshift-count-overflow
4073 @opindex Wshift-count-overflow
4074 @opindex Wno-shift-count-overflow
4075 Warn if shift count >= width of type. This warning is enabled by default.
4077 @item -Wshift-negative-value
4078 @opindex Wshift-negative-value
4079 @opindex Wno-shift-negative-value
4080 Warn if left shifting a negative value.  This warning is enabled by
4081 @option{-Wextra} in C99 and C++11 modes (and newer).
4083 @item -Wshift-overflow
4084 @itemx -Wshift-overflow=@var{n}
4085 @opindex Wshift-overflow
4086 @opindex Wno-shift-overflow
4087 Warn about left shift overflows.  This warning is enabled by
4088 default in C99 and C++11 modes (and newer).
4090 @table @gcctabopt
4091 @item -Wshift-overflow=1
4092 This is the warning level of @option{-Wshift-overflow} and is enabled
4093 by default in C99 and C++11 modes (and newer).  This warning level does
4094 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4095 an overflow is still rejected in contexts where an integer constant expression
4096 is required.)
4098 @item -Wshift-overflow=2
4099 This warning level also warns about left-shifting 1 into the sign bit,
4100 unless C++14 mode is active.
4101 @end table
4103 @item -Wswitch
4104 @opindex Wswitch
4105 @opindex Wno-switch
4106 Warn whenever a @code{switch} statement has an index of enumerated type
4107 and lacks a @code{case} for one or more of the named codes of that
4108 enumeration.  (The presence of a @code{default} label prevents this
4109 warning.)  @code{case} labels outside the enumeration range also
4110 provoke warnings when this option is used (even if there is a
4111 @code{default} label).
4112 This warning is enabled by @option{-Wall}.
4114 @item -Wswitch-default
4115 @opindex Wswitch-default
4116 @opindex Wno-switch-default
4117 Warn whenever a @code{switch} statement does not have a @code{default}
4118 case.
4120 @item -Wswitch-enum
4121 @opindex Wswitch-enum
4122 @opindex Wno-switch-enum
4123 Warn whenever a @code{switch} statement has an index of enumerated type
4124 and lacks a @code{case} for one or more of the named codes of that
4125 enumeration.  @code{case} labels outside the enumeration range also
4126 provoke warnings when this option is used.  The only difference
4127 between @option{-Wswitch} and this option is that this option gives a
4128 warning about an omitted enumeration code even if there is a
4129 @code{default} label.
4131 @item -Wswitch-bool
4132 @opindex Wswitch-bool
4133 @opindex Wno-switch-bool
4134 Warn whenever a @code{switch} statement has an index of boolean type
4135 and the case values are outside the range of a boolean type.
4136 It is possible to suppress this warning by casting the controlling
4137 expression to a type other than @code{bool}.  For example:
4138 @smallexample
4139 @group
4140 switch ((int) (a == 4))
4141   @{
4142   @dots{}
4143   @}
4144 @end group
4145 @end smallexample
4146 This warning is enabled by default for C and C++ programs.
4148 @item -Wswitch-unreachable
4149 @opindex Wswitch-unreachable
4150 @opindex Wno-switch-unreachable
4151 Warn whenever a @code{switch} statement contains statements between the
4152 controlling expression and the first case label, which will never be
4153 executed.  For example:
4154 @smallexample
4155 @group
4156 switch (cond)
4157   @{
4158    i = 15;
4159   @dots{}
4160    case 5:
4161   @dots{}
4162   @}
4163 @end group
4164 @end smallexample
4165 @option{-Wswitch-unreachable} does not warn if the statement between the
4166 controlling expression and the first case label is just a declaration:
4167 @smallexample
4168 @group
4169 switch (cond)
4170   @{
4171    int i;
4172   @dots{}
4173    case 5:
4174    i = 5;
4175   @dots{}
4176   @}
4177 @end group
4178 @end smallexample
4179 This warning is enabled by default for C and C++ programs.
4181 @item -Wsync-nand @r{(C and C++ only)}
4182 @opindex Wsync-nand
4183 @opindex Wno-sync-nand
4184 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4185 built-in functions are used.  These functions changed semantics in GCC 4.4.
4187 @item -Wtrigraphs
4188 @opindex Wtrigraphs
4189 @opindex Wno-trigraphs
4190 Warn if any trigraphs are encountered that might change the meaning of
4191 the program (trigraphs within comments are not warned about).
4192 This warning is enabled by @option{-Wall}.
4194 @item -Wunused-but-set-parameter
4195 @opindex Wunused-but-set-parameter
4196 @opindex Wno-unused-but-set-parameter
4197 Warn whenever a function parameter is assigned to, but otherwise unused
4198 (aside from its declaration).
4200 To suppress this warning use the @code{unused} attribute
4201 (@pxref{Variable Attributes}).
4203 This warning is also enabled by @option{-Wunused} together with
4204 @option{-Wextra}.
4206 @item -Wunused-but-set-variable
4207 @opindex Wunused-but-set-variable
4208 @opindex Wno-unused-but-set-variable
4209 Warn whenever a local variable is assigned to, but otherwise unused
4210 (aside from its declaration).
4211 This warning is enabled by @option{-Wall}.
4213 To suppress this warning use the @code{unused} attribute
4214 (@pxref{Variable Attributes}).
4216 This warning is also enabled by @option{-Wunused}, which is enabled
4217 by @option{-Wall}.
4219 @item -Wunused-function
4220 @opindex Wunused-function
4221 @opindex Wno-unused-function
4222 Warn whenever a static function is declared but not defined or a
4223 non-inline static function is unused.
4224 This warning is enabled by @option{-Wall}.
4226 @item -Wunused-label
4227 @opindex Wunused-label
4228 @opindex Wno-unused-label
4229 Warn whenever a label is declared but not used.
4230 This warning is enabled by @option{-Wall}.
4232 To suppress this warning use the @code{unused} attribute
4233 (@pxref{Variable Attributes}).
4235 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4236 @opindex Wunused-local-typedefs
4237 Warn when a typedef locally defined in a function is not used.
4238 This warning is enabled by @option{-Wall}.
4240 @item -Wunused-parameter
4241 @opindex Wunused-parameter
4242 @opindex Wno-unused-parameter
4243 Warn whenever a function parameter is unused aside from its declaration.
4245 To suppress this warning use the @code{unused} attribute
4246 (@pxref{Variable Attributes}).
4248 @item -Wno-unused-result
4249 @opindex Wunused-result
4250 @opindex Wno-unused-result
4251 Do not warn if a caller of a function marked with attribute
4252 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4253 its return value. The default is @option{-Wunused-result}.
4255 @item -Wunused-variable
4256 @opindex Wunused-variable
4257 @opindex Wno-unused-variable
4258 Warn whenever a local or static variable is unused aside from its
4259 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4260 but not for C++. This warning is enabled by @option{-Wall}.
4262 To suppress this warning use the @code{unused} attribute
4263 (@pxref{Variable Attributes}).
4265 @item -Wunused-const-variable
4266 @itemx -Wunused-const-variable=@var{n}
4267 @opindex Wunused-const-variable
4268 @opindex Wno-unused-const-variable
4269 Warn whenever a constant static variable is unused aside from its declaration.
4270 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4271 for C, but not for C++. In C this declares variable storage, but in C++ this
4272 is not an error since const variables take the place of @code{#define}s.
4274 To suppress this warning use the @code{unused} attribute
4275 (@pxref{Variable Attributes}).
4277 @table @gcctabopt
4278 @item -Wunused-const-variable=1
4279 This is the warning level that is enabled by @option{-Wunused-variable} for
4280 C.  It warns only about unused static const variables defined in the main
4281 compilation unit, but not about static const variables declared in any
4282 header included.
4284 @item -Wunused-const-variable=2
4285 This warning level also warns for unused constant static variables in
4286 headers (excluding system headers).  This is the warning level of
4287 @option{-Wunused-const-variable} and must be explicitly requested since
4288 in C++ this isn't an error and in C it might be harder to clean up all
4289 headers included.
4290 @end table
4292 @item -Wunused-value
4293 @opindex Wunused-value
4294 @opindex Wno-unused-value
4295 Warn whenever a statement computes a result that is explicitly not
4296 used. To suppress this warning cast the unused expression to
4297 @code{void}. This includes an expression-statement or the left-hand
4298 side of a comma expression that contains no side effects. For example,
4299 an expression such as @code{x[i,j]} causes a warning, while
4300 @code{x[(void)i,j]} does not.
4302 This warning is enabled by @option{-Wall}.
4304 @item -Wunused
4305 @opindex Wunused
4306 @opindex Wno-unused
4307 All the above @option{-Wunused} options combined.
4309 In order to get a warning about an unused function parameter, you must
4310 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4311 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4313 @item -Wuninitialized
4314 @opindex Wuninitialized
4315 @opindex Wno-uninitialized
4316 Warn if an automatic variable is used without first being initialized
4317 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4318 warn if a non-static reference or non-static @code{const} member
4319 appears in a class without constructors.
4321 If you want to warn about code that uses the uninitialized value of the
4322 variable in its own initializer, use the @option{-Winit-self} option.
4324 These warnings occur for individual uninitialized or clobbered
4325 elements of structure, union or array variables as well as for
4326 variables that are uninitialized or clobbered as a whole.  They do
4327 not occur for variables or elements declared @code{volatile}.  Because
4328 these warnings depend on optimization, the exact variables or elements
4329 for which there are warnings depends on the precise optimization
4330 options and version of GCC used.
4332 Note that there may be no warning about a variable that is used only
4333 to compute a value that itself is never used, because such
4334 computations may be deleted by data flow analysis before the warnings
4335 are printed.
4337 @item -Winvalid-memory-model
4338 @opindex Winvalid-memory-model
4339 @opindex Wno-invalid-memory-model
4340 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4341 and the C11 atomic generic functions with a memory consistency argument
4342 that is either invalid for the operation or outside the range of values
4343 of the @code{memory_order} enumeration.  For example, since the
4344 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4345 defined for the relaxed, release, and sequentially consistent memory
4346 orders the following code is diagnosed:
4348 @smallexample
4349 void store (int *i)
4351   __atomic_store_n (i, 0, memory_order_consume);
4353 @end smallexample
4355 @option{-Winvalid-memory-model} is enabled by default.
4357 @item -Wmaybe-uninitialized
4358 @opindex Wmaybe-uninitialized
4359 @opindex Wno-maybe-uninitialized
4360 For an automatic variable, if there exists a path from the function
4361 entry to a use of the variable that is initialized, but there exist
4362 some other paths for which the variable is not initialized, the compiler
4363 emits a warning if it cannot prove the uninitialized paths are not
4364 executed at run time. These warnings are made optional because GCC is
4365 not smart enough to see all the reasons why the code might be correct
4366 in spite of appearing to have an error.  Here is one example of how
4367 this can happen:
4369 @smallexample
4370 @group
4372   int x;
4373   switch (y)
4374     @{
4375     case 1: x = 1;
4376       break;
4377     case 2: x = 4;
4378       break;
4379     case 3: x = 5;
4380     @}
4381   foo (x);
4383 @end group
4384 @end smallexample
4386 @noindent
4387 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4388 always initialized, but GCC doesn't know this. To suppress the
4389 warning, you need to provide a default case with assert(0) or
4390 similar code.
4392 @cindex @code{longjmp} warnings
4393 This option also warns when a non-volatile automatic variable might be
4394 changed by a call to @code{longjmp}.  These warnings as well are possible
4395 only in optimizing compilation.
4397 The compiler sees only the calls to @code{setjmp}.  It cannot know
4398 where @code{longjmp} will be called; in fact, a signal handler could
4399 call it at any point in the code.  As a result, you may get a warning
4400 even when there is in fact no problem because @code{longjmp} cannot
4401 in fact be called at the place that would cause a problem.
4403 Some spurious warnings can be avoided if you declare all the functions
4404 you use that never return as @code{noreturn}.  @xref{Function
4405 Attributes}.
4407 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4409 @item -Wunknown-pragmas
4410 @opindex Wunknown-pragmas
4411 @opindex Wno-unknown-pragmas
4412 @cindex warning for unknown pragmas
4413 @cindex unknown pragmas, warning
4414 @cindex pragmas, warning of unknown
4415 Warn when a @code{#pragma} directive is encountered that is not understood by 
4416 GCC@.  If this command-line option is used, warnings are even issued
4417 for unknown pragmas in system header files.  This is not the case if
4418 the warnings are only enabled by the @option{-Wall} command-line option.
4420 @item -Wno-pragmas
4421 @opindex Wno-pragmas
4422 @opindex Wpragmas
4423 Do not warn about misuses of pragmas, such as incorrect parameters,
4424 invalid syntax, or conflicts between pragmas.  See also
4425 @option{-Wunknown-pragmas}.
4427 @item -Wstrict-aliasing
4428 @opindex Wstrict-aliasing
4429 @opindex Wno-strict-aliasing
4430 This option is only active when @option{-fstrict-aliasing} is active.
4431 It warns about code that might break the strict aliasing rules that the
4432 compiler is using for optimization.  The warning does not catch all
4433 cases, but does attempt to catch the more common pitfalls.  It is
4434 included in @option{-Wall}.
4435 It is equivalent to @option{-Wstrict-aliasing=3}
4437 @item -Wstrict-aliasing=n
4438 @opindex Wstrict-aliasing=n
4439 This option is only active when @option{-fstrict-aliasing} is active.
4440 It warns about code that might break the strict aliasing rules that the
4441 compiler is using for optimization.
4442 Higher levels correspond to higher accuracy (fewer false positives).
4443 Higher levels also correspond to more effort, similar to the way @option{-O} 
4444 works.
4445 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4447 Level 1: Most aggressive, quick, least accurate.
4448 Possibly useful when higher levels
4449 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4450 false negatives.  However, it has many false positives.
4451 Warns for all pointer conversions between possibly incompatible types,
4452 even if never dereferenced.  Runs in the front end only.
4454 Level 2: Aggressive, quick, not too precise.
4455 May still have many false positives (not as many as level 1 though),
4456 and few false negatives (but possibly more than level 1).
4457 Unlike level 1, it only warns when an address is taken.  Warns about
4458 incomplete types.  Runs in the front end only.
4460 Level 3 (default for @option{-Wstrict-aliasing}):
4461 Should have very few false positives and few false
4462 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4463 Takes care of the common pun+dereference pattern in the front end:
4464 @code{*(int*)&some_float}.
4465 If optimization is enabled, it also runs in the back end, where it deals
4466 with multiple statement cases using flow-sensitive points-to information.
4467 Only warns when the converted pointer is dereferenced.
4468 Does not warn about incomplete types.
4470 @item -Wstrict-overflow
4471 @itemx -Wstrict-overflow=@var{n}
4472 @opindex Wstrict-overflow
4473 @opindex Wno-strict-overflow
4474 This option is only active when @option{-fstrict-overflow} is active.
4475 It warns about cases where the compiler optimizes based on the
4476 assumption that signed overflow does not occur.  Note that it does not
4477 warn about all cases where the code might overflow: it only warns
4478 about cases where the compiler implements some optimization.  Thus
4479 this warning depends on the optimization level.
4481 An optimization that assumes that signed overflow does not occur is
4482 perfectly safe if the values of the variables involved are such that
4483 overflow never does, in fact, occur.  Therefore this warning can
4484 easily give a false positive: a warning about code that is not
4485 actually a problem.  To help focus on important issues, several
4486 warning levels are defined.  No warnings are issued for the use of
4487 undefined signed overflow when estimating how many iterations a loop
4488 requires, in particular when determining whether a loop will be
4489 executed at all.
4491 @table @gcctabopt
4492 @item -Wstrict-overflow=1
4493 Warn about cases that are both questionable and easy to avoid.  For
4494 example,  with @option{-fstrict-overflow}, the compiler simplifies
4495 @code{x + 1 > x} to @code{1}.  This level of
4496 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4497 are not, and must be explicitly requested.
4499 @item -Wstrict-overflow=2
4500 Also warn about other cases where a comparison is simplified to a
4501 constant.  For example: @code{abs (x) >= 0}.  This can only be
4502 simplified when @option{-fstrict-overflow} is in effect, because
4503 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4504 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4505 @option{-Wstrict-overflow=2}.
4507 @item -Wstrict-overflow=3
4508 Also warn about other cases where a comparison is simplified.  For
4509 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4511 @item -Wstrict-overflow=4
4512 Also warn about other simplifications not covered by the above cases.
4513 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4515 @item -Wstrict-overflow=5
4516 Also warn about cases where the compiler reduces the magnitude of a
4517 constant involved in a comparison.  For example: @code{x + 2 > y} is
4518 simplified to @code{x + 1 >= y}.  This is reported only at the
4519 highest warning level because this simplification applies to many
4520 comparisons, so this warning level gives a very large number of
4521 false positives.
4522 @end table
4524 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4525 @opindex Wsuggest-attribute=
4526 @opindex Wno-suggest-attribute=
4527 Warn for cases where adding an attribute may be beneficial. The
4528 attributes currently supported are listed below.
4530 @table @gcctabopt
4531 @item -Wsuggest-attribute=pure
4532 @itemx -Wsuggest-attribute=const
4533 @itemx -Wsuggest-attribute=noreturn
4534 @opindex Wsuggest-attribute=pure
4535 @opindex Wno-suggest-attribute=pure
4536 @opindex Wsuggest-attribute=const
4537 @opindex Wno-suggest-attribute=const
4538 @opindex Wsuggest-attribute=noreturn
4539 @opindex Wno-suggest-attribute=noreturn
4541 Warn about functions that might be candidates for attributes
4542 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4543 functions visible in other compilation units or (in the case of @code{pure} and
4544 @code{const}) if it cannot prove that the function returns normally. A function
4545 returns normally if it doesn't contain an infinite loop or return abnormally
4546 by throwing, calling @code{abort} or trapping.  This analysis requires option
4547 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4548 higher.  Higher optimization levels improve the accuracy of the analysis.
4550 @item -Wsuggest-attribute=format
4551 @itemx -Wmissing-format-attribute
4552 @opindex Wsuggest-attribute=format
4553 @opindex Wmissing-format-attribute
4554 @opindex Wno-suggest-attribute=format
4555 @opindex Wno-missing-format-attribute
4556 @opindex Wformat
4557 @opindex Wno-format
4559 Warn about function pointers that might be candidates for @code{format}
4560 attributes.  Note these are only possible candidates, not absolute ones.
4561 GCC guesses that function pointers with @code{format} attributes that
4562 are used in assignment, initialization, parameter passing or return
4563 statements should have a corresponding @code{format} attribute in the
4564 resulting type.  I.e.@: the left-hand side of the assignment or
4565 initialization, the type of the parameter variable, or the return type
4566 of the containing function respectively should also have a @code{format}
4567 attribute to avoid the warning.
4569 GCC also warns about function definitions that might be
4570 candidates for @code{format} attributes.  Again, these are only
4571 possible candidates.  GCC guesses that @code{format} attributes
4572 might be appropriate for any function that calls a function like
4573 @code{vprintf} or @code{vscanf}, but this might not always be the
4574 case, and some functions for which @code{format} attributes are
4575 appropriate may not be detected.
4576 @end table
4578 @item -Wsuggest-final-types
4579 @opindex Wno-suggest-final-types
4580 @opindex Wsuggest-final-types
4581 Warn about types with virtual methods where code quality would be improved
4582 if the type were declared with the C++11 @code{final} specifier, 
4583 or, if possible,
4584 declared in an anonymous namespace. This allows GCC to more aggressively
4585 devirtualize the polymorphic calls. This warning is more effective with link
4586 time optimization, where the information about the class hierarchy graph is
4587 more complete.
4589 @item -Wsuggest-final-methods
4590 @opindex Wno-suggest-final-methods
4591 @opindex Wsuggest-final-methods
4592 Warn about virtual methods where code quality would be improved if the method
4593 were declared with the C++11 @code{final} specifier, 
4594 or, if possible, its type were
4595 declared in an anonymous namespace or with the @code{final} specifier.
4596 This warning is
4597 more effective with link time optimization, where the information about the
4598 class hierarchy graph is more complete. It is recommended to first consider
4599 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4600 annotations.
4602 @item -Wsuggest-override
4603 Warn about overriding virtual functions that are not marked with the override
4604 keyword.
4606 @item -Warray-bounds
4607 @itemx -Warray-bounds=@var{n}
4608 @opindex Wno-array-bounds
4609 @opindex Warray-bounds
4610 This option is only active when @option{-ftree-vrp} is active
4611 (default for @option{-O2} and above). It warns about subscripts to arrays
4612 that are always out of bounds. This warning is enabled by @option{-Wall}.
4614 @table @gcctabopt
4615 @item -Warray-bounds=1
4616 This is the warning level of @option{-Warray-bounds} and is enabled
4617 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4619 @item -Warray-bounds=2
4620 This warning level also warns about out of bounds access for
4621 arrays at the end of a struct and for arrays accessed through
4622 pointers. This warning level may give a larger number of
4623 false positives and is deactivated by default.
4624 @end table
4626 @item -Wbool-compare
4627 @opindex Wno-bool-compare
4628 @opindex Wbool-compare
4629 Warn about boolean expression compared with an integer value different from
4630 @code{true}/@code{false}.  For instance, the following comparison is
4631 always false:
4632 @smallexample
4633 int n = 5;
4634 @dots{}
4635 if ((n > 1) == 2) @{ @dots{} @}
4636 @end smallexample
4637 This warning is enabled by @option{-Wall}.
4639 @item -Wduplicated-cond
4640 @opindex Wno-duplicated-cond
4641 @opindex Wduplicated-cond
4642 Warn about duplicated conditions in an if-else-if chain.  For instance,
4643 warn for the following code:
4644 @smallexample
4645 if (p->q != NULL) @{ @dots{} @}
4646 else if (p->q != NULL) @{ @dots{} @}
4647 @end smallexample
4649 @item -Wframe-address
4650 @opindex Wno-frame-address
4651 @opindex Wframe-address
4652 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
4653 is called with an argument greater than 0.  Such calls may return indeterminate
4654 values or crash the program.  The warning is included in @option{-Wall}.
4656 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4657 @opindex Wno-discarded-qualifiers
4658 @opindex Wdiscarded-qualifiers
4659 Do not warn if type qualifiers on pointers are being discarded.
4660 Typically, the compiler warns if a @code{const char *} variable is
4661 passed to a function that takes a @code{char *} parameter.  This option
4662 can be used to suppress such a warning.
4664 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4665 @opindex Wno-discarded-array-qualifiers
4666 @opindex Wdiscarded-array-qualifiers
4667 Do not warn if type qualifiers on arrays which are pointer targets
4668 are being discarded. Typically, the compiler warns if a
4669 @code{const int (*)[]} variable is passed to a function that
4670 takes a @code{int (*)[]} parameter.  This option can be used to
4671 suppress such a warning.
4673 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4674 @opindex Wno-incompatible-pointer-types
4675 @opindex Wincompatible-pointer-types
4676 Do not warn when there is a conversion between pointers that have incompatible
4677 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4678 which warns for pointer argument passing or assignment with different
4679 signedness.
4681 @item -Wno-int-conversion @r{(C and Objective-C only)}
4682 @opindex Wno-int-conversion
4683 @opindex Wint-conversion
4684 Do not warn about incompatible integer to pointer and pointer to integer
4685 conversions.  This warning is about implicit conversions; for explicit
4686 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4687 @option{-Wno-pointer-to-int-cast} may be used.
4689 @item -Wno-div-by-zero
4690 @opindex Wno-div-by-zero
4691 @opindex Wdiv-by-zero
4692 Do not warn about compile-time integer division by zero.  Floating-point
4693 division by zero is not warned about, as it can be a legitimate way of
4694 obtaining infinities and NaNs.
4696 @item -Wsystem-headers
4697 @opindex Wsystem-headers
4698 @opindex Wno-system-headers
4699 @cindex warnings from system headers
4700 @cindex system headers, warnings from
4701 Print warning messages for constructs found in system header files.
4702 Warnings from system headers are normally suppressed, on the assumption
4703 that they usually do not indicate real problems and would only make the
4704 compiler output harder to read.  Using this command-line option tells
4705 GCC to emit warnings from system headers as if they occurred in user
4706 code.  However, note that using @option{-Wall} in conjunction with this
4707 option does @emph{not} warn about unknown pragmas in system
4708 headers---for that, @option{-Wunknown-pragmas} must also be used.
4710 @item -Wtautological-compare
4711 @opindex Wtautological-compare
4712 @opindex Wno-tautological-compare
4713 Warn if a self-comparison always evaluates to true or false.  This
4714 warning detects various mistakes such as:
4715 @smallexample
4716 int i = 1;
4717 @dots{}
4718 if (i > i) @{ @dots{} @}
4719 @end smallexample
4720 This warning is enabled by @option{-Wall}.
4722 @item -Wtrampolines
4723 @opindex Wtrampolines
4724 @opindex Wno-trampolines
4725 Warn about trampolines generated for pointers to nested functions.
4726 A trampoline is a small piece of data or code that is created at run
4727 time on the stack when the address of a nested function is taken, and is
4728 used to call the nested function indirectly.  For some targets, it is
4729 made up of data only and thus requires no special treatment.  But, for
4730 most targets, it is made up of code and thus requires the stack to be
4731 made executable in order for the program to work properly.
4733 @item -Wfloat-equal
4734 @opindex Wfloat-equal
4735 @opindex Wno-float-equal
4736 Warn if floating-point values are used in equality comparisons.
4738 The idea behind this is that sometimes it is convenient (for the
4739 programmer) to consider floating-point values as approximations to
4740 infinitely precise real numbers.  If you are doing this, then you need
4741 to compute (by analyzing the code, or in some other way) the maximum or
4742 likely maximum error that the computation introduces, and allow for it
4743 when performing comparisons (and when producing output, but that's a
4744 different problem).  In particular, instead of testing for equality, you
4745 should check to see whether the two values have ranges that overlap; and
4746 this is done with the relational operators, so equality comparisons are
4747 probably mistaken.
4749 @item -Wtraditional @r{(C and Objective-C only)}
4750 @opindex Wtraditional
4751 @opindex Wno-traditional
4752 Warn about certain constructs that behave differently in traditional and
4753 ISO C@.  Also warn about ISO C constructs that have no traditional C
4754 equivalent, and/or problematic constructs that should be avoided.
4756 @itemize @bullet
4757 @item
4758 Macro parameters that appear within string literals in the macro body.
4759 In traditional C macro replacement takes place within string literals,
4760 but in ISO C it does not.
4762 @item
4763 In traditional C, some preprocessor directives did not exist.
4764 Traditional preprocessors only considered a line to be a directive
4765 if the @samp{#} appeared in column 1 on the line.  Therefore
4766 @option{-Wtraditional} warns about directives that traditional C
4767 understands but ignores because the @samp{#} does not appear as the
4768 first character on the line.  It also suggests you hide directives like
4769 @code{#pragma} not understood by traditional C by indenting them.  Some
4770 traditional implementations do not recognize @code{#elif}, so this option
4771 suggests avoiding it altogether.
4773 @item
4774 A function-like macro that appears without arguments.
4776 @item
4777 The unary plus operator.
4779 @item
4780 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4781 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4782 constants.)  Note, these suffixes appear in macros defined in the system
4783 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4784 Use of these macros in user code might normally lead to spurious
4785 warnings, however GCC's integrated preprocessor has enough context to
4786 avoid warning in these cases.
4788 @item
4789 A function declared external in one block and then used after the end of
4790 the block.
4792 @item
4793 A @code{switch} statement has an operand of type @code{long}.
4795 @item
4796 A non-@code{static} function declaration follows a @code{static} one.
4797 This construct is not accepted by some traditional C compilers.
4799 @item
4800 The ISO type of an integer constant has a different width or
4801 signedness from its traditional type.  This warning is only issued if
4802 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4803 typically represent bit patterns, are not warned about.
4805 @item
4806 Usage of ISO string concatenation is detected.
4808 @item
4809 Initialization of automatic aggregates.
4811 @item
4812 Identifier conflicts with labels.  Traditional C lacks a separate
4813 namespace for labels.
4815 @item
4816 Initialization of unions.  If the initializer is zero, the warning is
4817 omitted.  This is done under the assumption that the zero initializer in
4818 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4819 initializer warnings and relies on default initialization to zero in the
4820 traditional C case.
4822 @item
4823 Conversions by prototypes between fixed/floating-point values and vice
4824 versa.  The absence of these prototypes when compiling with traditional
4825 C causes serious problems.  This is a subset of the possible
4826 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4828 @item
4829 Use of ISO C style function definitions.  This warning intentionally is
4830 @emph{not} issued for prototype declarations or variadic functions
4831 because these ISO C features appear in your code when using
4832 libiberty's traditional C compatibility macros, @code{PARAMS} and
4833 @code{VPARAMS}.  This warning is also bypassed for nested functions
4834 because that feature is already a GCC extension and thus not relevant to
4835 traditional C compatibility.
4836 @end itemize
4838 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4839 @opindex Wtraditional-conversion
4840 @opindex Wno-traditional-conversion
4841 Warn if a prototype causes a type conversion that is different from what
4842 would happen to the same argument in the absence of a prototype.  This
4843 includes conversions of fixed point to floating and vice versa, and
4844 conversions changing the width or signedness of a fixed-point argument
4845 except when the same as the default promotion.
4847 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4848 @opindex Wdeclaration-after-statement
4849 @opindex Wno-declaration-after-statement
4850 Warn when a declaration is found after a statement in a block.  This
4851 construct, known from C++, was introduced with ISO C99 and is by default
4852 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4854 @item -Wundef
4855 @opindex Wundef
4856 @opindex Wno-undef
4857 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4859 @item -Wno-endif-labels
4860 @opindex Wno-endif-labels
4861 @opindex Wendif-labels
4862 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4864 @item -Wshadow
4865 @opindex Wshadow
4866 @opindex Wno-shadow
4867 Warn whenever a local variable or type declaration shadows another
4868 variable, parameter, type, class member (in C++), or instance variable
4869 (in Objective-C) or whenever a built-in function is shadowed. Note
4870 that in C++, the compiler warns if a local variable shadows an
4871 explicit typedef, but not if it shadows a struct/class/enum.
4873 @item -Wno-shadow-ivar @r{(Objective-C only)}
4874 @opindex Wno-shadow-ivar
4875 @opindex Wshadow-ivar
4876 Do not warn whenever a local variable shadows an instance variable in an
4877 Objective-C method.
4879 @item -Wlarger-than=@var{len}
4880 @opindex Wlarger-than=@var{len}
4881 @opindex Wlarger-than-@var{len}
4882 Warn whenever an object of larger than @var{len} bytes is defined.
4884 @item -Wframe-larger-than=@var{len}
4885 @opindex Wframe-larger-than
4886 Warn if the size of a function frame is larger than @var{len} bytes.
4887 The computation done to determine the stack frame size is approximate
4888 and not conservative.
4889 The actual requirements may be somewhat greater than @var{len}
4890 even if you do not get a warning.  In addition, any space allocated
4891 via @code{alloca}, variable-length arrays, or related constructs
4892 is not included by the compiler when determining
4893 whether or not to issue a warning.
4895 @item -Wno-free-nonheap-object
4896 @opindex Wno-free-nonheap-object
4897 @opindex Wfree-nonheap-object
4898 Do not warn when attempting to free an object that was not allocated
4899 on the heap.
4901 @item -Wstack-usage=@var{len}
4902 @opindex Wstack-usage
4903 Warn if the stack usage of a function might be larger than @var{len} bytes.
4904 The computation done to determine the stack usage is conservative.
4905 Any space allocated via @code{alloca}, variable-length arrays, or related
4906 constructs is included by the compiler when determining whether or not to
4907 issue a warning.
4909 The message is in keeping with the output of @option{-fstack-usage}.
4911 @itemize
4912 @item
4913 If the stack usage is fully static but exceeds the specified amount, it's:
4915 @smallexample
4916   warning: stack usage is 1120 bytes
4917 @end smallexample
4918 @item
4919 If the stack usage is (partly) dynamic but bounded, it's:
4921 @smallexample
4922   warning: stack usage might be 1648 bytes
4923 @end smallexample
4924 @item
4925 If the stack usage is (partly) dynamic and not bounded, it's:
4927 @smallexample
4928   warning: stack usage might be unbounded
4929 @end smallexample
4930 @end itemize
4932 @item -Wunsafe-loop-optimizations
4933 @opindex Wunsafe-loop-optimizations
4934 @opindex Wno-unsafe-loop-optimizations
4935 Warn if the loop cannot be optimized because the compiler cannot
4936 assume anything on the bounds of the loop indices.  With
4937 @option{-funsafe-loop-optimizations} warn if the compiler makes
4938 such assumptions.
4940 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4941 @opindex Wno-pedantic-ms-format
4942 @opindex Wpedantic-ms-format
4943 When used in combination with @option{-Wformat}
4944 and @option{-pedantic} without GNU extensions, this option
4945 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4946 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4947 which depend on the MS runtime.
4949 @item -Wplacement-new
4950 @itemx -Wplacement-new=@var{n}
4951 @opindex Wplacement-new
4952 @opindex Wno-placement-new
4953 Warn about placement new expressions with undefined behavior, such as
4954 constructing an object in a buffer that is smaller than the type of
4955 the object.  For example, the placement new expression below is diagnosed
4956 because it attempts to construct an array of 64 integers in a buffer only
4957 64 bytes large.
4958 @smallexample
4959 char buf [64];
4960 new (buf) int[64];
4961 @end smallexample
4962 This warning is enabled by default.
4964 @table @gcctabopt
4965 @item -Wplacement-new=1
4966 This is the default warning level of @option{-Wplacement-new}.  At this
4967 level the warning is not issued for some strictly undefined constructs that
4968 GCC allows as extensions for compatibility with legacy code.  For example,
4969 the following @code{new} expression is not diagnosed at this level even
4970 though it has undefined behavior according to the C++ standard because
4971 it writes past the end of the one-element array.
4972 @smallexample
4973 struct S @{ int n, a[1]; @};
4974 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
4975 new (s->a)int [32]();
4976 @end smallexample
4978 @item -Wplacement-new=2
4979 At this level, in addition to diagnosing all the same constructs as at level
4980 1, a diagnostic is also issued for placement new expressions that construct
4981 an object in the last member of structure whose type is an array of a single
4982 element and whose size is less than the size of the object being constructed.
4983 While the previous example would be diagnosed, the following construct makes
4984 use of the flexible member array extension to avoid the warning at level 2.
4985 @smallexample
4986 struct S @{ int n, a[]; @};
4987 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
4988 new (s->a)int [32]();
4989 @end smallexample
4991 @end table
4993 @item -Wpointer-arith
4994 @opindex Wpointer-arith
4995 @opindex Wno-pointer-arith
4996 Warn about anything that depends on the ``size of'' a function type or
4997 of @code{void}.  GNU C assigns these types a size of 1, for
4998 convenience in calculations with @code{void *} pointers and pointers
4999 to functions.  In C++, warn also when an arithmetic operation involves
5000 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5002 @item -Wtype-limits
5003 @opindex Wtype-limits
5004 @opindex Wno-type-limits
5005 Warn if a comparison is always true or always false due to the limited
5006 range of the data type, but do not warn for constant expressions.  For
5007 example, warn if an unsigned variable is compared against zero with
5008 @code{<} or @code{>=}.  This warning is also enabled by
5009 @option{-Wextra}.
5011 @item -Wbad-function-cast @r{(C and Objective-C only)}
5012 @opindex Wbad-function-cast
5013 @opindex Wno-bad-function-cast
5014 Warn when a function call is cast to a non-matching type.
5015 For example, warn if a call to a function returning an integer type 
5016 is cast to a pointer type.
5018 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5019 @opindex Wc90-c99-compat
5020 @opindex Wno-c90-c99-compat
5021 Warn about features not present in ISO C90, but present in ISO C99.
5022 For instance, warn about use of variable length arrays, @code{long long}
5023 type, @code{bool} type, compound literals, designated initializers, and so
5024 on.  This option is independent of the standards mode.  Warnings are disabled
5025 in the expression that follows @code{__extension__}.
5027 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5028 @opindex Wc99-c11-compat
5029 @opindex Wno-c99-c11-compat
5030 Warn about features not present in ISO C99, but present in ISO C11.
5031 For instance, warn about use of anonymous structures and unions,
5032 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5033 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5034 and so on.  This option is independent of the standards mode.  Warnings are
5035 disabled in the expression that follows @code{__extension__}.
5037 @item -Wc++-compat @r{(C and Objective-C only)}
5038 @opindex Wc++-compat
5039 Warn about ISO C constructs that are outside of the common subset of
5040 ISO C and ISO C++, e.g.@: request for implicit conversion from
5041 @code{void *} to a pointer to non-@code{void} type.
5043 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5044 @opindex Wc++11-compat
5045 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5046 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5047 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5048 enabled by @option{-Wall}.
5050 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5051 @opindex Wc++14-compat
5052 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5053 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5055 @item -Wcast-qual
5056 @opindex Wcast-qual
5057 @opindex Wno-cast-qual
5058 Warn whenever a pointer is cast so as to remove a type qualifier from
5059 the target type.  For example, warn if a @code{const char *} is cast
5060 to an ordinary @code{char *}.
5062 Also warn when making a cast that introduces a type qualifier in an
5063 unsafe way.  For example, casting @code{char **} to @code{const char **}
5064 is unsafe, as in this example:
5066 @smallexample
5067   /* p is char ** value.  */
5068   const char **q = (const char **) p;
5069   /* Assignment of readonly string to const char * is OK.  */
5070   *q = "string";
5071   /* Now char** pointer points to read-only memory.  */
5072   **p = 'b';
5073 @end smallexample
5075 @item -Wcast-align
5076 @opindex Wcast-align
5077 @opindex Wno-cast-align
5078 Warn whenever a pointer is cast such that the required alignment of the
5079 target is increased.  For example, warn if a @code{char *} is cast to
5080 an @code{int *} on machines where integers can only be accessed at
5081 two- or four-byte boundaries.
5083 @item -Wwrite-strings
5084 @opindex Wwrite-strings
5085 @opindex Wno-write-strings
5086 When compiling C, give string constants the type @code{const
5087 char[@var{length}]} so that copying the address of one into a
5088 non-@code{const} @code{char *} pointer produces a warning.  These
5089 warnings help you find at compile time code that can try to write
5090 into a string constant, but only if you have been very careful about
5091 using @code{const} in declarations and prototypes.  Otherwise, it is
5092 just a nuisance. This is why we did not make @option{-Wall} request
5093 these warnings.
5095 When compiling C++, warn about the deprecated conversion from string
5096 literals to @code{char *}.  This warning is enabled by default for C++
5097 programs.
5099 @item -Wclobbered
5100 @opindex Wclobbered
5101 @opindex Wno-clobbered
5102 Warn for variables that might be changed by @code{longjmp} or
5103 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5105 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5106 @opindex Wconditionally-supported
5107 @opindex Wno-conditionally-supported
5108 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5110 @item -Wconversion
5111 @opindex Wconversion
5112 @opindex Wno-conversion
5113 Warn for implicit conversions that may alter a value. This includes
5114 conversions between real and integer, like @code{abs (x)} when
5115 @code{x} is @code{double}; conversions between signed and unsigned,
5116 like @code{unsigned ui = -1}; and conversions to smaller types, like
5117 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5118 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5119 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5120 conversions between signed and unsigned integers can be disabled by
5121 using @option{-Wno-sign-conversion}.
5123 For C++, also warn for confusing overload resolution for user-defined
5124 conversions; and conversions that never use a type conversion
5125 operator: conversions to @code{void}, the same type, a base class or a
5126 reference to them. Warnings about conversions between signed and
5127 unsigned integers are disabled by default in C++ unless
5128 @option{-Wsign-conversion} is explicitly enabled.
5130 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5131 @opindex Wconversion-null
5132 @opindex Wno-conversion-null
5133 Do not warn for conversions between @code{NULL} and non-pointer
5134 types. @option{-Wconversion-null} is enabled by default.
5136 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5137 @opindex Wzero-as-null-pointer-constant
5138 @opindex Wno-zero-as-null-pointer-constant
5139 Warn when a literal @samp{0} is used as null pointer constant.  This can
5140 be useful to facilitate the conversion to @code{nullptr} in C++11.
5142 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5143 @opindex Wsubobject-linkage
5144 @opindex Wno-subobject-linkage
5145 Warn if a class type has a base or a field whose type uses the anonymous
5146 namespace or depends on a type with no linkage.  If a type A depends on
5147 a type B with no or internal linkage, defining it in multiple
5148 translation units would be an ODR violation because the meaning of B
5149 is different in each translation unit.  If A only appears in a single
5150 translation unit, the best way to silence the warning is to give it
5151 internal linkage by putting it in an anonymous namespace as well.  The
5152 compiler doesn't give this warning for types defined in the main .C
5153 file, as those are unlikely to have multiple definitions.
5154 @option{-Wsubobject-linkage} is enabled by default.
5156 @item -Wdangling-else
5157 @opindex Wdangling-else
5158 @opindex Wno-dangling-else
5159 Warn about constructions where there may be confusion to which
5160 @code{if} statement an @code{else} branch belongs.  Here is an example of
5161 such a case:
5163 @smallexample
5164 @group
5166   if (a)
5167     if (b)
5168       foo ();
5169   else
5170     bar ();
5172 @end group
5173 @end smallexample
5175 In C/C++, every @code{else} branch belongs to the innermost possible
5176 @code{if} statement, which in this example is @code{if (b)}.  This is
5177 often not what the programmer expected, as illustrated in the above
5178 example by indentation the programmer chose.  When there is the
5179 potential for this confusion, GCC issues a warning when this flag
5180 is specified.  To eliminate the warning, add explicit braces around
5181 the innermost @code{if} statement so there is no way the @code{else}
5182 can belong to the enclosing @code{if}.  The resulting code
5183 looks like this:
5185 @smallexample
5186 @group
5188   if (a)
5189     @{
5190       if (b)
5191         foo ();
5192       else
5193         bar ();
5194     @}
5196 @end group
5197 @end smallexample
5199 This warning is enabled by @option{-Wparentheses}.
5201 @item -Wdate-time
5202 @opindex Wdate-time
5203 @opindex Wno-date-time
5204 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5205 are encountered as they might prevent bit-wise-identical reproducible
5206 compilations.
5208 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5209 @opindex Wdelete-incomplete
5210 @opindex Wno-delete-incomplete
5211 Warn when deleting a pointer to incomplete type, which may cause
5212 undefined behavior at runtime.  This warning is enabled by default.
5214 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5215 @opindex Wuseless-cast
5216 @opindex Wno-useless-cast
5217 Warn when an expression is casted to its own type.
5219 @item -Wempty-body
5220 @opindex Wempty-body
5221 @opindex Wno-empty-body
5222 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5223 while} statement.  This warning is also enabled by @option{-Wextra}.
5225 @item -Wenum-compare
5226 @opindex Wenum-compare
5227 @opindex Wno-enum-compare
5228 Warn about a comparison between values of different enumerated types.
5229 In C++ enumeral mismatches in conditional expressions are also
5230 diagnosed and the warning is enabled by default.  In C this warning is 
5231 enabled by @option{-Wall}.
5233 @item -Wjump-misses-init @r{(C, Objective-C only)}
5234 @opindex Wjump-misses-init
5235 @opindex Wno-jump-misses-init
5236 Warn if a @code{goto} statement or a @code{switch} statement jumps
5237 forward across the initialization of a variable, or jumps backward to a
5238 label after the variable has been initialized.  This only warns about
5239 variables that are initialized when they are declared.  This warning is
5240 only supported for C and Objective-C; in C++ this sort of branch is an
5241 error in any case.
5243 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5244 can be disabled with the @option{-Wno-jump-misses-init} option.
5246 @item -Wsign-compare
5247 @opindex Wsign-compare
5248 @opindex Wno-sign-compare
5249 @cindex warning for comparison of signed and unsigned values
5250 @cindex comparison of signed and unsigned values, warning
5251 @cindex signed and unsigned values, comparison warning
5252 Warn when a comparison between signed and unsigned values could produce
5253 an incorrect result when the signed value is converted to unsigned.
5254 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
5255 also enabled by @option{-Wextra}.
5257 @item -Wsign-conversion
5258 @opindex Wsign-conversion
5259 @opindex Wno-sign-conversion
5260 Warn for implicit conversions that may change the sign of an integer
5261 value, like assigning a signed integer expression to an unsigned
5262 integer variable. An explicit cast silences the warning. In C, this
5263 option is enabled also by @option{-Wconversion}.
5265 @item -Wfloat-conversion
5266 @opindex Wfloat-conversion
5267 @opindex Wno-float-conversion
5268 Warn for implicit conversions that reduce the precision of a real value.
5269 This includes conversions from real to integer, and from higher precision
5270 real to lower precision real values.  This option is also enabled by
5271 @option{-Wconversion}.
5273 @item -Wno-scalar-storage-order
5274 @opindex -Wno-scalar-storage-order
5275 @opindex -Wscalar-storage-order
5276 Do not warn on suspicious constructs involving reverse scalar storage order.
5278 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
5279 @opindex Wsized-deallocation
5280 @opindex Wno-sized-deallocation
5281 Warn about a definition of an unsized deallocation function
5282 @smallexample
5283 void operator delete (void *) noexcept;
5284 void operator delete[] (void *) noexcept;
5285 @end smallexample
5286 without a definition of the corresponding sized deallocation function
5287 @smallexample
5288 void operator delete (void *, std::size_t) noexcept;
5289 void operator delete[] (void *, std::size_t) noexcept;
5290 @end smallexample
5291 or vice versa.  Enabled by @option{-Wextra} along with
5292 @option{-fsized-deallocation}.
5294 @item -Wsizeof-pointer-memaccess
5295 @opindex Wsizeof-pointer-memaccess
5296 @opindex Wno-sizeof-pointer-memaccess
5297 Warn for suspicious length parameters to certain string and memory built-in
5298 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
5299 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
5300 but a pointer, and suggests a possible fix, or about
5301 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
5302 @option{-Wall}.
5304 @item -Wsizeof-array-argument
5305 @opindex Wsizeof-array-argument
5306 @opindex Wno-sizeof-array-argument
5307 Warn when the @code{sizeof} operator is applied to a parameter that is
5308 declared as an array in a function definition.  This warning is enabled by
5309 default for C and C++ programs.
5311 @item -Wmemset-elt-size
5312 @opindex Wmemset-elt-size
5313 @opindex Wno-memset-elt-size
5314 Warn for suspicious calls to the @code{memset} built-in function, if the
5315 first argument references an array, and the third argument is a number
5316 equal to the number of elements, but not equal to the size of the array
5317 in memory.  This indicates that the user has omitted a multiplication by
5318 the element size.  This warning is enabled by @option{-Wall}.
5320 @item -Wmemset-transposed-args
5321 @opindex Wmemset-transposed-args
5322 @opindex Wno-memset-transposed-args
5323 Warn for suspicious calls to the @code{memset} built-in function, if the
5324 second argument is not zero and the third argument is zero.  This warns e.g.@
5325 about @code{memset (buf, sizeof buf, 0)} where most probably
5326 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
5327 is only emitted if the third argument is literal zero.  If it is some
5328 expression that is folded to zero, a cast of zero to some type, etc., 
5329 it is far less likely that the user has mistakenly exchanged the arguments 
5330 and no warning is emitted.  This warning is enabled by @option{-Wall}.
5332 @item -Waddress
5333 @opindex Waddress
5334 @opindex Wno-address
5335 Warn about suspicious uses of memory addresses. These include using
5336 the address of a function in a conditional expression, such as
5337 @code{void func(void); if (func)}, and comparisons against the memory
5338 address of a string literal, such as @code{if (x == "abc")}.  Such
5339 uses typically indicate a programmer error: the address of a function
5340 always evaluates to true, so their use in a conditional usually
5341 indicate that the programmer forgot the parentheses in a function
5342 call; and comparisons against string literals result in unspecified
5343 behavior and are not portable in C, so they usually indicate that the
5344 programmer intended to use @code{strcmp}.  This warning is enabled by
5345 @option{-Wall}.
5347 @item -Wlogical-op
5348 @opindex Wlogical-op
5349 @opindex Wno-logical-op
5350 Warn about suspicious uses of logical operators in expressions.
5351 This includes using logical operators in contexts where a
5352 bit-wise operator is likely to be expected.  Also warns when
5353 the operands of a logical operator are the same:
5354 @smallexample
5355 extern int a;
5356 if (a < 0 && a < 0) @{ @dots{} @}
5357 @end smallexample
5359 @item -Wlogical-not-parentheses
5360 @opindex Wlogical-not-parentheses
5361 @opindex Wno-logical-not-parentheses
5362 Warn about logical not used on the left hand side operand of a comparison.
5363 This option does not warn if the RHS operand is of a boolean type.  Its
5364 purpose is to detect suspicious code like the following:
5365 @smallexample
5366 int a;
5367 @dots{}
5368 if (!a > 1) @{ @dots{} @}
5369 @end smallexample
5371 It is possible to suppress the warning by wrapping the LHS into
5372 parentheses:
5373 @smallexample
5374 if ((!a) > 1) @{ @dots{} @}
5375 @end smallexample
5377 This warning is enabled by @option{-Wall}.
5379 @item -Waggregate-return
5380 @opindex Waggregate-return
5381 @opindex Wno-aggregate-return
5382 Warn if any functions that return structures or unions are defined or
5383 called.  (In languages where you can return an array, this also elicits
5384 a warning.)
5386 @item -Wno-aggressive-loop-optimizations
5387 @opindex Wno-aggressive-loop-optimizations
5388 @opindex Waggressive-loop-optimizations
5389 Warn if in a loop with constant number of iterations the compiler detects
5390 undefined behavior in some statement during one or more of the iterations.
5392 @item -Wno-attributes
5393 @opindex Wno-attributes
5394 @opindex Wattributes
5395 Do not warn if an unexpected @code{__attribute__} is used, such as
5396 unrecognized attributes, function attributes applied to variables,
5397 etc.  This does not stop errors for incorrect use of supported
5398 attributes.
5400 @item -Wno-builtin-macro-redefined
5401 @opindex Wno-builtin-macro-redefined
5402 @opindex Wbuiltin-macro-redefined
5403 Do not warn if certain built-in macros are redefined.  This suppresses
5404 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5405 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5407 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5408 @opindex Wstrict-prototypes
5409 @opindex Wno-strict-prototypes
5410 Warn if a function is declared or defined without specifying the
5411 argument types.  (An old-style function definition is permitted without
5412 a warning if preceded by a declaration that specifies the argument
5413 types.)
5415 @item -Wold-style-declaration @r{(C and Objective-C only)}
5416 @opindex Wold-style-declaration
5417 @opindex Wno-old-style-declaration
5418 Warn for obsolescent usages, according to the C Standard, in a
5419 declaration. For example, warn if storage-class specifiers like
5420 @code{static} are not the first things in a declaration.  This warning
5421 is also enabled by @option{-Wextra}.
5423 @item -Wold-style-definition @r{(C and Objective-C only)}
5424 @opindex Wold-style-definition
5425 @opindex Wno-old-style-definition
5426 Warn if an old-style function definition is used.  A warning is given
5427 even if there is a previous prototype.
5429 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5430 @opindex Wmissing-parameter-type
5431 @opindex Wno-missing-parameter-type
5432 A function parameter is declared without a type specifier in K&R-style
5433 functions:
5435 @smallexample
5436 void foo(bar) @{ @}
5437 @end smallexample
5439 This warning is also enabled by @option{-Wextra}.
5441 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5442 @opindex Wmissing-prototypes
5443 @opindex Wno-missing-prototypes
5444 Warn if a global function is defined without a previous prototype
5445 declaration.  This warning is issued even if the definition itself
5446 provides a prototype.  Use this option to detect global functions
5447 that do not have a matching prototype declaration in a header file.
5448 This option is not valid for C++ because all function declarations
5449 provide prototypes and a non-matching declaration declares an
5450 overload rather than conflict with an earlier declaration.
5451 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5453 @item -Wmissing-declarations
5454 @opindex Wmissing-declarations
5455 @opindex Wno-missing-declarations
5456 Warn if a global function is defined without a previous declaration.
5457 Do so even if the definition itself provides a prototype.
5458 Use this option to detect global functions that are not declared in
5459 header files.  In C, no warnings are issued for functions with previous
5460 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5461 missing prototypes.  In C++, no warnings are issued for function templates,
5462 or for inline functions, or for functions in anonymous namespaces.
5464 @item -Wmissing-field-initializers
5465 @opindex Wmissing-field-initializers
5466 @opindex Wno-missing-field-initializers
5467 @opindex W
5468 @opindex Wextra
5469 @opindex Wno-extra
5470 Warn if a structure's initializer has some fields missing.  For
5471 example, the following code causes such a warning, because
5472 @code{x.h} is implicitly zero:
5474 @smallexample
5475 struct s @{ int f, g, h; @};
5476 struct s x = @{ 3, 4 @};
5477 @end smallexample
5479 This option does not warn about designated initializers, so the following
5480 modification does not trigger a warning:
5482 @smallexample
5483 struct s @{ int f, g, h; @};
5484 struct s x = @{ .f = 3, .g = 4 @};
5485 @end smallexample
5487 In C++ this option does not warn either about the empty @{ @}
5488 initializer, for example:
5490 @smallexample
5491 struct s @{ int f, g, h; @};
5492 s x = @{ @};
5493 @end smallexample
5495 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5496 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5498 @item -Wno-multichar
5499 @opindex Wno-multichar
5500 @opindex Wmultichar
5501 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5502 Usually they indicate a typo in the user's code, as they have
5503 implementation-defined values, and should not be used in portable code.
5505 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5506 @opindex Wnormalized=
5507 @opindex Wnormalized
5508 @opindex Wno-normalized
5509 @cindex NFC
5510 @cindex NFKC
5511 @cindex character set, input normalization
5512 In ISO C and ISO C++, two identifiers are different if they are
5513 different sequences of characters.  However, sometimes when characters
5514 outside the basic ASCII character set are used, you can have two
5515 different character sequences that look the same.  To avoid confusion,
5516 the ISO 10646 standard sets out some @dfn{normalization rules} which
5517 when applied ensure that two sequences that look the same are turned into
5518 the same sequence.  GCC can warn you if you are using identifiers that
5519 have not been normalized; this option controls that warning.
5521 There are four levels of warning supported by GCC@.  The default is
5522 @option{-Wnormalized=nfc}, which warns about any identifier that is
5523 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5524 recommended form for most uses.  It is equivalent to
5525 @option{-Wnormalized}.
5527 Unfortunately, there are some characters allowed in identifiers by
5528 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5529 identifiers.  That is, there's no way to use these symbols in portable
5530 ISO C or C++ and have all your identifiers in NFC@.
5531 @option{-Wnormalized=id} suppresses the warning for these characters.
5532 It is hoped that future versions of the standards involved will correct
5533 this, which is why this option is not the default.
5535 You can switch the warning off for all characters by writing
5536 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5537 only do this if you are using some other normalization scheme (like
5538 ``D''), because otherwise you can easily create bugs that are
5539 literally impossible to see.
5541 Some characters in ISO 10646 have distinct meanings but look identical
5542 in some fonts or display methodologies, especially once formatting has
5543 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5544 LETTER N'', displays just like a regular @code{n} that has been
5545 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5546 normalization scheme to convert all these into a standard form as
5547 well, and GCC warns if your code is not in NFKC if you use
5548 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5549 about every identifier that contains the letter O because it might be
5550 confused with the digit 0, and so is not the default, but may be
5551 useful as a local coding convention if the programming environment 
5552 cannot be fixed to display these characters distinctly.
5554 @item -Wno-deprecated
5555 @opindex Wno-deprecated
5556 @opindex Wdeprecated
5557 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5559 @item -Wno-deprecated-declarations
5560 @opindex Wno-deprecated-declarations
5561 @opindex Wdeprecated-declarations
5562 Do not warn about uses of functions (@pxref{Function Attributes}),
5563 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5564 Attributes}) marked as deprecated by using the @code{deprecated}
5565 attribute.
5567 @item -Wno-overflow
5568 @opindex Wno-overflow
5569 @opindex Woverflow
5570 Do not warn about compile-time overflow in constant expressions.
5572 @item -Wno-odr
5573 @opindex Wno-odr
5574 @opindex Wodr
5575 Warn about One Definition Rule violations during link-time optimization.
5576 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5578 @item -Wopenmp-simd
5579 @opindex Wopenm-simd
5580 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5581 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5582 option can be used to relax the cost model.
5584 @item -Woverride-init @r{(C and Objective-C only)}
5585 @opindex Woverride-init
5586 @opindex Wno-override-init
5587 @opindex W
5588 @opindex Wextra
5589 @opindex Wno-extra
5590 Warn if an initialized field without side effects is overridden when
5591 using designated initializers (@pxref{Designated Inits, , Designated
5592 Initializers}).
5594 This warning is included in @option{-Wextra}.  To get other
5595 @option{-Wextra} warnings without this one, use @option{-Wextra
5596 -Wno-override-init}.
5598 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
5599 @opindex Woverride-init-side-effects
5600 @opindex Wno-override-init-side-effects
5601 Warn if an initialized field with side effects is overridden when
5602 using designated initializers (@pxref{Designated Inits, , Designated
5603 Initializers}).  This warning is enabled by default.
5605 @item -Wpacked
5606 @opindex Wpacked
5607 @opindex Wno-packed
5608 Warn if a structure is given the packed attribute, but the packed
5609 attribute has no effect on the layout or size of the structure.
5610 Such structures may be mis-aligned for little benefit.  For
5611 instance, in this code, the variable @code{f.x} in @code{struct bar}
5612 is misaligned even though @code{struct bar} does not itself
5613 have the packed attribute:
5615 @smallexample
5616 @group
5617 struct foo @{
5618   int x;
5619   char a, b, c, d;
5620 @} __attribute__((packed));
5621 struct bar @{
5622   char z;
5623   struct foo f;
5625 @end group
5626 @end smallexample
5628 @item -Wpacked-bitfield-compat
5629 @opindex Wpacked-bitfield-compat
5630 @opindex Wno-packed-bitfield-compat
5631 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5632 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5633 the change can lead to differences in the structure layout.  GCC
5634 informs you when the offset of such a field has changed in GCC 4.4.
5635 For example there is no longer a 4-bit padding between field @code{a}
5636 and @code{b} in this structure:
5638 @smallexample
5639 struct foo
5641   char a:4;
5642   char b:8;
5643 @} __attribute__ ((packed));
5644 @end smallexample
5646 This warning is enabled by default.  Use
5647 @option{-Wno-packed-bitfield-compat} to disable this warning.
5649 @item -Wpadded
5650 @opindex Wpadded
5651 @opindex Wno-padded
5652 Warn if padding is included in a structure, either to align an element
5653 of the structure or to align the whole structure.  Sometimes when this
5654 happens it is possible to rearrange the fields of the structure to
5655 reduce the padding and so make the structure smaller.
5657 @item -Wredundant-decls
5658 @opindex Wredundant-decls
5659 @opindex Wno-redundant-decls
5660 Warn if anything is declared more than once in the same scope, even in
5661 cases where multiple declaration is valid and changes nothing.
5663 @item -Wnested-externs @r{(C and Objective-C only)}
5664 @opindex Wnested-externs
5665 @opindex Wno-nested-externs
5666 Warn if an @code{extern} declaration is encountered within a function.
5668 @item -Wno-inherited-variadic-ctor
5669 @opindex Winherited-variadic-ctor
5670 @opindex Wno-inherited-variadic-ctor
5671 Suppress warnings about use of C++11 inheriting constructors when the
5672 base class inherited from has a C variadic constructor; the warning is
5673 on by default because the ellipsis is not inherited.
5675 @item -Winline
5676 @opindex Winline
5677 @opindex Wno-inline
5678 Warn if a function that is declared as inline cannot be inlined.
5679 Even with this option, the compiler does not warn about failures to
5680 inline functions declared in system headers.
5682 The compiler uses a variety of heuristics to determine whether or not
5683 to inline a function.  For example, the compiler takes into account
5684 the size of the function being inlined and the amount of inlining
5685 that has already been done in the current function.  Therefore,
5686 seemingly insignificant changes in the source program can cause the
5687 warnings produced by @option{-Winline} to appear or disappear.
5689 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5690 @opindex Wno-invalid-offsetof
5691 @opindex Winvalid-offsetof
5692 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5693 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5694 to a non-standard-layout type is undefined.  In existing C++ implementations,
5695 however, @code{offsetof} typically gives meaningful results.
5696 This flag is for users who are aware that they are
5697 writing nonportable code and who have deliberately chosen to ignore the
5698 warning about it.
5700 The restrictions on @code{offsetof} may be relaxed in a future version
5701 of the C++ standard.
5703 @item -Wno-int-to-pointer-cast
5704 @opindex Wno-int-to-pointer-cast
5705 @opindex Wint-to-pointer-cast
5706 Suppress warnings from casts to pointer type of an integer of a
5707 different size. In C++, casting to a pointer type of smaller size is
5708 an error. @option{Wint-to-pointer-cast} is enabled by default.
5711 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5712 @opindex Wno-pointer-to-int-cast
5713 @opindex Wpointer-to-int-cast
5714 Suppress warnings from casts from a pointer to an integer type of a
5715 different size.
5717 @item -Winvalid-pch
5718 @opindex Winvalid-pch
5719 @opindex Wno-invalid-pch
5720 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5721 the search path but can't be used.
5723 @item -Wlong-long
5724 @opindex Wlong-long
5725 @opindex Wno-long-long
5726 Warn if @code{long long} type is used.  This is enabled by either
5727 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5728 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5730 @item -Wvariadic-macros
5731 @opindex Wvariadic-macros
5732 @opindex Wno-variadic-macros
5733 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5734 alternate syntax is used in ISO C99 mode.  This is enabled by either
5735 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5736 messages, use @option{-Wno-variadic-macros}.
5738 @item -Wvarargs
5739 @opindex Wvarargs
5740 @opindex Wno-varargs
5741 Warn upon questionable usage of the macros used to handle variable
5742 arguments like @code{va_start}.  This is default.  To inhibit the
5743 warning messages, use @option{-Wno-varargs}.
5745 @item -Wvector-operation-performance
5746 @opindex Wvector-operation-performance
5747 @opindex Wno-vector-operation-performance
5748 Warn if vector operation is not implemented via SIMD capabilities of the
5749 architecture.  Mainly useful for the performance tuning.
5750 Vector operation can be implemented @code{piecewise}, which means that the
5751 scalar operation is performed on every vector element; 
5752 @code{in parallel}, which means that the vector operation is implemented
5753 using scalars of wider type, which normally is more performance efficient;
5754 and @code{as a single scalar}, which means that vector fits into a
5755 scalar type.
5757 @item -Wno-virtual-move-assign
5758 @opindex Wvirtual-move-assign
5759 @opindex Wno-virtual-move-assign
5760 Suppress warnings about inheriting from a virtual base with a
5761 non-trivial C++11 move assignment operator.  This is dangerous because
5762 if the virtual base is reachable along more than one path, it is
5763 moved multiple times, which can mean both objects end up in the
5764 moved-from state.  If the move assignment operator is written to avoid
5765 moving from a moved-from object, this warning can be disabled.
5767 @item -Wvla
5768 @opindex Wvla
5769 @opindex Wno-vla
5770 Warn if variable length array is used in the code.
5771 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5772 the variable length array.
5774 @item -Wvolatile-register-var
5775 @opindex Wvolatile-register-var
5776 @opindex Wno-volatile-register-var
5777 Warn if a register variable is declared volatile.  The volatile
5778 modifier does not inhibit all optimizations that may eliminate reads
5779 and/or writes to register variables.  This warning is enabled by
5780 @option{-Wall}.
5782 @item -Wdisabled-optimization
5783 @opindex Wdisabled-optimization
5784 @opindex Wno-disabled-optimization
5785 Warn if a requested optimization pass is disabled.  This warning does
5786 not generally indicate that there is anything wrong with your code; it
5787 merely indicates that GCC's optimizers are unable to handle the code
5788 effectively.  Often, the problem is that your code is too big or too
5789 complex; GCC refuses to optimize programs when the optimization
5790 itself is likely to take inordinate amounts of time.
5792 @item -Wpointer-sign @r{(C and Objective-C only)}
5793 @opindex Wpointer-sign
5794 @opindex Wno-pointer-sign
5795 Warn for pointer argument passing or assignment with different signedness.
5796 This option is only supported for C and Objective-C@.  It is implied by
5797 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5798 @option{-Wno-pointer-sign}.
5800 @item -Wstack-protector
5801 @opindex Wstack-protector
5802 @opindex Wno-stack-protector
5803 This option is only active when @option{-fstack-protector} is active.  It
5804 warns about functions that are not protected against stack smashing.
5806 @item -Woverlength-strings
5807 @opindex Woverlength-strings
5808 @opindex Wno-overlength-strings
5809 Warn about string constants that are longer than the ``minimum
5810 maximum'' length specified in the C standard.  Modern compilers
5811 generally allow string constants that are much longer than the
5812 standard's minimum limit, but very portable programs should avoid
5813 using longer strings.
5815 The limit applies @emph{after} string constant concatenation, and does
5816 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5817 C99, it was raised to 4095.  C++98 does not specify a normative
5818 minimum maximum, so we do not diagnose overlength strings in C++@.
5820 This option is implied by @option{-Wpedantic}, and can be disabled with
5821 @option{-Wno-overlength-strings}.
5823 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5824 @opindex Wunsuffixed-float-constants
5826 Issue a warning for any floating constant that does not have
5827 a suffix.  When used together with @option{-Wsystem-headers} it
5828 warns about such constants in system header files.  This can be useful
5829 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5830 from the decimal floating-point extension to C99.
5832 @item -Wno-designated-init @r{(C and Objective-C only)}
5833 Suppress warnings when a positional initializer is used to initialize
5834 a structure that has been marked with the @code{designated_init}
5835 attribute.
5837 @item -Whsa
5838 Issue a warning when HSAIL cannot be emitted for the compiled function or
5839 OpenMP construct.
5841 @end table
5843 @node Debugging Options
5844 @section Options for Debugging Your Program
5845 @cindex options, debugging
5846 @cindex debugging information options
5848 To tell GCC to emit extra information for use by a debugger, in almost 
5849 all cases you need only to add @option{-g} to your other options.
5851 GCC allows you to use @option{-g} with
5852 @option{-O}.  The shortcuts taken by optimized code may occasionally
5853 be surprising: some variables you declared may not exist
5854 at all; flow of control may briefly move where you did not expect it;
5855 some statements may not be executed because they compute constant
5856 results or their values are already at hand; some statements may
5857 execute in different places because they have been moved out of loops.
5858 Nevertheless it is possible to debug optimized output.  This makes
5859 it reasonable to use the optimizer for programs that might have bugs.
5861 If you are not using some other optimization option, consider
5862 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
5863 With no @option{-O} option at all, some compiler passes that collect
5864 information useful for debugging do not run at all, so that
5865 @option{-Og} may result in a better debugging experience.
5867 @table @gcctabopt
5868 @item -g
5869 @opindex g
5870 Produce debugging information in the operating system's native format
5871 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
5872 information.
5874 On most systems that use stabs format, @option{-g} enables use of extra
5875 debugging information that only GDB can use; this extra information
5876 makes debugging work better in GDB but probably makes other debuggers
5877 crash or
5878 refuse to read the program.  If you want to control for certain whether
5879 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5880 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5882 @item -ggdb
5883 @opindex ggdb
5884 Produce debugging information for use by GDB@.  This means to use the
5885 most expressive format available (DWARF, stabs, or the native format
5886 if neither of those are supported), including GDB extensions if at all
5887 possible.
5889 @item -gdwarf
5890 @itemx -gdwarf-@var{version}
5891 @opindex gdwarf
5892 Produce debugging information in DWARF format (if that is supported).
5893 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5894 for most targets is 4.  DWARF Version 5 is only experimental.
5896 Note that with DWARF Version 2, some ports require and always
5897 use some non-conflicting DWARF 3 extensions in the unwind tables.
5899 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5900 for maximum benefit.
5902 GCC no longer supports DWARF Version 1, which is substantially
5903 different than Version 2 and later.  For historical reasons, some
5904 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
5905 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
5906 in their names, but apply to all currently-supported versions of DWARF.
5908 @item -gstabs
5909 @opindex gstabs
5910 Produce debugging information in stabs format (if that is supported),
5911 without GDB extensions.  This is the format used by DBX on most BSD
5912 systems.  On MIPS, Alpha and System V Release 4 systems this option
5913 produces stabs debugging output that is not understood by DBX or SDB@.
5914 On System V Release 4 systems this option requires the GNU assembler.
5916 @item -gstabs+
5917 @opindex gstabs+
5918 Produce debugging information in stabs format (if that is supported),
5919 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5920 use of these extensions is likely to make other debuggers crash or
5921 refuse to read the program.
5923 @item -gcoff
5924 @opindex gcoff
5925 Produce debugging information in COFF format (if that is supported).
5926 This is the format used by SDB on most System V systems prior to
5927 System V Release 4.
5929 @item -gxcoff
5930 @opindex gxcoff
5931 Produce debugging information in XCOFF format (if that is supported).
5932 This is the format used by the DBX debugger on IBM RS/6000 systems.
5934 @item -gxcoff+
5935 @opindex gxcoff+
5936 Produce debugging information in XCOFF format (if that is supported),
5937 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5938 use of these extensions is likely to make other debuggers crash or
5939 refuse to read the program, and may cause assemblers other than the GNU
5940 assembler (GAS) to fail with an error.
5942 @item -gvms
5943 @opindex gvms
5944 Produce debugging information in Alpha/VMS debug format (if that is
5945 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5947 @item -g@var{level}
5948 @itemx -ggdb@var{level}
5949 @itemx -gstabs@var{level}
5950 @itemx -gcoff@var{level}
5951 @itemx -gxcoff@var{level}
5952 @itemx -gvms@var{level}
5953 Request debugging information and also use @var{level} to specify how
5954 much information.  The default level is 2.
5956 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5957 @option{-g}.
5959 Level 1 produces minimal information, enough for making backtraces in
5960 parts of the program that you don't plan to debug.  This includes
5961 descriptions of functions and external variables, and line number
5962 tables, but no information about local variables.
5964 Level 3 includes extra information, such as all the macro definitions
5965 present in the program.  Some debuggers support macro expansion when
5966 you use @option{-g3}.
5968 @option{-gdwarf} does not accept a concatenated debug level, to avoid
5969 confusion with @option{-gdwarf-@var{level}}.
5970 Instead use an additional @option{-g@var{level}} option to change the
5971 debug level for DWARF.
5973 @item -feliminate-unused-debug-symbols
5974 @opindex feliminate-unused-debug-symbols
5975 Produce debugging information in stabs format (if that is supported),
5976 for only symbols that are actually used.
5978 @item -femit-class-debug-always
5979 @opindex femit-class-debug-always
5980 Instead of emitting debugging information for a C++ class in only one
5981 object file, emit it in all object files using the class.  This option
5982 should be used only with debuggers that are unable to handle the way GCC
5983 normally emits debugging information for classes because using this
5984 option increases the size of debugging information by as much as a
5985 factor of two.
5987 @item -fno-merge-debug-strings
5988 @opindex fmerge-debug-strings
5989 @opindex fno-merge-debug-strings
5990 Direct the linker to not merge together strings in the debugging
5991 information that are identical in different object files.  Merging is
5992 not supported by all assemblers or linkers.  Merging decreases the size
5993 of the debug information in the output file at the cost of increasing
5994 link processing time.  Merging is enabled by default.
5996 @item -fdebug-prefix-map=@var{old}=@var{new}
5997 @opindex fdebug-prefix-map
5998 When compiling files in directory @file{@var{old}}, record debugging
5999 information describing them as in @file{@var{new}} instead.
6001 @item -fvar-tracking
6002 @opindex fvar-tracking
6003 Run variable tracking pass.  It computes where variables are stored at each
6004 position in code.  Better debugging information is then generated
6005 (if the debugging information format supports this information).
6007 It is enabled by default when compiling with optimization (@option{-Os},
6008 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6009 the debug info format supports it.
6011 @item -fvar-tracking-assignments
6012 @opindex fvar-tracking-assignments
6013 @opindex fno-var-tracking-assignments
6014 Annotate assignments to user variables early in the compilation and
6015 attempt to carry the annotations over throughout the compilation all the
6016 way to the end, in an attempt to improve debug information while
6017 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6019 It can be enabled even if var-tracking is disabled, in which case
6020 annotations are created and maintained, but discarded at the end.
6021 By default, this flag is enabled together with @option{-fvar-tracking},
6022 except when selective scheduling is enabled.
6024 @item -gsplit-dwarf
6025 @opindex gsplit-dwarf
6026 Separate as much DWARF debugging information as possible into a
6027 separate output file with the extension @file{.dwo}.  This option allows
6028 the build system to avoid linking files with debug information.  To
6029 be useful, this option requires a debugger capable of reading @file{.dwo}
6030 files.
6032 @item -gpubnames
6033 @opindex gpubnames
6034 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6036 @item -ggnu-pubnames
6037 @opindex ggnu-pubnames
6038 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6039 suitable for conversion into a GDB@ index.  This option is only useful
6040 with a linker that can produce GDB@ index version 7.
6042 @item -fdebug-types-section
6043 @opindex fdebug-types-section
6044 @opindex fno-debug-types-section
6045 When using DWARF Version 4 or higher, type DIEs can be put into
6046 their own @code{.debug_types} section instead of making them part of the
6047 @code{.debug_info} section.  It is more efficient to put them in a separate
6048 comdat sections since the linker can then remove duplicates.
6049 But not all DWARF consumers support @code{.debug_types} sections yet
6050 and on some objects @code{.debug_types} produces larger instead of smaller
6051 debugging information.
6053 @item -grecord-gcc-switches
6054 @item -gno-record-gcc-switches
6055 @opindex grecord-gcc-switches
6056 @opindex gno-record-gcc-switches
6057 This switch causes the command-line options used to invoke the
6058 compiler that may affect code generation to be appended to the
6059 DW_AT_producer attribute in DWARF debugging information.  The options
6060 are concatenated with spaces separating them from each other and from
6061 the compiler version.  
6062 It is enabled by default.
6063 See also @option{-frecord-gcc-switches} for another
6064 way of storing compiler options into the object file.  
6066 @item -gstrict-dwarf
6067 @opindex gstrict-dwarf
6068 Disallow using extensions of later DWARF standard version than selected
6069 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6070 DWARF extensions from later standard versions is allowed.
6072 @item -gno-strict-dwarf
6073 @opindex gno-strict-dwarf
6074 Allow using extensions of later DWARF standard version than selected with
6075 @option{-gdwarf-@var{version}}.
6077 @item -gz@r{[}=@var{type}@r{]}
6078 @opindex gz
6079 Produce compressed debug sections in DWARF format, if that is supported.
6080 If @var{type} is not given, the default type depends on the capabilities
6081 of the assembler and linker used.  @var{type} may be one of
6082 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6083 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6084 compression in traditional GNU format).  If the linker doesn't support
6085 writing compressed debug sections, the option is rejected.  Otherwise,
6086 if the assembler does not support them, @option{-gz} is silently ignored
6087 when producing object files.
6089 @item -feliminate-dwarf2-dups
6090 @opindex feliminate-dwarf2-dups
6091 Compress DWARF debugging information by eliminating duplicated
6092 information about each symbol.  This option only makes sense when
6093 generating DWARF debugging information.
6095 @item -femit-struct-debug-baseonly
6096 @opindex femit-struct-debug-baseonly
6097 Emit debug information for struct-like types
6098 only when the base name of the compilation source file
6099 matches the base name of file in which the struct is defined.
6101 This option substantially reduces the size of debugging information,
6102 but at significant potential loss in type information to the debugger.
6103 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6104 See @option{-femit-struct-debug-detailed} for more detailed control.
6106 This option works only with DWARF debug output.
6108 @item -femit-struct-debug-reduced
6109 @opindex femit-struct-debug-reduced
6110 Emit debug information for struct-like types
6111 only when the base name of the compilation source file
6112 matches the base name of file in which the type is defined,
6113 unless the struct is a template or defined in a system header.
6115 This option significantly reduces the size of debugging information,
6116 with some potential loss in type information to the debugger.
6117 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6118 See @option{-femit-struct-debug-detailed} for more detailed control.
6120 This option works only with DWARF debug output.
6122 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6123 @opindex femit-struct-debug-detailed
6124 Specify the struct-like types
6125 for which the compiler generates debug information.
6126 The intent is to reduce duplicate struct debug information
6127 between different object files within the same program.
6129 This option is a detailed version of
6130 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6131 which serves for most needs.
6133 A specification has the syntax@*
6134 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6136 The optional first word limits the specification to
6137 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6138 A struct type is used directly when it is the type of a variable, member.
6139 Indirect uses arise through pointers to structs.
6140 That is, when use of an incomplete struct is valid, the use is indirect.
6141 An example is
6142 @samp{struct one direct; struct two * indirect;}.
6144 The optional second word limits the specification to
6145 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6146 Generic structs are a bit complicated to explain.
6147 For C++, these are non-explicit specializations of template classes,
6148 or non-template classes within the above.
6149 Other programming languages have generics,
6150 but @option{-femit-struct-debug-detailed} does not yet implement them.
6152 The third word specifies the source files for those
6153 structs for which the compiler should emit debug information.
6154 The values @samp{none} and @samp{any} have the normal meaning.
6155 The value @samp{base} means that
6156 the base of name of the file in which the type declaration appears
6157 must match the base of the name of the main compilation file.
6158 In practice, this means that when compiling @file{foo.c}, debug information
6159 is generated for types declared in that file and @file{foo.h},
6160 but not other header files.
6161 The value @samp{sys} means those types satisfying @samp{base}
6162 or declared in system or compiler headers.
6164 You may need to experiment to determine the best settings for your application.
6166 The default is @option{-femit-struct-debug-detailed=all}.
6168 This option works only with DWARF debug output.
6170 @item -fno-dwarf2-cfi-asm
6171 @opindex fdwarf2-cfi-asm
6172 @opindex fno-dwarf2-cfi-asm
6173 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
6174 instead of using GAS @code{.cfi_*} directives.
6176 @item -fno-eliminate-unused-debug-types
6177 @opindex feliminate-unused-debug-types
6178 @opindex fno-eliminate-unused-debug-types
6179 Normally, when producing DWARF output, GCC avoids producing debug symbol 
6180 output for types that are nowhere used in the source file being compiled.
6181 Sometimes it is useful to have GCC emit debugging
6182 information for all types declared in a compilation
6183 unit, regardless of whether or not they are actually used
6184 in that compilation unit, for example 
6185 if, in the debugger, you want to cast a value to a type that is
6186 not actually used in your program (but is declared).  More often,
6187 however, this results in a significant amount of wasted space.
6188 @end table
6190 @node Optimize Options
6191 @section Options That Control Optimization
6192 @cindex optimize options
6193 @cindex options, optimization
6195 These options control various sorts of optimizations.
6197 Without any optimization option, the compiler's goal is to reduce the
6198 cost of compilation and to make debugging produce the expected
6199 results.  Statements are independent: if you stop the program with a
6200 breakpoint between statements, you can then assign a new value to any
6201 variable or change the program counter to any other statement in the
6202 function and get exactly the results you expect from the source
6203 code.
6205 Turning on optimization flags makes the compiler attempt to improve
6206 the performance and/or code size at the expense of compilation time
6207 and possibly the ability to debug the program.
6209 The compiler performs optimization based on the knowledge it has of the
6210 program.  Compiling multiple files at once to a single output file mode allows
6211 the compiler to use information gained from all of the files when compiling
6212 each of them.
6214 Not all optimizations are controlled directly by a flag.  Only
6215 optimizations that have a flag are listed in this section.
6217 Most optimizations are only enabled if an @option{-O} level is set on
6218 the command line.  Otherwise they are disabled, even if individual
6219 optimization flags are specified.
6221 Depending on the target and how GCC was configured, a slightly different
6222 set of optimizations may be enabled at each @option{-O} level than
6223 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6224 to find out the exact set of optimizations that are enabled at each level.
6225 @xref{Overall Options}, for examples.
6227 @table @gcctabopt
6228 @item -O
6229 @itemx -O1
6230 @opindex O
6231 @opindex O1
6232 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6233 more memory for a large function.
6235 With @option{-O}, the compiler tries to reduce code size and execution
6236 time, without performing any optimizations that take a great deal of
6237 compilation time.
6239 @option{-O} turns on the following optimization flags:
6240 @gccoptlist{
6241 -fauto-inc-dec @gol
6242 -fbranch-count-reg @gol
6243 -fcombine-stack-adjustments @gol
6244 -fcompare-elim @gol
6245 -fcprop-registers @gol
6246 -fdce @gol
6247 -fdefer-pop @gol
6248 -fdelayed-branch @gol
6249 -fdse @gol
6250 -fforward-propagate @gol
6251 -fguess-branch-probability @gol
6252 -fif-conversion2 @gol
6253 -fif-conversion @gol
6254 -finline-functions-called-once @gol
6255 -fipa-pure-const @gol
6256 -fipa-profile @gol
6257 -fipa-reference @gol
6258 -fmerge-constants @gol
6259 -fmove-loop-invariants @gol
6260 -freorder-blocks @gol
6261 -fshrink-wrap @gol
6262 -fsplit-wide-types @gol
6263 -fssa-backprop @gol
6264 -fssa-phiopt @gol
6265 -ftree-bit-ccp @gol
6266 -ftree-ccp @gol
6267 -ftree-ch @gol
6268 -ftree-coalesce-vars @gol
6269 -ftree-copy-prop @gol
6270 -ftree-dce @gol
6271 -ftree-dominator-opts @gol
6272 -ftree-dse @gol
6273 -ftree-forwprop @gol
6274 -ftree-fre @gol
6275 -ftree-phiprop @gol
6276 -ftree-sink @gol
6277 -ftree-slsr @gol
6278 -ftree-sra @gol
6279 -ftree-pta @gol
6280 -ftree-ter @gol
6281 -funit-at-a-time}
6283 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6284 where doing so does not interfere with debugging.
6286 @item -O2
6287 @opindex O2
6288 Optimize even more.  GCC performs nearly all supported optimizations
6289 that do not involve a space-speed tradeoff.
6290 As compared to @option{-O}, this option increases both compilation time
6291 and the performance of the generated code.
6293 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6294 also turns on the following optimization flags:
6295 @gccoptlist{-fthread-jumps @gol
6296 -falign-functions  -falign-jumps @gol
6297 -falign-loops  -falign-labels @gol
6298 -fcaller-saves @gol
6299 -fcrossjumping @gol
6300 -fcse-follow-jumps  -fcse-skip-blocks @gol
6301 -fdelete-null-pointer-checks @gol
6302 -fdevirtualize -fdevirtualize-speculatively @gol
6303 -fexpensive-optimizations @gol
6304 -fgcse  -fgcse-lm  @gol
6305 -fhoist-adjacent-loads @gol
6306 -finline-small-functions @gol
6307 -findirect-inlining @gol
6308 -fipa-cp @gol
6309 -fipa-cp-alignment @gol
6310 -fipa-sra @gol
6311 -fipa-icf @gol
6312 -fisolate-erroneous-paths-dereference @gol
6313 -flra-remat @gol
6314 -foptimize-sibling-calls @gol
6315 -foptimize-strlen @gol
6316 -fpartial-inlining @gol
6317 -fpeephole2 @gol
6318 -freorder-blocks-algorithm=stc @gol
6319 -freorder-blocks-and-partition -freorder-functions @gol
6320 -frerun-cse-after-loop  @gol
6321 -fsched-interblock  -fsched-spec @gol
6322 -fschedule-insns  -fschedule-insns2 @gol
6323 -fstrict-aliasing -fstrict-overflow @gol
6324 -ftree-builtin-call-dce @gol
6325 -ftree-switch-conversion -ftree-tail-merge @gol
6326 -ftree-pre @gol
6327 -ftree-vrp @gol
6328 -fipa-ra}
6330 Please note the warning under @option{-fgcse} about
6331 invoking @option{-O2} on programs that use computed gotos.
6333 @item -O3
6334 @opindex O3
6335 Optimize yet more.  @option{-O3} turns on all optimizations specified
6336 by @option{-O2} and also turns on the @option{-finline-functions},
6337 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6338 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
6339 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
6340 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
6341 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6343 @item -O0
6344 @opindex O0
6345 Reduce compilation time and make debugging produce the expected
6346 results.  This is the default.
6348 @item -Os
6349 @opindex Os
6350 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6351 do not typically increase code size.  It also performs further
6352 optimizations designed to reduce code size.
6354 @option{-Os} disables the following optimization flags:
6355 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6356 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
6357 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
6359 @item -Ofast
6360 @opindex Ofast
6361 Disregard strict standards compliance.  @option{-Ofast} enables all
6362 @option{-O3} optimizations.  It also enables optimizations that are not
6363 valid for all standard-compliant programs.
6364 It turns on @option{-ffast-math} and the Fortran-specific
6365 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6367 @item -Og
6368 @opindex Og
6369 Optimize debugging experience.  @option{-Og} enables optimizations
6370 that do not interfere with debugging. It should be the optimization
6371 level of choice for the standard edit-compile-debug cycle, offering
6372 a reasonable level of optimization while maintaining fast compilation
6373 and a good debugging experience.
6374 @end table
6376 If you use multiple @option{-O} options, with or without level numbers,
6377 the last such option is the one that is effective.
6379 Options of the form @option{-f@var{flag}} specify machine-independent
6380 flags.  Most flags have both positive and negative forms; the negative
6381 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6382 below, only one of the forms is listed---the one you typically 
6383 use.  You can figure out the other form by either removing @samp{no-}
6384 or adding it.
6386 The following options control specific optimizations.  They are either
6387 activated by @option{-O} options or are related to ones that are.  You
6388 can use the following flags in the rare cases when ``fine-tuning'' of
6389 optimizations to be performed is desired.
6391 @table @gcctabopt
6392 @item -fno-defer-pop
6393 @opindex fno-defer-pop
6394 Always pop the arguments to each function call as soon as that function
6395 returns.  For machines that must pop arguments after a function call,
6396 the compiler normally lets arguments accumulate on the stack for several
6397 function calls and pops them all at once.
6399 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6401 @item -fforward-propagate
6402 @opindex fforward-propagate
6403 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6404 instructions and checks if the result can be simplified.  If loop unrolling
6405 is active, two passes are performed and the second is scheduled after
6406 loop unrolling.
6408 This option is enabled by default at optimization levels @option{-O},
6409 @option{-O2}, @option{-O3}, @option{-Os}.
6411 @item -ffp-contract=@var{style}
6412 @opindex ffp-contract
6413 @option{-ffp-contract=off} disables floating-point expression contraction.
6414 @option{-ffp-contract=fast} enables floating-point expression contraction
6415 such as forming of fused multiply-add operations if the target has
6416 native support for them.
6417 @option{-ffp-contract=on} enables floating-point expression contraction
6418 if allowed by the language standard.  This is currently not implemented
6419 and treated equal to @option{-ffp-contract=off}.
6421 The default is @option{-ffp-contract=fast}.
6423 @item -fomit-frame-pointer
6424 @opindex fomit-frame-pointer
6425 Don't keep the frame pointer in a register for functions that
6426 don't need one.  This avoids the instructions to save, set up and
6427 restore frame pointers; it also makes an extra register available
6428 in many functions.  @strong{It also makes debugging impossible on
6429 some machines.}
6431 On some machines, such as the VAX, this flag has no effect, because
6432 the standard calling sequence automatically handles the frame pointer
6433 and nothing is saved by pretending it doesn't exist.  The
6434 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6435 whether a target machine supports this flag.  @xref{Registers,,Register
6436 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6438 The default setting (when not optimizing for
6439 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
6440 @option{-fomit-frame-pointer}.  You can configure GCC with the
6441 @option{--enable-frame-pointer} configure option to change the default.
6443 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6445 @item -foptimize-sibling-calls
6446 @opindex foptimize-sibling-calls
6447 Optimize sibling and tail recursive calls.
6449 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6451 @item -foptimize-strlen
6452 @opindex foptimize-strlen
6453 Optimize various standard C string functions (e.g. @code{strlen},
6454 @code{strchr} or @code{strcpy}) and
6455 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
6457 Enabled at levels @option{-O2}, @option{-O3}.
6459 @item -fno-inline
6460 @opindex fno-inline
6461 Do not expand any functions inline apart from those marked with
6462 the @code{always_inline} attribute.  This is the default when not
6463 optimizing.
6465 Single functions can be exempted from inlining by marking them
6466 with the @code{noinline} attribute.
6468 @item -finline-small-functions
6469 @opindex finline-small-functions
6470 Integrate functions into their callers when their body is smaller than expected
6471 function call code (so overall size of program gets smaller).  The compiler
6472 heuristically decides which functions are simple enough to be worth integrating
6473 in this way.  This inlining applies to all functions, even those not declared
6474 inline.
6476 Enabled at level @option{-O2}.
6478 @item -findirect-inlining
6479 @opindex findirect-inlining
6480 Inline also indirect calls that are discovered to be known at compile
6481 time thanks to previous inlining.  This option has any effect only
6482 when inlining itself is turned on by the @option{-finline-functions}
6483 or @option{-finline-small-functions} options.
6485 Enabled at level @option{-O2}.
6487 @item -finline-functions
6488 @opindex finline-functions
6489 Consider all functions for inlining, even if they are not declared inline.
6490 The compiler heuristically decides which functions are worth integrating
6491 in this way.
6493 If all calls to a given function are integrated, and the function is
6494 declared @code{static}, then the function is normally not output as
6495 assembler code in its own right.
6497 Enabled at level @option{-O3}.
6499 @item -finline-functions-called-once
6500 @opindex finline-functions-called-once
6501 Consider all @code{static} functions called once for inlining into their
6502 caller even if they are not marked @code{inline}.  If a call to a given
6503 function is integrated, then the function is not output as assembler code
6504 in its own right.
6506 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6508 @item -fearly-inlining
6509 @opindex fearly-inlining
6510 Inline functions marked by @code{always_inline} and functions whose body seems
6511 smaller than the function call overhead early before doing
6512 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6513 makes profiling significantly cheaper and usually inlining faster on programs
6514 having large chains of nested wrapper functions.
6516 Enabled by default.
6518 @item -fipa-sra
6519 @opindex fipa-sra
6520 Perform interprocedural scalar replacement of aggregates, removal of
6521 unused parameters and replacement of parameters passed by reference
6522 by parameters passed by value.
6524 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6526 @item -finline-limit=@var{n}
6527 @opindex finline-limit
6528 By default, GCC limits the size of functions that can be inlined.  This flag
6529 allows coarse control of this limit.  @var{n} is the size of functions that
6530 can be inlined in number of pseudo instructions.
6532 Inlining is actually controlled by a number of parameters, which may be
6533 specified individually by using @option{--param @var{name}=@var{value}}.
6534 The @option{-finline-limit=@var{n}} option sets some of these parameters
6535 as follows:
6537 @table @gcctabopt
6538 @item max-inline-insns-single
6539 is set to @var{n}/2.
6540 @item max-inline-insns-auto
6541 is set to @var{n}/2.
6542 @end table
6544 See below for a documentation of the individual
6545 parameters controlling inlining and for the defaults of these parameters.
6547 @emph{Note:} there may be no value to @option{-finline-limit} that results
6548 in default behavior.
6550 @emph{Note:} pseudo instruction represents, in this particular context, an
6551 abstract measurement of function's size.  In no way does it represent a count
6552 of assembly instructions and as such its exact meaning might change from one
6553 release to an another.
6555 @item -fno-keep-inline-dllexport
6556 @opindex fno-keep-inline-dllexport
6557 This is a more fine-grained version of @option{-fkeep-inline-functions},
6558 which applies only to functions that are declared using the @code{dllexport}
6559 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6560 Functions}.)
6562 @item -fkeep-inline-functions
6563 @opindex fkeep-inline-functions
6564 In C, emit @code{static} functions that are declared @code{inline}
6565 into the object file, even if the function has been inlined into all
6566 of its callers.  This switch does not affect functions using the
6567 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6568 inline functions into the object file.
6570 @item -fkeep-static-functions
6571 @opindex fkeep-static-functions
6572 Emit @code{static} functions into the object file, even if the function
6573 is never used.
6575 @item -fkeep-static-consts
6576 @opindex fkeep-static-consts
6577 Emit variables declared @code{static const} when optimization isn't turned
6578 on, even if the variables aren't referenced.
6580 GCC enables this option by default.  If you want to force the compiler to
6581 check if a variable is referenced, regardless of whether or not
6582 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6584 @item -fmerge-constants
6585 @opindex fmerge-constants
6586 Attempt to merge identical constants (string constants and floating-point
6587 constants) across compilation units.
6589 This option is the default for optimized compilation if the assembler and
6590 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6591 behavior.
6593 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6595 @item -fmerge-all-constants
6596 @opindex fmerge-all-constants
6597 Attempt to merge identical constants and identical variables.
6599 This option implies @option{-fmerge-constants}.  In addition to
6600 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6601 arrays or initialized constant variables with integral or floating-point
6602 types.  Languages like C or C++ require each variable, including multiple
6603 instances of the same variable in recursive calls, to have distinct locations,
6604 so using this option results in non-conforming
6605 behavior.
6607 @item -fmodulo-sched
6608 @opindex fmodulo-sched
6609 Perform swing modulo scheduling immediately before the first scheduling
6610 pass.  This pass looks at innermost loops and reorders their
6611 instructions by overlapping different iterations.
6613 @item -fmodulo-sched-allow-regmoves
6614 @opindex fmodulo-sched-allow-regmoves
6615 Perform more aggressive SMS-based modulo scheduling with register moves
6616 allowed.  By setting this flag certain anti-dependences edges are
6617 deleted, which triggers the generation of reg-moves based on the
6618 life-range analysis.  This option is effective only with
6619 @option{-fmodulo-sched} enabled.
6621 @item -fno-branch-count-reg
6622 @opindex fno-branch-count-reg
6623 Avoid running a pass scanning for opportunities to use ``decrement and
6624 branch'' instructions on a count register instead of generating sequences
6625 of instructions that decrement a register, compare it against zero, and
6626 then branch based upon the result.  This option is only meaningful on
6627 architectures that support such instructions, which include x86, PowerPC,
6628 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
6629 doesn't remove the decrement and branch instructions from the generated
6630 instruction stream introduced by other optimization passes.
6632 Enabled by default at @option{-O1} and higher.
6634 The default is @option{-fbranch-count-reg}.
6636 @item -fno-function-cse
6637 @opindex fno-function-cse
6638 Do not put function addresses in registers; make each instruction that
6639 calls a constant function contain the function's address explicitly.
6641 This option results in less efficient code, but some strange hacks
6642 that alter the assembler output may be confused by the optimizations
6643 performed when this option is not used.
6645 The default is @option{-ffunction-cse}
6647 @item -fno-zero-initialized-in-bss
6648 @opindex fno-zero-initialized-in-bss
6649 If the target supports a BSS section, GCC by default puts variables that
6650 are initialized to zero into BSS@.  This can save space in the resulting
6651 code.
6653 This option turns off this behavior because some programs explicitly
6654 rely on variables going to the data section---e.g., so that the
6655 resulting executable can find the beginning of that section and/or make
6656 assumptions based on that.
6658 The default is @option{-fzero-initialized-in-bss}.
6660 @item -fthread-jumps
6661 @opindex fthread-jumps
6662 Perform optimizations that check to see if a jump branches to a
6663 location where another comparison subsumed by the first is found.  If
6664 so, the first branch is redirected to either the destination of the
6665 second branch or a point immediately following it, depending on whether
6666 the condition is known to be true or false.
6668 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6670 @item -fsplit-wide-types
6671 @opindex fsplit-wide-types
6672 When using a type that occupies multiple registers, such as @code{long
6673 long} on a 32-bit system, split the registers apart and allocate them
6674 independently.  This normally generates better code for those types,
6675 but may make debugging more difficult.
6677 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6678 @option{-Os}.
6680 @item -fcse-follow-jumps
6681 @opindex fcse-follow-jumps
6682 In common subexpression elimination (CSE), scan through jump instructions
6683 when the target of the jump is not reached by any other path.  For
6684 example, when CSE encounters an @code{if} statement with an
6685 @code{else} clause, CSE follows the jump when the condition
6686 tested is false.
6688 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6690 @item -fcse-skip-blocks
6691 @opindex fcse-skip-blocks
6692 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6693 follow jumps that conditionally skip over blocks.  When CSE
6694 encounters a simple @code{if} statement with no else clause,
6695 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6696 body of the @code{if}.
6698 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6700 @item -frerun-cse-after-loop
6701 @opindex frerun-cse-after-loop
6702 Re-run common subexpression elimination after loop optimizations are
6703 performed.
6705 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6707 @item -fgcse
6708 @opindex fgcse
6709 Perform a global common subexpression elimination pass.
6710 This pass also performs global constant and copy propagation.
6712 @emph{Note:} When compiling a program using computed gotos, a GCC
6713 extension, you may get better run-time performance if you disable
6714 the global common subexpression elimination pass by adding
6715 @option{-fno-gcse} to the command line.
6717 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6719 @item -fgcse-lm
6720 @opindex fgcse-lm
6721 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6722 attempts to move loads that are only killed by stores into themselves.  This
6723 allows a loop containing a load/store sequence to be changed to a load outside
6724 the loop, and a copy/store within the loop.
6726 Enabled by default when @option{-fgcse} is enabled.
6728 @item -fgcse-sm
6729 @opindex fgcse-sm
6730 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6731 global common subexpression elimination.  This pass attempts to move
6732 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6733 loops containing a load/store sequence can be changed to a load before
6734 the loop and a store after the loop.
6736 Not enabled at any optimization level.
6738 @item -fgcse-las
6739 @opindex fgcse-las
6740 When @option{-fgcse-las} is enabled, the global common subexpression
6741 elimination pass eliminates redundant loads that come after stores to the
6742 same memory location (both partial and full redundancies).
6744 Not enabled at any optimization level.
6746 @item -fgcse-after-reload
6747 @opindex fgcse-after-reload
6748 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6749 pass is performed after reload.  The purpose of this pass is to clean up
6750 redundant spilling.
6752 @item -faggressive-loop-optimizations
6753 @opindex faggressive-loop-optimizations
6754 This option tells the loop optimizer to use language constraints to
6755 derive bounds for the number of iterations of a loop.  This assumes that
6756 loop code does not invoke undefined behavior by for example causing signed
6757 integer overflows or out-of-bound array accesses.  The bounds for the
6758 number of iterations of a loop are used to guide loop unrolling and peeling
6759 and loop exit test optimizations.
6760 This option is enabled by default.
6762 @item -funsafe-loop-optimizations
6763 @opindex funsafe-loop-optimizations
6764 This option tells the loop optimizer to assume that loop indices do not
6765 overflow, and that loops with nontrivial exit condition are not
6766 infinite.  This enables a wider range of loop optimizations even if
6767 the loop optimizer itself cannot prove that these assumptions are valid.
6768 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
6769 if it finds this kind of loop.
6771 @item -funconstrained-commons
6772 @opindex funconstrained-commons
6773 This option tells the compiler that variables declared in common blocks
6774 (e.g. Fortran) may later be overridden with longer trailing arrays. This
6775 prevents certain optimizations that depend on knowing the array bounds.
6777 @item -fcrossjumping
6778 @opindex fcrossjumping
6779 Perform cross-jumping transformation.
6780 This transformation unifies equivalent code and saves code size.  The
6781 resulting code may or may not perform better than without cross-jumping.
6783 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6785 @item -fauto-inc-dec
6786 @opindex fauto-inc-dec
6787 Combine increments or decrements of addresses with memory accesses.
6788 This pass is always skipped on architectures that do not have
6789 instructions to support this.  Enabled by default at @option{-O} and
6790 higher on architectures that support this.
6792 @item -fdce
6793 @opindex fdce
6794 Perform dead code elimination (DCE) on RTL@.
6795 Enabled by default at @option{-O} and higher.
6797 @item -fdse
6798 @opindex fdse
6799 Perform dead store elimination (DSE) on RTL@.
6800 Enabled by default at @option{-O} and higher.
6802 @item -fif-conversion
6803 @opindex fif-conversion
6804 Attempt to transform conditional jumps into branch-less equivalents.  This
6805 includes use of conditional moves, min, max, set flags and abs instructions, and
6806 some tricks doable by standard arithmetics.  The use of conditional execution
6807 on chips where it is available is controlled by @option{-fif-conversion2}.
6809 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6811 @item -fif-conversion2
6812 @opindex fif-conversion2
6813 Use conditional execution (where available) to transform conditional jumps into
6814 branch-less equivalents.
6816 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6818 @item -fdeclone-ctor-dtor
6819 @opindex fdeclone-ctor-dtor
6820 The C++ ABI requires multiple entry points for constructors and
6821 destructors: one for a base subobject, one for a complete object, and
6822 one for a virtual destructor that calls operator delete afterwards.
6823 For a hierarchy with virtual bases, the base and complete variants are
6824 clones, which means two copies of the function.  With this option, the
6825 base and complete variants are changed to be thunks that call a common
6826 implementation.
6828 Enabled by @option{-Os}.
6830 @item -fdelete-null-pointer-checks
6831 @opindex fdelete-null-pointer-checks
6832 Assume that programs cannot safely dereference null pointers, and that
6833 no code or data element resides at address zero.
6834 This option enables simple constant
6835 folding optimizations at all optimization levels.  In addition, other
6836 optimization passes in GCC use this flag to control global dataflow
6837 analyses that eliminate useless checks for null pointers; these assume
6838 that a memory access to address zero always results in a trap, so
6839 that if a pointer is checked after it has already been dereferenced,
6840 it cannot be null.
6842 Note however that in some environments this assumption is not true.
6843 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6844 for programs that depend on that behavior.
6846 This option is enabled by default on most targets.  On Nios II ELF, it
6847 defaults to off.  On AVR and CR16, this option is completely disabled.  
6849 Passes that use the dataflow information
6850 are enabled independently at different optimization levels.
6852 @item -fdevirtualize
6853 @opindex fdevirtualize
6854 Attempt to convert calls to virtual functions to direct calls.  This
6855 is done both within a procedure and interprocedurally as part of
6856 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
6857 propagation (@option{-fipa-cp}).
6858 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6860 @item -fdevirtualize-speculatively
6861 @opindex fdevirtualize-speculatively
6862 Attempt to convert calls to virtual functions to speculative direct calls.
6863 Based on the analysis of the type inheritance graph, determine for a given call
6864 the set of likely targets. If the set is small, preferably of size 1, change
6865 the call into a conditional deciding between direct and indirect calls.  The
6866 speculative calls enable more optimizations, such as inlining.  When they seem
6867 useless after further optimization, they are converted back into original form.
6869 @item -fdevirtualize-at-ltrans
6870 @opindex fdevirtualize-at-ltrans
6871 Stream extra information needed for aggressive devirtualization when running
6872 the link-time optimizer in local transformation mode.  
6873 This option enables more devirtualization but
6874 significantly increases the size of streamed data. For this reason it is
6875 disabled by default.
6877 @item -fexpensive-optimizations
6878 @opindex fexpensive-optimizations
6879 Perform a number of minor optimizations that are relatively expensive.
6881 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6883 @item -free
6884 @opindex free
6885 Attempt to remove redundant extension instructions.  This is especially
6886 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
6887 registers after writing to their lower 32-bit half.
6889 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
6890 @option{-O3}, @option{-Os}.
6892 @item -fno-lifetime-dse
6893 @opindex fno-lifetime-dse
6894 In C++ the value of an object is only affected by changes within its
6895 lifetime: when the constructor begins, the object has an indeterminate
6896 value, and any changes during the lifetime of the object are dead when
6897 the object is destroyed.  Normally dead store elimination will take
6898 advantage of this; if your code relies on the value of the object
6899 storage persisting beyond the lifetime of the object, you can use this
6900 flag to disable this optimization.  To preserve stores before the
6901 constructor starts (e.g. because your operator new clears the object
6902 storage) but still treat the object as dead after the destructor you,
6903 can use @option{-flifetime-dse=1}.  The default behavior can be
6904 explicitly selected with @option{-flifetime-dse=2}.
6905 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
6907 @item -flive-range-shrinkage
6908 @opindex flive-range-shrinkage
6909 Attempt to decrease register pressure through register live range
6910 shrinkage.  This is helpful for fast processors with small or moderate
6911 size register sets.
6913 @item -fira-algorithm=@var{algorithm}
6914 @opindex fira-algorithm
6915 Use the specified coloring algorithm for the integrated register
6916 allocator.  The @var{algorithm} argument can be @samp{priority}, which
6917 specifies Chow's priority coloring, or @samp{CB}, which specifies
6918 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
6919 for all architectures, but for those targets that do support it, it is
6920 the default because it generates better code.
6922 @item -fira-region=@var{region}
6923 @opindex fira-region
6924 Use specified regions for the integrated register allocator.  The
6925 @var{region} argument should be one of the following:
6927 @table @samp
6929 @item all
6930 Use all loops as register allocation regions.
6931 This can give the best results for machines with a small and/or
6932 irregular register set.
6934 @item mixed
6935 Use all loops except for loops with small register pressure 
6936 as the regions.  This value usually gives
6937 the best results in most cases and for most architectures,
6938 and is enabled by default when compiling with optimization for speed
6939 (@option{-O}, @option{-O2}, @dots{}).
6941 @item one
6942 Use all functions as a single region.  
6943 This typically results in the smallest code size, and is enabled by default for
6944 @option{-Os} or @option{-O0}.
6946 @end table
6948 @item -fira-hoist-pressure
6949 @opindex fira-hoist-pressure
6950 Use IRA to evaluate register pressure in the code hoisting pass for
6951 decisions to hoist expressions.  This option usually results in smaller
6952 code, but it can slow the compiler down.
6954 This option is enabled at level @option{-Os} for all targets.
6956 @item -fira-loop-pressure
6957 @opindex fira-loop-pressure
6958 Use IRA to evaluate register pressure in loops for decisions to move
6959 loop invariants.  This option usually results in generation
6960 of faster and smaller code on machines with large register files (>= 32
6961 registers), but it can slow the compiler down.
6963 This option is enabled at level @option{-O3} for some targets.
6965 @item -fno-ira-share-save-slots
6966 @opindex fno-ira-share-save-slots
6967 Disable sharing of stack slots used for saving call-used hard
6968 registers living through a call.  Each hard register gets a
6969 separate stack slot, and as a result function stack frames are
6970 larger.
6972 @item -fno-ira-share-spill-slots
6973 @opindex fno-ira-share-spill-slots
6974 Disable sharing of stack slots allocated for pseudo-registers.  Each
6975 pseudo-register that does not get a hard register gets a separate
6976 stack slot, and as a result function stack frames are larger.
6978 @item -flra-remat
6979 @opindex flra-remat
6980 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
6981 values of spilled pseudos, LRA tries to rematerialize (recalculate)
6982 values if it is profitable.
6984 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6986 @item -fdelayed-branch
6987 @opindex fdelayed-branch
6988 If supported for the target machine, attempt to reorder instructions
6989 to exploit instruction slots available after delayed branch
6990 instructions.
6992 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6994 @item -fschedule-insns
6995 @opindex fschedule-insns
6996 If supported for the target machine, attempt to reorder instructions to
6997 eliminate execution stalls due to required data being unavailable.  This
6998 helps machines that have slow floating point or memory load instructions
6999 by allowing other instructions to be issued until the result of the load
7000 or floating-point instruction is required.
7002 Enabled at levels @option{-O2}, @option{-O3}.
7004 @item -fschedule-insns2
7005 @opindex fschedule-insns2
7006 Similar to @option{-fschedule-insns}, but requests an additional pass of
7007 instruction scheduling after register allocation has been done.  This is
7008 especially useful on machines with a relatively small number of
7009 registers and where memory load instructions take more than one cycle.
7011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7013 @item -fno-sched-interblock
7014 @opindex fno-sched-interblock
7015 Don't schedule instructions across basic blocks.  This is normally
7016 enabled by default when scheduling before register allocation, i.e.@:
7017 with @option{-fschedule-insns} or at @option{-O2} or higher.
7019 @item -fno-sched-spec
7020 @opindex fno-sched-spec
7021 Don't allow speculative motion of non-load instructions.  This is normally
7022 enabled by default when scheduling before register allocation, i.e.@:
7023 with @option{-fschedule-insns} or at @option{-O2} or higher.
7025 @item -fsched-pressure
7026 @opindex fsched-pressure
7027 Enable register pressure sensitive insn scheduling before register
7028 allocation.  This only makes sense when scheduling before register
7029 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7030 @option{-O2} or higher.  Usage of this option can improve the
7031 generated code and decrease its size by preventing register pressure
7032 increase above the number of available hard registers and subsequent
7033 spills in register allocation.
7035 @item -fsched-spec-load
7036 @opindex fsched-spec-load
7037 Allow speculative motion of some load instructions.  This only makes
7038 sense when scheduling before register allocation, i.e.@: with
7039 @option{-fschedule-insns} or at @option{-O2} or higher.
7041 @item -fsched-spec-load-dangerous
7042 @opindex fsched-spec-load-dangerous
7043 Allow speculative motion of more load instructions.  This only makes
7044 sense when scheduling before register allocation, i.e.@: with
7045 @option{-fschedule-insns} or at @option{-O2} or higher.
7047 @item -fsched-stalled-insns
7048 @itemx -fsched-stalled-insns=@var{n}
7049 @opindex fsched-stalled-insns
7050 Define how many insns (if any) can be moved prematurely from the queue
7051 of stalled insns into the ready list during the second scheduling pass.
7052 @option{-fno-sched-stalled-insns} means that no insns are moved
7053 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7054 on how many queued insns can be moved prematurely.
7055 @option{-fsched-stalled-insns} without a value is equivalent to
7056 @option{-fsched-stalled-insns=1}.
7058 @item -fsched-stalled-insns-dep
7059 @itemx -fsched-stalled-insns-dep=@var{n}
7060 @opindex fsched-stalled-insns-dep
7061 Define how many insn groups (cycles) are examined for a dependency
7062 on a stalled insn that is a candidate for premature removal from the queue
7063 of stalled insns.  This has an effect only during the second scheduling pass,
7064 and only if @option{-fsched-stalled-insns} is used.
7065 @option{-fno-sched-stalled-insns-dep} is equivalent to
7066 @option{-fsched-stalled-insns-dep=0}.
7067 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7068 @option{-fsched-stalled-insns-dep=1}.
7070 @item -fsched2-use-superblocks
7071 @opindex fsched2-use-superblocks
7072 When scheduling after register allocation, use superblock scheduling.
7073 This allows motion across basic block boundaries,
7074 resulting in faster schedules.  This option is experimental, as not all machine
7075 descriptions used by GCC model the CPU closely enough to avoid unreliable
7076 results from the algorithm.
7078 This only makes sense when scheduling after register allocation, i.e.@: with
7079 @option{-fschedule-insns2} or at @option{-O2} or higher.
7081 @item -fsched-group-heuristic
7082 @opindex fsched-group-heuristic
7083 Enable the group heuristic in the scheduler.  This heuristic favors
7084 the instruction that belongs to a schedule group.  This is enabled
7085 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7086 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7088 @item -fsched-critical-path-heuristic
7089 @opindex fsched-critical-path-heuristic
7090 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7091 instructions on the critical path.  This is enabled by default when
7092 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7093 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7095 @item -fsched-spec-insn-heuristic
7096 @opindex fsched-spec-insn-heuristic
7097 Enable the speculative instruction heuristic in the scheduler.  This
7098 heuristic favors speculative instructions with greater dependency weakness.
7099 This is enabled by default when scheduling is enabled, i.e.@:
7100 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7101 or at @option{-O2} or higher.
7103 @item -fsched-rank-heuristic
7104 @opindex fsched-rank-heuristic
7105 Enable the rank heuristic in the scheduler.  This heuristic favors
7106 the instruction belonging to a basic block with greater size or frequency.
7107 This is enabled by default when scheduling is enabled, i.e.@:
7108 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7109 at @option{-O2} or higher.
7111 @item -fsched-last-insn-heuristic
7112 @opindex fsched-last-insn-heuristic
7113 Enable the last-instruction heuristic in the scheduler.  This heuristic
7114 favors the instruction that is less dependent on the last instruction
7115 scheduled.  This is enabled by default when scheduling is enabled,
7116 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7117 at @option{-O2} or higher.
7119 @item -fsched-dep-count-heuristic
7120 @opindex fsched-dep-count-heuristic
7121 Enable the dependent-count heuristic in the scheduler.  This heuristic
7122 favors the instruction that has more instructions depending on it.
7123 This is enabled by default when scheduling is enabled, i.e.@:
7124 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7125 at @option{-O2} or higher.
7127 @item -freschedule-modulo-scheduled-loops
7128 @opindex freschedule-modulo-scheduled-loops
7129 Modulo scheduling is performed before traditional scheduling.  If a loop
7130 is modulo scheduled, later scheduling passes may change its schedule.  
7131 Use this option to control that behavior.
7133 @item -fselective-scheduling
7134 @opindex fselective-scheduling
7135 Schedule instructions using selective scheduling algorithm.  Selective
7136 scheduling runs instead of the first scheduler pass.
7138 @item -fselective-scheduling2
7139 @opindex fselective-scheduling2
7140 Schedule instructions using selective scheduling algorithm.  Selective
7141 scheduling runs instead of the second scheduler pass.
7143 @item -fsel-sched-pipelining
7144 @opindex fsel-sched-pipelining
7145 Enable software pipelining of innermost loops during selective scheduling.
7146 This option has no effect unless one of @option{-fselective-scheduling} or
7147 @option{-fselective-scheduling2} is turned on.
7149 @item -fsel-sched-pipelining-outer-loops
7150 @opindex fsel-sched-pipelining-outer-loops
7151 When pipelining loops during selective scheduling, also pipeline outer loops.
7152 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7154 @item -fsemantic-interposition
7155 @opindex fsemantic-interposition
7156 Some object formats, like ELF, allow interposing of symbols by the 
7157 dynamic linker.
7158 This means that for symbols exported from the DSO, the compiler cannot perform
7159 interprocedural propagation, inlining and other optimizations in anticipation
7160 that the function or variable in question may change. While this feature is
7161 useful, for example, to rewrite memory allocation functions by a debugging
7162 implementation, it is expensive in the terms of code quality.
7163 With @option{-fno-semantic-interposition} the compiler assumes that 
7164 if interposition happens for functions the overwriting function will have 
7165 precisely the same semantics (and side effects). 
7166 Similarly if interposition happens
7167 for variables, the constructor of the variable will be the same. The flag
7168 has no effect for functions explicitly declared inline 
7169 (where it is never allowed for interposition to change semantics) 
7170 and for symbols explicitly declared weak.
7172 @item -fshrink-wrap
7173 @opindex fshrink-wrap
7174 Emit function prologues only before parts of the function that need it,
7175 rather than at the top of the function.  This flag is enabled by default at
7176 @option{-O} and higher.
7178 @item -fcaller-saves
7179 @opindex fcaller-saves
7180 Enable allocation of values to registers that are clobbered by
7181 function calls, by emitting extra instructions to save and restore the
7182 registers around such calls.  Such allocation is done only when it
7183 seems to result in better code.
7185 This option is always enabled by default on certain machines, usually
7186 those which have no call-preserved registers to use instead.
7188 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7190 @item -fcombine-stack-adjustments
7191 @opindex fcombine-stack-adjustments
7192 Tracks stack adjustments (pushes and pops) and stack memory references
7193 and then tries to find ways to combine them.
7195 Enabled by default at @option{-O1} and higher.
7197 @item -fipa-ra
7198 @opindex fipa-ra
7199 Use caller save registers for allocation if those registers are not used by
7200 any called function.  In that case it is not necessary to save and restore
7201 them around calls.  This is only possible if called functions are part of
7202 same compilation unit as current function and they are compiled before it.
7204 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7206 @item -fconserve-stack
7207 @opindex fconserve-stack
7208 Attempt to minimize stack usage.  The compiler attempts to use less
7209 stack space, even if that makes the program slower.  This option
7210 implies setting the @option{large-stack-frame} parameter to 100
7211 and the @option{large-stack-frame-growth} parameter to 400.
7213 @item -ftree-reassoc
7214 @opindex ftree-reassoc
7215 Perform reassociation on trees.  This flag is enabled by default
7216 at @option{-O} and higher.
7218 @item -ftree-pre
7219 @opindex ftree-pre
7220 Perform partial redundancy elimination (PRE) on trees.  This flag is
7221 enabled by default at @option{-O2} and @option{-O3}.
7223 @item -ftree-partial-pre
7224 @opindex ftree-partial-pre
7225 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7226 enabled by default at @option{-O3}.
7228 @item -ftree-forwprop
7229 @opindex ftree-forwprop
7230 Perform forward propagation on trees.  This flag is enabled by default
7231 at @option{-O} and higher.
7233 @item -ftree-fre
7234 @opindex ftree-fre
7235 Perform full redundancy elimination (FRE) on trees.  The difference
7236 between FRE and PRE is that FRE only considers expressions
7237 that are computed on all paths leading to the redundant computation.
7238 This analysis is faster than PRE, though it exposes fewer redundancies.
7239 This flag is enabled by default at @option{-O} and higher.
7241 @item -ftree-phiprop
7242 @opindex ftree-phiprop
7243 Perform hoisting of loads from conditional pointers on trees.  This
7244 pass is enabled by default at @option{-O} and higher.
7246 @item -fhoist-adjacent-loads
7247 @opindex fhoist-adjacent-loads
7248 Speculatively hoist loads from both branches of an if-then-else if the
7249 loads are from adjacent locations in the same structure and the target
7250 architecture has a conditional move instruction.  This flag is enabled
7251 by default at @option{-O2} and higher.
7253 @item -ftree-copy-prop
7254 @opindex ftree-copy-prop
7255 Perform copy propagation on trees.  This pass eliminates unnecessary
7256 copy operations.  This flag is enabled by default at @option{-O} and
7257 higher.
7259 @item -fipa-pure-const
7260 @opindex fipa-pure-const
7261 Discover which functions are pure or constant.
7262 Enabled by default at @option{-O} and higher.
7264 @item -fipa-reference
7265 @opindex fipa-reference
7266 Discover which static variables do not escape the
7267 compilation unit.
7268 Enabled by default at @option{-O} and higher.
7270 @item -fipa-pta
7271 @opindex fipa-pta
7272 Perform interprocedural pointer analysis and interprocedural modification
7273 and reference analysis.  This option can cause excessive memory and
7274 compile-time usage on large compilation units.  It is not enabled by
7275 default at any optimization level.
7277 @item -fipa-profile
7278 @opindex fipa-profile
7279 Perform interprocedural profile propagation.  The functions called only from
7280 cold functions are marked as cold. Also functions executed once (such as
7281 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7282 functions and loop less parts of functions executed once are then optimized for
7283 size.
7284 Enabled by default at @option{-O} and higher.
7286 @item -fipa-cp
7287 @opindex fipa-cp
7288 Perform interprocedural constant propagation.
7289 This optimization analyzes the program to determine when values passed
7290 to functions are constants and then optimizes accordingly.
7291 This optimization can substantially increase performance
7292 if the application has constants passed to functions.
7293 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7295 @item -fipa-cp-clone
7296 @opindex fipa-cp-clone
7297 Perform function cloning to make interprocedural constant propagation stronger.
7298 When enabled, interprocedural constant propagation performs function cloning
7299 when externally visible function can be called with constant arguments.
7300 Because this optimization can create multiple copies of functions,
7301 it may significantly increase code size
7302 (see @option{--param ipcp-unit-growth=@var{value}}).
7303 This flag is enabled by default at @option{-O3}.
7305 @item -fipa-cp-alignment
7306 @opindex -fipa-cp-alignment
7307 When enabled, this optimization propagates alignment of function
7308 parameters to support better vectorization and string operations.
7310 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
7311 requires that @option{-fipa-cp} is enabled.
7313 @item -fipa-icf
7314 @opindex fipa-icf
7315 Perform Identical Code Folding for functions and read-only variables.
7316 The optimization reduces code size and may disturb unwind stacks by replacing
7317 a function by equivalent one with a different name. The optimization works
7318 more effectively with link time optimization enabled.
7320 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
7321 works on different levels and thus the optimizations are not same - there are
7322 equivalences that are found only by GCC and equivalences found only by Gold.
7324 This flag is enabled by default at @option{-O2} and @option{-Os}.
7326 @item -fisolate-erroneous-paths-dereference
7327 @opindex fisolate-erroneous-paths-dereference
7328 Detect paths that trigger erroneous or undefined behavior due to
7329 dereferencing a null pointer.  Isolate those paths from the main control
7330 flow and turn the statement with erroneous or undefined behavior into a trap.
7331 This flag is enabled by default at @option{-O2} and higher and depends on
7332 @option{-fdelete-null-pointer-checks} also being enabled.
7334 @item -fisolate-erroneous-paths-attribute
7335 @opindex fisolate-erroneous-paths-attribute
7336 Detect paths that trigger erroneous or undefined behavior due a null value
7337 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
7338 attribute.  Isolate those paths from the main control flow and turn the
7339 statement with erroneous or undefined behavior into a trap.  This is not
7340 currently enabled, but may be enabled by @option{-O2} in the future.
7342 @item -ftree-sink
7343 @opindex ftree-sink
7344 Perform forward store motion on trees.  This flag is
7345 enabled by default at @option{-O} and higher.
7347 @item -ftree-bit-ccp
7348 @opindex ftree-bit-ccp
7349 Perform sparse conditional bit constant propagation on trees and propagate
7350 pointer alignment information.
7351 This pass only operates on local scalar variables and is enabled by default
7352 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7354 @item -ftree-ccp
7355 @opindex ftree-ccp
7356 Perform sparse conditional constant propagation (CCP) on trees.  This
7357 pass only operates on local scalar variables and is enabled by default
7358 at @option{-O} and higher.
7360 @item -fssa-backprop
7361 @opindex fssa-backprop
7362 Propagate information about uses of a value up the definition chain
7363 in order to simplify the definitions.  For example, this pass strips
7364 sign operations if the sign of a value never matters.  The flag is
7365 enabled by default at @option{-O} and higher.
7367 @item -fssa-phiopt
7368 @opindex fssa-phiopt
7369 Perform pattern matching on SSA PHI nodes to optimize conditional
7370 code.  This pass is enabled by default at @option{-O} and higher.
7372 @item -ftree-switch-conversion
7373 @opindex ftree-switch-conversion
7374 Perform conversion of simple initializations in a switch to
7375 initializations from a scalar array.  This flag is enabled by default
7376 at @option{-O2} and higher.
7378 @item -ftree-tail-merge
7379 @opindex ftree-tail-merge
7380 Look for identical code sequences.  When found, replace one with a jump to the
7381 other.  This optimization is known as tail merging or cross jumping.  This flag
7382 is enabled by default at @option{-O2} and higher.  The compilation time
7383 in this pass can
7384 be limited using @option{max-tail-merge-comparisons} parameter and
7385 @option{max-tail-merge-iterations} parameter.
7387 @item -ftree-dce
7388 @opindex ftree-dce
7389 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7390 default at @option{-O} and higher.
7392 @item -ftree-builtin-call-dce
7393 @opindex ftree-builtin-call-dce
7394 Perform conditional dead code elimination (DCE) for calls to built-in functions
7395 that may set @code{errno} but are otherwise side-effect free.  This flag is
7396 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7397 specified.
7399 @item -ftree-dominator-opts
7400 @opindex ftree-dominator-opts
7401 Perform a variety of simple scalar cleanups (constant/copy
7402 propagation, redundancy elimination, range propagation and expression
7403 simplification) based on a dominator tree traversal.  This also
7404 performs jump threading (to reduce jumps to jumps). This flag is
7405 enabled by default at @option{-O} and higher.
7407 @item -ftree-dse
7408 @opindex ftree-dse
7409 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7410 a memory location that is later overwritten by another store without
7411 any intervening loads.  In this case the earlier store can be deleted.  This
7412 flag is enabled by default at @option{-O} and higher.
7414 @item -ftree-ch
7415 @opindex ftree-ch
7416 Perform loop header copying on trees.  This is beneficial since it increases
7417 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7418 is enabled by default at @option{-O} and higher.  It is not enabled
7419 for @option{-Os}, since it usually increases code size.
7421 @item -ftree-loop-optimize
7422 @opindex ftree-loop-optimize
7423 Perform loop optimizations on trees.  This flag is enabled by default
7424 at @option{-O} and higher.
7426 @item -ftree-loop-linear
7427 @itemx -floop-interchange
7428 @itemx -floop-strip-mine
7429 @itemx -floop-block
7430 @itemx -floop-unroll-and-jam
7431 @opindex ftree-loop-linear
7432 @opindex floop-interchange
7433 @opindex floop-strip-mine
7434 @opindex floop-block
7435 @opindex floop-unroll-and-jam
7436 Perform loop nest optimizations.  Same as
7437 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
7438 to be configured with @option{--with-isl} to enable the Graphite loop
7439 transformation infrastructure.
7441 @item -fgraphite-identity
7442 @opindex fgraphite-identity
7443 Enable the identity transformation for graphite.  For every SCoP we generate
7444 the polyhedral representation and transform it back to gimple.  Using
7445 @option{-fgraphite-identity} we can check the costs or benefits of the
7446 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7447 are also performed by the code generator isl, like index splitting and
7448 dead code elimination in loops.
7450 @item -floop-nest-optimize
7451 @opindex floop-nest-optimize
7452 Enable the isl based loop nest optimizer.  This is a generic loop nest
7453 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7454 structure optimized for data-locality and parallelism.  This option
7455 is experimental.
7457 @item -floop-parallelize-all
7458 @opindex floop-parallelize-all
7459 Use the Graphite data dependence analysis to identify loops that can
7460 be parallelized.  Parallelize all the loops that can be analyzed to
7461 not contain loop carried dependences without checking that it is
7462 profitable to parallelize the loops.
7464 @item -ftree-coalesce-vars
7465 @opindex ftree-coalesce-vars
7466 While transforming the program out of the SSA representation, attempt to
7467 reduce copying by coalescing versions of different user-defined
7468 variables, instead of just compiler temporaries.  This may severely
7469 limit the ability to debug an optimized program compiled with
7470 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
7471 prevents SSA coalescing of user variables.  This option is enabled by
7472 default if optimization is enabled, and it does very little otherwise.
7474 @item -ftree-loop-if-convert
7475 @opindex ftree-loop-if-convert
7476 Attempt to transform conditional jumps in the innermost loops to
7477 branch-less equivalents.  The intent is to remove control-flow from
7478 the innermost loops in order to improve the ability of the
7479 vectorization pass to handle these loops.  This is enabled by default
7480 if vectorization is enabled.
7482 @item -ftree-loop-if-convert-stores
7483 @opindex ftree-loop-if-convert-stores
7484 Attempt to also if-convert conditional jumps containing memory writes.
7485 This transformation can be unsafe for multi-threaded programs as it
7486 transforms conditional memory writes into unconditional memory writes.
7487 For example,
7488 @smallexample
7489 for (i = 0; i < N; i++)
7490   if (cond)
7491     A[i] = expr;
7492 @end smallexample
7493 is transformed to
7494 @smallexample
7495 for (i = 0; i < N; i++)
7496   A[i] = cond ? expr : A[i];
7497 @end smallexample
7498 potentially producing data races.
7500 @item -ftree-loop-distribution
7501 @opindex ftree-loop-distribution
7502 Perform loop distribution.  This flag can improve cache performance on
7503 big loop bodies and allow further loop optimizations, like
7504 parallelization or vectorization, to take place.  For example, the loop
7505 @smallexample
7506 DO I = 1, N
7507   A(I) = B(I) + C
7508   D(I) = E(I) * F
7509 ENDDO
7510 @end smallexample
7511 is transformed to
7512 @smallexample
7513 DO I = 1, N
7514    A(I) = B(I) + C
7515 ENDDO
7516 DO I = 1, N
7517    D(I) = E(I) * F
7518 ENDDO
7519 @end smallexample
7521 @item -ftree-loop-distribute-patterns
7522 @opindex ftree-loop-distribute-patterns
7523 Perform loop distribution of patterns that can be code generated with
7524 calls to a library.  This flag is enabled by default at @option{-O3}.
7526 This pass distributes the initialization loops and generates a call to
7527 memset zero.  For example, the loop
7528 @smallexample
7529 DO I = 1, N
7530   A(I) = 0
7531   B(I) = A(I) + I
7532 ENDDO
7533 @end smallexample
7534 is transformed to
7535 @smallexample
7536 DO I = 1, N
7537    A(I) = 0
7538 ENDDO
7539 DO I = 1, N
7540    B(I) = A(I) + I
7541 ENDDO
7542 @end smallexample
7543 and the initialization loop is transformed into a call to memset zero.
7545 @item -ftree-loop-im
7546 @opindex ftree-loop-im
7547 Perform loop invariant motion on trees.  This pass moves only invariants that
7548 are hard to handle at RTL level (function calls, operations that expand to
7549 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7550 operands of conditions that are invariant out of the loop, so that we can use
7551 just trivial invariantness analysis in loop unswitching.  The pass also includes
7552 store motion.
7554 @item -ftree-loop-ivcanon
7555 @opindex ftree-loop-ivcanon
7556 Create a canonical counter for number of iterations in loops for which
7557 determining number of iterations requires complicated analysis.  Later
7558 optimizations then may determine the number easily.  Useful especially
7559 in connection with unrolling.
7561 @item -fivopts
7562 @opindex fivopts
7563 Perform induction variable optimizations (strength reduction, induction
7564 variable merging and induction variable elimination) on trees.
7566 @item -ftree-parallelize-loops=n
7567 @opindex ftree-parallelize-loops
7568 Parallelize loops, i.e., split their iteration space to run in n threads.
7569 This is only possible for loops whose iterations are independent
7570 and can be arbitrarily reordered.  The optimization is only
7571 profitable on multiprocessor machines, for loops that are CPU-intensive,
7572 rather than constrained e.g.@: by memory bandwidth.  This option
7573 implies @option{-pthread}, and thus is only supported on targets
7574 that have support for @option{-pthread}.
7576 @item -ftree-pta
7577 @opindex ftree-pta
7578 Perform function-local points-to analysis on trees.  This flag is
7579 enabled by default at @option{-O} and higher.
7581 @item -ftree-sra
7582 @opindex ftree-sra
7583 Perform scalar replacement of aggregates.  This pass replaces structure
7584 references with scalars to prevent committing structures to memory too
7585 early.  This flag is enabled by default at @option{-O} and higher.
7587 @item -ftree-ter
7588 @opindex ftree-ter
7589 Perform temporary expression replacement during the SSA->normal phase.  Single
7590 use/single def temporaries are replaced at their use location with their
7591 defining expression.  This results in non-GIMPLE code, but gives the expanders
7592 much more complex trees to work on resulting in better RTL generation.  This is
7593 enabled by default at @option{-O} and higher.
7595 @item -ftree-slsr
7596 @opindex ftree-slsr
7597 Perform straight-line strength reduction on trees.  This recognizes related
7598 expressions involving multiplications and replaces them by less expensive
7599 calculations when possible.  This is enabled by default at @option{-O} and
7600 higher.
7602 @item -ftree-vectorize
7603 @opindex ftree-vectorize
7604 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
7605 and @option{-ftree-slp-vectorize} if not explicitly specified.
7607 @item -ftree-loop-vectorize
7608 @opindex ftree-loop-vectorize
7609 Perform loop vectorization on trees. This flag is enabled by default at
7610 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7612 @item -ftree-slp-vectorize
7613 @opindex ftree-slp-vectorize
7614 Perform basic block vectorization on trees. This flag is enabled by default at
7615 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7617 @item -fvect-cost-model=@var{model}
7618 @opindex fvect-cost-model
7619 Alter the cost model used for vectorization.  The @var{model} argument
7620 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
7621 With the @samp{unlimited} model the vectorized code-path is assumed
7622 to be profitable while with the @samp{dynamic} model a runtime check
7623 guards the vectorized code-path to enable it only for iteration
7624 counts that will likely execute faster than when executing the original
7625 scalar loop.  The @samp{cheap} model disables vectorization of
7626 loops where doing so would be cost prohibitive for example due to
7627 required runtime checks for data dependence or alignment but otherwise
7628 is equal to the @samp{dynamic} model.
7629 The default cost model depends on other optimization flags and is
7630 either @samp{dynamic} or @samp{cheap}.
7632 @item -fsimd-cost-model=@var{model}
7633 @opindex fsimd-cost-model
7634 Alter the cost model used for vectorization of loops marked with the OpenMP
7635 or Cilk Plus simd directive.  The @var{model} argument should be one of
7636 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
7637 have the same meaning as described in @option{-fvect-cost-model} and by
7638 default a cost model defined with @option{-fvect-cost-model} is used.
7640 @item -ftree-vrp
7641 @opindex ftree-vrp
7642 Perform Value Range Propagation on trees.  This is similar to the
7643 constant propagation pass, but instead of values, ranges of values are
7644 propagated.  This allows the optimizers to remove unnecessary range
7645 checks like array bound checks and null pointer checks.  This is
7646 enabled by default at @option{-O2} and higher.  Null pointer check
7647 elimination is only done if @option{-fdelete-null-pointer-checks} is
7648 enabled.
7650 @item -fsplit-paths
7651 @opindex fsplit-paths
7652 Split paths leading to loop backedges.  This can improve dead code
7653 elimination and common subexpression elimination.  This is enabled by
7654 default at @option{-O2} and above.
7656 @item -fsplit-ivs-in-unroller
7657 @opindex fsplit-ivs-in-unroller
7658 Enables expression of values of induction variables in later iterations
7659 of the unrolled loop using the value in the first iteration.  This breaks
7660 long dependency chains, thus improving efficiency of the scheduling passes.
7662 A combination of @option{-fweb} and CSE is often sufficient to obtain the
7663 same effect.  However, that is not reliable in cases where the loop body
7664 is more complicated than a single basic block.  It also does not work at all
7665 on some architectures due to restrictions in the CSE pass.
7667 This optimization is enabled by default.
7669 @item -fvariable-expansion-in-unroller
7670 @opindex fvariable-expansion-in-unroller
7671 With this option, the compiler creates multiple copies of some
7672 local variables when unrolling a loop, which can result in superior code.
7674 @item -fpartial-inlining
7675 @opindex fpartial-inlining
7676 Inline parts of functions.  This option has any effect only
7677 when inlining itself is turned on by the @option{-finline-functions}
7678 or @option{-finline-small-functions} options.
7680 Enabled at level @option{-O2}.
7682 @item -fpredictive-commoning
7683 @opindex fpredictive-commoning
7684 Perform predictive commoning optimization, i.e., reusing computations
7685 (especially memory loads and stores) performed in previous
7686 iterations of loops.
7688 This option is enabled at level @option{-O3}.
7690 @item -fprefetch-loop-arrays
7691 @opindex fprefetch-loop-arrays
7692 If supported by the target machine, generate instructions to prefetch
7693 memory to improve the performance of loops that access large arrays.
7695 This option may generate better or worse code; results are highly
7696 dependent on the structure of loops within the source code.
7698 Disabled at level @option{-Os}.
7700 @item -fno-peephole
7701 @itemx -fno-peephole2
7702 @opindex fno-peephole
7703 @opindex fno-peephole2
7704 Disable any machine-specific peephole optimizations.  The difference
7705 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7706 are implemented in the compiler; some targets use one, some use the
7707 other, a few use both.
7709 @option{-fpeephole} is enabled by default.
7710 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7712 @item -fno-guess-branch-probability
7713 @opindex fno-guess-branch-probability
7714 Do not guess branch probabilities using heuristics.
7716 GCC uses heuristics to guess branch probabilities if they are
7717 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7718 heuristics are based on the control flow graph.  If some branch probabilities
7719 are specified by @code{__builtin_expect}, then the heuristics are
7720 used to guess branch probabilities for the rest of the control flow graph,
7721 taking the @code{__builtin_expect} info into account.  The interactions
7722 between the heuristics and @code{__builtin_expect} can be complex, and in
7723 some cases, it may be useful to disable the heuristics so that the effects
7724 of @code{__builtin_expect} are easier to understand.
7726 The default is @option{-fguess-branch-probability} at levels
7727 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7729 @item -freorder-blocks
7730 @opindex freorder-blocks
7731 Reorder basic blocks in the compiled function in order to reduce number of
7732 taken branches and improve code locality.
7734 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7736 @item -freorder-blocks-algorithm=@var{algorithm}
7737 @opindex freorder-blocks-algorithm
7738 Use the specified algorithm for basic block reordering.  The
7739 @var{algorithm} argument can be @samp{simple}, which does not increase
7740 code size (except sometimes due to secondary effects like alignment),
7741 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
7742 put all often executed code together, minimizing the number of branches
7743 executed by making extra copies of code.
7745 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
7746 @samp{stc} at levels @option{-O2}, @option{-O3}.
7748 @item -freorder-blocks-and-partition
7749 @opindex freorder-blocks-and-partition
7750 In addition to reordering basic blocks in the compiled function, in order
7751 to reduce number of taken branches, partitions hot and cold basic blocks
7752 into separate sections of the assembly and @file{.o} files, to improve
7753 paging and cache locality performance.
7755 This optimization is automatically turned off in the presence of
7756 exception handling, for linkonce sections, for functions with a user-defined
7757 section attribute and on any architecture that does not support named
7758 sections.
7760 Enabled for x86 at levels @option{-O2}, @option{-O3}.
7762 @item -freorder-functions
7763 @opindex freorder-functions
7764 Reorder functions in the object file in order to
7765 improve code locality.  This is implemented by using special
7766 subsections @code{.text.hot} for most frequently executed functions and
7767 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7768 the linker so object file format must support named sections and linker must
7769 place them in a reasonable way.
7771 Also profile feedback must be available to make this option effective.  See
7772 @option{-fprofile-arcs} for details.
7774 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7776 @item -fstrict-aliasing
7777 @opindex fstrict-aliasing
7778 Allow the compiler to assume the strictest aliasing rules applicable to
7779 the language being compiled.  For C (and C++), this activates
7780 optimizations based on the type of expressions.  In particular, an
7781 object of one type is assumed never to reside at the same address as an
7782 object of a different type, unless the types are almost the same.  For
7783 example, an @code{unsigned int} can alias an @code{int}, but not a
7784 @code{void*} or a @code{double}.  A character type may alias any other
7785 type.
7787 @anchor{Type-punning}Pay special attention to code like this:
7788 @smallexample
7789 union a_union @{
7790   int i;
7791   double d;
7794 int f() @{
7795   union a_union t;
7796   t.d = 3.0;
7797   return t.i;
7799 @end smallexample
7800 The practice of reading from a different union member than the one most
7801 recently written to (called ``type-punning'') is common.  Even with
7802 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7803 is accessed through the union type.  So, the code above works as
7804 expected.  @xref{Structures unions enumerations and bit-fields
7805 implementation}.  However, this code might not:
7806 @smallexample
7807 int f() @{
7808   union a_union t;
7809   int* ip;
7810   t.d = 3.0;
7811   ip = &t.i;
7812   return *ip;
7814 @end smallexample
7816 Similarly, access by taking the address, casting the resulting pointer
7817 and dereferencing the result has undefined behavior, even if the cast
7818 uses a union type, e.g.:
7819 @smallexample
7820 int f() @{
7821   double d = 3.0;
7822   return ((union a_union *) &d)->i;
7824 @end smallexample
7826 The @option{-fstrict-aliasing} option is enabled at levels
7827 @option{-O2}, @option{-O3}, @option{-Os}.
7829 @item -fstrict-overflow
7830 @opindex fstrict-overflow
7831 Allow the compiler to assume strict signed overflow rules, depending
7832 on the language being compiled.  For C (and C++) this means that
7833 overflow when doing arithmetic with signed numbers is undefined, which
7834 means that the compiler may assume that it does not happen.  This
7835 permits various optimizations.  For example, the compiler assumes
7836 that an expression like @code{i + 10 > i} is always true for
7837 signed @code{i}.  This assumption is only valid if signed overflow is
7838 undefined, as the expression is false if @code{i + 10} overflows when
7839 using twos complement arithmetic.  When this option is in effect any
7840 attempt to determine whether an operation on signed numbers 
7841 overflows must be written carefully to not actually involve overflow.
7843 This option also allows the compiler to assume strict pointer
7844 semantics: given a pointer to an object, if adding an offset to that
7845 pointer does not produce a pointer to the same object, the addition is
7846 undefined.  This permits the compiler to conclude that @code{p + u >
7847 p} is always true for a pointer @code{p} and unsigned integer
7848 @code{u}.  This assumption is only valid because pointer wraparound is
7849 undefined, as the expression is false if @code{p + u} overflows using
7850 twos complement arithmetic.
7852 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7853 that integer signed overflow is fully defined: it wraps.  When
7854 @option{-fwrapv} is used, there is no difference between
7855 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7856 integers.  With @option{-fwrapv} certain types of overflow are
7857 permitted.  For example, if the compiler gets an overflow when doing
7858 arithmetic on constants, the overflowed value can still be used with
7859 @option{-fwrapv}, but not otherwise.
7861 The @option{-fstrict-overflow} option is enabled at levels
7862 @option{-O2}, @option{-O3}, @option{-Os}.
7864 @item -falign-functions
7865 @itemx -falign-functions=@var{n}
7866 @opindex falign-functions
7867 Align the start of functions to the next power-of-two greater than
7868 @var{n}, skipping up to @var{n} bytes.  For instance,
7869 @option{-falign-functions=32} aligns functions to the next 32-byte
7870 boundary, but @option{-falign-functions=24} aligns to the next
7871 32-byte boundary only if this can be done by skipping 23 bytes or less.
7873 @option{-fno-align-functions} and @option{-falign-functions=1} are
7874 equivalent and mean that functions are not aligned.
7876 Some assemblers only support this flag when @var{n} is a power of two;
7877 in that case, it is rounded up.
7879 If @var{n} is not specified or is zero, use a machine-dependent default.
7881 Enabled at levels @option{-O2}, @option{-O3}.
7883 @item -falign-labels
7884 @itemx -falign-labels=@var{n}
7885 @opindex falign-labels
7886 Align all branch targets to a power-of-two boundary, skipping up to
7887 @var{n} bytes like @option{-falign-functions}.  This option can easily
7888 make code slower, because it must insert dummy operations for when the
7889 branch target is reached in the usual flow of the code.
7891 @option{-fno-align-labels} and @option{-falign-labels=1} are
7892 equivalent and mean that labels are not aligned.
7894 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7895 are greater than this value, then their values are used instead.
7897 If @var{n} is not specified or is zero, use a machine-dependent default
7898 which is very likely to be @samp{1}, meaning no alignment.
7900 Enabled at levels @option{-O2}, @option{-O3}.
7902 @item -falign-loops
7903 @itemx -falign-loops=@var{n}
7904 @opindex falign-loops
7905 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7906 like @option{-falign-functions}.  If the loops are
7907 executed many times, this makes up for any execution of the dummy
7908 operations.
7910 @option{-fno-align-loops} and @option{-falign-loops=1} are
7911 equivalent and mean that loops are not aligned.
7913 If @var{n} is not specified or is zero, use a machine-dependent default.
7915 Enabled at levels @option{-O2}, @option{-O3}.
7917 @item -falign-jumps
7918 @itemx -falign-jumps=@var{n}
7919 @opindex falign-jumps
7920 Align branch targets to a power-of-two boundary, for branch targets
7921 where the targets can only be reached by jumping, skipping up to @var{n}
7922 bytes like @option{-falign-functions}.  In this case, no dummy operations
7923 need be executed.
7925 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7926 equivalent and mean that loops are not aligned.
7928 If @var{n} is not specified or is zero, use a machine-dependent default.
7930 Enabled at levels @option{-O2}, @option{-O3}.
7932 @item -funit-at-a-time
7933 @opindex funit-at-a-time
7934 This option is left for compatibility reasons. @option{-funit-at-a-time}
7935 has no effect, while @option{-fno-unit-at-a-time} implies
7936 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7938 Enabled by default.
7940 @item -fno-toplevel-reorder
7941 @opindex fno-toplevel-reorder
7942 Do not reorder top-level functions, variables, and @code{asm}
7943 statements.  Output them in the same order that they appear in the
7944 input file.  When this option is used, unreferenced static variables
7945 are not removed.  This option is intended to support existing code
7946 that relies on a particular ordering.  For new code, it is better to
7947 use attributes when possible.
7949 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
7950 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
7951 targets.
7953 @item -fweb
7954 @opindex fweb
7955 Constructs webs as commonly used for register allocation purposes and assign
7956 each web individual pseudo register.  This allows the register allocation pass
7957 to operate on pseudos directly, but also strengthens several other optimization
7958 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7959 however, make debugging impossible, since variables no longer stay in a
7960 ``home register''.
7962 Enabled by default with @option{-funroll-loops}.
7964 @item -fwhole-program
7965 @opindex fwhole-program
7966 Assume that the current compilation unit represents the whole program being
7967 compiled.  All public functions and variables with the exception of @code{main}
7968 and those merged by attribute @code{externally_visible} become static functions
7969 and in effect are optimized more aggressively by interprocedural optimizers.
7971 This option should not be used in combination with @option{-flto}.
7972 Instead relying on a linker plugin should provide safer and more precise
7973 information.
7975 @item -flto[=@var{n}]
7976 @opindex flto
7977 This option runs the standard link-time optimizer.  When invoked
7978 with source code, it generates GIMPLE (one of GCC's internal
7979 representations) and writes it to special ELF sections in the object
7980 file.  When the object files are linked together, all the function
7981 bodies are read from these ELF sections and instantiated as if they
7982 had been part of the same translation unit.
7984 To use the link-time optimizer, @option{-flto} and optimization
7985 options should be specified at compile time and during the final link.
7986 It is recommended that you compile all the files participating in the
7987 same link with the same options and also specify those options at
7988 link time.  
7989 For example:
7991 @smallexample
7992 gcc -c -O2 -flto foo.c
7993 gcc -c -O2 -flto bar.c
7994 gcc -o myprog -flto -O2 foo.o bar.o
7995 @end smallexample
7997 The first two invocations to GCC save a bytecode representation
7998 of GIMPLE into special ELF sections inside @file{foo.o} and
7999 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8000 @file{foo.o} and @file{bar.o}, merges the two files into a single
8001 internal image, and compiles the result as usual.  Since both
8002 @file{foo.o} and @file{bar.o} are merged into a single image, this
8003 causes all the interprocedural analyses and optimizations in GCC to
8004 work across the two files as if they were a single one.  This means,
8005 for example, that the inliner is able to inline functions in
8006 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8008 Another (simpler) way to enable link-time optimization is:
8010 @smallexample
8011 gcc -o myprog -flto -O2 foo.c bar.c
8012 @end smallexample
8014 The above generates bytecode for @file{foo.c} and @file{bar.c},
8015 merges them together into a single GIMPLE representation and optimizes
8016 them as usual to produce @file{myprog}.
8018 The only important thing to keep in mind is that to enable link-time
8019 optimizations you need to use the GCC driver to perform the link step.
8020 GCC then automatically performs link-time optimization if any of the
8021 objects involved were compiled with the @option{-flto} command-line option.  
8022 You generally
8023 should specify the optimization options to be used for link-time
8024 optimization though GCC tries to be clever at guessing an
8025 optimization level to use from the options used at compile time
8026 if you fail to specify one at link time.  You can always override
8027 the automatic decision to do link-time optimization at link time
8028 by passing @option{-fno-lto} to the link command.
8030 To make whole program optimization effective, it is necessary to make
8031 certain whole program assumptions.  The compiler needs to know
8032 what functions and variables can be accessed by libraries and runtime
8033 outside of the link-time optimized unit.  When supported by the linker,
8034 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8035 to the compiler about used and externally visible symbols.  When
8036 the linker plugin is not available, @option{-fwhole-program} should be
8037 used to allow the compiler to make these assumptions, which leads
8038 to more aggressive optimization decisions.
8040 When @option{-fuse-linker-plugin} is not enabled, when a file is
8041 compiled with @option{-flto}, the generated object file is larger than
8042 a regular object file because it contains GIMPLE bytecodes and the usual
8043 final code (see @option{-ffat-lto-objects}.  This means that
8044 object files with LTO information can be linked as normal object
8045 files; if @option{-fno-lto} is passed to the linker, no
8046 interprocedural optimizations are applied.  Note that when
8047 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8048 but you cannot perform a regular, non-LTO link on them.
8050 Additionally, the optimization flags used to compile individual files
8051 are not necessarily related to those used at link time.  For instance,
8053 @smallexample
8054 gcc -c -O0 -ffat-lto-objects -flto foo.c
8055 gcc -c -O0 -ffat-lto-objects -flto bar.c
8056 gcc -o myprog -O3 foo.o bar.o
8057 @end smallexample
8059 This produces individual object files with unoptimized assembler
8060 code, but the resulting binary @file{myprog} is optimized at
8061 @option{-O3}.  If, instead, the final binary is generated with
8062 @option{-fno-lto}, then @file{myprog} is not optimized.
8064 When producing the final binary, GCC only
8065 applies link-time optimizations to those files that contain bytecode.
8066 Therefore, you can mix and match object files and libraries with
8067 GIMPLE bytecodes and final object code.  GCC automatically selects
8068 which files to optimize in LTO mode and which files to link without
8069 further processing.
8071 There are some code generation flags preserved by GCC when
8072 generating bytecodes, as they need to be used during the final link
8073 stage.  Generally options specified at link time override those
8074 specified at compile time.
8076 If you do not specify an optimization level option @option{-O} at
8077 link time, then GCC uses the highest optimization level 
8078 used when compiling the object files.
8080 Currently, the following options and their settings are taken from
8081 the first object file that explicitly specifies them: 
8082 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8083 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8084 and all the @option{-m} target flags.
8086 Certain ABI-changing flags are required to match in all compilation units,
8087 and trying to override this at link time with a conflicting value
8088 is ignored.  This includes options such as @option{-freg-struct-return}
8089 and @option{-fpcc-struct-return}. 
8091 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8092 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8093 are passed through to the link stage and merged conservatively for
8094 conflicting translation units.  Specifically
8095 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8096 precedence; and for example @option{-ffp-contract=off} takes precedence
8097 over @option{-ffp-contract=fast}.  You can override them at link time.
8099 If LTO encounters objects with C linkage declared with incompatible
8100 types in separate translation units to be linked together (undefined
8101 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8102 issued.  The behavior is still undefined at run time.  Similar
8103 diagnostics may be raised for other languages.
8105 Another feature of LTO is that it is possible to apply interprocedural
8106 optimizations on files written in different languages:
8108 @smallexample
8109 gcc -c -flto foo.c
8110 g++ -c -flto bar.cc
8111 gfortran -c -flto baz.f90
8112 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8113 @end smallexample
8115 Notice that the final link is done with @command{g++} to get the C++
8116 runtime libraries and @option{-lgfortran} is added to get the Fortran
8117 runtime libraries.  In general, when mixing languages in LTO mode, you
8118 should use the same link command options as when mixing languages in a
8119 regular (non-LTO) compilation.
8121 If object files containing GIMPLE bytecode are stored in a library archive, say
8122 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8123 are using a linker with plugin support.  To create static libraries suitable
8124 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8125 and @command{ranlib}; 
8126 to show the symbols of object files with GIMPLE bytecode, use
8127 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8128 and @command{nm} have been compiled with plugin support.  At link time, use the the
8129 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8130 the LTO optimization process:
8132 @smallexample
8133 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8134 @end smallexample
8136 With the linker plugin enabled, the linker extracts the needed
8137 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8138 to make them part of the aggregated GIMPLE image to be optimized.
8140 If you are not using a linker with plugin support and/or do not
8141 enable the linker plugin, then the objects inside @file{libfoo.a}
8142 are extracted and linked as usual, but they do not participate
8143 in the LTO optimization process.  In order to make a static library suitable
8144 for both LTO optimization and usual linkage, compile its object files with
8145 @option{-flto} @option{-ffat-lto-objects}.
8147 Link-time optimizations do not require the presence of the whole program to
8148 operate.  If the program does not require any symbols to be exported, it is
8149 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8150 the interprocedural optimizers to use more aggressive assumptions which may
8151 lead to improved optimization opportunities.
8152 Use of @option{-fwhole-program} is not needed when linker plugin is
8153 active (see @option{-fuse-linker-plugin}).
8155 The current implementation of LTO makes no
8156 attempt to generate bytecode that is portable between different
8157 types of hosts.  The bytecode files are versioned and there is a
8158 strict version check, so bytecode files generated in one version of
8159 GCC do not work with an older or newer version of GCC.
8161 Link-time optimization does not work well with generation of debugging
8162 information.  Combining @option{-flto} with
8163 @option{-g} is currently experimental and expected to produce unexpected
8164 results.
8166 If you specify the optional @var{n}, the optimization and code
8167 generation done at link time is executed in parallel using @var{n}
8168 parallel jobs by utilizing an installed @command{make} program.  The
8169 environment variable @env{MAKE} may be used to override the program
8170 used.  The default value for @var{n} is 1.
8172 You can also specify @option{-flto=jobserver} to use GNU make's
8173 job server mode to determine the number of parallel jobs. This
8174 is useful when the Makefile calling GCC is already executing in parallel.
8175 You must prepend a @samp{+} to the command recipe in the parent Makefile
8176 for this to work.  This option likely only works if @env{MAKE} is
8177 GNU make.
8179 @item -flto-partition=@var{alg}
8180 @opindex flto-partition
8181 Specify the partitioning algorithm used by the link-time optimizer.
8182 The value is either @samp{1to1} to specify a partitioning mirroring
8183 the original source files or @samp{balanced} to specify partitioning
8184 into equally sized chunks (whenever possible) or @samp{max} to create
8185 new partition for every symbol where possible.  Specifying @samp{none}
8186 as an algorithm disables partitioning and streaming completely. 
8187 The default value is @samp{balanced}. While @samp{1to1} can be used
8188 as an workaround for various code ordering issues, the @samp{max}
8189 partitioning is intended for internal testing only.
8190 The value @samp{one} specifies that exactly one partition should be
8191 used while the value @samp{none} bypasses partitioning and executes
8192 the link-time optimization step directly from the WPA phase.
8194 @item -flto-odr-type-merging
8195 @opindex flto-odr-type-merging
8196 Enable streaming of mangled types names of C++ types and their unification
8197 at link time.  This increases size of LTO object files, but enables
8198 diagnostics about One Definition Rule violations.
8200 @item -flto-compression-level=@var{n}
8201 @opindex flto-compression-level
8202 This option specifies the level of compression used for intermediate
8203 language written to LTO object files, and is only meaningful in
8204 conjunction with LTO mode (@option{-flto}).  Valid
8205 values are 0 (no compression) to 9 (maximum compression).  Values
8206 outside this range are clamped to either 0 or 9.  If the option is not
8207 given, a default balanced compression setting is used.
8209 @item -fuse-linker-plugin
8210 @opindex fuse-linker-plugin
8211 Enables the use of a linker plugin during link-time optimization.  This
8212 option relies on plugin support in the linker, which is available in gold
8213 or in GNU ld 2.21 or newer.
8215 This option enables the extraction of object files with GIMPLE bytecode out
8216 of library archives. This improves the quality of optimization by exposing
8217 more code to the link-time optimizer.  This information specifies what
8218 symbols can be accessed externally (by non-LTO object or during dynamic
8219 linking).  Resulting code quality improvements on binaries (and shared
8220 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
8221 See @option{-flto} for a description of the effect of this flag and how to
8222 use it.
8224 This option is enabled by default when LTO support in GCC is enabled
8225 and GCC was configured for use with
8226 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8228 @item -ffat-lto-objects
8229 @opindex ffat-lto-objects
8230 Fat LTO objects are object files that contain both the intermediate language
8231 and the object code. This makes them usable for both LTO linking and normal
8232 linking. This option is effective only when compiling with @option{-flto}
8233 and is ignored at link time.
8235 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8236 requires the complete toolchain to be aware of LTO. It requires a linker with
8237 linker plugin support for basic functionality.  Additionally,
8238 @command{nm}, @command{ar} and @command{ranlib}
8239 need to support linker plugins to allow a full-featured build environment
8240 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8241 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8242 to these tools. With non fat LTO makefiles need to be modified to use them.
8244 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
8245 support.
8247 @item -fcompare-elim
8248 @opindex fcompare-elim
8249 After register allocation and post-register allocation instruction splitting,
8250 identify arithmetic instructions that compute processor flags similar to a
8251 comparison operation based on that arithmetic.  If possible, eliminate the
8252 explicit comparison operation.
8254 This pass only applies to certain targets that cannot explicitly represent
8255 the comparison operation before register allocation is complete.
8257 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8259 @item -fcprop-registers
8260 @opindex fcprop-registers
8261 After register allocation and post-register allocation instruction splitting,
8262 perform a copy-propagation pass to try to reduce scheduling dependencies
8263 and occasionally eliminate the copy.
8265 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8267 @item -fprofile-correction
8268 @opindex fprofile-correction
8269 Profiles collected using an instrumented binary for multi-threaded programs may
8270 be inconsistent due to missed counter updates. When this option is specified,
8271 GCC uses heuristics to correct or smooth out such inconsistencies. By
8272 default, GCC emits an error message when an inconsistent profile is detected.
8274 @item -fprofile-use
8275 @itemx -fprofile-use=@var{path}
8276 @opindex fprofile-use
8277 Enable profile feedback-directed optimizations, 
8278 and the following optimizations
8279 which are generally profitable only with profile feedback available:
8280 @option{-fbranch-probabilities}, @option{-fvpt},
8281 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
8282 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
8284 Before you can use this option, you must first generate profiling information.
8285 @xref{Optimize Options}, for information about the @option{-fprofile-generate}
8286 option.
8288 By default, GCC emits an error message if the feedback profiles do not
8289 match the source code.  This error can be turned into a warning by using
8290 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8291 code.
8293 If @var{path} is specified, GCC looks at the @var{path} to find
8294 the profile feedback data files. See @option{-fprofile-dir}.
8296 @item -fauto-profile
8297 @itemx -fauto-profile=@var{path}
8298 @opindex fauto-profile
8299 Enable sampling-based feedback-directed optimizations, 
8300 and the following optimizations
8301 which are generally profitable only with profile feedback available:
8302 @option{-fbranch-probabilities}, @option{-fvpt},
8303 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
8304 @option{-ftree-vectorize},
8305 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
8306 @option{-fpredictive-commoning}, @option{-funswitch-loops},
8307 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
8309 @var{path} is the name of a file containing AutoFDO profile information.
8310 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
8312 Producing an AutoFDO profile data file requires running your program
8313 with the @command{perf} utility on a supported GNU/Linux target system.
8314 For more information, see @uref{https://perf.wiki.kernel.org/}.
8316 E.g.
8317 @smallexample
8318 perf record -e br_inst_retired:near_taken -b -o perf.data \
8319     -- your_program
8320 @end smallexample
8322 Then use the @command{create_gcov} tool to convert the raw profile data
8323 to a format that can be used by GCC.@  You must also supply the 
8324 unstripped binary for your program to this tool.  
8325 See @uref{https://github.com/google/autofdo}.
8327 E.g.
8328 @smallexample
8329 create_gcov --binary=your_program.unstripped --profile=perf.data \
8330     --gcov=profile.afdo
8331 @end smallexample
8332 @end table
8334 The following options control compiler behavior regarding floating-point 
8335 arithmetic.  These options trade off between speed and
8336 correctness.  All must be specifically enabled.
8338 @table @gcctabopt
8339 @item -ffloat-store
8340 @opindex ffloat-store
8341 Do not store floating-point variables in registers, and inhibit other
8342 options that might change whether a floating-point value is taken from a
8343 register or memory.
8345 @cindex floating-point precision
8346 This option prevents undesirable excess precision on machines such as
8347 the 68000 where the floating registers (of the 68881) keep more
8348 precision than a @code{double} is supposed to have.  Similarly for the
8349 x86 architecture.  For most programs, the excess precision does only
8350 good, but a few programs rely on the precise definition of IEEE floating
8351 point.  Use @option{-ffloat-store} for such programs, after modifying
8352 them to store all pertinent intermediate computations into variables.
8354 @item -fexcess-precision=@var{style}
8355 @opindex fexcess-precision
8356 This option allows further control over excess precision on machines
8357 where floating-point registers have more precision than the IEEE
8358 @code{float} and @code{double} types and the processor does not
8359 support operations rounding to those types.  By default,
8360 @option{-fexcess-precision=fast} is in effect; this means that
8361 operations are carried out in the precision of the registers and that
8362 it is unpredictable when rounding to the types specified in the source
8363 code takes place.  When compiling C, if
8364 @option{-fexcess-precision=standard} is specified then excess
8365 precision follows the rules specified in ISO C99; in particular,
8366 both casts and assignments cause values to be rounded to their
8367 semantic types (whereas @option{-ffloat-store} only affects
8368 assignments).  This option is enabled by default for C if a strict
8369 conformance option such as @option{-std=c99} is used.
8371 @opindex mfpmath
8372 @option{-fexcess-precision=standard} is not implemented for languages
8373 other than C, and has no effect if
8374 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8375 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8376 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8377 semantics apply without excess precision, and in the latter, rounding
8378 is unpredictable.
8380 @item -ffast-math
8381 @opindex ffast-math
8382 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8383 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8384 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8386 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8388 This option is not turned on by any @option{-O} option besides
8389 @option{-Ofast} since it can result in incorrect output for programs
8390 that depend on an exact implementation of IEEE or ISO rules/specifications
8391 for math functions. It may, however, yield faster code for programs
8392 that do not require the guarantees of these specifications.
8394 @item -fno-math-errno
8395 @opindex fno-math-errno
8396 Do not set @code{errno} after calling math functions that are executed
8397 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8398 IEEE exceptions for math error handling may want to use this flag
8399 for speed while maintaining IEEE arithmetic compatibility.
8401 This option is not turned on by any @option{-O} option since
8402 it can result in incorrect output for programs that depend on
8403 an exact implementation of IEEE or ISO rules/specifications for
8404 math functions. It may, however, yield faster code for programs
8405 that do not require the guarantees of these specifications.
8407 The default is @option{-fmath-errno}.
8409 On Darwin systems, the math library never sets @code{errno}.  There is
8410 therefore no reason for the compiler to consider the possibility that
8411 it might, and @option{-fno-math-errno} is the default.
8413 @item -funsafe-math-optimizations
8414 @opindex funsafe-math-optimizations
8416 Allow optimizations for floating-point arithmetic that (a) assume
8417 that arguments and results are valid and (b) may violate IEEE or
8418 ANSI standards.  When used at link time, it may include libraries
8419 or startup files that change the default FPU control word or other
8420 similar optimizations.
8422 This option is not turned on by any @option{-O} option since
8423 it can result in incorrect output for programs that depend on
8424 an exact implementation of IEEE or ISO rules/specifications for
8425 math functions. It may, however, yield faster code for programs
8426 that do not require the guarantees of these specifications.
8427 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8428 @option{-fassociative-math} and @option{-freciprocal-math}.
8430 The default is @option{-fno-unsafe-math-optimizations}.
8432 @item -fassociative-math
8433 @opindex fassociative-math
8435 Allow re-association of operands in series of floating-point operations.
8436 This violates the ISO C and C++ language standard by possibly changing
8437 computation result.  NOTE: re-ordering may change the sign of zero as
8438 well as ignore NaNs and inhibit or create underflow or overflow (and
8439 thus cannot be used on code that relies on rounding behavior like
8440 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8441 and thus may not be used when ordered comparisons are required.
8442 This option requires that both @option{-fno-signed-zeros} and
8443 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8444 much sense with @option{-frounding-math}. For Fortran the option
8445 is automatically enabled when both @option{-fno-signed-zeros} and
8446 @option{-fno-trapping-math} are in effect.
8448 The default is @option{-fno-associative-math}.
8450 @item -freciprocal-math
8451 @opindex freciprocal-math
8453 Allow the reciprocal of a value to be used instead of dividing by
8454 the value if this enables optimizations.  For example @code{x / y}
8455 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8456 is subject to common subexpression elimination.  Note that this loses
8457 precision and increases the number of flops operating on the value.
8459 The default is @option{-fno-reciprocal-math}.
8461 @item -ffinite-math-only
8462 @opindex ffinite-math-only
8463 Allow optimizations for floating-point arithmetic that assume
8464 that arguments and results are not NaNs or +-Infs.
8466 This option is not turned on by any @option{-O} option since
8467 it can result in incorrect output for programs that depend on
8468 an exact implementation of IEEE or ISO rules/specifications for
8469 math functions. It may, however, yield faster code for programs
8470 that do not require the guarantees of these specifications.
8472 The default is @option{-fno-finite-math-only}.
8474 @item -fno-signed-zeros
8475 @opindex fno-signed-zeros
8476 Allow optimizations for floating-point arithmetic that ignore the
8477 signedness of zero.  IEEE arithmetic specifies the behavior of
8478 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8479 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8480 This option implies that the sign of a zero result isn't significant.
8482 The default is @option{-fsigned-zeros}.
8484 @item -fno-trapping-math
8485 @opindex fno-trapping-math
8486 Compile code assuming that floating-point operations cannot generate
8487 user-visible traps.  These traps include division by zero, overflow,
8488 underflow, inexact result and invalid operation.  This option requires
8489 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8490 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8492 This option should never be turned on by any @option{-O} option since
8493 it can result in incorrect output for programs that depend on
8494 an exact implementation of IEEE or ISO rules/specifications for
8495 math functions.
8497 The default is @option{-ftrapping-math}.
8499 @item -frounding-math
8500 @opindex frounding-math
8501 Disable transformations and optimizations that assume default floating-point
8502 rounding behavior.  This is round-to-zero for all floating point
8503 to integer conversions, and round-to-nearest for all other arithmetic
8504 truncations.  This option should be specified for programs that change
8505 the FP rounding mode dynamically, or that may be executed with a
8506 non-default rounding mode.  This option disables constant folding of
8507 floating-point expressions at compile time (which may be affected by
8508 rounding mode) and arithmetic transformations that are unsafe in the
8509 presence of sign-dependent rounding modes.
8511 The default is @option{-fno-rounding-math}.
8513 This option is experimental and does not currently guarantee to
8514 disable all GCC optimizations that are affected by rounding mode.
8515 Future versions of GCC may provide finer control of this setting
8516 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8517 will be used to specify the default state for @code{FENV_ACCESS}.
8519 @item -fsignaling-nans
8520 @opindex fsignaling-nans
8521 Compile code assuming that IEEE signaling NaNs may generate user-visible
8522 traps during floating-point operations.  Setting this option disables
8523 optimizations that may change the number of exceptions visible with
8524 signaling NaNs.  This option implies @option{-ftrapping-math}.
8526 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8527 be defined.
8529 The default is @option{-fno-signaling-nans}.
8531 This option is experimental and does not currently guarantee to
8532 disable all GCC optimizations that affect signaling NaN behavior.
8534 @item -fsingle-precision-constant
8535 @opindex fsingle-precision-constant
8536 Treat floating-point constants as single precision instead of
8537 implicitly converting them to double-precision constants.
8539 @item -fcx-limited-range
8540 @opindex fcx-limited-range
8541 When enabled, this option states that a range reduction step is not
8542 needed when performing complex division.  Also, there is no checking
8543 whether the result of a complex multiplication or division is @code{NaN
8544 + I*NaN}, with an attempt to rescue the situation in that case.  The
8545 default is @option{-fno-cx-limited-range}, but is enabled by
8546 @option{-ffast-math}.
8548 This option controls the default setting of the ISO C99
8549 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8550 all languages.
8552 @item -fcx-fortran-rules
8553 @opindex fcx-fortran-rules
8554 Complex multiplication and division follow Fortran rules.  Range
8555 reduction is done as part of complex division, but there is no checking
8556 whether the result of a complex multiplication or division is @code{NaN
8557 + I*NaN}, with an attempt to rescue the situation in that case.
8559 The default is @option{-fno-cx-fortran-rules}.
8561 @end table
8563 The following options control optimizations that may improve
8564 performance, but are not enabled by any @option{-O} options.  This
8565 section includes experimental options that may produce broken code.
8567 @table @gcctabopt
8568 @item -fbranch-probabilities
8569 @opindex fbranch-probabilities
8570 After running a program compiled with @option{-fprofile-arcs}
8571 (@pxref{Instrumentation Options}),
8572 you can compile it a second time using
8573 @option{-fbranch-probabilities}, to improve optimizations based on
8574 the number of times each branch was taken.  When a program
8575 compiled with @option{-fprofile-arcs} exits, it saves arc execution
8576 counts to a file called @file{@var{sourcename}.gcda} for each source
8577 file.  The information in this data file is very dependent on the
8578 structure of the generated code, so you must use the same source code
8579 and the same optimization options for both compilations.
8581 With @option{-fbranch-probabilities}, GCC puts a
8582 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8583 These can be used to improve optimization.  Currently, they are only
8584 used in one place: in @file{reorg.c}, instead of guessing which path a
8585 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8586 exactly determine which path is taken more often.
8588 @item -fprofile-values
8589 @opindex fprofile-values
8590 If combined with @option{-fprofile-arcs}, it adds code so that some
8591 data about values of expressions in the program is gathered.
8593 With @option{-fbranch-probabilities}, it reads back the data gathered
8594 from profiling values of expressions for usage in optimizations.
8596 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8598 @item -fprofile-reorder-functions
8599 @opindex fprofile-reorder-functions
8600 Function reordering based on profile instrumentation collects
8601 first time of execution of a function and orders these functions
8602 in ascending order.
8604 Enabled with @option{-fprofile-use}.
8606 @item -fvpt
8607 @opindex fvpt
8608 If combined with @option{-fprofile-arcs}, this option instructs the compiler
8609 to add code to gather information about values of expressions.
8611 With @option{-fbranch-probabilities}, it reads back the data gathered
8612 and actually performs the optimizations based on them.
8613 Currently the optimizations include specialization of division operations
8614 using the knowledge about the value of the denominator.
8616 @item -frename-registers
8617 @opindex frename-registers
8618 Attempt to avoid false dependencies in scheduled code by making use
8619 of registers left over after register allocation.  This optimization
8620 most benefits processors with lots of registers.  Depending on the
8621 debug information format adopted by the target, however, it can
8622 make debugging impossible, since variables no longer stay in
8623 a ``home register''.
8625 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8627 @item -fschedule-fusion
8628 @opindex fschedule-fusion
8629 Performs a target dependent pass over the instruction stream to schedule
8630 instructions of same type together because target machine can execute them
8631 more efficiently if they are adjacent to each other in the instruction flow.
8633 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8635 @item -ftracer
8636 @opindex ftracer
8637 Perform tail duplication to enlarge superblock size.  This transformation
8638 simplifies the control flow of the function allowing other optimizations to do
8639 a better job.
8641 Enabled with @option{-fprofile-use}.
8643 @item -funroll-loops
8644 @opindex funroll-loops
8645 Unroll loops whose number of iterations can be determined at compile time or
8646 upon entry to the loop.  @option{-funroll-loops} implies
8647 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8648 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8649 a small constant number of iterations).  This option makes code larger, and may
8650 or may not make it run faster.
8652 Enabled with @option{-fprofile-use}.
8654 @item -funroll-all-loops
8655 @opindex funroll-all-loops
8656 Unroll all loops, even if their number of iterations is uncertain when
8657 the loop is entered.  This usually makes programs run more slowly.
8658 @option{-funroll-all-loops} implies the same options as
8659 @option{-funroll-loops}.
8661 @item -fpeel-loops
8662 @opindex fpeel-loops
8663 Peels loops for which there is enough information that they do not
8664 roll much (from profile feedback).  It also turns on complete loop peeling
8665 (i.e.@: complete removal of loops with small constant number of iterations).
8667 Enabled with @option{-fprofile-use}.
8669 @item -fmove-loop-invariants
8670 @opindex fmove-loop-invariants
8671 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8672 at level @option{-O1}
8674 @item -funswitch-loops
8675 @opindex funswitch-loops
8676 Move branches with loop invariant conditions out of the loop, with duplicates
8677 of the loop on both branches (modified according to result of the condition).
8679 @item -ffunction-sections
8680 @itemx -fdata-sections
8681 @opindex ffunction-sections
8682 @opindex fdata-sections
8683 Place each function or data item into its own section in the output
8684 file if the target supports arbitrary sections.  The name of the
8685 function or the name of the data item determines the section's name
8686 in the output file.
8688 Use these options on systems where the linker can perform optimizations
8689 to improve locality of reference in the instruction space.  Most systems
8690 using the ELF object format and SPARC processors running Solaris 2 have
8691 linkers with such optimizations.  AIX may have these optimizations in
8692 the future.
8694 Only use these options when there are significant benefits from doing
8695 so.  When you specify these options, the assembler and linker
8696 create larger object and executable files and are also slower.
8697 You cannot use @command{gprof} on all systems if you
8698 specify this option, and you may have problems with debugging if
8699 you specify both this option and @option{-g}.
8701 @item -fbranch-target-load-optimize
8702 @opindex fbranch-target-load-optimize
8703 Perform branch target register load optimization before prologue / epilogue
8704 threading.
8705 The use of target registers can typically be exposed only during reload,
8706 thus hoisting loads out of loops and doing inter-block scheduling needs
8707 a separate optimization pass.
8709 @item -fbranch-target-load-optimize2
8710 @opindex fbranch-target-load-optimize2
8711 Perform branch target register load optimization after prologue / epilogue
8712 threading.
8714 @item -fbtr-bb-exclusive
8715 @opindex fbtr-bb-exclusive
8716 When performing branch target register load optimization, don't reuse
8717 branch target registers within any basic block.
8719 @item -fstdarg-opt
8720 @opindex fstdarg-opt
8721 Optimize the prologue of variadic argument functions with respect to usage of
8722 those arguments.
8724 @item -fsection-anchors
8725 @opindex fsection-anchors
8726 Try to reduce the number of symbolic address calculations by using
8727 shared ``anchor'' symbols to address nearby objects.  This transformation
8728 can help to reduce the number of GOT entries and GOT accesses on some
8729 targets.
8731 For example, the implementation of the following function @code{foo}:
8733 @smallexample
8734 static int a, b, c;
8735 int foo (void) @{ return a + b + c; @}
8736 @end smallexample
8738 @noindent
8739 usually calculates the addresses of all three variables, but if you
8740 compile it with @option{-fsection-anchors}, it accesses the variables
8741 from a common anchor point instead.  The effect is similar to the
8742 following pseudocode (which isn't valid C):
8744 @smallexample
8745 int foo (void)
8747   register int *xr = &x;
8748   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8750 @end smallexample
8752 Not all targets support this option.
8754 @item --param @var{name}=@var{value}
8755 @opindex param
8756 In some places, GCC uses various constants to control the amount of
8757 optimization that is done.  For example, GCC does not inline functions
8758 that contain more than a certain number of instructions.  You can
8759 control some of these constants on the command line using the
8760 @option{--param} option.
8762 The names of specific parameters, and the meaning of the values, are
8763 tied to the internals of the compiler, and are subject to change
8764 without notice in future releases.
8766 In each case, the @var{value} is an integer.  The allowable choices for
8767 @var{name} are:
8769 @table @gcctabopt
8770 @item predictable-branch-outcome
8771 When branch is predicted to be taken with probability lower than this threshold
8772 (in percent), then it is considered well predictable. The default is 10.
8774 @item max-rtl-if-conversion-insns
8775 RTL if-conversion tries to remove conditional branches around a block and
8776 replace them with conditionally executed instructions.  This parameter
8777 gives the maximum number of instructions in a block which should be
8778 considered for if-conversion.  The default is 10, though the compiler will
8779 also use other heuristics to decide whether if-conversion is likely to be
8780 profitable.
8782 @item max-crossjump-edges
8783 The maximum number of incoming edges to consider for cross-jumping.
8784 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8785 the number of edges incoming to each block.  Increasing values mean
8786 more aggressive optimization, making the compilation time increase with
8787 probably small improvement in executable size.
8789 @item min-crossjump-insns
8790 The minimum number of instructions that must be matched at the end
8791 of two blocks before cross-jumping is performed on them.  This
8792 value is ignored in the case where all instructions in the block being
8793 cross-jumped from are matched.  The default value is 5.
8795 @item max-grow-copy-bb-insns
8796 The maximum code size expansion factor when copying basic blocks
8797 instead of jumping.  The expansion is relative to a jump instruction.
8798 The default value is 8.
8800 @item max-goto-duplication-insns
8801 The maximum number of instructions to duplicate to a block that jumps
8802 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8803 passes, GCC factors computed gotos early in the compilation process,
8804 and unfactors them as late as possible.  Only computed jumps at the
8805 end of a basic blocks with no more than max-goto-duplication-insns are
8806 unfactored.  The default value is 8.
8808 @item max-delay-slot-insn-search
8809 The maximum number of instructions to consider when looking for an
8810 instruction to fill a delay slot.  If more than this arbitrary number of
8811 instructions are searched, the time savings from filling the delay slot
8812 are minimal, so stop searching.  Increasing values mean more
8813 aggressive optimization, making the compilation time increase with probably
8814 small improvement in execution time.
8816 @item max-delay-slot-live-search
8817 When trying to fill delay slots, the maximum number of instructions to
8818 consider when searching for a block with valid live register
8819 information.  Increasing this arbitrarily chosen value means more
8820 aggressive optimization, increasing the compilation time.  This parameter
8821 should be removed when the delay slot code is rewritten to maintain the
8822 control-flow graph.
8824 @item max-gcse-memory
8825 The approximate maximum amount of memory that can be allocated in
8826 order to perform the global common subexpression elimination
8827 optimization.  If more memory than specified is required, the
8828 optimization is not done.
8830 @item max-gcse-insertion-ratio
8831 If the ratio of expression insertions to deletions is larger than this value
8832 for any expression, then RTL PRE inserts or removes the expression and thus
8833 leaves partially redundant computations in the instruction stream.  The default value is 20.
8835 @item max-pending-list-length
8836 The maximum number of pending dependencies scheduling allows
8837 before flushing the current state and starting over.  Large functions
8838 with few branches or calls can create excessively large lists which
8839 needlessly consume memory and resources.
8841 @item max-modulo-backtrack-attempts
8842 The maximum number of backtrack attempts the scheduler should make
8843 when modulo scheduling a loop.  Larger values can exponentially increase
8844 compilation time.
8846 @item max-inline-insns-single
8847 Several parameters control the tree inliner used in GCC@.
8848 This number sets the maximum number of instructions (counted in GCC's
8849 internal representation) in a single function that the tree inliner
8850 considers for inlining.  This only affects functions declared
8851 inline and methods implemented in a class declaration (C++).
8852 The default value is 400.
8854 @item max-inline-insns-auto
8855 When you use @option{-finline-functions} (included in @option{-O3}),
8856 a lot of functions that would otherwise not be considered for inlining
8857 by the compiler are investigated.  To those functions, a different
8858 (more restrictive) limit compared to functions declared inline can
8859 be applied.
8860 The default value is 40.
8862 @item inline-min-speedup
8863 When estimated performance improvement of caller + callee runtime exceeds this
8864 threshold (in precent), the function can be inlined regardless the limit on
8865 @option{--param max-inline-insns-single} and @option{--param
8866 max-inline-insns-auto}.
8868 @item large-function-insns
8869 The limit specifying really large functions.  For functions larger than this
8870 limit after inlining, inlining is constrained by
8871 @option{--param large-function-growth}.  This parameter is useful primarily
8872 to avoid extreme compilation time caused by non-linear algorithms used by the
8873 back end.
8874 The default value is 2700.
8876 @item large-function-growth
8877 Specifies maximal growth of large function caused by inlining in percents.
8878 The default value is 100 which limits large function growth to 2.0 times
8879 the original size.
8881 @item large-unit-insns
8882 The limit specifying large translation unit.  Growth caused by inlining of
8883 units larger than this limit is limited by @option{--param inline-unit-growth}.
8884 For small units this might be too tight.
8885 For example, consider a unit consisting of function A
8886 that is inline and B that just calls A three times.  If B is small relative to
8887 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8888 large units consisting of small inlineable functions, however, the overall unit
8889 growth limit is needed to avoid exponential explosion of code size.  Thus for
8890 smaller units, the size is increased to @option{--param large-unit-insns}
8891 before applying @option{--param inline-unit-growth}.  The default is 10000.
8893 @item inline-unit-growth
8894 Specifies maximal overall growth of the compilation unit caused by inlining.
8895 The default value is 20 which limits unit growth to 1.2 times the original
8896 size. Cold functions (either marked cold via an attribute or by profile
8897 feedback) are not accounted into the unit size.
8899 @item ipcp-unit-growth
8900 Specifies maximal overall growth of the compilation unit caused by
8901 interprocedural constant propagation.  The default value is 10 which limits
8902 unit growth to 1.1 times the original size.
8904 @item large-stack-frame
8905 The limit specifying large stack frames.  While inlining the algorithm is trying
8906 to not grow past this limit too much.  The default value is 256 bytes.
8908 @item large-stack-frame-growth
8909 Specifies maximal growth of large stack frames caused by inlining in percents.
8910 The default value is 1000 which limits large stack frame growth to 11 times
8911 the original size.
8913 @item max-inline-insns-recursive
8914 @itemx max-inline-insns-recursive-auto
8915 Specifies the maximum number of instructions an out-of-line copy of a
8916 self-recursive inline
8917 function can grow into by performing recursive inlining.
8919 @option{--param max-inline-insns-recursive} applies to functions
8920 declared inline.
8921 For functions not declared inline, recursive inlining
8922 happens only when @option{-finline-functions} (included in @option{-O3}) is
8923 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
8924 default value is 450.
8926 @item max-inline-recursive-depth
8927 @itemx max-inline-recursive-depth-auto
8928 Specifies the maximum recursion depth used for recursive inlining.
8930 @option{--param max-inline-recursive-depth} applies to functions
8931 declared inline.  For functions not declared inline, recursive inlining
8932 happens only when @option{-finline-functions} (included in @option{-O3}) is
8933 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
8934 default value is 8.
8936 @item min-inline-recursive-probability
8937 Recursive inlining is profitable only for function having deep recursion
8938 in average and can hurt for function having little recursion depth by
8939 increasing the prologue size or complexity of function body to other
8940 optimizers.
8942 When profile feedback is available (see @option{-fprofile-generate}) the actual
8943 recursion depth can be guessed from probability that function recurses via a
8944 given call expression.  This parameter limits inlining only to call expressions
8945 whose probability exceeds the given threshold (in percents).
8946 The default value is 10.
8948 @item early-inlining-insns
8949 Specify growth that the early inliner can make.  In effect it increases
8950 the amount of inlining for code having a large abstraction penalty.
8951 The default value is 14.
8953 @item max-early-inliner-iterations
8954 Limit of iterations of the early inliner.  This basically bounds
8955 the number of nested indirect calls the early inliner can resolve.
8956 Deeper chains are still handled by late inlining.
8958 @item comdat-sharing-probability
8959 Probability (in percent) that C++ inline function with comdat visibility
8960 are shared across multiple compilation units.  The default value is 20.
8962 @item profile-func-internal-id
8963 A parameter to control whether to use function internal id in profile
8964 database lookup. If the value is 0, the compiler uses an id that
8965 is based on function assembler name and filename, which makes old profile
8966 data more tolerant to source changes such as function reordering etc.
8967 The default value is 0.
8969 @item min-vect-loop-bound
8970 The minimum number of iterations under which loops are not vectorized
8971 when @option{-ftree-vectorize} is used.  The number of iterations after
8972 vectorization needs to be greater than the value specified by this option
8973 to allow vectorization.  The default value is 0.
8975 @item gcse-cost-distance-ratio
8976 Scaling factor in calculation of maximum distance an expression
8977 can be moved by GCSE optimizations.  This is currently supported only in the
8978 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8979 is with simple expressions, i.e., the expressions that have cost
8980 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
8981 hoisting of simple expressions.  The default value is 10.
8983 @item gcse-unrestricted-cost
8984 Cost, roughly measured as the cost of a single typical machine
8985 instruction, at which GCSE optimizations do not constrain
8986 the distance an expression can travel.  This is currently
8987 supported only in the code hoisting pass.  The lesser the cost,
8988 the more aggressive code hoisting is.  Specifying 0 
8989 allows all expressions to travel unrestricted distances.
8990 The default value is 3.
8992 @item max-hoist-depth
8993 The depth of search in the dominator tree for expressions to hoist.
8994 This is used to avoid quadratic behavior in hoisting algorithm.
8995 The value of 0 does not limit on the search, but may slow down compilation
8996 of huge functions.  The default value is 30.
8998 @item max-tail-merge-comparisons
8999 The maximum amount of similar bbs to compare a bb with.  This is used to
9000 avoid quadratic behavior in tree tail merging.  The default value is 10.
9002 @item max-tail-merge-iterations
9003 The maximum amount of iterations of the pass over the function.  This is used to
9004 limit compilation time in tree tail merging.  The default value is 2.
9006 @item max-unrolled-insns
9007 The maximum number of instructions that a loop may have to be unrolled.
9008 If a loop is unrolled, this parameter also determines how many times
9009 the loop code is unrolled.
9011 @item max-average-unrolled-insns
9012 The maximum number of instructions biased by probabilities of their execution
9013 that a loop may have to be unrolled.  If a loop is unrolled,
9014 this parameter also determines how many times the loop code is unrolled.
9016 @item max-unroll-times
9017 The maximum number of unrollings of a single loop.
9019 @item max-peeled-insns
9020 The maximum number of instructions that a loop may have to be peeled.
9021 If a loop is peeled, this parameter also determines how many times
9022 the loop code is peeled.
9024 @item max-peel-times
9025 The maximum number of peelings of a single loop.
9027 @item max-peel-branches
9028 The maximum number of branches on the hot path through the peeled sequence.
9030 @item max-completely-peeled-insns
9031 The maximum number of insns of a completely peeled loop.
9033 @item max-completely-peel-times
9034 The maximum number of iterations of a loop to be suitable for complete peeling.
9036 @item max-completely-peel-loop-nest-depth
9037 The maximum depth of a loop nest suitable for complete peeling.
9039 @item max-unswitch-insns
9040 The maximum number of insns of an unswitched loop.
9042 @item max-unswitch-level
9043 The maximum number of branches unswitched in a single loop.
9045 @item lim-expensive
9046 The minimum cost of an expensive expression in the loop invariant motion.
9048 @item iv-consider-all-candidates-bound
9049 Bound on number of candidates for induction variables, below which
9050 all candidates are considered for each use in induction variable
9051 optimizations.  If there are more candidates than this,
9052 only the most relevant ones are considered to avoid quadratic time complexity.
9054 @item iv-max-considered-uses
9055 The induction variable optimizations give up on loops that contain more
9056 induction variable uses.
9058 @item iv-always-prune-cand-set-bound
9059 If the number of candidates in the set is smaller than this value,
9060 always try to remove unnecessary ivs from the set
9061 when adding a new one.
9063 @item scev-max-expr-size
9064 Bound on size of expressions used in the scalar evolutions analyzer.
9065 Large expressions slow the analyzer.
9067 @item scev-max-expr-complexity
9068 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9069 Complex expressions slow the analyzer.
9071 @item max-tree-if-conversion-phi-args
9072 Maximum number of arguments in a PHI supported by TREE if conversion
9073 unless the loop is marked with simd pragma.
9075 @item vect-max-version-for-alignment-checks
9076 The maximum number of run-time checks that can be performed when
9077 doing loop versioning for alignment in the vectorizer.
9079 @item vect-max-version-for-alias-checks
9080 The maximum number of run-time checks that can be performed when
9081 doing loop versioning for alias in the vectorizer.
9083 @item vect-max-peeling-for-alignment
9084 The maximum number of loop peels to enhance access alignment
9085 for vectorizer. Value -1 means no limit.
9087 @item max-iterations-to-track
9088 The maximum number of iterations of a loop the brute-force algorithm
9089 for analysis of the number of iterations of the loop tries to evaluate.
9091 @item hot-bb-count-ws-permille
9092 A basic block profile count is considered hot if it contributes to 
9093 the given permillage (i.e. 0...1000) of the entire profiled execution.
9095 @item hot-bb-frequency-fraction
9096 Select fraction of the entry block frequency of executions of basic block in
9097 function given basic block needs to have to be considered hot.
9099 @item max-predicted-iterations
9100 The maximum number of loop iterations we predict statically.  This is useful
9101 in cases where a function contains a single loop with known bound and
9102 another loop with unknown bound.
9103 The known number of iterations is predicted correctly, while
9104 the unknown number of iterations average to roughly 10.  This means that the
9105 loop without bounds appears artificially cold relative to the other one.
9107 @item builtin-expect-probability
9108 Control the probability of the expression having the specified value. This
9109 parameter takes a percentage (i.e. 0 ... 100) as input.
9110 The default probability of 90 is obtained empirically.
9112 @item align-threshold
9114 Select fraction of the maximal frequency of executions of a basic block in
9115 a function to align the basic block.
9117 @item align-loop-iterations
9119 A loop expected to iterate at least the selected number of iterations is
9120 aligned.
9122 @item tracer-dynamic-coverage
9123 @itemx tracer-dynamic-coverage-feedback
9125 This value is used to limit superblock formation once the given percentage of
9126 executed instructions is covered.  This limits unnecessary code size
9127 expansion.
9129 The @option{tracer-dynamic-coverage-feedback} parameter
9130 is used only when profile
9131 feedback is available.  The real profiles (as opposed to statically estimated
9132 ones) are much less balanced allowing the threshold to be larger value.
9134 @item tracer-max-code-growth
9135 Stop tail duplication once code growth has reached given percentage.  This is
9136 a rather artificial limit, as most of the duplicates are eliminated later in
9137 cross jumping, so it may be set to much higher values than is the desired code
9138 growth.
9140 @item tracer-min-branch-ratio
9142 Stop reverse growth when the reverse probability of best edge is less than this
9143 threshold (in percent).
9145 @item tracer-min-branch-probability
9146 @itemx tracer-min-branch-probability-feedback
9148 Stop forward growth if the best edge has probability lower than this
9149 threshold.
9151 Similarly to @option{tracer-dynamic-coverage} two parameters are
9152 provided.  @option{tracer-min-branch-probability-feedback} is used for
9153 compilation with profile feedback and @option{tracer-min-branch-probability}
9154 compilation without.  The value for compilation with profile feedback
9155 needs to be more conservative (higher) in order to make tracer
9156 effective.
9158 @item max-cse-path-length
9160 The maximum number of basic blocks on path that CSE considers.
9161 The default is 10.
9163 @item max-cse-insns
9164 The maximum number of instructions CSE processes before flushing.
9165 The default is 1000.
9167 @item ggc-min-expand
9169 GCC uses a garbage collector to manage its own memory allocation.  This
9170 parameter specifies the minimum percentage by which the garbage
9171 collector's heap should be allowed to expand between collections.
9172 Tuning this may improve compilation speed; it has no effect on code
9173 generation.
9175 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9176 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9177 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9178 GCC is not able to calculate RAM on a particular platform, the lower
9179 bound of 30% is used.  Setting this parameter and
9180 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9181 every opportunity.  This is extremely slow, but can be useful for
9182 debugging.
9184 @item ggc-min-heapsize
9186 Minimum size of the garbage collector's heap before it begins bothering
9187 to collect garbage.  The first collection occurs after the heap expands
9188 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9189 tuning this may improve compilation speed, and has no effect on code
9190 generation.
9192 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9193 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9194 with a lower bound of 4096 (four megabytes) and an upper bound of
9195 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9196 particular platform, the lower bound is used.  Setting this parameter
9197 very large effectively disables garbage collection.  Setting this
9198 parameter and @option{ggc-min-expand} to zero causes a full collection
9199 to occur at every opportunity.
9201 @item max-reload-search-insns
9202 The maximum number of instruction reload should look backward for equivalent
9203 register.  Increasing values mean more aggressive optimization, making the
9204 compilation time increase with probably slightly better performance.
9205 The default value is 100.
9207 @item max-cselib-memory-locations
9208 The maximum number of memory locations cselib should take into account.
9209 Increasing values mean more aggressive optimization, making the compilation time
9210 increase with probably slightly better performance.  The default value is 500.
9212 @item max-sched-ready-insns
9213 The maximum number of instructions ready to be issued the scheduler should
9214 consider at any given time during the first scheduling pass.  Increasing
9215 values mean more thorough searches, making the compilation time increase
9216 with probably little benefit.  The default value is 100.
9218 @item max-sched-region-blocks
9219 The maximum number of blocks in a region to be considered for
9220 interblock scheduling.  The default value is 10.
9222 @item max-pipeline-region-blocks
9223 The maximum number of blocks in a region to be considered for
9224 pipelining in the selective scheduler.  The default value is 15.
9226 @item max-sched-region-insns
9227 The maximum number of insns in a region to be considered for
9228 interblock scheduling.  The default value is 100.
9230 @item max-pipeline-region-insns
9231 The maximum number of insns in a region to be considered for
9232 pipelining in the selective scheduler.  The default value is 200.
9234 @item min-spec-prob
9235 The minimum probability (in percents) of reaching a source block
9236 for interblock speculative scheduling.  The default value is 40.
9238 @item max-sched-extend-regions-iters
9239 The maximum number of iterations through CFG to extend regions.
9240 A value of 0 (the default) disables region extensions.
9242 @item max-sched-insn-conflict-delay
9243 The maximum conflict delay for an insn to be considered for speculative motion.
9244 The default value is 3.
9246 @item sched-spec-prob-cutoff
9247 The minimal probability of speculation success (in percents), so that
9248 speculative insns are scheduled.
9249 The default value is 40.
9251 @item sched-state-edge-prob-cutoff
9252 The minimum probability an edge must have for the scheduler to save its
9253 state across it.
9254 The default value is 10.
9256 @item sched-mem-true-dep-cost
9257 Minimal distance (in CPU cycles) between store and load targeting same
9258 memory locations.  The default value is 1.
9260 @item selsched-max-lookahead
9261 The maximum size of the lookahead window of selective scheduling.  It is a
9262 depth of search for available instructions.
9263 The default value is 50.
9265 @item selsched-max-sched-times
9266 The maximum number of times that an instruction is scheduled during
9267 selective scheduling.  This is the limit on the number of iterations
9268 through which the instruction may be pipelined.  The default value is 2.
9270 @item selsched-insns-to-rename
9271 The maximum number of best instructions in the ready list that are considered
9272 for renaming in the selective scheduler.  The default value is 2.
9274 @item sms-min-sc
9275 The minimum value of stage count that swing modulo scheduler
9276 generates.  The default value is 2.
9278 @item max-last-value-rtl
9279 The maximum size measured as number of RTLs that can be recorded in an expression
9280 in combiner for a pseudo register as last known value of that register.  The default
9281 is 10000.
9283 @item max-combine-insns
9284 The maximum number of instructions the RTL combiner tries to combine.
9285 The default value is 2 at @option{-Og} and 4 otherwise.
9287 @item integer-share-limit
9288 Small integer constants can use a shared data structure, reducing the
9289 compiler's memory usage and increasing its speed.  This sets the maximum
9290 value of a shared integer constant.  The default value is 256.
9292 @item ssp-buffer-size
9293 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9294 protection when @option{-fstack-protection} is used.
9296 @item min-size-for-stack-sharing
9297 The minimum size of variables taking part in stack slot sharing when not
9298 optimizing. The default value is 32.
9300 @item max-jump-thread-duplication-stmts
9301 Maximum number of statements allowed in a block that needs to be
9302 duplicated when threading jumps.
9304 @item max-fields-for-field-sensitive
9305 Maximum number of fields in a structure treated in
9306 a field sensitive manner during pointer analysis.  The default is zero
9307 for @option{-O0} and @option{-O1},
9308 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9310 @item prefetch-latency
9311 Estimate on average number of instructions that are executed before
9312 prefetch finishes.  The distance prefetched ahead is proportional
9313 to this constant.  Increasing this number may also lead to less
9314 streams being prefetched (see @option{simultaneous-prefetches}).
9316 @item simultaneous-prefetches
9317 Maximum number of prefetches that can run at the same time.
9319 @item l1-cache-line-size
9320 The size of cache line in L1 cache, in bytes.
9322 @item l1-cache-size
9323 The size of L1 cache, in kilobytes.
9325 @item l2-cache-size
9326 The size of L2 cache, in kilobytes.
9328 @item min-insn-to-prefetch-ratio
9329 The minimum ratio between the number of instructions and the
9330 number of prefetches to enable prefetching in a loop.
9332 @item prefetch-min-insn-to-mem-ratio
9333 The minimum ratio between the number of instructions and the
9334 number of memory references to enable prefetching in a loop.
9336 @item use-canonical-types
9337 Whether the compiler should use the ``canonical'' type system.  By
9338 default, this should always be 1, which uses a more efficient internal
9339 mechanism for comparing types in C++ and Objective-C++.  However, if
9340 bugs in the canonical type system are causing compilation failures,
9341 set this value to 0 to disable canonical types.
9343 @item switch-conversion-max-branch-ratio
9344 Switch initialization conversion refuses to create arrays that are
9345 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9346 branches in the switch.
9348 @item max-partial-antic-length
9349 Maximum length of the partial antic set computed during the tree
9350 partial redundancy elimination optimization (@option{-ftree-pre}) when
9351 optimizing at @option{-O3} and above.  For some sorts of source code
9352 the enhanced partial redundancy elimination optimization can run away,
9353 consuming all of the memory available on the host machine.  This
9354 parameter sets a limit on the length of the sets that are computed,
9355 which prevents the runaway behavior.  Setting a value of 0 for
9356 this parameter allows an unlimited set length.
9358 @item sccvn-max-scc-size
9359 Maximum size of a strongly connected component (SCC) during SCCVN
9360 processing.  If this limit is hit, SCCVN processing for the whole
9361 function is not done and optimizations depending on it are
9362 disabled.  The default maximum SCC size is 10000.
9364 @item sccvn-max-alias-queries-per-access
9365 Maximum number of alias-oracle queries we perform when looking for
9366 redundancies for loads and stores.  If this limit is hit the search
9367 is aborted and the load or store is not considered redundant.  The
9368 number of queries is algorithmically limited to the number of
9369 stores on all paths from the load to the function entry.
9370 The default maximum number of queries is 1000.
9372 @item ira-max-loops-num
9373 IRA uses regional register allocation by default.  If a function
9374 contains more loops than the number given by this parameter, only at most
9375 the given number of the most frequently-executed loops form regions
9376 for regional register allocation.  The default value of the
9377 parameter is 100.
9379 @item ira-max-conflict-table-size 
9380 Although IRA uses a sophisticated algorithm to compress the conflict
9381 table, the table can still require excessive amounts of memory for
9382 huge functions.  If the conflict table for a function could be more
9383 than the size in MB given by this parameter, the register allocator
9384 instead uses a faster, simpler, and lower-quality
9385 algorithm that does not require building a pseudo-register conflict table.  
9386 The default value of the parameter is 2000.
9388 @item ira-loop-reserved-regs
9389 IRA can be used to evaluate more accurate register pressure in loops
9390 for decisions to move loop invariants (see @option{-O3}).  The number
9391 of available registers reserved for some other purposes is given
9392 by this parameter.  The default value of the parameter is 2, which is
9393 the minimal number of registers needed by typical instructions.
9394 This value is the best found from numerous experiments.
9396 @item lra-inheritance-ebb-probability-cutoff
9397 LRA tries to reuse values reloaded in registers in subsequent insns.
9398 This optimization is called inheritance.  EBB is used as a region to
9399 do this optimization.  The parameter defines a minimal fall-through
9400 edge probability in percentage used to add BB to inheritance EBB in
9401 LRA.  The default value of the parameter is 40.  The value was chosen
9402 from numerous runs of SPEC2000 on x86-64.
9404 @item loop-invariant-max-bbs-in-loop
9405 Loop invariant motion can be very expensive, both in compilation time and
9406 in amount of needed compile-time memory, with very large loops.  Loops
9407 with more basic blocks than this parameter won't have loop invariant
9408 motion optimization performed on them.  The default value of the
9409 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9411 @item loop-max-datarefs-for-datadeps
9412 Building data dependencies is expensive for very large loops.  This
9413 parameter limits the number of data references in loops that are
9414 considered for data dependence analysis.  These large loops are no
9415 handled by the optimizations using loop data dependencies.
9416 The default value is 1000.
9418 @item max-vartrack-size
9419 Sets a maximum number of hash table slots to use during variable
9420 tracking dataflow analysis of any function.  If this limit is exceeded
9421 with variable tracking at assignments enabled, analysis for that
9422 function is retried without it, after removing all debug insns from
9423 the function.  If the limit is exceeded even without debug insns, var
9424 tracking analysis is completely disabled for the function.  Setting
9425 the parameter to zero makes it unlimited.
9427 @item max-vartrack-expr-depth
9428 Sets a maximum number of recursion levels when attempting to map
9429 variable names or debug temporaries to value expressions.  This trades
9430 compilation time for more complete debug information.  If this is set too
9431 low, value expressions that are available and could be represented in
9432 debug information may end up not being used; setting this higher may
9433 enable the compiler to find more complex debug expressions, but compile
9434 time and memory use may grow.  The default is 12.
9436 @item min-nondebug-insn-uid
9437 Use uids starting at this parameter for nondebug insns.  The range below
9438 the parameter is reserved exclusively for debug insns created by
9439 @option{-fvar-tracking-assignments}, but debug insns may get
9440 (non-overlapping) uids above it if the reserved range is exhausted.
9442 @item ipa-sra-ptr-growth-factor
9443 IPA-SRA replaces a pointer to an aggregate with one or more new
9444 parameters only when their cumulative size is less or equal to
9445 @option{ipa-sra-ptr-growth-factor} times the size of the original
9446 pointer parameter.
9448 @item sra-max-scalarization-size-Ospeed
9449 @item sra-max-scalarization-size-Osize
9450 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
9451 replace scalar parts of aggregates with uses of independent scalar
9452 variables.  These parameters control the maximum size, in storage units,
9453 of aggregate which is considered for replacement when compiling for
9454 speed
9455 (@option{sra-max-scalarization-size-Ospeed}) or size
9456 (@option{sra-max-scalarization-size-Osize}) respectively.
9458 @item tm-max-aggregate-size
9459 When making copies of thread-local variables in a transaction, this
9460 parameter specifies the size in bytes after which variables are
9461 saved with the logging functions as opposed to save/restore code
9462 sequence pairs.  This option only applies when using
9463 @option{-fgnu-tm}.
9465 @item graphite-max-nb-scop-params
9466 To avoid exponential effects in the Graphite loop transforms, the
9467 number of parameters in a Static Control Part (SCoP) is bounded.  The
9468 default value is 10 parameters.  A variable whose value is unknown at
9469 compilation time and defined outside a SCoP is a parameter of the SCoP.
9471 @item graphite-max-bbs-per-function
9472 To avoid exponential effects in the detection of SCoPs, the size of
9473 the functions analyzed by Graphite is bounded.  The default value is
9474 100 basic blocks.
9476 @item loop-block-tile-size
9477 Loop blocking or strip mining transforms, enabled with
9478 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9479 loop in the loop nest by a given number of iterations.  The strip
9480 length can be changed using the @option{loop-block-tile-size}
9481 parameter.  The default value is 51 iterations.
9483 @item loop-unroll-jam-size
9484 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
9485 default value is 4.
9487 @item loop-unroll-jam-depth
9488 Specify the dimension to be unrolled (counting from the most inner loop)
9489 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
9491 @item ipa-cp-value-list-size
9492 IPA-CP attempts to track all possible values and types passed to a function's
9493 parameter in order to propagate them and perform devirtualization.
9494 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9495 stores per one formal parameter of a function.
9497 @item ipa-cp-eval-threshold
9498 IPA-CP calculates its own score of cloning profitability heuristics
9499 and performs those cloning opportunities with scores that exceed
9500 @option{ipa-cp-eval-threshold}.
9502 @item ipa-cp-recursion-penalty
9503 Percentage penalty the recursive functions will receive when they
9504 are evaluated for cloning.
9506 @item ipa-cp-single-call-penalty
9507 Percentage penalty functions containg a single call to another
9508 function will receive when they are evaluated for cloning.
9511 @item ipa-max-agg-items
9512 IPA-CP is also capable to propagate a number of scalar values passed
9513 in an aggregate. @option{ipa-max-agg-items} controls the maximum
9514 number of such values per one parameter.
9516 @item ipa-cp-loop-hint-bonus
9517 When IPA-CP determines that a cloning candidate would make the number
9518 of iterations of a loop known, it adds a bonus of
9519 @option{ipa-cp-loop-hint-bonus} to the profitability score of
9520 the candidate.
9522 @item ipa-cp-array-index-hint-bonus
9523 When IPA-CP determines that a cloning candidate would make the index of
9524 an array access known, it adds a bonus of
9525 @option{ipa-cp-array-index-hint-bonus} to the profitability
9526 score of the candidate.
9528 @item ipa-max-aa-steps
9529 During its analysis of function bodies, IPA-CP employs alias analysis
9530 in order to track values pointed to by function parameters.  In order
9531 not spend too much time analyzing huge functions, it gives up and
9532 consider all memory clobbered after examining
9533 @option{ipa-max-aa-steps} statements modifying memory.
9535 @item lto-partitions
9536 Specify desired number of partitions produced during WHOPR compilation.
9537 The number of partitions should exceed the number of CPUs used for compilation.
9538 The default value is 32.
9540 @item lto-min-partition
9541 Size of minimal partition for WHOPR (in estimated instructions).
9542 This prevents expenses of splitting very small programs into too many
9543 partitions.
9545 @item lto-max-partition
9546 Size of max partition for WHOPR (in estimated instructions).
9547 to provide an upper bound for individual size of partition.
9548 Meant to be used only with balanced partitioning.
9550 @item cxx-max-namespaces-for-diagnostic-help
9551 The maximum number of namespaces to consult for suggestions when C++
9552 name lookup fails for an identifier.  The default is 1000.
9554 @item sink-frequency-threshold
9555 The maximum relative execution frequency (in percents) of the target block
9556 relative to a statement's original block to allow statement sinking of a
9557 statement.  Larger numbers result in more aggressive statement sinking.
9558 The default value is 75.  A small positive adjustment is applied for
9559 statements with memory operands as those are even more profitable so sink.
9561 @item max-stores-to-sink
9562 The maximum number of conditional store pairs that can be sunk.  Set to 0
9563 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9564 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9566 @item allow-store-data-races
9567 Allow optimizers to introduce new data races on stores.
9568 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9569 at optimization level @option{-Ofast}.
9571 @item case-values-threshold
9572 The smallest number of different values for which it is best to use a
9573 jump-table instead of a tree of conditional branches.  If the value is
9574 0, use the default for the machine.  The default is 0.
9576 @item tree-reassoc-width
9577 Set the maximum number of instructions executed in parallel in
9578 reassociated tree. This parameter overrides target dependent
9579 heuristics used by default if has non zero value.
9581 @item sched-pressure-algorithm
9582 Choose between the two available implementations of
9583 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9584 and is the more likely to prevent instructions from being reordered.
9585 Algorithm 2 was designed to be a compromise between the relatively
9586 conservative approach taken by algorithm 1 and the rather aggressive
9587 approach taken by the default scheduler.  It relies more heavily on
9588 having a regular register file and accurate register pressure classes.
9589 See @file{haifa-sched.c} in the GCC sources for more details.
9591 The default choice depends on the target.
9593 @item max-slsr-cand-scan
9594 Set the maximum number of existing candidates that are considered when
9595 seeking a basis for a new straight-line strength reduction candidate.
9597 @item asan-globals
9598 Enable buffer overflow detection for global objects.  This kind
9599 of protection is enabled by default if you are using
9600 @option{-fsanitize=address} option.
9601 To disable global objects protection use @option{--param asan-globals=0}.
9603 @item asan-stack
9604 Enable buffer overflow detection for stack objects.  This kind of
9605 protection is enabled by default when using @option{-fsanitize=address}.
9606 To disable stack protection use @option{--param asan-stack=0} option.
9608 @item asan-instrument-reads
9609 Enable buffer overflow detection for memory reads.  This kind of
9610 protection is enabled by default when using @option{-fsanitize=address}.
9611 To disable memory reads protection use
9612 @option{--param asan-instrument-reads=0}.
9614 @item asan-instrument-writes
9615 Enable buffer overflow detection for memory writes.  This kind of
9616 protection is enabled by default when using @option{-fsanitize=address}.
9617 To disable memory writes protection use
9618 @option{--param asan-instrument-writes=0} option.
9620 @item asan-memintrin
9621 Enable detection for built-in functions.  This kind of protection
9622 is enabled by default when using @option{-fsanitize=address}.
9623 To disable built-in functions protection use
9624 @option{--param asan-memintrin=0}.
9626 @item asan-use-after-return
9627 Enable detection of use-after-return.  This kind of protection
9628 is enabled by default when using @option{-fsanitize=address} option.
9629 To disable use-after-return detection use 
9630 @option{--param asan-use-after-return=0}.
9632 @item asan-instrumentation-with-call-threshold
9633 If number of memory accesses in function being instrumented
9634 is greater or equal to this number, use callbacks instead of inline checks.
9635 E.g. to disable inline code use
9636 @option{--param asan-instrumentation-with-call-threshold=0}.
9638 @item chkp-max-ctor-size
9639 Static constructors generated by Pointer Bounds Checker may become very
9640 large and significantly increase compile time at optimization level
9641 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
9642 in a single generated constructor.  Default value is 5000.
9644 @item max-fsm-thread-path-insns
9645 Maximum number of instructions to copy when duplicating blocks on a
9646 finite state automaton jump thread path.  The default is 100.
9648 @item max-fsm-thread-length
9649 Maximum number of basic blocks on a finite state automaton jump thread
9650 path.  The default is 10.
9652 @item max-fsm-thread-paths
9653 Maximum number of new jump thread paths to create for a finite state
9654 automaton.  The default is 50.
9656 @item parloops-chunk-size
9657 Chunk size of omp schedule for loops parallelized by parloops.  The default
9658 is 0.
9660 @item parloops-schedule
9661 Schedule type of omp schedule for loops parallelized by parloops (static,
9662 dynamic, guided, auto, runtime).  The default is static.
9664 @item max-ssa-name-query-depth
9665 Maximum depth of recursion when querying properties of SSA names in things
9666 like fold routines.  One level of recursion corresponds to following a
9667 use-def chain.
9669 @item hsa-gen-debug-stores
9670 Enable emission of special debug stores within HSA kernels which are
9671 then read and reported by libgomp plugin.  Generation of these stores
9672 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
9673 enable it.
9675 @item max-speculative-devirt-maydefs
9676 The maximum number of may-defs we analyze when looking for a must-def
9677 specifying the dynamic type of an object that invokes a virtual call
9678 we may be able to devirtualize speculatively.
9679 @end table
9680 @end table
9682 @node Instrumentation Options
9683 @section Program Instrumentation Options
9684 @cindex instrumentation options
9685 @cindex program instrumentation options
9686 @cindex run-time error checking options
9687 @cindex profiling options
9688 @cindex options, program instrumentation
9689 @cindex options, run-time error checking
9690 @cindex options, profiling
9692 GCC supports a number of command-line options that control adding
9693 run-time instrumentation to the code it normally generates.  
9694 For example, one purpose of instrumentation is collect profiling
9695 statistics for use in finding program hot spots, code coverage
9696 analysis, or profile-guided optimizations.
9697 Another class of program instrumentation is adding run-time checking 
9698 to detect programming errors like invalid pointer
9699 dereferences or out-of-bounds array accesses, as well as deliberately
9700 hostile attacks such as stack smashing or C++ vtable hijacking.
9701 There is also a general hook which can be used to implement other
9702 forms of tracing or function-level instrumentation for debug or
9703 program analysis purposes.
9705 @table @gcctabopt
9706 @cindex @command{prof}
9707 @item -p
9708 @opindex p
9709 Generate extra code to write profile information suitable for the
9710 analysis program @command{prof}.  You must use this option when compiling
9711 the source files you want data about, and you must also use it when
9712 linking.
9714 @cindex @command{gprof}
9715 @item -pg
9716 @opindex pg
9717 Generate extra code to write profile information suitable for the
9718 analysis program @command{gprof}.  You must use this option when compiling
9719 the source files you want data about, and you must also use it when
9720 linking.
9722 @item -fprofile-arcs
9723 @opindex fprofile-arcs
9724 Add code so that program flow @dfn{arcs} are instrumented.  During
9725 execution the program records how many times each branch and call is
9726 executed and how many times it is taken or returns.  When the compiled
9727 program exits it saves this data to a file called
9728 @file{@var{auxname}.gcda} for each source file.  The data may be used for
9729 profile-directed optimizations (@option{-fbranch-probabilities}), or for
9730 test coverage analysis (@option{-ftest-coverage}).  Each object file's
9731 @var{auxname} is generated from the name of the output file, if
9732 explicitly specified and it is not the final executable, otherwise it is
9733 the basename of the source file.  In both cases any suffix is removed
9734 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
9735 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
9736 @xref{Cross-profiling}.
9738 @cindex @command{gcov}
9739 @item --coverage
9740 @opindex coverage
9742 This option is used to compile and link code instrumented for coverage
9743 analysis.  The option is a synonym for @option{-fprofile-arcs}
9744 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
9745 linking).  See the documentation for those options for more details.
9747 @itemize
9749 @item
9750 Compile the source files with @option{-fprofile-arcs} plus optimization
9751 and code generation options.  For test coverage analysis, use the
9752 additional @option{-ftest-coverage} option.  You do not need to profile
9753 every source file in a program.
9755 @item
9756 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
9757 (the latter implies the former).
9759 @item
9760 Run the program on a representative workload to generate the arc profile
9761 information.  This may be repeated any number of times.  You can run
9762 concurrent instances of your program, and provided that the file system
9763 supports locking, the data files will be correctly updated.  Also
9764 @code{fork} calls are detected and correctly handled (double counting
9765 will not happen).
9767 @item
9768 For profile-directed optimizations, compile the source files again with
9769 the same optimization and code generation options plus
9770 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
9771 Control Optimization}).
9773 @item
9774 For test coverage analysis, use @command{gcov} to produce human readable
9775 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
9776 @command{gcov} documentation for further information.
9778 @end itemize
9780 With @option{-fprofile-arcs}, for each function of your program GCC
9781 creates a program flow graph, then finds a spanning tree for the graph.
9782 Only arcs that are not on the spanning tree have to be instrumented: the
9783 compiler adds code to count the number of times that these arcs are
9784 executed.  When an arc is the only exit or only entrance to a block, the
9785 instrumentation code can be added to the block; otherwise, a new basic
9786 block must be created to hold the instrumentation code.
9788 @need 2000
9789 @item -ftest-coverage
9790 @opindex ftest-coverage
9791 Produce a notes file that the @command{gcov} code-coverage utility
9792 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
9793 show program coverage.  Each source file's note file is called
9794 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
9795 above for a description of @var{auxname} and instructions on how to
9796 generate test coverage data.  Coverage data matches the source files
9797 more closely if you do not optimize.
9799 @item -fprofile-dir=@var{path}
9800 @opindex fprofile-dir
9802 Set the directory to search for the profile data files in to @var{path}.
9803 This option affects only the profile data generated by
9804 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9805 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9806 and its related options.  Both absolute and relative paths can be used.
9807 By default, GCC uses the current directory as @var{path}, thus the
9808 profile data file appears in the same directory as the object file.
9810 @item -fprofile-generate
9811 @itemx -fprofile-generate=@var{path}
9812 @opindex fprofile-generate
9814 Enable options usually used for instrumenting application to produce
9815 profile useful for later recompilation with profile feedback based
9816 optimization.  You must use @option{-fprofile-generate} both when
9817 compiling and when linking your program.
9819 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9821 If @var{path} is specified, GCC looks at the @var{path} to find
9822 the profile feedback data files. See @option{-fprofile-dir}.
9824 To optimize the program based on the collected profile information, use
9825 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
9827 @item -fsanitize=address
9828 @opindex fsanitize=address
9829 Enable AddressSanitizer, a fast memory error detector.
9830 Memory access instructions are instrumented to detect
9831 out-of-bounds and use-after-free bugs.
9832 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
9833 more details.  The run-time behavior can be influenced using the
9834 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
9835 the available options are shown at startup of the instrumented program.  See
9836 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
9837 for a list of supported options.
9839 @item -fsanitize=kernel-address
9840 @opindex fsanitize=kernel-address
9841 Enable AddressSanitizer for Linux kernel.
9842 See @uref{https://github.com/google/kasan/wiki} for more details.
9844 @item -fsanitize=thread
9845 @opindex fsanitize=thread
9846 Enable ThreadSanitizer, a fast data race detector.
9847 Memory access instructions are instrumented to detect
9848 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
9849 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
9850 environment variable; see
9851 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
9852 supported options.
9854 @item -fsanitize=leak
9855 @opindex fsanitize=leak
9856 Enable LeakSanitizer, a memory leak detector.
9857 This option only matters for linking of executables and if neither
9858 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
9859 case the executable is linked against a library that overrides @code{malloc}
9860 and other allocator functions.  See
9861 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
9862 details.  The run-time behavior can be influenced using the
9863 @env{LSAN_OPTIONS} environment variable.
9865 @item -fsanitize=undefined
9866 @opindex fsanitize=undefined
9867 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
9868 Various computations are instrumented to detect undefined behavior
9869 at runtime.  Current suboptions are:
9871 @table @gcctabopt
9873 @item -fsanitize=shift
9874 @opindex fsanitize=shift
9875 This option enables checking that the result of a shift operation is
9876 not undefined.  Note that what exactly is considered undefined differs
9877 slightly between C and C++, as well as between ISO C90 and C99, etc.
9879 @item -fsanitize=integer-divide-by-zero
9880 @opindex fsanitize=integer-divide-by-zero
9881 Detect integer division by zero as well as @code{INT_MIN / -1} division.
9883 @item -fsanitize=unreachable
9884 @opindex fsanitize=unreachable
9885 With this option, the compiler turns the @code{__builtin_unreachable}
9886 call into a diagnostics message call instead.  When reaching the
9887 @code{__builtin_unreachable} call, the behavior is undefined.
9889 @item -fsanitize=vla-bound
9890 @opindex fsanitize=vla-bound
9891 This option instructs the compiler to check that the size of a variable
9892 length array is positive.
9894 @item -fsanitize=null
9895 @opindex fsanitize=null
9896 This option enables pointer checking.  Particularly, the application
9897 built with this option turned on will issue an error message when it
9898 tries to dereference a NULL pointer, or if a reference (possibly an
9899 rvalue reference) is bound to a NULL pointer, or if a method is invoked
9900 on an object pointed by a NULL pointer.
9902 @item -fsanitize=return
9903 @opindex fsanitize=return
9904 This option enables return statement checking.  Programs
9905 built with this option turned on will issue an error message
9906 when the end of a non-void function is reached without actually
9907 returning a value.  This option works in C++ only.
9909 @item -fsanitize=signed-integer-overflow
9910 @opindex fsanitize=signed-integer-overflow
9911 This option enables signed integer overflow checking.  We check that
9912 the result of @code{+}, @code{*}, and both unary and binary @code{-}
9913 does not overflow in the signed arithmetics.  Note, integer promotion
9914 rules must be taken into account.  That is, the following is not an
9915 overflow:
9916 @smallexample
9917 signed char a = SCHAR_MAX;
9918 a++;
9919 @end smallexample
9921 @item -fsanitize=bounds
9922 @opindex fsanitize=bounds
9923 This option enables instrumentation of array bounds.  Various out of bounds
9924 accesses are detected.  Flexible array members, flexible array member-like
9925 arrays, and initializers of variables with static storage are not instrumented.
9927 @item -fsanitize=bounds-strict
9928 @opindex fsanitize=bounds-strict
9929 This option enables strict instrumentation of array bounds.  Most out of bounds
9930 accesses are detected, including flexible array members and flexible array
9931 member-like arrays.  Initializers of variables with static storage are not
9932 instrumented.
9934 @item -fsanitize=alignment
9935 @opindex fsanitize=alignment
9937 This option enables checking of alignment of pointers when they are
9938 dereferenced, or when a reference is bound to insufficiently aligned target,
9939 or when a method or constructor is invoked on insufficiently aligned object.
9941 @item -fsanitize=object-size
9942 @opindex fsanitize=object-size
9943 This option enables instrumentation of memory references using the
9944 @code{__builtin_object_size} function.  Various out of bounds pointer
9945 accesses are detected.
9947 @item -fsanitize=float-divide-by-zero
9948 @opindex fsanitize=float-divide-by-zero
9949 Detect floating-point division by zero.  Unlike other similar options,
9950 @option{-fsanitize=float-divide-by-zero} is not enabled by
9951 @option{-fsanitize=undefined}, since floating-point division by zero can
9952 be a legitimate way of obtaining infinities and NaNs.
9954 @item -fsanitize=float-cast-overflow
9955 @opindex fsanitize=float-cast-overflow
9956 This option enables floating-point type to integer conversion checking.
9957 We check that the result of the conversion does not overflow.
9958 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
9959 not enabled by @option{-fsanitize=undefined}.
9960 This option does not work well with @code{FE_INVALID} exceptions enabled.
9962 @item -fsanitize=nonnull-attribute
9963 @opindex fsanitize=nonnull-attribute
9965 This option enables instrumentation of calls, checking whether null values
9966 are not passed to arguments marked as requiring a non-null value by the
9967 @code{nonnull} function attribute.
9969 @item -fsanitize=returns-nonnull-attribute
9970 @opindex fsanitize=returns-nonnull-attribute
9972 This option enables instrumentation of return statements in functions
9973 marked with @code{returns_nonnull} function attribute, to detect returning
9974 of null values from such functions.
9976 @item -fsanitize=bool
9977 @opindex fsanitize=bool
9979 This option enables instrumentation of loads from bool.  If a value other
9980 than 0/1 is loaded, a run-time error is issued.
9982 @item -fsanitize=enum
9983 @opindex fsanitize=enum
9985 This option enables instrumentation of loads from an enum type.  If
9986 a value outside the range of values for the enum type is loaded,
9987 a run-time error is issued.
9989 @item -fsanitize=vptr
9990 @opindex fsanitize=vptr
9992 This option enables instrumentation of C++ member function calls, member
9993 accesses and some conversions between pointers to base and derived classes,
9994 to verify the referenced object has the correct dynamic type.
9996 @end table
9998 While @option{-ftrapv} causes traps for signed overflows to be emitted,
9999 @option{-fsanitize=undefined} gives a diagnostic message.
10000 This currently works only for the C family of languages.
10002 @item -fno-sanitize=all
10003 @opindex fno-sanitize=all
10005 This option disables all previously enabled sanitizers.
10006 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
10007 together.
10009 @item -fasan-shadow-offset=@var{number}
10010 @opindex fasan-shadow-offset
10011 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
10012 It is useful for experimenting with different shadow memory layouts in
10013 Kernel AddressSanitizer.
10015 @item -fsanitize-sections=@var{s1},@var{s2},...
10016 @opindex fsanitize-sections
10017 Sanitize global variables in selected user-defined sections.  @var{si} may
10018 contain wildcards.
10020 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
10021 @opindex fsanitize-recover
10022 @opindex fno-sanitize-recover
10023 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
10024 mentioned in comma-separated list of @var{opts}.  Enabling this option
10025 for a sanitizer component causes it to attempt to continue
10026 running the program as if no error happened.  This means multiple
10027 runtime errors can be reported in a single program run, and the exit
10028 code of the program may indicate success even when errors
10029 have been reported.  The @option{-fno-sanitize-recover=} option
10030 can be used to alter
10031 this behavior: only the first detected error is reported
10032 and program then exits with a non-zero exit code.
10034 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
10035 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
10036 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
10037 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
10038 For these sanitizers error recovery is turned on by default, except @option{-fsanitize=address},
10039 for which this feature is experimental.
10040 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
10041 accepted, the former enables recovery for all sanitizers that support it,
10042 the latter disables recovery for all sanitizers that support it.
10044 Even if a recovery mode is turned on the compiler side, it needs to be also
10045 enabled on the runtime library side, otherwise the failures are still fatal.
10046 The runtime library defaults to @code{halt_on_error=0} for
10047 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
10048 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
10049 setting the @code{halt_on_error} flag in the corresponding environment variable.
10051 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
10052 @smallexample
10053 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
10054 @end smallexample
10055 @noindent
10056 Similarly @option{-fno-sanitize-recover} is equivalent to
10057 @smallexample
10058 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
10059 @end smallexample
10061 @item -fsanitize-undefined-trap-on-error
10062 @opindex fsanitize-undefined-trap-on-error
10063 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
10064 report undefined behavior using @code{__builtin_trap} rather than
10065 a @code{libubsan} library routine.  The advantage of this is that the
10066 @code{libubsan} library is not needed and is not linked in, so this
10067 is usable even in freestanding environments.
10069 @item -fsanitize-coverage=trace-pc
10070 @opindex fsanitize-coverage=trace-pc
10071 Enable coverage-guided fuzzing code instrumentation.
10072 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
10074 @item -fbounds-check
10075 @opindex fbounds-check
10076 For front ends that support it, generate additional code to check that
10077 indices used to access arrays are within the declared range.  This is
10078 currently only supported by the Java and Fortran front ends, where
10079 this option defaults to true and false respectively.
10081 @item -fcheck-pointer-bounds
10082 @opindex fcheck-pointer-bounds
10083 @opindex fno-check-pointer-bounds
10084 @cindex Pointer Bounds Checker options
10085 Enable Pointer Bounds Checker instrumentation.  Each memory reference
10086 is instrumented with checks of the pointer used for memory access against
10087 bounds associated with that pointer.  
10089 Currently there
10090 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
10091 and @option{-mmpx} are required to enable this feature.  
10092 MPX-based instrumentation requires
10093 a runtime library to enable MPX in hardware and handle bounds
10094 violation signals.  By default when @option{-fcheck-pointer-bounds}
10095 and @option{-mmpx} options are used to link a program, the GCC driver
10096 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
10097 Bounds checking on calls to dynamic libraries requires a linker
10098 with @option{-z bndplt} support; if GCC was configured with a linker
10099 without support for this option (including the Gold linker and older
10100 versions of ld), a warning is given if you link with @option{-mmpx}
10101 without also specifying @option{-static}, since the overall effectiveness
10102 of the bounds checking protection is reduced.
10103 See also @option{-static-libmpxwrappers}.
10105 MPX-based instrumentation
10106 may be used for debugging and also may be included in production code
10107 to increase program security.  Depending on usage, you may
10108 have different requirements for the runtime library.  The current version
10109 of the MPX runtime library is more oriented for use as a debugging
10110 tool.  MPX runtime library usage implies @option{-lpthread}.  See
10111 also @option{-static-libmpx}.  The runtime library  behavior can be
10112 influenced using various @env{CHKP_RT_*} environment variables.  See
10113 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
10114 for more details.
10116 Generated instrumentation may be controlled by various
10117 @option{-fchkp-*} options and by the @code{bnd_variable_size}
10118 structure field attribute (@pxref{Type Attributes}) and
10119 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
10120 (@pxref{Function Attributes}).  GCC also provides a number of built-in
10121 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
10122 Bounds Checker builtins}, for more information.
10124 @item -fchkp-check-incomplete-type
10125 @opindex fchkp-check-incomplete-type
10126 @opindex fno-chkp-check-incomplete-type
10127 Generate pointer bounds checks for variables with incomplete type.
10128 Enabled by default.
10130 @item -fchkp-narrow-bounds
10131 @opindex fchkp-narrow-bounds
10132 @opindex fno-chkp-narrow-bounds
10133 Controls bounds used by Pointer Bounds Checker for pointers to object
10134 fields.  If narrowing is enabled then field bounds are used.  Otherwise
10135 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
10136 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
10138 @item -fchkp-first-field-has-own-bounds
10139 @opindex fchkp-first-field-has-own-bounds
10140 @opindex fno-chkp-first-field-has-own-bounds
10141 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
10142 first field in the structure.  By default a pointer to the first field has
10143 the same bounds as a pointer to the whole structure.
10145 @item -fchkp-narrow-to-innermost-array
10146 @opindex fchkp-narrow-to-innermost-array
10147 @opindex fno-chkp-narrow-to-innermost-array
10148 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
10149 case of nested static array access.  By default this option is disabled and
10150 bounds of the outermost array are used.
10152 @item -fchkp-optimize
10153 @opindex fchkp-optimize
10154 @opindex fno-chkp-optimize
10155 Enables Pointer Bounds Checker optimizations.  Enabled by default at
10156 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
10158 @item -fchkp-use-fast-string-functions
10159 @opindex fchkp-use-fast-string-functions
10160 @opindex fno-chkp-use-fast-string-functions
10161 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
10162 by Pointer Bounds Checker.  Disabled by default.
10164 @item -fchkp-use-nochk-string-functions
10165 @opindex fchkp-use-nochk-string-functions
10166 @opindex fno-chkp-use-nochk-string-functions
10167 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
10168 by Pointer Bounds Checker.  Disabled by default.
10170 @item -fchkp-use-static-bounds
10171 @opindex fchkp-use-static-bounds
10172 @opindex fno-chkp-use-static-bounds
10173 Allow Pointer Bounds Checker to generate static bounds holding
10174 bounds of static variables.  Enabled by default.
10176 @item -fchkp-use-static-const-bounds
10177 @opindex fchkp-use-static-const-bounds
10178 @opindex fno-chkp-use-static-const-bounds
10179 Use statically-initialized bounds for constant bounds instead of
10180 generating them each time they are required.  By default enabled when
10181 @option{-fchkp-use-static-bounds} is enabled.
10183 @item -fchkp-treat-zero-dynamic-size-as-infinite
10184 @opindex fchkp-treat-zero-dynamic-size-as-infinite
10185 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
10186 With this option, objects with incomplete type whose
10187 dynamically-obtained size is zero are treated as having infinite size
10188 instead by Pointer Bounds
10189 Checker.  This option may be helpful if a program is linked with a library
10190 missing size information for some symbols.  Disabled by default.
10192 @item -fchkp-check-read
10193 @opindex fchkp-check-read
10194 @opindex fno-chkp-check-read
10195 Instructs Pointer Bounds Checker to generate checks for all read
10196 accesses to memory.  Enabled by default.
10198 @item -fchkp-check-write
10199 @opindex fchkp-check-write
10200 @opindex fno-chkp-check-write
10201 Instructs Pointer Bounds Checker to generate checks for all write
10202 accesses to memory.  Enabled by default.
10204 @item -fchkp-store-bounds
10205 @opindex fchkp-store-bounds
10206 @opindex fno-chkp-store-bounds
10207 Instructs Pointer Bounds Checker to generate bounds stores for
10208 pointer writes.  Enabled by default.
10210 @item -fchkp-instrument-calls
10211 @opindex fchkp-instrument-calls
10212 @opindex fno-chkp-instrument-calls
10213 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
10214 Enabled by default.
10216 @item -fchkp-instrument-marked-only
10217 @opindex fchkp-instrument-marked-only
10218 @opindex fno-chkp-instrument-marked-only
10219 Instructs Pointer Bounds Checker to instrument only functions
10220 marked with the @code{bnd_instrument} attribute
10221 (@pxref{Function Attributes}).  Disabled by default.
10223 @item -fchkp-use-wrappers
10224 @opindex fchkp-use-wrappers
10225 @opindex fno-chkp-use-wrappers
10226 Allows Pointer Bounds Checker to replace calls to built-in functions
10227 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
10228 is used to link a program, the GCC driver automatically links
10229 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
10230 Enabled by default.
10232 @item -fstack-protector
10233 @opindex fstack-protector
10234 Emit extra code to check for buffer overflows, such as stack smashing
10235 attacks.  This is done by adding a guard variable to functions with
10236 vulnerable objects.  This includes functions that call @code{alloca}, and
10237 functions with buffers larger than 8 bytes.  The guards are initialized
10238 when a function is entered and then checked when the function exits.
10239 If a guard check fails, an error message is printed and the program exits.
10241 @item -fstack-protector-all
10242 @opindex fstack-protector-all
10243 Like @option{-fstack-protector} except that all functions are protected.
10245 @item -fstack-protector-strong
10246 @opindex fstack-protector-strong
10247 Like @option{-fstack-protector} but includes additional functions to
10248 be protected --- those that have local array definitions, or have
10249 references to local frame addresses.
10251 @item -fstack-protector-explicit
10252 @opindex fstack-protector-explicit
10253 Like @option{-fstack-protector} but only protects those functions which
10254 have the @code{stack_protect} attribute.
10256 @item -fstack-check
10257 @opindex fstack-check
10258 Generate code to verify that you do not go beyond the boundary of the
10259 stack.  You should specify this flag if you are running in an
10260 environment with multiple threads, but you only rarely need to specify it in
10261 a single-threaded environment since stack overflow is automatically
10262 detected on nearly all systems if there is only one stack.
10264 Note that this switch does not actually cause checking to be done; the
10265 operating system or the language runtime must do that.  The switch causes
10266 generation of code to ensure that they see the stack being extended.
10268 You can additionally specify a string parameter: @samp{no} means no
10269 checking, @samp{generic} means force the use of old-style checking,
10270 @samp{specific} means use the best checking method and is equivalent
10271 to bare @option{-fstack-check}.
10273 Old-style checking is a generic mechanism that requires no specific
10274 target support in the compiler but comes with the following drawbacks:
10276 @enumerate
10277 @item
10278 Modified allocation strategy for large objects: they are always
10279 allocated dynamically if their size exceeds a fixed threshold.
10281 @item
10282 Fixed limit on the size of the static frame of functions: when it is
10283 topped by a particular function, stack checking is not reliable and
10284 a warning is issued by the compiler.
10286 @item
10287 Inefficiency: because of both the modified allocation strategy and the
10288 generic implementation, code performance is hampered.
10289 @end enumerate
10291 Note that old-style stack checking is also the fallback method for
10292 @samp{specific} if no target support has been added in the compiler.
10294 @item -fstack-limit-register=@var{reg}
10295 @itemx -fstack-limit-symbol=@var{sym}
10296 @itemx -fno-stack-limit
10297 @opindex fstack-limit-register
10298 @opindex fstack-limit-symbol
10299 @opindex fno-stack-limit
10300 Generate code to ensure that the stack does not grow beyond a certain value,
10301 either the value of a register or the address of a symbol.  If a larger
10302 stack is required, a signal is raised at run time.  For most targets,
10303 the signal is raised before the stack overruns the boundary, so
10304 it is possible to catch the signal without taking special precautions.
10306 For instance, if the stack starts at absolute address @samp{0x80000000}
10307 and grows downwards, you can use the flags
10308 @option{-fstack-limit-symbol=__stack_limit} and
10309 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10310 of 128KB@.  Note that this may only work with the GNU linker.
10312 You can locally override stack limit checking by using the
10313 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
10315 @item -fsplit-stack
10316 @opindex fsplit-stack
10317 Generate code to automatically split the stack before it overflows.
10318 The resulting program has a discontiguous stack which can only
10319 overflow if the program is unable to allocate any more memory.  This
10320 is most useful when running threaded programs, as it is no longer
10321 necessary to calculate a good stack size to use for each thread.  This
10322 is currently only implemented for the x86 targets running
10323 GNU/Linux.
10325 When code compiled with @option{-fsplit-stack} calls code compiled
10326 without @option{-fsplit-stack}, there may not be much stack space
10327 available for the latter code to run.  If compiling all code,
10328 including library code, with @option{-fsplit-stack} is not an option,
10329 then the linker can fix up these calls so that the code compiled
10330 without @option{-fsplit-stack} always has a large stack.  Support for
10331 this is implemented in the gold linker in GNU binutils release 2.21
10332 and later.
10334 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
10335 @opindex fvtable-verify
10336 This option is only available when compiling C++ code.
10337 It turns on (or off, if using @option{-fvtable-verify=none}) the security
10338 feature that verifies at run time, for every virtual call, that
10339 the vtable pointer through which the call is made is valid for the type of
10340 the object, and has not been corrupted or overwritten.  If an invalid vtable
10341 pointer is detected at run time, an error is reported and execution of the
10342 program is immediately halted.
10344 This option causes run-time data structures to be built at program startup,
10345 which are used for verifying the vtable pointers.  
10346 The options @samp{std} and @samp{preinit}
10347 control the timing of when these data structures are built.  In both cases the
10348 data structures are built before execution reaches @code{main}.  Using
10349 @option{-fvtable-verify=std} causes the data structures to be built after
10350 shared libraries have been loaded and initialized.
10351 @option{-fvtable-verify=preinit} causes them to be built before shared
10352 libraries have been loaded and initialized.
10354 If this option appears multiple times in the command line with different
10355 values specified, @samp{none} takes highest priority over both @samp{std} and
10356 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
10358 @item -fvtv-debug
10359 @opindex fvtv-debug
10360 When used in conjunction with @option{-fvtable-verify=std} or 
10361 @option{-fvtable-verify=preinit}, causes debug versions of the 
10362 runtime functions for the vtable verification feature to be called.  
10363 This flag also causes the compiler to log information about which 
10364 vtable pointers it finds for each class.
10365 This information is written to a file named @file{vtv_set_ptr_data.log} 
10366 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
10367 if that is defined or the current working directory otherwise.
10369 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
10370 file, be sure to delete any existing one.
10372 @item -fvtv-counts
10373 @opindex fvtv-counts
10374 This is a debugging flag.  When used in conjunction with
10375 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
10376 causes the compiler to keep track of the total number of virtual calls
10377 it encounters and the number of verifications it inserts.  It also
10378 counts the number of calls to certain run-time library functions
10379 that it inserts and logs this information for each compilation unit.
10380 The compiler writes this information to a file named
10381 @file{vtv_count_data.log} in the directory named by the environment
10382 variable @env{VTV_LOGS_DIR} if that is defined or the current working
10383 directory otherwise.  It also counts the size of the vtable pointer sets
10384 for each class, and writes this information to @file{vtv_class_set_sizes.log}
10385 in the same directory.
10387 Note:  This feature @emph{appends} data to the log files.  To get fresh log
10388 files, be sure to delete any existing ones.
10390 @item -finstrument-functions
10391 @opindex finstrument-functions
10392 Generate instrumentation calls for entry and exit to functions.  Just
10393 after function entry and just before function exit, the following
10394 profiling functions are called with the address of the current
10395 function and its call site.  (On some platforms,
10396 @code{__builtin_return_address} does not work beyond the current
10397 function, so the call site information may not be available to the
10398 profiling functions otherwise.)
10400 @smallexample
10401 void __cyg_profile_func_enter (void *this_fn,
10402                                void *call_site);
10403 void __cyg_profile_func_exit  (void *this_fn,
10404                                void *call_site);
10405 @end smallexample
10407 The first argument is the address of the start of the current function,
10408 which may be looked up exactly in the symbol table.
10410 This instrumentation is also done for functions expanded inline in other
10411 functions.  The profiling calls indicate where, conceptually, the
10412 inline function is entered and exited.  This means that addressable
10413 versions of such functions must be available.  If all your uses of a
10414 function are expanded inline, this may mean an additional expansion of
10415 code size.  If you use @code{extern inline} in your C code, an
10416 addressable version of such functions must be provided.  (This is
10417 normally the case anyway, but if you get lucky and the optimizer always
10418 expands the functions inline, you might have gotten away without
10419 providing static copies.)
10421 A function may be given the attribute @code{no_instrument_function}, in
10422 which case this instrumentation is not done.  This can be used, for
10423 example, for the profiling functions listed above, high-priority
10424 interrupt routines, and any functions from which the profiling functions
10425 cannot safely be called (perhaps signal handlers, if the profiling
10426 routines generate output or allocate memory).
10428 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
10429 @opindex finstrument-functions-exclude-file-list
10431 Set the list of functions that are excluded from instrumentation (see
10432 the description of @option{-finstrument-functions}).  If the file that
10433 contains a function definition matches with one of @var{file}, then
10434 that function is not instrumented.  The match is done on substrings:
10435 if the @var{file} parameter is a substring of the file name, it is
10436 considered to be a match.
10438 For example:
10440 @smallexample
10441 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
10442 @end smallexample
10444 @noindent
10445 excludes any inline function defined in files whose pathnames
10446 contain @file{/bits/stl} or @file{include/sys}.
10448 If, for some reason, you want to include letter @samp{,} in one of
10449 @var{sym}, write @samp{\,}. For example,
10450 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
10451 (note the single quote surrounding the option).
10453 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
10454 @opindex finstrument-functions-exclude-function-list
10456 This is similar to @option{-finstrument-functions-exclude-file-list},
10457 but this option sets the list of function names to be excluded from
10458 instrumentation.  The function name to be matched is its user-visible
10459 name, such as @code{vector<int> blah(const vector<int> &)}, not the
10460 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
10461 match is done on substrings: if the @var{sym} parameter is a substring
10462 of the function name, it is considered to be a match.  For C99 and C++
10463 extended identifiers, the function name must be given in UTF-8, not
10464 using universal character names.
10466 @end table
10469 @node Preprocessor Options
10470 @section Options Controlling the Preprocessor
10471 @cindex preprocessor options
10472 @cindex options, preprocessor
10474 These options control the C preprocessor, which is run on each C source
10475 file before actual compilation.
10477 If you use the @option{-E} option, nothing is done except preprocessing.
10478 Some of these options make sense only together with @option{-E} because
10479 they cause the preprocessor output to be unsuitable for actual
10480 compilation.
10482 @table @gcctabopt
10483 @item -Wp,@var{option}
10484 @opindex Wp
10485 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10486 and pass @var{option} directly through to the preprocessor.  If
10487 @var{option} contains commas, it is split into multiple options at the
10488 commas.  However, many options are modified, translated or interpreted
10489 by the compiler driver before being passed to the preprocessor, and
10490 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10491 interface is undocumented and subject to change, so whenever possible
10492 you should avoid using @option{-Wp} and let the driver handle the
10493 options instead.
10495 @item -Xpreprocessor @var{option}
10496 @opindex Xpreprocessor
10497 Pass @var{option} as an option to the preprocessor.  You can use this to
10498 supply system-specific preprocessor options that GCC does not 
10499 recognize.
10501 If you want to pass an option that takes an argument, you must use
10502 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10504 @item -no-integrated-cpp
10505 @opindex no-integrated-cpp
10506 Perform preprocessing as a separate pass before compilation.
10507 By default, GCC performs preprocessing as an integrated part of
10508 input tokenization and parsing.
10509 If this option is provided, the appropriate language front end
10510 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10511 and Objective-C, respectively) is instead invoked twice,
10512 once for preprocessing only and once for actual compilation
10513 of the preprocessed input.
10514 This option may be useful in conjunction with the @option{-B} or
10515 @option{-wrapper} options to specify an alternate preprocessor or
10516 perform additional processing of the program source between
10517 normal preprocessing and compilation.
10518 @end table
10520 @include cppopts.texi
10522 @node Assembler Options
10523 @section Passing Options to the Assembler
10525 @c prevent bad page break with this line
10526 You can pass options to the assembler.
10528 @table @gcctabopt
10529 @item -Wa,@var{option}
10530 @opindex Wa
10531 Pass @var{option} as an option to the assembler.  If @var{option}
10532 contains commas, it is split into multiple options at the commas.
10534 @item -Xassembler @var{option}
10535 @opindex Xassembler
10536 Pass @var{option} as an option to the assembler.  You can use this to
10537 supply system-specific assembler options that GCC does not
10538 recognize.
10540 If you want to pass an option that takes an argument, you must use
10541 @option{-Xassembler} twice, once for the option and once for the argument.
10543 @end table
10545 @node Link Options
10546 @section Options for Linking
10547 @cindex link options
10548 @cindex options, linking
10550 These options come into play when the compiler links object files into
10551 an executable output file.  They are meaningless if the compiler is
10552 not doing a link step.
10554 @table @gcctabopt
10555 @cindex file names
10556 @item @var{object-file-name}
10557 A file name that does not end in a special recognized suffix is
10558 considered to name an object file or library.  (Object files are
10559 distinguished from libraries by the linker according to the file
10560 contents.)  If linking is done, these object files are used as input
10561 to the linker.
10563 @item -c
10564 @itemx -S
10565 @itemx -E
10566 @opindex c
10567 @opindex S
10568 @opindex E
10569 If any of these options is used, then the linker is not run, and
10570 object file names should not be used as arguments.  @xref{Overall
10571 Options}.
10573 @item -fuse-ld=bfd
10574 @opindex fuse-ld=bfd
10575 Use the @command{bfd} linker instead of the default linker.
10577 @item -fuse-ld=gold
10578 @opindex fuse-ld=gold
10579 Use the @command{gold} linker instead of the default linker.
10581 @cindex Libraries
10582 @item -l@var{library}
10583 @itemx -l @var{library}
10584 @opindex l
10585 Search the library named @var{library} when linking.  (The second
10586 alternative with the library as a separate argument is only for
10587 POSIX compliance and is not recommended.)
10589 It makes a difference where in the command you write this option; the
10590 linker searches and processes libraries and object files in the order they
10591 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10592 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10593 to functions in @samp{z}, those functions may not be loaded.
10595 The linker searches a standard list of directories for the library,
10596 which is actually a file named @file{lib@var{library}.a}.  The linker
10597 then uses this file as if it had been specified precisely by name.
10599 The directories searched include several standard system directories
10600 plus any that you specify with @option{-L}.
10602 Normally the files found this way are library files---archive files
10603 whose members are object files.  The linker handles an archive file by
10604 scanning through it for members which define symbols that have so far
10605 been referenced but not defined.  But if the file that is found is an
10606 ordinary object file, it is linked in the usual fashion.  The only
10607 difference between using an @option{-l} option and specifying a file name
10608 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10609 and searches several directories.
10611 @item -lobjc
10612 @opindex lobjc
10613 You need this special case of the @option{-l} option in order to
10614 link an Objective-C or Objective-C++ program.
10616 @item -nostartfiles
10617 @opindex nostartfiles
10618 Do not use the standard system startup files when linking.
10619 The standard system libraries are used normally, unless @option{-nostdlib}
10620 or @option{-nodefaultlibs} is used.
10622 @item -nodefaultlibs
10623 @opindex nodefaultlibs
10624 Do not use the standard system libraries when linking.
10625 Only the libraries you specify are passed to the linker, and options
10626 specifying linkage of the system libraries, such as @option{-static-libgcc}
10627 or @option{-shared-libgcc}, are ignored.  
10628 The standard startup files are used normally, unless @option{-nostartfiles}
10629 is used.  
10631 The compiler may generate calls to @code{memcmp},
10632 @code{memset}, @code{memcpy} and @code{memmove}.
10633 These entries are usually resolved by entries in
10634 libc.  These entry points should be supplied through some other
10635 mechanism when this option is specified.
10637 @item -nostdlib
10638 @opindex nostdlib
10639 Do not use the standard system startup files or libraries when linking.
10640 No startup files and only the libraries you specify are passed to
10641 the linker, and options specifying linkage of the system libraries, such as
10642 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
10644 The compiler may generate calls to @code{memcmp}, @code{memset},
10645 @code{memcpy} and @code{memmove}.
10646 These entries are usually resolved by entries in
10647 libc.  These entry points should be supplied through some other
10648 mechanism when this option is specified.
10650 @cindex @option{-lgcc}, use with @option{-nostdlib}
10651 @cindex @option{-nostdlib} and unresolved references
10652 @cindex unresolved references and @option{-nostdlib}
10653 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10654 @cindex @option{-nodefaultlibs} and unresolved references
10655 @cindex unresolved references and @option{-nodefaultlibs}
10656 One of the standard libraries bypassed by @option{-nostdlib} and
10657 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10658 which GCC uses to overcome shortcomings of particular machines, or special
10659 needs for some languages.
10660 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10661 Collection (GCC) Internals},
10662 for more discussion of @file{libgcc.a}.)
10663 In most cases, you need @file{libgcc.a} even when you want to avoid
10664 other standard libraries.  In other words, when you specify @option{-nostdlib}
10665 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10666 This ensures that you have no unresolved references to internal GCC
10667 library subroutines.
10668 (An example of such an internal subroutine is @code{__main}, used to ensure C++
10669 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10670 GNU Compiler Collection (GCC) Internals}.)
10672 @item -pie
10673 @opindex pie
10674 Produce a position independent executable on targets that support it.
10675 For predictable results, you must also specify the same set of options
10676 used for compilation (@option{-fpie}, @option{-fPIE},
10677 or model suboptions) when you specify this linker option.
10679 @item -no-pie
10680 @opindex no-pie
10681 Don't produce a position independent executable.
10683 @item -rdynamic
10684 @opindex rdynamic
10685 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10686 that support it. This instructs the linker to add all symbols, not
10687 only used ones, to the dynamic symbol table. This option is needed
10688 for some uses of @code{dlopen} or to allow obtaining backtraces
10689 from within a program.
10691 @item -s
10692 @opindex s
10693 Remove all symbol table and relocation information from the executable.
10695 @item -static
10696 @opindex static
10697 On systems that support dynamic linking, this prevents linking with the shared
10698 libraries.  On other systems, this option has no effect.
10700 @item -shared
10701 @opindex shared
10702 Produce a shared object which can then be linked with other objects to
10703 form an executable.  Not all systems support this option.  For predictable
10704 results, you must also specify the same set of options used for compilation
10705 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10706 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10707 needs to build supplementary stub code for constructors to work.  On
10708 multi-libbed systems, @samp{gcc -shared} must select the correct support
10709 libraries to link against.  Failing to supply the correct flags may lead
10710 to subtle defects.  Supplying them in cases where they are not necessary
10711 is innocuous.}
10713 @item -shared-libgcc
10714 @itemx -static-libgcc
10715 @opindex shared-libgcc
10716 @opindex static-libgcc
10717 On systems that provide @file{libgcc} as a shared library, these options
10718 force the use of either the shared or static version, respectively.
10719 If no shared version of @file{libgcc} was built when the compiler was
10720 configured, these options have no effect.
10722 There are several situations in which an application should use the
10723 shared @file{libgcc} instead of the static version.  The most common
10724 of these is when the application wishes to throw and catch exceptions
10725 across different shared libraries.  In that case, each of the libraries
10726 as well as the application itself should use the shared @file{libgcc}.
10728 Therefore, the G++ and GCJ drivers automatically add
10729 @option{-shared-libgcc} whenever you build a shared library or a main
10730 executable, because C++ and Java programs typically use exceptions, so
10731 this is the right thing to do.
10733 If, instead, you use the GCC driver to create shared libraries, you may
10734 find that they are not always linked with the shared @file{libgcc}.
10735 If GCC finds, at its configuration time, that you have a non-GNU linker
10736 or a GNU linker that does not support option @option{--eh-frame-hdr},
10737 it links the shared version of @file{libgcc} into shared libraries
10738 by default.  Otherwise, it takes advantage of the linker and optimizes
10739 away the linking with the shared version of @file{libgcc}, linking with
10740 the static version of libgcc by default.  This allows exceptions to
10741 propagate through such shared libraries, without incurring relocation
10742 costs at library load time.
10744 However, if a library or main executable is supposed to throw or catch
10745 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10746 for the languages used in the program, or using the option
10747 @option{-shared-libgcc}, such that it is linked with the shared
10748 @file{libgcc}.
10750 @item -static-libasan
10751 @opindex static-libasan
10752 When the @option{-fsanitize=address} option is used to link a program,
10753 the GCC driver automatically links against @option{libasan}.  If
10754 @file{libasan} is available as a shared library, and the @option{-static}
10755 option is not used, then this links against the shared version of
10756 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10757 driver to link @file{libasan} statically, without necessarily linking
10758 other libraries statically.
10760 @item -static-libtsan
10761 @opindex static-libtsan
10762 When the @option{-fsanitize=thread} option is used to link a program,
10763 the GCC driver automatically links against @option{libtsan}.  If
10764 @file{libtsan} is available as a shared library, and the @option{-static}
10765 option is not used, then this links against the shared version of
10766 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10767 driver to link @file{libtsan} statically, without necessarily linking
10768 other libraries statically.
10770 @item -static-liblsan
10771 @opindex static-liblsan
10772 When the @option{-fsanitize=leak} option is used to link a program,
10773 the GCC driver automatically links against @option{liblsan}.  If
10774 @file{liblsan} is available as a shared library, and the @option{-static}
10775 option is not used, then this links against the shared version of
10776 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10777 driver to link @file{liblsan} statically, without necessarily linking
10778 other libraries statically.
10780 @item -static-libubsan
10781 @opindex static-libubsan
10782 When the @option{-fsanitize=undefined} option is used to link a program,
10783 the GCC driver automatically links against @option{libubsan}.  If
10784 @file{libubsan} is available as a shared library, and the @option{-static}
10785 option is not used, then this links against the shared version of
10786 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10787 driver to link @file{libubsan} statically, without necessarily linking
10788 other libraries statically.
10790 @item -static-libmpx
10791 @opindex static-libmpx
10792 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
10793 used to link a program, the GCC driver automatically links against
10794 @file{libmpx}.  If @file{libmpx} is available as a shared library,
10795 and the @option{-static} option is not used, then this links against
10796 the shared version of @file{libmpx}.  The @option{-static-libmpx}
10797 option directs the GCC driver to link @file{libmpx} statically,
10798 without necessarily linking other libraries statically.
10800 @item -static-libmpxwrappers
10801 @opindex static-libmpxwrappers
10802 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
10803 to link a program without also using @option{-fno-chkp-use-wrappers}, the
10804 GCC driver automatically links against @file{libmpxwrappers}.  If
10805 @file{libmpxwrappers} is available as a shared library, and the
10806 @option{-static} option is not used, then this links against the shared
10807 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
10808 option directs the GCC driver to link @file{libmpxwrappers} statically,
10809 without necessarily linking other libraries statically.
10811 @item -static-libstdc++
10812 @opindex static-libstdc++
10813 When the @command{g++} program is used to link a C++ program, it
10814 normally automatically links against @option{libstdc++}.  If
10815 @file{libstdc++} is available as a shared library, and the
10816 @option{-static} option is not used, then this links against the
10817 shared version of @file{libstdc++}.  That is normally fine.  However, it
10818 is sometimes useful to freeze the version of @file{libstdc++} used by
10819 the program without going all the way to a fully static link.  The
10820 @option{-static-libstdc++} option directs the @command{g++} driver to
10821 link @file{libstdc++} statically, without necessarily linking other
10822 libraries statically.
10824 @item -symbolic
10825 @opindex symbolic
10826 Bind references to global symbols when building a shared object.  Warn
10827 about any unresolved references (unless overridden by the link editor
10828 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10829 this option.
10831 @item -T @var{script}
10832 @opindex T
10833 @cindex linker script
10834 Use @var{script} as the linker script.  This option is supported by most
10835 systems using the GNU linker.  On some targets, such as bare-board
10836 targets without an operating system, the @option{-T} option may be required
10837 when linking to avoid references to undefined symbols.
10839 @item -Xlinker @var{option}
10840 @opindex Xlinker
10841 Pass @var{option} as an option to the linker.  You can use this to
10842 supply system-specific linker options that GCC does not recognize.
10844 If you want to pass an option that takes a separate argument, you must use
10845 @option{-Xlinker} twice, once for the option and once for the argument.
10846 For example, to pass @option{-assert definitions}, you must write
10847 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10848 @option{-Xlinker "-assert definitions"}, because this passes the entire
10849 string as a single argument, which is not what the linker expects.
10851 When using the GNU linker, it is usually more convenient to pass
10852 arguments to linker options using the @option{@var{option}=@var{value}}
10853 syntax than as separate arguments.  For example, you can specify
10854 @option{-Xlinker -Map=output.map} rather than
10855 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10856 this syntax for command-line options.
10858 @item -Wl,@var{option}
10859 @opindex Wl
10860 Pass @var{option} as an option to the linker.  If @var{option} contains
10861 commas, it is split into multiple options at the commas.  You can use this
10862 syntax to pass an argument to the option.
10863 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10864 linker.  When using the GNU linker, you can also get the same effect with
10865 @option{-Wl,-Map=output.map}.
10867 @item -u @var{symbol}
10868 @opindex u
10869 Pretend the symbol @var{symbol} is undefined, to force linking of
10870 library modules to define it.  You can use @option{-u} multiple times with
10871 different symbols to force loading of additional library modules.
10873 @item -z @var{keyword}
10874 @opindex z
10875 @option{-z} is passed directly on to the linker along with the keyword
10876 @var{keyword}. See the section in the documentation of your linker for
10877 permitted values and their meanings.
10878 @end table
10880 @node Directory Options
10881 @section Options for Directory Search
10882 @cindex directory options
10883 @cindex options, directory search
10884 @cindex search path
10886 These options specify directories to search for header files, for
10887 libraries and for parts of the compiler:
10889 @table @gcctabopt
10890 @item -I@var{dir}
10891 @opindex I
10892 Add the directory @var{dir} to the head of the list of directories to be
10893 searched for header files.  This can be used to override a system header
10894 file, substituting your own version, since these directories are
10895 searched before the system header file directories.  However, you should
10896 not use this option to add directories that contain vendor-supplied
10897 system header files (use @option{-isystem} for that).  If you use more than
10898 one @option{-I} option, the directories are scanned in left-to-right
10899 order; the standard system directories come after.
10901 If a standard system include directory, or a directory specified with
10902 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10903 option is ignored.  The directory is still searched but as a
10904 system directory at its normal position in the system include chain.
10905 This is to ensure that GCC's procedure to fix buggy system headers and
10906 the ordering for the @code{include_next} directive are not inadvertently changed.
10907 If you really need to change the search order for system directories,
10908 use the @option{-nostdinc} and/or @option{-isystem} options.
10910 @item -iplugindir=@var{dir}
10911 @opindex iplugindir=
10912 Set the directory to search for plugins that are passed
10913 by @option{-fplugin=@var{name}} instead of
10914 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10915 to be used by the user, but only passed by the driver.
10917 @item -iquote@var{dir}
10918 @opindex iquote
10919 Add the directory @var{dir} to the head of the list of directories to
10920 be searched for header files only for the case of @code{#include
10921 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
10922 otherwise just like @option{-I}.
10924 @item -L@var{dir}
10925 @opindex L
10926 Add directory @var{dir} to the list of directories to be searched
10927 for @option{-l}.
10929 @item -B@var{prefix}
10930 @opindex B
10931 This option specifies where to find the executables, libraries,
10932 include files, and data files of the compiler itself.
10934 The compiler driver program runs one or more of the subprograms
10935 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10936 @var{prefix} as a prefix for each program it tries to run, both with and
10937 without @samp{@var{machine}/@var{version}/} for the corresponding target
10938 machine and compiler version.
10940 For each subprogram to be run, the compiler driver first tries the
10941 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10942 is not specified, the driver tries two standard prefixes, 
10943 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10944 those results in a file name that is found, the unmodified program
10945 name is searched for using the directories specified in your
10946 @env{PATH} environment variable.
10948 The compiler checks to see if the path provided by @option{-B}
10949 refers to a directory, and if necessary it adds a directory
10950 separator character at the end of the path.
10952 @option{-B} prefixes that effectively specify directory names also apply
10953 to libraries in the linker, because the compiler translates these
10954 options into @option{-L} options for the linker.  They also apply to
10955 include files in the preprocessor, because the compiler translates these
10956 options into @option{-isystem} options for the preprocessor.  In this case,
10957 the compiler appends @samp{include} to the prefix.
10959 The runtime support file @file{libgcc.a} can also be searched for using
10960 the @option{-B} prefix, if needed.  If it is not found there, the two
10961 standard prefixes above are tried, and that is all.  The file is left
10962 out of the link if it is not found by those means.
10964 Another way to specify a prefix much like the @option{-B} prefix is to use
10965 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10966 Variables}.
10968 As a special kludge, if the path provided by @option{-B} is
10969 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10970 9, then it is replaced by @file{[dir/]include}.  This is to help
10971 with boot-strapping the compiler.
10973 @item -no-canonical-prefixes
10974 @opindex no-canonical-prefixes
10975 Do not expand any symbolic links, resolve references to @samp{/../}
10976 or @samp{/./}, or make the path absolute when generating a relative
10977 prefix.
10979 @item --sysroot=@var{dir}
10980 @opindex sysroot
10981 Use @var{dir} as the logical root directory for headers and libraries.
10982 For example, if the compiler normally searches for headers in
10983 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10984 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10986 If you use both this option and the @option{-isysroot} option, then
10987 the @option{--sysroot} option applies to libraries, but the
10988 @option{-isysroot} option applies to header files.
10990 The GNU linker (beginning with version 2.16) has the necessary support
10991 for this option.  If your linker does not support this option, the
10992 header file aspect of @option{--sysroot} still works, but the
10993 library aspect does not.
10995 @item --no-sysroot-suffix
10996 @opindex no-sysroot-suffix
10997 For some targets, a suffix is added to the root directory specified
10998 with @option{--sysroot}, depending on the other options used, so that
10999 headers may for example be found in
11000 @file{@var{dir}/@var{suffix}/usr/include} instead of
11001 @file{@var{dir}/usr/include}.  This option disables the addition of
11002 such a suffix.
11004 @item -I-
11005 @opindex I-
11006 This option has been deprecated.  Please use @option{-iquote} instead for
11007 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11008 option.
11009 Any directories you specify with @option{-I} options before the @option{-I-}
11010 option are searched only for the case of @code{#include "@var{file}"};
11011 they are not searched for @code{#include <@var{file}>}.
11013 If additional directories are specified with @option{-I} options after
11014 the @option{-I-} option, these directories are searched for all @code{#include}
11015 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11016 this way.)
11018 In addition, the @option{-I-} option inhibits the use of the current
11019 directory (where the current input file came from) as the first search
11020 directory for @code{#include "@var{file}"}.  There is no way to
11021 override this effect of @option{-I-}.  With @option{-I.} you can specify
11022 searching the directory that is current when the compiler is
11023 invoked.  That is not exactly the same as what the preprocessor does
11024 by default, but it is often satisfactory.
11026 @option{-I-} does not inhibit the use of the standard system directories
11027 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11028 independent.
11029 @end table
11031 @node Code Gen Options
11032 @section Options for Code Generation Conventions
11033 @cindex code generation conventions
11034 @cindex options, code generation
11035 @cindex run-time options
11037 These machine-independent options control the interface conventions
11038 used in code generation.
11040 Most of them have both positive and negative forms; the negative form
11041 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
11042 one of the forms is listed---the one that is not the default.  You
11043 can figure out the other form by either removing @samp{no-} or adding
11046 @table @gcctabopt
11047 @item -fstack-reuse=@var{reuse-level}
11048 @opindex fstack_reuse
11049 This option controls stack space reuse for user declared local/auto variables
11050 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
11051 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
11052 local variables and temporaries, @samp{named_vars} enables the reuse only for
11053 user defined local variables with names, and @samp{none} disables stack reuse
11054 completely. The default value is @samp{all}. The option is needed when the
11055 program extends the lifetime of a scoped local variable or a compiler generated
11056 temporary beyond the end point defined by the language.  When a lifetime of
11057 a variable ends, and if the variable lives in memory, the optimizing compiler
11058 has the freedom to reuse its stack space with other temporaries or scoped
11059 local variables whose live range does not overlap with it. Legacy code extending
11060 local lifetime is likely to break with the stack reuse optimization.
11062 For example,
11064 @smallexample
11065    int *p;
11066    @{
11067      int local1;
11069      p = &local1;
11070      local1 = 10;
11071      ....
11072    @}
11073    @{
11074       int local2;
11075       local2 = 20;
11076       ...
11077    @}
11079    if (*p == 10)  // out of scope use of local1
11080      @{
11082      @}
11083 @end smallexample
11085 Another example:
11086 @smallexample
11088    struct A
11089    @{
11090        A(int k) : i(k), j(k) @{ @}
11091        int i;
11092        int j;
11093    @};
11095    A *ap;
11097    void foo(const A& ar)
11098    @{
11099       ap = &ar;
11100    @}
11102    void bar()
11103    @{
11104       foo(A(10)); // temp object's lifetime ends when foo returns
11106       @{
11107         A a(20);
11108         ....
11109       @}
11110       ap->i+= 10;  // ap references out of scope temp whose space
11111                    // is reused with a. What is the value of ap->i?
11112    @}
11114 @end smallexample
11116 The lifetime of a compiler generated temporary is well defined by the C++
11117 standard. When a lifetime of a temporary ends, and if the temporary lives
11118 in memory, the optimizing compiler has the freedom to reuse its stack
11119 space with other temporaries or scoped local variables whose live range
11120 does not overlap with it. However some of the legacy code relies on
11121 the behavior of older compilers in which temporaries' stack space is
11122 not reused, the aggressive stack reuse can lead to runtime errors. This
11123 option is used to control the temporary stack reuse optimization.
11125 @item -ftrapv
11126 @opindex ftrapv
11127 This option generates traps for signed overflow on addition, subtraction,
11128 multiplication operations.
11129 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
11130 @option{-ftrapv} @option{-fwrapv} on the command-line results in
11131 @option{-fwrapv} being effective.  Note that only active options override, so
11132 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
11133 results in @option{-ftrapv} being effective.
11135 @item -fwrapv
11136 @opindex fwrapv
11137 This option instructs the compiler to assume that signed arithmetic
11138 overflow of addition, subtraction and multiplication wraps around
11139 using twos-complement representation.  This flag enables some optimizations
11140 and disables others.  This option is enabled by default for the Java
11141 front end, as required by the Java language specification.
11142 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
11143 @option{-ftrapv} @option{-fwrapv} on the command-line results in
11144 @option{-fwrapv} being effective.  Note that only active options override, so
11145 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
11146 results in @option{-ftrapv} being effective.
11148 @item -fexceptions
11149 @opindex fexceptions
11150 Enable exception handling.  Generates extra code needed to propagate
11151 exceptions.  For some targets, this implies GCC generates frame
11152 unwind information for all functions, which can produce significant data
11153 size overhead, although it does not affect execution.  If you do not
11154 specify this option, GCC enables it by default for languages like
11155 C++ that normally require exception handling, and disables it for
11156 languages like C that do not normally require it.  However, you may need
11157 to enable this option when compiling C code that needs to interoperate
11158 properly with exception handlers written in C++.  You may also wish to
11159 disable this option if you are compiling older C++ programs that don't
11160 use exception handling.
11162 @item -fnon-call-exceptions
11163 @opindex fnon-call-exceptions
11164 Generate code that allows trapping instructions to throw exceptions.
11165 Note that this requires platform-specific runtime support that does
11166 not exist everywhere.  Moreover, it only allows @emph{trapping}
11167 instructions to throw exceptions, i.e.@: memory references or floating-point
11168 instructions.  It does not allow exceptions to be thrown from
11169 arbitrary signal handlers such as @code{SIGALRM}.
11171 @item -fdelete-dead-exceptions
11172 @opindex fdelete-dead-exceptions
11173 Consider that instructions that may throw exceptions but don't otherwise
11174 contribute to the execution of the program can be optimized away.
11175 This option is enabled by default for the Ada front end, as permitted by
11176 the Ada language specification.
11177 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
11179 @item -funwind-tables
11180 @opindex funwind-tables
11181 Similar to @option{-fexceptions}, except that it just generates any needed
11182 static data, but does not affect the generated code in any other way.
11183 You normally do not need to enable this option; instead, a language processor
11184 that needs this handling enables it on your behalf.
11186 @item -fasynchronous-unwind-tables
11187 @opindex fasynchronous-unwind-tables
11188 Generate unwind table in DWARF format, if supported by target machine.  The
11189 table is exact at each instruction boundary, so it can be used for stack
11190 unwinding from asynchronous events (such as debugger or garbage collector).
11192 @item -fno-gnu-unique
11193 @opindex fno-gnu-unique
11194 On systems with recent GNU assembler and C library, the C++ compiler
11195 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
11196 of template static data members and static local variables in inline
11197 functions are unique even in the presence of @code{RTLD_LOCAL}; this
11198 is necessary to avoid problems with a library used by two different
11199 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
11200 therefore disagreeing with the other one about the binding of the
11201 symbol.  But this causes @code{dlclose} to be ignored for affected
11202 DSOs; if your program relies on reinitialization of a DSO via
11203 @code{dlclose} and @code{dlopen}, you can use
11204 @option{-fno-gnu-unique}.
11206 @item -fpcc-struct-return
11207 @opindex fpcc-struct-return
11208 Return ``short'' @code{struct} and @code{union} values in memory like
11209 longer ones, rather than in registers.  This convention is less
11210 efficient, but it has the advantage of allowing intercallability between
11211 GCC-compiled files and files compiled with other compilers, particularly
11212 the Portable C Compiler (pcc).
11214 The precise convention for returning structures in memory depends
11215 on the target configuration macros.
11217 Short structures and unions are those whose size and alignment match
11218 that of some integer type.
11220 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11221 switch is not binary compatible with code compiled with the
11222 @option{-freg-struct-return} switch.
11223 Use it to conform to a non-default application binary interface.
11225 @item -freg-struct-return
11226 @opindex freg-struct-return
11227 Return @code{struct} and @code{union} values in registers when possible.
11228 This is more efficient for small structures than
11229 @option{-fpcc-struct-return}.
11231 If you specify neither @option{-fpcc-struct-return} nor
11232 @option{-freg-struct-return}, GCC defaults to whichever convention is
11233 standard for the target.  If there is no standard convention, GCC
11234 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11235 the principal compiler.  In those cases, we can choose the standard, and
11236 we chose the more efficient register return alternative.
11238 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11239 switch is not binary compatible with code compiled with the
11240 @option{-fpcc-struct-return} switch.
11241 Use it to conform to a non-default application binary interface.
11243 @item -fshort-enums
11244 @opindex fshort-enums
11245 Allocate to an @code{enum} type only as many bytes as it needs for the
11246 declared range of possible values.  Specifically, the @code{enum} type
11247 is equivalent to the smallest integer type that has enough room.
11249 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11250 code that is not binary compatible with code generated without that switch.
11251 Use it to conform to a non-default application binary interface.
11253 @item -fshort-wchar
11254 @opindex fshort-wchar
11255 Override the underlying type for @code{wchar_t} to be @code{short
11256 unsigned int} instead of the default for the target.  This option is
11257 useful for building programs to run under WINE@.
11259 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11260 code that is not binary compatible with code generated without that switch.
11261 Use it to conform to a non-default application binary interface.
11263 @item -fno-common
11264 @opindex fno-common
11265 In C code, controls the placement of uninitialized global variables.
11266 Unix C compilers have traditionally permitted multiple definitions of
11267 such variables in different compilation units by placing the variables
11268 in a common block.
11269 This is the behavior specified by @option{-fcommon}, and is the default
11270 for GCC on most targets.
11271 On the other hand, this behavior is not required by ISO C, and on some
11272 targets may carry a speed or code size penalty on variable references.
11273 The @option{-fno-common} option specifies that the compiler should place
11274 uninitialized global variables in the data section of the object file,
11275 rather than generating them as common blocks.
11276 This has the effect that if the same variable is declared
11277 (without @code{extern}) in two different compilations,
11278 you get a multiple-definition error when you link them.
11279 In this case, you must compile with @option{-fcommon} instead.
11280 Compiling with @option{-fno-common} is useful on targets for which
11281 it provides better performance, or if you wish to verify that the
11282 program will work on other systems that always treat uninitialized
11283 variable declarations this way.
11285 @item -fno-ident
11286 @opindex fno-ident
11287 Ignore the @code{#ident} directive.
11289 @item -finhibit-size-directive
11290 @opindex finhibit-size-directive
11291 Don't output a @code{.size} assembler directive, or anything else that
11292 would cause trouble if the function is split in the middle, and the
11293 two halves are placed at locations far apart in memory.  This option is
11294 used when compiling @file{crtstuff.c}; you should not need to use it
11295 for anything else.
11297 @item -fverbose-asm
11298 @opindex fverbose-asm
11299 Put extra commentary information in the generated assembly code to
11300 make it more readable.  This option is generally only of use to those
11301 who actually need to read the generated assembly code (perhaps while
11302 debugging the compiler itself).
11304 @option{-fno-verbose-asm}, the default, causes the
11305 extra information to be omitted and is useful when comparing two assembler
11306 files.
11308 @item -frecord-gcc-switches
11309 @opindex frecord-gcc-switches
11310 This switch causes the command line used to invoke the
11311 compiler to be recorded into the object file that is being created.
11312 This switch is only implemented on some targets and the exact format
11313 of the recording is target and binary file format dependent, but it
11314 usually takes the form of a section containing ASCII text.  This
11315 switch is related to the @option{-fverbose-asm} switch, but that
11316 switch only records information in the assembler output file as
11317 comments, so it never reaches the object file.
11318 See also @option{-grecord-gcc-switches} for another
11319 way of storing compiler options into the object file.
11321 @item -fpic
11322 @opindex fpic
11323 @cindex global offset table
11324 @cindex PIC
11325 Generate position-independent code (PIC) suitable for use in a shared
11326 library, if supported for the target machine.  Such code accesses all
11327 constant addresses through a global offset table (GOT)@.  The dynamic
11328 loader resolves the GOT entries when the program starts (the dynamic
11329 loader is not part of GCC; it is part of the operating system).  If
11330 the GOT size for the linked executable exceeds a machine-specific
11331 maximum size, you get an error message from the linker indicating that
11332 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11333 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
11334 on the m68k and RS/6000.  The x86 has no such limit.)
11336 Position-independent code requires special support, and therefore works
11337 only on certain machines.  For the x86, GCC supports PIC for System V
11338 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11339 position-independent.
11341 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
11342 are defined to 1.
11344 @item -fPIC
11345 @opindex fPIC
11346 If supported for the target machine, emit position-independent code,
11347 suitable for dynamic linking and avoiding any limit on the size of the
11348 global offset table.  This option makes a difference on AArch64, m68k,
11349 PowerPC and SPARC@.
11351 Position-independent code requires special support, and therefore works
11352 only on certain machines.
11354 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
11355 are defined to 2.
11357 @item -fpie
11358 @itemx -fPIE
11359 @opindex fpie
11360 @opindex fPIE
11361 These options are similar to @option{-fpic} and @option{-fPIC}, but
11362 generated position independent code can be only linked into executables.
11363 Usually these options are used when @option{-pie} GCC option is
11364 used during linking.
11366 @option{-fpie} and @option{-fPIE} both define the macros
11367 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
11368 for @option{-fpie} and 2 for @option{-fPIE}.
11370 @item -fno-plt
11371 @opindex fno-plt
11372 Do not use the PLT for external function calls in position-independent code.
11373 Instead, load the callee address at call sites from the GOT and branch to it.
11374 This leads to more efficient code by eliminating PLT stubs and exposing
11375 GOT loads to optimizations.  On architectures such as 32-bit x86 where
11376 PLT stubs expect the GOT pointer in a specific register, this gives more
11377 register allocation freedom to the compiler.
11378 Lazy binding requires use of the PLT; 
11379 with @option{-fno-plt} all external symbols are resolved at load time.
11381 Alternatively, the function attribute @code{noplt} can be used to avoid calls
11382 through the PLT for specific external functions.
11384 In position-dependent code, a few targets also convert calls to
11385 functions that are marked to not use the PLT to use the GOT instead.
11387 @item -fno-jump-tables
11388 @opindex fno-jump-tables
11389 Do not use jump tables for switch statements even where it would be
11390 more efficient than other code generation strategies.  This option is
11391 of use in conjunction with @option{-fpic} or @option{-fPIC} for
11392 building code that forms part of a dynamic linker and cannot
11393 reference the address of a jump table.  On some targets, jump tables
11394 do not require a GOT and this option is not needed.
11396 @item -ffixed-@var{reg}
11397 @opindex ffixed
11398 Treat the register named @var{reg} as a fixed register; generated code
11399 should never refer to it (except perhaps as a stack pointer, frame
11400 pointer or in some other fixed role).
11402 @var{reg} must be the name of a register.  The register names accepted
11403 are machine-specific and are defined in the @code{REGISTER_NAMES}
11404 macro in the machine description macro file.
11406 This flag does not have a negative form, because it specifies a
11407 three-way choice.
11409 @item -fcall-used-@var{reg}
11410 @opindex fcall-used
11411 Treat the register named @var{reg} as an allocable register that is
11412 clobbered by function calls.  It may be allocated for temporaries or
11413 variables that do not live across a call.  Functions compiled this way
11414 do not save and restore the register @var{reg}.
11416 It is an error to use this flag with the frame pointer or stack pointer.
11417 Use of this flag for other registers that have fixed pervasive roles in
11418 the machine's execution model produces disastrous results.
11420 This flag does not have a negative form, because it specifies a
11421 three-way choice.
11423 @item -fcall-saved-@var{reg}
11424 @opindex fcall-saved
11425 Treat the register named @var{reg} as an allocable register saved by
11426 functions.  It may be allocated even for temporaries or variables that
11427 live across a call.  Functions compiled this way save and restore
11428 the register @var{reg} if they use it.
11430 It is an error to use this flag with the frame pointer or stack pointer.
11431 Use of this flag for other registers that have fixed pervasive roles in
11432 the machine's execution model produces disastrous results.
11434 A different sort of disaster results from the use of this flag for
11435 a register in which function values may be returned.
11437 This flag does not have a negative form, because it specifies a
11438 three-way choice.
11440 @item -fpack-struct[=@var{n}]
11441 @opindex fpack-struct
11442 Without a value specified, pack all structure members together without
11443 holes.  When a value is specified (which must be a small power of two), pack
11444 structure members according to this value, representing the maximum
11445 alignment (that is, objects with default alignment requirements larger than
11446 this are output potentially unaligned at the next fitting location.
11448 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11449 code that is not binary compatible with code generated without that switch.
11450 Additionally, it makes the code suboptimal.
11451 Use it to conform to a non-default application binary interface.
11453 @item -fleading-underscore
11454 @opindex fleading-underscore
11455 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11456 change the way C symbols are represented in the object file.  One use
11457 is to help link with legacy assembly code.
11459 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11460 generate code that is not binary compatible with code generated without that
11461 switch.  Use it to conform to a non-default application binary interface.
11462 Not all targets provide complete support for this switch.
11464 @item -ftls-model=@var{model}
11465 @opindex ftls-model
11466 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11467 The @var{model} argument should be one of @samp{global-dynamic},
11468 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
11469 Note that the choice is subject to optimization: the compiler may use
11470 a more efficient model for symbols not visible outside of the translation
11471 unit, or if @option{-fpic} is not given on the command line.
11473 The default without @option{-fpic} is @samp{initial-exec}; with
11474 @option{-fpic} the default is @samp{global-dynamic}.
11476 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
11477 @opindex fvisibility
11478 Set the default ELF image symbol visibility to the specified option---all
11479 symbols are marked with this unless overridden within the code.
11480 Using this feature can very substantially improve linking and
11481 load times of shared object libraries, produce more optimized
11482 code, provide near-perfect API export and prevent symbol clashes.
11483 It is @strong{strongly} recommended that you use this in any shared objects
11484 you distribute.
11486 Despite the nomenclature, @samp{default} always means public; i.e.,
11487 available to be linked against from outside the shared object.
11488 @samp{protected} and @samp{internal} are pretty useless in real-world
11489 usage so the only other commonly used option is @samp{hidden}.
11490 The default if @option{-fvisibility} isn't specified is
11491 @samp{default}, i.e., make every symbol public.
11493 A good explanation of the benefits offered by ensuring ELF
11494 symbols have the correct visibility is given by ``How To Write
11495 Shared Libraries'' by Ulrich Drepper (which can be found at
11496 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
11497 solution made possible by this option to marking things hidden when
11498 the default is public is to make the default hidden and mark things
11499 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
11500 and @code{__attribute__ ((visibility("default")))} instead of
11501 @code{__declspec(dllexport)} you get almost identical semantics with
11502 identical syntax.  This is a great boon to those working with
11503 cross-platform projects.
11505 For those adding visibility support to existing code, you may find
11506 @code{#pragma GCC visibility} of use.  This works by you enclosing
11507 the declarations you wish to set visibility for with (for example)
11508 @code{#pragma GCC visibility push(hidden)} and
11509 @code{#pragma GCC visibility pop}.
11510 Bear in mind that symbol visibility should be viewed @strong{as
11511 part of the API interface contract} and thus all new code should
11512 always specify visibility when it is not the default; i.e., declarations
11513 only for use within the local DSO should @strong{always} be marked explicitly
11514 as hidden as so to avoid PLT indirection overheads---making this
11515 abundantly clear also aids readability and self-documentation of the code.
11516 Note that due to ISO C++ specification requirements, @code{operator new} and
11517 @code{operator delete} must always be of default visibility.
11519 Be aware that headers from outside your project, in particular system
11520 headers and headers from any other library you use, may not be
11521 expecting to be compiled with visibility other than the default.  You
11522 may need to explicitly say @code{#pragma GCC visibility push(default)}
11523 before including any such headers.
11525 @code{extern} declarations are not affected by @option{-fvisibility}, so
11526 a lot of code can be recompiled with @option{-fvisibility=hidden} with
11527 no modifications.  However, this means that calls to @code{extern}
11528 functions with no explicit visibility use the PLT, so it is more
11529 effective to use @code{__attribute ((visibility))} and/or
11530 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
11531 declarations should be treated as hidden.
11533 Note that @option{-fvisibility} does affect C++ vague linkage
11534 entities. This means that, for instance, an exception class that is
11535 be thrown between DSOs must be explicitly marked with default
11536 visibility so that the @samp{type_info} nodes are unified between
11537 the DSOs.
11539 An overview of these techniques, their benefits and how to use them
11540 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
11542 @item -fstrict-volatile-bitfields
11543 @opindex fstrict-volatile-bitfields
11544 This option should be used if accesses to volatile bit-fields (or other
11545 structure fields, although the compiler usually honors those types
11546 anyway) should use a single access of the width of the
11547 field's type, aligned to a natural alignment if possible.  For
11548 example, targets with memory-mapped peripheral registers might require
11549 all such accesses to be 16 bits wide; with this flag you can
11550 declare all peripheral bit-fields as @code{unsigned short} (assuming short
11551 is 16 bits on these targets) to force GCC to use 16-bit accesses
11552 instead of, perhaps, a more efficient 32-bit access.
11554 If this option is disabled, the compiler uses the most efficient
11555 instruction.  In the previous example, that might be a 32-bit load
11556 instruction, even though that accesses bytes that do not contain
11557 any portion of the bit-field, or memory-mapped registers unrelated to
11558 the one being updated.
11560 In some cases, such as when the @code{packed} attribute is applied to a 
11561 structure field, it may not be possible to access the field with a single
11562 read or write that is correctly aligned for the target machine.  In this
11563 case GCC falls back to generating multiple accesses rather than code that 
11564 will fault or truncate the result at run time.
11566 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
11567 not allowed to touch non bit-field members.  It is therefore recommended
11568 to define all bits of the field's type as bit-field members.
11570 The default value of this option is determined by the application binary
11571 interface for the target processor.
11573 @item -fsync-libcalls
11574 @opindex fsync-libcalls
11575 This option controls whether any out-of-line instance of the @code{__sync}
11576 family of functions may be used to implement the C++11 @code{__atomic}
11577 family of functions.
11579 The default value of this option is enabled, thus the only useful form
11580 of the option is @option{-fno-sync-libcalls}.  This option is used in
11581 the implementation of the @file{libatomic} runtime library.
11583 @end table
11585 @node Developer Options
11586 @section GCC Developer Options
11587 @cindex developer options
11588 @cindex debugging GCC
11589 @cindex debug dump options
11590 @cindex dump options
11591 @cindex compilation statistics
11593 This section describes command-line options that are primarily of
11594 interest to GCC developers, including options to support compiler
11595 testing and investigation of compiler bugs and compile-time
11596 performance problems.  This includes options that produce debug dumps
11597 at various points in the compilation; that print statistics such as
11598 memory use and execution time; and that print information about GCC's
11599 configuration, such as where it searches for libraries.  You should
11600 rarely need to use any of these options for ordinary compilation and
11601 linking tasks.
11603 @table @gcctabopt
11605 @item -d@var{letters}
11606 @itemx -fdump-rtl-@var{pass}
11607 @itemx -fdump-rtl-@var{pass}=@var{filename}
11608 @opindex d
11609 @opindex fdump-rtl-@var{pass}
11610 Says to make debugging dumps during compilation at times specified by
11611 @var{letters}.  This is used for debugging the RTL-based passes of the
11612 compiler.  The file names for most of the dumps are made by appending
11613 a pass number and a word to the @var{dumpname}, and the files are
11614 created in the directory of the output file.  In case of
11615 @option{=@var{filename}} option, the dump is output on the given file
11616 instead of the pass numbered dump files.  Note that the pass number is
11617 assigned as passes are registered into the pass manager.  Most passes
11618 are registered in the order that they will execute and for these passes
11619 the number corresponds to the pass execution order.  However, passes
11620 registered by plugins, passes specific to compilation targets, or
11621 passes that are otherwise registered after all the other passes are
11622 numbered higher than a pass named "final", even if they are executed
11623 earlier.  @var{dumpname} is generated from the name of the output
11624 file if explicitly specified and not an executable, otherwise it is
11625 the basename of the source file.  These switches may have different
11626 effects when @option{-E} is used for preprocessing.
11628 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
11629 @option{-d} option @var{letters}.  Here are the possible
11630 letters for use in @var{pass} and @var{letters}, and their meanings:
11632 @table @gcctabopt
11634 @item -fdump-rtl-alignments
11635 @opindex fdump-rtl-alignments
11636 Dump after branch alignments have been computed.
11638 @item -fdump-rtl-asmcons
11639 @opindex fdump-rtl-asmcons
11640 Dump after fixing rtl statements that have unsatisfied in/out constraints.
11642 @item -fdump-rtl-auto_inc_dec
11643 @opindex fdump-rtl-auto_inc_dec
11644 Dump after auto-inc-dec discovery.  This pass is only run on
11645 architectures that have auto inc or auto dec instructions.
11647 @item -fdump-rtl-barriers
11648 @opindex fdump-rtl-barriers
11649 Dump after cleaning up the barrier instructions.
11651 @item -fdump-rtl-bbpart
11652 @opindex fdump-rtl-bbpart
11653 Dump after partitioning hot and cold basic blocks.
11655 @item -fdump-rtl-bbro
11656 @opindex fdump-rtl-bbro
11657 Dump after block reordering.
11659 @item -fdump-rtl-btl1
11660 @itemx -fdump-rtl-btl2
11661 @opindex fdump-rtl-btl2
11662 @opindex fdump-rtl-btl2
11663 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
11664 after the two branch
11665 target load optimization passes.
11667 @item -fdump-rtl-bypass
11668 @opindex fdump-rtl-bypass
11669 Dump after jump bypassing and control flow optimizations.
11671 @item -fdump-rtl-combine
11672 @opindex fdump-rtl-combine
11673 Dump after the RTL instruction combination pass.
11675 @item -fdump-rtl-compgotos
11676 @opindex fdump-rtl-compgotos
11677 Dump after duplicating the computed gotos.
11679 @item -fdump-rtl-ce1
11680 @itemx -fdump-rtl-ce2
11681 @itemx -fdump-rtl-ce3
11682 @opindex fdump-rtl-ce1
11683 @opindex fdump-rtl-ce2
11684 @opindex fdump-rtl-ce3
11685 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
11686 @option{-fdump-rtl-ce3} enable dumping after the three
11687 if conversion passes.
11689 @item -fdump-rtl-cprop_hardreg
11690 @opindex fdump-rtl-cprop_hardreg
11691 Dump after hard register copy propagation.
11693 @item -fdump-rtl-csa
11694 @opindex fdump-rtl-csa
11695 Dump after combining stack adjustments.
11697 @item -fdump-rtl-cse1
11698 @itemx -fdump-rtl-cse2
11699 @opindex fdump-rtl-cse1
11700 @opindex fdump-rtl-cse2
11701 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
11702 the two common subexpression elimination passes.
11704 @item -fdump-rtl-dce
11705 @opindex fdump-rtl-dce
11706 Dump after the standalone dead code elimination passes.
11708 @item -fdump-rtl-dbr
11709 @opindex fdump-rtl-dbr
11710 Dump after delayed branch scheduling.
11712 @item -fdump-rtl-dce1
11713 @itemx -fdump-rtl-dce2
11714 @opindex fdump-rtl-dce1
11715 @opindex fdump-rtl-dce2
11716 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
11717 the two dead store elimination passes.
11719 @item -fdump-rtl-eh
11720 @opindex fdump-rtl-eh
11721 Dump after finalization of EH handling code.
11723 @item -fdump-rtl-eh_ranges
11724 @opindex fdump-rtl-eh_ranges
11725 Dump after conversion of EH handling range regions.
11727 @item -fdump-rtl-expand
11728 @opindex fdump-rtl-expand
11729 Dump after RTL generation.
11731 @item -fdump-rtl-fwprop1
11732 @itemx -fdump-rtl-fwprop2
11733 @opindex fdump-rtl-fwprop1
11734 @opindex fdump-rtl-fwprop2
11735 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
11736 dumping after the two forward propagation passes.
11738 @item -fdump-rtl-gcse1
11739 @itemx -fdump-rtl-gcse2
11740 @opindex fdump-rtl-gcse1
11741 @opindex fdump-rtl-gcse2
11742 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
11743 after global common subexpression elimination.
11745 @item -fdump-rtl-init-regs
11746 @opindex fdump-rtl-init-regs
11747 Dump after the initialization of the registers.
11749 @item -fdump-rtl-initvals
11750 @opindex fdump-rtl-initvals
11751 Dump after the computation of the initial value sets.
11753 @item -fdump-rtl-into_cfglayout
11754 @opindex fdump-rtl-into_cfglayout
11755 Dump after converting to cfglayout mode.
11757 @item -fdump-rtl-ira
11758 @opindex fdump-rtl-ira
11759 Dump after iterated register allocation.
11761 @item -fdump-rtl-jump
11762 @opindex fdump-rtl-jump
11763 Dump after the second jump optimization.
11765 @item -fdump-rtl-loop2
11766 @opindex fdump-rtl-loop2
11767 @option{-fdump-rtl-loop2} enables dumping after the rtl
11768 loop optimization passes.
11770 @item -fdump-rtl-mach
11771 @opindex fdump-rtl-mach
11772 Dump after performing the machine dependent reorganization pass, if that
11773 pass exists.
11775 @item -fdump-rtl-mode_sw
11776 @opindex fdump-rtl-mode_sw
11777 Dump after removing redundant mode switches.
11779 @item -fdump-rtl-rnreg
11780 @opindex fdump-rtl-rnreg
11781 Dump after register renumbering.
11783 @item -fdump-rtl-outof_cfglayout
11784 @opindex fdump-rtl-outof_cfglayout
11785 Dump after converting from cfglayout mode.
11787 @item -fdump-rtl-peephole2
11788 @opindex fdump-rtl-peephole2
11789 Dump after the peephole pass.
11791 @item -fdump-rtl-postreload
11792 @opindex fdump-rtl-postreload
11793 Dump after post-reload optimizations.
11795 @item -fdump-rtl-pro_and_epilogue
11796 @opindex fdump-rtl-pro_and_epilogue
11797 Dump after generating the function prologues and epilogues.
11799 @item -fdump-rtl-sched1
11800 @itemx -fdump-rtl-sched2
11801 @opindex fdump-rtl-sched1
11802 @opindex fdump-rtl-sched2
11803 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
11804 after the basic block scheduling passes.
11806 @item -fdump-rtl-ree
11807 @opindex fdump-rtl-ree
11808 Dump after sign/zero extension elimination.
11810 @item -fdump-rtl-seqabstr
11811 @opindex fdump-rtl-seqabstr
11812 Dump after common sequence discovery.
11814 @item -fdump-rtl-shorten
11815 @opindex fdump-rtl-shorten
11816 Dump after shortening branches.
11818 @item -fdump-rtl-sibling
11819 @opindex fdump-rtl-sibling
11820 Dump after sibling call optimizations.
11822 @item -fdump-rtl-split1
11823 @itemx -fdump-rtl-split2
11824 @itemx -fdump-rtl-split3
11825 @itemx -fdump-rtl-split4
11826 @itemx -fdump-rtl-split5
11827 @opindex fdump-rtl-split1
11828 @opindex fdump-rtl-split2
11829 @opindex fdump-rtl-split3
11830 @opindex fdump-rtl-split4
11831 @opindex fdump-rtl-split5
11832 These options enable dumping after five rounds of
11833 instruction splitting.
11835 @item -fdump-rtl-sms
11836 @opindex fdump-rtl-sms
11837 Dump after modulo scheduling.  This pass is only run on some
11838 architectures.
11840 @item -fdump-rtl-stack
11841 @opindex fdump-rtl-stack
11842 Dump after conversion from GCC's ``flat register file'' registers to the
11843 x87's stack-like registers.  This pass is only run on x86 variants.
11845 @item -fdump-rtl-subreg1
11846 @itemx -fdump-rtl-subreg2
11847 @opindex fdump-rtl-subreg1
11848 @opindex fdump-rtl-subreg2
11849 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
11850 the two subreg expansion passes.
11852 @item -fdump-rtl-unshare
11853 @opindex fdump-rtl-unshare
11854 Dump after all rtl has been unshared.
11856 @item -fdump-rtl-vartrack
11857 @opindex fdump-rtl-vartrack
11858 Dump after variable tracking.
11860 @item -fdump-rtl-vregs
11861 @opindex fdump-rtl-vregs
11862 Dump after converting virtual registers to hard registers.
11864 @item -fdump-rtl-web
11865 @opindex fdump-rtl-web
11866 Dump after live range splitting.
11868 @item -fdump-rtl-regclass
11869 @itemx -fdump-rtl-subregs_of_mode_init
11870 @itemx -fdump-rtl-subregs_of_mode_finish
11871 @itemx -fdump-rtl-dfinit
11872 @itemx -fdump-rtl-dfinish
11873 @opindex fdump-rtl-regclass
11874 @opindex fdump-rtl-subregs_of_mode_init
11875 @opindex fdump-rtl-subregs_of_mode_finish
11876 @opindex fdump-rtl-dfinit
11877 @opindex fdump-rtl-dfinish
11878 These dumps are defined but always produce empty files.
11880 @item -da
11881 @itemx -fdump-rtl-all
11882 @opindex da
11883 @opindex fdump-rtl-all
11884 Produce all the dumps listed above.
11886 @item -dA
11887 @opindex dA
11888 Annotate the assembler output with miscellaneous debugging information.
11890 @item -dD
11891 @opindex dD
11892 Dump all macro definitions, at the end of preprocessing, in addition to
11893 normal output.
11895 @item -dH
11896 @opindex dH
11897 Produce a core dump whenever an error occurs.
11899 @item -dp
11900 @opindex dp
11901 Annotate the assembler output with a comment indicating which
11902 pattern and alternative is used.  The length of each instruction is
11903 also printed.
11905 @item -dP
11906 @opindex dP
11907 Dump the RTL in the assembler output as a comment before each instruction.
11908 Also turns on @option{-dp} annotation.
11910 @item -dx
11911 @opindex dx
11912 Just generate RTL for a function instead of compiling it.  Usually used
11913 with @option{-fdump-rtl-expand}.
11914 @end table
11916 @item -fdump-noaddr
11917 @opindex fdump-noaddr
11918 When doing debugging dumps, suppress address output.  This makes it more
11919 feasible to use diff on debugging dumps for compiler invocations with
11920 different compiler binaries and/or different
11921 text / bss / data / heap / stack / dso start locations.
11923 @item -freport-bug
11924 @opindex freport-bug
11925 Collect and dump debug information into a temporary file if an
11926 internal compiler error (ICE) occurs.
11928 @item -fdump-unnumbered
11929 @opindex fdump-unnumbered
11930 When doing debugging dumps, suppress instruction numbers and address output.
11931 This makes it more feasible to use diff on debugging dumps for compiler
11932 invocations with different options, in particular with and without
11933 @option{-g}.
11935 @item -fdump-unnumbered-links
11936 @opindex fdump-unnumbered-links
11937 When doing debugging dumps (see @option{-d} option above), suppress
11938 instruction numbers for the links to the previous and next instructions
11939 in a sequence.
11941 @item -fdump-translation-unit @r{(C++ only)}
11942 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
11943 @opindex fdump-translation-unit
11944 Dump a representation of the tree structure for the entire translation
11945 unit to a file.  The file name is made by appending @file{.tu} to the
11946 source file name, and the file is created in the same directory as the
11947 output file.  If the @samp{-@var{options}} form is used, @var{options}
11948 controls the details of the dump as described for the
11949 @option{-fdump-tree} options.
11951 @item -fdump-class-hierarchy @r{(C++ only)}
11952 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
11953 @opindex fdump-class-hierarchy
11954 Dump a representation of each class's hierarchy and virtual function
11955 table layout to a file.  The file name is made by appending
11956 @file{.class} to the source file name, and the file is created in the
11957 same directory as the output file.  If the @samp{-@var{options}} form
11958 is used, @var{options} controls the details of the dump as described
11959 for the @option{-fdump-tree} options.
11961 @item -fdump-ipa-@var{switch}
11962 @opindex fdump-ipa
11963 Control the dumping at various stages of inter-procedural analysis
11964 language tree to a file.  The file name is generated by appending a
11965 switch specific suffix to the source file name, and the file is created
11966 in the same directory as the output file.  The following dumps are
11967 possible:
11969 @table @samp
11970 @item all
11971 Enables all inter-procedural analysis dumps.
11973 @item cgraph
11974 Dumps information about call-graph optimization, unused function removal,
11975 and inlining decisions.
11977 @item inline
11978 Dump after function inlining.
11980 @end table
11982 @item -fdump-passes
11983 @opindex fdump-passes
11984 Dump the list of optimization passes that are turned on and off by
11985 the current command-line options.
11987 @item -fdump-statistics-@var{option}
11988 @opindex fdump-statistics
11989 Enable and control dumping of pass statistics in a separate file.  The
11990 file name is generated by appending a suffix ending in
11991 @samp{.statistics} to the source file name, and the file is created in
11992 the same directory as the output file.  If the @samp{-@var{option}}
11993 form is used, @samp{-stats} causes counters to be summed over the
11994 whole compilation unit while @samp{-details} dumps every event as
11995 the passes generate them.  The default with no option is to sum
11996 counters for each function compiled.
11998 @item -fdump-tree-@var{switch}
11999 @itemx -fdump-tree-@var{switch}-@var{options}
12000 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
12001 @opindex fdump-tree
12002 Control the dumping at various stages of processing the intermediate
12003 language tree to a file.  The file name is generated by appending a
12004 switch-specific suffix to the source file name, and the file is
12005 created in the same directory as the output file. In case of
12006 @option{=@var{filename}} option, the dump is output on the given file
12007 instead of the auto named dump files.  If the @samp{-@var{options}}
12008 form is used, @var{options} is a list of @samp{-} separated options
12009 which control the details of the dump.  Not all options are applicable
12010 to all dumps; those that are not meaningful are ignored.  The
12011 following options are available
12013 @table @samp
12014 @item address
12015 Print the address of each node.  Usually this is not meaningful as it
12016 changes according to the environment and source file.  Its primary use
12017 is for tying up a dump file with a debug environment.
12018 @item asmname
12019 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
12020 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
12021 use working backward from mangled names in the assembly file.
12022 @item slim
12023 When dumping front-end intermediate representations, inhibit dumping
12024 of members of a scope or body of a function merely because that scope
12025 has been reached.  Only dump such items when they are directly reachable
12026 by some other path.
12028 When dumping pretty-printed trees, this option inhibits dumping the
12029 bodies of control structures.
12031 When dumping RTL, print the RTL in slim (condensed) form instead of
12032 the default LISP-like representation.
12033 @item raw
12034 Print a raw representation of the tree.  By default, trees are
12035 pretty-printed into a C-like representation.
12036 @item details
12037 Enable more detailed dumps (not honored by every dump option). Also
12038 include information from the optimization passes.
12039 @item stats
12040 Enable dumping various statistics about the pass (not honored by every dump
12041 option).
12042 @item blocks
12043 Enable showing basic block boundaries (disabled in raw dumps).
12044 @item graph
12045 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
12046 dump a representation of the control flow graph suitable for viewing with
12047 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
12048 the file is pretty-printed as a subgraph, so that GraphViz can render them
12049 all in a single plot.
12051 This option currently only works for RTL dumps, and the RTL is always
12052 dumped in slim form.
12053 @item vops
12054 Enable showing virtual operands for every statement.
12055 @item lineno
12056 Enable showing line numbers for statements.
12057 @item uid
12058 Enable showing the unique ID (@code{DECL_UID}) for each variable.
12059 @item verbose
12060 Enable showing the tree dump for each statement.
12061 @item eh
12062 Enable showing the EH region number holding each statement.
12063 @item scev
12064 Enable showing scalar evolution analysis details.
12065 @item optimized
12066 Enable showing optimization information (only available in certain
12067 passes).
12068 @item missed
12069 Enable showing missed optimization information (only available in certain
12070 passes).
12071 @item note
12072 Enable other detailed optimization information (only available in
12073 certain passes).
12074 @item =@var{filename}
12075 Instead of an auto named dump file, output into the given file
12076 name. The file names @file{stdout} and @file{stderr} are treated
12077 specially and are considered already open standard streams. For
12078 example,
12080 @smallexample
12081 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
12082      -fdump-tree-pre=stderr file.c
12083 @end smallexample
12085 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
12086 output on to @file{stderr}. If two conflicting dump filenames are
12087 given for the same pass, then the latter option overrides the earlier
12088 one.
12090 @item split-paths
12091 @opindex fdump-tree-split-paths
12092 Dump each function after splitting paths to loop backedges.  The file
12093 name is made by appending @file{.split-paths} to the source file name.
12095 @item all
12096 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
12097 and @option{lineno}.
12099 @item optall
12100 Turn on all optimization options, i.e., @option{optimized},
12101 @option{missed}, and @option{note}.
12102 @end table
12104 The following tree dumps are possible:
12105 @table @samp
12107 @item original
12108 @opindex fdump-tree-original
12109 Dump before any tree based optimization, to @file{@var{file}.original}.
12111 @item optimized
12112 @opindex fdump-tree-optimized
12113 Dump after all tree based optimization, to @file{@var{file}.optimized}.
12115 @item gimple
12116 @opindex fdump-tree-gimple
12117 Dump each function before and after the gimplification pass to a file.  The
12118 file name is made by appending @file{.gimple} to the source file name.
12120 @item cfg
12121 @opindex fdump-tree-cfg
12122 Dump the control flow graph of each function to a file.  The file name is
12123 made by appending @file{.cfg} to the source file name.
12125 @item ch
12126 @opindex fdump-tree-ch
12127 Dump each function after copying loop headers.  The file name is made by
12128 appending @file{.ch} to the source file name.
12130 @item ssa
12131 @opindex fdump-tree-ssa
12132 Dump SSA related information to a file.  The file name is made by appending
12133 @file{.ssa} to the source file name.
12135 @item alias
12136 @opindex fdump-tree-alias
12137 Dump aliasing information for each function.  The file name is made by
12138 appending @file{.alias} to the source file name.
12140 @item ccp
12141 @opindex fdump-tree-ccp
12142 Dump each function after CCP@.  The file name is made by appending
12143 @file{.ccp} to the source file name.
12145 @item storeccp
12146 @opindex fdump-tree-storeccp
12147 Dump each function after STORE-CCP@.  The file name is made by appending
12148 @file{.storeccp} to the source file name.
12150 @item pre
12151 @opindex fdump-tree-pre
12152 Dump trees after partial redundancy elimination.  The file name is made
12153 by appending @file{.pre} to the source file name.
12155 @item fre
12156 @opindex fdump-tree-fre
12157 Dump trees after full redundancy elimination.  The file name is made
12158 by appending @file{.fre} to the source file name.
12160 @item copyprop
12161 @opindex fdump-tree-copyprop
12162 Dump trees after copy propagation.  The file name is made
12163 by appending @file{.copyprop} to the source file name.
12165 @item store_copyprop
12166 @opindex fdump-tree-store_copyprop
12167 Dump trees after store copy-propagation.  The file name is made
12168 by appending @file{.store_copyprop} to the source file name.
12170 @item dce
12171 @opindex fdump-tree-dce
12172 Dump each function after dead code elimination.  The file name is made by
12173 appending @file{.dce} to the source file name.
12175 @item sra
12176 @opindex fdump-tree-sra
12177 Dump each function after performing scalar replacement of aggregates.  The
12178 file name is made by appending @file{.sra} to the source file name.
12180 @item sink
12181 @opindex fdump-tree-sink
12182 Dump each function after performing code sinking.  The file name is made
12183 by appending @file{.sink} to the source file name.
12185 @item dom
12186 @opindex fdump-tree-dom
12187 Dump each function after applying dominator tree optimizations.  The file
12188 name is made by appending @file{.dom} to the source file name.
12190 @item dse
12191 @opindex fdump-tree-dse
12192 Dump each function after applying dead store elimination.  The file
12193 name is made by appending @file{.dse} to the source file name.
12195 @item phiopt
12196 @opindex fdump-tree-phiopt
12197 Dump each function after optimizing PHI nodes into straightline code.  The file
12198 name is made by appending @file{.phiopt} to the source file name.
12200 @item backprop
12201 @opindex fdump-tree-backprop
12202 Dump each function after back-propagating use information up the definition
12203 chain.  The file name is made by appending @file{.backprop} to the
12204 source file name.
12206 @item forwprop
12207 @opindex fdump-tree-forwprop
12208 Dump each function after forward propagating single use variables.  The file
12209 name is made by appending @file{.forwprop} to the source file name.
12211 @item nrv
12212 @opindex fdump-tree-nrv
12213 Dump each function after applying the named return value optimization on
12214 generic trees.  The file name is made by appending @file{.nrv} to the source
12215 file name.
12217 @item vect
12218 @opindex fdump-tree-vect
12219 Dump each function after applying vectorization of loops.  The file name is
12220 made by appending @file{.vect} to the source file name.
12222 @item slp
12223 @opindex fdump-tree-slp
12224 Dump each function after applying vectorization of basic blocks.  The file name
12225 is made by appending @file{.slp} to the source file name.
12227 @item vrp
12228 @opindex fdump-tree-vrp
12229 Dump each function after Value Range Propagation (VRP).  The file name
12230 is made by appending @file{.vrp} to the source file name.
12232 @item oaccdevlow
12233 @opindex fdump-tree-oaccdevlow
12234 Dump each function after applying device-specific OpenACC transformations.
12235 The file name is made by appending @file{.oaccdevlow} to the source file name.
12237 @item all
12238 @opindex fdump-tree-all
12239 Enable all the available tree dumps with the flags provided in this option.
12240 @end table
12242 @item -fopt-info
12243 @itemx -fopt-info-@var{options}
12244 @itemx -fopt-info-@var{options}=@var{filename}
12245 @opindex fopt-info
12246 Controls optimization dumps from various optimization passes. If the
12247 @samp{-@var{options}} form is used, @var{options} is a list of
12248 @samp{-} separated option keywords to select the dump details and
12249 optimizations.  
12251 The @var{options} can be divided into two groups: options describing the
12252 verbosity of the dump, and options describing which optimizations
12253 should be included. The options from both the groups can be freely
12254 mixed as they are non-overlapping. However, in case of any conflicts,
12255 the later options override the earlier options on the command
12256 line. 
12258 The following options control the dump verbosity:
12260 @table @samp
12261 @item optimized
12262 Print information when an optimization is successfully applied. It is
12263 up to a pass to decide which information is relevant. For example, the
12264 vectorizer passes print the source location of loops which are
12265 successfully vectorized.
12266 @item missed
12267 Print information about missed optimizations. Individual passes
12268 control which information to include in the output. 
12269 @item note
12270 Print verbose information about optimizations, such as certain
12271 transformations, more detailed messages about decisions etc.
12272 @item all
12273 Print detailed optimization information. This includes
12274 @samp{optimized}, @samp{missed}, and @samp{note}.
12275 @end table
12277 One or more of the following option keywords can be used to describe a
12278 group of optimizations:
12280 @table @samp
12281 @item ipa
12282 Enable dumps from all interprocedural optimizations.
12283 @item loop
12284 Enable dumps from all loop optimizations.
12285 @item inline
12286 Enable dumps from all inlining optimizations.
12287 @item vec
12288 Enable dumps from all vectorization optimizations.
12289 @item optall
12290 Enable dumps from all optimizations. This is a superset of
12291 the optimization groups listed above.
12292 @end table
12294 If @var{options} is
12295 omitted, it defaults to @samp{optimized-optall}, which means to dump all
12296 info about successful optimizations from all the passes.  
12298 If the @var{filename} is provided, then the dumps from all the
12299 applicable optimizations are concatenated into the @var{filename}.
12300 Otherwise the dump is output onto @file{stderr}. Though multiple
12301 @option{-fopt-info} options are accepted, only one of them can include
12302 a @var{filename}. If other filenames are provided then all but the
12303 first such option are ignored.
12305 Note that the output @var{filename} is overwritten
12306 in case of multiple translation units. If a combined output from
12307 multiple translation units is desired, @file{stderr} should be used
12308 instead.
12310 In the following example, the optimization info is output to
12311 @file{stderr}:
12313 @smallexample
12314 gcc -O3 -fopt-info
12315 @end smallexample
12317 This example:
12318 @smallexample
12319 gcc -O3 -fopt-info-missed=missed.all
12320 @end smallexample
12322 @noindent
12323 outputs missed optimization report from all the passes into
12324 @file{missed.all}, and this one:
12326 @smallexample
12327 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
12328 @end smallexample
12330 @noindent
12331 prints information about missed optimization opportunities from
12332 vectorization passes on @file{stderr}.  
12333 Note that @option{-fopt-info-vec-missed} is equivalent to 
12334 @option{-fopt-info-missed-vec}.
12336 As another example,
12337 @smallexample
12338 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
12339 @end smallexample
12341 @noindent
12342 outputs information about missed optimizations as well as
12343 optimized locations from all the inlining passes into
12344 @file{inline.txt}.
12346 Finally, consider:
12348 @smallexample
12349 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
12350 @end smallexample
12352 @noindent
12353 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
12354 in conflict since only one output file is allowed. In this case, only
12355 the first option takes effect and the subsequent options are
12356 ignored. Thus only @file{vec.miss} is produced which contains
12357 dumps from the vectorizer about missed opportunities.
12359 @item -fsched-verbose=@var{n}
12360 @opindex fsched-verbose
12361 On targets that use instruction scheduling, this option controls the
12362 amount of debugging output the scheduler prints to the dump files.
12364 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
12365 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
12366 For @var{n} greater than one, it also output basic block probabilities,
12367 detailed ready list information and unit/insn info.  For @var{n} greater
12368 than two, it includes RTL at abort point, control-flow and regions info.
12369 And for @var{n} over four, @option{-fsched-verbose} also includes
12370 dependence info.
12374 @item -fenable-@var{kind}-@var{pass}
12375 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
12376 @opindex fdisable-
12377 @opindex fenable-
12379 This is a set of options that are used to explicitly disable/enable
12380 optimization passes.  These options are intended for use for debugging GCC.
12381 Compiler users should use regular options for enabling/disabling
12382 passes instead.
12384 @table @gcctabopt
12386 @item -fdisable-ipa-@var{pass}
12387 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
12388 statically invoked in the compiler multiple times, the pass name should be
12389 appended with a sequential number starting from 1.
12391 @item -fdisable-rtl-@var{pass}
12392 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
12393 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
12394 statically invoked in the compiler multiple times, the pass name should be
12395 appended with a sequential number starting from 1.  @var{range-list} is a 
12396 comma-separated list of function ranges or assembler names.  Each range is a number
12397 pair separated by a colon.  The range is inclusive in both ends.  If the range
12398 is trivial, the number pair can be simplified as a single number.  If the
12399 function's call graph node's @var{uid} falls within one of the specified ranges,
12400 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
12401 function header of a dump file, and the pass names can be dumped by using
12402 option @option{-fdump-passes}.
12404 @item -fdisable-tree-@var{pass}
12405 @itemx -fdisable-tree-@var{pass}=@var{range-list}
12406 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
12407 option arguments.
12409 @item -fenable-ipa-@var{pass}
12410 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
12411 statically invoked in the compiler multiple times, the pass name should be
12412 appended with a sequential number starting from 1.
12414 @item -fenable-rtl-@var{pass}
12415 @itemx -fenable-rtl-@var{pass}=@var{range-list}
12416 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
12417 description and examples.
12419 @item -fenable-tree-@var{pass}
12420 @itemx -fenable-tree-@var{pass}=@var{range-list}
12421 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
12422 of option arguments.
12424 @end table
12426 Here are some examples showing uses of these options.
12428 @smallexample
12430 # disable ccp1 for all functions
12431    -fdisable-tree-ccp1
12432 # disable complete unroll for function whose cgraph node uid is 1
12433    -fenable-tree-cunroll=1
12434 # disable gcse2 for functions at the following ranges [1,1],
12435 # [300,400], and [400,1000]
12436 # disable gcse2 for functions foo and foo2
12437    -fdisable-rtl-gcse2=foo,foo2
12438 # disable early inlining
12439    -fdisable-tree-einline
12440 # disable ipa inlining
12441    -fdisable-ipa-inline
12442 # enable tree full unroll
12443    -fenable-tree-unroll
12445 @end smallexample
12447 @item -fchecking
12448 @itemx -fchecking=@var{n}
12449 @opindex fchecking
12450 @opindex fno-checking
12451 Enable internal consistency checking.  The default depends on
12452 the compiler configuration.  @option{-fchecking=2} enables further
12453 internal consistency checking that might affect code generation.
12455 @item -frandom-seed=@var{string}
12456 @opindex frandom-seed
12457 This option provides a seed that GCC uses in place of
12458 random numbers in generating certain symbol names
12459 that have to be different in every compiled file.  It is also used to
12460 place unique stamps in coverage data files and the object files that
12461 produce them.  You can use the @option{-frandom-seed} option to produce
12462 reproducibly identical object files.
12464 The @var{string} can either be a number (decimal, octal or hex) or an
12465 arbitrary string (in which case it's converted to a number by
12466 computing CRC32).
12468 The @var{string} should be different for every file you compile.
12470 @item -save-temps
12471 @itemx -save-temps=cwd
12472 @opindex save-temps
12473 Store the usual ``temporary'' intermediate files permanently; place them
12474 in the current directory and name them based on the source file.  Thus,
12475 compiling @file{foo.c} with @option{-c -save-temps} produces files
12476 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
12477 preprocessed @file{foo.i} output file even though the compiler now
12478 normally uses an integrated preprocessor.
12480 When used in combination with the @option{-x} command-line option,
12481 @option{-save-temps} is sensible enough to avoid over writing an
12482 input source file with the same extension as an intermediate file.
12483 The corresponding intermediate file may be obtained by renaming the
12484 source file before using @option{-save-temps}.
12486 If you invoke GCC in parallel, compiling several different source
12487 files that share a common base name in different subdirectories or the
12488 same source file compiled for multiple output destinations, it is
12489 likely that the different parallel compilers will interfere with each
12490 other, and overwrite the temporary files.  For instance:
12492 @smallexample
12493 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
12494 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
12495 @end smallexample
12497 may result in @file{foo.i} and @file{foo.o} being written to
12498 simultaneously by both compilers.
12500 @item -save-temps=obj
12501 @opindex save-temps=obj
12502 Store the usual ``temporary'' intermediate files permanently.  If the
12503 @option{-o} option is used, the temporary files are based on the
12504 object file.  If the @option{-o} option is not used, the
12505 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
12507 For example:
12509 @smallexample
12510 gcc -save-temps=obj -c foo.c
12511 gcc -save-temps=obj -c bar.c -o dir/xbar.o
12512 gcc -save-temps=obj foobar.c -o dir2/yfoobar
12513 @end smallexample
12515 @noindent
12516 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
12517 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
12518 @file{dir2/yfoobar.o}.
12520 @item -time@r{[}=@var{file}@r{]}
12521 @opindex time
12522 Report the CPU time taken by each subprocess in the compilation
12523 sequence.  For C source files, this is the compiler proper and assembler
12524 (plus the linker if linking is done).
12526 Without the specification of an output file, the output looks like this:
12528 @smallexample
12529 # cc1 0.12 0.01
12530 # as 0.00 0.01
12531 @end smallexample
12533 The first number on each line is the ``user time'', that is time spent
12534 executing the program itself.  The second number is ``system time'',
12535 time spent executing operating system routines on behalf of the program.
12536 Both numbers are in seconds.
12538 With the specification of an output file, the output is appended to the
12539 named file, and it looks like this:
12541 @smallexample
12542 0.12 0.01 cc1 @var{options}
12543 0.00 0.01 as @var{options}
12544 @end smallexample
12546 The ``user time'' and the ``system time'' are moved before the program
12547 name, and the options passed to the program are displayed, so that one
12548 can later tell what file was being compiled, and with which options.
12550 @item -fdump-final-insns@r{[}=@var{file}@r{]}
12551 @opindex fdump-final-insns
12552 Dump the final internal representation (RTL) to @var{file}.  If the
12553 optional argument is omitted (or if @var{file} is @code{.}), the name
12554 of the dump file is determined by appending @code{.gkd} to the
12555 compilation output file name.
12557 @item -fcompare-debug@r{[}=@var{opts}@r{]}
12558 @opindex fcompare-debug
12559 @opindex fno-compare-debug
12560 If no error occurs during compilation, run the compiler a second time,
12561 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
12562 passed to the second compilation.  Dump the final internal
12563 representation in both compilations, and print an error if they differ.
12565 If the equal sign is omitted, the default @option{-gtoggle} is used.
12567 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
12568 and nonzero, implicitly enables @option{-fcompare-debug}.  If
12569 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
12570 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
12571 is used.
12573 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
12574 is equivalent to @option{-fno-compare-debug}, which disables the dumping
12575 of the final representation and the second compilation, preventing even
12576 @env{GCC_COMPARE_DEBUG} from taking effect.
12578 To verify full coverage during @option{-fcompare-debug} testing, set
12579 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
12580 which GCC rejects as an invalid option in any actual compilation
12581 (rather than preprocessing, assembly or linking).  To get just a
12582 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
12583 not overridden} will do.
12585 @item -fcompare-debug-second
12586 @opindex fcompare-debug-second
12587 This option is implicitly passed to the compiler for the second
12588 compilation requested by @option{-fcompare-debug}, along with options to
12589 silence warnings, and omitting other options that would cause
12590 side-effect compiler outputs to files or to the standard output.  Dump
12591 files and preserved temporary files are renamed so as to contain the
12592 @code{.gk} additional extension during the second compilation, to avoid
12593 overwriting those generated by the first.
12595 When this option is passed to the compiler driver, it causes the
12596 @emph{first} compilation to be skipped, which makes it useful for little
12597 other than debugging the compiler proper.
12599 @item -gtoggle
12600 @opindex gtoggle
12601 Turn off generation of debug info, if leaving out this option
12602 generates it, or turn it on at level 2 otherwise.  The position of this
12603 argument in the command line does not matter; it takes effect after all
12604 other options are processed, and it does so only once, no matter how
12605 many times it is given.  This is mainly intended to be used with
12606 @option{-fcompare-debug}.
12608 @item -fvar-tracking-assignments-toggle
12609 @opindex fvar-tracking-assignments-toggle
12610 @opindex fno-var-tracking-assignments-toggle
12611 Toggle @option{-fvar-tracking-assignments}, in the same way that
12612 @option{-gtoggle} toggles @option{-g}.
12614 @item -Q
12615 @opindex Q
12616 Makes the compiler print out each function name as it is compiled, and
12617 print some statistics about each pass when it finishes.
12619 @item -ftime-report
12620 @opindex ftime-report
12621 Makes the compiler print some statistics about the time consumed by each
12622 pass when it finishes.
12624 @item -fira-verbose=@var{n}
12625 @opindex fira-verbose
12626 Control the verbosity of the dump file for the integrated register allocator.
12627 The default value is 5.  If the value @var{n} is greater or equal to 10,
12628 the dump output is sent to stderr using the same format as @var{n} minus 10.
12630 @item -flto-report
12631 @opindex flto-report
12632 Prints a report with internal details on the workings of the link-time
12633 optimizer.  The contents of this report vary from version to version.
12634 It is meant to be useful to GCC developers when processing object
12635 files in LTO mode (via @option{-flto}).
12637 Disabled by default.
12639 @item -flto-report-wpa
12640 @opindex flto-report-wpa
12641 Like @option{-flto-report}, but only print for the WPA phase of Link
12642 Time Optimization.
12644 @item -fmem-report
12645 @opindex fmem-report
12646 Makes the compiler print some statistics about permanent memory
12647 allocation when it finishes.
12649 @item -fmem-report-wpa
12650 @opindex fmem-report-wpa
12651 Makes the compiler print some statistics about permanent memory
12652 allocation for the WPA phase only.
12654 @item -fpre-ipa-mem-report
12655 @opindex fpre-ipa-mem-report
12656 @item -fpost-ipa-mem-report
12657 @opindex fpost-ipa-mem-report
12658 Makes the compiler print some statistics about permanent memory
12659 allocation before or after interprocedural optimization.
12661 @item -fprofile-report
12662 @opindex fprofile-report
12663 Makes the compiler print some statistics about consistency of the
12664 (estimated) profile and effect of individual passes.
12666 @item -fstack-usage
12667 @opindex fstack-usage
12668 Makes the compiler output stack usage information for the program, on a
12669 per-function basis.  The filename for the dump is made by appending
12670 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
12671 the output file, if explicitly specified and it is not an executable,
12672 otherwise it is the basename of the source file.  An entry is made up
12673 of three fields:
12675 @itemize
12676 @item
12677 The name of the function.
12678 @item
12679 A number of bytes.
12680 @item
12681 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
12682 @end itemize
12684 The qualifier @code{static} means that the function manipulates the stack
12685 statically: a fixed number of bytes are allocated for the frame on function
12686 entry and released on function exit; no stack adjustments are otherwise made
12687 in the function.  The second field is this fixed number of bytes.
12689 The qualifier @code{dynamic} means that the function manipulates the stack
12690 dynamically: in addition to the static allocation described above, stack
12691 adjustments are made in the body of the function, for example to push/pop
12692 arguments around function calls.  If the qualifier @code{bounded} is also
12693 present, the amount of these adjustments is bounded at compile time and
12694 the second field is an upper bound of the total amount of stack used by
12695 the function.  If it is not present, the amount of these adjustments is
12696 not bounded at compile time and the second field only represents the
12697 bounded part.
12699 @item -fstats
12700 @opindex fstats
12701 Emit statistics about front-end processing at the end of the compilation.
12702 This option is supported only by the C++ front end, and
12703 the information is generally only useful to the G++ development team.
12705 @item -fdbg-cnt-list
12706 @opindex fdbg-cnt-list
12707 Print the name and the counter upper bound for all debug counters.
12710 @item -fdbg-cnt=@var{counter-value-list}
12711 @opindex fdbg-cnt
12712 Set the internal debug counter upper bound.  @var{counter-value-list}
12713 is a comma-separated list of @var{name}:@var{value} pairs
12714 which sets the upper bound of each debug counter @var{name} to @var{value}.
12715 All debug counters have the initial upper bound of @code{UINT_MAX};
12716 thus @code{dbg_cnt} returns true always unless the upper bound
12717 is set by this option.
12718 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
12719 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
12721 @item -print-file-name=@var{library}
12722 @opindex print-file-name
12723 Print the full absolute name of the library file @var{library} that
12724 would be used when linking---and don't do anything else.  With this
12725 option, GCC does not compile or link anything; it just prints the
12726 file name.
12728 @item -print-multi-directory
12729 @opindex print-multi-directory
12730 Print the directory name corresponding to the multilib selected by any
12731 other switches present in the command line.  This directory is supposed
12732 to exist in @env{GCC_EXEC_PREFIX}.
12734 @item -print-multi-lib
12735 @opindex print-multi-lib
12736 Print the mapping from multilib directory names to compiler switches
12737 that enable them.  The directory name is separated from the switches by
12738 @samp{;}, and each switch starts with an @samp{@@} instead of the
12739 @samp{-}, without spaces between multiple switches.  This is supposed to
12740 ease shell processing.
12742 @item -print-multi-os-directory
12743 @opindex print-multi-os-directory
12744 Print the path to OS libraries for the selected
12745 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
12746 present in the @file{lib} subdirectory and no multilibs are used, this is
12747 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
12748 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
12749 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
12750 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
12752 @item -print-multiarch
12753 @opindex print-multiarch
12754 Print the path to OS libraries for the selected multiarch,
12755 relative to some @file{lib} subdirectory.
12757 @item -print-prog-name=@var{program}
12758 @opindex print-prog-name
12759 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
12761 @item -print-libgcc-file-name
12762 @opindex print-libgcc-file-name
12763 Same as @option{-print-file-name=libgcc.a}.
12765 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
12766 but you do want to link with @file{libgcc.a}.  You can do:
12768 @smallexample
12769 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
12770 @end smallexample
12772 @item -print-search-dirs
12773 @opindex print-search-dirs
12774 Print the name of the configured installation directory and a list of
12775 program and library directories @command{gcc} searches---and don't do anything else.
12777 This is useful when @command{gcc} prints the error message
12778 @samp{installation problem, cannot exec cpp0: No such file or directory}.
12779 To resolve this you either need to put @file{cpp0} and the other compiler
12780 components where @command{gcc} expects to find them, or you can set the environment
12781 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
12782 Don't forget the trailing @samp{/}.
12783 @xref{Environment Variables}.
12785 @item -print-sysroot
12786 @opindex print-sysroot
12787 Print the target sysroot directory that is used during
12788 compilation.  This is the target sysroot specified either at configure
12789 time or using the @option{--sysroot} option, possibly with an extra
12790 suffix that depends on compilation options.  If no target sysroot is
12791 specified, the option prints nothing.
12793 @item -print-sysroot-headers-suffix
12794 @opindex print-sysroot-headers-suffix
12795 Print the suffix added to the target sysroot when searching for
12796 headers, or give an error if the compiler is not configured with such
12797 a suffix---and don't do anything else.
12799 @item -dumpmachine
12800 @opindex dumpmachine
12801 Print the compiler's target machine (for example,
12802 @samp{i686-pc-linux-gnu})---and don't do anything else.
12804 @item -dumpversion
12805 @opindex dumpversion
12806 Print the compiler version (for example, @code{3.0})---and don't do
12807 anything else.
12809 @item -dumpspecs
12810 @opindex dumpspecs
12811 Print the compiler's built-in specs---and don't do anything else.  (This
12812 is used when GCC itself is being built.)  @xref{Spec Files}.
12813 @end table
12815 @node Submodel Options
12816 @section Machine-Dependent Options
12817 @cindex submodel options
12818 @cindex specifying hardware config
12819 @cindex hardware models and configurations, specifying
12820 @cindex target-dependent options
12821 @cindex machine-dependent options
12823 Each target machine supported by GCC can have its own options---for
12824 example, to allow you to compile for a particular processor variant or
12825 ABI, or to control optimizations specific to that machine.  By
12826 convention, the names of machine-specific options start with
12827 @samp{-m}.
12829 Some configurations of the compiler also support additional target-specific
12830 options, usually for compatibility with other compilers on the same
12831 platform.
12833 @c This list is ordered alphanumerically by subsection name.
12834 @c It should be the same order and spelling as these options are listed
12835 @c in Machine Dependent Options
12837 @menu
12838 * AArch64 Options::
12839 * Adapteva Epiphany Options::
12840 * ARC Options::
12841 * ARM Options::
12842 * AVR Options::
12843 * Blackfin Options::
12844 * C6X Options::
12845 * CRIS Options::
12846 * CR16 Options::
12847 * Darwin Options::
12848 * DEC Alpha Options::
12849 * FR30 Options::
12850 * FT32 Options::
12851 * FRV Options::
12852 * GNU/Linux Options::
12853 * H8/300 Options::
12854 * HPPA Options::
12855 * IA-64 Options::
12856 * LM32 Options::
12857 * M32C Options::
12858 * M32R/D Options::
12859 * M680x0 Options::
12860 * MCore Options::
12861 * MeP Options::
12862 * MicroBlaze Options::
12863 * MIPS Options::
12864 * MMIX Options::
12865 * MN10300 Options::
12866 * Moxie Options::
12867 * MSP430 Options::
12868 * NDS32 Options::
12869 * Nios II Options::
12870 * Nvidia PTX Options::
12871 * PDP-11 Options::
12872 * picoChip Options::
12873 * PowerPC Options::
12874 * RL78 Options::
12875 * RS/6000 and PowerPC Options::
12876 * RX Options::
12877 * S/390 and zSeries Options::
12878 * Score Options::
12879 * SH Options::
12880 * Solaris 2 Options::
12881 * SPARC Options::
12882 * SPU Options::
12883 * System V Options::
12884 * TILE-Gx Options::
12885 * TILEPro Options::
12886 * V850 Options::
12887 * VAX Options::
12888 * Visium Options::
12889 * VMS Options::
12890 * VxWorks Options::
12891 * x86 Options::
12892 * x86 Windows Options::
12893 * Xstormy16 Options::
12894 * Xtensa Options::
12895 * zSeries Options::
12896 @end menu
12898 @node AArch64 Options
12899 @subsection AArch64 Options
12900 @cindex AArch64 Options
12902 These options are defined for AArch64 implementations:
12904 @table @gcctabopt
12906 @item -mabi=@var{name}
12907 @opindex mabi
12908 Generate code for the specified data model.  Permissible values
12909 are @samp{ilp32} for SysV-like data model where int, long int and pointers
12910 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
12911 but long int and pointers are 64 bits.
12913 The default depends on the specific target configuration.  Note that
12914 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
12915 entire program with the same ABI, and link with a compatible set of libraries.
12917 @item -mbig-endian
12918 @opindex mbig-endian
12919 Generate big-endian code.  This is the default when GCC is configured for an
12920 @samp{aarch64_be-*-*} target.
12922 @item -mgeneral-regs-only
12923 @opindex mgeneral-regs-only
12924 Generate code which uses only the general-purpose registers.  This will prevent
12925 the compiler from using floating-point and Advanced SIMD registers but will not
12926 impose any restrictions on the assembler.
12928 @item -mlittle-endian
12929 @opindex mlittle-endian
12930 Generate little-endian code.  This is the default when GCC is configured for an
12931 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12933 @item -mcmodel=tiny
12934 @opindex mcmodel=tiny
12935 Generate code for the tiny code model.  The program and its statically defined
12936 symbols must be within 1MB of each other.  Programs can be statically or
12937 dynamically linked.
12939 @item -mcmodel=small
12940 @opindex mcmodel=small
12941 Generate code for the small code model.  The program and its statically defined
12942 symbols must be within 4GB of each other.  Programs can be statically or
12943 dynamically linked.  This is the default code model.
12945 @item -mcmodel=large
12946 @opindex mcmodel=large
12947 Generate code for the large code model.  This makes no assumptions about
12948 addresses and sizes of sections.  Programs can be statically linked only.
12950 @item -mstrict-align
12951 @opindex mstrict-align
12952 Avoid generating memory accesses that may not be aligned on a natural object
12953 boundary as described in the architecture specification.
12955 @item -momit-leaf-frame-pointer
12956 @itemx -mno-omit-leaf-frame-pointer
12957 @opindex momit-leaf-frame-pointer
12958 @opindex mno-omit-leaf-frame-pointer
12959 Omit or keep the frame pointer in leaf functions.  The former behavior is the
12960 default.
12962 @item -mtls-dialect=desc
12963 @opindex mtls-dialect=desc
12964 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12965 of TLS variables.  This is the default.
12967 @item -mtls-dialect=traditional
12968 @opindex mtls-dialect=traditional
12969 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12970 of TLS variables.
12972 @item -mtls-size=@var{size}
12973 @opindex mtls-size
12974 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
12975 This option requires binutils 2.26 or newer.
12977 @item -mfix-cortex-a53-835769
12978 @itemx -mno-fix-cortex-a53-835769
12979 @opindex mfix-cortex-a53-835769
12980 @opindex mno-fix-cortex-a53-835769
12981 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12982 This involves inserting a NOP instruction between memory instructions and
12983 64-bit integer multiply-accumulate instructions.
12985 @item -mfix-cortex-a53-843419
12986 @itemx -mno-fix-cortex-a53-843419
12987 @opindex mfix-cortex-a53-843419
12988 @opindex mno-fix-cortex-a53-843419
12989 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
12990 This erratum workaround is made at link time and this will only pass the
12991 corresponding flag to the linker.
12993 @item -mlow-precision-recip-sqrt
12994 @item -mno-low-precision-recip-sqrt
12995 @opindex mlow-precision-recip-sqrt
12996 @opindex mno-low-precision-recip-sqrt
12997 Enable or disable reciprocal square root approximation.
12998 This option only has an effect if @option{-ffast-math} or
12999 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13000 precision of reciprocal square root results to about 16 bits for
13001 single precision and to 32 bits for double precision.
13003 @item -march=@var{name}
13004 @opindex march
13005 Specify the name of the target architecture and, optionally, one or
13006 more feature modifiers.  This option has the form
13007 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
13009 The permissible values for @var{arch} are @samp{armv8-a},
13010 @samp{armv8.1-a} or @var{native}.
13012 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
13013 support for the ARMv8.1 architecture extension.  In particular, it
13014 enables the @samp{+crc} and @samp{+lse} features.
13016 The value @samp{native} is available on native AArch64 GNU/Linux and
13017 causes the compiler to pick the architecture of the host system.  This
13018 option has no effect if the compiler is unable to recognize the
13019 architecture of the host system,
13021 The permissible values for @var{feature} are listed in the sub-section
13022 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13023 Feature Modifiers}.  Where conflicting feature modifiers are
13024 specified, the right-most feature is used.
13026 GCC uses @var{name} to determine what kind of instructions it can emit
13027 when generating assembly code.  If @option{-march} is specified
13028 without either of @option{-mtune} or @option{-mcpu} also being
13029 specified, the code is tuned to perform well across a range of target
13030 processors implementing the target architecture.
13032 @item -mtune=@var{name}
13033 @opindex mtune
13034 Specify the name of the target processor for which GCC should tune the
13035 performance of the code.  Permissible values for this option are:
13036 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
13037 @samp{cortex-a72}, @samp{exynos-m1}, @samp{qdf24xx}, @samp{thunderx},
13038 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
13039 @samp{native}.
13041 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}
13042 specify that GCC should tune for a big.LITTLE system.
13044 Additionally on native AArch64 GNU/Linux systems the value
13045 @samp{native} tunes performance to the host system.  This option has no effect
13046 if the compiler is unable to recognize the processor of the host system.
13048 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
13049 are specified, the code is tuned to perform well across a range
13050 of target processors.
13052 This option cannot be suffixed by feature modifiers.
13054 @item -mcpu=@var{name}
13055 @opindex mcpu
13056 Specify the name of the target processor, optionally suffixed by one
13057 or more feature modifiers.  This option has the form
13058 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
13059 the permissible values for @var{cpu} are the same as those available
13060 for @option{-mtune}.  The permissible values for @var{feature} are
13061 documented in the sub-section on
13062 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13063 Feature Modifiers}.  Where conflicting feature modifiers are
13064 specified, the right-most feature is used.
13066 GCC uses @var{name} to determine what kind of instructions it can emit when
13067 generating assembly code (as if by @option{-march}) and to determine
13068 the target processor for which to tune for performance (as if
13069 by @option{-mtune}).  Where this option is used in conjunction
13070 with @option{-march} or @option{-mtune}, those options take precedence
13071 over the appropriate part of this option.
13073 @item -moverride=@var{string}
13074 @opindex moverride
13075 Override tuning decisions made by the back-end in response to a
13076 @option{-mtune=} switch.  The syntax, semantics, and accepted values
13077 for @var{string} in this option are not guaranteed to be consistent
13078 across releases.
13080 This option is only intended to be useful when developing GCC.
13082 @item -mpc-relative-literal-loads
13083 @opindex mpc-relative-literal-loads
13084 Enable PC-relative literal loads.  With this option literal pools are
13085 accessed using a single instruction and emitted after each function.  This
13086 limits the maximum size of functions to 1MB.  This is enabled by default for
13087 @option{-mcmodel=tiny}.
13089 @end table
13091 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
13092 @anchor{aarch64-feature-modifiers}
13093 @cindex @option{-march} feature modifiers
13094 @cindex @option{-mcpu} feature modifiers
13095 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
13096 the following and their inverses @option{no@var{feature}}:
13098 @table @samp
13099 @item crc
13100 Enable CRC extension.  This is on by default for
13101 @option{-march=armv8.1-a}.
13102 @item crypto
13103 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
13104 instructions.
13105 @item fp
13106 Enable floating-point instructions.  This is on by default for all possible
13107 values for options @option{-march} and @option{-mcpu}.
13108 @item simd
13109 Enable Advanced SIMD instructions.  This also enables floating-point
13110 instructions.  This is on by default for all possible values for options
13111 @option{-march} and @option{-mcpu}.
13112 @item lse
13113 Enable Large System Extension instructions.  This is on by default for
13114 @option{-march=armv8.1-a}.
13116 @end table
13118 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
13119 Conversely, @option{nofp} implies @option{nosimd}, which implies
13120 @option{nocrypto}.
13122 @node Adapteva Epiphany Options
13123 @subsection Adapteva Epiphany Options
13125 These @samp{-m} options are defined for Adapteva Epiphany:
13127 @table @gcctabopt
13128 @item -mhalf-reg-file
13129 @opindex mhalf-reg-file
13130 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
13131 That allows code to run on hardware variants that lack these registers.
13133 @item -mprefer-short-insn-regs
13134 @opindex mprefer-short-insn-regs
13135 Preferentially allocate registers that allow short instruction generation.
13136 This can result in increased instruction count, so this may either reduce or
13137 increase overall code size.
13139 @item -mbranch-cost=@var{num}
13140 @opindex mbranch-cost
13141 Set the cost of branches to roughly @var{num} ``simple'' instructions.
13142 This cost is only a heuristic and is not guaranteed to produce
13143 consistent results across releases.
13145 @item -mcmove
13146 @opindex mcmove
13147 Enable the generation of conditional moves.
13149 @item -mnops=@var{num}
13150 @opindex mnops
13151 Emit @var{num} NOPs before every other generated instruction.
13153 @item -mno-soft-cmpsf
13154 @opindex mno-soft-cmpsf
13155 For single-precision floating-point comparisons, emit an @code{fsub} instruction
13156 and test the flags.  This is faster than a software comparison, but can
13157 get incorrect results in the presence of NaNs, or when two different small
13158 numbers are compared such that their difference is calculated as zero.
13159 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
13160 software comparisons.
13162 @item -mstack-offset=@var{num}
13163 @opindex mstack-offset
13164 Set the offset between the top of the stack and the stack pointer.
13165 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
13166 can be used by leaf functions without stack allocation.
13167 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
13168 Note also that this option changes the ABI; compiling a program with a
13169 different stack offset than the libraries have been compiled with
13170 generally does not work.
13171 This option can be useful if you want to evaluate if a different stack
13172 offset would give you better code, but to actually use a different stack
13173 offset to build working programs, it is recommended to configure the
13174 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
13176 @item -mno-round-nearest
13177 @opindex mno-round-nearest
13178 Make the scheduler assume that the rounding mode has been set to
13179 truncating.  The default is @option{-mround-nearest}.
13181 @item -mlong-calls
13182 @opindex mlong-calls
13183 If not otherwise specified by an attribute, assume all calls might be beyond
13184 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
13185 function address into a register before performing a (otherwise direct) call.
13186 This is the default.
13188 @item -mshort-calls
13189 @opindex short-calls
13190 If not otherwise specified by an attribute, assume all direct calls are
13191 in the range of the @code{b} / @code{bl} instructions, so use these instructions
13192 for direct calls.  The default is @option{-mlong-calls}.
13194 @item -msmall16
13195 @opindex msmall16
13196 Assume addresses can be loaded as 16-bit unsigned values.  This does not
13197 apply to function addresses for which @option{-mlong-calls} semantics
13198 are in effect.
13200 @item -mfp-mode=@var{mode}
13201 @opindex mfp-mode
13202 Set the prevailing mode of the floating-point unit.
13203 This determines the floating-point mode that is provided and expected
13204 at function call and return time.  Making this mode match the mode you
13205 predominantly need at function start can make your programs smaller and
13206 faster by avoiding unnecessary mode switches.
13208 @var{mode} can be set to one the following values:
13210 @table @samp
13211 @item caller
13212 Any mode at function entry is valid, and retained or restored when
13213 the function returns, and when it calls other functions.
13214 This mode is useful for compiling libraries or other compilation units
13215 you might want to incorporate into different programs with different
13216 prevailing FPU modes, and the convenience of being able to use a single
13217 object file outweighs the size and speed overhead for any extra
13218 mode switching that might be needed, compared with what would be needed
13219 with a more specific choice of prevailing FPU mode.
13221 @item truncate
13222 This is the mode used for floating-point calculations with
13223 truncating (i.e.@: round towards zero) rounding mode.  That includes
13224 conversion from floating point to integer.
13226 @item round-nearest
13227 This is the mode used for floating-point calculations with
13228 round-to-nearest-or-even rounding mode.
13230 @item int
13231 This is the mode used to perform integer calculations in the FPU, e.g.@:
13232 integer multiply, or integer multiply-and-accumulate.
13233 @end table
13235 The default is @option{-mfp-mode=caller}
13237 @item -mnosplit-lohi
13238 @itemx -mno-postinc
13239 @itemx -mno-postmodify
13240 @opindex mnosplit-lohi
13241 @opindex mno-postinc
13242 @opindex mno-postmodify
13243 Code generation tweaks that disable, respectively, splitting of 32-bit
13244 loads, generation of post-increment addresses, and generation of
13245 post-modify addresses.  The defaults are @option{msplit-lohi},
13246 @option{-mpost-inc}, and @option{-mpost-modify}.
13248 @item -mnovect-double
13249 @opindex mno-vect-double
13250 Change the preferred SIMD mode to SImode.  The default is
13251 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
13253 @item -max-vect-align=@var{num}
13254 @opindex max-vect-align
13255 The maximum alignment for SIMD vector mode types.
13256 @var{num} may be 4 or 8.  The default is 8.
13257 Note that this is an ABI change, even though many library function
13258 interfaces are unaffected if they don't use SIMD vector modes
13259 in places that affect size and/or alignment of relevant types.
13261 @item -msplit-vecmove-early
13262 @opindex msplit-vecmove-early
13263 Split vector moves into single word moves before reload.  In theory this
13264 can give better register allocation, but so far the reverse seems to be
13265 generally the case.
13267 @item -m1reg-@var{reg}
13268 @opindex m1reg-
13269 Specify a register to hold the constant @minus{}1, which makes loading small negative
13270 constants and certain bitmasks faster.
13271 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
13272 which specify use of that register as a fixed register,
13273 and @samp{none}, which means that no register is used for this
13274 purpose.  The default is @option{-m1reg-none}.
13276 @end table
13278 @node ARC Options
13279 @subsection ARC Options
13280 @cindex ARC options
13282 The following options control the architecture variant for which code
13283 is being compiled:
13285 @c architecture variants
13286 @table @gcctabopt
13288 @item -mbarrel-shifter
13289 @opindex mbarrel-shifter
13290 Generate instructions supported by barrel shifter.  This is the default
13291 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
13293 @item -mcpu=@var{cpu}
13294 @opindex mcpu
13295 Set architecture type, register usage, and instruction scheduling
13296 parameters for @var{cpu}.  There are also shortcut alias options
13297 available for backward compatibility and convenience.  Supported
13298 values for @var{cpu} are
13300 @table @samp
13301 @opindex mA6
13302 @opindex mARC600
13303 @item ARC600
13304 @item arc600
13305 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
13307 @item ARC601
13308 @item arc601
13309 @opindex mARC601
13310 Compile for ARC601.  Alias: @option{-mARC601}.
13312 @item ARC700
13313 @item arc700
13314 @opindex mA7
13315 @opindex mARC700
13316 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
13317 This is the default when configured with @option{--with-cpu=arc700}@.
13319 @item ARCEM
13320 @item arcem
13321 Compile for ARC EM.
13323 @item ARCHS
13324 @item archs
13325 Compile for ARC HS.
13326 @end table
13328 @item -mdpfp
13329 @opindex mdpfp
13330 @itemx -mdpfp-compact
13331 @opindex mdpfp-compact
13332 FPX: Generate Double Precision FPX instructions, tuned for the compact
13333 implementation.
13335 @item -mdpfp-fast
13336 @opindex mdpfp-fast
13337 FPX: Generate Double Precision FPX instructions, tuned for the fast
13338 implementation.
13340 @item -mno-dpfp-lrsr
13341 @opindex mno-dpfp-lrsr
13342 Disable LR and SR instructions from using FPX extension aux registers.
13344 @item -mea
13345 @opindex mea
13346 Generate Extended arithmetic instructions.  Currently only
13347 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
13348 supported.  This is always enabled for @option{-mcpu=ARC700}.
13350 @item -mno-mpy
13351 @opindex mno-mpy
13352 Do not generate mpy instructions for ARC700.
13354 @item -mmul32x16
13355 @opindex mmul32x16
13356 Generate 32x16 bit multiply and mac instructions.
13358 @item -mmul64
13359 @opindex mmul64
13360 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
13362 @item -mnorm
13363 @opindex mnorm
13364 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
13365 is in effect.
13367 @item -mspfp
13368 @opindex mspfp
13369 @itemx -mspfp-compact
13370 @opindex mspfp-compact
13371 FPX: Generate Single Precision FPX instructions, tuned for the compact
13372 implementation.
13374 @item -mspfp-fast
13375 @opindex mspfp-fast
13376 FPX: Generate Single Precision FPX instructions, tuned for the fast
13377 implementation.
13379 @item -msimd
13380 @opindex msimd
13381 Enable generation of ARC SIMD instructions via target-specific
13382 builtins.  Only valid for @option{-mcpu=ARC700}.
13384 @item -msoft-float
13385 @opindex msoft-float
13386 This option ignored; it is provided for compatibility purposes only.
13387 Software floating point code is emitted by default, and this default
13388 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
13389 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
13390 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
13392 @item -mswap
13393 @opindex mswap
13394 Generate swap instructions.
13396 @item -matomic
13397 @opindex matomic
13398 This enables Locked Load/Store Conditional extension to implement
13399 atomic memopry built-in functions.  Not available for ARC 6xx or ARC
13400 EM cores.
13402 @item -mdiv-rem
13403 @opindex mdiv-rem
13404 Enable DIV/REM instructions for ARCv2 cores.
13406 @item -mcode-density
13407 @opindex mcode-density
13408 Enable code density instructions for ARC EM, default on for ARC HS.
13410 @item -mll64
13411 @opindex mll64
13412 Enable double load/store operations for ARC HS cores.
13414 @item -mtp-regno=@var{regno}
13415 @opindex mtp-regno
13416 Specify thread pointer register number.
13418 @item -mmpy-option=@var{multo}
13419 @opindex mmpy-option
13420 Compile ARCv2 code with a multiplier design option.  @samp{wlh1} is
13421 the default value.  The recognized values for @var{multo} are:
13423 @table @samp
13424 @item 0
13425 No multiplier available.
13427 @item 1
13428 @opindex w
13429 The multiply option is set to w: 16x16 multiplier, fully pipelined.
13430 The following instructions are enabled: MPYW, and MPYUW.
13432 @item 2
13433 @opindex wlh1
13434 The multiply option is set to wlh1: 32x32 multiplier, fully
13435 pipelined (1 stage).  The following instructions are additionally
13436 enabled: MPY, MPYU, MPYM, MPYMU, and MPY_S.
13438 @item 3
13439 @opindex wlh2
13440 The multiply option is set to wlh2: 32x32 multiplier, fully pipelined
13441 (2 stages).  The following instructions are additionally enabled: MPY,
13442 MPYU, MPYM, MPYMU, and MPY_S.
13444 @item 4
13445 @opindex wlh3
13446 The multiply option is set to wlh3: Two 16x16 multiplier, blocking,
13447 sequential.  The following instructions are additionally enabled: MPY,
13448 MPYU, MPYM, MPYMU, and MPY_S.
13450 @item 5
13451 @opindex wlh4
13452 The multiply option is set to wlh4: One 16x16 multiplier, blocking,
13453 sequential.  The following instructions are additionally enabled: MPY,
13454 MPYU, MPYM, MPYMU, and MPY_S.
13456 @item 6
13457 @opindex wlh5
13458 The multiply option is set to wlh5: One 32x4 multiplier, blocking,
13459 sequential.  The following instructions are additionally enabled: MPY,
13460 MPYU, MPYM, MPYMU, and MPY_S.
13462 @end table
13464 This option is only available for ARCv2 cores@.
13466 @item -mfpu=@var{fpu}
13467 @opindex mfpu
13468 Enables specific floating-point hardware extension for ARCv2
13469 core.  Supported values for @var{fpu} are:
13471 @table @samp
13473 @item fpus
13474 @opindex fpus
13475 Enables support for single precision floating point hardware
13476 extensions@.
13478 @item fpud
13479 @opindex fpud
13480 Enables support for double precision floating point hardware
13481 extensions.  The single precision floating point extension is also
13482 enabled.  Not available for ARC EM@.
13484 @item fpuda
13485 @opindex fpuda
13486 Enables support for double precision floating point hardware
13487 extensions using double precision assist instructions.  The single
13488 precision floating point extension is also enabled.  This option is
13489 only available for ARC EM@.
13491 @item fpuda_div
13492 @opindex fpuda_div
13493 Enables support for double precision floating point hardware
13494 extensions using double precision assist instructions, and simple
13495 precision square-root and divide hardware extensions.  The single
13496 precision floating point extension is also enabled.  This option is
13497 only available for ARC EM@.
13499 @item fpuda_fma
13500 @opindex fpuda_fma
13501 Enables support for double precision floating point hardware
13502 extensions using double precision assist instructions, and simple
13503 precision fused multiple and add hardware extension.  The single
13504 precision floating point extension is also enabled.  This option is
13505 only available for ARC EM@.
13507 @item fpuda_all
13508 @opindex fpuda_all
13509 Enables support for double precision floating point hardware
13510 extensions using double precision assist instructions, and all simple
13511 precision hardware extensions.  The single precision floating point
13512 extension is also enabled.  This option is only available for ARC EM@.
13514 @item fpus_div
13515 @opindex fpus_div
13516 Enables support for single precision floating point, and single
13517 precision square-root and divide hardware extensions@.
13519 @item fpud_div
13520 @opindex fpud_div
13521 Enables support for double precision floating point, and double
13522 precision square-root and divide hardware extensions.  This option
13523 includes option @samp{fpus_div}. Not available for ARC EM@.
13525 @item fpus_fma
13526 @opindex fpus_fma
13527 Enables support for single precision floating point, and single
13528 precision fused multiple and add hardware extensions@.
13530 @item fpud_fma
13531 @opindex fpud_fma
13532 Enables support for double precision floating point, and double
13533 precision fused multiple and add hardware extensions.  This option
13534 includes option @samp{fpus_fma}.  Not available for ARC EM@.
13536 @item fpus_all
13537 @opindex fpus_all
13538 Enables support for all single precision floating point hardware
13539 extensions@.
13541 @item fpud_all
13542 @opindex fpud_all
13543 Enables support for all single and double precision floating point
13544 hardware extensions.  Not available for ARC EM@.
13546 @end table
13548 @end table
13550 The following options are passed through to the assembler, and also
13551 define preprocessor macro symbols.
13553 @c Flags used by the assembler, but for which we define preprocessor
13554 @c macro symbols as well.
13555 @table @gcctabopt
13556 @item -mdsp-packa
13557 @opindex mdsp-packa
13558 Passed down to the assembler to enable the DSP Pack A extensions.
13559 Also sets the preprocessor symbol @code{__Xdsp_packa}.
13561 @item -mdvbf
13562 @opindex mdvbf
13563 Passed down to the assembler to enable the dual viterbi butterfly
13564 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
13566 @c ARC700 4.10 extension instruction
13567 @item -mlock
13568 @opindex mlock
13569 Passed down to the assembler to enable the Locked Load/Store
13570 Conditional extension.  Also sets the preprocessor symbol
13571 @code{__Xlock}.
13573 @item -mmac-d16
13574 @opindex mmac-d16
13575 Passed down to the assembler.  Also sets the preprocessor symbol
13576 @code{__Xxmac_d16}.
13578 @item -mmac-24
13579 @opindex mmac-24
13580 Passed down to the assembler.  Also sets the preprocessor symbol
13581 @code{__Xxmac_24}.
13583 @c ARC700 4.10 extension instruction
13584 @item -mrtsc
13585 @opindex mrtsc
13586 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
13587 extension instruction.  Also sets the preprocessor symbol
13588 @code{__Xrtsc}.
13590 @c ARC700 4.10 extension instruction
13591 @item -mswape
13592 @opindex mswape
13593 Passed down to the assembler to enable the swap byte ordering
13594 extension instruction.  Also sets the preprocessor symbol
13595 @code{__Xswape}.
13597 @item -mtelephony
13598 @opindex mtelephony
13599 Passed down to the assembler to enable dual and single operand
13600 instructions for telephony.  Also sets the preprocessor symbol
13601 @code{__Xtelephony}.
13603 @item -mxy
13604 @opindex mxy
13605 Passed down to the assembler to enable the XY Memory extension.  Also
13606 sets the preprocessor symbol @code{__Xxy}.
13608 @end table
13610 The following options control how the assembly code is annotated:
13612 @c Assembly annotation options
13613 @table @gcctabopt
13614 @item -misize
13615 @opindex misize
13616 Annotate assembler instructions with estimated addresses.
13618 @item -mannotate-align
13619 @opindex mannotate-align
13620 Explain what alignment considerations lead to the decision to make an
13621 instruction short or long.
13623 @end table
13625 The following options are passed through to the linker:
13627 @c options passed through to the linker
13628 @table @gcctabopt
13629 @item -marclinux
13630 @opindex marclinux
13631 Passed through to the linker, to specify use of the @code{arclinux} emulation.
13632 This option is enabled by default in tool chains built for
13633 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
13634 when profiling is not requested.
13636 @item -marclinux_prof
13637 @opindex marclinux_prof
13638 Passed through to the linker, to specify use of the
13639 @code{arclinux_prof} emulation.  This option is enabled by default in
13640 tool chains built for @w{@code{arc-linux-uclibc}} and
13641 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
13643 @end table
13645 The following options control the semantics of generated code:
13647 @c semantically relevant code generation options
13648 @table @gcctabopt
13649 @item -mlong-calls
13650 @opindex mlong-calls
13651 Generate call insns as register indirect calls, thus providing access
13652 to the full 32-bit address range.
13654 @item -mmedium-calls
13655 @opindex mmedium-calls
13656 Don't use less than 25 bit addressing range for calls, which is the
13657 offset available for an unconditional branch-and-link
13658 instruction.  Conditional execution of function calls is suppressed, to
13659 allow use of the 25-bit range, rather than the 21-bit range with
13660 conditional branch-and-link.  This is the default for tool chains built
13661 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
13663 @item -mno-sdata
13664 @opindex mno-sdata
13665 Do not generate sdata references.  This is the default for tool chains
13666 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
13667 targets.
13669 @item -mucb-mcount
13670 @opindex mucb-mcount
13671 Instrument with mcount calls as used in UCB code.  I.e. do the
13672 counting in the callee, not the caller.  By default ARC instrumentation
13673 counts in the caller.
13675 @item -mvolatile-cache
13676 @opindex mvolatile-cache
13677 Use ordinarily cached memory accesses for volatile references.  This is the
13678 default.
13680 @item -mno-volatile-cache
13681 @opindex mno-volatile-cache
13682 Enable cache bypass for volatile references.
13684 @end table
13686 The following options fine tune code generation:
13687 @c code generation tuning options
13688 @table @gcctabopt
13689 @item -malign-call
13690 @opindex malign-call
13691 Do alignment optimizations for call instructions.
13693 @item -mauto-modify-reg
13694 @opindex mauto-modify-reg
13695 Enable the use of pre/post modify with register displacement.
13697 @item -mbbit-peephole
13698 @opindex mbbit-peephole
13699 Enable bbit peephole2.
13701 @item -mno-brcc
13702 @opindex mno-brcc
13703 This option disables a target-specific pass in @file{arc_reorg} to
13704 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
13705 generation driven by the combiner pass.
13707 @item -mcase-vector-pcrel
13708 @opindex mcase-vector-pcrel
13709 Use pc-relative switch case tables - this enables case table shortening.
13710 This is the default for @option{-Os}.
13712 @item -mcompact-casesi
13713 @opindex mcompact-casesi
13714 Enable compact casesi pattern.
13715 This is the default for @option{-Os}.
13717 @item -mno-cond-exec
13718 @opindex mno-cond-exec
13719 Disable ARCompact specific pass to generate conditional execution instructions.
13720 Due to delay slot scheduling and interactions between operand numbers,
13721 literal sizes, instruction lengths, and the support for conditional execution,
13722 the target-independent pass to generate conditional execution is often lacking,
13723 so the ARC port has kept a special pass around that tries to find more
13724 conditional execution generating opportunities after register allocation,
13725 branch shortening, and delay slot scheduling have been done.  This pass
13726 generally, but not always, improves performance and code size, at the cost of
13727 extra compilation time, which is why there is an option to switch it off.
13728 If you have a problem with call instructions exceeding their allowable
13729 offset range because they are conditionalized, you should consider using
13730 @option{-mmedium-calls} instead.
13732 @item -mearly-cbranchsi
13733 @opindex mearly-cbranchsi
13734 Enable pre-reload use of the cbranchsi pattern.
13736 @item -mexpand-adddi
13737 @opindex mexpand-adddi
13738 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
13739 @code{add.f}, @code{adc} etc.
13741 @item -mindexed-loads
13742 @opindex mindexed-loads
13743 Enable the use of indexed loads.  This can be problematic because some
13744 optimizers then assume that indexed stores exist, which is not
13745 the case.
13747 @opindex mlra
13748 Enable Local Register Allocation.  This is still experimental for ARC,
13749 so by default the compiler uses standard reload
13750 (i.e. @option{-mno-lra}).
13752 @item -mlra-priority-none
13753 @opindex mlra-priority-none
13754 Don't indicate any priority for target registers.
13756 @item -mlra-priority-compact
13757 @opindex mlra-priority-compact
13758 Indicate target register priority for r0..r3 / r12..r15.
13760 @item -mlra-priority-noncompact
13761 @opindex mlra-priority-noncompact
13762 Reduce target register priority for r0..r3 / r12..r15.
13764 @item -mno-millicode
13765 @opindex mno-millicode
13766 When optimizing for size (using @option{-Os}), prologues and epilogues
13767 that have to save or restore a large number of registers are often
13768 shortened by using call to a special function in libgcc; this is
13769 referred to as a @emph{millicode} call.  As these calls can pose
13770 performance issues, and/or cause linking issues when linking in a
13771 nonstandard way, this option is provided to turn off millicode call
13772 generation.
13774 @item -mmixed-code
13775 @opindex mmixed-code
13776 Tweak register allocation to help 16-bit instruction generation.
13777 This generally has the effect of decreasing the average instruction size
13778 while increasing the instruction count.
13780 @item -mq-class
13781 @opindex mq-class
13782 Enable 'q' instruction alternatives.
13783 This is the default for @option{-Os}.
13785 @item -mRcq
13786 @opindex mRcq
13787 Enable Rcq constraint handling - most short code generation depends on this.
13788 This is the default.
13790 @item -mRcw
13791 @opindex mRcw
13792 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
13793 This is the default.
13795 @item -msize-level=@var{level}
13796 @opindex msize-level
13797 Fine-tune size optimization with regards to instruction lengths and alignment.
13798 The recognized values for @var{level} are:
13799 @table @samp
13800 @item 0
13801 No size optimization.  This level is deprecated and treated like @samp{1}.
13803 @item 1
13804 Short instructions are used opportunistically.
13806 @item 2
13807 In addition, alignment of loops and of code after barriers are dropped.
13809 @item 3
13810 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
13812 @end table
13814 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
13815 the behavior when this is not set is equivalent to level @samp{1}.
13817 @item -mtune=@var{cpu}
13818 @opindex mtune
13819 Set instruction scheduling parameters for @var{cpu}, overriding any implied
13820 by @option{-mcpu=}.
13822 Supported values for @var{cpu} are
13824 @table @samp
13825 @item ARC600
13826 Tune for ARC600 cpu.
13828 @item ARC601
13829 Tune for ARC601 cpu.
13831 @item ARC700
13832 Tune for ARC700 cpu with standard multiplier block.
13834 @item ARC700-xmac
13835 Tune for ARC700 cpu with XMAC block.
13837 @item ARC725D
13838 Tune for ARC725D cpu.
13840 @item ARC750D
13841 Tune for ARC750D cpu.
13843 @end table
13845 @item -mmultcost=@var{num}
13846 @opindex mmultcost
13847 Cost to assume for a multiply instruction, with @samp{4} being equal to a
13848 normal instruction.
13850 @item -munalign-prob-threshold=@var{probability}
13851 @opindex munalign-prob-threshold
13852 Set probability threshold for unaligning branches.
13853 When tuning for @samp{ARC700} and optimizing for speed, branches without
13854 filled delay slot are preferably emitted unaligned and long, unless
13855 profiling indicates that the probability for the branch to be taken
13856 is below @var{probability}.  @xref{Cross-profiling}.
13857 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13859 @end table
13861 The following options are maintained for backward compatibility, but
13862 are now deprecated and will be removed in a future release:
13864 @c Deprecated options
13865 @table @gcctabopt
13867 @item -margonaut
13868 @opindex margonaut
13869 Obsolete FPX.
13871 @item -mbig-endian
13872 @opindex mbig-endian
13873 @itemx -EB
13874 @opindex EB
13875 Compile code for big endian targets.  Use of these options is now
13876 deprecated.  Users wanting big-endian code, should use the
13877 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13878 building the tool chain, for which big-endian is the default.
13880 @item -mlittle-endian
13881 @opindex mlittle-endian
13882 @itemx -EL
13883 @opindex EL
13884 Compile code for little endian targets.  Use of these options is now
13885 deprecated.  Users wanting little-endian code should use the
13886 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13887 building the tool chain, for which little-endian is the default.
13889 @item -mbarrel_shifter
13890 @opindex mbarrel_shifter
13891 Replaced by @option{-mbarrel-shifter}.
13893 @item -mdpfp_compact
13894 @opindex mdpfp_compact
13895 Replaced by @option{-mdpfp-compact}.
13897 @item -mdpfp_fast
13898 @opindex mdpfp_fast
13899 Replaced by @option{-mdpfp-fast}.
13901 @item -mdsp_packa
13902 @opindex mdsp_packa
13903 Replaced by @option{-mdsp-packa}.
13905 @item -mEA
13906 @opindex mEA
13907 Replaced by @option{-mea}.
13909 @item -mmac_24
13910 @opindex mmac_24
13911 Replaced by @option{-mmac-24}.
13913 @item -mmac_d16
13914 @opindex mmac_d16
13915 Replaced by @option{-mmac-d16}.
13917 @item -mspfp_compact
13918 @opindex mspfp_compact
13919 Replaced by @option{-mspfp-compact}.
13921 @item -mspfp_fast
13922 @opindex mspfp_fast
13923 Replaced by @option{-mspfp-fast}.
13925 @item -mtune=@var{cpu}
13926 @opindex mtune
13927 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13928 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13929 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13931 @item -multcost=@var{num}
13932 @opindex multcost
13933 Replaced by @option{-mmultcost}.
13935 @end table
13937 @node ARM Options
13938 @subsection ARM Options
13939 @cindex ARM options
13941 These @samp{-m} options are defined for the ARM port:
13943 @table @gcctabopt
13944 @item -mabi=@var{name}
13945 @opindex mabi
13946 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13947 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13949 @item -mapcs-frame
13950 @opindex mapcs-frame
13951 Generate a stack frame that is compliant with the ARM Procedure Call
13952 Standard for all functions, even if this is not strictly necessary for
13953 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13954 with this option causes the stack frames not to be generated for
13955 leaf functions.  The default is @option{-mno-apcs-frame}.
13956 This option is deprecated.
13958 @item -mapcs
13959 @opindex mapcs
13960 This is a synonym for @option{-mapcs-frame} and is deprecated.
13962 @ignore
13963 @c not currently implemented
13964 @item -mapcs-stack-check
13965 @opindex mapcs-stack-check
13966 Generate code to check the amount of stack space available upon entry to
13967 every function (that actually uses some stack space).  If there is
13968 insufficient space available then either the function
13969 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13970 called, depending upon the amount of stack space required.  The runtime
13971 system is required to provide these functions.  The default is
13972 @option{-mno-apcs-stack-check}, since this produces smaller code.
13974 @c not currently implemented
13975 @item -mapcs-float
13976 @opindex mapcs-float
13977 Pass floating-point arguments using the floating-point registers.  This is
13978 one of the variants of the APCS@.  This option is recommended if the
13979 target hardware has a floating-point unit or if a lot of floating-point
13980 arithmetic is going to be performed by the code.  The default is
13981 @option{-mno-apcs-float}, since the size of integer-only code is 
13982 slightly increased if @option{-mapcs-float} is used.
13984 @c not currently implemented
13985 @item -mapcs-reentrant
13986 @opindex mapcs-reentrant
13987 Generate reentrant, position-independent code.  The default is
13988 @option{-mno-apcs-reentrant}.
13989 @end ignore
13991 @item -mthumb-interwork
13992 @opindex mthumb-interwork
13993 Generate code that supports calling between the ARM and Thumb
13994 instruction sets.  Without this option, on pre-v5 architectures, the
13995 two instruction sets cannot be reliably used inside one program.  The
13996 default is @option{-mno-thumb-interwork}, since slightly larger code
13997 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13998 configurations this option is meaningless.
14000 @item -mno-sched-prolog
14001 @opindex mno-sched-prolog
14002 Prevent the reordering of instructions in the function prologue, or the
14003 merging of those instruction with the instructions in the function's
14004 body.  This means that all functions start with a recognizable set
14005 of instructions (or in fact one of a choice from a small set of
14006 different function prologues), and this information can be used to
14007 locate the start of functions inside an executable piece of code.  The
14008 default is @option{-msched-prolog}.
14010 @item -mfloat-abi=@var{name}
14011 @opindex mfloat-abi
14012 Specifies which floating-point ABI to use.  Permissible values
14013 are: @samp{soft}, @samp{softfp} and @samp{hard}.
14015 Specifying @samp{soft} causes GCC to generate output containing
14016 library calls for floating-point operations.
14017 @samp{softfp} allows the generation of code using hardware floating-point
14018 instructions, but still uses the soft-float calling conventions.
14019 @samp{hard} allows generation of floating-point instructions
14020 and uses FPU-specific calling conventions.
14022 The default depends on the specific target configuration.  Note that
14023 the hard-float and soft-float ABIs are not link-compatible; you must
14024 compile your entire program with the same ABI, and link with a
14025 compatible set of libraries.
14027 @item -mlittle-endian
14028 @opindex mlittle-endian
14029 Generate code for a processor running in little-endian mode.  This is
14030 the default for all standard configurations.
14032 @item -mbig-endian
14033 @opindex mbig-endian
14034 Generate code for a processor running in big-endian mode; the default is
14035 to compile code for a little-endian processor.
14037 @item -march=@var{name}
14038 @opindex march
14039 This specifies the name of the target ARM architecture.  GCC uses this
14040 name to determine what kind of instructions it can emit when generating
14041 assembly code.  This option can be used in conjunction with or instead
14042 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
14043 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
14044 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
14045 @samp{armv6}, @samp{armv6j},
14046 @samp{armv6t2}, @samp{armv6z}, @samp{armv6kz}, @samp{armv6-m},
14047 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
14048 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
14049 @samp{armv8.1-a+crc}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
14051 Architecture revisions older than @option{armv4t} are deprecated.
14053 @option{-march=armv7ve} is the armv7-a architecture with virtualization
14054 extensions.
14056 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
14057 architecture together with the optional CRC32 extensions.
14059 @option{-march=native} causes the compiler to auto-detect the architecture
14060 of the build computer.  At present, this feature is only supported on
14061 GNU/Linux, and not all architectures are recognized.  If the auto-detect
14062 is unsuccessful the option has no effect.
14064 @item -mtune=@var{name}
14065 @opindex mtune
14066 This option specifies the name of the target ARM processor for
14067 which GCC should tune the performance of the code.
14068 For some ARM implementations better performance can be obtained by using
14069 this option.
14070 Permissible names are: @samp{arm2}, @samp{arm250},
14071 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
14072 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
14073 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
14074 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
14075 @samp{arm720},
14076 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
14077 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
14078 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
14079 @samp{strongarm1110},
14080 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
14081 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
14082 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
14083 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
14084 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
14085 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
14086 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
14087 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
14088 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
14089 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
14090 @samp{cortex-a72}, @samp{cortex-r4},
14091 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
14092 @samp{cortex-m7},
14093 @samp{cortex-m4},
14094 @samp{cortex-m3},
14095 @samp{cortex-m1},
14096 @samp{cortex-m0},
14097 @samp{cortex-m0plus},
14098 @samp{cortex-m1.small-multiply},
14099 @samp{cortex-m0.small-multiply},
14100 @samp{cortex-m0plus.small-multiply},
14101 @samp{exynos-m1},
14102 @samp{qdf24xx},
14103 @samp{marvell-pj4},
14104 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
14105 @samp{fa526}, @samp{fa626},
14106 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
14107 @samp{xgene1}.
14109 Additionally, this option can specify that GCC should tune the performance
14110 of the code for a big.LITTLE system.  Permissible names are:
14111 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
14112 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
14114 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
14115 performance for a blend of processors within architecture @var{arch}.
14116 The aim is to generate code that run well on the current most popular
14117 processors, balancing between optimizations that benefit some CPUs in the
14118 range, and avoiding performance pitfalls of other CPUs.  The effects of
14119 this option may change in future GCC versions as CPU models come and go.
14121 @option{-mtune=native} causes the compiler to auto-detect the CPU
14122 of the build computer.  At present, this feature is only supported on
14123 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
14124 unsuccessful the option has no effect.
14126 @item -mcpu=@var{name}
14127 @opindex mcpu
14128 This specifies the name of the target ARM processor.  GCC uses this name
14129 to derive the name of the target ARM architecture (as if specified
14130 by @option{-march}) and the ARM processor type for which to tune for
14131 performance (as if specified by @option{-mtune}).  Where this option
14132 is used in conjunction with @option{-march} or @option{-mtune},
14133 those options take precedence over the appropriate part of this option.
14135 Permissible names for this option are the same as those for
14136 @option{-mtune}.
14138 @option{-mcpu=generic-@var{arch}} is also permissible, and is
14139 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
14140 See @option{-mtune} for more information.
14142 @option{-mcpu=native} causes the compiler to auto-detect the CPU
14143 of the build computer.  At present, this feature is only supported on
14144 GNU/Linux, and not all architectures are recognized.  If the auto-detect
14145 is unsuccessful the option has no effect.
14147 @item -mfpu=@var{name}
14148 @opindex mfpu
14149 This specifies what floating-point hardware (or hardware emulation) is
14150 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
14151 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
14152 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
14153 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
14154 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
14155 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
14157 If @option{-msoft-float} is specified this specifies the format of
14158 floating-point values.
14160 If the selected floating-point hardware includes the NEON extension
14161 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
14162 operations are not generated by GCC's auto-vectorization pass unless
14163 @option{-funsafe-math-optimizations} is also specified.  This is
14164 because NEON hardware does not fully implement the IEEE 754 standard for
14165 floating-point arithmetic (in particular denormal values are treated as
14166 zero), so the use of NEON instructions may lead to a loss of precision.
14168 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}).
14170 @item -mfp16-format=@var{name}
14171 @opindex mfp16-format
14172 Specify the format of the @code{__fp16} half-precision floating-point type.
14173 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
14174 the default is @samp{none}, in which case the @code{__fp16} type is not
14175 defined.  @xref{Half-Precision}, for more information.
14177 @item -mstructure-size-boundary=@var{n}
14178 @opindex mstructure-size-boundary
14179 The sizes of all structures and unions are rounded up to a multiple
14180 of the number of bits set by this option.  Permissible values are 8, 32
14181 and 64.  The default value varies for different toolchains.  For the COFF
14182 targeted toolchain the default value is 8.  A value of 64 is only allowed
14183 if the underlying ABI supports it.
14185 Specifying a larger number can produce faster, more efficient code, but
14186 can also increase the size of the program.  Different values are potentially
14187 incompatible.  Code compiled with one value cannot necessarily expect to
14188 work with code or libraries compiled with another value, if they exchange
14189 information using structures or unions.
14191 @item -mabort-on-noreturn
14192 @opindex mabort-on-noreturn
14193 Generate a call to the function @code{abort} at the end of a
14194 @code{noreturn} function.  It is executed if the function tries to
14195 return.
14197 @item -mlong-calls
14198 @itemx -mno-long-calls
14199 @opindex mlong-calls
14200 @opindex mno-long-calls
14201 Tells the compiler to perform function calls by first loading the
14202 address of the function into a register and then performing a subroutine
14203 call on this register.  This switch is needed if the target function
14204 lies outside of the 64-megabyte addressing range of the offset-based
14205 version of subroutine call instruction.
14207 Even if this switch is enabled, not all function calls are turned
14208 into long calls.  The heuristic is that static functions, functions
14209 that have the @code{short_call} attribute, functions that are inside
14210 the scope of a @code{#pragma no_long_calls} directive, and functions whose
14211 definitions have already been compiled within the current compilation
14212 unit are not turned into long calls.  The exceptions to this rule are
14213 that weak function definitions, functions with the @code{long_call}
14214 attribute or the @code{section} attribute, and functions that are within
14215 the scope of a @code{#pragma long_calls} directive are always
14216 turned into long calls.
14218 This feature is not enabled by default.  Specifying
14219 @option{-mno-long-calls} restores the default behavior, as does
14220 placing the function calls within the scope of a @code{#pragma
14221 long_calls_off} directive.  Note these switches have no effect on how
14222 the compiler generates code to handle function calls via function
14223 pointers.
14225 @item -msingle-pic-base
14226 @opindex msingle-pic-base
14227 Treat the register used for PIC addressing as read-only, rather than
14228 loading it in the prologue for each function.  The runtime system is
14229 responsible for initializing this register with an appropriate value
14230 before execution begins.
14232 @item -mpic-register=@var{reg}
14233 @opindex mpic-register
14234 Specify the register to be used for PIC addressing.
14235 For standard PIC base case, the default is any suitable register
14236 determined by compiler.  For single PIC base case, the default is
14237 @samp{R9} if target is EABI based or stack-checking is enabled,
14238 otherwise the default is @samp{R10}.
14240 @item -mpic-data-is-text-relative
14241 @opindex mpic-data-is-text-relative
14242 Assume that each data segments are relative to text segment at load time.
14243 Therefore, it permits addressing data using PC-relative operations.
14244 This option is on by default for targets other than VxWorks RTP.
14246 @item -mpoke-function-name
14247 @opindex mpoke-function-name
14248 Write the name of each function into the text section, directly
14249 preceding the function prologue.  The generated code is similar to this:
14251 @smallexample
14252      t0
14253          .ascii "arm_poke_function_name", 0
14254          .align
14255      t1
14256          .word 0xff000000 + (t1 - t0)
14257      arm_poke_function_name
14258          mov     ip, sp
14259          stmfd   sp!, @{fp, ip, lr, pc@}
14260          sub     fp, ip, #4
14261 @end smallexample
14263 When performing a stack backtrace, code can inspect the value of
14264 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
14265 location @code{pc - 12} and the top 8 bits are set, then we know that
14266 there is a function name embedded immediately preceding this location
14267 and has length @code{((pc[-3]) & 0xff000000)}.
14269 @item -mthumb
14270 @itemx -marm
14271 @opindex marm
14272 @opindex mthumb
14274 Select between generating code that executes in ARM and Thumb
14275 states.  The default for most configurations is to generate code
14276 that executes in ARM state, but the default can be changed by
14277 configuring GCC with the @option{--with-mode=}@var{state}
14278 configure option.
14280 You can also override the ARM and Thumb mode for each function
14281 by using the @code{target("thumb")} and @code{target("arm")} function attributes
14282 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
14284 @item -mtpcs-frame
14285 @opindex mtpcs-frame
14286 Generate a stack frame that is compliant with the Thumb Procedure Call
14287 Standard for all non-leaf functions.  (A leaf function is one that does
14288 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
14290 @item -mtpcs-leaf-frame
14291 @opindex mtpcs-leaf-frame
14292 Generate a stack frame that is compliant with the Thumb Procedure Call
14293 Standard for all leaf functions.  (A leaf function is one that does
14294 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
14296 @item -mcallee-super-interworking
14297 @opindex mcallee-super-interworking
14298 Gives all externally visible functions in the file being compiled an ARM
14299 instruction set header which switches to Thumb mode before executing the
14300 rest of the function.  This allows these functions to be called from
14301 non-interworking code.  This option is not valid in AAPCS configurations
14302 because interworking is enabled by default.
14304 @item -mcaller-super-interworking
14305 @opindex mcaller-super-interworking
14306 Allows calls via function pointers (including virtual functions) to
14307 execute correctly regardless of whether the target code has been
14308 compiled for interworking or not.  There is a small overhead in the cost
14309 of executing a function pointer if this option is enabled.  This option
14310 is not valid in AAPCS configurations because interworking is enabled
14311 by default.
14313 @item -mtp=@var{name}
14314 @opindex mtp
14315 Specify the access model for the thread local storage pointer.  The valid
14316 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
14317 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
14318 (supported in the arm6k architecture), and @samp{auto}, which uses the
14319 best available method for the selected processor.  The default setting is
14320 @samp{auto}.
14322 @item -mtls-dialect=@var{dialect}
14323 @opindex mtls-dialect
14324 Specify the dialect to use for accessing thread local storage.  Two
14325 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
14326 @samp{gnu} dialect selects the original GNU scheme for supporting
14327 local and global dynamic TLS models.  The @samp{gnu2} dialect
14328 selects the GNU descriptor scheme, which provides better performance
14329 for shared libraries.  The GNU descriptor scheme is compatible with
14330 the original scheme, but does require new assembler, linker and
14331 library support.  Initial and local exec TLS models are unaffected by
14332 this option and always use the original scheme.
14334 @item -mword-relocations
14335 @opindex mword-relocations
14336 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
14337 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
14338 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
14339 is specified.
14341 @item -mfix-cortex-m3-ldrd
14342 @opindex mfix-cortex-m3-ldrd
14343 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
14344 with overlapping destination and base registers are used.  This option avoids
14345 generating these instructions.  This option is enabled by default when
14346 @option{-mcpu=cortex-m3} is specified.
14348 @item -munaligned-access
14349 @itemx -mno-unaligned-access
14350 @opindex munaligned-access
14351 @opindex mno-unaligned-access
14352 Enables (or disables) reading and writing of 16- and 32- bit values
14353 from addresses that are not 16- or 32- bit aligned.  By default
14354 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
14355 architectures, and enabled for all other architectures.  If unaligned
14356 access is not enabled then words in packed data structures are
14357 accessed a byte at a time.
14359 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
14360 generated object file to either true or false, depending upon the
14361 setting of this option.  If unaligned access is enabled then the
14362 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
14363 defined.
14365 @item -mneon-for-64bits
14366 @opindex mneon-for-64bits
14367 Enables using Neon to handle scalar 64-bits operations. This is
14368 disabled by default since the cost of moving data from core registers
14369 to Neon is high.
14371 @item -mslow-flash-data
14372 @opindex mslow-flash-data
14373 Assume loading data from flash is slower than fetching instruction.
14374 Therefore literal load is minimized for better performance.
14375 This option is only supported when compiling for ARMv7 M-profile and
14376 off by default.
14378 @item -masm-syntax-unified
14379 @opindex masm-syntax-unified
14380 Assume inline assembler is using unified asm syntax.  The default is
14381 currently off which implies divided syntax.  This option has no impact
14382 on Thumb2. However, this may change in future releases of GCC.
14383 Divided syntax should be considered deprecated.
14385 @item -mrestrict-it
14386 @opindex mrestrict-it
14387 Restricts generation of IT blocks to conform to the rules of ARMv8.
14388 IT blocks can only contain a single 16-bit instruction from a select
14389 set of instructions. This option is on by default for ARMv8 Thumb mode.
14391 @item -mprint-tune-info
14392 @opindex mprint-tune-info
14393 Print CPU tuning information as comment in assembler file.  This is
14394 an option used only for regression testing of the compiler and not
14395 intended for ordinary use in compiling code.  This option is disabled
14396 by default.
14397 @end table
14399 @node AVR Options
14400 @subsection AVR Options
14401 @cindex AVR Options
14403 These options are defined for AVR implementations:
14405 @table @gcctabopt
14406 @item -mmcu=@var{mcu}
14407 @opindex mmcu
14408 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
14410 The default for this option is@tie{}@samp{avr2}.
14412 GCC supports the following AVR devices and ISAs:
14414 @include avr-mmcu.texi
14416 @item -maccumulate-args
14417 @opindex maccumulate-args
14418 Accumulate outgoing function arguments and acquire/release the needed
14419 stack space for outgoing function arguments once in function
14420 prologue/epilogue.  Without this option, outgoing arguments are pushed
14421 before calling a function and popped afterwards.
14423 Popping the arguments after the function call can be expensive on
14424 AVR so that accumulating the stack space might lead to smaller
14425 executables because arguments need not to be removed from the
14426 stack after such a function call.
14428 This option can lead to reduced code size for functions that perform
14429 several calls to functions that get their arguments on the stack like
14430 calls to printf-like functions.
14432 @item -mbranch-cost=@var{cost}
14433 @opindex mbranch-cost
14434 Set the branch costs for conditional branch instructions to
14435 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
14436 integers. The default branch cost is 0.
14438 @item -mcall-prologues
14439 @opindex mcall-prologues
14440 Functions prologues/epilogues are expanded as calls to appropriate
14441 subroutines.  Code size is smaller.
14443 @item -mint8
14444 @opindex mint8
14445 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
14446 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
14447 and @code{long long} is 4 bytes.  Please note that this option does not
14448 conform to the C standards, but it results in smaller code
14449 size.
14451 @item -mn-flash=@var{num}
14452 @opindex mn-flash
14453 Assume that the flash memory has a size of 
14454 @var{num} times 64@tie{}KiB.
14456 @item -mno-interrupts
14457 @opindex mno-interrupts
14458 Generated code is not compatible with hardware interrupts.
14459 Code size is smaller.
14461 @item -mrelax
14462 @opindex mrelax
14463 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
14464 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
14465 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
14466 the assembler's command line and the @option{--relax} option to the
14467 linker's command line.
14469 Jump relaxing is performed by the linker because jump offsets are not
14470 known before code is located. Therefore, the assembler code generated by the
14471 compiler is the same, but the instructions in the executable may
14472 differ from instructions in the assembler code.
14474 Relaxing must be turned on if linker stubs are needed, see the
14475 section on @code{EIND} and linker stubs below.
14477 @item -mrmw
14478 @opindex mrmw
14479 Assume that the device supports the Read-Modify-Write
14480 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
14482 @item -msp8
14483 @opindex msp8
14484 Treat the stack pointer register as an 8-bit register,
14485 i.e.@: assume the high byte of the stack pointer is zero.
14486 In general, you don't need to set this option by hand.
14488 This option is used internally by the compiler to select and
14489 build multilibs for architectures @code{avr2} and @code{avr25}.
14490 These architectures mix devices with and without @code{SPH}.
14491 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
14492 the compiler driver adds or removes this option from the compiler
14493 proper's command line, because the compiler then knows if the device
14494 or architecture has an 8-bit stack pointer and thus no @code{SPH}
14495 register or not.
14497 @item -mstrict-X
14498 @opindex mstrict-X
14499 Use address register @code{X} in a way proposed by the hardware.  This means
14500 that @code{X} is only used in indirect, post-increment or
14501 pre-decrement addressing.
14503 Without this option, the @code{X} register may be used in the same way
14504 as @code{Y} or @code{Z} which then is emulated by additional
14505 instructions.  
14506 For example, loading a value with @code{X+const} addressing with a
14507 small non-negative @code{const < 64} to a register @var{Rn} is
14508 performed as
14510 @example
14511 adiw r26, const   ; X += const
14512 ld   @var{Rn}, X        ; @var{Rn} = *X
14513 sbiw r26, const   ; X -= const
14514 @end example
14516 @item -mtiny-stack
14517 @opindex mtiny-stack
14518 Only change the lower 8@tie{}bits of the stack pointer.
14520 @item -nodevicelib
14521 @opindex nodevicelib
14522 Don't link against AVR-LibC's device specific library @code{libdev.a}.
14524 @item -Waddr-space-convert
14525 @opindex Waddr-space-convert
14526 Warn about conversions between address spaces in the case where the
14527 resulting address space is not contained in the incoming address space.
14528 @end table
14530 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
14531 @cindex @code{EIND}
14532 Pointers in the implementation are 16@tie{}bits wide.
14533 The address of a function or label is represented as word address so
14534 that indirect jumps and calls can target any code address in the
14535 range of 64@tie{}Ki words.
14537 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
14538 bytes of program memory space, there is a special function register called
14539 @code{EIND} that serves as most significant part of the target address
14540 when @code{EICALL} or @code{EIJMP} instructions are used.
14542 Indirect jumps and calls on these devices are handled as follows by
14543 the compiler and are subject to some limitations:
14545 @itemize @bullet
14547 @item
14548 The compiler never sets @code{EIND}.
14550 @item
14551 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
14552 instructions or might read @code{EIND} directly in order to emulate an
14553 indirect call/jump by means of a @code{RET} instruction.
14555 @item
14556 The compiler assumes that @code{EIND} never changes during the startup
14557 code or during the application. In particular, @code{EIND} is not
14558 saved/restored in function or interrupt service routine
14559 prologue/epilogue.
14561 @item
14562 For indirect calls to functions and computed goto, the linker
14563 generates @emph{stubs}. Stubs are jump pads sometimes also called
14564 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
14565 The stub contains a direct jump to the desired address.
14567 @item
14568 Linker relaxation must be turned on so that the linker generates
14569 the stubs correctly in all situations. See the compiler option
14570 @option{-mrelax} and the linker option @option{--relax}.
14571 There are corner cases where the linker is supposed to generate stubs
14572 but aborts without relaxation and without a helpful error message.
14574 @item
14575 The default linker script is arranged for code with @code{EIND = 0}.
14576 If code is supposed to work for a setup with @code{EIND != 0}, a custom
14577 linker script has to be used in order to place the sections whose
14578 name start with @code{.trampolines} into the segment where @code{EIND}
14579 points to.
14581 @item
14582 The startup code from libgcc never sets @code{EIND}.
14583 Notice that startup code is a blend of code from libgcc and AVR-LibC.
14584 For the impact of AVR-LibC on @code{EIND}, see the
14585 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
14587 @item
14588 It is legitimate for user-specific startup code to set up @code{EIND}
14589 early, for example by means of initialization code located in
14590 section @code{.init3}. Such code runs prior to general startup code
14591 that initializes RAM and calls constructors, but after the bit
14592 of startup code from AVR-LibC that sets @code{EIND} to the segment
14593 where the vector table is located.
14594 @example
14595 #include <avr/io.h>
14597 static void
14598 __attribute__((section(".init3"),naked,used,no_instrument_function))
14599 init3_set_eind (void)
14601   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
14602                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
14604 @end example
14606 @noindent
14607 The @code{__trampolines_start} symbol is defined in the linker script.
14609 @item
14610 Stubs are generated automatically by the linker if
14611 the following two conditions are met:
14612 @itemize @minus
14614 @item The address of a label is taken by means of the @code{gs} modifier
14615 (short for @emph{generate stubs}) like so:
14616 @example
14617 LDI r24, lo8(gs(@var{func}))
14618 LDI r25, hi8(gs(@var{func}))
14619 @end example
14620 @item The final location of that label is in a code segment
14621 @emph{outside} the segment where the stubs are located.
14622 @end itemize
14624 @item
14625 The compiler emits such @code{gs} modifiers for code labels in the
14626 following situations:
14627 @itemize @minus
14628 @item Taking address of a function or code label.
14629 @item Computed goto.
14630 @item If prologue-save function is used, see @option{-mcall-prologues}
14631 command-line option.
14632 @item Switch/case dispatch tables. If you do not want such dispatch
14633 tables you can specify the @option{-fno-jump-tables} command-line option.
14634 @item C and C++ constructors/destructors called during startup/shutdown.
14635 @item If the tools hit a @code{gs()} modifier explained above.
14636 @end itemize
14638 @item
14639 Jumping to non-symbolic addresses like so is @emph{not} supported:
14641 @example
14642 int main (void)
14644     /* Call function at word address 0x2 */
14645     return ((int(*)(void)) 0x2)();
14647 @end example
14649 Instead, a stub has to be set up, i.e.@: the function has to be called
14650 through a symbol (@code{func_4} in the example):
14652 @example
14653 int main (void)
14655     extern int func_4 (void);
14657     /* Call function at byte address 0x4 */
14658     return func_4();
14660 @end example
14662 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
14663 Alternatively, @code{func_4} can be defined in the linker script.
14664 @end itemize
14666 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
14667 @cindex @code{RAMPD}
14668 @cindex @code{RAMPX}
14669 @cindex @code{RAMPY}
14670 @cindex @code{RAMPZ}
14671 Some AVR devices support memories larger than the 64@tie{}KiB range
14672 that can be accessed with 16-bit pointers.  To access memory locations
14673 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
14674 register is used as high part of the address:
14675 The @code{X}, @code{Y}, @code{Z} address register is concatenated
14676 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
14677 register, respectively, to get a wide address. Similarly,
14678 @code{RAMPD} is used together with direct addressing.
14680 @itemize
14681 @item
14682 The startup code initializes the @code{RAMP} special function
14683 registers with zero.
14685 @item
14686 If a @ref{AVR Named Address Spaces,named address space} other than
14687 generic or @code{__flash} is used, then @code{RAMPZ} is set
14688 as needed before the operation.
14690 @item
14691 If the device supports RAM larger than 64@tie{}KiB and the compiler
14692 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
14693 is reset to zero after the operation.
14695 @item
14696 If the device comes with a specific @code{RAMP} register, the ISR
14697 prologue/epilogue saves/restores that SFR and initializes it with
14698 zero in case the ISR code might (implicitly) use it.
14700 @item
14701 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
14702 If you use inline assembler to read from locations outside the
14703 16-bit address range and change one of the @code{RAMP} registers,
14704 you must reset it to zero after the access.
14706 @end itemize
14708 @subsubsection AVR Built-in Macros
14710 GCC defines several built-in macros so that the user code can test
14711 for the presence or absence of features.  Almost any of the following
14712 built-in macros are deduced from device capabilities and thus
14713 triggered by the @option{-mmcu=} command-line option.
14715 For even more AVR-specific built-in macros see
14716 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
14718 @table @code
14720 @item __AVR_ARCH__
14721 Build-in macro that resolves to a decimal number that identifies the
14722 architecture and depends on the @option{-mmcu=@var{mcu}} option.
14723 Possible values are:
14725 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
14726 @code{4}, @code{5}, @code{51}, @code{6}
14728 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
14729 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
14731 respectively and
14733 @code{100}, @code{102}, @code{104},
14734 @code{105}, @code{106}, @code{107}
14736 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
14737 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
14738 If @var{mcu} specifies a device, this built-in macro is set
14739 accordingly. For example, with @option{-mmcu=atmega8} the macro is
14740 defined to @code{4}.
14742 @item __AVR_@var{Device}__
14743 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
14744 the device's name. For example, @option{-mmcu=atmega8} defines the
14745 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
14746 @code{__AVR_ATtiny261A__}, etc.
14748 The built-in macros' names follow
14749 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
14750 the device name as from the AVR user manual. The difference between
14751 @var{Device} in the built-in macro and @var{device} in
14752 @option{-mmcu=@var{device}} is that the latter is always lowercase.
14754 If @var{device} is not a device but only a core architecture like
14755 @samp{avr51}, this macro is not defined.
14757 @item __AVR_DEVICE_NAME__
14758 Setting @option{-mmcu=@var{device}} defines this built-in macro to
14759 the device's name. For example, with @option{-mmcu=atmega8} the macro
14760 is defined to @code{atmega8}.
14762 If @var{device} is not a device but only a core architecture like
14763 @samp{avr51}, this macro is not defined.
14765 @item __AVR_XMEGA__
14766 The device / architecture belongs to the XMEGA family of devices.
14768 @item __AVR_HAVE_ELPM__
14769 The device has the @code{ELPM} instruction.
14771 @item __AVR_HAVE_ELPMX__
14772 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
14773 R@var{n},Z+} instructions.
14775 @item __AVR_HAVE_MOVW__
14776 The device has the @code{MOVW} instruction to perform 16-bit
14777 register-register moves.
14779 @item __AVR_HAVE_LPMX__
14780 The device has the @code{LPM R@var{n},Z} and
14781 @code{LPM R@var{n},Z+} instructions.
14783 @item __AVR_HAVE_MUL__
14784 The device has a hardware multiplier. 
14786 @item __AVR_HAVE_JMP_CALL__
14787 The device has the @code{JMP} and @code{CALL} instructions.
14788 This is the case for devices with at least 16@tie{}KiB of program
14789 memory.
14791 @item __AVR_HAVE_EIJMP_EICALL__
14792 @itemx __AVR_3_BYTE_PC__
14793 The device has the @code{EIJMP} and @code{EICALL} instructions.
14794 This is the case for devices with more than 128@tie{}KiB of program memory.
14795 This also means that the program counter
14796 (PC) is 3@tie{}bytes wide.
14798 @item __AVR_2_BYTE_PC__
14799 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
14800 with up to 128@tie{}KiB of program memory.
14802 @item __AVR_HAVE_8BIT_SP__
14803 @itemx __AVR_HAVE_16BIT_SP__
14804 The stack pointer (SP) register is treated as 8-bit respectively
14805 16-bit register by the compiler.
14806 The definition of these macros is affected by @option{-mtiny-stack}.
14808 @item __AVR_HAVE_SPH__
14809 @itemx __AVR_SP8__
14810 The device has the SPH (high part of stack pointer) special function
14811 register or has an 8-bit stack pointer, respectively.
14812 The definition of these macros is affected by @option{-mmcu=} and
14813 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
14814 by @option{-msp8}.
14816 @item __AVR_HAVE_RAMPD__
14817 @itemx __AVR_HAVE_RAMPX__
14818 @itemx __AVR_HAVE_RAMPY__
14819 @itemx __AVR_HAVE_RAMPZ__
14820 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
14821 @code{RAMPZ} special function register, respectively.
14823 @item __NO_INTERRUPTS__
14824 This macro reflects the @option{-mno-interrupts} command-line option.
14826 @item __AVR_ERRATA_SKIP__
14827 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
14828 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
14829 instructions because of a hardware erratum.  Skip instructions are
14830 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
14831 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
14832 set.
14834 @item __AVR_ISA_RMW__
14835 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
14837 @item __AVR_SFR_OFFSET__=@var{offset}
14838 Instructions that can address I/O special function registers directly
14839 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
14840 address as if addressed by an instruction to access RAM like @code{LD}
14841 or @code{STS}. This offset depends on the device architecture and has
14842 to be subtracted from the RAM address in order to get the
14843 respective I/O@tie{}address.
14845 @item __WITH_AVRLIBC__
14846 The compiler is configured to be used together with AVR-Libc.
14847 See the @option{--with-avrlibc} configure option.
14849 @end table
14851 @node Blackfin Options
14852 @subsection Blackfin Options
14853 @cindex Blackfin Options
14855 @table @gcctabopt
14856 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
14857 @opindex mcpu=
14858 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
14859 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14860 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14861 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14862 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14863 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14864 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14865 @samp{bf561}, @samp{bf592}.
14867 The optional @var{sirevision} specifies the silicon revision of the target
14868 Blackfin processor.  Any workarounds available for the targeted silicon revision
14869 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14870 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14871 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14872 hexadecimal digits representing the major and minor numbers in the silicon
14873 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14874 is not defined.  If @var{sirevision} is @samp{any}, the
14875 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14876 If this optional @var{sirevision} is not used, GCC assumes the latest known
14877 silicon revision of the targeted Blackfin processor.
14879 GCC defines a preprocessor macro for the specified @var{cpu}.
14880 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14881 provided by libgloss to be linked in if @option{-msim} is not given.
14883 Without this option, @samp{bf532} is used as the processor by default.
14885 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14886 only the preprocessor macro is defined.
14888 @item -msim
14889 @opindex msim
14890 Specifies that the program will be run on the simulator.  This causes
14891 the simulator BSP provided by libgloss to be linked in.  This option
14892 has effect only for @samp{bfin-elf} toolchain.
14893 Certain other options, such as @option{-mid-shared-library} and
14894 @option{-mfdpic}, imply @option{-msim}.
14896 @item -momit-leaf-frame-pointer
14897 @opindex momit-leaf-frame-pointer
14898 Don't keep the frame pointer in a register for leaf functions.  This
14899 avoids the instructions to save, set up and restore frame pointers and
14900 makes an extra register available in leaf functions.  The option
14901 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14902 which might make debugging harder.
14904 @item -mspecld-anomaly
14905 @opindex mspecld-anomaly
14906 When enabled, the compiler ensures that the generated code does not
14907 contain speculative loads after jump instructions. If this option is used,
14908 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14910 @item -mno-specld-anomaly
14911 @opindex mno-specld-anomaly
14912 Don't generate extra code to prevent speculative loads from occurring.
14914 @item -mcsync-anomaly
14915 @opindex mcsync-anomaly
14916 When enabled, the compiler ensures that the generated code does not
14917 contain CSYNC or SSYNC instructions too soon after conditional branches.
14918 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14920 @item -mno-csync-anomaly
14921 @opindex mno-csync-anomaly
14922 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14923 occurring too soon after a conditional branch.
14925 @item -mlow-64k
14926 @opindex mlow-64k
14927 When enabled, the compiler is free to take advantage of the knowledge that
14928 the entire program fits into the low 64k of memory.
14930 @item -mno-low-64k
14931 @opindex mno-low-64k
14932 Assume that the program is arbitrarily large.  This is the default.
14934 @item -mstack-check-l1
14935 @opindex mstack-check-l1
14936 Do stack checking using information placed into L1 scratchpad memory by the
14937 uClinux kernel.
14939 @item -mid-shared-library
14940 @opindex mid-shared-library
14941 Generate code that supports shared libraries via the library ID method.
14942 This allows for execute in place and shared libraries in an environment
14943 without virtual memory management.  This option implies @option{-fPIC}.
14944 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14946 @item -mno-id-shared-library
14947 @opindex mno-id-shared-library
14948 Generate code that doesn't assume ID-based shared libraries are being used.
14949 This is the default.
14951 @item -mleaf-id-shared-library
14952 @opindex mleaf-id-shared-library
14953 Generate code that supports shared libraries via the library ID method,
14954 but assumes that this library or executable won't link against any other
14955 ID shared libraries.  That allows the compiler to use faster code for jumps
14956 and calls.
14958 @item -mno-leaf-id-shared-library
14959 @opindex mno-leaf-id-shared-library
14960 Do not assume that the code being compiled won't link against any ID shared
14961 libraries.  Slower code is generated for jump and call insns.
14963 @item -mshared-library-id=n
14964 @opindex mshared-library-id
14965 Specifies the identification number of the ID-based shared library being
14966 compiled.  Specifying a value of 0 generates more compact code; specifying
14967 other values forces the allocation of that number to the current
14968 library but is no more space- or time-efficient than omitting this option.
14970 @item -msep-data
14971 @opindex msep-data
14972 Generate code that allows the data segment to be located in a different
14973 area of memory from the text segment.  This allows for execute in place in
14974 an environment without virtual memory management by eliminating relocations
14975 against the text section.
14977 @item -mno-sep-data
14978 @opindex mno-sep-data
14979 Generate code that assumes that the data segment follows the text segment.
14980 This is the default.
14982 @item -mlong-calls
14983 @itemx -mno-long-calls
14984 @opindex mlong-calls
14985 @opindex mno-long-calls
14986 Tells the compiler to perform function calls by first loading the
14987 address of the function into a register and then performing a subroutine
14988 call on this register.  This switch is needed if the target function
14989 lies outside of the 24-bit addressing range of the offset-based
14990 version of subroutine call instruction.
14992 This feature is not enabled by default.  Specifying
14993 @option{-mno-long-calls} restores the default behavior.  Note these
14994 switches have no effect on how the compiler generates code to handle
14995 function calls via function pointers.
14997 @item -mfast-fp
14998 @opindex mfast-fp
14999 Link with the fast floating-point library. This library relaxes some of
15000 the IEEE floating-point standard's rules for checking inputs against
15001 Not-a-Number (NAN), in the interest of performance.
15003 @item -minline-plt
15004 @opindex minline-plt
15005 Enable inlining of PLT entries in function calls to functions that are
15006 not known to bind locally.  It has no effect without @option{-mfdpic}.
15008 @item -mmulticore
15009 @opindex mmulticore
15010 Build a standalone application for multicore Blackfin processors. 
15011 This option causes proper start files and link scripts supporting 
15012 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
15013 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
15015 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
15016 selects the one-application-per-core programming model.  Without
15017 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
15018 programming model is used. In this model, the main function of Core B
15019 should be named as @code{coreb_main}.
15021 If this option is not used, the single-core application programming
15022 model is used.
15024 @item -mcorea
15025 @opindex mcorea
15026 Build a standalone application for Core A of BF561 when using
15027 the one-application-per-core programming model. Proper start files
15028 and link scripts are used to support Core A, and the macro
15029 @code{__BFIN_COREA} is defined.
15030 This option can only be used in conjunction with @option{-mmulticore}.
15032 @item -mcoreb
15033 @opindex mcoreb
15034 Build a standalone application for Core B of BF561 when using
15035 the one-application-per-core programming model. Proper start files
15036 and link scripts are used to support Core B, and the macro
15037 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
15038 should be used instead of @code{main}. 
15039 This option can only be used in conjunction with @option{-mmulticore}.
15041 @item -msdram
15042 @opindex msdram
15043 Build a standalone application for SDRAM. Proper start files and
15044 link scripts are used to put the application into SDRAM, and the macro
15045 @code{__BFIN_SDRAM} is defined.
15046 The loader should initialize SDRAM before loading the application.
15048 @item -micplb
15049 @opindex micplb
15050 Assume that ICPLBs are enabled at run time.  This has an effect on certain
15051 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
15052 are enabled; for standalone applications the default is off.
15053 @end table
15055 @node C6X Options
15056 @subsection C6X Options
15057 @cindex C6X Options
15059 @table @gcctabopt
15060 @item -march=@var{name}
15061 @opindex march
15062 This specifies the name of the target architecture.  GCC uses this
15063 name to determine what kind of instructions it can emit when generating
15064 assembly code.  Permissible names are: @samp{c62x},
15065 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
15067 @item -mbig-endian
15068 @opindex mbig-endian
15069 Generate code for a big-endian target.
15071 @item -mlittle-endian
15072 @opindex mlittle-endian
15073 Generate code for a little-endian target.  This is the default.
15075 @item -msim
15076 @opindex msim
15077 Choose startup files and linker script suitable for the simulator.
15079 @item -msdata=default
15080 @opindex msdata=default
15081 Put small global and static data in the @code{.neardata} section,
15082 which is pointed to by register @code{B14}.  Put small uninitialized
15083 global and static data in the @code{.bss} section, which is adjacent
15084 to the @code{.neardata} section.  Put small read-only data into the
15085 @code{.rodata} section.  The corresponding sections used for large
15086 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
15088 @item -msdata=all
15089 @opindex msdata=all
15090 Put all data, not just small objects, into the sections reserved for
15091 small data, and use addressing relative to the @code{B14} register to
15092 access them.
15094 @item -msdata=none
15095 @opindex msdata=none
15096 Make no use of the sections reserved for small data, and use absolute
15097 addresses to access all data.  Put all initialized global and static
15098 data in the @code{.fardata} section, and all uninitialized data in the
15099 @code{.far} section.  Put all constant data into the @code{.const}
15100 section.
15101 @end table
15103 @node CRIS Options
15104 @subsection CRIS Options
15105 @cindex CRIS Options
15107 These options are defined specifically for the CRIS ports.
15109 @table @gcctabopt
15110 @item -march=@var{architecture-type}
15111 @itemx -mcpu=@var{architecture-type}
15112 @opindex march
15113 @opindex mcpu
15114 Generate code for the specified architecture.  The choices for
15115 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
15116 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
15117 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
15118 @samp{v10}.
15120 @item -mtune=@var{architecture-type}
15121 @opindex mtune
15122 Tune to @var{architecture-type} everything applicable about the generated
15123 code, except for the ABI and the set of available instructions.  The
15124 choices for @var{architecture-type} are the same as for
15125 @option{-march=@var{architecture-type}}.
15127 @item -mmax-stack-frame=@var{n}
15128 @opindex mmax-stack-frame
15129 Warn when the stack frame of a function exceeds @var{n} bytes.
15131 @item -metrax4
15132 @itemx -metrax100
15133 @opindex metrax4
15134 @opindex metrax100
15135 The options @option{-metrax4} and @option{-metrax100} are synonyms for
15136 @option{-march=v3} and @option{-march=v8} respectively.
15138 @item -mmul-bug-workaround
15139 @itemx -mno-mul-bug-workaround
15140 @opindex mmul-bug-workaround
15141 @opindex mno-mul-bug-workaround
15142 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
15143 models where it applies.  This option is active by default.
15145 @item -mpdebug
15146 @opindex mpdebug
15147 Enable CRIS-specific verbose debug-related information in the assembly
15148 code.  This option also has the effect of turning off the @samp{#NO_APP}
15149 formatted-code indicator to the assembler at the beginning of the
15150 assembly file.
15152 @item -mcc-init
15153 @opindex mcc-init
15154 Do not use condition-code results from previous instruction; always emit
15155 compare and test instructions before use of condition codes.
15157 @item -mno-side-effects
15158 @opindex mno-side-effects
15159 Do not emit instructions with side effects in addressing modes other than
15160 post-increment.
15162 @item -mstack-align
15163 @itemx -mno-stack-align
15164 @itemx -mdata-align
15165 @itemx -mno-data-align
15166 @itemx -mconst-align
15167 @itemx -mno-const-align
15168 @opindex mstack-align
15169 @opindex mno-stack-align
15170 @opindex mdata-align
15171 @opindex mno-data-align
15172 @opindex mconst-align
15173 @opindex mno-const-align
15174 These options (@samp{no-} options) arrange (eliminate arrangements) for the
15175 stack frame, individual data and constants to be aligned for the maximum
15176 single data access size for the chosen CPU model.  The default is to
15177 arrange for 32-bit alignment.  ABI details such as structure layout are
15178 not affected by these options.
15180 @item -m32-bit
15181 @itemx -m16-bit
15182 @itemx -m8-bit
15183 @opindex m32-bit
15184 @opindex m16-bit
15185 @opindex m8-bit
15186 Similar to the stack- data- and const-align options above, these options
15187 arrange for stack frame, writable data and constants to all be 32-bit,
15188 16-bit or 8-bit aligned.  The default is 32-bit alignment.
15190 @item -mno-prologue-epilogue
15191 @itemx -mprologue-epilogue
15192 @opindex mno-prologue-epilogue
15193 @opindex mprologue-epilogue
15194 With @option{-mno-prologue-epilogue}, the normal function prologue and
15195 epilogue which set up the stack frame are omitted and no return
15196 instructions or return sequences are generated in the code.  Use this
15197 option only together with visual inspection of the compiled code: no
15198 warnings or errors are generated when call-saved registers must be saved,
15199 or storage for local variables needs to be allocated.
15201 @item -mno-gotplt
15202 @itemx -mgotplt
15203 @opindex mno-gotplt
15204 @opindex mgotplt
15205 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
15206 instruction sequences that load addresses for functions from the PLT part
15207 of the GOT rather than (traditional on other architectures) calls to the
15208 PLT@.  The default is @option{-mgotplt}.
15210 @item -melf
15211 @opindex melf
15212 Legacy no-op option only recognized with the cris-axis-elf and
15213 cris-axis-linux-gnu targets.
15215 @item -mlinux
15216 @opindex mlinux
15217 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
15219 @item -sim
15220 @opindex sim
15221 This option, recognized for the cris-axis-elf, arranges
15222 to link with input-output functions from a simulator library.  Code,
15223 initialized data and zero-initialized data are allocated consecutively.
15225 @item -sim2
15226 @opindex sim2
15227 Like @option{-sim}, but pass linker options to locate initialized data at
15228 0x40000000 and zero-initialized data at 0x80000000.
15229 @end table
15231 @node CR16 Options
15232 @subsection CR16 Options
15233 @cindex CR16 Options
15235 These options are defined specifically for the CR16 ports.
15237 @table @gcctabopt
15239 @item -mmac
15240 @opindex mmac
15241 Enable the use of multiply-accumulate instructions. Disabled by default.
15243 @item -mcr16cplus
15244 @itemx -mcr16c
15245 @opindex mcr16cplus
15246 @opindex mcr16c
15247 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
15248 is default.
15250 @item -msim
15251 @opindex msim
15252 Links the library libsim.a which is in compatible with simulator. Applicable
15253 to ELF compiler only.
15255 @item -mint32
15256 @opindex mint32
15257 Choose integer type as 32-bit wide.
15259 @item -mbit-ops
15260 @opindex mbit-ops
15261 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
15263 @item -mdata-model=@var{model}
15264 @opindex mdata-model
15265 Choose a data model. The choices for @var{model} are @samp{near},
15266 @samp{far} or @samp{medium}. @samp{medium} is default.
15267 However, @samp{far} is not valid with @option{-mcr16c}, as the
15268 CR16C architecture does not support the far data model.
15269 @end table
15271 @node Darwin Options
15272 @subsection Darwin Options
15273 @cindex Darwin options
15275 These options are defined for all architectures running the Darwin operating
15276 system.
15278 FSF GCC on Darwin does not create ``fat'' object files; it creates
15279 an object file for the single architecture that GCC was built to
15280 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
15281 @option{-arch} options are used; it does so by running the compiler or
15282 linker multiple times and joining the results together with
15283 @file{lipo}.
15285 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
15286 @samp{i686}) is determined by the flags that specify the ISA
15287 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
15288 @option{-force_cpusubtype_ALL} option can be used to override this.
15290 The Darwin tools vary in their behavior when presented with an ISA
15291 mismatch.  The assembler, @file{as}, only permits instructions to
15292 be used that are valid for the subtype of the file it is generating,
15293 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
15294 The linker for shared libraries, @file{/usr/bin/libtool}, fails
15295 and prints an error if asked to create a shared library with a less
15296 restrictive subtype than its input files (for instance, trying to put
15297 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
15298 for executables, @command{ld}, quietly gives the executable the most
15299 restrictive subtype of any of its input files.
15301 @table @gcctabopt
15302 @item -F@var{dir}
15303 @opindex F
15304 Add the framework directory @var{dir} to the head of the list of
15305 directories to be searched for header files.  These directories are
15306 interleaved with those specified by @option{-I} options and are
15307 scanned in a left-to-right order.
15309 A framework directory is a directory with frameworks in it.  A
15310 framework is a directory with a @file{Headers} and/or
15311 @file{PrivateHeaders} directory contained directly in it that ends
15312 in @file{.framework}.  The name of a framework is the name of this
15313 directory excluding the @file{.framework}.  Headers associated with
15314 the framework are found in one of those two directories, with
15315 @file{Headers} being searched first.  A subframework is a framework
15316 directory that is in a framework's @file{Frameworks} directory.
15317 Includes of subframework headers can only appear in a header of a
15318 framework that contains the subframework, or in a sibling subframework
15319 header.  Two subframeworks are siblings if they occur in the same
15320 framework.  A subframework should not have the same name as a
15321 framework; a warning is issued if this is violated.  Currently a
15322 subframework cannot have subframeworks; in the future, the mechanism
15323 may be extended to support this.  The standard frameworks can be found
15324 in @file{/System/Library/Frameworks} and
15325 @file{/Library/Frameworks}.  An example include looks like
15326 @code{#include <Framework/header.h>}, where @file{Framework} denotes
15327 the name of the framework and @file{header.h} is found in the
15328 @file{PrivateHeaders} or @file{Headers} directory.
15330 @item -iframework@var{dir}
15331 @opindex iframework
15332 Like @option{-F} except the directory is a treated as a system
15333 directory.  The main difference between this @option{-iframework} and
15334 @option{-F} is that with @option{-iframework} the compiler does not
15335 warn about constructs contained within header files found via
15336 @var{dir}.  This option is valid only for the C family of languages.
15338 @item -gused
15339 @opindex gused
15340 Emit debugging information for symbols that are used.  For stabs
15341 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
15342 This is by default ON@.
15344 @item -gfull
15345 @opindex gfull
15346 Emit debugging information for all symbols and types.
15348 @item -mmacosx-version-min=@var{version}
15349 The earliest version of MacOS X that this executable will run on
15350 is @var{version}.  Typical values of @var{version} include @code{10.1},
15351 @code{10.2}, and @code{10.3.9}.
15353 If the compiler was built to use the system's headers by default,
15354 then the default for this option is the system version on which the
15355 compiler is running, otherwise the default is to make choices that
15356 are compatible with as many systems and code bases as possible.
15358 @item -mkernel
15359 @opindex mkernel
15360 Enable kernel development mode.  The @option{-mkernel} option sets
15361 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
15362 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
15363 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
15364 applicable.  This mode also sets @option{-mno-altivec},
15365 @option{-msoft-float}, @option{-fno-builtin} and
15366 @option{-mlong-branch} for PowerPC targets.
15368 @item -mone-byte-bool
15369 @opindex mone-byte-bool
15370 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
15371 By default @code{sizeof(bool)} is @code{4} when compiling for
15372 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
15373 option has no effect on x86.
15375 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
15376 to generate code that is not binary compatible with code generated
15377 without that switch.  Using this switch may require recompiling all
15378 other modules in a program, including system libraries.  Use this
15379 switch to conform to a non-default data model.
15381 @item -mfix-and-continue
15382 @itemx -ffix-and-continue
15383 @itemx -findirect-data
15384 @opindex mfix-and-continue
15385 @opindex ffix-and-continue
15386 @opindex findirect-data
15387 Generate code suitable for fast turnaround development, such as to
15388 allow GDB to dynamically load @file{.o} files into already-running
15389 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
15390 are provided for backwards compatibility.
15392 @item -all_load
15393 @opindex all_load
15394 Loads all members of static archive libraries.
15395 See man ld(1) for more information.
15397 @item -arch_errors_fatal
15398 @opindex arch_errors_fatal
15399 Cause the errors having to do with files that have the wrong architecture
15400 to be fatal.
15402 @item -bind_at_load
15403 @opindex bind_at_load
15404 Causes the output file to be marked such that the dynamic linker will
15405 bind all undefined references when the file is loaded or launched.
15407 @item -bundle
15408 @opindex bundle
15409 Produce a Mach-o bundle format file.
15410 See man ld(1) for more information.
15412 @item -bundle_loader @var{executable}
15413 @opindex bundle_loader
15414 This option specifies the @var{executable} that will load the build
15415 output file being linked.  See man ld(1) for more information.
15417 @item -dynamiclib
15418 @opindex dynamiclib
15419 When passed this option, GCC produces a dynamic library instead of
15420 an executable when linking, using the Darwin @file{libtool} command.
15422 @item -force_cpusubtype_ALL
15423 @opindex force_cpusubtype_ALL
15424 This causes GCC's output file to have the @samp{ALL} subtype, instead of
15425 one controlled by the @option{-mcpu} or @option{-march} option.
15427 @item -allowable_client  @var{client_name}
15428 @itemx -client_name
15429 @itemx -compatibility_version
15430 @itemx -current_version
15431 @itemx -dead_strip
15432 @itemx -dependency-file
15433 @itemx -dylib_file
15434 @itemx -dylinker_install_name
15435 @itemx -dynamic
15436 @itemx -exported_symbols_list
15437 @itemx -filelist
15438 @need 800
15439 @itemx -flat_namespace
15440 @itemx -force_flat_namespace
15441 @itemx -headerpad_max_install_names
15442 @itemx -image_base
15443 @itemx -init
15444 @itemx -install_name
15445 @itemx -keep_private_externs
15446 @itemx -multi_module
15447 @itemx -multiply_defined
15448 @itemx -multiply_defined_unused
15449 @need 800
15450 @itemx -noall_load
15451 @itemx -no_dead_strip_inits_and_terms
15452 @itemx -nofixprebinding
15453 @itemx -nomultidefs
15454 @itemx -noprebind
15455 @itemx -noseglinkedit
15456 @itemx -pagezero_size
15457 @itemx -prebind
15458 @itemx -prebind_all_twolevel_modules
15459 @itemx -private_bundle
15460 @need 800
15461 @itemx -read_only_relocs
15462 @itemx -sectalign
15463 @itemx -sectobjectsymbols
15464 @itemx -whyload
15465 @itemx -seg1addr
15466 @itemx -sectcreate
15467 @itemx -sectobjectsymbols
15468 @itemx -sectorder
15469 @itemx -segaddr
15470 @itemx -segs_read_only_addr
15471 @need 800
15472 @itemx -segs_read_write_addr
15473 @itemx -seg_addr_table
15474 @itemx -seg_addr_table_filename
15475 @itemx -seglinkedit
15476 @itemx -segprot
15477 @itemx -segs_read_only_addr
15478 @itemx -segs_read_write_addr
15479 @itemx -single_module
15480 @itemx -static
15481 @itemx -sub_library
15482 @need 800
15483 @itemx -sub_umbrella
15484 @itemx -twolevel_namespace
15485 @itemx -umbrella
15486 @itemx -undefined
15487 @itemx -unexported_symbols_list
15488 @itemx -weak_reference_mismatches
15489 @itemx -whatsloaded
15490 @opindex allowable_client
15491 @opindex client_name
15492 @opindex compatibility_version
15493 @opindex current_version
15494 @opindex dead_strip
15495 @opindex dependency-file
15496 @opindex dylib_file
15497 @opindex dylinker_install_name
15498 @opindex dynamic
15499 @opindex exported_symbols_list
15500 @opindex filelist
15501 @opindex flat_namespace
15502 @opindex force_flat_namespace
15503 @opindex headerpad_max_install_names
15504 @opindex image_base
15505 @opindex init
15506 @opindex install_name
15507 @opindex keep_private_externs
15508 @opindex multi_module
15509 @opindex multiply_defined
15510 @opindex multiply_defined_unused
15511 @opindex noall_load
15512 @opindex no_dead_strip_inits_and_terms
15513 @opindex nofixprebinding
15514 @opindex nomultidefs
15515 @opindex noprebind
15516 @opindex noseglinkedit
15517 @opindex pagezero_size
15518 @opindex prebind
15519 @opindex prebind_all_twolevel_modules
15520 @opindex private_bundle
15521 @opindex read_only_relocs
15522 @opindex sectalign
15523 @opindex sectobjectsymbols
15524 @opindex whyload
15525 @opindex seg1addr
15526 @opindex sectcreate
15527 @opindex sectobjectsymbols
15528 @opindex sectorder
15529 @opindex segaddr
15530 @opindex segs_read_only_addr
15531 @opindex segs_read_write_addr
15532 @opindex seg_addr_table
15533 @opindex seg_addr_table_filename
15534 @opindex seglinkedit
15535 @opindex segprot
15536 @opindex segs_read_only_addr
15537 @opindex segs_read_write_addr
15538 @opindex single_module
15539 @opindex static
15540 @opindex sub_library
15541 @opindex sub_umbrella
15542 @opindex twolevel_namespace
15543 @opindex umbrella
15544 @opindex undefined
15545 @opindex unexported_symbols_list
15546 @opindex weak_reference_mismatches
15547 @opindex whatsloaded
15548 These options are passed to the Darwin linker.  The Darwin linker man page
15549 describes them in detail.
15550 @end table
15552 @node DEC Alpha Options
15553 @subsection DEC Alpha Options
15555 These @samp{-m} options are defined for the DEC Alpha implementations:
15557 @table @gcctabopt
15558 @item -mno-soft-float
15559 @itemx -msoft-float
15560 @opindex mno-soft-float
15561 @opindex msoft-float
15562 Use (do not use) the hardware floating-point instructions for
15563 floating-point operations.  When @option{-msoft-float} is specified,
15564 functions in @file{libgcc.a} are used to perform floating-point
15565 operations.  Unless they are replaced by routines that emulate the
15566 floating-point operations, or compiled in such a way as to call such
15567 emulations routines, these routines issue floating-point
15568 operations.   If you are compiling for an Alpha without floating-point
15569 operations, you must ensure that the library is built so as not to call
15570 them.
15572 Note that Alpha implementations without floating-point operations are
15573 required to have floating-point registers.
15575 @item -mfp-reg
15576 @itemx -mno-fp-regs
15577 @opindex mfp-reg
15578 @opindex mno-fp-regs
15579 Generate code that uses (does not use) the floating-point register set.
15580 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
15581 register set is not used, floating-point operands are passed in integer
15582 registers as if they were integers and floating-point results are passed
15583 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
15584 so any function with a floating-point argument or return value called by code
15585 compiled with @option{-mno-fp-regs} must also be compiled with that
15586 option.
15588 A typical use of this option is building a kernel that does not use,
15589 and hence need not save and restore, any floating-point registers.
15591 @item -mieee
15592 @opindex mieee
15593 The Alpha architecture implements floating-point hardware optimized for
15594 maximum performance.  It is mostly compliant with the IEEE floating-point
15595 standard.  However, for full compliance, software assistance is
15596 required.  This option generates code fully IEEE-compliant code
15597 @emph{except} that the @var{inexact-flag} is not maintained (see below).
15598 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
15599 defined during compilation.  The resulting code is less efficient but is
15600 able to correctly support denormalized numbers and exceptional IEEE
15601 values such as not-a-number and plus/minus infinity.  Other Alpha
15602 compilers call this option @option{-ieee_with_no_inexact}.
15604 @item -mieee-with-inexact
15605 @opindex mieee-with-inexact
15606 This is like @option{-mieee} except the generated code also maintains
15607 the IEEE @var{inexact-flag}.  Turning on this option causes the
15608 generated code to implement fully-compliant IEEE math.  In addition to
15609 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
15610 macro.  On some Alpha implementations the resulting code may execute
15611 significantly slower than the code generated by default.  Since there is
15612 very little code that depends on the @var{inexact-flag}, you should
15613 normally not specify this option.  Other Alpha compilers call this
15614 option @option{-ieee_with_inexact}.
15616 @item -mfp-trap-mode=@var{trap-mode}
15617 @opindex mfp-trap-mode
15618 This option controls what floating-point related traps are enabled.
15619 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
15620 The trap mode can be set to one of four values:
15622 @table @samp
15623 @item n
15624 This is the default (normal) setting.  The only traps that are enabled
15625 are the ones that cannot be disabled in software (e.g., division by zero
15626 trap).
15628 @item u
15629 In addition to the traps enabled by @samp{n}, underflow traps are enabled
15630 as well.
15632 @item su
15633 Like @samp{u}, but the instructions are marked to be safe for software
15634 completion (see Alpha architecture manual for details).
15636 @item sui
15637 Like @samp{su}, but inexact traps are enabled as well.
15638 @end table
15640 @item -mfp-rounding-mode=@var{rounding-mode}
15641 @opindex mfp-rounding-mode
15642 Selects the IEEE rounding mode.  Other Alpha compilers call this option
15643 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
15646 @table @samp
15647 @item n
15648 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
15649 the nearest machine number or towards the even machine number in case
15650 of a tie.
15652 @item m
15653 Round towards minus infinity.
15655 @item c
15656 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
15658 @item d
15659 Dynamic rounding mode.  A field in the floating-point control register
15660 (@var{fpcr}, see Alpha architecture reference manual) controls the
15661 rounding mode in effect.  The C library initializes this register for
15662 rounding towards plus infinity.  Thus, unless your program modifies the
15663 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
15664 @end table
15666 @item -mtrap-precision=@var{trap-precision}
15667 @opindex mtrap-precision
15668 In the Alpha architecture, floating-point traps are imprecise.  This
15669 means without software assistance it is impossible to recover from a
15670 floating trap and program execution normally needs to be terminated.
15671 GCC can generate code that can assist operating system trap handlers
15672 in determining the exact location that caused a floating-point trap.
15673 Depending on the requirements of an application, different levels of
15674 precisions can be selected:
15676 @table @samp
15677 @item p
15678 Program precision.  This option is the default and means a trap handler
15679 can only identify which program caused a floating-point exception.
15681 @item f
15682 Function precision.  The trap handler can determine the function that
15683 caused a floating-point exception.
15685 @item i
15686 Instruction precision.  The trap handler can determine the exact
15687 instruction that caused a floating-point exception.
15688 @end table
15690 Other Alpha compilers provide the equivalent options called
15691 @option{-scope_safe} and @option{-resumption_safe}.
15693 @item -mieee-conformant
15694 @opindex mieee-conformant
15695 This option marks the generated code as IEEE conformant.  You must not
15696 use this option unless you also specify @option{-mtrap-precision=i} and either
15697 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
15698 is to emit the line @samp{.eflag 48} in the function prologue of the
15699 generated assembly file.
15701 @item -mbuild-constants
15702 @opindex mbuild-constants
15703 Normally GCC examines a 32- or 64-bit integer constant to
15704 see if it can construct it from smaller constants in two or three
15705 instructions.  If it cannot, it outputs the constant as a literal and
15706 generates code to load it from the data segment at run time.
15708 Use this option to require GCC to construct @emph{all} integer constants
15709 using code, even if it takes more instructions (the maximum is six).
15711 You typically use this option to build a shared library dynamic
15712 loader.  Itself a shared library, it must relocate itself in memory
15713 before it can find the variables and constants in its own data segment.
15715 @item -mbwx
15716 @itemx -mno-bwx
15717 @itemx -mcix
15718 @itemx -mno-cix
15719 @itemx -mfix
15720 @itemx -mno-fix
15721 @itemx -mmax
15722 @itemx -mno-max
15723 @opindex mbwx
15724 @opindex mno-bwx
15725 @opindex mcix
15726 @opindex mno-cix
15727 @opindex mfix
15728 @opindex mno-fix
15729 @opindex mmax
15730 @opindex mno-max
15731 Indicate whether GCC should generate code to use the optional BWX,
15732 CIX, FIX and MAX instruction sets.  The default is to use the instruction
15733 sets supported by the CPU type specified via @option{-mcpu=} option or that
15734 of the CPU on which GCC was built if none is specified.
15736 @item -mfloat-vax
15737 @itemx -mfloat-ieee
15738 @opindex mfloat-vax
15739 @opindex mfloat-ieee
15740 Generate code that uses (does not use) VAX F and G floating-point
15741 arithmetic instead of IEEE single and double precision.
15743 @item -mexplicit-relocs
15744 @itemx -mno-explicit-relocs
15745 @opindex mexplicit-relocs
15746 @opindex mno-explicit-relocs
15747 Older Alpha assemblers provided no way to generate symbol relocations
15748 except via assembler macros.  Use of these macros does not allow
15749 optimal instruction scheduling.  GNU binutils as of version 2.12
15750 supports a new syntax that allows the compiler to explicitly mark
15751 which relocations should apply to which instructions.  This option
15752 is mostly useful for debugging, as GCC detects the capabilities of
15753 the assembler when it is built and sets the default accordingly.
15755 @item -msmall-data
15756 @itemx -mlarge-data
15757 @opindex msmall-data
15758 @opindex mlarge-data
15759 When @option{-mexplicit-relocs} is in effect, static data is
15760 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
15761 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
15762 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
15763 16-bit relocations off of the @code{$gp} register.  This limits the
15764 size of the small data area to 64KB, but allows the variables to be
15765 directly accessed via a single instruction.
15767 The default is @option{-mlarge-data}.  With this option the data area
15768 is limited to just below 2GB@.  Programs that require more than 2GB of
15769 data must use @code{malloc} or @code{mmap} to allocate the data in the
15770 heap instead of in the program's data segment.
15772 When generating code for shared libraries, @option{-fpic} implies
15773 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
15775 @item -msmall-text
15776 @itemx -mlarge-text
15777 @opindex msmall-text
15778 @opindex mlarge-text
15779 When @option{-msmall-text} is used, the compiler assumes that the
15780 code of the entire program (or shared library) fits in 4MB, and is
15781 thus reachable with a branch instruction.  When @option{-msmall-data}
15782 is used, the compiler can assume that all local symbols share the
15783 same @code{$gp} value, and thus reduce the number of instructions
15784 required for a function call from 4 to 1.
15786 The default is @option{-mlarge-text}.
15788 @item -mcpu=@var{cpu_type}
15789 @opindex mcpu
15790 Set the instruction set and instruction scheduling parameters for
15791 machine type @var{cpu_type}.  You can specify either the @samp{EV}
15792 style name or the corresponding chip number.  GCC supports scheduling
15793 parameters for the EV4, EV5 and EV6 family of processors and
15794 chooses the default values for the instruction set from the processor
15795 you specify.  If you do not specify a processor type, GCC defaults
15796 to the processor on which the compiler was built.
15798 Supported values for @var{cpu_type} are
15800 @table @samp
15801 @item ev4
15802 @itemx ev45
15803 @itemx 21064
15804 Schedules as an EV4 and has no instruction set extensions.
15806 @item ev5
15807 @itemx 21164
15808 Schedules as an EV5 and has no instruction set extensions.
15810 @item ev56
15811 @itemx 21164a
15812 Schedules as an EV5 and supports the BWX extension.
15814 @item pca56
15815 @itemx 21164pc
15816 @itemx 21164PC
15817 Schedules as an EV5 and supports the BWX and MAX extensions.
15819 @item ev6
15820 @itemx 21264
15821 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
15823 @item ev67
15824 @itemx 21264a
15825 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
15826 @end table
15828 Native toolchains also support the value @samp{native},
15829 which selects the best architecture option for the host processor.
15830 @option{-mcpu=native} has no effect if GCC does not recognize
15831 the processor.
15833 @item -mtune=@var{cpu_type}
15834 @opindex mtune
15835 Set only the instruction scheduling parameters for machine type
15836 @var{cpu_type}.  The instruction set is not changed.
15838 Native toolchains also support the value @samp{native},
15839 which selects the best architecture option for the host processor.
15840 @option{-mtune=native} has no effect if GCC does not recognize
15841 the processor.
15843 @item -mmemory-latency=@var{time}
15844 @opindex mmemory-latency
15845 Sets the latency the scheduler should assume for typical memory
15846 references as seen by the application.  This number is highly
15847 dependent on the memory access patterns used by the application
15848 and the size of the external cache on the machine.
15850 Valid options for @var{time} are
15852 @table @samp
15853 @item @var{number}
15854 A decimal number representing clock cycles.
15856 @item L1
15857 @itemx L2
15858 @itemx L3
15859 @itemx main
15860 The compiler contains estimates of the number of clock cycles for
15861 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15862 (also called Dcache, Scache, and Bcache), as well as to main memory.
15863 Note that L3 is only valid for EV5.
15865 @end table
15866 @end table
15868 @node FR30 Options
15869 @subsection FR30 Options
15870 @cindex FR30 Options
15872 These options are defined specifically for the FR30 port.
15874 @table @gcctabopt
15876 @item -msmall-model
15877 @opindex msmall-model
15878 Use the small address space model.  This can produce smaller code, but
15879 it does assume that all symbolic values and addresses fit into a
15880 20-bit range.
15882 @item -mno-lsim
15883 @opindex mno-lsim
15884 Assume that runtime support has been provided and so there is no need
15885 to include the simulator library (@file{libsim.a}) on the linker
15886 command line.
15888 @end table
15890 @node FT32 Options
15891 @subsection FT32 Options
15892 @cindex FT32 Options
15894 These options are defined specifically for the FT32 port.
15896 @table @gcctabopt
15898 @item -msim
15899 @opindex msim
15900 Specifies that the program will be run on the simulator.  This causes
15901 an alternate runtime startup and library to be linked.
15902 You must not use this option when generating programs that will run on
15903 real hardware; you must provide your own runtime library for whatever
15904 I/O functions are needed.
15906 @item -mlra
15907 @opindex mlra
15908 Enable Local Register Allocation.  This is still experimental for FT32,
15909 so by default the compiler uses standard reload.
15911 @item -mnodiv
15912 @opindex mnodiv
15913 Do not use div and mod instructions.
15915 @end table
15917 @node FRV Options
15918 @subsection FRV Options
15919 @cindex FRV Options
15921 @table @gcctabopt
15922 @item -mgpr-32
15923 @opindex mgpr-32
15925 Only use the first 32 general-purpose registers.
15927 @item -mgpr-64
15928 @opindex mgpr-64
15930 Use all 64 general-purpose registers.
15932 @item -mfpr-32
15933 @opindex mfpr-32
15935 Use only the first 32 floating-point registers.
15937 @item -mfpr-64
15938 @opindex mfpr-64
15940 Use all 64 floating-point registers.
15942 @item -mhard-float
15943 @opindex mhard-float
15945 Use hardware instructions for floating-point operations.
15947 @item -msoft-float
15948 @opindex msoft-float
15950 Use library routines for floating-point operations.
15952 @item -malloc-cc
15953 @opindex malloc-cc
15955 Dynamically allocate condition code registers.
15957 @item -mfixed-cc
15958 @opindex mfixed-cc
15960 Do not try to dynamically allocate condition code registers, only
15961 use @code{icc0} and @code{fcc0}.
15963 @item -mdword
15964 @opindex mdword
15966 Change ABI to use double word insns.
15968 @item -mno-dword
15969 @opindex mno-dword
15971 Do not use double word instructions.
15973 @item -mdouble
15974 @opindex mdouble
15976 Use floating-point double instructions.
15978 @item -mno-double
15979 @opindex mno-double
15981 Do not use floating-point double instructions.
15983 @item -mmedia
15984 @opindex mmedia
15986 Use media instructions.
15988 @item -mno-media
15989 @opindex mno-media
15991 Do not use media instructions.
15993 @item -mmuladd
15994 @opindex mmuladd
15996 Use multiply and add/subtract instructions.
15998 @item -mno-muladd
15999 @opindex mno-muladd
16001 Do not use multiply and add/subtract instructions.
16003 @item -mfdpic
16004 @opindex mfdpic
16006 Select the FDPIC ABI, which uses function descriptors to represent
16007 pointers to functions.  Without any PIC/PIE-related options, it
16008 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
16009 assumes GOT entries and small data are within a 12-bit range from the
16010 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
16011 are computed with 32 bits.
16012 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16014 @item -minline-plt
16015 @opindex minline-plt
16017 Enable inlining of PLT entries in function calls to functions that are
16018 not known to bind locally.  It has no effect without @option{-mfdpic}.
16019 It's enabled by default if optimizing for speed and compiling for
16020 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
16021 optimization option such as @option{-O3} or above is present in the
16022 command line.
16024 @item -mTLS
16025 @opindex mTLS
16027 Assume a large TLS segment when generating thread-local code.
16029 @item -mtls
16030 @opindex mtls
16032 Do not assume a large TLS segment when generating thread-local code.
16034 @item -mgprel-ro
16035 @opindex mgprel-ro
16037 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
16038 that is known to be in read-only sections.  It's enabled by default,
16039 except for @option{-fpic} or @option{-fpie}: even though it may help
16040 make the global offset table smaller, it trades 1 instruction for 4.
16041 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
16042 one of which may be shared by multiple symbols, and it avoids the need
16043 for a GOT entry for the referenced symbol, so it's more likely to be a
16044 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
16046 @item -multilib-library-pic
16047 @opindex multilib-library-pic
16049 Link with the (library, not FD) pic libraries.  It's implied by
16050 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
16051 @option{-fpic} without @option{-mfdpic}.  You should never have to use
16052 it explicitly.
16054 @item -mlinked-fp
16055 @opindex mlinked-fp
16057 Follow the EABI requirement of always creating a frame pointer whenever
16058 a stack frame is allocated.  This option is enabled by default and can
16059 be disabled with @option{-mno-linked-fp}.
16061 @item -mlong-calls
16062 @opindex mlong-calls
16064 Use indirect addressing to call functions outside the current
16065 compilation unit.  This allows the functions to be placed anywhere
16066 within the 32-bit address space.
16068 @item -malign-labels
16069 @opindex malign-labels
16071 Try to align labels to an 8-byte boundary by inserting NOPs into the
16072 previous packet.  This option only has an effect when VLIW packing
16073 is enabled.  It doesn't create new packets; it merely adds NOPs to
16074 existing ones.
16076 @item -mlibrary-pic
16077 @opindex mlibrary-pic
16079 Generate position-independent EABI code.
16081 @item -macc-4
16082 @opindex macc-4
16084 Use only the first four media accumulator registers.
16086 @item -macc-8
16087 @opindex macc-8
16089 Use all eight media accumulator registers.
16091 @item -mpack
16092 @opindex mpack
16094 Pack VLIW instructions.
16096 @item -mno-pack
16097 @opindex mno-pack
16099 Do not pack VLIW instructions.
16101 @item -mno-eflags
16102 @opindex mno-eflags
16104 Do not mark ABI switches in e_flags.
16106 @item -mcond-move
16107 @opindex mcond-move
16109 Enable the use of conditional-move instructions (default).
16111 This switch is mainly for debugging the compiler and will likely be removed
16112 in a future version.
16114 @item -mno-cond-move
16115 @opindex mno-cond-move
16117 Disable the use of conditional-move instructions.
16119 This switch is mainly for debugging the compiler and will likely be removed
16120 in a future version.
16122 @item -mscc
16123 @opindex mscc
16125 Enable the use of conditional set instructions (default).
16127 This switch is mainly for debugging the compiler and will likely be removed
16128 in a future version.
16130 @item -mno-scc
16131 @opindex mno-scc
16133 Disable the use of conditional set instructions.
16135 This switch is mainly for debugging the compiler and will likely be removed
16136 in a future version.
16138 @item -mcond-exec
16139 @opindex mcond-exec
16141 Enable the use of conditional execution (default).
16143 This switch is mainly for debugging the compiler and will likely be removed
16144 in a future version.
16146 @item -mno-cond-exec
16147 @opindex mno-cond-exec
16149 Disable the use of conditional execution.
16151 This switch is mainly for debugging the compiler and will likely be removed
16152 in a future version.
16154 @item -mvliw-branch
16155 @opindex mvliw-branch
16157 Run a pass to pack branches into VLIW instructions (default).
16159 This switch is mainly for debugging the compiler and will likely be removed
16160 in a future version.
16162 @item -mno-vliw-branch
16163 @opindex mno-vliw-branch
16165 Do not run a pass to pack branches into VLIW instructions.
16167 This switch is mainly for debugging the compiler and will likely be removed
16168 in a future version.
16170 @item -mmulti-cond-exec
16171 @opindex mmulti-cond-exec
16173 Enable optimization of @code{&&} and @code{||} in conditional execution
16174 (default).
16176 This switch is mainly for debugging the compiler and will likely be removed
16177 in a future version.
16179 @item -mno-multi-cond-exec
16180 @opindex mno-multi-cond-exec
16182 Disable optimization of @code{&&} and @code{||} in conditional execution.
16184 This switch is mainly for debugging the compiler and will likely be removed
16185 in a future version.
16187 @item -mnested-cond-exec
16188 @opindex mnested-cond-exec
16190 Enable nested conditional execution optimizations (default).
16192 This switch is mainly for debugging the compiler and will likely be removed
16193 in a future version.
16195 @item -mno-nested-cond-exec
16196 @opindex mno-nested-cond-exec
16198 Disable nested conditional execution optimizations.
16200 This switch is mainly for debugging the compiler and will likely be removed
16201 in a future version.
16203 @item -moptimize-membar
16204 @opindex moptimize-membar
16206 This switch removes redundant @code{membar} instructions from the
16207 compiler-generated code.  It is enabled by default.
16209 @item -mno-optimize-membar
16210 @opindex mno-optimize-membar
16212 This switch disables the automatic removal of redundant @code{membar}
16213 instructions from the generated code.
16215 @item -mtomcat-stats
16216 @opindex mtomcat-stats
16218 Cause gas to print out tomcat statistics.
16220 @item -mcpu=@var{cpu}
16221 @opindex mcpu
16223 Select the processor type for which to generate code.  Possible values are
16224 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
16225 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
16227 @end table
16229 @node GNU/Linux Options
16230 @subsection GNU/Linux Options
16232 These @samp{-m} options are defined for GNU/Linux targets:
16234 @table @gcctabopt
16235 @item -mglibc
16236 @opindex mglibc
16237 Use the GNU C library.  This is the default except
16238 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
16239 @samp{*-*-linux-*android*} targets.
16241 @item -muclibc
16242 @opindex muclibc
16243 Use uClibc C library.  This is the default on
16244 @samp{*-*-linux-*uclibc*} targets.
16246 @item -mmusl
16247 @opindex mmusl
16248 Use the musl C library.  This is the default on
16249 @samp{*-*-linux-*musl*} targets.
16251 @item -mbionic
16252 @opindex mbionic
16253 Use Bionic C library.  This is the default on
16254 @samp{*-*-linux-*android*} targets.
16256 @item -mandroid
16257 @opindex mandroid
16258 Compile code compatible with Android platform.  This is the default on
16259 @samp{*-*-linux-*android*} targets.
16261 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
16262 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
16263 this option makes the GCC driver pass Android-specific options to the linker.
16264 Finally, this option causes the preprocessor macro @code{__ANDROID__}
16265 to be defined.
16267 @item -tno-android-cc
16268 @opindex tno-android-cc
16269 Disable compilation effects of @option{-mandroid}, i.e., do not enable
16270 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
16271 @option{-fno-rtti} by default.
16273 @item -tno-android-ld
16274 @opindex tno-android-ld
16275 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
16276 linking options to the linker.
16278 @end table
16280 @node H8/300 Options
16281 @subsection H8/300 Options
16283 These @samp{-m} options are defined for the H8/300 implementations:
16285 @table @gcctabopt
16286 @item -mrelax
16287 @opindex mrelax
16288 Shorten some address references at link time, when possible; uses the
16289 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
16290 ld, Using ld}, for a fuller description.
16292 @item -mh
16293 @opindex mh
16294 Generate code for the H8/300H@.
16296 @item -ms
16297 @opindex ms
16298 Generate code for the H8S@.
16300 @item -mn
16301 @opindex mn
16302 Generate code for the H8S and H8/300H in the normal mode.  This switch
16303 must be used either with @option{-mh} or @option{-ms}.
16305 @item -ms2600
16306 @opindex ms2600
16307 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
16309 @item -mexr
16310 @opindex mexr
16311 Extended registers are stored on stack before execution of function
16312 with monitor attribute. Default option is @option{-mexr}.
16313 This option is valid only for H8S targets.
16315 @item -mno-exr
16316 @opindex mno-exr
16317 Extended registers are not stored on stack before execution of function 
16318 with monitor attribute. Default option is @option{-mno-exr}. 
16319 This option is valid only for H8S targets.
16321 @item -mint32
16322 @opindex mint32
16323 Make @code{int} data 32 bits by default.
16325 @item -malign-300
16326 @opindex malign-300
16327 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
16328 The default for the H8/300H and H8S is to align longs and floats on
16329 4-byte boundaries.
16330 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
16331 This option has no effect on the H8/300.
16332 @end table
16334 @node HPPA Options
16335 @subsection HPPA Options
16336 @cindex HPPA Options
16338 These @samp{-m} options are defined for the HPPA family of computers:
16340 @table @gcctabopt
16341 @item -march=@var{architecture-type}
16342 @opindex march
16343 Generate code for the specified architecture.  The choices for
16344 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
16345 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
16346 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
16347 architecture option for your machine.  Code compiled for lower numbered
16348 architectures runs on higher numbered architectures, but not the
16349 other way around.
16351 @item -mpa-risc-1-0
16352 @itemx -mpa-risc-1-1
16353 @itemx -mpa-risc-2-0
16354 @opindex mpa-risc-1-0
16355 @opindex mpa-risc-1-1
16356 @opindex mpa-risc-2-0
16357 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
16359 @item -mjump-in-delay
16360 @opindex mjump-in-delay
16361 This option is ignored and provided for compatibility purposes only.
16363 @item -mdisable-fpregs
16364 @opindex mdisable-fpregs
16365 Prevent floating-point registers from being used in any manner.  This is
16366 necessary for compiling kernels that perform lazy context switching of
16367 floating-point registers.  If you use this option and attempt to perform
16368 floating-point operations, the compiler aborts.
16370 @item -mdisable-indexing
16371 @opindex mdisable-indexing
16372 Prevent the compiler from using indexing address modes.  This avoids some
16373 rather obscure problems when compiling MIG generated code under MACH@.
16375 @item -mno-space-regs
16376 @opindex mno-space-regs
16377 Generate code that assumes the target has no space registers.  This allows
16378 GCC to generate faster indirect calls and use unscaled index address modes.
16380 Such code is suitable for level 0 PA systems and kernels.
16382 @item -mfast-indirect-calls
16383 @opindex mfast-indirect-calls
16384 Generate code that assumes calls never cross space boundaries.  This
16385 allows GCC to emit code that performs faster indirect calls.
16387 This option does not work in the presence of shared libraries or nested
16388 functions.
16390 @item -mfixed-range=@var{register-range}
16391 @opindex mfixed-range
16392 Generate code treating the given register range as fixed registers.
16393 A fixed register is one that the register allocator cannot use.  This is
16394 useful when compiling kernel code.  A register range is specified as
16395 two registers separated by a dash.  Multiple register ranges can be
16396 specified separated by a comma.
16398 @item -mlong-load-store
16399 @opindex mlong-load-store
16400 Generate 3-instruction load and store sequences as sometimes required by
16401 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
16402 the HP compilers.
16404 @item -mportable-runtime
16405 @opindex mportable-runtime
16406 Use the portable calling conventions proposed by HP for ELF systems.
16408 @item -mgas
16409 @opindex mgas
16410 Enable the use of assembler directives only GAS understands.
16412 @item -mschedule=@var{cpu-type}
16413 @opindex mschedule
16414 Schedule code according to the constraints for the machine type
16415 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
16416 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
16417 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
16418 proper scheduling option for your machine.  The default scheduling is
16419 @samp{8000}.
16421 @item -mlinker-opt
16422 @opindex mlinker-opt
16423 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
16424 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
16425 linkers in which they give bogus error messages when linking some programs.
16427 @item -msoft-float
16428 @opindex msoft-float
16429 Generate output containing library calls for floating point.
16430 @strong{Warning:} the requisite libraries are not available for all HPPA
16431 targets.  Normally the facilities of the machine's usual C compiler are
16432 used, but this cannot be done directly in cross-compilation.  You must make
16433 your own arrangements to provide suitable library functions for
16434 cross-compilation.
16436 @option{-msoft-float} changes the calling convention in the output file;
16437 therefore, it is only useful if you compile @emph{all} of a program with
16438 this option.  In particular, you need to compile @file{libgcc.a}, the
16439 library that comes with GCC, with @option{-msoft-float} in order for
16440 this to work.
16442 @item -msio
16443 @opindex msio
16444 Generate the predefine, @code{_SIO}, for server IO@.  The default is
16445 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
16446 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
16447 options are available under HP-UX and HI-UX@.
16449 @item -mgnu-ld
16450 @opindex mgnu-ld
16451 Use options specific to GNU @command{ld}.
16452 This passes @option{-shared} to @command{ld} when
16453 building a shared library.  It is the default when GCC is configured,
16454 explicitly or implicitly, with the GNU linker.  This option does not
16455 affect which @command{ld} is called; it only changes what parameters
16456 are passed to that @command{ld}.
16457 The @command{ld} that is called is determined by the
16458 @option{--with-ld} configure option, GCC's program search path, and
16459 finally by the user's @env{PATH}.  The linker used by GCC can be printed
16460 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
16461 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
16463 @item -mhp-ld
16464 @opindex mhp-ld
16465 Use options specific to HP @command{ld}.
16466 This passes @option{-b} to @command{ld} when building
16467 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
16468 links.  It is the default when GCC is configured, explicitly or
16469 implicitly, with the HP linker.  This option does not affect
16470 which @command{ld} is called; it only changes what parameters are passed to that
16471 @command{ld}.
16472 The @command{ld} that is called is determined by the @option{--with-ld}
16473 configure option, GCC's program search path, and finally by the user's
16474 @env{PATH}.  The linker used by GCC can be printed using @samp{which
16475 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
16476 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
16478 @item -mlong-calls
16479 @opindex mno-long-calls
16480 Generate code that uses long call sequences.  This ensures that a call
16481 is always able to reach linker generated stubs.  The default is to generate
16482 long calls only when the distance from the call site to the beginning
16483 of the function or translation unit, as the case may be, exceeds a
16484 predefined limit set by the branch type being used.  The limits for
16485 normal calls are 7,600,000 and 240,000 bytes, respectively for the
16486 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
16487 240,000 bytes.
16489 Distances are measured from the beginning of functions when using the
16490 @option{-ffunction-sections} option, or when using the @option{-mgas}
16491 and @option{-mno-portable-runtime} options together under HP-UX with
16492 the SOM linker.
16494 It is normally not desirable to use this option as it degrades
16495 performance.  However, it may be useful in large applications,
16496 particularly when partial linking is used to build the application.
16498 The types of long calls used depends on the capabilities of the
16499 assembler and linker, and the type of code being generated.  The
16500 impact on systems that support long absolute calls, and long pic
16501 symbol-difference or pc-relative calls should be relatively small.
16502 However, an indirect call is used on 32-bit ELF systems in pic code
16503 and it is quite long.
16505 @item -munix=@var{unix-std}
16506 @opindex march
16507 Generate compiler predefines and select a startfile for the specified
16508 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
16509 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
16510 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
16511 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
16512 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
16513 and later.
16515 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
16516 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
16517 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
16518 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
16519 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
16520 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
16522 It is @emph{important} to note that this option changes the interfaces
16523 for various library routines.  It also affects the operational behavior
16524 of the C library.  Thus, @emph{extreme} care is needed in using this
16525 option.
16527 Library code that is intended to operate with more than one UNIX
16528 standard must test, set and restore the variable @code{__xpg4_extended_mask}
16529 as appropriate.  Most GNU software doesn't provide this capability.
16531 @item -nolibdld
16532 @opindex nolibdld
16533 Suppress the generation of link options to search libdld.sl when the
16534 @option{-static} option is specified on HP-UX 10 and later.
16536 @item -static
16537 @opindex static
16538 The HP-UX implementation of setlocale in libc has a dependency on
16539 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
16540 when the @option{-static} option is specified, special link options
16541 are needed to resolve this dependency.
16543 On HP-UX 10 and later, the GCC driver adds the necessary options to
16544 link with libdld.sl when the @option{-static} option is specified.
16545 This causes the resulting binary to be dynamic.  On the 64-bit port,
16546 the linkers generate dynamic binaries by default in any case.  The
16547 @option{-nolibdld} option can be used to prevent the GCC driver from
16548 adding these link options.
16550 @item -threads
16551 @opindex threads
16552 Add support for multithreading with the @dfn{dce thread} library
16553 under HP-UX@.  This option sets flags for both the preprocessor and
16554 linker.
16555 @end table
16557 @node IA-64 Options
16558 @subsection IA-64 Options
16559 @cindex IA-64 Options
16561 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16563 @table @gcctabopt
16564 @item -mbig-endian
16565 @opindex mbig-endian
16566 Generate code for a big-endian target.  This is the default for HP-UX@.
16568 @item -mlittle-endian
16569 @opindex mlittle-endian
16570 Generate code for a little-endian target.  This is the default for AIX5
16571 and GNU/Linux.
16573 @item -mgnu-as
16574 @itemx -mno-gnu-as
16575 @opindex mgnu-as
16576 @opindex mno-gnu-as
16577 Generate (or don't) code for the GNU assembler.  This is the default.
16578 @c Also, this is the default if the configure option @option{--with-gnu-as}
16579 @c is used.
16581 @item -mgnu-ld
16582 @itemx -mno-gnu-ld
16583 @opindex mgnu-ld
16584 @opindex mno-gnu-ld
16585 Generate (or don't) code for the GNU linker.  This is the default.
16586 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16587 @c is used.
16589 @item -mno-pic
16590 @opindex mno-pic
16591 Generate code that does not use a global pointer register.  The result
16592 is not position independent code, and violates the IA-64 ABI@.
16594 @item -mvolatile-asm-stop
16595 @itemx -mno-volatile-asm-stop
16596 @opindex mvolatile-asm-stop
16597 @opindex mno-volatile-asm-stop
16598 Generate (or don't) a stop bit immediately before and after volatile asm
16599 statements.
16601 @item -mregister-names
16602 @itemx -mno-register-names
16603 @opindex mregister-names
16604 @opindex mno-register-names
16605 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16606 the stacked registers.  This may make assembler output more readable.
16608 @item -mno-sdata
16609 @itemx -msdata
16610 @opindex mno-sdata
16611 @opindex msdata
16612 Disable (or enable) optimizations that use the small data section.  This may
16613 be useful for working around optimizer bugs.
16615 @item -mconstant-gp
16616 @opindex mconstant-gp
16617 Generate code that uses a single constant global pointer value.  This is
16618 useful when compiling kernel code.
16620 @item -mauto-pic
16621 @opindex mauto-pic
16622 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16623 This is useful when compiling firmware code.
16625 @item -minline-float-divide-min-latency
16626 @opindex minline-float-divide-min-latency
16627 Generate code for inline divides of floating-point values
16628 using the minimum latency algorithm.
16630 @item -minline-float-divide-max-throughput
16631 @opindex minline-float-divide-max-throughput
16632 Generate code for inline divides of floating-point values
16633 using the maximum throughput algorithm.
16635 @item -mno-inline-float-divide
16636 @opindex mno-inline-float-divide
16637 Do not generate inline code for divides of floating-point values.
16639 @item -minline-int-divide-min-latency
16640 @opindex minline-int-divide-min-latency
16641 Generate code for inline divides of integer values
16642 using the minimum latency algorithm.
16644 @item -minline-int-divide-max-throughput
16645 @opindex minline-int-divide-max-throughput
16646 Generate code for inline divides of integer values
16647 using the maximum throughput algorithm.
16649 @item -mno-inline-int-divide
16650 @opindex mno-inline-int-divide
16651 Do not generate inline code for divides of integer values.
16653 @item -minline-sqrt-min-latency
16654 @opindex minline-sqrt-min-latency
16655 Generate code for inline square roots
16656 using the minimum latency algorithm.
16658 @item -minline-sqrt-max-throughput
16659 @opindex minline-sqrt-max-throughput
16660 Generate code for inline square roots
16661 using the maximum throughput algorithm.
16663 @item -mno-inline-sqrt
16664 @opindex mno-inline-sqrt
16665 Do not generate inline code for @code{sqrt}.
16667 @item -mfused-madd
16668 @itemx -mno-fused-madd
16669 @opindex mfused-madd
16670 @opindex mno-fused-madd
16671 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16672 instructions.  The default is to use these instructions.
16674 @item -mno-dwarf2-asm
16675 @itemx -mdwarf2-asm
16676 @opindex mno-dwarf2-asm
16677 @opindex mdwarf2-asm
16678 Don't (or do) generate assembler code for the DWARF line number debugging
16679 info.  This may be useful when not using the GNU assembler.
16681 @item -mearly-stop-bits
16682 @itemx -mno-early-stop-bits
16683 @opindex mearly-stop-bits
16684 @opindex mno-early-stop-bits
16685 Allow stop bits to be placed earlier than immediately preceding the
16686 instruction that triggered the stop bit.  This can improve instruction
16687 scheduling, but does not always do so.
16689 @item -mfixed-range=@var{register-range}
16690 @opindex mfixed-range
16691 Generate code treating the given register range as fixed registers.
16692 A fixed register is one that the register allocator cannot use.  This is
16693 useful when compiling kernel code.  A register range is specified as
16694 two registers separated by a dash.  Multiple register ranges can be
16695 specified separated by a comma.
16697 @item -mtls-size=@var{tls-size}
16698 @opindex mtls-size
16699 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16702 @item -mtune=@var{cpu-type}
16703 @opindex mtune
16704 Tune the instruction scheduling for a particular CPU, Valid values are
16705 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16706 and @samp{mckinley}.
16708 @item -milp32
16709 @itemx -mlp64
16710 @opindex milp32
16711 @opindex mlp64
16712 Generate code for a 32-bit or 64-bit environment.
16713 The 32-bit environment sets int, long and pointer to 32 bits.
16714 The 64-bit environment sets int to 32 bits and long and pointer
16715 to 64 bits.  These are HP-UX specific flags.
16717 @item -mno-sched-br-data-spec
16718 @itemx -msched-br-data-spec
16719 @opindex mno-sched-br-data-spec
16720 @opindex msched-br-data-spec
16721 (Dis/En)able data speculative scheduling before reload.
16722 This results in generation of @code{ld.a} instructions and
16723 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16724 The default setting is disabled.
16726 @item -msched-ar-data-spec
16727 @itemx -mno-sched-ar-data-spec
16728 @opindex msched-ar-data-spec
16729 @opindex mno-sched-ar-data-spec
16730 (En/Dis)able data speculative scheduling after reload.
16731 This results in generation of @code{ld.a} instructions and
16732 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16733 The default setting is enabled.
16735 @item -mno-sched-control-spec
16736 @itemx -msched-control-spec
16737 @opindex mno-sched-control-spec
16738 @opindex msched-control-spec
16739 (Dis/En)able control speculative scheduling.  This feature is
16740 available only during region scheduling (i.e.@: before reload).
16741 This results in generation of the @code{ld.s} instructions and
16742 the corresponding check instructions @code{chk.s}.
16743 The default setting is disabled.
16745 @item -msched-br-in-data-spec
16746 @itemx -mno-sched-br-in-data-spec
16747 @opindex msched-br-in-data-spec
16748 @opindex mno-sched-br-in-data-spec
16749 (En/Dis)able speculative scheduling of the instructions that
16750 are dependent on the data speculative loads before reload.
16751 This is effective only with @option{-msched-br-data-spec} enabled.
16752 The default setting is enabled.
16754 @item -msched-ar-in-data-spec
16755 @itemx -mno-sched-ar-in-data-spec
16756 @opindex msched-ar-in-data-spec
16757 @opindex mno-sched-ar-in-data-spec
16758 (En/Dis)able speculative scheduling of the instructions that
16759 are dependent on the data speculative loads after reload.
16760 This is effective only with @option{-msched-ar-data-spec} enabled.
16761 The default setting is enabled.
16763 @item -msched-in-control-spec
16764 @itemx -mno-sched-in-control-spec
16765 @opindex msched-in-control-spec
16766 @opindex mno-sched-in-control-spec
16767 (En/Dis)able speculative scheduling of the instructions that
16768 are dependent on the control speculative loads.
16769 This is effective only with @option{-msched-control-spec} enabled.
16770 The default setting is enabled.
16772 @item -mno-sched-prefer-non-data-spec-insns
16773 @itemx -msched-prefer-non-data-spec-insns
16774 @opindex mno-sched-prefer-non-data-spec-insns
16775 @opindex msched-prefer-non-data-spec-insns
16776 If enabled, data-speculative instructions are chosen for schedule
16777 only if there are no other choices at the moment.  This makes
16778 the use of the data speculation much more conservative.
16779 The default setting is disabled.
16781 @item -mno-sched-prefer-non-control-spec-insns
16782 @itemx -msched-prefer-non-control-spec-insns
16783 @opindex mno-sched-prefer-non-control-spec-insns
16784 @opindex msched-prefer-non-control-spec-insns
16785 If enabled, control-speculative instructions are chosen for schedule
16786 only if there are no other choices at the moment.  This makes
16787 the use of the control speculation much more conservative.
16788 The default setting is disabled.
16790 @item -mno-sched-count-spec-in-critical-path
16791 @itemx -msched-count-spec-in-critical-path
16792 @opindex mno-sched-count-spec-in-critical-path
16793 @opindex msched-count-spec-in-critical-path
16794 If enabled, speculative dependencies are considered during
16795 computation of the instructions priorities.  This makes the use of the
16796 speculation a bit more conservative.
16797 The default setting is disabled.
16799 @item -msched-spec-ldc
16800 @opindex msched-spec-ldc
16801 Use a simple data speculation check.  This option is on by default.
16803 @item -msched-control-spec-ldc
16804 @opindex msched-spec-ldc
16805 Use a simple check for control speculation.  This option is on by default.
16807 @item -msched-stop-bits-after-every-cycle
16808 @opindex msched-stop-bits-after-every-cycle
16809 Place a stop bit after every cycle when scheduling.  This option is on
16810 by default.
16812 @item -msched-fp-mem-deps-zero-cost
16813 @opindex msched-fp-mem-deps-zero-cost
16814 Assume that floating-point stores and loads are not likely to cause a conflict
16815 when placed into the same instruction group.  This option is disabled by
16816 default.
16818 @item -msel-sched-dont-check-control-spec
16819 @opindex msel-sched-dont-check-control-spec
16820 Generate checks for control speculation in selective scheduling.
16821 This flag is disabled by default.
16823 @item -msched-max-memory-insns=@var{max-insns}
16824 @opindex msched-max-memory-insns
16825 Limit on the number of memory insns per instruction group, giving lower
16826 priority to subsequent memory insns attempting to schedule in the same
16827 instruction group. Frequently useful to prevent cache bank conflicts.
16828 The default value is 1.
16830 @item -msched-max-memory-insns-hard-limit
16831 @opindex msched-max-memory-insns-hard-limit
16832 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16833 disallowing more than that number in an instruction group.
16834 Otherwise, the limit is ``soft'', meaning that non-memory operations
16835 are preferred when the limit is reached, but memory operations may still
16836 be scheduled.
16838 @end table
16840 @node LM32 Options
16841 @subsection LM32 Options
16842 @cindex LM32 options
16844 These @option{-m} options are defined for the LatticeMico32 architecture:
16846 @table @gcctabopt
16847 @item -mbarrel-shift-enabled
16848 @opindex mbarrel-shift-enabled
16849 Enable barrel-shift instructions.
16851 @item -mdivide-enabled
16852 @opindex mdivide-enabled
16853 Enable divide and modulus instructions.
16855 @item -mmultiply-enabled
16856 @opindex multiply-enabled
16857 Enable multiply instructions.
16859 @item -msign-extend-enabled
16860 @opindex msign-extend-enabled
16861 Enable sign extend instructions.
16863 @item -muser-enabled
16864 @opindex muser-enabled
16865 Enable user-defined instructions.
16867 @end table
16869 @node M32C Options
16870 @subsection M32C Options
16871 @cindex M32C options
16873 @table @gcctabopt
16874 @item -mcpu=@var{name}
16875 @opindex mcpu=
16876 Select the CPU for which code is generated.  @var{name} may be one of
16877 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16878 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16879 the M32C/80 series.
16881 @item -msim
16882 @opindex msim
16883 Specifies that the program will be run on the simulator.  This causes
16884 an alternate runtime library to be linked in which supports, for
16885 example, file I/O@.  You must not use this option when generating
16886 programs that will run on real hardware; you must provide your own
16887 runtime library for whatever I/O functions are needed.
16889 @item -memregs=@var{number}
16890 @opindex memregs=
16891 Specifies the number of memory-based pseudo-registers GCC uses
16892 during code generation.  These pseudo-registers are used like real
16893 registers, so there is a tradeoff between GCC's ability to fit the
16894 code into available registers, and the performance penalty of using
16895 memory instead of registers.  Note that all modules in a program must
16896 be compiled with the same value for this option.  Because of that, you
16897 must not use this option with GCC's default runtime libraries.
16899 @end table
16901 @node M32R/D Options
16902 @subsection M32R/D Options
16903 @cindex M32R/D options
16905 These @option{-m} options are defined for Renesas M32R/D architectures:
16907 @table @gcctabopt
16908 @item -m32r2
16909 @opindex m32r2
16910 Generate code for the M32R/2@.
16912 @item -m32rx
16913 @opindex m32rx
16914 Generate code for the M32R/X@.
16916 @item -m32r
16917 @opindex m32r
16918 Generate code for the M32R@.  This is the default.
16920 @item -mmodel=small
16921 @opindex mmodel=small
16922 Assume all objects live in the lower 16MB of memory (so that their addresses
16923 can be loaded with the @code{ld24} instruction), and assume all subroutines
16924 are reachable with the @code{bl} instruction.
16925 This is the default.
16927 The addressability of a particular object can be set with the
16928 @code{model} attribute.
16930 @item -mmodel=medium
16931 @opindex mmodel=medium
16932 Assume objects may be anywhere in the 32-bit address space (the compiler
16933 generates @code{seth/add3} instructions to load their addresses), and
16934 assume all subroutines are reachable with the @code{bl} instruction.
16936 @item -mmodel=large
16937 @opindex mmodel=large
16938 Assume objects may be anywhere in the 32-bit address space (the compiler
16939 generates @code{seth/add3} instructions to load their addresses), and
16940 assume subroutines may not be reachable with the @code{bl} instruction
16941 (the compiler generates the much slower @code{seth/add3/jl}
16942 instruction sequence).
16944 @item -msdata=none
16945 @opindex msdata=none
16946 Disable use of the small data area.  Variables are put into
16947 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16948 @code{section} attribute has been specified).
16949 This is the default.
16951 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16952 Objects may be explicitly put in the small data area with the
16953 @code{section} attribute using one of these sections.
16955 @item -msdata=sdata
16956 @opindex msdata=sdata
16957 Put small global and static data in the small data area, but do not
16958 generate special code to reference them.
16960 @item -msdata=use
16961 @opindex msdata=use
16962 Put small global and static data in the small data area, and generate
16963 special instructions to reference them.
16965 @item -G @var{num}
16966 @opindex G
16967 @cindex smaller data references
16968 Put global and static objects less than or equal to @var{num} bytes
16969 into the small data or BSS sections instead of the normal data or BSS
16970 sections.  The default value of @var{num} is 8.
16971 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16972 for this option to have any effect.
16974 All modules should be compiled with the same @option{-G @var{num}} value.
16975 Compiling with different values of @var{num} may or may not work; if it
16976 doesn't the linker gives an error message---incorrect code is not
16977 generated.
16979 @item -mdebug
16980 @opindex mdebug
16981 Makes the M32R-specific code in the compiler display some statistics
16982 that might help in debugging programs.
16984 @item -malign-loops
16985 @opindex malign-loops
16986 Align all loops to a 32-byte boundary.
16988 @item -mno-align-loops
16989 @opindex mno-align-loops
16990 Do not enforce a 32-byte alignment for loops.  This is the default.
16992 @item -missue-rate=@var{number}
16993 @opindex missue-rate=@var{number}
16994 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16995 or 2.
16997 @item -mbranch-cost=@var{number}
16998 @opindex mbranch-cost=@var{number}
16999 @var{number} can only be 1 or 2.  If it is 1 then branches are
17000 preferred over conditional code, if it is 2, then the opposite applies.
17002 @item -mflush-trap=@var{number}
17003 @opindex mflush-trap=@var{number}
17004 Specifies the trap number to use to flush the cache.  The default is
17005 12.  Valid numbers are between 0 and 15 inclusive.
17007 @item -mno-flush-trap
17008 @opindex mno-flush-trap
17009 Specifies that the cache cannot be flushed by using a trap.
17011 @item -mflush-func=@var{name}
17012 @opindex mflush-func=@var{name}
17013 Specifies the name of the operating system function to call to flush
17014 the cache.  The default is @samp{_flush_cache}, but a function call
17015 is only used if a trap is not available.
17017 @item -mno-flush-func
17018 @opindex mno-flush-func
17019 Indicates that there is no OS function for flushing the cache.
17021 @end table
17023 @node M680x0 Options
17024 @subsection M680x0 Options
17025 @cindex M680x0 options
17027 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
17028 The default settings depend on which architecture was selected when
17029 the compiler was configured; the defaults for the most common choices
17030 are given below.
17032 @table @gcctabopt
17033 @item -march=@var{arch}
17034 @opindex march
17035 Generate code for a specific M680x0 or ColdFire instruction set
17036 architecture.  Permissible values of @var{arch} for M680x0
17037 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
17038 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
17039 architectures are selected according to Freescale's ISA classification
17040 and the permissible values are: @samp{isaa}, @samp{isaaplus},
17041 @samp{isab} and @samp{isac}.
17043 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
17044 code for a ColdFire target.  The @var{arch} in this macro is one of the
17045 @option{-march} arguments given above.
17047 When used together, @option{-march} and @option{-mtune} select code
17048 that runs on a family of similar processors but that is optimized
17049 for a particular microarchitecture.
17051 @item -mcpu=@var{cpu}
17052 @opindex mcpu
17053 Generate code for a specific M680x0 or ColdFire processor.
17054 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
17055 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
17056 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
17057 below, which also classifies the CPUs into families:
17059 @multitable @columnfractions 0.20 0.80
17060 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
17061 @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}
17062 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
17063 @item @samp{5206e} @tab @samp{5206e}
17064 @item @samp{5208} @tab @samp{5207} @samp{5208}
17065 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
17066 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
17067 @item @samp{5216} @tab @samp{5214} @samp{5216}
17068 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
17069 @item @samp{5225} @tab @samp{5224} @samp{5225}
17070 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
17071 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
17072 @item @samp{5249} @tab @samp{5249}
17073 @item @samp{5250} @tab @samp{5250}
17074 @item @samp{5271} @tab @samp{5270} @samp{5271}
17075 @item @samp{5272} @tab @samp{5272}
17076 @item @samp{5275} @tab @samp{5274} @samp{5275}
17077 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
17078 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
17079 @item @samp{5307} @tab @samp{5307}
17080 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
17081 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
17082 @item @samp{5407} @tab @samp{5407}
17083 @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}
17084 @end multitable
17086 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
17087 @var{arch} is compatible with @var{cpu}.  Other combinations of
17088 @option{-mcpu} and @option{-march} are rejected.
17090 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
17091 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
17092 where the value of @var{family} is given by the table above.
17094 @item -mtune=@var{tune}
17095 @opindex mtune
17096 Tune the code for a particular microarchitecture within the
17097 constraints set by @option{-march} and @option{-mcpu}.
17098 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
17099 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
17100 and @samp{cpu32}.  The ColdFire microarchitectures
17101 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
17103 You can also use @option{-mtune=68020-40} for code that needs
17104 to run relatively well on 68020, 68030 and 68040 targets.
17105 @option{-mtune=68020-60} is similar but includes 68060 targets
17106 as well.  These two options select the same tuning decisions as
17107 @option{-m68020-40} and @option{-m68020-60} respectively.
17109 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
17110 when tuning for 680x0 architecture @var{arch}.  It also defines
17111 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
17112 option is used.  If GCC is tuning for a range of architectures,
17113 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
17114 it defines the macros for every architecture in the range.
17116 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
17117 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
17118 of the arguments given above.
17120 @item -m68000
17121 @itemx -mc68000
17122 @opindex m68000
17123 @opindex mc68000
17124 Generate output for a 68000.  This is the default
17125 when the compiler is configured for 68000-based systems.
17126 It is equivalent to @option{-march=68000}.
17128 Use this option for microcontrollers with a 68000 or EC000 core,
17129 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
17131 @item -m68010
17132 @opindex m68010
17133 Generate output for a 68010.  This is the default
17134 when the compiler is configured for 68010-based systems.
17135 It is equivalent to @option{-march=68010}.
17137 @item -m68020
17138 @itemx -mc68020
17139 @opindex m68020
17140 @opindex mc68020
17141 Generate output for a 68020.  This is the default
17142 when the compiler is configured for 68020-based systems.
17143 It is equivalent to @option{-march=68020}.
17145 @item -m68030
17146 @opindex m68030
17147 Generate output for a 68030.  This is the default when the compiler is
17148 configured for 68030-based systems.  It is equivalent to
17149 @option{-march=68030}.
17151 @item -m68040
17152 @opindex m68040
17153 Generate output for a 68040.  This is the default when the compiler is
17154 configured for 68040-based systems.  It is equivalent to
17155 @option{-march=68040}.
17157 This option inhibits the use of 68881/68882 instructions that have to be
17158 emulated by software on the 68040.  Use this option if your 68040 does not
17159 have code to emulate those instructions.
17161 @item -m68060
17162 @opindex m68060
17163 Generate output for a 68060.  This is the default when the compiler is
17164 configured for 68060-based systems.  It is equivalent to
17165 @option{-march=68060}.
17167 This option inhibits the use of 68020 and 68881/68882 instructions that
17168 have to be emulated by software on the 68060.  Use this option if your 68060
17169 does not have code to emulate those instructions.
17171 @item -mcpu32
17172 @opindex mcpu32
17173 Generate output for a CPU32.  This is the default
17174 when the compiler is configured for CPU32-based systems.
17175 It is equivalent to @option{-march=cpu32}.
17177 Use this option for microcontrollers with a
17178 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
17179 68336, 68340, 68341, 68349 and 68360.
17181 @item -m5200
17182 @opindex m5200
17183 Generate output for a 520X ColdFire CPU@.  This is the default
17184 when the compiler is configured for 520X-based systems.
17185 It is equivalent to @option{-mcpu=5206}, and is now deprecated
17186 in favor of that option.
17188 Use this option for microcontroller with a 5200 core, including
17189 the MCF5202, MCF5203, MCF5204 and MCF5206.
17191 @item -m5206e
17192 @opindex m5206e
17193 Generate output for a 5206e ColdFire CPU@.  The option is now
17194 deprecated in favor of the equivalent @option{-mcpu=5206e}.
17196 @item -m528x
17197 @opindex m528x
17198 Generate output for a member of the ColdFire 528X family.
17199 The option is now deprecated in favor of the equivalent
17200 @option{-mcpu=528x}.
17202 @item -m5307
17203 @opindex m5307
17204 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
17205 in favor of the equivalent @option{-mcpu=5307}.
17207 @item -m5407
17208 @opindex m5407
17209 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
17210 in favor of the equivalent @option{-mcpu=5407}.
17212 @item -mcfv4e
17213 @opindex mcfv4e
17214 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
17215 This includes use of hardware floating-point instructions.
17216 The option is equivalent to @option{-mcpu=547x}, and is now
17217 deprecated in favor of that option.
17219 @item -m68020-40
17220 @opindex m68020-40
17221 Generate output for a 68040, without using any of the new instructions.
17222 This results in code that can run relatively efficiently on either a
17223 68020/68881 or a 68030 or a 68040.  The generated code does use the
17224 68881 instructions that are emulated on the 68040.
17226 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
17228 @item -m68020-60
17229 @opindex m68020-60
17230 Generate output for a 68060, without using any of the new instructions.
17231 This results in code that can run relatively efficiently on either a
17232 68020/68881 or a 68030 or a 68040.  The generated code does use the
17233 68881 instructions that are emulated on the 68060.
17235 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
17237 @item -mhard-float
17238 @itemx -m68881
17239 @opindex mhard-float
17240 @opindex m68881
17241 Generate floating-point instructions.  This is the default for 68020
17242 and above, and for ColdFire devices that have an FPU@.  It defines the
17243 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
17244 on ColdFire targets.
17246 @item -msoft-float
17247 @opindex msoft-float
17248 Do not generate floating-point instructions; use library calls instead.
17249 This is the default for 68000, 68010, and 68832 targets.  It is also
17250 the default for ColdFire devices that have no FPU.
17252 @item -mdiv
17253 @itemx -mno-div
17254 @opindex mdiv
17255 @opindex mno-div
17256 Generate (do not generate) ColdFire hardware divide and remainder
17257 instructions.  If @option{-march} is used without @option{-mcpu},
17258 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
17259 architectures.  Otherwise, the default is taken from the target CPU
17260 (either the default CPU, or the one specified by @option{-mcpu}).  For
17261 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
17262 @option{-mcpu=5206e}.
17264 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
17266 @item -mshort
17267 @opindex mshort
17268 Consider type @code{int} to be 16 bits wide, like @code{short int}.
17269 Additionally, parameters passed on the stack are also aligned to a
17270 16-bit boundary even on targets whose API mandates promotion to 32-bit.
17272 @item -mno-short
17273 @opindex mno-short
17274 Do not consider type @code{int} to be 16 bits wide.  This is the default.
17276 @item -mnobitfield
17277 @itemx -mno-bitfield
17278 @opindex mnobitfield
17279 @opindex mno-bitfield
17280 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
17281 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
17283 @item -mbitfield
17284 @opindex mbitfield
17285 Do use the bit-field instructions.  The @option{-m68020} option implies
17286 @option{-mbitfield}.  This is the default if you use a configuration
17287 designed for a 68020.
17289 @item -mrtd
17290 @opindex mrtd
17291 Use a different function-calling convention, in which functions
17292 that take a fixed number of arguments return with the @code{rtd}
17293 instruction, which pops their arguments while returning.  This
17294 saves one instruction in the caller since there is no need to pop
17295 the arguments there.
17297 This calling convention is incompatible with the one normally
17298 used on Unix, so you cannot use it if you need to call libraries
17299 compiled with the Unix compiler.
17301 Also, you must provide function prototypes for all functions that
17302 take variable numbers of arguments (including @code{printf});
17303 otherwise incorrect code is generated for calls to those
17304 functions.
17306 In addition, seriously incorrect code results if you call a
17307 function with too many arguments.  (Normally, extra arguments are
17308 harmlessly ignored.)
17310 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
17311 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
17313 @item -mno-rtd
17314 @opindex mno-rtd
17315 Do not use the calling conventions selected by @option{-mrtd}.
17316 This is the default.
17318 @item -malign-int
17319 @itemx -mno-align-int
17320 @opindex malign-int
17321 @opindex mno-align-int
17322 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
17323 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
17324 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
17325 Aligning variables on 32-bit boundaries produces code that runs somewhat
17326 faster on processors with 32-bit busses at the expense of more memory.
17328 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
17329 aligns structures containing the above types differently than
17330 most published application binary interface specifications for the m68k.
17332 @item -mpcrel
17333 @opindex mpcrel
17334 Use the pc-relative addressing mode of the 68000 directly, instead of
17335 using a global offset table.  At present, this option implies @option{-fpic},
17336 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
17337 not presently supported with @option{-mpcrel}, though this could be supported for
17338 68020 and higher processors.
17340 @item -mno-strict-align
17341 @itemx -mstrict-align
17342 @opindex mno-strict-align
17343 @opindex mstrict-align
17344 Do not (do) assume that unaligned memory references are handled by
17345 the system.
17347 @item -msep-data
17348 Generate code that allows the data segment to be located in a different
17349 area of memory from the text segment.  This allows for execute-in-place in
17350 an environment without virtual memory management.  This option implies
17351 @option{-fPIC}.
17353 @item -mno-sep-data
17354 Generate code that assumes that the data segment follows the text segment.
17355 This is the default.
17357 @item -mid-shared-library
17358 Generate code that supports shared libraries via the library ID method.
17359 This allows for execute-in-place and shared libraries in an environment
17360 without virtual memory management.  This option implies @option{-fPIC}.
17362 @item -mno-id-shared-library
17363 Generate code that doesn't assume ID-based shared libraries are being used.
17364 This is the default.
17366 @item -mshared-library-id=n
17367 Specifies the identification number of the ID-based shared library being
17368 compiled.  Specifying a value of 0 generates more compact code; specifying
17369 other values forces the allocation of that number to the current
17370 library, but is no more space- or time-efficient than omitting this option.
17372 @item -mxgot
17373 @itemx -mno-xgot
17374 @opindex mxgot
17375 @opindex mno-xgot
17376 When generating position-independent code for ColdFire, generate code
17377 that works if the GOT has more than 8192 entries.  This code is
17378 larger and slower than code generated without this option.  On M680x0
17379 processors, this option is not needed; @option{-fPIC} suffices.
17381 GCC normally uses a single instruction to load values from the GOT@.
17382 While this is relatively efficient, it only works if the GOT
17383 is smaller than about 64k.  Anything larger causes the linker
17384 to report an error such as:
17386 @cindex relocation truncated to fit (ColdFire)
17387 @smallexample
17388 relocation truncated to fit: R_68K_GOT16O foobar
17389 @end smallexample
17391 If this happens, you should recompile your code with @option{-mxgot}.
17392 It should then work with very large GOTs.  However, code generated with
17393 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17394 the value of a global symbol.
17396 Note that some linkers, including newer versions of the GNU linker,
17397 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17398 you should only need to use @option{-mxgot} when compiling a single
17399 object file that accesses more than 8192 GOT entries.  Very few do.
17401 These options have no effect unless GCC is generating
17402 position-independent code.
17404 @end table
17406 @node MCore Options
17407 @subsection MCore Options
17408 @cindex MCore options
17410 These are the @samp{-m} options defined for the Motorola M*Core
17411 processors.
17413 @table @gcctabopt
17415 @item -mhardlit
17416 @itemx -mno-hardlit
17417 @opindex mhardlit
17418 @opindex mno-hardlit
17419 Inline constants into the code stream if it can be done in two
17420 instructions or less.
17422 @item -mdiv
17423 @itemx -mno-div
17424 @opindex mdiv
17425 @opindex mno-div
17426 Use the divide instruction.  (Enabled by default).
17428 @item -mrelax-immediate
17429 @itemx -mno-relax-immediate
17430 @opindex mrelax-immediate
17431 @opindex mno-relax-immediate
17432 Allow arbitrary-sized immediates in bit operations.
17434 @item -mwide-bitfields
17435 @itemx -mno-wide-bitfields
17436 @opindex mwide-bitfields
17437 @opindex mno-wide-bitfields
17438 Always treat bit-fields as @code{int}-sized.
17440 @item -m4byte-functions
17441 @itemx -mno-4byte-functions
17442 @opindex m4byte-functions
17443 @opindex mno-4byte-functions
17444 Force all functions to be aligned to a 4-byte boundary.
17446 @item -mcallgraph-data
17447 @itemx -mno-callgraph-data
17448 @opindex mcallgraph-data
17449 @opindex mno-callgraph-data
17450 Emit callgraph information.
17452 @item -mslow-bytes
17453 @itemx -mno-slow-bytes
17454 @opindex mslow-bytes
17455 @opindex mno-slow-bytes
17456 Prefer word access when reading byte quantities.
17458 @item -mlittle-endian
17459 @itemx -mbig-endian
17460 @opindex mlittle-endian
17461 @opindex mbig-endian
17462 Generate code for a little-endian target.
17464 @item -m210
17465 @itemx -m340
17466 @opindex m210
17467 @opindex m340
17468 Generate code for the 210 processor.
17470 @item -mno-lsim
17471 @opindex mno-lsim
17472 Assume that runtime support has been provided and so omit the
17473 simulator library (@file{libsim.a)} from the linker command line.
17475 @item -mstack-increment=@var{size}
17476 @opindex mstack-increment
17477 Set the maximum amount for a single stack increment operation.  Large
17478 values can increase the speed of programs that contain functions
17479 that need a large amount of stack space, but they can also trigger a
17480 segmentation fault if the stack is extended too much.  The default
17481 value is 0x1000.
17483 @end table
17485 @node MeP Options
17486 @subsection MeP Options
17487 @cindex MeP options
17489 @table @gcctabopt
17491 @item -mabsdiff
17492 @opindex mabsdiff
17493 Enables the @code{abs} instruction, which is the absolute difference
17494 between two registers.
17496 @item -mall-opts
17497 @opindex mall-opts
17498 Enables all the optional instructions---average, multiply, divide, bit
17499 operations, leading zero, absolute difference, min/max, clip, and
17500 saturation.
17503 @item -maverage
17504 @opindex maverage
17505 Enables the @code{ave} instruction, which computes the average of two
17506 registers.
17508 @item -mbased=@var{n}
17509 @opindex mbased=
17510 Variables of size @var{n} bytes or smaller are placed in the
17511 @code{.based} section by default.  Based variables use the @code{$tp}
17512 register as a base register, and there is a 128-byte limit to the
17513 @code{.based} section.
17515 @item -mbitops
17516 @opindex mbitops
17517 Enables the bit operation instructions---bit test (@code{btstm}), set
17518 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17519 test-and-set (@code{tas}).
17521 @item -mc=@var{name}
17522 @opindex mc=
17523 Selects which section constant data is placed in.  @var{name} may
17524 be @samp{tiny}, @samp{near}, or @samp{far}.
17526 @item -mclip
17527 @opindex mclip
17528 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
17529 useful unless you also provide @option{-mminmax}.
17531 @item -mconfig=@var{name}
17532 @opindex mconfig=
17533 Selects one of the built-in core configurations.  Each MeP chip has
17534 one or more modules in it; each module has a core CPU and a variety of
17535 coprocessors, optional instructions, and peripherals.  The
17536 @code{MeP-Integrator} tool, not part of GCC, provides these
17537 configurations through this option; using this option is the same as
17538 using all the corresponding command-line options.  The default
17539 configuration is @samp{default}.
17541 @item -mcop
17542 @opindex mcop
17543 Enables the coprocessor instructions.  By default, this is a 32-bit
17544 coprocessor.  Note that the coprocessor is normally enabled via the
17545 @option{-mconfig=} option.
17547 @item -mcop32
17548 @opindex mcop32
17549 Enables the 32-bit coprocessor's instructions.
17551 @item -mcop64
17552 @opindex mcop64
17553 Enables the 64-bit coprocessor's instructions.
17555 @item -mivc2
17556 @opindex mivc2
17557 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17559 @item -mdc
17560 @opindex mdc
17561 Causes constant variables to be placed in the @code{.near} section.
17563 @item -mdiv
17564 @opindex mdiv
17565 Enables the @code{div} and @code{divu} instructions.
17567 @item -meb
17568 @opindex meb
17569 Generate big-endian code.
17571 @item -mel
17572 @opindex mel
17573 Generate little-endian code.
17575 @item -mio-volatile
17576 @opindex mio-volatile
17577 Tells the compiler that any variable marked with the @code{io}
17578 attribute is to be considered volatile.
17580 @item -ml
17581 @opindex ml
17582 Causes variables to be assigned to the @code{.far} section by default.
17584 @item -mleadz
17585 @opindex mleadz
17586 Enables the @code{leadz} (leading zero) instruction.
17588 @item -mm
17589 @opindex mm
17590 Causes variables to be assigned to the @code{.near} section by default.
17592 @item -mminmax
17593 @opindex mminmax
17594 Enables the @code{min} and @code{max} instructions.
17596 @item -mmult
17597 @opindex mmult
17598 Enables the multiplication and multiply-accumulate instructions.
17600 @item -mno-opts
17601 @opindex mno-opts
17602 Disables all the optional instructions enabled by @option{-mall-opts}.
17604 @item -mrepeat
17605 @opindex mrepeat
17606 Enables the @code{repeat} and @code{erepeat} instructions, used for
17607 low-overhead looping.
17609 @item -ms
17610 @opindex ms
17611 Causes all variables to default to the @code{.tiny} section.  Note
17612 that there is a 65536-byte limit to this section.  Accesses to these
17613 variables use the @code{%gp} base register.
17615 @item -msatur
17616 @opindex msatur
17617 Enables the saturation instructions.  Note that the compiler does not
17618 currently generate these itself, but this option is included for
17619 compatibility with other tools, like @code{as}.
17621 @item -msdram
17622 @opindex msdram
17623 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17625 @item -msim
17626 @opindex msim
17627 Link the simulator run-time libraries.
17629 @item -msimnovec
17630 @opindex msimnovec
17631 Link the simulator runtime libraries, excluding built-in support
17632 for reset and exception vectors and tables.
17634 @item -mtf
17635 @opindex mtf
17636 Causes all functions to default to the @code{.far} section.  Without
17637 this option, functions default to the @code{.near} section.
17639 @item -mtiny=@var{n}
17640 @opindex mtiny=
17641 Variables that are @var{n} bytes or smaller are allocated to the
17642 @code{.tiny} section.  These variables use the @code{$gp} base
17643 register.  The default for this option is 4, but note that there's a
17644 65536-byte limit to the @code{.tiny} section.
17646 @end table
17648 @node MicroBlaze Options
17649 @subsection MicroBlaze Options
17650 @cindex MicroBlaze Options
17652 @table @gcctabopt
17654 @item -msoft-float
17655 @opindex msoft-float
17656 Use software emulation for floating point (default).
17658 @item -mhard-float
17659 @opindex mhard-float
17660 Use hardware floating-point instructions.
17662 @item -mmemcpy
17663 @opindex mmemcpy
17664 Do not optimize block moves, use @code{memcpy}.
17666 @item -mno-clearbss
17667 @opindex mno-clearbss
17668 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17670 @item -mcpu=@var{cpu-type}
17671 @opindex mcpu=
17672 Use features of, and schedule code for, the given CPU.
17673 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17674 where @var{X} is a major version, @var{YY} is the minor version, and
17675 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17676 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17678 @item -mxl-soft-mul
17679 @opindex mxl-soft-mul
17680 Use software multiply emulation (default).
17682 @item -mxl-soft-div
17683 @opindex mxl-soft-div
17684 Use software emulation for divides (default).
17686 @item -mxl-barrel-shift
17687 @opindex mxl-barrel-shift
17688 Use the hardware barrel shifter.
17690 @item -mxl-pattern-compare
17691 @opindex mxl-pattern-compare
17692 Use pattern compare instructions.
17694 @item -msmall-divides
17695 @opindex msmall-divides
17696 Use table lookup optimization for small signed integer divisions.
17698 @item -mxl-stack-check
17699 @opindex mxl-stack-check
17700 This option is deprecated.  Use @option{-fstack-check} instead.
17702 @item -mxl-gp-opt
17703 @opindex mxl-gp-opt
17704 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17706 @item -mxl-multiply-high
17707 @opindex mxl-multiply-high
17708 Use multiply high instructions for high part of 32x32 multiply.
17710 @item -mxl-float-convert
17711 @opindex mxl-float-convert
17712 Use hardware floating-point conversion instructions.
17714 @item -mxl-float-sqrt
17715 @opindex mxl-float-sqrt
17716 Use hardware floating-point square root instruction.
17718 @item -mbig-endian
17719 @opindex mbig-endian
17720 Generate code for a big-endian target.
17722 @item -mlittle-endian
17723 @opindex mlittle-endian
17724 Generate code for a little-endian target.
17726 @item -mxl-reorder
17727 @opindex mxl-reorder
17728 Use reorder instructions (swap and byte reversed load/store).
17730 @item -mxl-mode-@var{app-model}
17731 Select application model @var{app-model}.  Valid models are
17732 @table @samp
17733 @item executable
17734 normal executable (default), uses startup code @file{crt0.o}.
17736 @item xmdstub
17737 for use with Xilinx Microprocessor Debugger (XMD) based
17738 software intrusive debug agent called xmdstub. This uses startup file
17739 @file{crt1.o} and sets the start address of the program to 0x800.
17741 @item bootstrap
17742 for applications that are loaded using a bootloader.
17743 This model uses startup file @file{crt2.o} which does not contain a processor
17744 reset vector handler. This is suitable for transferring control on a
17745 processor reset to the bootloader rather than the application.
17747 @item novectors
17748 for applications that do not require any of the
17749 MicroBlaze vectors. This option may be useful for applications running
17750 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17751 @end table
17753 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17754 @option{-mxl-mode-@var{app-model}}.
17756 @end table
17758 @node MIPS Options
17759 @subsection MIPS Options
17760 @cindex MIPS options
17762 @table @gcctabopt
17764 @item -EB
17765 @opindex EB
17766 Generate big-endian code.
17768 @item -EL
17769 @opindex EL
17770 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17771 configurations.
17773 @item -march=@var{arch}
17774 @opindex march
17775 Generate code that runs on @var{arch}, which can be the name of a
17776 generic MIPS ISA, or the name of a particular processor.
17777 The ISA names are:
17778 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17779 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17780 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17781 @samp{mips64r5} and @samp{mips64r6}.
17782 The processor names are:
17783 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17784 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17785 @samp{5kc}, @samp{5kf},
17786 @samp{20kc},
17787 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17788 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17789 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17790 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17791 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17792 @samp{i6400},
17793 @samp{interaptiv},
17794 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17795 @samp{m4k},
17796 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17797 @samp{m5100}, @samp{m5101},
17798 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17799 @samp{orion},
17800 @samp{p5600},
17801 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17802 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17803 @samp{rm7000}, @samp{rm9000},
17804 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17805 @samp{sb1},
17806 @samp{sr71000},
17807 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17808 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17809 @samp{xlr} and @samp{xlp}.
17810 The special value @samp{from-abi} selects the
17811 most compatible architecture for the selected ABI (that is,
17812 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17814 The native Linux/GNU toolchain also supports the value @samp{native},
17815 which selects the best architecture option for the host processor.
17816 @option{-march=native} has no effect if GCC does not recognize
17817 the processor.
17819 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17820 (for example, @option{-march=r2k}).  Prefixes are optional, and
17821 @samp{vr} may be written @samp{r}.
17823 Names of the form @samp{@var{n}f2_1} refer to processors with
17824 FPUs clocked at half the rate of the core, names of the form
17825 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17826 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17827 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17828 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17829 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17830 accepted as synonyms for @samp{@var{n}f1_1}.
17832 GCC defines two macros based on the value of this option.  The first
17833 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
17834 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
17835 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
17836 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
17837 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
17839 Note that the @code{_MIPS_ARCH} macro uses the processor names given
17840 above.  In other words, it has the full prefix and does not
17841 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17842 the macro names the resolved architecture (either @code{"mips1"} or
17843 @code{"mips3"}).  It names the default architecture when no
17844 @option{-march} option is given.
17846 @item -mtune=@var{arch}
17847 @opindex mtune
17848 Optimize for @var{arch}.  Among other things, this option controls
17849 the way instructions are scheduled, and the perceived cost of arithmetic
17850 operations.  The list of @var{arch} values is the same as for
17851 @option{-march}.
17853 When this option is not used, GCC optimizes for the processor
17854 specified by @option{-march}.  By using @option{-march} and
17855 @option{-mtune} together, it is possible to generate code that
17856 runs on a family of processors, but optimize the code for one
17857 particular member of that family.
17859 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
17860 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17861 @option{-march} ones described above.
17863 @item -mips1
17864 @opindex mips1
17865 Equivalent to @option{-march=mips1}.
17867 @item -mips2
17868 @opindex mips2
17869 Equivalent to @option{-march=mips2}.
17871 @item -mips3
17872 @opindex mips3
17873 Equivalent to @option{-march=mips3}.
17875 @item -mips4
17876 @opindex mips4
17877 Equivalent to @option{-march=mips4}.
17879 @item -mips32
17880 @opindex mips32
17881 Equivalent to @option{-march=mips32}.
17883 @item -mips32r3
17884 @opindex mips32r3
17885 Equivalent to @option{-march=mips32r3}.
17887 @item -mips32r5
17888 @opindex mips32r5
17889 Equivalent to @option{-march=mips32r5}.
17891 @item -mips32r6
17892 @opindex mips32r6
17893 Equivalent to @option{-march=mips32r6}.
17895 @item -mips64
17896 @opindex mips64
17897 Equivalent to @option{-march=mips64}.
17899 @item -mips64r2
17900 @opindex mips64r2
17901 Equivalent to @option{-march=mips64r2}.
17903 @item -mips64r3
17904 @opindex mips64r3
17905 Equivalent to @option{-march=mips64r3}.
17907 @item -mips64r5
17908 @opindex mips64r5
17909 Equivalent to @option{-march=mips64r5}.
17911 @item -mips64r6
17912 @opindex mips64r6
17913 Equivalent to @option{-march=mips64r6}.
17915 @item -mips16
17916 @itemx -mno-mips16
17917 @opindex mips16
17918 @opindex mno-mips16
17919 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17920 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17922 MIPS16 code generation can also be controlled on a per-function basis
17923 by means of @code{mips16} and @code{nomips16} attributes.
17924 @xref{Function Attributes}, for more information.
17926 @item -mflip-mips16
17927 @opindex mflip-mips16
17928 Generate MIPS16 code on alternating functions.  This option is provided
17929 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17930 not intended for ordinary use in compiling user code.
17932 @item -minterlink-compressed
17933 @item -mno-interlink-compressed
17934 @opindex minterlink-compressed
17935 @opindex mno-interlink-compressed
17936 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17937 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17939 For example, code using the standard ISA encoding cannot jump directly
17940 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17941 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17942 knows that the target of the jump is not compressed.
17944 @item -minterlink-mips16
17945 @itemx -mno-interlink-mips16
17946 @opindex minterlink-mips16
17947 @opindex mno-interlink-mips16
17948 Aliases of @option{-minterlink-compressed} and
17949 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17950 and are retained for backwards compatibility.
17952 @item -mabi=32
17953 @itemx -mabi=o64
17954 @itemx -mabi=n32
17955 @itemx -mabi=64
17956 @itemx -mabi=eabi
17957 @opindex mabi=32
17958 @opindex mabi=o64
17959 @opindex mabi=n32
17960 @opindex mabi=64
17961 @opindex mabi=eabi
17962 Generate code for the given ABI@.
17964 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17965 generates 64-bit code when you select a 64-bit architecture, but you
17966 can use @option{-mgp32} to get 32-bit code instead.
17968 For information about the O64 ABI, see
17969 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17971 GCC supports a variant of the o32 ABI in which floating-point registers
17972 are 64 rather than 32 bits wide.  You can select this combination with
17973 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17974 and @code{mfhc1} instructions and is therefore only supported for
17975 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17977 The register assignments for arguments and return values remain the
17978 same, but each scalar value is passed in a single 64-bit register
17979 rather than a pair of 32-bit registers.  For example, scalar
17980 floating-point values are returned in @samp{$f0} only, not a
17981 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17982 remains the same in that the even-numbered double-precision registers
17983 are saved.
17985 Two additional variants of the o32 ABI are supported to enable
17986 a transition from 32-bit to 64-bit registers.  These are FPXX
17987 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17988 The FPXX extension mandates that all code must execute correctly
17989 when run using 32-bit or 64-bit registers.  The code can be interlinked
17990 with either FP32 or FP64, but not both.
17991 The FP64A extension is similar to the FP64 extension but forbids the
17992 use of odd-numbered single-precision registers.  This can be used
17993 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17994 processors and allows both FP32 and FP64A code to interlink and
17995 run in the same process without changing FPU modes.
17997 @item -mabicalls
17998 @itemx -mno-abicalls
17999 @opindex mabicalls
18000 @opindex mno-abicalls
18001 Generate (do not generate) code that is suitable for SVR4-style
18002 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
18003 systems.
18005 @item -mshared
18006 @itemx -mno-shared
18007 Generate (do not generate) code that is fully position-independent,
18008 and that can therefore be linked into shared libraries.  This option
18009 only affects @option{-mabicalls}.
18011 All @option{-mabicalls} code has traditionally been position-independent,
18012 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
18013 as an extension, the GNU toolchain allows executables to use absolute
18014 accesses for locally-binding symbols.  It can also use shorter GP
18015 initialization sequences and generate direct calls to locally-defined
18016 functions.  This mode is selected by @option{-mno-shared}.
18018 @option{-mno-shared} depends on binutils 2.16 or higher and generates
18019 objects that can only be linked by the GNU linker.  However, the option
18020 does not affect the ABI of the final executable; it only affects the ABI
18021 of relocatable objects.  Using @option{-mno-shared} generally makes
18022 executables both smaller and quicker.
18024 @option{-mshared} is the default.
18026 @item -mplt
18027 @itemx -mno-plt
18028 @opindex mplt
18029 @opindex mno-plt
18030 Assume (do not assume) that the static and dynamic linkers
18031 support PLTs and copy relocations.  This option only affects
18032 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
18033 has no effect without @option{-msym32}.
18035 You can make @option{-mplt} the default by configuring
18036 GCC with @option{--with-mips-plt}.  The default is
18037 @option{-mno-plt} otherwise.
18039 @item -mxgot
18040 @itemx -mno-xgot
18041 @opindex mxgot
18042 @opindex mno-xgot
18043 Lift (do not lift) the usual restrictions on the size of the global
18044 offset table.
18046 GCC normally uses a single instruction to load values from the GOT@.
18047 While this is relatively efficient, it only works if the GOT
18048 is smaller than about 64k.  Anything larger causes the linker
18049 to report an error such as:
18051 @cindex relocation truncated to fit (MIPS)
18052 @smallexample
18053 relocation truncated to fit: R_MIPS_GOT16 foobar
18054 @end smallexample
18056 If this happens, you should recompile your code with @option{-mxgot}.
18057 This works with very large GOTs, although the code is also
18058 less efficient, since it takes three instructions to fetch the
18059 value of a global symbol.
18061 Note that some linkers can create multiple GOTs.  If you have such a
18062 linker, you should only need to use @option{-mxgot} when a single object
18063 file accesses more than 64k's worth of GOT entries.  Very few do.
18065 These options have no effect unless GCC is generating position
18066 independent code.
18068 @item -mgp32
18069 @opindex mgp32
18070 Assume that general-purpose registers are 32 bits wide.
18072 @item -mgp64
18073 @opindex mgp64
18074 Assume that general-purpose registers are 64 bits wide.
18076 @item -mfp32
18077 @opindex mfp32
18078 Assume that floating-point registers are 32 bits wide.
18080 @item -mfp64
18081 @opindex mfp64
18082 Assume that floating-point registers are 64 bits wide.
18084 @item -mfpxx
18085 @opindex mfpxx
18086 Do not assume the width of floating-point registers.
18088 @item -mhard-float
18089 @opindex mhard-float
18090 Use floating-point coprocessor instructions.
18092 @item -msoft-float
18093 @opindex msoft-float
18094 Do not use floating-point coprocessor instructions.  Implement
18095 floating-point calculations using library calls instead.
18097 @item -mno-float
18098 @opindex mno-float
18099 Equivalent to @option{-msoft-float}, but additionally asserts that the
18100 program being compiled does not perform any floating-point operations.
18101 This option is presently supported only by some bare-metal MIPS
18102 configurations, where it may select a special set of libraries
18103 that lack all floating-point support (including, for example, the
18104 floating-point @code{printf} formats).  
18105 If code compiled with @option{-mno-float} accidentally contains
18106 floating-point operations, it is likely to suffer a link-time
18107 or run-time failure.
18109 @item -msingle-float
18110 @opindex msingle-float
18111 Assume that the floating-point coprocessor only supports single-precision
18112 operations.
18114 @item -mdouble-float
18115 @opindex mdouble-float
18116 Assume that the floating-point coprocessor supports double-precision
18117 operations.  This is the default.
18119 @item -modd-spreg
18120 @itemx -mno-odd-spreg
18121 @opindex modd-spreg
18122 @opindex mno-odd-spreg
18123 Enable the use of odd-numbered single-precision floating-point registers
18124 for the o32 ABI.  This is the default for processors that are known to
18125 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
18126 is set by default.
18128 @item -mabs=2008
18129 @itemx -mabs=legacy
18130 @opindex mabs=2008
18131 @opindex mabs=legacy
18132 These options control the treatment of the special not-a-number (NaN)
18133 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
18134 @code{neg.@i{fmt}} machine instructions.
18136 By default or when @option{-mabs=legacy} is used the legacy
18137 treatment is selected.  In this case these instructions are considered
18138 arithmetic and avoided where correct operation is required and the
18139 input operand might be a NaN.  A longer sequence of instructions that
18140 manipulate the sign bit of floating-point datum manually is used
18141 instead unless the @option{-ffinite-math-only} option has also been
18142 specified.
18144 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
18145 this case these instructions are considered non-arithmetic and therefore
18146 operating correctly in all cases, including in particular where the
18147 input operand is a NaN.  These instructions are therefore always used
18148 for the respective operations.
18150 @item -mnan=2008
18151 @itemx -mnan=legacy
18152 @opindex mnan=2008
18153 @opindex mnan=legacy
18154 These options control the encoding of the special not-a-number (NaN)
18155 IEEE 754 floating-point data.
18157 The @option{-mnan=legacy} option selects the legacy encoding.  In this
18158 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
18159 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
18160 by the first bit of their trailing significand field being 1.
18162 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
18163 this case qNaNs are denoted by the first bit of their trailing
18164 significand field being 1, whereas sNaNs are denoted by the first bit of
18165 their trailing significand field being 0.
18167 The default is @option{-mnan=legacy} unless GCC has been configured with
18168 @option{--with-nan=2008}.
18170 @item -mllsc
18171 @itemx -mno-llsc
18172 @opindex mllsc
18173 @opindex mno-llsc
18174 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
18175 implement atomic memory built-in functions.  When neither option is
18176 specified, GCC uses the instructions if the target architecture
18177 supports them.
18179 @option{-mllsc} is useful if the runtime environment can emulate the
18180 instructions and @option{-mno-llsc} can be useful when compiling for
18181 nonstandard ISAs.  You can make either option the default by
18182 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
18183 respectively.  @option{--with-llsc} is the default for some
18184 configurations; see the installation documentation for details.
18186 @item -mdsp
18187 @itemx -mno-dsp
18188 @opindex mdsp
18189 @opindex mno-dsp
18190 Use (do not use) revision 1 of the MIPS DSP ASE@.
18191 @xref{MIPS DSP Built-in Functions}.  This option defines the
18192 preprocessor macro @code{__mips_dsp}.  It also defines
18193 @code{__mips_dsp_rev} to 1.
18195 @item -mdspr2
18196 @itemx -mno-dspr2
18197 @opindex mdspr2
18198 @opindex mno-dspr2
18199 Use (do not use) revision 2 of the MIPS DSP ASE@.
18200 @xref{MIPS DSP Built-in Functions}.  This option defines the
18201 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
18202 It also defines @code{__mips_dsp_rev} to 2.
18204 @item -msmartmips
18205 @itemx -mno-smartmips
18206 @opindex msmartmips
18207 @opindex mno-smartmips
18208 Use (do not use) the MIPS SmartMIPS ASE.
18210 @item -mpaired-single
18211 @itemx -mno-paired-single
18212 @opindex mpaired-single
18213 @opindex mno-paired-single
18214 Use (do not use) paired-single floating-point instructions.
18215 @xref{MIPS Paired-Single Support}.  This option requires
18216 hardware floating-point support to be enabled.
18218 @item -mdmx
18219 @itemx -mno-mdmx
18220 @opindex mdmx
18221 @opindex mno-mdmx
18222 Use (do not use) MIPS Digital Media Extension instructions.
18223 This option can only be used when generating 64-bit code and requires
18224 hardware floating-point support to be enabled.
18226 @item -mips3d
18227 @itemx -mno-mips3d
18228 @opindex mips3d
18229 @opindex mno-mips3d
18230 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
18231 The option @option{-mips3d} implies @option{-mpaired-single}.
18233 @item -mmicromips
18234 @itemx -mno-micromips
18235 @opindex mmicromips
18236 @opindex mno-mmicromips
18237 Generate (do not generate) microMIPS code.
18239 MicroMIPS code generation can also be controlled on a per-function basis
18240 by means of @code{micromips} and @code{nomicromips} attributes.
18241 @xref{Function Attributes}, for more information.
18243 @item -mmt
18244 @itemx -mno-mt
18245 @opindex mmt
18246 @opindex mno-mt
18247 Use (do not use) MT Multithreading instructions.
18249 @item -mmcu
18250 @itemx -mno-mcu
18251 @opindex mmcu
18252 @opindex mno-mcu
18253 Use (do not use) the MIPS MCU ASE instructions.
18255 @item -meva
18256 @itemx -mno-eva
18257 @opindex meva
18258 @opindex mno-eva
18259 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
18261 @item -mvirt
18262 @itemx -mno-virt
18263 @opindex mvirt
18264 @opindex mno-virt
18265 Use (do not use) the MIPS Virtualization Application Specific instructions.
18267 @item -mxpa
18268 @itemx -mno-xpa
18269 @opindex mxpa
18270 @opindex mno-xpa
18271 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
18273 @item -mlong64
18274 @opindex mlong64
18275 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
18276 an explanation of the default and the way that the pointer size is
18277 determined.
18279 @item -mlong32
18280 @opindex mlong32
18281 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
18283 The default size of @code{int}s, @code{long}s and pointers depends on
18284 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
18285 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
18286 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
18287 or the same size as integer registers, whichever is smaller.
18289 @item -msym32
18290 @itemx -mno-sym32
18291 @opindex msym32
18292 @opindex mno-sym32
18293 Assume (do not assume) that all symbols have 32-bit values, regardless
18294 of the selected ABI@.  This option is useful in combination with
18295 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
18296 to generate shorter and faster references to symbolic addresses.
18298 @item -G @var{num}
18299 @opindex G
18300 Put definitions of externally-visible data in a small data section
18301 if that data is no bigger than @var{num} bytes.  GCC can then generate
18302 more efficient accesses to the data; see @option{-mgpopt} for details.
18304 The default @option{-G} option depends on the configuration.
18306 @item -mlocal-sdata
18307 @itemx -mno-local-sdata
18308 @opindex mlocal-sdata
18309 @opindex mno-local-sdata
18310 Extend (do not extend) the @option{-G} behavior to local data too,
18311 such as to static variables in C@.  @option{-mlocal-sdata} is the
18312 default for all configurations.
18314 If the linker complains that an application is using too much small data,
18315 you might want to try rebuilding the less performance-critical parts with
18316 @option{-mno-local-sdata}.  You might also want to build large
18317 libraries with @option{-mno-local-sdata}, so that the libraries leave
18318 more room for the main program.
18320 @item -mextern-sdata
18321 @itemx -mno-extern-sdata
18322 @opindex mextern-sdata
18323 @opindex mno-extern-sdata
18324 Assume (do not assume) that externally-defined data is in
18325 a small data section if the size of that data is within the @option{-G} limit.
18326 @option{-mextern-sdata} is the default for all configurations.
18328 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
18329 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
18330 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
18331 is placed in a small data section.  If @var{Var} is defined by another
18332 module, you must either compile that module with a high-enough
18333 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
18334 definition.  If @var{Var} is common, you must link the application
18335 with a high-enough @option{-G} setting.
18337 The easiest way of satisfying these restrictions is to compile
18338 and link every module with the same @option{-G} option.  However,
18339 you may wish to build a library that supports several different
18340 small data limits.  You can do this by compiling the library with
18341 the highest supported @option{-G} setting and additionally using
18342 @option{-mno-extern-sdata} to stop the library from making assumptions
18343 about externally-defined data.
18345 @item -mgpopt
18346 @itemx -mno-gpopt
18347 @opindex mgpopt
18348 @opindex mno-gpopt
18349 Use (do not use) GP-relative accesses for symbols that are known to be
18350 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
18351 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
18352 configurations.
18354 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
18355 might not hold the value of @code{_gp}.  For example, if the code is
18356 part of a library that might be used in a boot monitor, programs that
18357 call boot monitor routines pass an unknown value in @code{$gp}.
18358 (In such situations, the boot monitor itself is usually compiled
18359 with @option{-G0}.)
18361 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
18362 @option{-mno-extern-sdata}.
18364 @item -membedded-data
18365 @itemx -mno-embedded-data
18366 @opindex membedded-data
18367 @opindex mno-embedded-data
18368 Allocate variables to the read-only data section first if possible, then
18369 next in the small data section if possible, otherwise in data.  This gives
18370 slightly slower code than the default, but reduces the amount of RAM required
18371 when executing, and thus may be preferred for some embedded systems.
18373 @item -muninit-const-in-rodata
18374 @itemx -mno-uninit-const-in-rodata
18375 @opindex muninit-const-in-rodata
18376 @opindex mno-uninit-const-in-rodata
18377 Put uninitialized @code{const} variables in the read-only data section.
18378 This option is only meaningful in conjunction with @option{-membedded-data}.
18380 @item -mcode-readable=@var{setting}
18381 @opindex mcode-readable
18382 Specify whether GCC may generate code that reads from executable sections.
18383 There are three possible settings:
18385 @table @gcctabopt
18386 @item -mcode-readable=yes
18387 Instructions may freely access executable sections.  This is the
18388 default setting.
18390 @item -mcode-readable=pcrel
18391 MIPS16 PC-relative load instructions can access executable sections,
18392 but other instructions must not do so.  This option is useful on 4KSc
18393 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
18394 It is also useful on processors that can be configured to have a dual
18395 instruction/data SRAM interface and that, like the M4K, automatically
18396 redirect PC-relative loads to the instruction RAM.
18398 @item -mcode-readable=no
18399 Instructions must not access executable sections.  This option can be
18400 useful on targets that are configured to have a dual instruction/data
18401 SRAM interface but that (unlike the M4K) do not automatically redirect
18402 PC-relative loads to the instruction RAM.
18403 @end table
18405 @item -msplit-addresses
18406 @itemx -mno-split-addresses
18407 @opindex msplit-addresses
18408 @opindex mno-split-addresses
18409 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18410 relocation operators.  This option has been superseded by
18411 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18413 @item -mexplicit-relocs
18414 @itemx -mno-explicit-relocs
18415 @opindex mexplicit-relocs
18416 @opindex mno-explicit-relocs
18417 Use (do not use) assembler relocation operators when dealing with symbolic
18418 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18419 is to use assembler macros instead.
18421 @option{-mexplicit-relocs} is the default if GCC was configured
18422 to use an assembler that supports relocation operators.
18424 @item -mcheck-zero-division
18425 @itemx -mno-check-zero-division
18426 @opindex mcheck-zero-division
18427 @opindex mno-check-zero-division
18428 Trap (do not trap) on integer division by zero.
18430 The default is @option{-mcheck-zero-division}.
18432 @item -mdivide-traps
18433 @itemx -mdivide-breaks
18434 @opindex mdivide-traps
18435 @opindex mdivide-breaks
18436 MIPS systems check for division by zero by generating either a
18437 conditional trap or a break instruction.  Using traps results in
18438 smaller code, but is only supported on MIPS II and later.  Also, some
18439 versions of the Linux kernel have a bug that prevents trap from
18440 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18441 allow conditional traps on architectures that support them and
18442 @option{-mdivide-breaks} to force the use of breaks.
18444 The default is usually @option{-mdivide-traps}, but this can be
18445 overridden at configure time using @option{--with-divide=breaks}.
18446 Divide-by-zero checks can be completely disabled using
18447 @option{-mno-check-zero-division}.
18449 @item -mmemcpy
18450 @itemx -mno-memcpy
18451 @opindex mmemcpy
18452 @opindex mno-memcpy
18453 Force (do not force) the use of @code{memcpy} for non-trivial block
18454 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18455 most constant-sized copies.
18457 @item -mlong-calls
18458 @itemx -mno-long-calls
18459 @opindex mlong-calls
18460 @opindex mno-long-calls
18461 Disable (do not disable) use of the @code{jal} instruction.  Calling
18462 functions using @code{jal} is more efficient but requires the caller
18463 and callee to be in the same 256 megabyte segment.
18465 This option has no effect on abicalls code.  The default is
18466 @option{-mno-long-calls}.
18468 @item -mmad
18469 @itemx -mno-mad
18470 @opindex mmad
18471 @opindex mno-mad
18472 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18473 instructions, as provided by the R4650 ISA@.
18475 @item -mimadd
18476 @itemx -mno-imadd
18477 @opindex mimadd
18478 @opindex mno-imadd
18479 Enable (disable) use of the @code{madd} and @code{msub} integer
18480 instructions.  The default is @option{-mimadd} on architectures
18481 that support @code{madd} and @code{msub} except for the 74k 
18482 architecture where it was found to generate slower code.
18484 @item -mfused-madd
18485 @itemx -mno-fused-madd
18486 @opindex mfused-madd
18487 @opindex mno-fused-madd
18488 Enable (disable) use of the floating-point multiply-accumulate
18489 instructions, when they are available.  The default is
18490 @option{-mfused-madd}.
18492 On the R8000 CPU when multiply-accumulate instructions are used,
18493 the intermediate product is calculated to infinite precision
18494 and is not subject to the FCSR Flush to Zero bit.  This may be
18495 undesirable in some circumstances.  On other processors the result
18496 is numerically identical to the equivalent computation using
18497 separate multiply, add, subtract and negate instructions.
18499 @item -nocpp
18500 @opindex nocpp
18501 Tell the MIPS assembler to not run its preprocessor over user
18502 assembler files (with a @samp{.s} suffix) when assembling them.
18504 @item -mfix-24k
18505 @item -mno-fix-24k
18506 @opindex mfix-24k
18507 @opindex mno-fix-24k
18508 Work around the 24K E48 (lost data on stores during refill) errata.
18509 The workarounds are implemented by the assembler rather than by GCC@.
18511 @item -mfix-r4000
18512 @itemx -mno-fix-r4000
18513 @opindex mfix-r4000
18514 @opindex mno-fix-r4000
18515 Work around certain R4000 CPU errata:
18516 @itemize @minus
18517 @item
18518 A double-word or a variable shift may give an incorrect result if executed
18519 immediately after starting an integer division.
18520 @item
18521 A double-word or a variable shift may give an incorrect result if executed
18522 while an integer multiplication is in progress.
18523 @item
18524 An integer division may give an incorrect result if started in a delay slot
18525 of a taken branch or a jump.
18526 @end itemize
18528 @item -mfix-r4400
18529 @itemx -mno-fix-r4400
18530 @opindex mfix-r4400
18531 @opindex mno-fix-r4400
18532 Work around certain R4400 CPU errata:
18533 @itemize @minus
18534 @item
18535 A double-word or a variable shift may give an incorrect result if executed
18536 immediately after starting an integer division.
18537 @end itemize
18539 @item -mfix-r10000
18540 @itemx -mno-fix-r10000
18541 @opindex mfix-r10000
18542 @opindex mno-fix-r10000
18543 Work around certain R10000 errata:
18544 @itemize @minus
18545 @item
18546 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18547 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18548 @end itemize
18550 This option can only be used if the target architecture supports
18551 branch-likely instructions.  @option{-mfix-r10000} is the default when
18552 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18553 otherwise.
18555 @item -mfix-rm7000
18556 @itemx -mno-fix-rm7000
18557 @opindex mfix-rm7000
18558 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18559 workarounds are implemented by the assembler rather than by GCC@.
18561 @item -mfix-vr4120
18562 @itemx -mno-fix-vr4120
18563 @opindex mfix-vr4120
18564 Work around certain VR4120 errata:
18565 @itemize @minus
18566 @item
18567 @code{dmultu} does not always produce the correct result.
18568 @item
18569 @code{div} and @code{ddiv} do not always produce the correct result if one
18570 of the operands is negative.
18571 @end itemize
18572 The workarounds for the division errata rely on special functions in
18573 @file{libgcc.a}.  At present, these functions are only provided by
18574 the @code{mips64vr*-elf} configurations.
18576 Other VR4120 errata require a NOP to be inserted between certain pairs of
18577 instructions.  These errata are handled by the assembler, not by GCC itself.
18579 @item -mfix-vr4130
18580 @opindex mfix-vr4130
18581 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18582 workarounds are implemented by the assembler rather than by GCC,
18583 although GCC avoids using @code{mflo} and @code{mfhi} if the
18584 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18585 instructions are available instead.
18587 @item -mfix-sb1
18588 @itemx -mno-fix-sb1
18589 @opindex mfix-sb1
18590 Work around certain SB-1 CPU core errata.
18591 (This flag currently works around the SB-1 revision 2
18592 ``F1'' and ``F2'' floating-point errata.)
18594 @item -mr10k-cache-barrier=@var{setting}
18595 @opindex mr10k-cache-barrier
18596 Specify whether GCC should insert cache barriers to avoid the
18597 side-effects of speculation on R10K processors.
18599 In common with many processors, the R10K tries to predict the outcome
18600 of a conditional branch and speculatively executes instructions from
18601 the ``taken'' branch.  It later aborts these instructions if the
18602 predicted outcome is wrong.  However, on the R10K, even aborted
18603 instructions can have side effects.
18605 This problem only affects kernel stores and, depending on the system,
18606 kernel loads.  As an example, a speculatively-executed store may load
18607 the target memory into cache and mark the cache line as dirty, even if
18608 the store itself is later aborted.  If a DMA operation writes to the
18609 same area of memory before the ``dirty'' line is flushed, the cached
18610 data overwrites the DMA-ed data.  See the R10K processor manual
18611 for a full description, including other potential problems.
18613 One workaround is to insert cache barrier instructions before every memory
18614 access that might be speculatively executed and that might have side
18615 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18616 controls GCC's implementation of this workaround.  It assumes that
18617 aborted accesses to any byte in the following regions does not have
18618 side effects:
18620 @enumerate
18621 @item
18622 the memory occupied by the current function's stack frame;
18624 @item
18625 the memory occupied by an incoming stack argument;
18627 @item
18628 the memory occupied by an object with a link-time-constant address.
18629 @end enumerate
18631 It is the kernel's responsibility to ensure that speculative
18632 accesses to these regions are indeed safe.
18634 If the input program contains a function declaration such as:
18636 @smallexample
18637 void foo (void);
18638 @end smallexample
18640 then the implementation of @code{foo} must allow @code{j foo} and
18641 @code{jal foo} to be executed speculatively.  GCC honors this
18642 restriction for functions it compiles itself.  It expects non-GCC
18643 functions (such as hand-written assembly code) to do the same.
18645 The option has three forms:
18647 @table @gcctabopt
18648 @item -mr10k-cache-barrier=load-store
18649 Insert a cache barrier before a load or store that might be
18650 speculatively executed and that might have side effects even
18651 if aborted.
18653 @item -mr10k-cache-barrier=store
18654 Insert a cache barrier before a store that might be speculatively
18655 executed and that might have side effects even if aborted.
18657 @item -mr10k-cache-barrier=none
18658 Disable the insertion of cache barriers.  This is the default setting.
18659 @end table
18661 @item -mflush-func=@var{func}
18662 @itemx -mno-flush-func
18663 @opindex mflush-func
18664 Specifies the function to call to flush the I and D caches, or to not
18665 call any such function.  If called, the function must take the same
18666 arguments as the common @code{_flush_func}, that is, the address of the
18667 memory range for which the cache is being flushed, the size of the
18668 memory range, and the number 3 (to flush both caches).  The default
18669 depends on the target GCC was configured for, but commonly is either
18670 @code{_flush_func} or @code{__cpu_flush}.
18672 @item mbranch-cost=@var{num}
18673 @opindex mbranch-cost
18674 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18675 This cost is only a heuristic and is not guaranteed to produce
18676 consistent results across releases.  A zero cost redundantly selects
18677 the default, which is based on the @option{-mtune} setting.
18679 @item -mbranch-likely
18680 @itemx -mno-branch-likely
18681 @opindex mbranch-likely
18682 @opindex mno-branch-likely
18683 Enable or disable use of Branch Likely instructions, regardless of the
18684 default for the selected architecture.  By default, Branch Likely
18685 instructions may be generated if they are supported by the selected
18686 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18687 and processors that implement those architectures; for those, Branch
18688 Likely instructions are not be generated by default because the MIPS32
18689 and MIPS64 architectures specifically deprecate their use.
18691 @item -mcompact-branches=never
18692 @itemx -mcompact-branches=optimal
18693 @itemx -mcompact-branches=always
18694 @opindex mcompact-branches=never
18695 @opindex mcompact-branches=optimal
18696 @opindex mcompact-branches=always
18697 These options control which form of branches will be generated.  The
18698 default is @option{-mcompact-branches=optimal}.
18700 The @option{-mcompact-branches=never} option ensures that compact branch
18701 instructions will never be generated.
18703 The @option{-mcompact-branches=always} option ensures that a compact
18704 branch instruction will be generated if available.  If a compact branch
18705 instruction is not available, a delay slot form of the branch will be
18706 used instead.
18708 This option is supported from MIPS Release 6 onwards.
18710 The @option{-mcompact-branches=optimal} option will cause a delay slot
18711 branch to be used if one is available in the current ISA and the delay
18712 slot is successfully filled.  If the delay slot is not filled, a compact
18713 branch will be chosen if one is available.
18715 @item -mfp-exceptions
18716 @itemx -mno-fp-exceptions
18717 @opindex mfp-exceptions
18718 Specifies whether FP exceptions are enabled.  This affects how
18719 FP instructions are scheduled for some processors.
18720 The default is that FP exceptions are
18721 enabled.
18723 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18724 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18725 FP pipe.
18727 @item -mvr4130-align
18728 @itemx -mno-vr4130-align
18729 @opindex mvr4130-align
18730 The VR4130 pipeline is two-way superscalar, but can only issue two
18731 instructions together if the first one is 8-byte aligned.  When this
18732 option is enabled, GCC aligns pairs of instructions that it
18733 thinks should execute in parallel.
18735 This option only has an effect when optimizing for the VR4130.
18736 It normally makes code faster, but at the expense of making it bigger.
18737 It is enabled by default at optimization level @option{-O3}.
18739 @item -msynci
18740 @itemx -mno-synci
18741 @opindex msynci
18742 Enable (disable) generation of @code{synci} instructions on
18743 architectures that support it.  The @code{synci} instructions (if
18744 enabled) are generated when @code{__builtin___clear_cache} is
18745 compiled.
18747 This option defaults to @option{-mno-synci}, but the default can be
18748 overridden by configuring GCC with @option{--with-synci}.
18750 When compiling code for single processor systems, it is generally safe
18751 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18752 does not invalidate the instruction caches on all cores and may lead
18753 to undefined behavior.
18755 @item -mrelax-pic-calls
18756 @itemx -mno-relax-pic-calls
18757 @opindex mrelax-pic-calls
18758 Try to turn PIC calls that are normally dispatched via register
18759 @code{$25} into direct calls.  This is only possible if the linker can
18760 resolve the destination at link time and if the destination is within
18761 range for a direct call.
18763 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18764 an assembler and a linker that support the @code{.reloc} assembly
18765 directive and @option{-mexplicit-relocs} is in effect.  With
18766 @option{-mno-explicit-relocs}, this optimization can be performed by the
18767 assembler and the linker alone without help from the compiler.
18769 @item -mmcount-ra-address
18770 @itemx -mno-mcount-ra-address
18771 @opindex mmcount-ra-address
18772 @opindex mno-mcount-ra-address
18773 Emit (do not emit) code that allows @code{_mcount} to modify the
18774 calling function's return address.  When enabled, this option extends
18775 the usual @code{_mcount} interface with a new @var{ra-address}
18776 parameter, which has type @code{intptr_t *} and is passed in register
18777 @code{$12}.  @code{_mcount} can then modify the return address by
18778 doing both of the following:
18779 @itemize
18780 @item
18781 Returning the new address in register @code{$31}.
18782 @item
18783 Storing the new address in @code{*@var{ra-address}},
18784 if @var{ra-address} is nonnull.
18785 @end itemize
18787 The default is @option{-mno-mcount-ra-address}.
18789 @item -mframe-header-opt
18790 @itemx -mno-frame-header-opt
18791 @opindex mframe-header-opt
18792 Enable (disable) frame header optimization in the o32 ABI.  When using the
18793 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
18794 function to write out register arguments.  When enabled, this optimization
18795 will suppress the allocation of the frame header if it can be determined that
18796 it is unused.
18798 This optimization is off by default at all optimization levels.
18800 @end table
18802 @node MMIX Options
18803 @subsection MMIX Options
18804 @cindex MMIX Options
18806 These options are defined for the MMIX:
18808 @table @gcctabopt
18809 @item -mlibfuncs
18810 @itemx -mno-libfuncs
18811 @opindex mlibfuncs
18812 @opindex mno-libfuncs
18813 Specify that intrinsic library functions are being compiled, passing all
18814 values in registers, no matter the size.
18816 @item -mepsilon
18817 @itemx -mno-epsilon
18818 @opindex mepsilon
18819 @opindex mno-epsilon
18820 Generate floating-point comparison instructions that compare with respect
18821 to the @code{rE} epsilon register.
18823 @item -mabi=mmixware
18824 @itemx -mabi=gnu
18825 @opindex mabi=mmixware
18826 @opindex mabi=gnu
18827 Generate code that passes function parameters and return values that (in
18828 the called function) are seen as registers @code{$0} and up, as opposed to
18829 the GNU ABI which uses global registers @code{$231} and up.
18831 @item -mzero-extend
18832 @itemx -mno-zero-extend
18833 @opindex mzero-extend
18834 @opindex mno-zero-extend
18835 When reading data from memory in sizes shorter than 64 bits, use (do not
18836 use) zero-extending load instructions by default, rather than
18837 sign-extending ones.
18839 @item -mknuthdiv
18840 @itemx -mno-knuthdiv
18841 @opindex mknuthdiv
18842 @opindex mno-knuthdiv
18843 Make the result of a division yielding a remainder have the same sign as
18844 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18845 remainder follows the sign of the dividend.  Both methods are
18846 arithmetically valid, the latter being almost exclusively used.
18848 @item -mtoplevel-symbols
18849 @itemx -mno-toplevel-symbols
18850 @opindex mtoplevel-symbols
18851 @opindex mno-toplevel-symbols
18852 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18853 code can be used with the @code{PREFIX} assembly directive.
18855 @item -melf
18856 @opindex melf
18857 Generate an executable in the ELF format, rather than the default
18858 @samp{mmo} format used by the @command{mmix} simulator.
18860 @item -mbranch-predict
18861 @itemx -mno-branch-predict
18862 @opindex mbranch-predict
18863 @opindex mno-branch-predict
18864 Use (do not use) the probable-branch instructions, when static branch
18865 prediction indicates a probable branch.
18867 @item -mbase-addresses
18868 @itemx -mno-base-addresses
18869 @opindex mbase-addresses
18870 @opindex mno-base-addresses
18871 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18872 base address automatically generates a request (handled by the assembler
18873 and the linker) for a constant to be set up in a global register.  The
18874 register is used for one or more base address requests within the range 0
18875 to 255 from the value held in the register.  The generally leads to short
18876 and fast code, but the number of different data items that can be
18877 addressed is limited.  This means that a program that uses lots of static
18878 data may require @option{-mno-base-addresses}.
18880 @item -msingle-exit
18881 @itemx -mno-single-exit
18882 @opindex msingle-exit
18883 @opindex mno-single-exit
18884 Force (do not force) generated code to have a single exit point in each
18885 function.
18886 @end table
18888 @node MN10300 Options
18889 @subsection MN10300 Options
18890 @cindex MN10300 options
18892 These @option{-m} options are defined for Matsushita MN10300 architectures:
18894 @table @gcctabopt
18895 @item -mmult-bug
18896 @opindex mmult-bug
18897 Generate code to avoid bugs in the multiply instructions for the MN10300
18898 processors.  This is the default.
18900 @item -mno-mult-bug
18901 @opindex mno-mult-bug
18902 Do not generate code to avoid bugs in the multiply instructions for the
18903 MN10300 processors.
18905 @item -mam33
18906 @opindex mam33
18907 Generate code using features specific to the AM33 processor.
18909 @item -mno-am33
18910 @opindex mno-am33
18911 Do not generate code using features specific to the AM33 processor.  This
18912 is the default.
18914 @item -mam33-2
18915 @opindex mam33-2
18916 Generate code using features specific to the AM33/2.0 processor.
18918 @item -mam34
18919 @opindex mam34
18920 Generate code using features specific to the AM34 processor.
18922 @item -mtune=@var{cpu-type}
18923 @opindex mtune
18924 Use the timing characteristics of the indicated CPU type when
18925 scheduling instructions.  This does not change the targeted processor
18926 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18927 @samp{am33-2} or @samp{am34}.
18929 @item -mreturn-pointer-on-d0
18930 @opindex mreturn-pointer-on-d0
18931 When generating a function that returns a pointer, return the pointer
18932 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18933 only in @code{a0}, and attempts to call such functions without a prototype
18934 result in errors.  Note that this option is on by default; use
18935 @option{-mno-return-pointer-on-d0} to disable it.
18937 @item -mno-crt0
18938 @opindex mno-crt0
18939 Do not link in the C run-time initialization object file.
18941 @item -mrelax
18942 @opindex mrelax
18943 Indicate to the linker that it should perform a relaxation optimization pass
18944 to shorten branches, calls and absolute memory addresses.  This option only
18945 has an effect when used on the command line for the final link step.
18947 This option makes symbolic debugging impossible.
18949 @item -mliw
18950 @opindex mliw
18951 Allow the compiler to generate @emph{Long Instruction Word}
18952 instructions if the target is the @samp{AM33} or later.  This is the
18953 default.  This option defines the preprocessor macro @code{__LIW__}.
18955 @item -mnoliw
18956 @opindex mnoliw
18957 Do not allow the compiler to generate @emph{Long Instruction Word}
18958 instructions.  This option defines the preprocessor macro
18959 @code{__NO_LIW__}.
18961 @item -msetlb
18962 @opindex msetlb
18963 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18964 instructions if the target is the @samp{AM33} or later.  This is the
18965 default.  This option defines the preprocessor macro @code{__SETLB__}.
18967 @item -mnosetlb
18968 @opindex mnosetlb
18969 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18970 instructions.  This option defines the preprocessor macro
18971 @code{__NO_SETLB__}.
18973 @end table
18975 @node Moxie Options
18976 @subsection Moxie Options
18977 @cindex Moxie Options
18979 @table @gcctabopt
18981 @item -meb
18982 @opindex meb
18983 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18984 configurations.
18986 @item -mel
18987 @opindex mel
18988 Generate little-endian code.
18990 @item -mmul.x
18991 @opindex mmul.x
18992 Generate mul.x and umul.x instructions.  This is the default for
18993 @samp{moxiebox-*-*} configurations.
18995 @item -mno-crt0
18996 @opindex mno-crt0
18997 Do not link in the C run-time initialization object file.
18999 @end table
19001 @node MSP430 Options
19002 @subsection MSP430 Options
19003 @cindex MSP430 Options
19005 These options are defined for the MSP430:
19007 @table @gcctabopt
19009 @item -masm-hex
19010 @opindex masm-hex
19011 Force assembly output to always use hex constants.  Normally such
19012 constants are signed decimals, but this option is available for
19013 testsuite and/or aesthetic purposes.
19015 @item -mmcu=
19016 @opindex mmcu=
19017 Select the MCU to target.  This is used to create a C preprocessor
19018 symbol based upon the MCU name, converted to upper case and pre- and
19019 post-fixed with @samp{__}.  This in turn is used by the
19020 @file{msp430.h} header file to select an MCU-specific supplementary
19021 header file.
19023 The option also sets the ISA to use.  If the MCU name is one that is
19024 known to only support the 430 ISA then that is selected, otherwise the
19025 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
19026 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
19027 name selects the 430X ISA.
19029 In addition an MCU-specific linker script is added to the linker
19030 command line.  The script's name is the name of the MCU with
19031 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
19032 command line defines the C preprocessor symbol @code{__XXX__} and
19033 cause the linker to search for a script called @file{xxx.ld}.
19035 This option is also passed on to the assembler.
19037 @item -mwarn-mcu
19038 @itemx -mno-warn-mcu
19039 @opindex mwarn-mcu
19040 @opindex mno-warn-mcu
19041 This option enables or disables warnings about conflicts between the
19042 MCU name specified by the @option{-mmcu} option and the ISA set by the
19043 @option{-mcpu} option and/or the hardware multiply support set by the
19044 @option{-mhwmult} option.  It also toggles warnings about unrecognized
19045 MCU names.  This option is on by default.
19047 @item -mcpu=
19048 @opindex mcpu=
19049 Specifies the ISA to use.  Accepted values are @samp{msp430},
19050 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
19051 @option{-mmcu=} option should be used to select the ISA.
19053 @item -msim
19054 @opindex msim
19055 Link to the simulator runtime libraries and linker script.  Overrides
19056 any scripts that would be selected by the @option{-mmcu=} option.
19058 @item -mlarge
19059 @opindex mlarge
19060 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
19062 @item -msmall
19063 @opindex msmall
19064 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
19066 @item -mrelax
19067 @opindex mrelax
19068 This option is passed to the assembler and linker, and allows the
19069 linker to perform certain optimizations that cannot be done until
19070 the final link.
19072 @item mhwmult=
19073 @opindex mhwmult=
19074 Describes the type of hardware multiply supported by the target.
19075 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
19076 for the original 16-bit-only multiply supported by early MCUs.
19077 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
19078 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
19079 A value of @samp{auto} can also be given.  This tells GCC to deduce
19080 the hardware multiply support based upon the MCU name provided by the
19081 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
19082 the MCU name is not recognized then no hardware multiply support is
19083 assumed.  @code{auto} is the default setting.
19085 Hardware multiplies are normally performed by calling a library
19086 routine.  This saves space in the generated code.  When compiling at
19087 @option{-O3} or higher however the hardware multiplier is invoked
19088 inline.  This makes for bigger, but faster code.
19090 The hardware multiply routines disable interrupts whilst running and
19091 restore the previous interrupt state when they finish.  This makes
19092 them safe to use inside interrupt handlers as well as in normal code.
19094 @item -minrt
19095 @opindex minrt
19096 Enable the use of a minimum runtime environment - no static
19097 initializers or constructors.  This is intended for memory-constrained
19098 devices.  The compiler includes special symbols in some objects
19099 that tell the linker and runtime which code fragments are required.
19101 @item -mcode-region=
19102 @itemx -mdata-region=
19103 @opindex mcode-region
19104 @opindex mdata-region
19105 These options tell the compiler where to place functions and data that
19106 do not have one of the @code{lower}, @code{upper}, @code{either} or
19107 @code{section} attributes.  Possible values are @code{lower},
19108 @code{upper}, @code{either} or @code{any}.  The first three behave
19109 like the corresponding attribute.  The fourth possible value -
19110 @code{any} - is the default.  It leaves placement entirely up to the
19111 linker script and how it assigns the standard sections
19112 (@code{.text}, @code{.data}, etc) to the memory regions.
19114 @item -msilicon-errata=
19115 @opindex msilicon-errata
19116 This option passes on a request to assembler to enable the fixes for
19117 the named silicon errata.
19119 @item -msilicon-errata-warn=
19120 @opindex msilicon-errata-warn
19121 This option passes on a request to the assembler to enable warning
19122 messages when a silicon errata might need to be applied.
19124 @end table
19126 @node NDS32 Options
19127 @subsection NDS32 Options
19128 @cindex NDS32 Options
19130 These options are defined for NDS32 implementations:
19132 @table @gcctabopt
19134 @item -mbig-endian
19135 @opindex mbig-endian
19136 Generate code in big-endian mode.
19138 @item -mlittle-endian
19139 @opindex mlittle-endian
19140 Generate code in little-endian mode.
19142 @item -mreduced-regs
19143 @opindex mreduced-regs
19144 Use reduced-set registers for register allocation.
19146 @item -mfull-regs
19147 @opindex mfull-regs
19148 Use full-set registers for register allocation.
19150 @item -mcmov
19151 @opindex mcmov
19152 Generate conditional move instructions.
19154 @item -mno-cmov
19155 @opindex mno-cmov
19156 Do not generate conditional move instructions.
19158 @item -mperf-ext
19159 @opindex mperf-ext
19160 Generate performance extension instructions.
19162 @item -mno-perf-ext
19163 @opindex mno-perf-ext
19164 Do not generate performance extension instructions.
19166 @item -mv3push
19167 @opindex mv3push
19168 Generate v3 push25/pop25 instructions.
19170 @item -mno-v3push
19171 @opindex mno-v3push
19172 Do not generate v3 push25/pop25 instructions.
19174 @item -m16-bit
19175 @opindex m16-bit
19176 Generate 16-bit instructions.
19178 @item -mno-16-bit
19179 @opindex mno-16-bit
19180 Do not generate 16-bit instructions.
19182 @item -misr-vector-size=@var{num}
19183 @opindex misr-vector-size
19184 Specify the size of each interrupt vector, which must be 4 or 16.
19186 @item -mcache-block-size=@var{num}
19187 @opindex mcache-block-size
19188 Specify the size of each cache block,
19189 which must be a power of 2 between 4 and 512.
19191 @item -march=@var{arch}
19192 @opindex march
19193 Specify the name of the target architecture.
19195 @item -mcmodel=@var{code-model}
19196 @opindex mcmodel
19197 Set the code model to one of
19198 @table @asis
19199 @item @samp{small}
19200 All the data and read-only data segments must be within 512KB addressing space.
19201 The text segment must be within 16MB addressing space.
19202 @item @samp{medium}
19203 The data segment must be within 512KB while the read-only data segment can be
19204 within 4GB addressing space.  The text segment should be still within 16MB
19205 addressing space.
19206 @item @samp{large}
19207 All the text and data segments can be within 4GB addressing space.
19208 @end table
19210 @item -mctor-dtor
19211 @opindex mctor-dtor
19212 Enable constructor/destructor feature.
19214 @item -mrelax
19215 @opindex mrelax
19216 Guide linker to relax instructions.
19218 @end table
19220 @node Nios II Options
19221 @subsection Nios II Options
19222 @cindex Nios II options
19223 @cindex Altera Nios II options
19225 These are the options defined for the Altera Nios II processor.
19227 @table @gcctabopt
19229 @item -G @var{num}
19230 @opindex G
19231 @cindex smaller data references
19232 Put global and static objects less than or equal to @var{num} bytes
19233 into the small data or BSS sections instead of the normal data or BSS
19234 sections.  The default value of @var{num} is 8.
19236 @item -mgpopt=@var{option}
19237 @item -mgpopt
19238 @itemx -mno-gpopt
19239 @opindex mgpopt
19240 @opindex mno-gpopt
19241 Generate (do not generate) GP-relative accesses.  The following 
19242 @var{option} names are recognized:
19244 @table @samp
19246 @item none
19247 Do not generate GP-relative accesses.
19249 @item local
19250 Generate GP-relative accesses for small data objects that are not 
19251 external, weak, or uninitialized common symbols.  
19252 Also use GP-relative addressing for objects that
19253 have been explicitly placed in a small data section via a @code{section}
19254 attribute.
19256 @item global
19257 As for @samp{local}, but also generate GP-relative accesses for
19258 small data objects that are external, weak, or common.  If you use this option,
19259 you must ensure that all parts of your program (including libraries) are
19260 compiled with the same @option{-G} setting.
19262 @item data
19263 Generate GP-relative accesses for all data objects in the program.  If you
19264 use this option, the entire data and BSS segments
19265 of your program must fit in 64K of memory and you must use an appropriate
19266 linker script to allocate them within the addressable range of the
19267 global pointer.
19269 @item all
19270 Generate GP-relative addresses for function pointers as well as data
19271 pointers.  If you use this option, the entire text, data, and BSS segments
19272 of your program must fit in 64K of memory and you must use an appropriate
19273 linker script to allocate them within the addressable range of the
19274 global pointer.
19276 @end table
19278 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
19279 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
19281 The default is @option{-mgpopt} except when @option{-fpic} or
19282 @option{-fPIC} is specified to generate position-independent code.
19283 Note that the Nios II ABI does not permit GP-relative accesses from
19284 shared libraries.
19286 You may need to specify @option{-mno-gpopt} explicitly when building
19287 programs that include large amounts of small data, including large
19288 GOT data sections.  In this case, the 16-bit offset for GP-relative
19289 addressing may not be large enough to allow access to the entire 
19290 small data section.
19292 @item -mel
19293 @itemx -meb
19294 @opindex mel
19295 @opindex meb
19296 Generate little-endian (default) or big-endian (experimental) code,
19297 respectively.
19299 @item -march=@var{arch}
19300 @opindex march
19301 This specifies the name of the target Nios II architecture.  GCC uses this
19302 name to determine what kind of instructions it can emit when generating
19303 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
19305 The preprocessor macro @code{__nios2_arch__} is available to programs,
19306 with value 1 or 2, indicating the targeted ISA level.
19308 @item -mbypass-cache
19309 @itemx -mno-bypass-cache
19310 @opindex mno-bypass-cache
19311 @opindex mbypass-cache
19312 Force all load and store instructions to always bypass cache by 
19313 using I/O variants of the instructions. The default is not to
19314 bypass the cache.
19316 @item -mno-cache-volatile 
19317 @itemx -mcache-volatile       
19318 @opindex mcache-volatile 
19319 @opindex mno-cache-volatile
19320 Volatile memory access bypass the cache using the I/O variants of 
19321 the load and store instructions. The default is not to bypass the cache.
19323 @item -mno-fast-sw-div
19324 @itemx -mfast-sw-div
19325 @opindex mno-fast-sw-div
19326 @opindex mfast-sw-div
19327 Do not use table-based fast divide for small numbers. The default 
19328 is to use the fast divide at @option{-O3} and above.
19330 @item -mno-hw-mul
19331 @itemx -mhw-mul
19332 @itemx -mno-hw-mulx
19333 @itemx -mhw-mulx
19334 @itemx -mno-hw-div
19335 @itemx -mhw-div
19336 @opindex mno-hw-mul
19337 @opindex mhw-mul
19338 @opindex mno-hw-mulx
19339 @opindex mhw-mulx
19340 @opindex mno-hw-div
19341 @opindex mhw-div
19342 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
19343 instructions by the compiler. The default is to emit @code{mul}
19344 and not emit @code{div} and @code{mulx}.
19346 @item -mbmx
19347 @itemx -mno-bmx
19348 @itemx -mcdx
19349 @itemx -mno-cdx
19350 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
19351 CDX (code density) instructions.  Enabling these instructions also
19352 requires @option{-march=r2}.  Since these instructions are optional
19353 extensions to the R2 architecture, the default is not to emit them.
19355 @item -mcustom-@var{insn}=@var{N}
19356 @itemx -mno-custom-@var{insn}
19357 @opindex mcustom-@var{insn}
19358 @opindex mno-custom-@var{insn}
19359 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
19360 custom instruction with encoding @var{N} when generating code that uses 
19361 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
19362 instruction 253 for single-precision floating-point add operations instead
19363 of the default behavior of using a library call.
19365 The following values of @var{insn} are supported.  Except as otherwise
19366 noted, floating-point operations are expected to be implemented with
19367 normal IEEE 754 semantics and correspond directly to the C operators or the
19368 equivalent GCC built-in functions (@pxref{Other Builtins}).
19370 Single-precision floating point:
19371 @table @asis
19373 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
19374 Binary arithmetic operations.
19376 @item @samp{fnegs}
19377 Unary negation.
19379 @item @samp{fabss}
19380 Unary absolute value.
19382 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
19383 Comparison operations.
19385 @item @samp{fmins}, @samp{fmaxs}
19386 Floating-point minimum and maximum.  These instructions are only
19387 generated if @option{-ffinite-math-only} is specified.
19389 @item @samp{fsqrts}
19390 Unary square root operation.
19392 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
19393 Floating-point trigonometric and exponential functions.  These instructions
19394 are only generated if @option{-funsafe-math-optimizations} is also specified.
19396 @end table
19398 Double-precision floating point:
19399 @table @asis
19401 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
19402 Binary arithmetic operations.
19404 @item @samp{fnegd}
19405 Unary negation.
19407 @item @samp{fabsd}
19408 Unary absolute value.
19410 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
19411 Comparison operations.
19413 @item @samp{fmind}, @samp{fmaxd}
19414 Double-precision minimum and maximum.  These instructions are only
19415 generated if @option{-ffinite-math-only} is specified.
19417 @item @samp{fsqrtd}
19418 Unary square root operation.
19420 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
19421 Double-precision trigonometric and exponential functions.  These instructions
19422 are only generated if @option{-funsafe-math-optimizations} is also specified.
19424 @end table
19426 Conversions:
19427 @table @asis
19428 @item @samp{fextsd}
19429 Conversion from single precision to double precision.
19431 @item @samp{ftruncds}
19432 Conversion from double precision to single precision.
19434 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
19435 Conversion from floating point to signed or unsigned integer types, with
19436 truncation towards zero.
19438 @item @samp{round}
19439 Conversion from single-precision floating point to signed integer,
19440 rounding to the nearest integer and ties away from zero.
19441 This corresponds to the @code{__builtin_lroundf} function when
19442 @option{-fno-math-errno} is used.
19444 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
19445 Conversion from signed or unsigned integer types to floating-point types.
19447 @end table
19449 In addition, all of the following transfer instructions for internal
19450 registers X and Y must be provided to use any of the double-precision
19451 floating-point instructions.  Custom instructions taking two
19452 double-precision source operands expect the first operand in the
19453 64-bit register X.  The other operand (or only operand of a unary
19454 operation) is given to the custom arithmetic instruction with the
19455 least significant half in source register @var{src1} and the most
19456 significant half in @var{src2}.  A custom instruction that returns a
19457 double-precision result returns the most significant 32 bits in the
19458 destination register and the other half in 32-bit register Y.  
19459 GCC automatically generates the necessary code sequences to write
19460 register X and/or read register Y when double-precision floating-point
19461 instructions are used.
19463 @table @asis
19465 @item @samp{fwrx}
19466 Write @var{src1} into the least significant half of X and @var{src2} into
19467 the most significant half of X.
19469 @item @samp{fwry}
19470 Write @var{src1} into Y.
19472 @item @samp{frdxhi}, @samp{frdxlo}
19473 Read the most or least (respectively) significant half of X and store it in
19474 @var{dest}.
19476 @item @samp{frdy}
19477 Read the value of Y and store it into @var{dest}.
19478 @end table
19480 Note that you can gain more local control over generation of Nios II custom
19481 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
19482 and @code{target("no-custom-@var{insn}")} function attributes
19483 (@pxref{Function Attributes})
19484 or pragmas (@pxref{Function Specific Option Pragmas}).
19486 @item -mcustom-fpu-cfg=@var{name}
19487 @opindex mcustom-fpu-cfg
19489 This option enables a predefined, named set of custom instruction encodings
19490 (see @option{-mcustom-@var{insn}} above).  
19491 Currently, the following sets are defined:
19493 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
19494 @gccoptlist{-mcustom-fmuls=252 @gol
19495 -mcustom-fadds=253 @gol
19496 -mcustom-fsubs=254 @gol
19497 -fsingle-precision-constant}
19499 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
19500 @gccoptlist{-mcustom-fmuls=252 @gol
19501 -mcustom-fadds=253 @gol
19502 -mcustom-fsubs=254 @gol
19503 -mcustom-fdivs=255 @gol
19504 -fsingle-precision-constant}
19506 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
19507 @gccoptlist{-mcustom-floatus=243 @gol
19508 -mcustom-fixsi=244 @gol
19509 -mcustom-floatis=245 @gol
19510 -mcustom-fcmpgts=246 @gol
19511 -mcustom-fcmples=249 @gol
19512 -mcustom-fcmpeqs=250 @gol
19513 -mcustom-fcmpnes=251 @gol
19514 -mcustom-fmuls=252 @gol
19515 -mcustom-fadds=253 @gol
19516 -mcustom-fsubs=254 @gol
19517 -mcustom-fdivs=255 @gol
19518 -fsingle-precision-constant}
19520 Custom instruction assignments given by individual
19521 @option{-mcustom-@var{insn}=} options override those given by
19522 @option{-mcustom-fpu-cfg=}, regardless of the
19523 order of the options on the command line.
19525 Note that you can gain more local control over selection of a FPU
19526 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19527 function attribute (@pxref{Function Attributes})
19528 or pragma (@pxref{Function Specific Option Pragmas}).
19530 @end table
19532 These additional @samp{-m} options are available for the Altera Nios II
19533 ELF (bare-metal) target:
19535 @table @gcctabopt
19537 @item -mhal
19538 @opindex mhal
19539 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19540 startup and termination code, and is typically used in conjunction with
19541 @option{-msys-crt0=} to specify the location of the alternate startup code
19542 provided by the HAL BSP.
19544 @item -msmallc
19545 @opindex msmallc
19546 Link with a limited version of the C library, @option{-lsmallc}, rather than
19547 Newlib.
19549 @item -msys-crt0=@var{startfile}
19550 @opindex msys-crt0
19551 @var{startfile} is the file name of the startfile (crt0) to use 
19552 when linking.  This option is only useful in conjunction with @option{-mhal}.
19554 @item -msys-lib=@var{systemlib}
19555 @opindex msys-lib
19556 @var{systemlib} is the library name of the library that provides
19557 low-level system calls required by the C library,
19558 e.g. @code{read} and @code{write}.
19559 This option is typically used to link with a library provided by a HAL BSP.
19561 @end table
19563 @node Nvidia PTX Options
19564 @subsection Nvidia PTX Options
19565 @cindex Nvidia PTX options
19566 @cindex nvptx options
19568 These options are defined for Nvidia PTX:
19570 @table @gcctabopt
19572 @item -m32
19573 @itemx -m64
19574 @opindex m32
19575 @opindex m64
19576 Generate code for 32-bit or 64-bit ABI.
19578 @item -mmainkernel
19579 @opindex mmainkernel
19580 Link in code for a __main kernel.  This is for stand-alone instead of
19581 offloading execution.
19583 @item -moptimize
19584 @opindex moptimize
19585 Apply partitioned execution optimizations.  This is the default when any
19586 level of optimization is selected.
19588 @end table
19590 @node PDP-11 Options
19591 @subsection PDP-11 Options
19592 @cindex PDP-11 Options
19594 These options are defined for the PDP-11:
19596 @table @gcctabopt
19597 @item -mfpu
19598 @opindex mfpu
19599 Use hardware FPP floating point.  This is the default.  (FIS floating
19600 point on the PDP-11/40 is not supported.)
19602 @item -msoft-float
19603 @opindex msoft-float
19604 Do not use hardware floating point.
19606 @item -mac0
19607 @opindex mac0
19608 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19610 @item -mno-ac0
19611 @opindex mno-ac0
19612 Return floating-point results in memory.  This is the default.
19614 @item -m40
19615 @opindex m40
19616 Generate code for a PDP-11/40.
19618 @item -m45
19619 @opindex m45
19620 Generate code for a PDP-11/45.  This is the default.
19622 @item -m10
19623 @opindex m10
19624 Generate code for a PDP-11/10.
19626 @item -mbcopy-builtin
19627 @opindex mbcopy-builtin
19628 Use inline @code{movmemhi} patterns for copying memory.  This is the
19629 default.
19631 @item -mbcopy
19632 @opindex mbcopy
19633 Do not use inline @code{movmemhi} patterns for copying memory.
19635 @item -mint16
19636 @itemx -mno-int32
19637 @opindex mint16
19638 @opindex mno-int32
19639 Use 16-bit @code{int}.  This is the default.
19641 @item -mint32
19642 @itemx -mno-int16
19643 @opindex mint32
19644 @opindex mno-int16
19645 Use 32-bit @code{int}.
19647 @item -mfloat64
19648 @itemx -mno-float32
19649 @opindex mfloat64
19650 @opindex mno-float32
19651 Use 64-bit @code{float}.  This is the default.
19653 @item -mfloat32
19654 @itemx -mno-float64
19655 @opindex mfloat32
19656 @opindex mno-float64
19657 Use 32-bit @code{float}.
19659 @item -mabshi
19660 @opindex mabshi
19661 Use @code{abshi2} pattern.  This is the default.
19663 @item -mno-abshi
19664 @opindex mno-abshi
19665 Do not use @code{abshi2} pattern.
19667 @item -mbranch-expensive
19668 @opindex mbranch-expensive
19669 Pretend that branches are expensive.  This is for experimenting with
19670 code generation only.
19672 @item -mbranch-cheap
19673 @opindex mbranch-cheap
19674 Do not pretend that branches are expensive.  This is the default.
19676 @item -munix-asm
19677 @opindex munix-asm
19678 Use Unix assembler syntax.  This is the default when configured for
19679 @samp{pdp11-*-bsd}.
19681 @item -mdec-asm
19682 @opindex mdec-asm
19683 Use DEC assembler syntax.  This is the default when configured for any
19684 PDP-11 target other than @samp{pdp11-*-bsd}.
19685 @end table
19687 @node picoChip Options
19688 @subsection picoChip Options
19689 @cindex picoChip options
19691 These @samp{-m} options are defined for picoChip implementations:
19693 @table @gcctabopt
19695 @item -mae=@var{ae_type}
19696 @opindex mcpu
19697 Set the instruction set, register set, and instruction scheduling
19698 parameters for array element type @var{ae_type}.  Supported values
19699 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19701 @option{-mae=ANY} selects a completely generic AE type.  Code
19702 generated with this option runs on any of the other AE types.  The
19703 code is not as efficient as it would be if compiled for a specific
19704 AE type, and some types of operation (e.g., multiplication) do not
19705 work properly on all types of AE.
19707 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19708 for compiled code, and is the default.
19710 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19711 option may suffer from poor performance of byte (char) manipulation,
19712 since the DSP AE does not provide hardware support for byte load/stores.
19714 @item -msymbol-as-address
19715 Enable the compiler to directly use a symbol name as an address in a
19716 load/store instruction, without first loading it into a
19717 register.  Typically, the use of this option generates larger
19718 programs, which run faster than when the option isn't used.  However, the
19719 results vary from program to program, so it is left as a user option,
19720 rather than being permanently enabled.
19722 @item -mno-inefficient-warnings
19723 Disables warnings about the generation of inefficient code.  These
19724 warnings can be generated, for example, when compiling code that
19725 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19726 no hardware support for byte-level memory operations, so all byte
19727 load/stores must be synthesized from word load/store operations.  This is
19728 inefficient and a warning is generated to indicate
19729 that you should rewrite the code to avoid byte operations, or to target
19730 an AE type that has the necessary hardware support.  This option disables
19731 these warnings.
19733 @end table
19735 @node PowerPC Options
19736 @subsection PowerPC Options
19737 @cindex PowerPC options
19739 These are listed under @xref{RS/6000 and PowerPC Options}.
19741 @node RL78 Options
19742 @subsection RL78 Options
19743 @cindex RL78 Options
19745 @table @gcctabopt
19747 @item -msim
19748 @opindex msim
19749 Links in additional target libraries to support operation within a
19750 simulator.
19752 @item -mmul=none
19753 @itemx -mmul=g10
19754 @itemx -mmul=g13
19755 @itemx -mmul=g14
19756 @itemx -mmul=rl78
19757 @opindex mmul
19758 Specifies the type of hardware multiplication and division support to
19759 be used.  The simplest is @code{none}, which uses software for both
19760 multiplication and division.  This is the default.  The @code{g13}
19761 value is for the hardware multiply/divide peripheral found on the
19762 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
19763 the multiplication and division instructions supported by the RL78/G14
19764 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
19765 the value @code{mg10} is an alias for @code{none}.
19767 In addition a C preprocessor macro is defined, based upon the setting
19768 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
19769 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
19771 @item -mcpu=g10
19772 @itemx -mcpu=g13
19773 @itemx -mcpu=g14
19774 @itemx -mcpu=rl78
19775 @opindex mcpu
19776 Specifies the RL78 core to target.  The default is the G14 core, also
19777 known as an S3 core or just RL78.  The G13 or S2 core does not have
19778 multiply or divide instructions, instead it uses a hardware peripheral
19779 for these operations.  The G10 or S1 core does not have register
19780 banks, so it uses a different calling convention.
19782 If this option is set it also selects the type of hardware multiply
19783 support to use, unless this is overridden by an explicit
19784 @option{-mmul=none} option on the command line.  Thus specifying
19785 @option{-mcpu=g13} enables the use of the G13 hardware multiply
19786 peripheral and specifying @option{-mcpu=g10} disables the use of
19787 hardware multiplications altogether.
19789 Note, although the RL78/G14 core is the default target, specifying
19790 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
19791 change the behavior of the toolchain since it also enables G14
19792 hardware multiply support.  If these options are not specified on the
19793 command line then software multiplication routines will be used even
19794 though the code targets the RL78 core.  This is for backwards
19795 compatibility with older toolchains which did not have hardware
19796 multiply and divide support.
19798 In addition a C preprocessor macro is defined, based upon the setting
19799 of this option.  Possible values are: @code{__RL78_G10__},
19800 @code{__RL78_G13__} or @code{__RL78_G14__}.
19802 @item -mg10
19803 @itemx -mg13
19804 @itemx -mg14
19805 @itemx -mrl78
19806 @opindex mg10
19807 @opindex mg13
19808 @opindex mg14
19809 @opindex mrl78
19810 These are aliases for the corresponding @option{-mcpu=} option.  They
19811 are provided for backwards compatibility.
19813 @item -mallregs
19814 @opindex mallregs
19815 Allow the compiler to use all of the available registers.  By default
19816 registers @code{r24..r31} are reserved for use in interrupt handlers.
19817 With this option enabled these registers can be used in ordinary
19818 functions as well.
19820 @item -m64bit-doubles
19821 @itemx -m32bit-doubles
19822 @opindex m64bit-doubles
19823 @opindex m32bit-doubles
19824 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19825 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19826 @option{-m32bit-doubles}.
19828 @item -msave-mduc-in-interrupts
19829 @item -mno-save-mduc-in-interrupts
19830 @opindex msave-mduc-in-interrupts
19831 @opindex mno-save-mduc-in-interrupts
19832 Specifies that interrupt handler functions should preserve the
19833 MDUC registers.  This is only necessary if normal code might use
19834 the MDUC registers, for example because it performs multiplication
19835 and division operations.  The default is to ignore the MDUC registers
19836 as this makes the interrupt handlers faster.  The target option -mg13
19837 needs to be passed for this to work as this feature is only available
19838 on the G13 target (S2 core).  The MDUC registers will only be saved
19839 if the interrupt handler performs a multiplication or division
19840 operation or it calls another function.
19842 @end table
19844 @node RS/6000 and PowerPC Options
19845 @subsection IBM RS/6000 and PowerPC Options
19846 @cindex RS/6000 and PowerPC Options
19847 @cindex IBM RS/6000 and PowerPC Options
19849 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19850 @table @gcctabopt
19851 @item -mpowerpc-gpopt
19852 @itemx -mno-powerpc-gpopt
19853 @itemx -mpowerpc-gfxopt
19854 @itemx -mno-powerpc-gfxopt
19855 @need 800
19856 @itemx -mpowerpc64
19857 @itemx -mno-powerpc64
19858 @itemx -mmfcrf
19859 @itemx -mno-mfcrf
19860 @itemx -mpopcntb
19861 @itemx -mno-popcntb
19862 @itemx -mpopcntd
19863 @itemx -mno-popcntd
19864 @itemx -mfprnd
19865 @itemx -mno-fprnd
19866 @need 800
19867 @itemx -mcmpb
19868 @itemx -mno-cmpb
19869 @itemx -mmfpgpr
19870 @itemx -mno-mfpgpr
19871 @itemx -mhard-dfp
19872 @itemx -mno-hard-dfp
19873 @opindex mpowerpc-gpopt
19874 @opindex mno-powerpc-gpopt
19875 @opindex mpowerpc-gfxopt
19876 @opindex mno-powerpc-gfxopt
19877 @opindex mpowerpc64
19878 @opindex mno-powerpc64
19879 @opindex mmfcrf
19880 @opindex mno-mfcrf
19881 @opindex mpopcntb
19882 @opindex mno-popcntb
19883 @opindex mpopcntd
19884 @opindex mno-popcntd
19885 @opindex mfprnd
19886 @opindex mno-fprnd
19887 @opindex mcmpb
19888 @opindex mno-cmpb
19889 @opindex mmfpgpr
19890 @opindex mno-mfpgpr
19891 @opindex mhard-dfp
19892 @opindex mno-hard-dfp
19893 You use these options to specify which instructions are available on the
19894 processor you are using.  The default value of these options is
19895 determined when configuring GCC@.  Specifying the
19896 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19897 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19898 rather than the options listed above.
19900 Specifying @option{-mpowerpc-gpopt} allows
19901 GCC to use the optional PowerPC architecture instructions in the
19902 General Purpose group, including floating-point square root.  Specifying
19903 @option{-mpowerpc-gfxopt} allows GCC to
19904 use the optional PowerPC architecture instructions in the Graphics
19905 group, including floating-point select.
19907 The @option{-mmfcrf} option allows GCC to generate the move from
19908 condition register field instruction implemented on the POWER4
19909 processor and other processors that support the PowerPC V2.01
19910 architecture.
19911 The @option{-mpopcntb} option allows GCC to generate the popcount and
19912 double-precision FP reciprocal estimate instruction implemented on the
19913 POWER5 processor and other processors that support the PowerPC V2.02
19914 architecture.
19915 The @option{-mpopcntd} option allows GCC to generate the popcount
19916 instruction implemented on the POWER7 processor and other processors
19917 that support the PowerPC V2.06 architecture.
19918 The @option{-mfprnd} option allows GCC to generate the FP round to
19919 integer instructions implemented on the POWER5+ processor and other
19920 processors that support the PowerPC V2.03 architecture.
19921 The @option{-mcmpb} option allows GCC to generate the compare bytes
19922 instruction implemented on the POWER6 processor and other processors
19923 that support the PowerPC V2.05 architecture.
19924 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19925 general-purpose register instructions implemented on the POWER6X
19926 processor and other processors that support the extended PowerPC V2.05
19927 architecture.
19928 The @option{-mhard-dfp} option allows GCC to generate the decimal
19929 floating-point instructions implemented on some POWER processors.
19931 The @option{-mpowerpc64} option allows GCC to generate the additional
19932 64-bit instructions that are found in the full PowerPC64 architecture
19933 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19934 @option{-mno-powerpc64}.
19936 @item -mcpu=@var{cpu_type}
19937 @opindex mcpu
19938 Set architecture type, register usage, and
19939 instruction scheduling parameters for machine type @var{cpu_type}.
19940 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19941 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19942 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19943 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19944 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19945 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19946 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19947 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19948 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19949 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
19950 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
19951 and @samp{rs64}.
19953 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
19954 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
19955 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
19956 architecture machine types, with an appropriate, generic processor
19957 model assumed for scheduling purposes.
19959 The other options specify a specific processor.  Code generated under
19960 those options runs best on that processor, and may not run at all on
19961 others.
19963 The @option{-mcpu} options automatically enable or disable the
19964 following options:
19966 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19967 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19968 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19969 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19970 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19971 -mquad-memory -mquad-memory-atomic -mmodulo -mfloat128 -mfloat128-hardware @gol
19972 -mpower9-fusion -mpower9-vector -mpower9-dform}
19974 The particular options set for any particular CPU varies between
19975 compiler versions, depending on what setting seems to produce optimal
19976 code for that CPU; it doesn't necessarily reflect the actual hardware's
19977 capabilities.  If you wish to set an individual option to a particular
19978 value, you may specify it after the @option{-mcpu} option, like
19979 @option{-mcpu=970 -mno-altivec}.
19981 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19982 not enabled or disabled by the @option{-mcpu} option at present because
19983 AIX does not have full support for these options.  You may still
19984 enable or disable them individually if you're sure it'll work in your
19985 environment.
19987 @item -mtune=@var{cpu_type}
19988 @opindex mtune
19989 Set the instruction scheduling parameters for machine type
19990 @var{cpu_type}, but do not set the architecture type or register usage,
19991 as @option{-mcpu=@var{cpu_type}} does.  The same
19992 values for @var{cpu_type} are used for @option{-mtune} as for
19993 @option{-mcpu}.  If both are specified, the code generated uses the
19994 architecture and registers set by @option{-mcpu}, but the
19995 scheduling parameters set by @option{-mtune}.
19997 @item -mcmodel=small
19998 @opindex mcmodel=small
19999 Generate PowerPC64 code for the small model: The TOC is limited to
20000 64k.
20002 @item -mcmodel=medium
20003 @opindex mcmodel=medium
20004 Generate PowerPC64 code for the medium model: The TOC and other static
20005 data may be up to a total of 4G in size.
20007 @item -mcmodel=large
20008 @opindex mcmodel=large
20009 Generate PowerPC64 code for the large model: The TOC may be up to 4G
20010 in size.  Other data and code is only limited by the 64-bit address
20011 space.
20013 @item -maltivec
20014 @itemx -mno-altivec
20015 @opindex maltivec
20016 @opindex mno-altivec
20017 Generate code that uses (does not use) AltiVec instructions, and also
20018 enable the use of built-in functions that allow more direct access to
20019 the AltiVec instruction set.  You may also need to set
20020 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
20021 enhancements.
20023 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
20024 @option{-maltivec=be}, the element order for AltiVec intrinsics such
20025 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
20026 match array element order corresponding to the endianness of the
20027 target.  That is, element zero identifies the leftmost element in a
20028 vector register when targeting a big-endian platform, and identifies
20029 the rightmost element in a vector register when targeting a
20030 little-endian platform.
20032 @item -maltivec=be
20033 @opindex maltivec=be
20034 Generate AltiVec instructions using big-endian element order,
20035 regardless of whether the target is big- or little-endian.  This is
20036 the default when targeting a big-endian platform.
20038 The element order is used to interpret element numbers in AltiVec
20039 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
20040 @code{vec_insert}.  By default, these match array element order
20041 corresponding to the endianness for the target.
20043 @item -maltivec=le
20044 @opindex maltivec=le
20045 Generate AltiVec instructions using little-endian element order,
20046 regardless of whether the target is big- or little-endian.  This is
20047 the default when targeting a little-endian platform.  This option is
20048 currently ignored when targeting a big-endian platform.
20050 The element order is used to interpret element numbers in AltiVec
20051 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
20052 @code{vec_insert}.  By default, these match array element order
20053 corresponding to the endianness for the target.
20055 @item -mvrsave
20056 @itemx -mno-vrsave
20057 @opindex mvrsave
20058 @opindex mno-vrsave
20059 Generate VRSAVE instructions when generating AltiVec code.
20061 @item -mgen-cell-microcode
20062 @opindex mgen-cell-microcode
20063 Generate Cell microcode instructions.
20065 @item -mwarn-cell-microcode
20066 @opindex mwarn-cell-microcode
20067 Warn when a Cell microcode instruction is emitted.  An example
20068 of a Cell microcode instruction is a variable shift.
20070 @item -msecure-plt
20071 @opindex msecure-plt
20072 Generate code that allows @command{ld} and @command{ld.so}
20073 to build executables and shared
20074 libraries with non-executable @code{.plt} and @code{.got} sections.
20075 This is a PowerPC
20076 32-bit SYSV ABI option.
20078 @item -mbss-plt
20079 @opindex mbss-plt
20080 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
20081 fills in, and
20082 requires @code{.plt} and @code{.got}
20083 sections that are both writable and executable.
20084 This is a PowerPC 32-bit SYSV ABI option.
20086 @item -misel
20087 @itemx -mno-isel
20088 @opindex misel
20089 @opindex mno-isel
20090 This switch enables or disables the generation of ISEL instructions.
20092 @item -misel=@var{yes/no}
20093 This switch has been deprecated.  Use @option{-misel} and
20094 @option{-mno-isel} instead.
20096 @item -mlra
20097 @opindex mlra
20098 Enable Local Register Allocation.  This is still experimental for PowerPC,
20099 so by default the compiler uses standard reload
20100 (i.e. @option{-mno-lra}).
20102 @item -mspe
20103 @itemx -mno-spe
20104 @opindex mspe
20105 @opindex mno-spe
20106 This switch enables or disables the generation of SPE simd
20107 instructions.
20109 @item -mpaired
20110 @itemx -mno-paired
20111 @opindex mpaired
20112 @opindex mno-paired
20113 This switch enables or disables the generation of PAIRED simd
20114 instructions.
20116 @item -mspe=@var{yes/no}
20117 This option has been deprecated.  Use @option{-mspe} and
20118 @option{-mno-spe} instead.
20120 @item -mvsx
20121 @itemx -mno-vsx
20122 @opindex mvsx
20123 @opindex mno-vsx
20124 Generate code that uses (does not use) vector/scalar (VSX)
20125 instructions, and also enable the use of built-in functions that allow
20126 more direct access to the VSX instruction set.
20128 @item -mcrypto
20129 @itemx -mno-crypto
20130 @opindex mcrypto
20131 @opindex mno-crypto
20132 Enable the use (disable) of the built-in functions that allow direct
20133 access to the cryptographic instructions that were added in version
20134 2.07 of the PowerPC ISA.
20136 @item -mdirect-move
20137 @itemx -mno-direct-move
20138 @opindex mdirect-move
20139 @opindex mno-direct-move
20140 Generate code that uses (does not use) the instructions to move data
20141 between the general purpose registers and the vector/scalar (VSX)
20142 registers that were added in version 2.07 of the PowerPC ISA.
20144 @item -mpower8-fusion
20145 @itemx -mno-power8-fusion
20146 @opindex mpower8-fusion
20147 @opindex mno-power8-fusion
20148 Generate code that keeps (does not keeps) some integer operations
20149 adjacent so that the instructions can be fused together on power8 and
20150 later processors.
20152 @item -mpower8-vector
20153 @itemx -mno-power8-vector
20154 @opindex mpower8-vector
20155 @opindex mno-power8-vector
20156 Generate code that uses (does not use) the vector and scalar
20157 instructions that were added in version 2.07 of the PowerPC ISA.  Also
20158 enable the use of built-in functions that allow more direct access to
20159 the vector instructions.
20161 @item -mquad-memory
20162 @itemx -mno-quad-memory
20163 @opindex mquad-memory
20164 @opindex mno-quad-memory
20165 Generate code that uses (does not use) the non-atomic quad word memory
20166 instructions.  The @option{-mquad-memory} option requires use of
20167 64-bit mode.
20169 @item -mquad-memory-atomic
20170 @itemx -mno-quad-memory-atomic
20171 @opindex mquad-memory-atomic
20172 @opindex mno-quad-memory-atomic
20173 Generate code that uses (does not use) the atomic quad word memory
20174 instructions.  The @option{-mquad-memory-atomic} option requires use of
20175 64-bit mode.
20177 @item -mupper-regs-df
20178 @itemx -mno-upper-regs-df
20179 @opindex mupper-regs-df
20180 @opindex mno-upper-regs-df
20181 Generate code that uses (does not use) the scalar double precision
20182 instructions that target all 64 registers in the vector/scalar
20183 floating point register set that were added in version 2.06 of the
20184 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
20185 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
20186 @option{-mvsx} options.
20188 @item -mupper-regs-sf
20189 @itemx -mno-upper-regs-sf
20190 @opindex mupper-regs-sf
20191 @opindex mno-upper-regs-sf
20192 Generate code that uses (does not use) the scalar single precision
20193 instructions that target all 64 registers in the vector/scalar
20194 floating point register set that were added in version 2.07 of the
20195 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
20196 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
20197 options.
20199 @item -mupper-regs
20200 @itemx -mno-upper-regs
20201 @opindex mupper-regs
20202 @opindex mno-upper-regs
20203 Generate code that uses (does not use) the scalar
20204 instructions that target all 64 registers in the vector/scalar
20205 floating point register set, depending on the model of the machine.
20207 If the @option{-mno-upper-regs} option is used, it turns off both
20208 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
20210 @item -mfloat128
20211 @itemx -mno-float128
20212 @opindex mfloat128
20213 @opindex mno-float128
20214 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
20215 and use either software emulation for IEEE 128-bit floating point or
20216 hardware instructions.
20218 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
20219 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
20220 option.  The @code{-mfloat128} option only works on PowerPC 64-bit
20221 Linux systems.
20223 @item -mfloat128-hardware
20224 @itemx -mno-float128-hardware
20225 @opindex mfloat128-hardware
20226 @opindex mno-float128-hardware
20227 Enable/disable using ISA 3.0 hardware instructions to support the
20228 @var{__float128} data type.
20230 @item -mmodulo
20231 @itemx -mno-modulo
20232 @opindex mmodulo
20233 @opindex mno-module
20234 Generate code that uses (does not use) the ISA 3.0 integer modulo
20235 instructions.  The @option{-mmodulo} option is enabled by default
20236 with the @option{-mcpu=power9} option.
20238 @item -mpower9-fusion
20239 @itemx -mno-power9-fusion
20240 @opindex mpower9-fusion
20241 @opindex mno-power9-fusion
20242 Generate code that keeps (does not keeps) some operations adjacent so
20243 that the instructions can be fused together on power9 and later
20244 processors.
20246 @item -mpower9-vector
20247 @itemx -mno-power9-vector
20248 @opindex mpower9-vector
20249 @opindex mno-power9-vector
20250 Generate code that uses (does not use) the vector and scalar
20251 instructions that were added in version 3.0 of the PowerPC ISA.  Also
20252 enable the use of built-in functions that allow more direct access to
20253 the vector instructions.
20255 @item -mpower9-dform
20256 @itemx -mno-power9-dform
20257 @opindex mpower9-dform
20258 @opindex mno-power9-dform
20259 Enable (disable) scalar d-form (register + offset) memory instructions
20260 to load/store traditional Altivec registers. If the @var{LRA} register
20261 allocator is enabled, also enable (disable) vector d-form memory
20262 instructions.
20264 @item -mfloat-gprs=@var{yes/single/double/no}
20265 @itemx -mfloat-gprs
20266 @opindex mfloat-gprs
20267 This switch enables or disables the generation of floating-point
20268 operations on the general-purpose registers for architectures that
20269 support it.
20271 The argument @samp{yes} or @samp{single} enables the use of
20272 single-precision floating-point operations.
20274 The argument @samp{double} enables the use of single and
20275 double-precision floating-point operations.
20277 The argument @samp{no} disables floating-point operations on the
20278 general-purpose registers.
20280 This option is currently only available on the MPC854x.
20282 @item -m32
20283 @itemx -m64
20284 @opindex m32
20285 @opindex m64
20286 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
20287 targets (including GNU/Linux).  The 32-bit environment sets int, long
20288 and pointer to 32 bits and generates code that runs on any PowerPC
20289 variant.  The 64-bit environment sets int to 32 bits and long and
20290 pointer to 64 bits, and generates code for PowerPC64, as for
20291 @option{-mpowerpc64}.
20293 @item -mfull-toc
20294 @itemx -mno-fp-in-toc
20295 @itemx -mno-sum-in-toc
20296 @itemx -mminimal-toc
20297 @opindex mfull-toc
20298 @opindex mno-fp-in-toc
20299 @opindex mno-sum-in-toc
20300 @opindex mminimal-toc
20301 Modify generation of the TOC (Table Of Contents), which is created for
20302 every executable file.  The @option{-mfull-toc} option is selected by
20303 default.  In that case, GCC allocates at least one TOC entry for
20304 each unique non-automatic variable reference in your program.  GCC
20305 also places floating-point constants in the TOC@.  However, only
20306 16,384 entries are available in the TOC@.
20308 If you receive a linker error message that saying you have overflowed
20309 the available TOC space, you can reduce the amount of TOC space used
20310 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
20311 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
20312 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
20313 generate code to calculate the sum of an address and a constant at
20314 run time instead of putting that sum into the TOC@.  You may specify one
20315 or both of these options.  Each causes GCC to produce very slightly
20316 slower and larger code at the expense of conserving TOC space.
20318 If you still run out of space in the TOC even when you specify both of
20319 these options, specify @option{-mminimal-toc} instead.  This option causes
20320 GCC to make only one TOC entry for every file.  When you specify this
20321 option, GCC produces code that is slower and larger but which
20322 uses extremely little TOC space.  You may wish to use this option
20323 only on files that contain less frequently-executed code.
20325 @item -maix64
20326 @itemx -maix32
20327 @opindex maix64
20328 @opindex maix32
20329 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
20330 @code{long} type, and the infrastructure needed to support them.
20331 Specifying @option{-maix64} implies @option{-mpowerpc64},
20332 while @option{-maix32} disables the 64-bit ABI and
20333 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
20335 @item -mxl-compat
20336 @itemx -mno-xl-compat
20337 @opindex mxl-compat
20338 @opindex mno-xl-compat
20339 Produce code that conforms more closely to IBM XL compiler semantics
20340 when using AIX-compatible ABI@.  Pass floating-point arguments to
20341 prototyped functions beyond the register save area (RSA) on the stack
20342 in addition to argument FPRs.  Do not assume that most significant
20343 double in 128-bit long double value is properly rounded when comparing
20344 values and converting to double.  Use XL symbol names for long double
20345 support routines.
20347 The AIX calling convention was extended but not initially documented to
20348 handle an obscure K&R C case of calling a function that takes the
20349 address of its arguments with fewer arguments than declared.  IBM XL
20350 compilers access floating-point arguments that do not fit in the
20351 RSA from the stack when a subroutine is compiled without
20352 optimization.  Because always storing floating-point arguments on the
20353 stack is inefficient and rarely needed, this option is not enabled by
20354 default and only is necessary when calling subroutines compiled by IBM
20355 XL compilers without optimization.
20357 @item -mpe
20358 @opindex mpe
20359 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
20360 application written to use message passing with special startup code to
20361 enable the application to run.  The system must have PE installed in the
20362 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
20363 must be overridden with the @option{-specs=} option to specify the
20364 appropriate directory location.  The Parallel Environment does not
20365 support threads, so the @option{-mpe} option and the @option{-pthread}
20366 option are incompatible.
20368 @item -malign-natural
20369 @itemx -malign-power
20370 @opindex malign-natural
20371 @opindex malign-power
20372 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
20373 @option{-malign-natural} overrides the ABI-defined alignment of larger
20374 types, such as floating-point doubles, on their natural size-based boundary.
20375 The option @option{-malign-power} instructs GCC to follow the ABI-specified
20376 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
20378 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
20379 is not supported.
20381 @item -msoft-float
20382 @itemx -mhard-float
20383 @opindex msoft-float
20384 @opindex mhard-float
20385 Generate code that does not use (uses) the floating-point register set.
20386 Software floating-point emulation is provided if you use the
20387 @option{-msoft-float} option, and pass the option to GCC when linking.
20389 @item -msingle-float
20390 @itemx -mdouble-float
20391 @opindex msingle-float
20392 @opindex mdouble-float
20393 Generate code for single- or double-precision floating-point operations.
20394 @option{-mdouble-float} implies @option{-msingle-float}.
20396 @item -msimple-fpu
20397 @opindex msimple-fpu
20398 Do not generate @code{sqrt} and @code{div} instructions for hardware
20399 floating-point unit.
20401 @item -mfpu=@var{name}
20402 @opindex mfpu
20403 Specify type of floating-point unit.  Valid values for @var{name} are
20404 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
20405 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
20406 @samp{sp_full} (equivalent to @option{-msingle-float}),
20407 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
20409 @item -mxilinx-fpu
20410 @opindex mxilinx-fpu
20411 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
20413 @item -mmultiple
20414 @itemx -mno-multiple
20415 @opindex mmultiple
20416 @opindex mno-multiple
20417 Generate code that uses (does not use) the load multiple word
20418 instructions and the store multiple word instructions.  These
20419 instructions are generated by default on POWER systems, and not
20420 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
20421 PowerPC systems, since those instructions do not work when the
20422 processor is in little-endian mode.  The exceptions are PPC740 and
20423 PPC750 which permit these instructions in little-endian mode.
20425 @item -mstring
20426 @itemx -mno-string
20427 @opindex mstring
20428 @opindex mno-string
20429 Generate code that uses (does not use) the load string instructions
20430 and the store string word instructions to save multiple registers and
20431 do small block moves.  These instructions are generated by default on
20432 POWER systems, and not generated on PowerPC systems.  Do not use
20433 @option{-mstring} on little-endian PowerPC systems, since those
20434 instructions do not work when the processor is in little-endian mode.
20435 The exceptions are PPC740 and PPC750 which permit these instructions
20436 in little-endian mode.
20438 @item -mupdate
20439 @itemx -mno-update
20440 @opindex mupdate
20441 @opindex mno-update
20442 Generate code that uses (does not use) the load or store instructions
20443 that update the base register to the address of the calculated memory
20444 location.  These instructions are generated by default.  If you use
20445 @option{-mno-update}, there is a small window between the time that the
20446 stack pointer is updated and the address of the previous frame is
20447 stored, which means code that walks the stack frame across interrupts or
20448 signals may get corrupted data.
20450 @item -mavoid-indexed-addresses
20451 @itemx -mno-avoid-indexed-addresses
20452 @opindex mavoid-indexed-addresses
20453 @opindex mno-avoid-indexed-addresses
20454 Generate code that tries to avoid (not avoid) the use of indexed load
20455 or store instructions. These instructions can incur a performance
20456 penalty on Power6 processors in certain situations, such as when
20457 stepping through large arrays that cross a 16M boundary.  This option
20458 is enabled by default when targeting Power6 and disabled otherwise.
20460 @item -mfused-madd
20461 @itemx -mno-fused-madd
20462 @opindex mfused-madd
20463 @opindex mno-fused-madd
20464 Generate code that uses (does not use) the floating-point multiply and
20465 accumulate instructions.  These instructions are generated by default
20466 if hardware floating point is used.  The machine-dependent
20467 @option{-mfused-madd} option is now mapped to the machine-independent
20468 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20469 mapped to @option{-ffp-contract=off}.
20471 @item -mmulhw
20472 @itemx -mno-mulhw
20473 @opindex mmulhw
20474 @opindex mno-mulhw
20475 Generate code that uses (does not use) the half-word multiply and
20476 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
20477 These instructions are generated by default when targeting those
20478 processors.
20480 @item -mdlmzb
20481 @itemx -mno-dlmzb
20482 @opindex mdlmzb
20483 @opindex mno-dlmzb
20484 Generate code that uses (does not use) the string-search @samp{dlmzb}
20485 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
20486 generated by default when targeting those processors.
20488 @item -mno-bit-align
20489 @itemx -mbit-align
20490 @opindex mno-bit-align
20491 @opindex mbit-align
20492 On System V.4 and embedded PowerPC systems do not (do) force structures
20493 and unions that contain bit-fields to be aligned to the base type of the
20494 bit-field.
20496 For example, by default a structure containing nothing but 8
20497 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
20498 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
20499 the structure is aligned to a 1-byte boundary and is 1 byte in
20500 size.
20502 @item -mno-strict-align
20503 @itemx -mstrict-align
20504 @opindex mno-strict-align
20505 @opindex mstrict-align
20506 On System V.4 and embedded PowerPC systems do not (do) assume that
20507 unaligned memory references are handled by the system.
20509 @item -mrelocatable
20510 @itemx -mno-relocatable
20511 @opindex mrelocatable
20512 @opindex mno-relocatable
20513 Generate code that allows (does not allow) a static executable to be
20514 relocated to a different address at run time.  A simple embedded
20515 PowerPC system loader should relocate the entire contents of
20516 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
20517 a table of 32-bit addresses generated by this option.  For this to
20518 work, all objects linked together must be compiled with
20519 @option{-mrelocatable} or @option{-mrelocatable-lib}.
20520 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
20522 @item -mrelocatable-lib
20523 @itemx -mno-relocatable-lib
20524 @opindex mrelocatable-lib
20525 @opindex mno-relocatable-lib
20526 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
20527 @code{.fixup} section to allow static executables to be relocated at
20528 run time, but @option{-mrelocatable-lib} does not use the smaller stack
20529 alignment of @option{-mrelocatable}.  Objects compiled with
20530 @option{-mrelocatable-lib} may be linked with objects compiled with
20531 any combination of the @option{-mrelocatable} options.
20533 @item -mno-toc
20534 @itemx -mtoc
20535 @opindex mno-toc
20536 @opindex mtoc
20537 On System V.4 and embedded PowerPC systems do not (do) assume that
20538 register 2 contains a pointer to a global area pointing to the addresses
20539 used in the program.
20541 @item -mlittle
20542 @itemx -mlittle-endian
20543 @opindex mlittle
20544 @opindex mlittle-endian
20545 On System V.4 and embedded PowerPC systems compile code for the
20546 processor in little-endian mode.  The @option{-mlittle-endian} option is
20547 the same as @option{-mlittle}.
20549 @item -mbig
20550 @itemx -mbig-endian
20551 @opindex mbig
20552 @opindex mbig-endian
20553 On System V.4 and embedded PowerPC systems compile code for the
20554 processor in big-endian mode.  The @option{-mbig-endian} option is
20555 the same as @option{-mbig}.
20557 @item -mdynamic-no-pic
20558 @opindex mdynamic-no-pic
20559 On Darwin and Mac OS X systems, compile code so that it is not
20560 relocatable, but that its external references are relocatable.  The
20561 resulting code is suitable for applications, but not shared
20562 libraries.
20564 @item -msingle-pic-base
20565 @opindex msingle-pic-base
20566 Treat the register used for PIC addressing as read-only, rather than
20567 loading it in the prologue for each function.  The runtime system is
20568 responsible for initializing this register with an appropriate value
20569 before execution begins.
20571 @item -mprioritize-restricted-insns=@var{priority}
20572 @opindex mprioritize-restricted-insns
20573 This option controls the priority that is assigned to
20574 dispatch-slot restricted instructions during the second scheduling
20575 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
20576 or @samp{2} to assign no, highest, or second-highest (respectively) 
20577 priority to dispatch-slot restricted
20578 instructions.
20580 @item -msched-costly-dep=@var{dependence_type}
20581 @opindex msched-costly-dep
20582 This option controls which dependences are considered costly
20583 by the target during instruction scheduling.  The argument
20584 @var{dependence_type} takes one of the following values:
20586 @table @asis
20587 @item @samp{no}
20588 No dependence is costly.
20590 @item @samp{all}
20591 All dependences are costly.
20593 @item @samp{true_store_to_load}
20594 A true dependence from store to load is costly.
20596 @item @samp{store_to_load}
20597 Any dependence from store to load is costly.
20599 @item @var{number}
20600 Any dependence for which the latency is greater than or equal to 
20601 @var{number} is costly.
20602 @end table
20604 @item -minsert-sched-nops=@var{scheme}
20605 @opindex minsert-sched-nops
20606 This option controls which NOP insertion scheme is used during
20607 the second scheduling pass.  The argument @var{scheme} takes one of the
20608 following values:
20610 @table @asis
20611 @item @samp{no}
20612 Don't insert NOPs.
20614 @item @samp{pad}
20615 Pad with NOPs any dispatch group that has vacant issue slots,
20616 according to the scheduler's grouping.
20618 @item @samp{regroup_exact}
20619 Insert NOPs to force costly dependent insns into
20620 separate groups.  Insert exactly as many NOPs as needed to force an insn
20621 to a new group, according to the estimated processor grouping.
20623 @item @var{number}
20624 Insert NOPs to force costly dependent insns into
20625 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
20626 @end table
20628 @item -mcall-sysv
20629 @opindex mcall-sysv
20630 On System V.4 and embedded PowerPC systems compile code using calling
20631 conventions that adhere to the March 1995 draft of the System V
20632 Application Binary Interface, PowerPC processor supplement.  This is the
20633 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
20635 @item -mcall-sysv-eabi
20636 @itemx -mcall-eabi
20637 @opindex mcall-sysv-eabi
20638 @opindex mcall-eabi
20639 Specify both @option{-mcall-sysv} and @option{-meabi} options.
20641 @item -mcall-sysv-noeabi
20642 @opindex mcall-sysv-noeabi
20643 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
20645 @item -mcall-aixdesc
20646 @opindex m
20647 On System V.4 and embedded PowerPC systems compile code for the AIX
20648 operating system.
20650 @item -mcall-linux
20651 @opindex mcall-linux
20652 On System V.4 and embedded PowerPC systems compile code for the
20653 Linux-based GNU system.
20655 @item -mcall-freebsd
20656 @opindex mcall-freebsd
20657 On System V.4 and embedded PowerPC systems compile code for the
20658 FreeBSD operating system.
20660 @item -mcall-netbsd
20661 @opindex mcall-netbsd
20662 On System V.4 and embedded PowerPC systems compile code for the
20663 NetBSD operating system.
20665 @item -mcall-openbsd
20666 @opindex mcall-netbsd
20667 On System V.4 and embedded PowerPC systems compile code for the
20668 OpenBSD operating system.
20670 @item -maix-struct-return
20671 @opindex maix-struct-return
20672 Return all structures in memory (as specified by the AIX ABI)@.
20674 @item -msvr4-struct-return
20675 @opindex msvr4-struct-return
20676 Return structures smaller than 8 bytes in registers (as specified by the
20677 SVR4 ABI)@.
20679 @item -mabi=@var{abi-type}
20680 @opindex mabi
20681 Extend the current ABI with a particular extension, or remove such extension.
20682 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
20683 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
20684 @samp{elfv1}, @samp{elfv2}@.
20686 @item -mabi=spe
20687 @opindex mabi=spe
20688 Extend the current ABI with SPE ABI extensions.  This does not change
20689 the default ABI, instead it adds the SPE ABI extensions to the current
20690 ABI@.
20692 @item -mabi=no-spe
20693 @opindex mabi=no-spe
20694 Disable Book-E SPE ABI extensions for the current ABI@.
20696 @item -mabi=ibmlongdouble
20697 @opindex mabi=ibmlongdouble
20698 Change the current ABI to use IBM extended-precision long double.
20699 This is a PowerPC 32-bit SYSV ABI option.
20701 @item -mabi=ieeelongdouble
20702 @opindex mabi=ieeelongdouble
20703 Change the current ABI to use IEEE extended-precision long double.
20704 This is a PowerPC 32-bit Linux ABI option.
20706 @item -mabi=elfv1
20707 @opindex mabi=elfv1
20708 Change the current ABI to use the ELFv1 ABI.
20709 This is the default ABI for big-endian PowerPC 64-bit Linux.
20710 Overriding the default ABI requires special system support and is
20711 likely to fail in spectacular ways.
20713 @item -mabi=elfv2
20714 @opindex mabi=elfv2
20715 Change the current ABI to use the ELFv2 ABI.
20716 This is the default ABI for little-endian PowerPC 64-bit Linux.
20717 Overriding the default ABI requires special system support and is
20718 likely to fail in spectacular ways.
20720 @item -mprototype
20721 @itemx -mno-prototype
20722 @opindex mprototype
20723 @opindex mno-prototype
20724 On System V.4 and embedded PowerPC systems assume that all calls to
20725 variable argument functions are properly prototyped.  Otherwise, the
20726 compiler must insert an instruction before every non-prototyped call to
20727 set or clear bit 6 of the condition code register (@code{CR}) to
20728 indicate whether floating-point values are passed in the floating-point
20729 registers in case the function takes variable arguments.  With
20730 @option{-mprototype}, only calls to prototyped variable argument functions
20731 set or clear the bit.
20733 @item -msim
20734 @opindex msim
20735 On embedded PowerPC systems, assume that the startup module is called
20736 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20737 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20738 configurations.
20740 @item -mmvme
20741 @opindex mmvme
20742 On embedded PowerPC systems, assume that the startup module is called
20743 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20744 @file{libc.a}.
20746 @item -mads
20747 @opindex mads
20748 On embedded PowerPC systems, assume that the startup module is called
20749 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20750 @file{libc.a}.
20752 @item -myellowknife
20753 @opindex myellowknife
20754 On embedded PowerPC systems, assume that the startup module is called
20755 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20756 @file{libc.a}.
20758 @item -mvxworks
20759 @opindex mvxworks
20760 On System V.4 and embedded PowerPC systems, specify that you are
20761 compiling for a VxWorks system.
20763 @item -memb
20764 @opindex memb
20765 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
20766 header to indicate that @samp{eabi} extended relocations are used.
20768 @item -meabi
20769 @itemx -mno-eabi
20770 @opindex meabi
20771 @opindex mno-eabi
20772 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20773 Embedded Applications Binary Interface (EABI), which is a set of
20774 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20775 means that the stack is aligned to an 8-byte boundary, a function
20776 @code{__eabi} is called from @code{main} to set up the EABI
20777 environment, and the @option{-msdata} option can use both @code{r2} and
20778 @code{r13} to point to two separate small data areas.  Selecting
20779 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20780 no EABI initialization function is called from @code{main}, and the
20781 @option{-msdata} option only uses @code{r13} to point to a single
20782 small data area.  The @option{-meabi} option is on by default if you
20783 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20785 @item -msdata=eabi
20786 @opindex msdata=eabi
20787 On System V.4 and embedded PowerPC systems, put small initialized
20788 @code{const} global and static data in the @code{.sdata2} section, which
20789 is pointed to by register @code{r2}.  Put small initialized
20790 non-@code{const} global and static data in the @code{.sdata} section,
20791 which is pointed to by register @code{r13}.  Put small uninitialized
20792 global and static data in the @code{.sbss} section, which is adjacent to
20793 the @code{.sdata} section.  The @option{-msdata=eabi} option is
20794 incompatible with the @option{-mrelocatable} option.  The
20795 @option{-msdata=eabi} option also sets the @option{-memb} option.
20797 @item -msdata=sysv
20798 @opindex msdata=sysv
20799 On System V.4 and embedded PowerPC systems, put small global and static
20800 data in the @code{.sdata} section, which is pointed to by register
20801 @code{r13}.  Put small uninitialized global and static data in the
20802 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
20803 The @option{-msdata=sysv} option is incompatible with the
20804 @option{-mrelocatable} option.
20806 @item -msdata=default
20807 @itemx -msdata
20808 @opindex msdata=default
20809 @opindex msdata
20810 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20811 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20812 same as @option{-msdata=sysv}.
20814 @item -msdata=data
20815 @opindex msdata=data
20816 On System V.4 and embedded PowerPC systems, put small global
20817 data in the @code{.sdata} section.  Put small uninitialized global
20818 data in the @code{.sbss} section.  Do not use register @code{r13}
20819 to address small data however.  This is the default behavior unless
20820 other @option{-msdata} options are used.
20822 @item -msdata=none
20823 @itemx -mno-sdata
20824 @opindex msdata=none
20825 @opindex mno-sdata
20826 On embedded PowerPC systems, put all initialized global and static data
20827 in the @code{.data} section, and all uninitialized data in the
20828 @code{.bss} section.
20830 @item -mblock-move-inline-limit=@var{num}
20831 @opindex mblock-move-inline-limit
20832 Inline all block moves (such as calls to @code{memcpy} or structure
20833 copies) less than or equal to @var{num} bytes.  The minimum value for
20834 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20835 targets.  The default value is target-specific.
20837 @item -G @var{num}
20838 @opindex G
20839 @cindex smaller data references (PowerPC)
20840 @cindex .sdata/.sdata2 references (PowerPC)
20841 On embedded PowerPC systems, put global and static items less than or
20842 equal to @var{num} bytes into the small data or BSS sections instead of
20843 the normal data or BSS section.  By default, @var{num} is 8.  The
20844 @option{-G @var{num}} switch is also passed to the linker.
20845 All modules should be compiled with the same @option{-G @var{num}} value.
20847 @item -mregnames
20848 @itemx -mno-regnames
20849 @opindex mregnames
20850 @opindex mno-regnames
20851 On System V.4 and embedded PowerPC systems do (do not) emit register
20852 names in the assembly language output using symbolic forms.
20854 @item -mlongcall
20855 @itemx -mno-longcall
20856 @opindex mlongcall
20857 @opindex mno-longcall
20858 By default assume that all calls are far away so that a longer and more
20859 expensive calling sequence is required.  This is required for calls
20860 farther than 32 megabytes (33,554,432 bytes) from the current location.
20861 A short call is generated if the compiler knows
20862 the call cannot be that far away.  This setting can be overridden by
20863 the @code{shortcall} function attribute, or by @code{#pragma
20864 longcall(0)}.
20866 Some linkers are capable of detecting out-of-range calls and generating
20867 glue code on the fly.  On these systems, long calls are unnecessary and
20868 generate slower code.  As of this writing, the AIX linker can do this,
20869 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20870 to the GNU linker for 32-bit PowerPC systems as well.
20872 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20873 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20874 addresses represent the callee and the branch island.  The
20875 Darwin/PPC linker prefers the first address and generates a @code{bl
20876 callee} if the PPC @code{bl} instruction reaches the callee directly;
20877 otherwise, the linker generates @code{bl L42} to call the branch
20878 island.  The branch island is appended to the body of the
20879 calling function; it computes the full 32-bit address of the callee
20880 and jumps to it.
20882 On Mach-O (Darwin) systems, this option directs the compiler emit to
20883 the glue for every direct call, and the Darwin linker decides whether
20884 to use or discard it.
20886 In the future, GCC may ignore all longcall specifications
20887 when the linker is known to generate glue.
20889 @item -mtls-markers
20890 @itemx -mno-tls-markers
20891 @opindex mtls-markers
20892 @opindex mno-tls-markers
20893 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20894 specifying the function argument.  The relocation allows the linker to
20895 reliably associate function call with argument setup instructions for
20896 TLS optimization, which in turn allows GCC to better schedule the
20897 sequence.
20899 @item -pthread
20900 @opindex pthread
20901 Adds support for multithreading with the @dfn{pthreads} library.
20902 This option sets flags for both the preprocessor and linker.
20904 @item -mrecip
20905 @itemx -mno-recip
20906 @opindex mrecip
20907 This option enables use of the reciprocal estimate and
20908 reciprocal square root estimate instructions with additional
20909 Newton-Raphson steps to increase precision instead of doing a divide or
20910 square root and divide for floating-point arguments.  You should use
20911 the @option{-ffast-math} option when using @option{-mrecip} (or at
20912 least @option{-funsafe-math-optimizations},
20913 @option{-ffinite-math-only}, @option{-freciprocal-math} and
20914 @option{-fno-trapping-math}).  Note that while the throughput of the
20915 sequence is generally higher than the throughput of the non-reciprocal
20916 instruction, the precision of the sequence can be decreased by up to 2
20917 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20918 roots.
20920 @item -mrecip=@var{opt}
20921 @opindex mrecip=opt
20922 This option controls which reciprocal estimate instructions
20923 may be used.  @var{opt} is a comma-separated list of options, which may
20924 be preceded by a @code{!} to invert the option:
20926 @table @samp
20928 @item all
20929 Enable all estimate instructions.
20931 @item default 
20932 Enable the default instructions, equivalent to @option{-mrecip}.
20934 @item none 
20935 Disable all estimate instructions, equivalent to @option{-mno-recip}.
20937 @item div 
20938 Enable the reciprocal approximation instructions for both 
20939 single and double precision.
20941 @item divf 
20942 Enable the single-precision reciprocal approximation instructions.
20944 @item divd 
20945 Enable the double-precision reciprocal approximation instructions.
20947 @item rsqrt 
20948 Enable the reciprocal square root approximation instructions for both
20949 single and double precision.
20951 @item rsqrtf 
20952 Enable the single-precision reciprocal square root approximation instructions.
20954 @item rsqrtd 
20955 Enable the double-precision reciprocal square root approximation instructions.
20957 @end table
20959 So, for example, @option{-mrecip=all,!rsqrtd} enables
20960 all of the reciprocal estimate instructions, except for the
20961 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20962 which handle the double-precision reciprocal square root calculations.
20964 @item -mrecip-precision
20965 @itemx -mno-recip-precision
20966 @opindex mrecip-precision
20967 Assume (do not assume) that the reciprocal estimate instructions
20968 provide higher-precision estimates than is mandated by the PowerPC
20969 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20970 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20971 The double-precision square root estimate instructions are not generated by
20972 default on low-precision machines, since they do not provide an
20973 estimate that converges after three steps.
20975 @item -mveclibabi=@var{type}
20976 @opindex mveclibabi
20977 Specifies the ABI type to use for vectorizing intrinsics using an
20978 external library.  The only type supported at present is @samp{mass},
20979 which specifies to use IBM's Mathematical Acceleration Subsystem
20980 (MASS) libraries for vectorizing intrinsics using external libraries.
20981 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20982 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20983 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20984 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20985 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20986 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20987 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20988 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20989 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20990 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20991 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20992 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20993 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20994 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20995 for power7.  Both @option{-ftree-vectorize} and
20996 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20997 libraries must be specified at link time.
20999 @item -mfriz
21000 @itemx -mno-friz
21001 @opindex mfriz
21002 Generate (do not generate) the @code{friz} instruction when the
21003 @option{-funsafe-math-optimizations} option is used to optimize
21004 rounding of floating-point values to 64-bit integer and back to floating
21005 point.  The @code{friz} instruction does not return the same value if
21006 the floating-point number is too large to fit in an integer.
21008 @item -mpointers-to-nested-functions
21009 @itemx -mno-pointers-to-nested-functions
21010 @opindex mpointers-to-nested-functions
21011 Generate (do not generate) code to load up the static chain register
21012 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
21013 systems where a function pointer points to a 3-word descriptor giving
21014 the function address, TOC value to be loaded in register @code{r2}, and
21015 static chain value to be loaded in register @code{r11}.  The
21016 @option{-mpointers-to-nested-functions} is on by default.  You cannot
21017 call through pointers to nested functions or pointers
21018 to functions compiled in other languages that use the static chain if
21019 you use @option{-mno-pointers-to-nested-functions}.
21021 @item -msave-toc-indirect
21022 @itemx -mno-save-toc-indirect
21023 @opindex msave-toc-indirect
21024 Generate (do not generate) code to save the TOC value in the reserved
21025 stack location in the function prologue if the function calls through
21026 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
21027 saved in the prologue, it is saved just before the call through the
21028 pointer.  The @option{-mno-save-toc-indirect} option is the default.
21030 @item -mcompat-align-parm
21031 @itemx -mno-compat-align-parm
21032 @opindex mcompat-align-parm
21033 Generate (do not generate) code to pass structure parameters with a
21034 maximum alignment of 64 bits, for compatibility with older versions
21035 of GCC.
21037 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
21038 structure parameter on a 128-bit boundary when that structure contained
21039 a member requiring 128-bit alignment.  This is corrected in more
21040 recent versions of GCC.  This option may be used to generate code
21041 that is compatible with functions compiled with older versions of
21042 GCC.
21044 The @option{-mno-compat-align-parm} option is the default.
21045 @end table
21047 @node RX Options
21048 @subsection RX Options
21049 @cindex RX Options
21051 These command-line options are defined for RX targets:
21053 @table @gcctabopt
21054 @item -m64bit-doubles
21055 @itemx -m32bit-doubles
21056 @opindex m64bit-doubles
21057 @opindex m32bit-doubles
21058 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21059 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21060 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
21061 works on 32-bit values, which is why the default is
21062 @option{-m32bit-doubles}.
21064 @item -fpu
21065 @itemx -nofpu
21066 @opindex fpu
21067 @opindex nofpu
21068 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
21069 floating-point hardware.  The default is enabled for the RX600
21070 series and disabled for the RX200 series.
21072 Floating-point instructions are only generated for 32-bit floating-point 
21073 values, however, so the FPU hardware is not used for doubles if the
21074 @option{-m64bit-doubles} option is used.
21076 @emph{Note} If the @option{-fpu} option is enabled then
21077 @option{-funsafe-math-optimizations} is also enabled automatically.
21078 This is because the RX FPU instructions are themselves unsafe.
21080 @item -mcpu=@var{name}
21081 @opindex mcpu
21082 Selects the type of RX CPU to be targeted.  Currently three types are
21083 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
21084 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
21086 The only difference between @samp{RX600} and @samp{RX610} is that the
21087 @samp{RX610} does not support the @code{MVTIPL} instruction.
21089 The @samp{RX200} series does not have a hardware floating-point unit
21090 and so @option{-nofpu} is enabled by default when this type is
21091 selected.
21093 @item -mbig-endian-data
21094 @itemx -mlittle-endian-data
21095 @opindex mbig-endian-data
21096 @opindex mlittle-endian-data
21097 Store data (but not code) in the big-endian format.  The default is
21098 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
21099 format.
21101 @item -msmall-data-limit=@var{N}
21102 @opindex msmall-data-limit
21103 Specifies the maximum size in bytes of global and static variables
21104 which can be placed into the small data area.  Using the small data
21105 area can lead to smaller and faster code, but the size of area is
21106 limited and it is up to the programmer to ensure that the area does
21107 not overflow.  Also when the small data area is used one of the RX's
21108 registers (usually @code{r13}) is reserved for use pointing to this
21109 area, so it is no longer available for use by the compiler.  This
21110 could result in slower and/or larger code if variables are pushed onto
21111 the stack instead of being held in this register.
21113 Note, common variables (variables that have not been initialized) and
21114 constants are not placed into the small data area as they are assigned
21115 to other sections in the output executable.
21117 The default value is zero, which disables this feature.  Note, this
21118 feature is not enabled by default with higher optimization levels
21119 (@option{-O2} etc) because of the potentially detrimental effects of
21120 reserving a register.  It is up to the programmer to experiment and
21121 discover whether this feature is of benefit to their program.  See the
21122 description of the @option{-mpid} option for a description of how the
21123 actual register to hold the small data area pointer is chosen.
21125 @item -msim
21126 @itemx -mno-sim
21127 @opindex msim
21128 @opindex mno-sim
21129 Use the simulator runtime.  The default is to use the libgloss
21130 board-specific runtime.
21132 @item -mas100-syntax
21133 @itemx -mno-as100-syntax
21134 @opindex mas100-syntax
21135 @opindex mno-as100-syntax
21136 When generating assembler output use a syntax that is compatible with
21137 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
21138 assembler, but it has some restrictions so it is not generated by default.
21140 @item -mmax-constant-size=@var{N}
21141 @opindex mmax-constant-size
21142 Specifies the maximum size, in bytes, of a constant that can be used as
21143 an operand in a RX instruction.  Although the RX instruction set does
21144 allow constants of up to 4 bytes in length to be used in instructions,
21145 a longer value equates to a longer instruction.  Thus in some
21146 circumstances it can be beneficial to restrict the size of constants
21147 that are used in instructions.  Constants that are too big are instead
21148 placed into a constant pool and referenced via register indirection.
21150 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
21151 or 4 means that constants of any size are allowed.
21153 @item -mrelax
21154 @opindex mrelax
21155 Enable linker relaxation.  Linker relaxation is a process whereby the
21156 linker attempts to reduce the size of a program by finding shorter
21157 versions of various instructions.  Disabled by default.
21159 @item -mint-register=@var{N}
21160 @opindex mint-register
21161 Specify the number of registers to reserve for fast interrupt handler
21162 functions.  The value @var{N} can be between 0 and 4.  A value of 1
21163 means that register @code{r13} is reserved for the exclusive use
21164 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
21165 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
21166 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
21167 A value of 0, the default, does not reserve any registers.
21169 @item -msave-acc-in-interrupts
21170 @opindex msave-acc-in-interrupts
21171 Specifies that interrupt handler functions should preserve the
21172 accumulator register.  This is only necessary if normal code might use
21173 the accumulator register, for example because it performs 64-bit
21174 multiplications.  The default is to ignore the accumulator as this
21175 makes the interrupt handlers faster.
21177 @item -mpid
21178 @itemx -mno-pid
21179 @opindex mpid
21180 @opindex mno-pid
21181 Enables the generation of position independent data.  When enabled any
21182 access to constant data is done via an offset from a base address
21183 held in a register.  This allows the location of constant data to be
21184 determined at run time without requiring the executable to be
21185 relocated, which is a benefit to embedded applications with tight
21186 memory constraints.  Data that can be modified is not affected by this
21187 option.
21189 Note, using this feature reserves a register, usually @code{r13}, for
21190 the constant data base address.  This can result in slower and/or
21191 larger code, especially in complicated functions.
21193 The actual register chosen to hold the constant data base address
21194 depends upon whether the @option{-msmall-data-limit} and/or the
21195 @option{-mint-register} command-line options are enabled.  Starting
21196 with register @code{r13} and proceeding downwards, registers are
21197 allocated first to satisfy the requirements of @option{-mint-register},
21198 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
21199 is possible for the small data area register to be @code{r8} if both
21200 @option{-mint-register=4} and @option{-mpid} are specified on the
21201 command line.
21203 By default this feature is not enabled.  The default can be restored
21204 via the @option{-mno-pid} command-line option.
21206 @item -mno-warn-multiple-fast-interrupts
21207 @itemx -mwarn-multiple-fast-interrupts
21208 @opindex mno-warn-multiple-fast-interrupts
21209 @opindex mwarn-multiple-fast-interrupts
21210 Prevents GCC from issuing a warning message if it finds more than one
21211 fast interrupt handler when it is compiling a file.  The default is to
21212 issue a warning for each extra fast interrupt handler found, as the RX
21213 only supports one such interrupt.
21215 @item -mallow-string-insns
21216 @itemx -mno-allow-string-insns
21217 @opindex mallow-string-insns
21218 @opindex mno-allow-string-insns
21219 Enables or disables the use of the string manipulation instructions
21220 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
21221 @code{SWHILE} and also the @code{RMPA} instruction.  These
21222 instructions may prefetch data, which is not safe to do if accessing
21223 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
21224 for more information).
21226 The default is to allow these instructions, but it is not possible for
21227 GCC to reliably detect all circumstances where a string instruction
21228 might be used to access an I/O register, so their use cannot be
21229 disabled automatically.  Instead it is reliant upon the programmer to
21230 use the @option{-mno-allow-string-insns} option if their program
21231 accesses I/O space.
21233 When the instructions are enabled GCC defines the C preprocessor
21234 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
21235 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
21237 @item -mjsr
21238 @itemx -mno-jsr
21239 @opindex mjsr
21240 @opindex mno-jsr
21241 Use only (or not only) @code{JSR} instructions to access functions.
21242 This option can be used when code size exceeds the range of @code{BSR}
21243 instructions.  Note that @option{-mno-jsr} does not mean to not use
21244 @code{JSR} but instead means that any type of branch may be used.
21245 @end table
21247 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
21248 has special significance to the RX port when used with the
21249 @code{interrupt} function attribute.  This attribute indicates a
21250 function intended to process fast interrupts.  GCC ensures
21251 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
21252 and/or @code{r13} and only provided that the normal use of the
21253 corresponding registers have been restricted via the
21254 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
21255 options.
21257 @node S/390 and zSeries Options
21258 @subsection S/390 and zSeries Options
21259 @cindex S/390 and zSeries Options
21261 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
21263 @table @gcctabopt
21264 @item -mhard-float
21265 @itemx -msoft-float
21266 @opindex mhard-float
21267 @opindex msoft-float
21268 Use (do not use) the hardware floating-point instructions and registers
21269 for floating-point operations.  When @option{-msoft-float} is specified,
21270 functions in @file{libgcc.a} are used to perform floating-point
21271 operations.  When @option{-mhard-float} is specified, the compiler
21272 generates IEEE floating-point instructions.  This is the default.
21274 @item -mhard-dfp
21275 @itemx -mno-hard-dfp
21276 @opindex mhard-dfp
21277 @opindex mno-hard-dfp
21278 Use (do not use) the hardware decimal-floating-point instructions for
21279 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
21280 specified, functions in @file{libgcc.a} are used to perform
21281 decimal-floating-point operations.  When @option{-mhard-dfp} is
21282 specified, the compiler generates decimal-floating-point hardware
21283 instructions.  This is the default for @option{-march=z9-ec} or higher.
21285 @item -mlong-double-64
21286 @itemx -mlong-double-128
21287 @opindex mlong-double-64
21288 @opindex mlong-double-128
21289 These switches control the size of @code{long double} type. A size
21290 of 64 bits makes the @code{long double} type equivalent to the @code{double}
21291 type. This is the default.
21293 @item -mbackchain
21294 @itemx -mno-backchain
21295 @opindex mbackchain
21296 @opindex mno-backchain
21297 Store (do not store) the address of the caller's frame as backchain pointer
21298 into the callee's stack frame.
21299 A backchain may be needed to allow debugging using tools that do not understand
21300 DWARF call frame information.
21301 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
21302 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
21303 the backchain is placed into the topmost word of the 96/160 byte register
21304 save area.
21306 In general, code compiled with @option{-mbackchain} is call-compatible with
21307 code compiled with @option{-mmo-backchain}; however, use of the backchain
21308 for debugging purposes usually requires that the whole binary is built with
21309 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
21310 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
21311 to build a linux kernel use @option{-msoft-float}.
21313 The default is to not maintain the backchain.
21315 @item -mpacked-stack
21316 @itemx -mno-packed-stack
21317 @opindex mpacked-stack
21318 @opindex mno-packed-stack
21319 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
21320 specified, the compiler uses the all fields of the 96/160 byte register save
21321 area only for their default purpose; unused fields still take up stack space.
21322 When @option{-mpacked-stack} is specified, register save slots are densely
21323 packed at the top of the register save area; unused space is reused for other
21324 purposes, allowing for more efficient use of the available stack space.
21325 However, when @option{-mbackchain} is also in effect, the topmost word of
21326 the save area is always used to store the backchain, and the return address
21327 register is always saved two words below the backchain.
21329 As long as the stack frame backchain is not used, code generated with
21330 @option{-mpacked-stack} is call-compatible with code generated with
21331 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
21332 S/390 or zSeries generated code that uses the stack frame backchain at run
21333 time, not just for debugging purposes.  Such code is not call-compatible
21334 with code compiled with @option{-mpacked-stack}.  Also, note that the
21335 combination of @option{-mbackchain},
21336 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
21337 to build a linux kernel use @option{-msoft-float}.
21339 The default is to not use the packed stack layout.
21341 @item -msmall-exec
21342 @itemx -mno-small-exec
21343 @opindex msmall-exec
21344 @opindex mno-small-exec
21345 Generate (or do not generate) code using the @code{bras} instruction
21346 to do subroutine calls.
21347 This only works reliably if the total executable size does not
21348 exceed 64k.  The default is to use the @code{basr} instruction instead,
21349 which does not have this limitation.
21351 @item -m64
21352 @itemx -m31
21353 @opindex m64
21354 @opindex m31
21355 When @option{-m31} is specified, generate code compliant to the
21356 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
21357 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
21358 particular to generate 64-bit instructions.  For the @samp{s390}
21359 targets, the default is @option{-m31}, while the @samp{s390x}
21360 targets default to @option{-m64}.
21362 @item -mzarch
21363 @itemx -mesa
21364 @opindex mzarch
21365 @opindex mesa
21366 When @option{-mzarch} is specified, generate code using the
21367 instructions available on z/Architecture.
21368 When @option{-mesa} is specified, generate code using the
21369 instructions available on ESA/390.  Note that @option{-mesa} is
21370 not possible with @option{-m64}.
21371 When generating code compliant to the GNU/Linux for S/390 ABI,
21372 the default is @option{-mesa}.  When generating code compliant
21373 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
21375 @item -mhtm
21376 @itemx -mno-htm
21377 @opindex mhtm
21378 @opindex mno-htm
21379 The @option{-mhtm} option enables a set of builtins making use of
21380 instructions available with the transactional execution facility
21381 introduced with the IBM zEnterprise EC12 machine generation
21382 @ref{S/390 System z Built-in Functions}.
21383 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
21385 @item -mvx
21386 @itemx -mno-vx
21387 @opindex mvx
21388 @opindex mno-vx
21389 When @option{-mvx} is specified, generate code using the instructions
21390 available with the vector extension facility introduced with the IBM
21391 z13 machine generation.
21392 This option changes the ABI for some vector type values with regard to
21393 alignment and calling conventions.  In case vector type values are
21394 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
21395 command will be added to mark the resulting binary with the ABI used.
21396 @option{-mvx} is enabled by default when using @option{-march=z13}.
21398 @item -mzvector
21399 @itemx -mno-zvector
21400 @opindex mzvector
21401 @opindex mno-zvector
21402 The @option{-mzvector} option enables vector language extensions and
21403 builtins using instructions available with the vector extension
21404 facility introduced with the IBM z13 machine generation.
21405 This option adds support for @samp{vector} to be used as a keyword to
21406 define vector type variables and arguments.  @samp{vector} is only
21407 available when GNU extensions are enabled.  It will not be expanded
21408 when requesting strict standard compliance e.g. with @option{-std=c99}.
21409 In addition to the GCC low-level builtins @option{-mzvector} enables
21410 a set of builtins added for compatibility with AltiVec-style
21411 implementations like Power and Cell.  In order to make use of these
21412 builtins the header file @file{vecintrin.h} needs to be included.
21413 @option{-mzvector} is disabled by default.
21415 @item -mmvcle
21416 @itemx -mno-mvcle
21417 @opindex mmvcle
21418 @opindex mno-mvcle
21419 Generate (or do not generate) code using the @code{mvcle} instruction
21420 to perform block moves.  When @option{-mno-mvcle} is specified,
21421 use a @code{mvc} loop instead.  This is the default unless optimizing for
21422 size.
21424 @item -mdebug
21425 @itemx -mno-debug
21426 @opindex mdebug
21427 @opindex mno-debug
21428 Print (or do not print) additional debug information when compiling.
21429 The default is to not print debug information.
21431 @item -march=@var{cpu-type}
21432 @opindex march
21433 Generate code that runs on @var{cpu-type}, which is the name of a
21434 system representing a certain processor type.  Possible values for
21435 @var{cpu-type} are @samp{z900}, @samp{z990}, @samp{z9-109},
21436 @samp{z9-ec}, @samp{z10}, @samp{z196}, @samp{zEC12}, and @samp{z13}.
21437 The default is @option{-march=z900}.  @samp{g5} and @samp{g6} are
21438 deprecated and will be removed with future releases.
21440 @item -mtune=@var{cpu-type}
21441 @opindex mtune
21442 Tune to @var{cpu-type} everything applicable about the generated code,
21443 except for the ABI and the set of available instructions.
21444 The list of @var{cpu-type} values is the same as for @option{-march}.
21445 The default is the value used for @option{-march}.
21447 @item -mtpf-trace
21448 @itemx -mno-tpf-trace
21449 @opindex mtpf-trace
21450 @opindex mno-tpf-trace
21451 Generate code that adds (does not add) in TPF OS specific branches to trace
21452 routines in the operating system.  This option is off by default, even
21453 when compiling for the TPF OS@.
21455 @item -mfused-madd
21456 @itemx -mno-fused-madd
21457 @opindex mfused-madd
21458 @opindex mno-fused-madd
21459 Generate code that uses (does not use) the floating-point multiply and
21460 accumulate instructions.  These instructions are generated by default if
21461 hardware floating point is used.
21463 @item -mwarn-framesize=@var{framesize}
21464 @opindex mwarn-framesize
21465 Emit a warning if the current function exceeds the given frame size.  Because
21466 this is a compile-time check it doesn't need to be a real problem when the program
21467 runs.  It is intended to identify functions that most probably cause
21468 a stack overflow.  It is useful to be used in an environment with limited stack
21469 size e.g.@: the linux kernel.
21471 @item -mwarn-dynamicstack
21472 @opindex mwarn-dynamicstack
21473 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
21474 arrays.  This is generally a bad idea with a limited stack size.
21476 @item -mstack-guard=@var{stack-guard}
21477 @itemx -mstack-size=@var{stack-size}
21478 @opindex mstack-guard
21479 @opindex mstack-size
21480 If these options are provided the S/390 back end emits additional instructions in
21481 the function prologue that trigger a trap if the stack size is @var{stack-guard}
21482 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
21483 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
21484 the frame size of the compiled function is chosen.
21485 These options are intended to be used to help debugging stack overflow problems.
21486 The additionally emitted code causes only little overhead and hence can also be
21487 used in production-like systems without greater performance degradation.  The given
21488 values have to be exact powers of 2 and @var{stack-size} has to be greater than
21489 @var{stack-guard} without exceeding 64k.
21490 In order to be efficient the extra code makes the assumption that the stack starts
21491 at an address aligned to the value given by @var{stack-size}.
21492 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
21494 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
21495 @opindex mhotpatch
21496 If the hotpatch option is enabled, a ``hot-patching'' function
21497 prologue is generated for all functions in the compilation unit.
21498 The funtion label is prepended with the given number of two-byte
21499 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
21500 the label, 2 * @var{post-halfwords} bytes are appended, using the
21501 largest NOP like instructions the architecture allows (maximum
21502 1000000).
21504 If both arguments are zero, hotpatching is disabled.
21506 This option can be overridden for individual functions with the
21507 @code{hotpatch} attribute.
21508 @end table
21510 @node Score Options
21511 @subsection Score Options
21512 @cindex Score Options
21514 These options are defined for Score implementations:
21516 @table @gcctabopt
21517 @item -meb
21518 @opindex meb
21519 Compile code for big-endian mode.  This is the default.
21521 @item -mel
21522 @opindex mel
21523 Compile code for little-endian mode.
21525 @item -mnhwloop
21526 @opindex mnhwloop
21527 Disable generation of @code{bcnz} instructions.
21529 @item -muls
21530 @opindex muls
21531 Enable generation of unaligned load and store instructions.
21533 @item -mmac
21534 @opindex mmac
21535 Enable the use of multiply-accumulate instructions. Disabled by default.
21537 @item -mscore5
21538 @opindex mscore5
21539 Specify the SCORE5 as the target architecture.
21541 @item -mscore5u
21542 @opindex mscore5u
21543 Specify the SCORE5U of the target architecture.
21545 @item -mscore7
21546 @opindex mscore7
21547 Specify the SCORE7 as the target architecture. This is the default.
21549 @item -mscore7d
21550 @opindex mscore7d
21551 Specify the SCORE7D as the target architecture.
21552 @end table
21554 @node SH Options
21555 @subsection SH Options
21557 These @samp{-m} options are defined for the SH implementations:
21559 @table @gcctabopt
21560 @item -m1
21561 @opindex m1
21562 Generate code for the SH1.
21564 @item -m2
21565 @opindex m2
21566 Generate code for the SH2.
21568 @item -m2e
21569 Generate code for the SH2e.
21571 @item -m2a-nofpu
21572 @opindex m2a-nofpu
21573 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
21574 that the floating-point unit is not used.
21576 @item -m2a-single-only
21577 @opindex m2a-single-only
21578 Generate code for the SH2a-FPU, in such a way that no double-precision
21579 floating-point operations are used.
21581 @item -m2a-single
21582 @opindex m2a-single
21583 Generate code for the SH2a-FPU assuming the floating-point unit is in
21584 single-precision mode by default.
21586 @item -m2a
21587 @opindex m2a
21588 Generate code for the SH2a-FPU assuming the floating-point unit is in
21589 double-precision mode by default.
21591 @item -m3
21592 @opindex m3
21593 Generate code for the SH3.
21595 @item -m3e
21596 @opindex m3e
21597 Generate code for the SH3e.
21599 @item -m4-nofpu
21600 @opindex m4-nofpu
21601 Generate code for the SH4 without a floating-point unit.
21603 @item -m4-single-only
21604 @opindex m4-single-only
21605 Generate code for the SH4 with a floating-point unit that only
21606 supports single-precision arithmetic.
21608 @item -m4-single
21609 @opindex m4-single
21610 Generate code for the SH4 assuming the floating-point unit is in
21611 single-precision mode by default.
21613 @item -m4
21614 @opindex m4
21615 Generate code for the SH4.
21617 @item -m4-100
21618 @opindex m4-100
21619 Generate code for SH4-100.
21621 @item -m4-100-nofpu
21622 @opindex m4-100-nofpu
21623 Generate code for SH4-100 in such a way that the
21624 floating-point unit is not used.
21626 @item -m4-100-single
21627 @opindex m4-100-single
21628 Generate code for SH4-100 assuming the floating-point unit is in
21629 single-precision mode by default.
21631 @item -m4-100-single-only
21632 @opindex m4-100-single-only
21633 Generate code for SH4-100 in such a way that no double-precision
21634 floating-point operations are used.
21636 @item -m4-200
21637 @opindex m4-200
21638 Generate code for SH4-200.
21640 @item -m4-200-nofpu
21641 @opindex m4-200-nofpu
21642 Generate code for SH4-200 without in such a way that the
21643 floating-point unit is not used.
21645 @item -m4-200-single
21646 @opindex m4-200-single
21647 Generate code for SH4-200 assuming the floating-point unit is in
21648 single-precision mode by default.
21650 @item -m4-200-single-only
21651 @opindex m4-200-single-only
21652 Generate code for SH4-200 in such a way that no double-precision
21653 floating-point operations are used.
21655 @item -m4-300
21656 @opindex m4-300
21657 Generate code for SH4-300.
21659 @item -m4-300-nofpu
21660 @opindex m4-300-nofpu
21661 Generate code for SH4-300 without in such a way that the
21662 floating-point unit is not used.
21664 @item -m4-300-single
21665 @opindex m4-300-single
21666 Generate code for SH4-300 in such a way that no double-precision
21667 floating-point operations are used.
21669 @item -m4-300-single-only
21670 @opindex m4-300-single-only
21671 Generate code for SH4-300 in such a way that no double-precision
21672 floating-point operations are used.
21674 @item -m4-340
21675 @opindex m4-340
21676 Generate code for SH4-340 (no MMU, no FPU).
21678 @item -m4-500
21679 @opindex m4-500
21680 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
21681 assembler.
21683 @item -m4a-nofpu
21684 @opindex m4a-nofpu
21685 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
21686 floating-point unit is not used.
21688 @item -m4a-single-only
21689 @opindex m4a-single-only
21690 Generate code for the SH4a, in such a way that no double-precision
21691 floating-point operations are used.
21693 @item -m4a-single
21694 @opindex m4a-single
21695 Generate code for the SH4a assuming the floating-point unit is in
21696 single-precision mode by default.
21698 @item -m4a
21699 @opindex m4a
21700 Generate code for the SH4a.
21702 @item -m4al
21703 @opindex m4al
21704 Same as @option{-m4a-nofpu}, except that it implicitly passes
21705 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
21706 instructions at the moment.
21708 @item -mb
21709 @opindex mb
21710 Compile code for the processor in big-endian mode.
21712 @item -ml
21713 @opindex ml
21714 Compile code for the processor in little-endian mode.
21716 @item -mdalign
21717 @opindex mdalign
21718 Align doubles at 64-bit boundaries.  Note that this changes the calling
21719 conventions, and thus some functions from the standard C library do
21720 not work unless you recompile it first with @option{-mdalign}.
21722 @item -mrelax
21723 @opindex mrelax
21724 Shorten some address references at link time, when possible; uses the
21725 linker option @option{-relax}.
21727 @item -mbigtable
21728 @opindex mbigtable
21729 Use 32-bit offsets in @code{switch} tables.  The default is to use
21730 16-bit offsets.
21732 @item -mbitops
21733 @opindex mbitops
21734 Enable the use of bit manipulation instructions on SH2A.
21736 @item -mfmovd
21737 @opindex mfmovd
21738 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21739 alignment constraints.
21741 @item -mrenesas
21742 @opindex mrenesas
21743 Comply with the calling conventions defined by Renesas.
21745 @item -mno-renesas
21746 @opindex mno-renesas
21747 Comply with the calling conventions defined for GCC before the Renesas
21748 conventions were available.  This option is the default for all
21749 targets of the SH toolchain.
21751 @item -mnomacsave
21752 @opindex mnomacsave
21753 Mark the @code{MAC} register as call-clobbered, even if
21754 @option{-mrenesas} is given.
21756 @item -mieee
21757 @itemx -mno-ieee
21758 @opindex mieee
21759 @opindex mno-ieee
21760 Control the IEEE compliance of floating-point comparisons, which affects the
21761 handling of cases where the result of a comparison is unordered.  By default
21762 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21763 enabled @option{-mno-ieee} is implicitly set, which results in faster
21764 floating-point greater-equal and less-equal comparisons.  The implicit settings
21765 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21767 @item -minline-ic_invalidate
21768 @opindex minline-ic_invalidate
21769 Inline code to invalidate instruction cache entries after setting up
21770 nested function trampolines.
21771 This option has no effect if @option{-musermode} is in effect and the selected
21772 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21773 instruction.
21774 If the selected code generation option does not allow the use of the @code{icbi}
21775 instruction, and @option{-musermode} is not in effect, the inlined code
21776 manipulates the instruction cache address array directly with an associative
21777 write.  This not only requires privileged mode at run time, but it also
21778 fails if the cache line had been mapped via the TLB and has become unmapped.
21780 @item -misize
21781 @opindex misize
21782 Dump instruction size and location in the assembly code.
21784 @item -mpadstruct
21785 @opindex mpadstruct
21786 This option is deprecated.  It pads structures to multiple of 4 bytes,
21787 which is incompatible with the SH ABI@.
21789 @item -matomic-model=@var{model}
21790 @opindex matomic-model=@var{model}
21791 Sets the model of atomic operations and additional parameters as a comma
21792 separated list.  For details on the atomic built-in functions see
21793 @ref{__atomic Builtins}.  The following models and parameters are supported:
21795 @table @samp
21797 @item none
21798 Disable compiler generated atomic sequences and emit library calls for atomic
21799 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21801 @item soft-gusa
21802 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21803 built-in functions.  The generated atomic sequences require additional support
21804 from the interrupt/exception handling code of the system and are only suitable
21805 for SH3* and SH4* single-core systems.  This option is enabled by default when
21806 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21807 this option also partially utilizes the hardware atomic instructions
21808 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21809 @samp{strict} is specified.  
21811 @item soft-tcb
21812 Generate software atomic sequences that use a variable in the thread control
21813 block.  This is a variation of the gUSA sequences which can also be used on
21814 SH1* and SH2* targets.  The generated atomic sequences require additional
21815 support from the interrupt/exception handling code of the system and are only
21816 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21817 parameter has to be specified as well.
21819 @item soft-imask
21820 Generate software atomic sequences that temporarily disable interrupts by
21821 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21822 in privileged mode and is only suitable for single-core systems.  Additional
21823 support from the interrupt/exception handling code of the system is not
21824 required.  This model is enabled by default when the target is
21825 @code{sh*-*-linux*} and SH1* or SH2*.
21827 @item hard-llcs
21828 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21829 instructions only.  This is only available on SH4A and is suitable for
21830 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21831 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21832 Code compiled with this option is also compatible with other software
21833 atomic model interrupt/exception handling systems if executed on an SH4A
21834 system.  Additional support from the interrupt/exception handling code of the
21835 system is not required for this model.
21837 @item gbr-offset=
21838 This parameter specifies the offset in bytes of the variable in the thread
21839 control block structure that should be used by the generated atomic sequences
21840 when the @samp{soft-tcb} model has been selected.  For other models this
21841 parameter is ignored.  The specified value must be an integer multiple of four
21842 and in the range 0-1020.
21844 @item strict
21845 This parameter prevents mixed usage of multiple atomic models, even if they
21846 are compatible, and makes the compiler generate atomic sequences of the
21847 specified model only.
21849 @end table
21851 @item -mtas
21852 @opindex mtas
21853 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21854 Notice that depending on the particular hardware and software configuration
21855 this can degrade overall performance due to the operand cache line flushes
21856 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21857 processors the @code{tas.b} instruction must be used with caution since it
21858 can result in data corruption for certain cache configurations.
21860 @item -mprefergot
21861 @opindex mprefergot
21862 When generating position-independent code, emit function calls using
21863 the Global Offset Table instead of the Procedure Linkage Table.
21865 @item -musermode
21866 @itemx -mno-usermode
21867 @opindex musermode
21868 @opindex mno-usermode
21869 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21870 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21871 inlined code would not work in user mode.  @option{-musermode} is the default
21872 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21873 @option{-musermode} has no effect, since there is no user mode.
21875 @item -multcost=@var{number}
21876 @opindex multcost=@var{number}
21877 Set the cost to assume for a multiply insn.
21879 @item -mdiv=@var{strategy}
21880 @opindex mdiv=@var{strategy}
21881 Set the division strategy to be used for integer division operations.
21882 @var{strategy} can be one of: 
21884 @table @samp
21886 @item call-div1
21887 Calls a library function that uses the single-step division instruction
21888 @code{div1} to perform the operation.  Division by zero calculates an
21889 unspecified result and does not trap.  This is the default except for SH4,
21890 SH2A and SHcompact.
21892 @item call-fp
21893 Calls a library function that performs the operation in double precision
21894 floating point.  Division by zero causes a floating-point exception.  This is
21895 the default for SHcompact with FPU.  Specifying this for targets that do not
21896 have a double precision FPU defaults to @code{call-div1}.
21898 @item call-table
21899 Calls a library function that uses a lookup table for small divisors and
21900 the @code{div1} instruction with case distinction for larger divisors.  Division
21901 by zero calculates an unspecified result and does not trap.  This is the default
21902 for SH4.  Specifying this for targets that do not have dynamic shift
21903 instructions defaults to @code{call-div1}.
21905 @end table
21907 When a division strategy has not been specified the default strategy is
21908 selected based on the current target.  For SH2A the default strategy is to
21909 use the @code{divs} and @code{divu} instructions instead of library function
21910 calls.
21912 @item -maccumulate-outgoing-args
21913 @opindex maccumulate-outgoing-args
21914 Reserve space once for outgoing arguments in the function prologue rather
21915 than around each call.  Generally beneficial for performance and size.  Also
21916 needed for unwinding to avoid changing the stack frame around conditional code.
21918 @item -mdivsi3_libfunc=@var{name}
21919 @opindex mdivsi3_libfunc=@var{name}
21920 Set the name of the library function used for 32-bit signed division to
21921 @var{name}.
21922 This only affects the name used in the @samp{call} division strategies, and
21923 the compiler still expects the same sets of input/output/clobbered registers as
21924 if this option were not present.
21926 @item -mfixed-range=@var{register-range}
21927 @opindex mfixed-range
21928 Generate code treating the given register range as fixed registers.
21929 A fixed register is one that the register allocator can not use.  This is
21930 useful when compiling kernel code.  A register range is specified as
21931 two registers separated by a dash.  Multiple register ranges can be
21932 specified separated by a comma.
21934 @item -mbranch-cost=@var{num}
21935 @opindex mbranch-cost=@var{num}
21936 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21937 make the compiler try to generate more branch-free code if possible.  
21938 If not specified the value is selected depending on the processor type that
21939 is being compiled for.
21941 @item -mzdcbranch
21942 @itemx -mno-zdcbranch
21943 @opindex mzdcbranch
21944 @opindex mno-zdcbranch
21945 Assume (do not assume) that zero displacement conditional branch instructions
21946 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21947 compiler prefers zero displacement branch code sequences.  This is
21948 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21949 disabled by specifying @option{-mno-zdcbranch}.
21951 @item -mcbranch-force-delay-slot
21952 @opindex mcbranch-force-delay-slot
21953 Force the usage of delay slots for conditional branches, which stuffs the delay
21954 slot with a @code{nop} if a suitable instruction can't be found.  By default
21955 this option is disabled.  It can be enabled to work around hardware bugs as
21956 found in the original SH7055.
21958 @item -mfused-madd
21959 @itemx -mno-fused-madd
21960 @opindex mfused-madd
21961 @opindex mno-fused-madd
21962 Generate code that uses (does not use) the floating-point multiply and
21963 accumulate instructions.  These instructions are generated by default
21964 if hardware floating point is used.  The machine-dependent
21965 @option{-mfused-madd} option is now mapped to the machine-independent
21966 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21967 mapped to @option{-ffp-contract=off}.
21969 @item -mfsca
21970 @itemx -mno-fsca
21971 @opindex mfsca
21972 @opindex mno-fsca
21973 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21974 and cosine approximations.  The option @option{-mfsca} must be used in
21975 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21976 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21977 approximations even if @option{-funsafe-math-optimizations} is in effect.
21979 @item -mfsrra
21980 @itemx -mno-fsrra
21981 @opindex mfsrra
21982 @opindex mno-fsrra
21983 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21984 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21985 in combination with @option{-funsafe-math-optimizations} and
21986 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21987 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21988 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21989 in effect.
21991 @item -mpretend-cmove
21992 @opindex mpretend-cmove
21993 Prefer zero-displacement conditional branches for conditional move instruction
21994 patterns.  This can result in faster code on the SH4 processor.
21996 @item -mfdpic
21997 @opindex fdpic
21998 Generate code using the FDPIC ABI.
22000 @end table
22002 @node Solaris 2 Options
22003 @subsection Solaris 2 Options
22004 @cindex Solaris 2 options
22006 These @samp{-m} options are supported on Solaris 2:
22008 @table @gcctabopt
22009 @item -mclear-hwcap
22010 @opindex mclear-hwcap
22011 @option{-mclear-hwcap} tells the compiler to remove the hardware
22012 capabilities generated by the Solaris assembler.  This is only necessary
22013 when object files use ISA extensions not supported by the current
22014 machine, but check at runtime whether or not to use them.
22016 @item -mimpure-text
22017 @opindex mimpure-text
22018 @option{-mimpure-text}, used in addition to @option{-shared}, tells
22019 the compiler to not pass @option{-z text} to the linker when linking a
22020 shared object.  Using this option, you can link position-dependent
22021 code into a shared object.
22023 @option{-mimpure-text} suppresses the ``relocations remain against
22024 allocatable but non-writable sections'' linker error message.
22025 However, the necessary relocations trigger copy-on-write, and the
22026 shared object is not actually shared across processes.  Instead of
22027 using @option{-mimpure-text}, you should compile all source code with
22028 @option{-fpic} or @option{-fPIC}.
22030 @end table
22032 These switches are supported in addition to the above on Solaris 2:
22034 @table @gcctabopt
22035 @item -pthreads
22036 @opindex pthreads
22037 Add support for multithreading using the POSIX threads library.  This
22038 option sets flags for both the preprocessor and linker.  This option does
22039 not affect the thread safety of object code produced  by the compiler or
22040 that of libraries supplied with it.
22042 @item -pthread
22043 @opindex pthread
22044 This is a synonym for @option{-pthreads}.
22045 @end table
22047 @node SPARC Options
22048 @subsection SPARC Options
22049 @cindex SPARC options
22051 These @samp{-m} options are supported on the SPARC:
22053 @table @gcctabopt
22054 @item -mno-app-regs
22055 @itemx -mapp-regs
22056 @opindex mno-app-regs
22057 @opindex mapp-regs
22058 Specify @option{-mapp-regs} to generate output using the global registers
22059 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
22060 global register 1, each global register 2 through 4 is then treated as an
22061 allocable register that is clobbered by function calls.  This is the default.
22063 To be fully SVR4 ABI-compliant at the cost of some performance loss,
22064 specify @option{-mno-app-regs}.  You should compile libraries and system
22065 software with this option.
22067 @item -mflat
22068 @itemx -mno-flat
22069 @opindex mflat
22070 @opindex mno-flat
22071 With @option{-mflat}, the compiler does not generate save/restore instructions
22072 and uses a ``flat'' or single register window model.  This model is compatible
22073 with the regular register window model.  The local registers and the input
22074 registers (0--5) are still treated as ``call-saved'' registers and are
22075 saved on the stack as needed.
22077 With @option{-mno-flat} (the default), the compiler generates save/restore
22078 instructions (except for leaf functions).  This is the normal operating mode.
22080 @item -mfpu
22081 @itemx -mhard-float
22082 @opindex mfpu
22083 @opindex mhard-float
22084 Generate output containing floating-point instructions.  This is the
22085 default.
22087 @item -mno-fpu
22088 @itemx -msoft-float
22089 @opindex mno-fpu
22090 @opindex msoft-float
22091 Generate output containing library calls for floating point.
22092 @strong{Warning:} the requisite libraries are not available for all SPARC
22093 targets.  Normally the facilities of the machine's usual C compiler are
22094 used, but this cannot be done directly in cross-compilation.  You must make
22095 your own arrangements to provide suitable library functions for
22096 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
22097 @samp{sparclite-*-*} do provide software floating-point support.
22099 @option{-msoft-float} changes the calling convention in the output file;
22100 therefore, it is only useful if you compile @emph{all} of a program with
22101 this option.  In particular, you need to compile @file{libgcc.a}, the
22102 library that comes with GCC, with @option{-msoft-float} in order for
22103 this to work.
22105 @item -mhard-quad-float
22106 @opindex mhard-quad-float
22107 Generate output containing quad-word (long double) floating-point
22108 instructions.
22110 @item -msoft-quad-float
22111 @opindex msoft-quad-float
22112 Generate output containing library calls for quad-word (long double)
22113 floating-point instructions.  The functions called are those specified
22114 in the SPARC ABI@.  This is the default.
22116 As of this writing, there are no SPARC implementations that have hardware
22117 support for the quad-word floating-point instructions.  They all invoke
22118 a trap handler for one of these instructions, and then the trap handler
22119 emulates the effect of the instruction.  Because of the trap handler overhead,
22120 this is much slower than calling the ABI library routines.  Thus the
22121 @option{-msoft-quad-float} option is the default.
22123 @item -mno-unaligned-doubles
22124 @itemx -munaligned-doubles
22125 @opindex mno-unaligned-doubles
22126 @opindex munaligned-doubles
22127 Assume that doubles have 8-byte alignment.  This is the default.
22129 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
22130 alignment only if they are contained in another type, or if they have an
22131 absolute address.  Otherwise, it assumes they have 4-byte alignment.
22132 Specifying this option avoids some rare compatibility problems with code
22133 generated by other compilers.  It is not the default because it results
22134 in a performance loss, especially for floating-point code.
22136 @item -muser-mode
22137 @itemx -mno-user-mode
22138 @opindex muser-mode
22139 @opindex mno-user-mode
22140 Do not generate code that can only run in supervisor mode.  This is relevant
22141 only for the @code{casa} instruction emitted for the LEON3 processor.  This
22142 is the default.
22144 @item -mfaster-structs
22145 @itemx -mno-faster-structs
22146 @opindex mfaster-structs
22147 @opindex mno-faster-structs
22148 With @option{-mfaster-structs}, the compiler assumes that structures
22149 should have 8-byte alignment.  This enables the use of pairs of
22150 @code{ldd} and @code{std} instructions for copies in structure
22151 assignment, in place of twice as many @code{ld} and @code{st} pairs.
22152 However, the use of this changed alignment directly violates the SPARC
22153 ABI@.  Thus, it's intended only for use on targets where the developer
22154 acknowledges that their resulting code is not directly in line with
22155 the rules of the ABI@.
22157 @item -mstd-struct-return
22158 @itemx -mno-std-struct-return
22159 @opindex mstd-struct-return
22160 @opindex mno-std-struct-return
22161 With @option{-mstd-struct-return}, the compiler generates checking code
22162 in functions returning structures or unions to detect size mismatches
22163 between the two sides of function calls, as per the 32-bit ABI@.
22165 The default is @option{-mno-std-struct-return}.  This option has no effect
22166 in 64-bit mode.
22168 @item -mcpu=@var{cpu_type}
22169 @opindex mcpu
22170 Set the instruction set, register set, and instruction scheduling parameters
22171 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22172 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
22173 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
22174 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
22175 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
22176 @samp{niagara3} and @samp{niagara4}.
22178 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
22179 which selects the best architecture option for the host processor.
22180 @option{-mcpu=native} has no effect if GCC does not recognize
22181 the processor.
22183 Default instruction scheduling parameters are used for values that select
22184 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
22185 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
22187 Here is a list of each supported architecture and their supported
22188 implementations.
22190 @table @asis
22191 @item v7
22192 cypress, leon3v7
22194 @item v8
22195 supersparc, hypersparc, leon, leon3
22197 @item sparclite
22198 f930, f934, sparclite86x
22200 @item sparclet
22201 tsc701
22203 @item v9
22204 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
22205 @end table
22207 By default (unless configured otherwise), GCC generates code for the V7
22208 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
22209 additionally optimizes it for the Cypress CY7C602 chip, as used in the
22210 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
22211 SPARCStation 1, 2, IPX etc.
22213 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
22214 architecture.  The only difference from V7 code is that the compiler emits
22215 the integer multiply and integer divide instructions which exist in SPARC-V8
22216 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
22217 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
22218 2000 series.
22220 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
22221 the SPARC architecture.  This adds the integer multiply, integer divide step
22222 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
22223 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
22224 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
22225 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
22226 MB86934 chip, which is the more recent SPARClite with FPU@.
22228 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
22229 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
22230 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
22231 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
22232 optimizes it for the TEMIC SPARClet chip.
22234 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
22235 architecture.  This adds 64-bit integer and floating-point move instructions,
22236 3 additional floating-point condition code registers and conditional move
22237 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
22238 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
22239 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
22240 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
22241 @option{-mcpu=niagara}, the compiler additionally optimizes it for
22242 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
22243 additionally optimizes it for Sun UltraSPARC T2 chips. With
22244 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
22245 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
22246 additionally optimizes it for Sun UltraSPARC T4 chips.
22248 @item -mtune=@var{cpu_type}
22249 @opindex mtune
22250 Set the instruction scheduling parameters for machine type
22251 @var{cpu_type}, but do not set the instruction set or register set that the
22252 option @option{-mcpu=@var{cpu_type}} does.
22254 The same values for @option{-mcpu=@var{cpu_type}} can be used for
22255 @option{-mtune=@var{cpu_type}}, but the only useful values are those
22256 that select a particular CPU implementation.  Those are @samp{cypress},
22257 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
22258 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
22259 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
22260 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
22261 toolchains, @samp{native} can also be used.
22263 @item -mv8plus
22264 @itemx -mno-v8plus
22265 @opindex mv8plus
22266 @opindex mno-v8plus
22267 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
22268 difference from the V8 ABI is that the global and out registers are
22269 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
22270 mode for all SPARC-V9 processors.
22272 @item -mvis
22273 @itemx -mno-vis
22274 @opindex mvis
22275 @opindex mno-vis
22276 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
22277 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
22279 @item -mvis2
22280 @itemx -mno-vis2
22281 @opindex mvis2
22282 @opindex mno-vis2
22283 With @option{-mvis2}, GCC generates code that takes advantage of
22284 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
22285 default is @option{-mvis2} when targeting a cpu that supports such
22286 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
22287 also sets @option{-mvis}.
22289 @item -mvis3
22290 @itemx -mno-vis3
22291 @opindex mvis3
22292 @opindex mno-vis3
22293 With @option{-mvis3}, GCC generates code that takes advantage of
22294 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
22295 default is @option{-mvis3} when targeting a cpu that supports such
22296 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
22297 also sets @option{-mvis2} and @option{-mvis}.
22299 @item -mcbcond
22300 @itemx -mno-cbcond
22301 @opindex mcbcond
22302 @opindex mno-cbcond
22303 With @option{-mcbcond}, GCC generates code that takes advantage of
22304 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
22305 The default is @option{-mcbcond} when targeting a cpu that supports such
22306 instructions, such as niagara-4 and later.
22308 @item -mpopc
22309 @itemx -mno-popc
22310 @opindex mpopc
22311 @opindex mno-popc
22312 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
22313 population count instruction.  The default is @option{-mpopc}
22314 when targeting a cpu that supports such instructions, such as Niagara-2 and
22315 later.
22317 @item -mfmaf
22318 @itemx -mno-fmaf
22319 @opindex mfmaf
22320 @opindex mno-fmaf
22321 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
22322 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
22323 when targeting a cpu that supports such instructions, such as Niagara-3 and
22324 later.
22326 @item -mfix-at697f
22327 @opindex mfix-at697f
22328 Enable the documented workaround for the single erratum of the Atmel AT697F
22329 processor (which corresponds to erratum #13 of the AT697E processor).
22331 @item -mfix-ut699
22332 @opindex mfix-ut699
22333 Enable the documented workarounds for the floating-point errata and the data
22334 cache nullify errata of the UT699 processor.
22335 @end table
22337 These @samp{-m} options are supported in addition to the above
22338 on SPARC-V9 processors in 64-bit environments:
22340 @table @gcctabopt
22341 @item -m32
22342 @itemx -m64
22343 @opindex m32
22344 @opindex m64
22345 Generate code for a 32-bit or 64-bit environment.
22346 The 32-bit environment sets int, long and pointer to 32 bits.
22347 The 64-bit environment sets int to 32 bits and long and pointer
22348 to 64 bits.
22350 @item -mcmodel=@var{which}
22351 @opindex mcmodel
22352 Set the code model to one of
22354 @table @samp
22355 @item medlow
22356 The Medium/Low code model: 64-bit addresses, programs
22357 must be linked in the low 32 bits of memory.  Programs can be statically
22358 or dynamically linked.
22360 @item medmid
22361 The Medium/Middle code model: 64-bit addresses, programs
22362 must be linked in the low 44 bits of memory, the text and data segments must
22363 be less than 2GB in size and the data segment must be located within 2GB of
22364 the text segment.
22366 @item medany
22367 The Medium/Anywhere code model: 64-bit addresses, programs
22368 may be linked anywhere in memory, the text and data segments must be less
22369 than 2GB in size and the data segment must be located within 2GB of the
22370 text segment.
22372 @item embmedany
22373 The Medium/Anywhere code model for embedded systems:
22374 64-bit addresses, the text and data segments must be less than 2GB in
22375 size, both starting anywhere in memory (determined at link time).  The
22376 global register %g4 points to the base of the data segment.  Programs
22377 are statically linked and PIC is not supported.
22378 @end table
22380 @item -mmemory-model=@var{mem-model}
22381 @opindex mmemory-model
22382 Set the memory model in force on the processor to one of
22384 @table @samp
22385 @item default
22386 The default memory model for the processor and operating system.
22388 @item rmo
22389 Relaxed Memory Order
22391 @item pso
22392 Partial Store Order
22394 @item tso
22395 Total Store Order
22397 @item sc
22398 Sequential Consistency
22399 @end table
22401 These memory models are formally defined in Appendix D of the Sparc V9
22402 architecture manual, as set in the processor's @code{PSTATE.MM} field.
22404 @item -mstack-bias
22405 @itemx -mno-stack-bias
22406 @opindex mstack-bias
22407 @opindex mno-stack-bias
22408 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
22409 frame pointer if present, are offset by @minus{}2047 which must be added back
22410 when making stack frame references.  This is the default in 64-bit mode.
22411 Otherwise, assume no such offset is present.
22412 @end table
22414 @node SPU Options
22415 @subsection SPU Options
22416 @cindex SPU options
22418 These @samp{-m} options are supported on the SPU:
22420 @table @gcctabopt
22421 @item -mwarn-reloc
22422 @itemx -merror-reloc
22423 @opindex mwarn-reloc
22424 @opindex merror-reloc
22426 The loader for SPU does not handle dynamic relocations.  By default, GCC
22427 gives an error when it generates code that requires a dynamic
22428 relocation.  @option{-mno-error-reloc} disables the error,
22429 @option{-mwarn-reloc} generates a warning instead.
22431 @item -msafe-dma
22432 @itemx -munsafe-dma
22433 @opindex msafe-dma
22434 @opindex munsafe-dma
22436 Instructions that initiate or test completion of DMA must not be
22437 reordered with respect to loads and stores of the memory that is being
22438 accessed.
22439 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
22440 memory accesses, but that can lead to inefficient code in places where the
22441 memory is known to not change.  Rather than mark the memory as volatile,
22442 you can use @option{-msafe-dma} to tell the compiler to treat
22443 the DMA instructions as potentially affecting all memory.  
22445 @item -mbranch-hints
22446 @opindex mbranch-hints
22448 By default, GCC generates a branch hint instruction to avoid
22449 pipeline stalls for always-taken or probably-taken branches.  A hint
22450 is not generated closer than 8 instructions away from its branch.
22451 There is little reason to disable them, except for debugging purposes,
22452 or to make an object a little bit smaller.
22454 @item -msmall-mem
22455 @itemx -mlarge-mem
22456 @opindex msmall-mem
22457 @opindex mlarge-mem
22459 By default, GCC generates code assuming that addresses are never larger
22460 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
22461 a full 32-bit address.
22463 @item -mstdmain
22464 @opindex mstdmain
22466 By default, GCC links against startup code that assumes the SPU-style
22467 main function interface (which has an unconventional parameter list).
22468 With @option{-mstdmain}, GCC links your program against startup
22469 code that assumes a C99-style interface to @code{main}, including a
22470 local copy of @code{argv} strings.
22472 @item -mfixed-range=@var{register-range}
22473 @opindex mfixed-range
22474 Generate code treating the given register range as fixed registers.
22475 A fixed register is one that the register allocator cannot use.  This is
22476 useful when compiling kernel code.  A register range is specified as
22477 two registers separated by a dash.  Multiple register ranges can be
22478 specified separated by a comma.
22480 @item -mea32
22481 @itemx -mea64
22482 @opindex mea32
22483 @opindex mea64
22484 Compile code assuming that pointers to the PPU address space accessed
22485 via the @code{__ea} named address space qualifier are either 32 or 64
22486 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
22487 all object code in an executable must be compiled with the same setting.
22489 @item -maddress-space-conversion
22490 @itemx -mno-address-space-conversion
22491 @opindex maddress-space-conversion
22492 @opindex mno-address-space-conversion
22493 Allow/disallow treating the @code{__ea} address space as superset
22494 of the generic address space.  This enables explicit type casts
22495 between @code{__ea} and generic pointer as well as implicit
22496 conversions of generic pointers to @code{__ea} pointers.  The
22497 default is to allow address space pointer conversions.
22499 @item -mcache-size=@var{cache-size}
22500 @opindex mcache-size
22501 This option controls the version of libgcc that the compiler links to an
22502 executable and selects a software-managed cache for accessing variables
22503 in the @code{__ea} address space with a particular cache size.  Possible
22504 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
22505 and @samp{128}.  The default cache size is 64KB.
22507 @item -matomic-updates
22508 @itemx -mno-atomic-updates
22509 @opindex matomic-updates
22510 @opindex mno-atomic-updates
22511 This option controls the version of libgcc that the compiler links to an
22512 executable and selects whether atomic updates to the software-managed
22513 cache of PPU-side variables are used.  If you use atomic updates, changes
22514 to a PPU variable from SPU code using the @code{__ea} named address space
22515 qualifier do not interfere with changes to other PPU variables residing
22516 in the same cache line from PPU code.  If you do not use atomic updates,
22517 such interference may occur; however, writing back cache lines is
22518 more efficient.  The default behavior is to use atomic updates.
22520 @item -mdual-nops
22521 @itemx -mdual-nops=@var{n}
22522 @opindex mdual-nops
22523 By default, GCC inserts nops to increase dual issue when it expects
22524 it to increase performance.  @var{n} can be a value from 0 to 10.  A
22525 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
22526 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
22528 @item -mhint-max-nops=@var{n}
22529 @opindex mhint-max-nops
22530 Maximum number of nops to insert for a branch hint.  A branch hint must
22531 be at least 8 instructions away from the branch it is affecting.  GCC
22532 inserts up to @var{n} nops to enforce this, otherwise it does not
22533 generate the branch hint.
22535 @item -mhint-max-distance=@var{n}
22536 @opindex mhint-max-distance
22537 The encoding of the branch hint instruction limits the hint to be within
22538 256 instructions of the branch it is affecting.  By default, GCC makes
22539 sure it is within 125.
22541 @item -msafe-hints
22542 @opindex msafe-hints
22543 Work around a hardware bug that causes the SPU to stall indefinitely.
22544 By default, GCC inserts the @code{hbrp} instruction to make sure
22545 this stall won't happen.
22547 @end table
22549 @node System V Options
22550 @subsection Options for System V
22552 These additional options are available on System V Release 4 for
22553 compatibility with other compilers on those systems:
22555 @table @gcctabopt
22556 @item -G
22557 @opindex G
22558 Create a shared object.
22559 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
22561 @item -Qy
22562 @opindex Qy
22563 Identify the versions of each tool used by the compiler, in a
22564 @code{.ident} assembler directive in the output.
22566 @item -Qn
22567 @opindex Qn
22568 Refrain from adding @code{.ident} directives to the output file (this is
22569 the default).
22571 @item -YP,@var{dirs}
22572 @opindex YP
22573 Search the directories @var{dirs}, and no others, for libraries
22574 specified with @option{-l}.
22576 @item -Ym,@var{dir}
22577 @opindex Ym
22578 Look in the directory @var{dir} to find the M4 preprocessor.
22579 The assembler uses this option.
22580 @c This is supposed to go with a -Yd for predefined M4 macro files, but
22581 @c the generic assembler that comes with Solaris takes just -Ym.
22582 @end table
22584 @node TILE-Gx Options
22585 @subsection TILE-Gx Options
22586 @cindex TILE-Gx options
22588 These @samp{-m} options are supported on the TILE-Gx:
22590 @table @gcctabopt
22591 @item -mcmodel=small
22592 @opindex mcmodel=small
22593 Generate code for the small model.  The distance for direct calls is
22594 limited to 500M in either direction.  PC-relative addresses are 32
22595 bits.  Absolute addresses support the full address range.
22597 @item -mcmodel=large
22598 @opindex mcmodel=large
22599 Generate code for the large model.  There is no limitation on call
22600 distance, pc-relative addresses, or absolute addresses.
22602 @item -mcpu=@var{name}
22603 @opindex mcpu
22604 Selects the type of CPU to be targeted.  Currently the only supported
22605 type is @samp{tilegx}.
22607 @item -m32
22608 @itemx -m64
22609 @opindex m32
22610 @opindex m64
22611 Generate code for a 32-bit or 64-bit environment.  The 32-bit
22612 environment sets int, long, and pointer to 32 bits.  The 64-bit
22613 environment sets int to 32 bits and long and pointer to 64 bits.
22615 @item -mbig-endian
22616 @itemx -mlittle-endian
22617 @opindex mbig-endian
22618 @opindex mlittle-endian
22619 Generate code in big/little endian mode, respectively.
22620 @end table
22622 @node TILEPro Options
22623 @subsection TILEPro Options
22624 @cindex TILEPro options
22626 These @samp{-m} options are supported on the TILEPro:
22628 @table @gcctabopt
22629 @item -mcpu=@var{name}
22630 @opindex mcpu
22631 Selects the type of CPU to be targeted.  Currently the only supported
22632 type is @samp{tilepro}.
22634 @item -m32
22635 @opindex m32
22636 Generate code for a 32-bit environment, which sets int, long, and
22637 pointer to 32 bits.  This is the only supported behavior so the flag
22638 is essentially ignored.
22639 @end table
22641 @node V850 Options
22642 @subsection V850 Options
22643 @cindex V850 Options
22645 These @samp{-m} options are defined for V850 implementations:
22647 @table @gcctabopt
22648 @item -mlong-calls
22649 @itemx -mno-long-calls
22650 @opindex mlong-calls
22651 @opindex mno-long-calls
22652 Treat all calls as being far away (near).  If calls are assumed to be
22653 far away, the compiler always loads the function's address into a
22654 register, and calls indirect through the pointer.
22656 @item -mno-ep
22657 @itemx -mep
22658 @opindex mno-ep
22659 @opindex mep
22660 Do not optimize (do optimize) basic blocks that use the same index
22661 pointer 4 or more times to copy pointer into the @code{ep} register, and
22662 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
22663 option is on by default if you optimize.
22665 @item -mno-prolog-function
22666 @itemx -mprolog-function
22667 @opindex mno-prolog-function
22668 @opindex mprolog-function
22669 Do not use (do use) external functions to save and restore registers
22670 at the prologue and epilogue of a function.  The external functions
22671 are slower, but use less code space if more than one function saves
22672 the same number of registers.  The @option{-mprolog-function} option
22673 is on by default if you optimize.
22675 @item -mspace
22676 @opindex mspace
22677 Try to make the code as small as possible.  At present, this just turns
22678 on the @option{-mep} and @option{-mprolog-function} options.
22680 @item -mtda=@var{n}
22681 @opindex mtda
22682 Put static or global variables whose size is @var{n} bytes or less into
22683 the tiny data area that register @code{ep} points to.  The tiny data
22684 area can hold up to 256 bytes in total (128 bytes for byte references).
22686 @item -msda=@var{n}
22687 @opindex msda
22688 Put static or global variables whose size is @var{n} bytes or less into
22689 the small data area that register @code{gp} points to.  The small data
22690 area can hold up to 64 kilobytes.
22692 @item -mzda=@var{n}
22693 @opindex mzda
22694 Put static or global variables whose size is @var{n} bytes or less into
22695 the first 32 kilobytes of memory.
22697 @item -mv850
22698 @opindex mv850
22699 Specify that the target processor is the V850.
22701 @item -mv850e3v5
22702 @opindex mv850e3v5
22703 Specify that the target processor is the V850E3V5.  The preprocessor
22704 constant @code{__v850e3v5__} is defined if this option is used.
22706 @item -mv850e2v4
22707 @opindex mv850e2v4
22708 Specify that the target processor is the V850E3V5.  This is an alias for
22709 the @option{-mv850e3v5} option.
22711 @item -mv850e2v3
22712 @opindex mv850e2v3
22713 Specify that the target processor is the V850E2V3.  The preprocessor
22714 constant @code{__v850e2v3__} is defined if this option is used.
22716 @item -mv850e2
22717 @opindex mv850e2
22718 Specify that the target processor is the V850E2.  The preprocessor
22719 constant @code{__v850e2__} is defined if this option is used.
22721 @item -mv850e1
22722 @opindex mv850e1
22723 Specify that the target processor is the V850E1.  The preprocessor
22724 constants @code{__v850e1__} and @code{__v850e__} are defined if
22725 this option is used.
22727 @item -mv850es
22728 @opindex mv850es
22729 Specify that the target processor is the V850ES.  This is an alias for
22730 the @option{-mv850e1} option.
22732 @item -mv850e
22733 @opindex mv850e
22734 Specify that the target processor is the V850E@.  The preprocessor
22735 constant @code{__v850e__} is defined if this option is used.
22737 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22738 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22739 are defined then a default target processor is chosen and the
22740 relevant @samp{__v850*__} preprocessor constant is defined.
22742 The preprocessor constants @code{__v850} and @code{__v851__} are always
22743 defined, regardless of which processor variant is the target.
22745 @item -mdisable-callt
22746 @itemx -mno-disable-callt
22747 @opindex mdisable-callt
22748 @opindex mno-disable-callt
22749 This option suppresses generation of the @code{CALLT} instruction for the
22750 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22751 architecture.
22753 This option is enabled by default when the RH850 ABI is
22754 in use (see @option{-mrh850-abi}), and disabled by default when the
22755 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22756 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
22758 @item -mrelax
22759 @itemx -mno-relax
22760 @opindex mrelax
22761 @opindex mno-relax
22762 Pass on (or do not pass on) the @option{-mrelax} command-line option
22763 to the assembler.
22765 @item -mlong-jumps
22766 @itemx -mno-long-jumps
22767 @opindex mlong-jumps
22768 @opindex mno-long-jumps
22769 Disable (or re-enable) the generation of PC-relative jump instructions.
22771 @item -msoft-float
22772 @itemx -mhard-float
22773 @opindex msoft-float
22774 @opindex mhard-float
22775 Disable (or re-enable) the generation of hardware floating point
22776 instructions.  This option is only significant when the target
22777 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22778 instructions are being generated then the C preprocessor symbol
22779 @code{__FPU_OK__} is defined, otherwise the symbol
22780 @code{__NO_FPU__} is defined.
22782 @item -mloop
22783 @opindex mloop
22784 Enables the use of the e3v5 LOOP instruction.  The use of this
22785 instruction is not enabled by default when the e3v5 architecture is
22786 selected because its use is still experimental.
22788 @item -mrh850-abi
22789 @itemx -mghs
22790 @opindex mrh850-abi
22791 @opindex mghs
22792 Enables support for the RH850 version of the V850 ABI.  This is the
22793 default.  With this version of the ABI the following rules apply:
22795 @itemize
22796 @item
22797 Integer sized structures and unions are returned via a memory pointer
22798 rather than a register.
22800 @item
22801 Large structures and unions (more than 8 bytes in size) are passed by
22802 value.
22804 @item
22805 Functions are aligned to 16-bit boundaries.
22807 @item
22808 The @option{-m8byte-align} command-line option is supported.
22810 @item
22811 The @option{-mdisable-callt} command-line option is enabled by
22812 default.  The @option{-mno-disable-callt} command-line option is not
22813 supported.
22814 @end itemize
22816 When this version of the ABI is enabled the C preprocessor symbol
22817 @code{__V850_RH850_ABI__} is defined.
22819 @item -mgcc-abi
22820 @opindex mgcc-abi
22821 Enables support for the old GCC version of the V850 ABI.  With this
22822 version of the ABI the following rules apply:
22824 @itemize
22825 @item
22826 Integer sized structures and unions are returned in register @code{r10}.
22828 @item
22829 Large structures and unions (more than 8 bytes in size) are passed by
22830 reference.
22832 @item
22833 Functions are aligned to 32-bit boundaries, unless optimizing for
22834 size.
22836 @item
22837 The @option{-m8byte-align} command-line option is not supported.
22839 @item
22840 The @option{-mdisable-callt} command-line option is supported but not
22841 enabled by default.
22842 @end itemize
22844 When this version of the ABI is enabled the C preprocessor symbol
22845 @code{__V850_GCC_ABI__} is defined.
22847 @item -m8byte-align
22848 @itemx -mno-8byte-align
22849 @opindex m8byte-align
22850 @opindex mno-8byte-align
22851 Enables support for @code{double} and @code{long long} types to be
22852 aligned on 8-byte boundaries.  The default is to restrict the
22853 alignment of all objects to at most 4-bytes.  When
22854 @option{-m8byte-align} is in effect the C preprocessor symbol
22855 @code{__V850_8BYTE_ALIGN__} is defined.
22857 @item -mbig-switch
22858 @opindex mbig-switch
22859 Generate code suitable for big switch tables.  Use this option only if
22860 the assembler/linker complain about out of range branches within a switch
22861 table.
22863 @item -mapp-regs
22864 @opindex mapp-regs
22865 This option causes r2 and r5 to be used in the code generated by
22866 the compiler.  This setting is the default.
22868 @item -mno-app-regs
22869 @opindex mno-app-regs
22870 This option causes r2 and r5 to be treated as fixed registers.
22872 @end table
22874 @node VAX Options
22875 @subsection VAX Options
22876 @cindex VAX options
22878 These @samp{-m} options are defined for the VAX:
22880 @table @gcctabopt
22881 @item -munix
22882 @opindex munix
22883 Do not output certain jump instructions (@code{aobleq} and so on)
22884 that the Unix assembler for the VAX cannot handle across long
22885 ranges.
22887 @item -mgnu
22888 @opindex mgnu
22889 Do output those jump instructions, on the assumption that the
22890 GNU assembler is being used.
22892 @item -mg
22893 @opindex mg
22894 Output code for G-format floating-point numbers instead of D-format.
22895 @end table
22897 @node Visium Options
22898 @subsection Visium Options
22899 @cindex Visium options
22901 @table @gcctabopt
22903 @item -mdebug
22904 @opindex mdebug
22905 A program which performs file I/O and is destined to run on an MCM target
22906 should be linked with this option.  It causes the libraries libc.a and
22907 libdebug.a to be linked.  The program should be run on the target under
22908 the control of the GDB remote debugging stub.
22910 @item -msim
22911 @opindex msim
22912 A program which performs file I/O and is destined to run on the simulator
22913 should be linked with option.  This causes libraries libc.a and libsim.a to
22914 be linked.
22916 @item -mfpu
22917 @itemx -mhard-float
22918 @opindex mfpu
22919 @opindex mhard-float
22920 Generate code containing floating-point instructions.  This is the
22921 default.
22923 @item -mno-fpu
22924 @itemx -msoft-float
22925 @opindex mno-fpu
22926 @opindex msoft-float
22927 Generate code containing library calls for floating-point.
22929 @option{-msoft-float} changes the calling convention in the output file;
22930 therefore, it is only useful if you compile @emph{all} of a program with
22931 this option.  In particular, you need to compile @file{libgcc.a}, the
22932 library that comes with GCC, with @option{-msoft-float} in order for
22933 this to work.
22935 @item -mcpu=@var{cpu_type}
22936 @opindex mcpu
22937 Set the instruction set, register set, and instruction scheduling parameters
22938 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22939 @samp{mcm}, @samp{gr5} and @samp{gr6}.
22941 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
22943 By default (unless configured otherwise), GCC generates code for the GR5
22944 variant of the Visium architecture.  
22946 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
22947 architecture.  The only difference from GR5 code is that the compiler will
22948 generate block move instructions.
22950 @item -mtune=@var{cpu_type}
22951 @opindex mtune
22952 Set the instruction scheduling parameters for machine type @var{cpu_type},
22953 but do not set the instruction set or register set that the option
22954 @option{-mcpu=@var{cpu_type}} would.
22956 @item -msv-mode
22957 @opindex msv-mode
22958 Generate code for the supervisor mode, where there are no restrictions on
22959 the access to general registers.  This is the default.
22961 @item -muser-mode
22962 @opindex muser-mode
22963 Generate code for the user mode, where the access to some general registers
22964 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
22965 mode; on the GR6, only registers r29 to r31 are affected.
22966 @end table
22968 @node VMS Options
22969 @subsection VMS Options
22971 These @samp{-m} options are defined for the VMS implementations:
22973 @table @gcctabopt
22974 @item -mvms-return-codes
22975 @opindex mvms-return-codes
22976 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22977 condition (e.g.@ error) codes.
22979 @item -mdebug-main=@var{prefix}
22980 @opindex mdebug-main=@var{prefix}
22981 Flag the first routine whose name starts with @var{prefix} as the main
22982 routine for the debugger.
22984 @item -mmalloc64
22985 @opindex mmalloc64
22986 Default to 64-bit memory allocation routines.
22988 @item -mpointer-size=@var{size}
22989 @opindex mpointer-size=@var{size}
22990 Set the default size of pointers. Possible options for @var{size} are
22991 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22992 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22993 The later option disables @code{pragma pointer_size}.
22994 @end table
22996 @node VxWorks Options
22997 @subsection VxWorks Options
22998 @cindex VxWorks Options
23000 The options in this section are defined for all VxWorks targets.
23001 Options specific to the target hardware are listed with the other
23002 options for that target.
23004 @table @gcctabopt
23005 @item -mrtp
23006 @opindex mrtp
23007 GCC can generate code for both VxWorks kernels and real time processes
23008 (RTPs).  This option switches from the former to the latter.  It also
23009 defines the preprocessor macro @code{__RTP__}.
23011 @item -non-static
23012 @opindex non-static
23013 Link an RTP executable against shared libraries rather than static
23014 libraries.  The options @option{-static} and @option{-shared} can
23015 also be used for RTPs (@pxref{Link Options}); @option{-static}
23016 is the default.
23018 @item -Bstatic
23019 @itemx -Bdynamic
23020 @opindex Bstatic
23021 @opindex Bdynamic
23022 These options are passed down to the linker.  They are defined for
23023 compatibility with Diab.
23025 @item -Xbind-lazy
23026 @opindex Xbind-lazy
23027 Enable lazy binding of function calls.  This option is equivalent to
23028 @option{-Wl,-z,now} and is defined for compatibility with Diab.
23030 @item -Xbind-now
23031 @opindex Xbind-now
23032 Disable lazy binding of function calls.  This option is the default and
23033 is defined for compatibility with Diab.
23034 @end table
23036 @node x86 Options
23037 @subsection x86 Options
23038 @cindex x86 Options
23040 These @samp{-m} options are defined for the x86 family of computers.
23042 @table @gcctabopt
23044 @item -march=@var{cpu-type}
23045 @opindex march
23046 Generate instructions for the machine type @var{cpu-type}.  In contrast to
23047 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
23048 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
23049 to generate code that may not run at all on processors other than the one
23050 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
23051 @option{-mtune=@var{cpu-type}}.
23053 The choices for @var{cpu-type} are:
23055 @table @samp
23056 @item native
23057 This selects the CPU to generate code for at compilation time by determining
23058 the processor type of the compiling machine.  Using @option{-march=native}
23059 enables all instruction subsets supported by the local machine (hence
23060 the result might not run on different machines).  Using @option{-mtune=native}
23061 produces code optimized for the local machine under the constraints
23062 of the selected instruction set.  
23064 @item i386
23065 Original Intel i386 CPU@.
23067 @item i486
23068 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
23070 @item i586
23071 @itemx pentium
23072 Intel Pentium CPU with no MMX support.
23074 @item lakemont
23075 Intel Lakemont MCU, based on Intel Pentium CPU.
23077 @item pentium-mmx
23078 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
23080 @item pentiumpro
23081 Intel Pentium Pro CPU@.
23083 @item i686
23084 When used with @option{-march}, the Pentium Pro
23085 instruction set is used, so the code runs on all i686 family chips.
23086 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
23088 @item pentium2
23089 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
23090 support.
23092 @item pentium3
23093 @itemx pentium3m
23094 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
23095 set support.
23097 @item pentium-m
23098 Intel Pentium M; low-power version of Intel Pentium III CPU
23099 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
23101 @item pentium4
23102 @itemx pentium4m
23103 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
23105 @item prescott
23106 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
23107 set support.
23109 @item nocona
23110 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
23111 SSE2 and SSE3 instruction set support.
23113 @item core2
23114 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
23115 instruction set support.
23117 @item nehalem
23118 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23119 SSE4.1, SSE4.2 and POPCNT instruction set support.
23121 @item westmere
23122 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23123 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
23125 @item sandybridge
23126 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23127 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
23129 @item ivybridge
23130 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
23131 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
23132 instruction set support.
23134 @item haswell
23135 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23136 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23137 BMI, BMI2 and F16C instruction set support.
23139 @item broadwell
23140 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23141 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23142 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
23144 @item skylake
23145 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23146 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23147 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
23148 XSAVES instruction set support.
23150 @item bonnell
23151 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
23152 instruction set support.
23154 @item silvermont
23155 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
23156 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
23158 @item knl
23159 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
23160 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23161 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
23162 AVX512CD instruction set support.
23164 @item skylake-avx512
23165 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
23166 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
23167 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
23168 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
23170 @item k6
23171 AMD K6 CPU with MMX instruction set support.
23173 @item k6-2
23174 @itemx k6-3
23175 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
23177 @item athlon
23178 @itemx athlon-tbird
23179 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
23180 support.
23182 @item athlon-4
23183 @itemx athlon-xp
23184 @itemx athlon-mp
23185 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
23186 instruction set support.
23188 @item k8
23189 @itemx opteron
23190 @itemx athlon64
23191 @itemx athlon-fx
23192 Processors based on the AMD K8 core with x86-64 instruction set support,
23193 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
23194 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
23195 instruction set extensions.)
23197 @item k8-sse3
23198 @itemx opteron-sse3
23199 @itemx athlon64-sse3
23200 Improved versions of AMD K8 cores with SSE3 instruction set support.
23202 @item amdfam10
23203 @itemx barcelona
23204 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
23205 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
23206 instruction set extensions.)
23208 @item bdver1
23209 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
23210 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
23211 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
23212 @item bdver2
23213 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
23214 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
23215 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
23216 extensions.)
23217 @item bdver3
23218 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
23219 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
23220 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
23221 64-bit instruction set extensions.
23222 @item bdver4
23223 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
23224 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
23225 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
23226 SSE4.2, ABM and 64-bit instruction set extensions.
23228 @item znver1
23229 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
23230 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
23231 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
23232 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
23233 instruction set extensions.
23235 @item btver1
23236 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
23237 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
23238 instruction set extensions.)
23240 @item btver2
23241 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
23242 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
23243 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
23245 @item winchip-c6
23246 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
23247 set support.
23249 @item winchip2
23250 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
23251 instruction set support.
23253 @item c3
23254 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
23255 implemented for this chip.)
23257 @item c3-2
23258 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
23259 (No scheduling is
23260 implemented for this chip.)
23262 @item geode
23263 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
23264 @end table
23266 @item -mtune=@var{cpu-type}
23267 @opindex mtune
23268 Tune to @var{cpu-type} everything applicable about the generated code, except
23269 for the ABI and the set of available instructions.  
23270 While picking a specific @var{cpu-type} schedules things appropriately
23271 for that particular chip, the compiler does not generate any code that
23272 cannot run on the default machine type unless you use a
23273 @option{-march=@var{cpu-type}} option.
23274 For example, if GCC is configured for i686-pc-linux-gnu
23275 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
23276 but still runs on i686 machines.
23278 The choices for @var{cpu-type} are the same as for @option{-march}.
23279 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
23281 @table @samp
23282 @item generic
23283 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
23284 If you know the CPU on which your code will run, then you should use
23285 the corresponding @option{-mtune} or @option{-march} option instead of
23286 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
23287 of your application will have, then you should use this option.
23289 As new processors are deployed in the marketplace, the behavior of this
23290 option will change.  Therefore, if you upgrade to a newer version of
23291 GCC, code generation controlled by this option will change to reflect
23292 the processors
23293 that are most common at the time that version of GCC is released.
23295 There is no @option{-march=generic} option because @option{-march}
23296 indicates the instruction set the compiler can use, and there is no
23297 generic instruction set applicable to all processors.  In contrast,
23298 @option{-mtune} indicates the processor (or, in this case, collection of
23299 processors) for which the code is optimized.
23301 @item intel
23302 Produce code optimized for the most current Intel processors, which are
23303 Haswell and Silvermont for this version of GCC.  If you know the CPU
23304 on which your code will run, then you should use the corresponding
23305 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
23306 But, if you want your application performs better on both Haswell and
23307 Silvermont, then you should use this option.
23309 As new Intel processors are deployed in the marketplace, the behavior of
23310 this option will change.  Therefore, if you upgrade to a newer version of
23311 GCC, code generation controlled by this option will change to reflect
23312 the most current Intel processors at the time that version of GCC is
23313 released.
23315 There is no @option{-march=intel} option because @option{-march} indicates
23316 the instruction set the compiler can use, and there is no common
23317 instruction set applicable to all processors.  In contrast,
23318 @option{-mtune} indicates the processor (or, in this case, collection of
23319 processors) for which the code is optimized.
23320 @end table
23322 @item -mcpu=@var{cpu-type}
23323 @opindex mcpu
23324 A deprecated synonym for @option{-mtune}.
23326 @item -mfpmath=@var{unit}
23327 @opindex mfpmath
23328 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
23329 for @var{unit} are:
23331 @table @samp
23332 @item 387
23333 Use the standard 387 floating-point coprocessor present on the majority of chips and
23334 emulated otherwise.  Code compiled with this option runs almost everywhere.
23335 The temporary results are computed in 80-bit precision instead of the precision
23336 specified by the type, resulting in slightly different results compared to most
23337 of other chips.  See @option{-ffloat-store} for more detailed description.
23339 This is the default choice for x86-32 targets.
23341 @item sse
23342 Use scalar floating-point instructions present in the SSE instruction set.
23343 This instruction set is supported by Pentium III and newer chips,
23344 and in the AMD line
23345 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
23346 instruction set supports only single-precision arithmetic, thus the double and
23347 extended-precision arithmetic are still done using 387.  A later version, present
23348 only in Pentium 4 and AMD x86-64 chips, supports double-precision
23349 arithmetic too.
23351 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
23352 or @option{-msse2} switches to enable SSE extensions and make this option
23353 effective.  For the x86-64 compiler, these extensions are enabled by default.
23355 The resulting code should be considerably faster in the majority of cases and avoid
23356 the numerical instability problems of 387 code, but may break some existing
23357 code that expects temporaries to be 80 bits.
23359 This is the default choice for the x86-64 compiler.
23361 @item sse,387
23362 @itemx sse+387
23363 @itemx both
23364 Attempt to utilize both instruction sets at once.  This effectively doubles the
23365 amount of available registers, and on chips with separate execution units for
23366 387 and SSE the execution resources too.  Use this option with care, as it is
23367 still experimental, because the GCC register allocator does not model separate
23368 functional units well, resulting in unstable performance.
23369 @end table
23371 @item -masm=@var{dialect}
23372 @opindex masm=@var{dialect}
23373 Output assembly instructions using selected @var{dialect}.  Also affects
23374 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
23375 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
23376 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
23377 not support @samp{intel}.
23379 @item -mieee-fp
23380 @itemx -mno-ieee-fp
23381 @opindex mieee-fp
23382 @opindex mno-ieee-fp
23383 Control whether or not the compiler uses IEEE floating-point
23384 comparisons.  These correctly handle the case where the result of a
23385 comparison is unordered.
23387 @item -msoft-float
23388 @opindex msoft-float
23389 Generate output containing library calls for floating point.
23391 @strong{Warning:} the requisite libraries are not part of GCC@.
23392 Normally the facilities of the machine's usual C compiler are used, but
23393 this can't be done directly in cross-compilation.  You must make your
23394 own arrangements to provide suitable library functions for
23395 cross-compilation.
23397 On machines where a function returns floating-point results in the 80387
23398 register stack, some floating-point opcodes may be emitted even if
23399 @option{-msoft-float} is used.
23401 @item -mno-fp-ret-in-387
23402 @opindex mno-fp-ret-in-387
23403 Do not use the FPU registers for return values of functions.
23405 The usual calling convention has functions return values of types
23406 @code{float} and @code{double} in an FPU register, even if there
23407 is no FPU@.  The idea is that the operating system should emulate
23408 an FPU@.
23410 The option @option{-mno-fp-ret-in-387} causes such values to be returned
23411 in ordinary CPU registers instead.
23413 @item -mno-fancy-math-387
23414 @opindex mno-fancy-math-387
23415 Some 387 emulators do not support the @code{sin}, @code{cos} and
23416 @code{sqrt} instructions for the 387.  Specify this option to avoid
23417 generating those instructions.  This option is the default on
23418 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
23419 indicates that the target CPU always has an FPU and so the
23420 instruction does not need emulation.  These
23421 instructions are not generated unless you also use the
23422 @option{-funsafe-math-optimizations} switch.
23424 @item -malign-double
23425 @itemx -mno-align-double
23426 @opindex malign-double
23427 @opindex mno-align-double
23428 Control whether GCC aligns @code{double}, @code{long double}, and
23429 @code{long long} variables on a two-word boundary or a one-word
23430 boundary.  Aligning @code{double} variables on a two-word boundary
23431 produces code that runs somewhat faster on a Pentium at the
23432 expense of more memory.
23434 On x86-64, @option{-malign-double} is enabled by default.
23436 @strong{Warning:} if you use the @option{-malign-double} switch,
23437 structures containing the above types are aligned differently than
23438 the published application binary interface specifications for the x86-32
23439 and are not binary compatible with structures in code compiled
23440 without that switch.
23442 @item -m96bit-long-double
23443 @itemx -m128bit-long-double
23444 @opindex m96bit-long-double
23445 @opindex m128bit-long-double
23446 These switches control the size of @code{long double} type.  The x86-32
23447 application binary interface specifies the size to be 96 bits,
23448 so @option{-m96bit-long-double} is the default in 32-bit mode.
23450 Modern architectures (Pentium and newer) prefer @code{long double}
23451 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
23452 conforming to the ABI, this is not possible.  So specifying
23453 @option{-m128bit-long-double} aligns @code{long double}
23454 to a 16-byte boundary by padding the @code{long double} with an additional
23455 32-bit zero.
23457 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
23458 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
23460 Notice that neither of these options enable any extra precision over the x87
23461 standard of 80 bits for a @code{long double}.
23463 @strong{Warning:} if you override the default value for your target ABI, this
23464 changes the size of 
23465 structures and arrays containing @code{long double} variables,
23466 as well as modifying the function calling convention for functions taking
23467 @code{long double}.  Hence they are not binary-compatible
23468 with code compiled without that switch.
23470 @item -mlong-double-64
23471 @itemx -mlong-double-80
23472 @itemx -mlong-double-128
23473 @opindex mlong-double-64
23474 @opindex mlong-double-80
23475 @opindex mlong-double-128
23476 These switches control the size of @code{long double} type. A size
23477 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23478 type. This is the default for 32-bit Bionic C library.  A size
23479 of 128 bits makes the @code{long double} type equivalent to the
23480 @code{__float128} type. This is the default for 64-bit Bionic C library.
23482 @strong{Warning:} if you override the default value for your target ABI, this
23483 changes the size of
23484 structures and arrays containing @code{long double} variables,
23485 as well as modifying the function calling convention for functions taking
23486 @code{long double}.  Hence they are not binary-compatible
23487 with code compiled without that switch.
23489 @item -malign-data=@var{type}
23490 @opindex malign-data
23491 Control how GCC aligns variables.  Supported values for @var{type} are
23492 @samp{compat} uses increased alignment value compatible uses GCC 4.8
23493 and earlier, @samp{abi} uses alignment value as specified by the
23494 psABI, and @samp{cacheline} uses increased alignment value to match
23495 the cache line size.  @samp{compat} is the default.
23497 @item -mlarge-data-threshold=@var{threshold}
23498 @opindex mlarge-data-threshold
23499 When @option{-mcmodel=medium} is specified, data objects larger than
23500 @var{threshold} are placed in the large data section.  This value must be the
23501 same across all objects linked into the binary, and defaults to 65535.
23503 @item -mrtd
23504 @opindex mrtd
23505 Use a different function-calling convention, in which functions that
23506 take a fixed number of arguments return with the @code{ret @var{num}}
23507 instruction, which pops their arguments while returning.  This saves one
23508 instruction in the caller since there is no need to pop the arguments
23509 there.
23511 You can specify that an individual function is called with this calling
23512 sequence with the function attribute @code{stdcall}.  You can also
23513 override the @option{-mrtd} option by using the function attribute
23514 @code{cdecl}.  @xref{Function Attributes}.
23516 @strong{Warning:} this calling convention is incompatible with the one
23517 normally used on Unix, so you cannot use it if you need to call
23518 libraries compiled with the Unix compiler.
23520 Also, you must provide function prototypes for all functions that
23521 take variable numbers of arguments (including @code{printf});
23522 otherwise incorrect code is generated for calls to those
23523 functions.
23525 In addition, seriously incorrect code results if you call a
23526 function with too many arguments.  (Normally, extra arguments are
23527 harmlessly ignored.)
23529 @item -mregparm=@var{num}
23530 @opindex mregparm
23531 Control how many registers are used to pass integer arguments.  By
23532 default, no registers are used to pass arguments, and at most 3
23533 registers can be used.  You can control this behavior for a specific
23534 function by using the function attribute @code{regparm}.
23535 @xref{Function Attributes}.
23537 @strong{Warning:} if you use this switch, and
23538 @var{num} is nonzero, then you must build all modules with the same
23539 value, including any libraries.  This includes the system libraries and
23540 startup modules.
23542 @item -msseregparm
23543 @opindex msseregparm
23544 Use SSE register passing conventions for float and double arguments
23545 and return values.  You can control this behavior for a specific
23546 function by using the function attribute @code{sseregparm}.
23547 @xref{Function Attributes}.
23549 @strong{Warning:} if you use this switch then you must build all
23550 modules with the same value, including any libraries.  This includes
23551 the system libraries and startup modules.
23553 @item -mvect8-ret-in-mem
23554 @opindex mvect8-ret-in-mem
23555 Return 8-byte vectors in memory instead of MMX registers.  This is the
23556 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
23557 Studio compilers until version 12.  Later compiler versions (starting
23558 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
23559 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
23560 you need to remain compatible with existing code produced by those
23561 previous compiler versions or older versions of GCC@.
23563 @item -mpc32
23564 @itemx -mpc64
23565 @itemx -mpc80
23566 @opindex mpc32
23567 @opindex mpc64
23568 @opindex mpc80
23570 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
23571 is specified, the significands of results of floating-point operations are
23572 rounded to 24 bits (single precision); @option{-mpc64} rounds the
23573 significands of results of floating-point operations to 53 bits (double
23574 precision) and @option{-mpc80} rounds the significands of results of
23575 floating-point operations to 64 bits (extended double precision), which is
23576 the default.  When this option is used, floating-point operations in higher
23577 precisions are not available to the programmer without setting the FPU
23578 control word explicitly.
23580 Setting the rounding of floating-point operations to less than the default
23581 80 bits can speed some programs by 2% or more.  Note that some mathematical
23582 libraries assume that extended-precision (80-bit) floating-point operations
23583 are enabled by default; routines in such libraries could suffer significant
23584 loss of accuracy, typically through so-called ``catastrophic cancellation'',
23585 when this option is used to set the precision to less than extended precision.
23587 @item -mstackrealign
23588 @opindex mstackrealign
23589 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
23590 option generates an alternate prologue and epilogue that realigns the
23591 run-time stack if necessary.  This supports mixing legacy codes that keep
23592 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
23593 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
23594 applicable to individual functions.
23596 @item -mpreferred-stack-boundary=@var{num}
23597 @opindex mpreferred-stack-boundary
23598 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23599 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23600 the default is 4 (16 bytes or 128 bits).
23602 @strong{Warning:} When generating code for the x86-64 architecture with
23603 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
23604 used to keep the stack boundary aligned to 8 byte boundary.  Since
23605 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
23606 intended to be used in controlled environment where stack space is
23607 important limitation.  This option leads to wrong code when functions
23608 compiled with 16 byte stack alignment (such as functions from a standard
23609 library) are called with misaligned stack.  In this case, SSE
23610 instructions may lead to misaligned memory access traps.  In addition,
23611 variable arguments are handled incorrectly for 16 byte aligned
23612 objects (including x87 long double and __int128), leading to wrong
23613 results.  You must build all modules with
23614 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
23615 includes the system libraries and startup modules.
23617 @item -mincoming-stack-boundary=@var{num}
23618 @opindex mincoming-stack-boundary
23619 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
23620 boundary.  If @option{-mincoming-stack-boundary} is not specified,
23621 the one specified by @option{-mpreferred-stack-boundary} is used.
23623 On Pentium and Pentium Pro, @code{double} and @code{long double} values
23624 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
23625 suffer significant run time performance penalties.  On Pentium III, the
23626 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
23627 properly if it is not 16-byte aligned.
23629 To ensure proper alignment of this values on the stack, the stack boundary
23630 must be as aligned as that required by any value stored on the stack.
23631 Further, every function must be generated such that it keeps the stack
23632 aligned.  Thus calling a function compiled with a higher preferred
23633 stack boundary from a function compiled with a lower preferred stack
23634 boundary most likely misaligns the stack.  It is recommended that
23635 libraries that use callbacks always use the default setting.
23637 This extra alignment does consume extra stack space, and generally
23638 increases code size.  Code that is sensitive to stack space usage, such
23639 as embedded systems and operating system kernels, may want to reduce the
23640 preferred alignment to @option{-mpreferred-stack-boundary=2}.
23642 @need 200
23643 @item -mmmx
23644 @opindex mmmx
23645 @need 200
23646 @itemx -msse
23647 @opindex msse
23648 @need 200
23649 @itemx -msse2
23650 @opindex msse2
23651 @need 200
23652 @itemx -msse3
23653 @opindex msse3
23654 @need 200
23655 @itemx -mssse3
23656 @opindex mssse3
23657 @need 200
23658 @itemx -msse4
23659 @opindex msse4
23660 @need 200
23661 @itemx -msse4a
23662 @opindex msse4a
23663 @need 200
23664 @itemx -msse4.1
23665 @opindex msse4.1
23666 @need 200
23667 @itemx -msse4.2
23668 @opindex msse4.2
23669 @need 200
23670 @itemx -mavx
23671 @opindex mavx
23672 @need 200
23673 @itemx -mavx2
23674 @opindex mavx2
23675 @need 200
23676 @itemx -mavx512f
23677 @opindex mavx512f
23678 @need 200
23679 @itemx -mavx512pf
23680 @opindex mavx512pf
23681 @need 200
23682 @itemx -mavx512er
23683 @opindex mavx512er
23684 @need 200
23685 @itemx -mavx512cd
23686 @opindex mavx512cd
23687 @need 200
23688 @itemx -mavx512vl
23689 @opindex mavx512vl
23690 @need 200
23691 @itemx -mavx512bw
23692 @opindex mavx512bw
23693 @need 200
23694 @itemx -mavx512dq
23695 @opindex mavx512dq
23696 @need 200
23697 @itemx -mavx512ifma
23698 @opindex mavx512ifma
23699 @need 200
23700 @itemx -mavx512vbmi
23701 @opindex mavx512vbmi
23702 @need 200
23703 @itemx -msha
23704 @opindex msha
23705 @need 200
23706 @itemx -maes
23707 @opindex maes
23708 @need 200
23709 @itemx -mpclmul
23710 @opindex mpclmul
23711 @need 200
23712 @itemx -mclfushopt
23713 @opindex mclfushopt
23714 @need 200
23715 @itemx -mfsgsbase
23716 @opindex mfsgsbase
23717 @need 200
23718 @itemx -mrdrnd
23719 @opindex mrdrnd
23720 @need 200
23721 @itemx -mf16c
23722 @opindex mf16c
23723 @need 200
23724 @itemx -mfma
23725 @opindex mfma
23726 @need 200
23727 @itemx -mfma4
23728 @opindex mfma4
23729 @need 200
23730 @itemx -mprefetchwt1
23731 @opindex mprefetchwt1
23732 @need 200
23733 @itemx -mxop
23734 @opindex mxop
23735 @need 200
23736 @itemx -mlwp
23737 @opindex mlwp
23738 @need 200
23739 @itemx -m3dnow
23740 @opindex m3dnow
23741 @need 200
23742 @itemx -mpopcnt
23743 @opindex mpopcnt
23744 @need 200
23745 @itemx -mabm
23746 @opindex mabm
23747 @need 200
23748 @itemx -mbmi
23749 @opindex mbmi
23750 @need 200
23751 @itemx -mbmi2
23752 @need 200
23753 @itemx -mlzcnt
23754 @opindex mlzcnt
23755 @need 200
23756 @itemx -mfxsr
23757 @opindex mfxsr
23758 @need 200
23759 @itemx -mxsave
23760 @opindex mxsave
23761 @need 200
23762 @itemx -mxsaveopt
23763 @opindex mxsaveopt
23764 @need 200
23765 @itemx -mxsavec
23766 @opindex mxsavec
23767 @need 200
23768 @itemx -mxsaves
23769 @opindex mxsaves
23770 @need 200
23771 @itemx -mrtm
23772 @opindex mrtm
23773 @need 200
23774 @itemx -mtbm
23775 @opindex mtbm
23776 @need 200
23777 @itemx -mmpx
23778 @opindex mmpx
23779 @need 200
23780 @itemx -mmwaitx
23781 @opindex mmwaitx
23782 @need 200
23783 @itemx -mclzero
23784 @opindex mclzero
23785 @itemx -mpku
23786 @opindex mpku
23787 These switches enable the use of instructions in the MMX, SSE,
23788 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
23789 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
23790 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
23791 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU or 3DNow!@:
23792 extended instruction sets.  Each has a corresponding @option{-mno-} option
23793 to disable use of these instructions.
23795 These extensions are also available as built-in functions: see
23796 @ref{x86 Built-in Functions}, for details of the functions enabled and
23797 disabled by these switches.
23799 To generate SSE/SSE2 instructions automatically from floating-point
23800 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
23802 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
23803 generates new AVX instructions or AVX equivalence for all SSEx instructions
23804 when needed.
23806 These options enable GCC to use these extended instructions in
23807 generated code, even without @option{-mfpmath=sse}.  Applications that
23808 perform run-time CPU detection must compile separate files for each
23809 supported architecture, using the appropriate flags.  In particular,
23810 the file containing the CPU detection code should be compiled without
23811 these options.
23813 @item -mdump-tune-features
23814 @opindex mdump-tune-features
23815 This option instructs GCC to dump the names of the x86 performance 
23816 tuning features and default settings. The names can be used in 
23817 @option{-mtune-ctrl=@var{feature-list}}.
23819 @item -mtune-ctrl=@var{feature-list}
23820 @opindex mtune-ctrl=@var{feature-list}
23821 This option is used to do fine grain control of x86 code generation features.
23822 @var{feature-list} is a comma separated list of @var{feature} names. See also
23823 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
23824 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
23825 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
23826 developers. Using it may lead to code paths not covered by testing and can
23827 potentially result in compiler ICEs or runtime errors.
23829 @item -mno-default
23830 @opindex mno-default
23831 This option instructs GCC to turn off all tunable features. See also 
23832 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
23834 @item -mcld
23835 @opindex mcld
23836 This option instructs GCC to emit a @code{cld} instruction in the prologue
23837 of functions that use string instructions.  String instructions depend on
23838 the DF flag to select between autoincrement or autodecrement mode.  While the
23839 ABI specifies the DF flag to be cleared on function entry, some operating
23840 systems violate this specification by not clearing the DF flag in their
23841 exception dispatchers.  The exception handler can be invoked with the DF flag
23842 set, which leads to wrong direction mode when string instructions are used.
23843 This option can be enabled by default on 32-bit x86 targets by configuring
23844 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
23845 instructions can be suppressed with the @option{-mno-cld} compiler option
23846 in this case.
23848 @item -mvzeroupper
23849 @opindex mvzeroupper
23850 This option instructs GCC to emit a @code{vzeroupper} instruction
23851 before a transfer of control flow out of the function to minimize
23852 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
23853 intrinsics.
23855 @item -mprefer-avx128
23856 @opindex mprefer-avx128
23857 This option instructs GCC to use 128-bit AVX instructions instead of
23858 256-bit AVX instructions in the auto-vectorizer.
23860 @item -mcx16
23861 @opindex mcx16
23862 This option enables GCC to generate @code{CMPXCHG16B} instructions.
23863 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
23864 (or oword) data types.  
23865 This is useful for high-resolution counters that can be updated
23866 by multiple processors (or cores).  This instruction is generated as part of
23867 atomic built-in functions: see @ref{__sync Builtins} or
23868 @ref{__atomic Builtins} for details.
23870 @item -msahf
23871 @opindex msahf
23872 This option enables generation of @code{SAHF} instructions in 64-bit code.
23873 Early Intel Pentium 4 CPUs with Intel 64 support,
23874 prior to the introduction of Pentium 4 G1 step in December 2005,
23875 lacked the @code{LAHF} and @code{SAHF} instructions
23876 which are supported by AMD64.
23877 These are load and store instructions, respectively, for certain status flags.
23878 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
23879 @code{drem}, and @code{remainder} built-in functions;
23880 see @ref{Other Builtins} for details.
23882 @item -mmovbe
23883 @opindex mmovbe
23884 This option enables use of the @code{movbe} instruction to implement
23885 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
23887 @item -mcrc32
23888 @opindex mcrc32
23889 This option enables built-in functions @code{__builtin_ia32_crc32qi},
23890 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
23891 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
23893 @item -mrecip
23894 @opindex mrecip
23895 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
23896 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
23897 with an additional Newton-Raphson step
23898 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
23899 (and their vectorized
23900 variants) for single-precision floating-point arguments.  These instructions
23901 are generated only when @option{-funsafe-math-optimizations} is enabled
23902 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
23903 Note that while the throughput of the sequence is higher than the throughput
23904 of the non-reciprocal instruction, the precision of the sequence can be
23905 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
23907 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
23908 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
23909 combination), and doesn't need @option{-mrecip}.
23911 Also note that GCC emits the above sequence with additional Newton-Raphson step
23912 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
23913 already with @option{-ffast-math} (or the above option combination), and
23914 doesn't need @option{-mrecip}.
23916 @item -mrecip=@var{opt}
23917 @opindex mrecip=opt
23918 This option controls which reciprocal estimate instructions
23919 may be used.  @var{opt} is a comma-separated list of options, which may
23920 be preceded by a @samp{!} to invert the option:
23922 @table @samp
23923 @item all
23924 Enable all estimate instructions.
23926 @item default
23927 Enable the default instructions, equivalent to @option{-mrecip}.
23929 @item none
23930 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23932 @item div
23933 Enable the approximation for scalar division.
23935 @item vec-div
23936 Enable the approximation for vectorized division.
23938 @item sqrt
23939 Enable the approximation for scalar square root.
23941 @item vec-sqrt
23942 Enable the approximation for vectorized square root.
23943 @end table
23945 So, for example, @option{-mrecip=all,!sqrt} enables
23946 all of the reciprocal approximations, except for square root.
23948 @item -mveclibabi=@var{type}
23949 @opindex mveclibabi
23950 Specifies the ABI type to use for vectorizing intrinsics using an
23951 external library.  Supported values for @var{type} are @samp{svml} 
23952 for the Intel short
23953 vector math library and @samp{acml} for the AMD math core library.
23954 To use this option, both @option{-ftree-vectorize} and
23955 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
23956 ABI-compatible library must be specified at link time.
23958 GCC currently emits calls to @code{vmldExp2},
23959 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
23960 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
23961 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
23962 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
23963 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
23964 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
23965 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
23966 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
23967 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
23968 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
23969 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
23970 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
23971 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
23972 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
23973 when @option{-mveclibabi=acml} is used.  
23975 @item -mabi=@var{name}
23976 @opindex mabi
23977 Generate code for the specified calling convention.  Permissible values
23978 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
23979 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
23980 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
23981 You can control this behavior for specific functions by
23982 using the function attributes @code{ms_abi} and @code{sysv_abi}.
23983 @xref{Function Attributes}.
23985 @item -mtls-dialect=@var{type}
23986 @opindex mtls-dialect
23987 Generate code to access thread-local storage using the @samp{gnu} or
23988 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
23989 @samp{gnu2} is more efficient, but it may add compile- and run-time
23990 requirements that cannot be satisfied on all systems.
23992 @item -mpush-args
23993 @itemx -mno-push-args
23994 @opindex mpush-args
23995 @opindex mno-push-args
23996 Use PUSH operations to store outgoing parameters.  This method is shorter
23997 and usually equally fast as method using SUB/MOV operations and is enabled
23998 by default.  In some cases disabling it may improve performance because of
23999 improved scheduling and reduced dependencies.
24001 @item -maccumulate-outgoing-args
24002 @opindex maccumulate-outgoing-args
24003 If enabled, the maximum amount of space required for outgoing arguments is
24004 computed in the function prologue.  This is faster on most modern CPUs
24005 because of reduced dependencies, improved scheduling and reduced stack usage
24006 when the preferred stack boundary is not equal to 2.  The drawback is a notable
24007 increase in code size.  This switch implies @option{-mno-push-args}.
24009 @item -mthreads
24010 @opindex mthreads
24011 Support thread-safe exception handling on MinGW.  Programs that rely
24012 on thread-safe exception handling must compile and link all code with the
24013 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
24014 @option{-D_MT}; when linking, it links in a special thread helper library
24015 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
24017 @item -mms-bitfields
24018 @itemx -mno-ms-bitfields
24019 @opindex mms-bitfields
24020 @opindex mno-ms-bitfields
24022 Enable/disable bit-field layout compatible with the native Microsoft
24023 Windows compiler.  
24025 If @code{packed} is used on a structure, or if bit-fields are used,
24026 it may be that the Microsoft ABI lays out the structure differently
24027 than the way GCC normally does.  Particularly when moving packed
24028 data between functions compiled with GCC and the native Microsoft compiler
24029 (either via function call or as data in a file), it may be necessary to access
24030 either format.
24032 This option is enabled by default for Microsoft Windows
24033 targets.  This behavior can also be controlled locally by use of variable
24034 or type attributes.  For more information, see @ref{x86 Variable Attributes}
24035 and @ref{x86 Type Attributes}.
24037 The Microsoft structure layout algorithm is fairly simple with the exception
24038 of the bit-field packing.  
24039 The padding and alignment of members of structures and whether a bit-field 
24040 can straddle a storage-unit boundary are determine by these rules:
24042 @enumerate
24043 @item Structure members are stored sequentially in the order in which they are
24044 declared: the first member has the lowest memory address and the last member
24045 the highest.
24047 @item Every data object has an alignment requirement.  The alignment requirement
24048 for all data except structures, unions, and arrays is either the size of the
24049 object or the current packing size (specified with either the
24050 @code{aligned} attribute or the @code{pack} pragma),
24051 whichever is less.  For structures, unions, and arrays,
24052 the alignment requirement is the largest alignment requirement of its members.
24053 Every object is allocated an offset so that:
24055 @smallexample
24056 offset % alignment_requirement == 0
24057 @end smallexample
24059 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
24060 unit if the integral types are the same size and if the next bit-field fits
24061 into the current allocation unit without crossing the boundary imposed by the
24062 common alignment requirements of the bit-fields.
24063 @end enumerate
24065 MSVC interprets zero-length bit-fields in the following ways:
24067 @enumerate
24068 @item If a zero-length bit-field is inserted between two bit-fields that
24069 are normally coalesced, the bit-fields are not coalesced.
24071 For example:
24073 @smallexample
24074 struct
24075  @{
24076    unsigned long bf_1 : 12;
24077    unsigned long : 0;
24078    unsigned long bf_2 : 12;
24079  @} t1;
24080 @end smallexample
24082 @noindent
24083 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
24084 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
24086 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
24087 alignment of the zero-length bit-field is greater than the member that follows it,
24088 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
24090 For example:
24092 @smallexample
24093 struct
24094  @{
24095    char foo : 4;
24096    short : 0;
24097    char bar;
24098  @} t2;
24100 struct
24101  @{
24102    char foo : 4;
24103    short : 0;
24104    double bar;
24105  @} t3;
24106 @end smallexample
24108 @noindent
24109 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
24110 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
24111 bit-field does not affect the alignment of @code{bar} or, as a result, the size
24112 of the structure.
24114 Taking this into account, it is important to note the following:
24116 @enumerate
24117 @item If a zero-length bit-field follows a normal bit-field, the type of the
24118 zero-length bit-field may affect the alignment of the structure as whole. For
24119 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
24120 normal bit-field, and is of type short.
24122 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
24123 still affect the alignment of the structure:
24125 @smallexample
24126 struct
24127  @{
24128    char foo : 6;
24129    long : 0;
24130  @} t4;
24131 @end smallexample
24133 @noindent
24134 Here, @code{t4} takes up 4 bytes.
24135 @end enumerate
24137 @item Zero-length bit-fields following non-bit-field members are ignored:
24139 @smallexample
24140 struct
24141  @{
24142    char foo;
24143    long : 0;
24144    char bar;
24145  @} t5;
24146 @end smallexample
24148 @noindent
24149 Here, @code{t5} takes up 2 bytes.
24150 @end enumerate
24153 @item -mno-align-stringops
24154 @opindex mno-align-stringops
24155 Do not align the destination of inlined string operations.  This switch reduces
24156 code size and improves performance in case the destination is already aligned,
24157 but GCC doesn't know about it.
24159 @item -minline-all-stringops
24160 @opindex minline-all-stringops
24161 By default GCC inlines string operations only when the destination is 
24162 known to be aligned to least a 4-byte boundary.  
24163 This enables more inlining and increases code
24164 size, but may improve performance of code that depends on fast
24165 @code{memcpy}, @code{strlen},
24166 and @code{memset} for short lengths.
24168 @item -minline-stringops-dynamically
24169 @opindex minline-stringops-dynamically
24170 For string operations of unknown size, use run-time checks with
24171 inline code for small blocks and a library call for large blocks.
24173 @item -mstringop-strategy=@var{alg}
24174 @opindex mstringop-strategy=@var{alg}
24175 Override the internal decision heuristic for the particular algorithm to use
24176 for inlining string operations.  The allowed values for @var{alg} are:
24178 @table @samp
24179 @item rep_byte
24180 @itemx rep_4byte
24181 @itemx rep_8byte
24182 Expand using i386 @code{rep} prefix of the specified size.
24184 @item byte_loop
24185 @itemx loop
24186 @itemx unrolled_loop
24187 Expand into an inline loop.
24189 @item libcall
24190 Always use a library call.
24191 @end table
24193 @item -mmemcpy-strategy=@var{strategy}
24194 @opindex mmemcpy-strategy=@var{strategy}
24195 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
24196 should be inlined and what inline algorithm to use when the expected size
24197 of the copy operation is known. @var{strategy} 
24198 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
24199 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
24200 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
24201 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
24202 in the list must be specified in increasing order.  The minimal byte size for 
24203 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
24204 preceding range.
24206 @item -mmemset-strategy=@var{strategy}
24207 @opindex mmemset-strategy=@var{strategy}
24208 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
24209 @code{__builtin_memset} expansion.
24211 @item -momit-leaf-frame-pointer
24212 @opindex momit-leaf-frame-pointer
24213 Don't keep the frame pointer in a register for leaf functions.  This
24214 avoids the instructions to save, set up, and restore frame pointers and
24215 makes an extra register available in leaf functions.  The option
24216 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
24217 which might make debugging harder.
24219 @item -mtls-direct-seg-refs
24220 @itemx -mno-tls-direct-seg-refs
24221 @opindex mtls-direct-seg-refs
24222 Controls whether TLS variables may be accessed with offsets from the
24223 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
24224 or whether the thread base pointer must be added.  Whether or not this
24225 is valid depends on the operating system, and whether it maps the
24226 segment to cover the entire TLS area.
24228 For systems that use the GNU C Library, the default is on.
24230 @item -msse2avx
24231 @itemx -mno-sse2avx
24232 @opindex msse2avx
24233 Specify that the assembler should encode SSE instructions with VEX
24234 prefix.  The option @option{-mavx} turns this on by default.
24236 @item -mfentry
24237 @itemx -mno-fentry
24238 @opindex mfentry
24239 If profiling is active (@option{-pg}), put the profiling
24240 counter call before the prologue.
24241 Note: On x86 architectures the attribute @code{ms_hook_prologue}
24242 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
24244 @item -mrecord-mcount
24245 @itemx -mno-record-mcount
24246 @opindex mrecord-mcount
24247 If profiling is active (@option{-pg}), generate a __mcount_loc section
24248 that contains pointers to each profiling call. This is useful for
24249 automatically patching and out calls.
24251 @item -mnop-mcount
24252 @itemx -mno-nop-mcount
24253 @opindex mnop-mcount
24254 If profiling is active (@option{-pg}), generate the calls to
24255 the profiling functions as nops. This is useful when they
24256 should be patched in later dynamically. This is likely only
24257 useful together with @option{-mrecord-mcount}.
24259 @item -mskip-rax-setup
24260 @itemx -mno-skip-rax-setup
24261 @opindex mskip-rax-setup
24262 When generating code for the x86-64 architecture with SSE extensions
24263 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
24264 register when there are no variable arguments passed in vector registers.
24266 @strong{Warning:} Since RAX register is used to avoid unnecessarily
24267 saving vector registers on stack when passing variable arguments, the
24268 impacts of this option are callees may waste some stack space,
24269 misbehave or jump to a random location.  GCC 4.4 or newer don't have
24270 those issues, regardless the RAX register value.
24272 @item -m8bit-idiv
24273 @itemx -mno-8bit-idiv
24274 @opindex m8bit-idiv
24275 On some processors, like Intel Atom, 8-bit unsigned integer divide is
24276 much faster than 32-bit/64-bit integer divide.  This option generates a
24277 run-time check.  If both dividend and divisor are within range of 0
24278 to 255, 8-bit unsigned integer divide is used instead of
24279 32-bit/64-bit integer divide.
24281 @item -mavx256-split-unaligned-load
24282 @itemx -mavx256-split-unaligned-store
24283 @opindex mavx256-split-unaligned-load
24284 @opindex mavx256-split-unaligned-store
24285 Split 32-byte AVX unaligned load and store.
24287 @item -mstack-protector-guard=@var{guard}
24288 @opindex mstack-protector-guard=@var{guard}
24289 Generate stack protection code using canary at @var{guard}.  Supported
24290 locations are @samp{global} for global canary or @samp{tls} for per-thread
24291 canary in the TLS block (the default).  This option has effect only when
24292 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
24294 @item -mmitigate-rop
24295 @opindex mmitigate-rop
24296 Try to avoid generating code sequences that contain unintended return
24297 opcodes, to mitigate against certain forms of attack. At the moment,
24298 this option is limited in what it can do and should not be relied
24299 on to provide serious protection.
24301 @end table
24303 These @samp{-m} switches are supported in addition to the above
24304 on x86-64 processors in 64-bit environments.
24306 @table @gcctabopt
24307 @item -m32
24308 @itemx -m64
24309 @itemx -mx32
24310 @itemx -m16
24311 @itemx -miamcu
24312 @opindex m32
24313 @opindex m64
24314 @opindex mx32
24315 @opindex m16
24316 @opindex miamcu
24317 Generate code for a 16-bit, 32-bit or 64-bit environment.
24318 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
24319 to 32 bits, and
24320 generates code that runs on any i386 system.
24322 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
24323 types to 64 bits, and generates code for the x86-64 architecture.
24324 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
24325 and @option{-mdynamic-no-pic} options.
24327 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
24328 to 32 bits, and
24329 generates code for the x86-64 architecture.
24331 The @option{-m16} option is the same as @option{-m32}, except for that
24332 it outputs the @code{.code16gcc} assembly directive at the beginning of
24333 the assembly output so that the binary can run in 16-bit mode.
24335 The @option{-miamcu} option generates code which conforms to Intel MCU
24336 psABI.  It requires the @option{-m32} option to be turned on.
24338 @item -mno-red-zone
24339 @opindex mno-red-zone
24340 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
24341 by the x86-64 ABI; it is a 128-byte area beyond the location of the
24342 stack pointer that is not modified by signal or interrupt handlers
24343 and therefore can be used for temporary data without adjusting the stack
24344 pointer.  The flag @option{-mno-red-zone} disables this red zone.
24346 @item -mcmodel=small
24347 @opindex mcmodel=small
24348 Generate code for the small code model: the program and its symbols must
24349 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
24350 Programs can be statically or dynamically linked.  This is the default
24351 code model.
24353 @item -mcmodel=kernel
24354 @opindex mcmodel=kernel
24355 Generate code for the kernel code model.  The kernel runs in the
24356 negative 2 GB of the address space.
24357 This model has to be used for Linux kernel code.
24359 @item -mcmodel=medium
24360 @opindex mcmodel=medium
24361 Generate code for the medium model: the program is linked in the lower 2
24362 GB of the address space.  Small symbols are also placed there.  Symbols
24363 with sizes larger than @option{-mlarge-data-threshold} are put into
24364 large data or BSS sections and can be located above 2GB.  Programs can
24365 be statically or dynamically linked.
24367 @item -mcmodel=large
24368 @opindex mcmodel=large
24369 Generate code for the large model.  This model makes no assumptions
24370 about addresses and sizes of sections.
24372 @item -maddress-mode=long
24373 @opindex maddress-mode=long
24374 Generate code for long address mode.  This is only supported for 64-bit
24375 and x32 environments.  It is the default address mode for 64-bit
24376 environments.
24378 @item -maddress-mode=short
24379 @opindex maddress-mode=short
24380 Generate code for short address mode.  This is only supported for 32-bit
24381 and x32 environments.  It is the default address mode for 32-bit and
24382 x32 environments.
24383 @end table
24385 @node x86 Windows Options
24386 @subsection x86 Windows Options
24387 @cindex x86 Windows Options
24388 @cindex Windows Options for x86
24390 These additional options are available for Microsoft Windows targets:
24392 @table @gcctabopt
24393 @item -mconsole
24394 @opindex mconsole
24395 This option
24396 specifies that a console application is to be generated, by
24397 instructing the linker to set the PE header subsystem type
24398 required for console applications.
24399 This option is available for Cygwin and MinGW targets and is
24400 enabled by default on those targets.
24402 @item -mdll
24403 @opindex mdll
24404 This option is available for Cygwin and MinGW targets.  It
24405 specifies that a DLL---a dynamic link library---is to be
24406 generated, enabling the selection of the required runtime
24407 startup object and entry point.
24409 @item -mnop-fun-dllimport
24410 @opindex mnop-fun-dllimport
24411 This option is available for Cygwin and MinGW targets.  It
24412 specifies that the @code{dllimport} attribute should be ignored.
24414 @item -mthread
24415 @opindex mthread
24416 This option is available for MinGW targets. It specifies
24417 that MinGW-specific thread support is to be used.
24419 @item -municode
24420 @opindex municode
24421 This option is available for MinGW-w64 targets.  It causes
24422 the @code{UNICODE} preprocessor macro to be predefined, and
24423 chooses Unicode-capable runtime startup code.
24425 @item -mwin32
24426 @opindex mwin32
24427 This option is available for Cygwin and MinGW targets.  It
24428 specifies that the typical Microsoft Windows predefined macros are to
24429 be set in the pre-processor, but does not influence the choice
24430 of runtime library/startup code.
24432 @item -mwindows
24433 @opindex mwindows
24434 This option is available for Cygwin and MinGW targets.  It
24435 specifies that a GUI application is to be generated by
24436 instructing the linker to set the PE header subsystem type
24437 appropriately.
24439 @item -fno-set-stack-executable
24440 @opindex fno-set-stack-executable
24441 This option is available for MinGW targets. It specifies that
24442 the executable flag for the stack used by nested functions isn't
24443 set. This is necessary for binaries running in kernel mode of
24444 Microsoft Windows, as there the User32 API, which is used to set executable
24445 privileges, isn't available.
24447 @item -fwritable-relocated-rdata
24448 @opindex fno-writable-relocated-rdata
24449 This option is available for MinGW and Cygwin targets.  It specifies
24450 that relocated-data in read-only section is put into the @code{.data}
24451 section.  This is a necessary for older runtimes not supporting
24452 modification of @code{.rdata} sections for pseudo-relocation.
24454 @item -mpe-aligned-commons
24455 @opindex mpe-aligned-commons
24456 This option is available for Cygwin and MinGW targets.  It
24457 specifies that the GNU extension to the PE file format that
24458 permits the correct alignment of COMMON variables should be
24459 used when generating code.  It is enabled by default if
24460 GCC detects that the target assembler found during configuration
24461 supports the feature.
24462 @end table
24464 See also under @ref{x86 Options} for standard options.
24466 @node Xstormy16 Options
24467 @subsection Xstormy16 Options
24468 @cindex Xstormy16 Options
24470 These options are defined for Xstormy16:
24472 @table @gcctabopt
24473 @item -msim
24474 @opindex msim
24475 Choose startup files and linker script suitable for the simulator.
24476 @end table
24478 @node Xtensa Options
24479 @subsection Xtensa Options
24480 @cindex Xtensa Options
24482 These options are supported for Xtensa targets:
24484 @table @gcctabopt
24485 @item -mconst16
24486 @itemx -mno-const16
24487 @opindex mconst16
24488 @opindex mno-const16
24489 Enable or disable use of @code{CONST16} instructions for loading
24490 constant values.  The @code{CONST16} instruction is currently not a
24491 standard option from Tensilica.  When enabled, @code{CONST16}
24492 instructions are always used in place of the standard @code{L32R}
24493 instructions.  The use of @code{CONST16} is enabled by default only if
24494 the @code{L32R} instruction is not available.
24496 @item -mfused-madd
24497 @itemx -mno-fused-madd
24498 @opindex mfused-madd
24499 @opindex mno-fused-madd
24500 Enable or disable use of fused multiply/add and multiply/subtract
24501 instructions in the floating-point option.  This has no effect if the
24502 floating-point option is not also enabled.  Disabling fused multiply/add
24503 and multiply/subtract instructions forces the compiler to use separate
24504 instructions for the multiply and add/subtract operations.  This may be
24505 desirable in some cases where strict IEEE 754-compliant results are
24506 required: the fused multiply add/subtract instructions do not round the
24507 intermediate result, thereby producing results with @emph{more} bits of
24508 precision than specified by the IEEE standard.  Disabling fused multiply
24509 add/subtract instructions also ensures that the program output is not
24510 sensitive to the compiler's ability to combine multiply and add/subtract
24511 operations.
24513 @item -mserialize-volatile
24514 @itemx -mno-serialize-volatile
24515 @opindex mserialize-volatile
24516 @opindex mno-serialize-volatile
24517 When this option is enabled, GCC inserts @code{MEMW} instructions before
24518 @code{volatile} memory references to guarantee sequential consistency.
24519 The default is @option{-mserialize-volatile}.  Use
24520 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
24522 @item -mforce-no-pic
24523 @opindex mforce-no-pic
24524 For targets, like GNU/Linux, where all user-mode Xtensa code must be
24525 position-independent code (PIC), this option disables PIC for compiling
24526 kernel code.
24528 @item -mtext-section-literals
24529 @itemx -mno-text-section-literals
24530 @opindex mtext-section-literals
24531 @opindex mno-text-section-literals
24532 These options control the treatment of literal pools.  The default is
24533 @option{-mno-text-section-literals}, which places literals in a separate
24534 section in the output file.  This allows the literal pool to be placed
24535 in a data RAM/ROM, and it also allows the linker to combine literal
24536 pools from separate object files to remove redundant literals and
24537 improve code size.  With @option{-mtext-section-literals}, the literals
24538 are interspersed in the text section in order to keep them as close as
24539 possible to their references.  This may be necessary for large assembly
24540 files.  Literals for each function are placed right before that function.
24542 @item -mauto-litpools
24543 @itemx -mno-auto-litpools
24544 @opindex mauto-litpools
24545 @opindex mno-auto-litpools
24546 These options control the treatment of literal pools.  The default is
24547 @option{-mno-auto-litpools}, which places literals in a separate
24548 section in the output file unless @option{-mtext-section-literals} is
24549 used.  With @option{-mauto-litpools} the literals are interspersed in
24550 the text section by the assembler.  Compiler does not produce explicit
24551 @code{.literal} directives and loads literals into registers with
24552 @code{MOVI} instructions instead of @code{L32R} to let the assembler
24553 do relaxation and place literals as necessary.  This option allows
24554 assembler to create several literal pools per function and assemble
24555 very big functions, which may not be possible with
24556 @option{-mtext-section-literals}.
24558 @item -mtarget-align
24559 @itemx -mno-target-align
24560 @opindex mtarget-align
24561 @opindex mno-target-align
24562 When this option is enabled, GCC instructs the assembler to
24563 automatically align instructions to reduce branch penalties at the
24564 expense of some code density.  The assembler attempts to widen density
24565 instructions to align branch targets and the instructions following call
24566 instructions.  If there are not enough preceding safe density
24567 instructions to align a target, no widening is performed.  The
24568 default is @option{-mtarget-align}.  These options do not affect the
24569 treatment of auto-aligned instructions like @code{LOOP}, which the
24570 assembler always aligns, either by widening density instructions or
24571 by inserting NOP instructions.
24573 @item -mlongcalls
24574 @itemx -mno-longcalls
24575 @opindex mlongcalls
24576 @opindex mno-longcalls
24577 When this option is enabled, GCC instructs the assembler to translate
24578 direct calls to indirect calls unless it can determine that the target
24579 of a direct call is in the range allowed by the call instruction.  This
24580 translation typically occurs for calls to functions in other source
24581 files.  Specifically, the assembler translates a direct @code{CALL}
24582 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
24583 The default is @option{-mno-longcalls}.  This option should be used in
24584 programs where the call target can potentially be out of range.  This
24585 option is implemented in the assembler, not the compiler, so the
24586 assembly code generated by GCC still shows direct call
24587 instructions---look at the disassembled object code to see the actual
24588 instructions.  Note that the assembler uses an indirect call for
24589 every cross-file call, not just those that really are out of range.
24590 @end table
24592 @node zSeries Options
24593 @subsection zSeries Options
24594 @cindex zSeries options
24596 These are listed under @xref{S/390 and zSeries Options}.
24599 @c man end
24601 @node Spec Files
24602 @section Specifying Subprocesses and the Switches to Pass to Them
24603 @cindex Spec Files
24605 @command{gcc} is a driver program.  It performs its job by invoking a
24606 sequence of other programs to do the work of compiling, assembling and
24607 linking.  GCC interprets its command-line parameters and uses these to
24608 deduce which programs it should invoke, and which command-line options
24609 it ought to place on their command lines.  This behavior is controlled
24610 by @dfn{spec strings}.  In most cases there is one spec string for each
24611 program that GCC can invoke, but a few programs have multiple spec
24612 strings to control their behavior.  The spec strings built into GCC can
24613 be overridden by using the @option{-specs=} command-line switch to specify
24614 a spec file.
24616 @dfn{Spec files} are plain-text files that are used to construct spec
24617 strings.  They consist of a sequence of directives separated by blank
24618 lines.  The type of directive is determined by the first non-whitespace
24619 character on the line, which can be one of the following:
24621 @table @code
24622 @item %@var{command}
24623 Issues a @var{command} to the spec file processor.  The commands that can
24624 appear here are:
24626 @table @code
24627 @item %include <@var{file}>
24628 @cindex @code{%include}
24629 Search for @var{file} and insert its text at the current point in the
24630 specs file.
24632 @item %include_noerr <@var{file}>
24633 @cindex @code{%include_noerr}
24634 Just like @samp{%include}, but do not generate an error message if the include
24635 file cannot be found.
24637 @item %rename @var{old_name} @var{new_name}
24638 @cindex @code{%rename}
24639 Rename the spec string @var{old_name} to @var{new_name}.
24641 @end table
24643 @item *[@var{spec_name}]:
24644 This tells the compiler to create, override or delete the named spec
24645 string.  All lines after this directive up to the next directive or
24646 blank line are considered to be the text for the spec string.  If this
24647 results in an empty string then the spec is deleted.  (Or, if the
24648 spec did not exist, then nothing happens.)  Otherwise, if the spec
24649 does not currently exist a new spec is created.  If the spec does
24650 exist then its contents are overridden by the text of this
24651 directive, unless the first character of that text is the @samp{+}
24652 character, in which case the text is appended to the spec.
24654 @item [@var{suffix}]:
24655 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
24656 and up to the next directive or blank line are considered to make up the
24657 spec string for the indicated suffix.  When the compiler encounters an
24658 input file with the named suffix, it processes the spec string in
24659 order to work out how to compile that file.  For example:
24661 @smallexample
24662 .ZZ:
24663 z-compile -input %i
24664 @end smallexample
24666 This says that any input file whose name ends in @samp{.ZZ} should be
24667 passed to the program @samp{z-compile}, which should be invoked with the
24668 command-line switch @option{-input} and with the result of performing the
24669 @samp{%i} substitution.  (See below.)
24671 As an alternative to providing a spec string, the text following a
24672 suffix directive can be one of the following:
24674 @table @code
24675 @item @@@var{language}
24676 This says that the suffix is an alias for a known @var{language}.  This is
24677 similar to using the @option{-x} command-line switch to GCC to specify a
24678 language explicitly.  For example:
24680 @smallexample
24681 .ZZ:
24682 @@c++
24683 @end smallexample
24685 Says that .ZZ files are, in fact, C++ source files.
24687 @item #@var{name}
24688 This causes an error messages saying:
24690 @smallexample
24691 @var{name} compiler not installed on this system.
24692 @end smallexample
24693 @end table
24695 GCC already has an extensive list of suffixes built into it.
24696 This directive adds an entry to the end of the list of suffixes, but
24697 since the list is searched from the end backwards, it is effectively
24698 possible to override earlier entries using this technique.
24700 @end table
24702 GCC has the following spec strings built into it.  Spec files can
24703 override these strings or create their own.  Note that individual
24704 targets can also add their own spec strings to this list.
24706 @smallexample
24707 asm          Options to pass to the assembler
24708 asm_final    Options to pass to the assembler post-processor
24709 cpp          Options to pass to the C preprocessor
24710 cc1          Options to pass to the C compiler
24711 cc1plus      Options to pass to the C++ compiler
24712 endfile      Object files to include at the end of the link
24713 link         Options to pass to the linker
24714 lib          Libraries to include on the command line to the linker
24715 libgcc       Decides which GCC support library to pass to the linker
24716 linker       Sets the name of the linker
24717 predefines   Defines to be passed to the C preprocessor
24718 signed_char  Defines to pass to CPP to say whether @code{char} is signed
24719              by default
24720 startfile    Object files to include at the start of the link
24721 @end smallexample
24723 Here is a small example of a spec file:
24725 @smallexample
24726 %rename lib                 old_lib
24728 *lib:
24729 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
24730 @end smallexample
24732 This example renames the spec called @samp{lib} to @samp{old_lib} and
24733 then overrides the previous definition of @samp{lib} with a new one.
24734 The new definition adds in some extra command-line options before
24735 including the text of the old definition.
24737 @dfn{Spec strings} are a list of command-line options to be passed to their
24738 corresponding program.  In addition, the spec strings can contain
24739 @samp{%}-prefixed sequences to substitute variable text or to
24740 conditionally insert text into the command line.  Using these constructs
24741 it is possible to generate quite complex command lines.
24743 Here is a table of all defined @samp{%}-sequences for spec
24744 strings.  Note that spaces are not generated automatically around the
24745 results of expanding these sequences.  Therefore you can concatenate them
24746 together or combine them with constant text in a single argument.
24748 @table @code
24749 @item %%
24750 Substitute one @samp{%} into the program name or argument.
24752 @item %i
24753 Substitute the name of the input file being processed.
24755 @item %b
24756 Substitute the basename of the input file being processed.
24757 This is the substring up to (and not including) the last period
24758 and not including the directory.
24760 @item %B
24761 This is the same as @samp{%b}, but include the file suffix (text after
24762 the last period).
24764 @item %d
24765 Marks the argument containing or following the @samp{%d} as a
24766 temporary file name, so that that file is deleted if GCC exits
24767 successfully.  Unlike @samp{%g}, this contributes no text to the
24768 argument.
24770 @item %g@var{suffix}
24771 Substitute a file name that has suffix @var{suffix} and is chosen
24772 once per compilation, and mark the argument in the same way as
24773 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
24774 name is now chosen in a way that is hard to predict even when previously
24775 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
24776 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
24777 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
24778 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
24779 was simply substituted with a file name chosen once per compilation,
24780 without regard to any appended suffix (which was therefore treated
24781 just like ordinary text), making such attacks more likely to succeed.
24783 @item %u@var{suffix}
24784 Like @samp{%g}, but generates a new temporary file name
24785 each time it appears instead of once per compilation.
24787 @item %U@var{suffix}
24788 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
24789 new one if there is no such last file name.  In the absence of any
24790 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
24791 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
24792 involves the generation of two distinct file names, one
24793 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
24794 simply substituted with a file name chosen for the previous @samp{%u},
24795 without regard to any appended suffix.
24797 @item %j@var{suffix}
24798 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
24799 writable, and if @option{-save-temps} is not used; 
24800 otherwise, substitute the name
24801 of a temporary file, just like @samp{%u}.  This temporary file is not
24802 meant for communication between processes, but rather as a junk
24803 disposal mechanism.
24805 @item %|@var{suffix}
24806 @itemx %m@var{suffix}
24807 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
24808 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
24809 all.  These are the two most common ways to instruct a program that it
24810 should read from standard input or write to standard output.  If you
24811 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
24812 construct: see for example @file{f/lang-specs.h}.
24814 @item %.@var{SUFFIX}
24815 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
24816 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
24817 terminated by the next space or %.
24819 @item %w
24820 Marks the argument containing or following the @samp{%w} as the
24821 designated output file of this compilation.  This puts the argument
24822 into the sequence of arguments that @samp{%o} substitutes.
24824 @item %o
24825 Substitutes the names of all the output files, with spaces
24826 automatically placed around them.  You should write spaces
24827 around the @samp{%o} as well or the results are undefined.
24828 @samp{%o} is for use in the specs for running the linker.
24829 Input files whose names have no recognized suffix are not compiled
24830 at all, but they are included among the output files, so they are
24831 linked.
24833 @item %O
24834 Substitutes the suffix for object files.  Note that this is
24835 handled specially when it immediately follows @samp{%g, %u, or %U},
24836 because of the need for those to form complete file names.  The
24837 handling is such that @samp{%O} is treated exactly as if it had already
24838 been substituted, except that @samp{%g, %u, and %U} do not currently
24839 support additional @var{suffix} characters following @samp{%O} as they do
24840 following, for example, @samp{.o}.
24842 @item %p
24843 Substitutes the standard macro predefinitions for the
24844 current target machine.  Use this when running @command{cpp}.
24846 @item %P
24847 Like @samp{%p}, but puts @samp{__} before and after the name of each
24848 predefined macro, except for macros that start with @samp{__} or with
24849 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
24852 @item %I
24853 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
24854 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
24855 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
24856 and @option{-imultilib} as necessary.
24858 @item %s
24859 Current argument is the name of a library or startup file of some sort.
24860 Search for that file in a standard list of directories and substitute
24861 the full name found.  The current working directory is included in the
24862 list of directories scanned.
24864 @item %T
24865 Current argument is the name of a linker script.  Search for that file
24866 in the current list of directories to scan for libraries. If the file
24867 is located insert a @option{--script} option into the command line
24868 followed by the full path name found.  If the file is not found then
24869 generate an error message.  Note: the current working directory is not
24870 searched.
24872 @item %e@var{str}
24873 Print @var{str} as an error message.  @var{str} is terminated by a newline.
24874 Use this when inconsistent options are detected.
24876 @item %(@var{name})
24877 Substitute the contents of spec string @var{name} at this point.
24879 @item %x@{@var{option}@}
24880 Accumulate an option for @samp{%X}.
24882 @item %X
24883 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
24884 spec string.
24886 @item %Y
24887 Output the accumulated assembler options specified by @option{-Wa}.
24889 @item %Z
24890 Output the accumulated preprocessor options specified by @option{-Wp}.
24892 @item %a
24893 Process the @code{asm} spec.  This is used to compute the
24894 switches to be passed to the assembler.
24896 @item %A
24897 Process the @code{asm_final} spec.  This is a spec string for
24898 passing switches to an assembler post-processor, if such a program is
24899 needed.
24901 @item %l
24902 Process the @code{link} spec.  This is the spec for computing the
24903 command line passed to the linker.  Typically it makes use of the
24904 @samp{%L %G %S %D and %E} sequences.
24906 @item %D
24907 Dump out a @option{-L} option for each directory that GCC believes might
24908 contain startup files.  If the target supports multilibs then the
24909 current multilib directory is prepended to each of these paths.
24911 @item %L
24912 Process the @code{lib} spec.  This is a spec string for deciding which
24913 libraries are included on the command line to the linker.
24915 @item %G
24916 Process the @code{libgcc} spec.  This is a spec string for deciding
24917 which GCC support library is included on the command line to the linker.
24919 @item %S
24920 Process the @code{startfile} spec.  This is a spec for deciding which
24921 object files are the first ones passed to the linker.  Typically
24922 this might be a file named @file{crt0.o}.
24924 @item %E
24925 Process the @code{endfile} spec.  This is a spec string that specifies
24926 the last object files that are passed to the linker.
24928 @item %C
24929 Process the @code{cpp} spec.  This is used to construct the arguments
24930 to be passed to the C preprocessor.
24932 @item %1
24933 Process the @code{cc1} spec.  This is used to construct the options to be
24934 passed to the actual C compiler (@command{cc1}).
24936 @item %2
24937 Process the @code{cc1plus} spec.  This is used to construct the options to be
24938 passed to the actual C++ compiler (@command{cc1plus}).
24940 @item %*
24941 Substitute the variable part of a matched option.  See below.
24942 Note that each comma in the substituted string is replaced by
24943 a single space.
24945 @item %<@code{S}
24946 Remove all occurrences of @code{-S} from the command line.  Note---this
24947 command is position dependent.  @samp{%} commands in the spec string
24948 before this one see @code{-S}, @samp{%} commands in the spec string
24949 after this one do not.
24951 @item %:@var{function}(@var{args})
24952 Call the named function @var{function}, passing it @var{args}.
24953 @var{args} is first processed as a nested spec string, then split
24954 into an argument vector in the usual fashion.  The function returns
24955 a string which is processed as if it had appeared literally as part
24956 of the current spec.
24958 The following built-in spec functions are provided:
24960 @table @code
24961 @item @code{getenv}
24962 The @code{getenv} spec function takes two arguments: an environment
24963 variable name and a string.  If the environment variable is not
24964 defined, a fatal error is issued.  Otherwise, the return value is the
24965 value of the environment variable concatenated with the string.  For
24966 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
24968 @smallexample
24969 %:getenv(TOPDIR /include)
24970 @end smallexample
24972 expands to @file{/path/to/top/include}.
24974 @item @code{if-exists}
24975 The @code{if-exists} spec function takes one argument, an absolute
24976 pathname to a file.  If the file exists, @code{if-exists} returns the
24977 pathname.  Here is a small example of its usage:
24979 @smallexample
24980 *startfile:
24981 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
24982 @end smallexample
24984 @item @code{if-exists-else}
24985 The @code{if-exists-else} spec function is similar to the @code{if-exists}
24986 spec function, except that it takes two arguments.  The first argument is
24987 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
24988 returns the pathname.  If it does not exist, it returns the second argument.
24989 This way, @code{if-exists-else} can be used to select one file or another,
24990 based on the existence of the first.  Here is a small example of its usage:
24992 @smallexample
24993 *startfile:
24994 crt0%O%s %:if-exists(crti%O%s) \
24995 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
24996 @end smallexample
24998 @item @code{replace-outfile}
24999 The @code{replace-outfile} spec function takes two arguments.  It looks for the
25000 first argument in the outfiles array and replaces it with the second argument.  Here
25001 is a small example of its usage:
25003 @smallexample
25004 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
25005 @end smallexample
25007 @item @code{remove-outfile}
25008 The @code{remove-outfile} spec function takes one argument.  It looks for the
25009 first argument in the outfiles array and removes it.  Here is a small example
25010 its usage:
25012 @smallexample
25013 %:remove-outfile(-lm)
25014 @end smallexample
25016 @item @code{pass-through-libs}
25017 The @code{pass-through-libs} spec function takes any number of arguments.  It
25018 finds any @option{-l} options and any non-options ending in @file{.a} (which it
25019 assumes are the names of linker input library archive files) and returns a
25020 result containing all the found arguments each prepended by
25021 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
25022 intended to be passed to the LTO linker plugin.
25024 @smallexample
25025 %:pass-through-libs(%G %L %G)
25026 @end smallexample
25028 @item @code{print-asm-header}
25029 The @code{print-asm-header} function takes no arguments and simply
25030 prints a banner like:
25032 @smallexample
25033 Assembler options
25034 =================
25036 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
25037 @end smallexample
25039 It is used to separate compiler options from assembler options
25040 in the @option{--target-help} output.
25041 @end table
25043 @item %@{@code{S}@}
25044 Substitutes the @code{-S} switch, if that switch is given to GCC@.
25045 If that switch is not specified, this substitutes nothing.  Note that
25046 the leading dash is omitted when specifying this option, and it is
25047 automatically inserted if the substitution is performed.  Thus the spec
25048 string @samp{%@{foo@}} matches the command-line option @option{-foo}
25049 and outputs the command-line option @option{-foo}.
25051 @item %W@{@code{S}@}
25052 Like %@{@code{S}@} but mark last argument supplied within as a file to be
25053 deleted on failure.
25055 @item %@{@code{S}*@}
25056 Substitutes all the switches specified to GCC whose names start
25057 with @code{-S}, but which also take an argument.  This is used for
25058 switches like @option{-o}, @option{-D}, @option{-I}, etc.
25059 GCC considers @option{-o foo} as being
25060 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
25061 text, including the space.  Thus two arguments are generated.
25063 @item %@{@code{S}*&@code{T}*@}
25064 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
25065 (the order of @code{S} and @code{T} in the spec is not significant).
25066 There can be any number of ampersand-separated variables; for each the
25067 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
25069 @item %@{@code{S}:@code{X}@}
25070 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
25072 @item %@{!@code{S}:@code{X}@}
25073 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
25075 @item %@{@code{S}*:@code{X}@}
25076 Substitutes @code{X} if one or more switches whose names start with
25077 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
25078 once, no matter how many such switches appeared.  However, if @code{%*}
25079 appears somewhere in @code{X}, then @code{X} is substituted once
25080 for each matching switch, with the @code{%*} replaced by the part of
25081 that switch matching the @code{*}.
25083 If @code{%*} appears as the last part of a spec sequence then a space
25084 is added after the end of the last substitution.  If there is more
25085 text in the sequence, however, then a space is not generated.  This
25086 allows the @code{%*} substitution to be used as part of a larger
25087 string.  For example, a spec string like this:
25089 @smallexample
25090 %@{mcu=*:--script=%*/memory.ld@}
25091 @end smallexample
25093 @noindent
25094 when matching an option like @option{-mcu=newchip} produces:
25096 @smallexample
25097 --script=newchip/memory.ld
25098 @end smallexample
25100 @item %@{.@code{S}:@code{X}@}
25101 Substitutes @code{X}, if processing a file with suffix @code{S}.
25103 @item %@{!.@code{S}:@code{X}@}
25104 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
25106 @item %@{,@code{S}:@code{X}@}
25107 Substitutes @code{X}, if processing a file for language @code{S}.
25109 @item %@{!,@code{S}:@code{X}@}
25110 Substitutes @code{X}, if not processing a file for language @code{S}.
25112 @item %@{@code{S}|@code{P}:@code{X}@}
25113 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
25114 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
25115 @code{*} sequences as well, although they have a stronger binding than
25116 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
25117 alternatives must be starred, and only the first matching alternative
25118 is substituted.
25120 For example, a spec string like this:
25122 @smallexample
25123 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
25124 @end smallexample
25126 @noindent
25127 outputs the following command-line options from the following input
25128 command-line options:
25130 @smallexample
25131 fred.c        -foo -baz
25132 jim.d         -bar -boggle
25133 -d fred.c     -foo -baz -boggle
25134 -d jim.d      -bar -baz -boggle
25135 @end smallexample
25137 @item %@{S:X; T:Y; :D@}
25139 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
25140 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
25141 be as many clauses as you need.  This may be combined with @code{.},
25142 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
25145 @end table
25147 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
25148 construct may contain other nested @samp{%} constructs or spaces, or
25149 even newlines.  They are processed as usual, as described above.
25150 Trailing white space in @code{X} is ignored.  White space may also
25151 appear anywhere on the left side of the colon in these constructs,
25152 except between @code{.} or @code{*} and the corresponding word.
25154 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
25155 handled specifically in these constructs.  If another value of
25156 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
25157 @option{-W} switch is found later in the command line, the earlier
25158 switch value is ignored, except with @{@code{S}*@} where @code{S} is
25159 just one letter, which passes all matching options.
25161 The character @samp{|} at the beginning of the predicate text is used to
25162 indicate that a command should be piped to the following command, but
25163 only if @option{-pipe} is specified.
25165 It is built into GCC which switches take arguments and which do not.
25166 (You might think it would be useful to generalize this to allow each
25167 compiler's spec to say which switches take arguments.  But this cannot
25168 be done in a consistent fashion.  GCC cannot even decide which input
25169 files have been specified without knowing which switches take arguments,
25170 and it must know which input files to compile in order to tell which
25171 compilers to run).
25173 GCC also knows implicitly that arguments starting in @option{-l} are to be
25174 treated as compiler output files, and passed to the linker in their
25175 proper position among the other output files.
25177 @node Environment Variables
25178 @section Environment Variables Affecting GCC
25179 @cindex environment variables
25181 @c man begin ENVIRONMENT
25182 This section describes several environment variables that affect how GCC
25183 operates.  Some of them work by specifying directories or prefixes to use
25184 when searching for various kinds of files.  Some are used to specify other
25185 aspects of the compilation environment.
25187 Note that you can also specify places to search using options such as
25188 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
25189 take precedence over places specified using environment variables, which
25190 in turn take precedence over those specified by the configuration of GCC@.
25191 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
25192 GNU Compiler Collection (GCC) Internals}.
25194 @table @env
25195 @item LANG
25196 @itemx LC_CTYPE
25197 @c @itemx LC_COLLATE
25198 @itemx LC_MESSAGES
25199 @c @itemx LC_MONETARY
25200 @c @itemx LC_NUMERIC
25201 @c @itemx LC_TIME
25202 @itemx LC_ALL
25203 @findex LANG
25204 @findex LC_CTYPE
25205 @c @findex LC_COLLATE
25206 @findex LC_MESSAGES
25207 @c @findex LC_MONETARY
25208 @c @findex LC_NUMERIC
25209 @c @findex LC_TIME
25210 @findex LC_ALL
25211 @cindex locale
25212 These environment variables control the way that GCC uses
25213 localization information which allows GCC to work with different
25214 national conventions.  GCC inspects the locale categories
25215 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
25216 so.  These locale categories can be set to any value supported by your
25217 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
25218 Kingdom encoded in UTF-8.
25220 The @env{LC_CTYPE} environment variable specifies character
25221 classification.  GCC uses it to determine the character boundaries in
25222 a string; this is needed for some multibyte encodings that contain quote
25223 and escape characters that are otherwise interpreted as a string
25224 end or escape.
25226 The @env{LC_MESSAGES} environment variable specifies the language to
25227 use in diagnostic messages.
25229 If the @env{LC_ALL} environment variable is set, it overrides the value
25230 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
25231 and @env{LC_MESSAGES} default to the value of the @env{LANG}
25232 environment variable.  If none of these variables are set, GCC
25233 defaults to traditional C English behavior.
25235 @item TMPDIR
25236 @findex TMPDIR
25237 If @env{TMPDIR} is set, it specifies the directory to use for temporary
25238 files.  GCC uses temporary files to hold the output of one stage of
25239 compilation which is to be used as input to the next stage: for example,
25240 the output of the preprocessor, which is the input to the compiler
25241 proper.
25243 @item GCC_COMPARE_DEBUG
25244 @findex GCC_COMPARE_DEBUG
25245 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
25246 @option{-fcompare-debug} to the compiler driver.  See the documentation
25247 of this option for more details.
25249 @item GCC_EXEC_PREFIX
25250 @findex GCC_EXEC_PREFIX
25251 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
25252 names of the subprograms executed by the compiler.  No slash is added
25253 when this prefix is combined with the name of a subprogram, but you can
25254 specify a prefix that ends with a slash if you wish.
25256 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
25257 an appropriate prefix to use based on the pathname it is invoked with.
25259 If GCC cannot find the subprogram using the specified prefix, it
25260 tries looking in the usual places for the subprogram.
25262 The default value of @env{GCC_EXEC_PREFIX} is
25263 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
25264 the installed compiler. In many cases @var{prefix} is the value
25265 of @code{prefix} when you ran the @file{configure} script.
25267 Other prefixes specified with @option{-B} take precedence over this prefix.
25269 This prefix is also used for finding files such as @file{crt0.o} that are
25270 used for linking.
25272 In addition, the prefix is used in an unusual way in finding the
25273 directories to search for header files.  For each of the standard
25274 directories whose name normally begins with @samp{/usr/local/lib/gcc}
25275 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
25276 replacing that beginning with the specified prefix to produce an
25277 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
25278 @file{foo/bar} just before it searches the standard directory 
25279 @file{/usr/local/lib/bar}.
25280 If a standard directory begins with the configured
25281 @var{prefix} then the value of @var{prefix} is replaced by
25282 @env{GCC_EXEC_PREFIX} when looking for header files.
25284 @item COMPILER_PATH
25285 @findex COMPILER_PATH
25286 The value of @env{COMPILER_PATH} is a colon-separated list of
25287 directories, much like @env{PATH}.  GCC tries the directories thus
25288 specified when searching for subprograms, if it can't find the
25289 subprograms using @env{GCC_EXEC_PREFIX}.
25291 @item LIBRARY_PATH
25292 @findex LIBRARY_PATH
25293 The value of @env{LIBRARY_PATH} is a colon-separated list of
25294 directories, much like @env{PATH}.  When configured as a native compiler,
25295 GCC tries the directories thus specified when searching for special
25296 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
25297 using GCC also uses these directories when searching for ordinary
25298 libraries for the @option{-l} option (but directories specified with
25299 @option{-L} come first).
25301 @item LANG
25302 @findex LANG
25303 @cindex locale definition
25304 This variable is used to pass locale information to the compiler.  One way in
25305 which this information is used is to determine the character set to be used
25306 when character literals, string literals and comments are parsed in C and C++.
25307 When the compiler is configured to allow multibyte characters,
25308 the following values for @env{LANG} are recognized:
25310 @table @samp
25311 @item C-JIS
25312 Recognize JIS characters.
25313 @item C-SJIS
25314 Recognize SJIS characters.
25315 @item C-EUCJP
25316 Recognize EUCJP characters.
25317 @end table
25319 If @env{LANG} is not defined, or if it has some other value, then the
25320 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
25321 recognize and translate multibyte characters.
25322 @end table
25324 @noindent
25325 Some additional environment variables affect the behavior of the
25326 preprocessor.
25328 @include cppenv.texi
25330 @c man end
25332 @node Precompiled Headers
25333 @section Using Precompiled Headers
25334 @cindex precompiled headers
25335 @cindex speed of compilation
25337 Often large projects have many header files that are included in every
25338 source file.  The time the compiler takes to process these header files
25339 over and over again can account for nearly all of the time required to
25340 build the project.  To make builds faster, GCC allows you to
25341 @dfn{precompile} a header file.
25343 To create a precompiled header file, simply compile it as you would any
25344 other file, if necessary using the @option{-x} option to make the driver
25345 treat it as a C or C++ header file.  You may want to use a
25346 tool like @command{make} to keep the precompiled header up-to-date when
25347 the headers it contains change.
25349 A precompiled header file is searched for when @code{#include} is
25350 seen in the compilation.  As it searches for the included file
25351 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
25352 compiler looks for a precompiled header in each directory just before it
25353 looks for the include file in that directory.  The name searched for is
25354 the name specified in the @code{#include} with @samp{.gch} appended.  If
25355 the precompiled header file can't be used, it is ignored.
25357 For instance, if you have @code{#include "all.h"}, and you have
25358 @file{all.h.gch} in the same directory as @file{all.h}, then the
25359 precompiled header file is used if possible, and the original
25360 header is used otherwise.
25362 Alternatively, you might decide to put the precompiled header file in a
25363 directory and use @option{-I} to ensure that directory is searched
25364 before (or instead of) the directory containing the original header.
25365 Then, if you want to check that the precompiled header file is always
25366 used, you can put a file of the same name as the original header in this
25367 directory containing an @code{#error} command.
25369 This also works with @option{-include}.  So yet another way to use
25370 precompiled headers, good for projects not designed with precompiled
25371 header files in mind, is to simply take most of the header files used by
25372 a project, include them from another header file, precompile that header
25373 file, and @option{-include} the precompiled header.  If the header files
25374 have guards against multiple inclusion, they are skipped because
25375 they've already been included (in the precompiled header).
25377 If you need to precompile the same header file for different
25378 languages, targets, or compiler options, you can instead make a
25379 @emph{directory} named like @file{all.h.gch}, and put each precompiled
25380 header in the directory, perhaps using @option{-o}.  It doesn't matter
25381 what you call the files in the directory; every precompiled header in
25382 the directory is considered.  The first precompiled header
25383 encountered in the directory that is valid for this compilation is
25384 used; they're searched in no particular order.
25386 There are many other possibilities, limited only by your imagination,
25387 good sense, and the constraints of your build system.
25389 A precompiled header file can be used only when these conditions apply:
25391 @itemize
25392 @item
25393 Only one precompiled header can be used in a particular compilation.
25395 @item
25396 A precompiled header can't be used once the first C token is seen.  You
25397 can have preprocessor directives before a precompiled header; you cannot
25398 include a precompiled header from inside another header.
25400 @item
25401 The precompiled header file must be produced for the same language as
25402 the current compilation.  You can't use a C precompiled header for a C++
25403 compilation.
25405 @item
25406 The precompiled header file must have been produced by the same compiler
25407 binary as the current compilation is using.
25409 @item
25410 Any macros defined before the precompiled header is included must
25411 either be defined in the same way as when the precompiled header was
25412 generated, or must not affect the precompiled header, which usually
25413 means that they don't appear in the precompiled header at all.
25415 The @option{-D} option is one way to define a macro before a
25416 precompiled header is included; using a @code{#define} can also do it.
25417 There are also some options that define macros implicitly, like
25418 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
25419 defined this way.
25421 @item If debugging information is output when using the precompiled
25422 header, using @option{-g} or similar, the same kind of debugging information
25423 must have been output when building the precompiled header.  However,
25424 a precompiled header built using @option{-g} can be used in a compilation
25425 when no debugging information is being output.
25427 @item The same @option{-m} options must generally be used when building
25428 and using the precompiled header.  @xref{Submodel Options},
25429 for any cases where this rule is relaxed.
25431 @item Each of the following options must be the same when building and using
25432 the precompiled header:
25434 @gccoptlist{-fexceptions}
25436 @item
25437 Some other command-line options starting with @option{-f},
25438 @option{-p}, or @option{-O} must be defined in the same way as when
25439 the precompiled header was generated.  At present, it's not clear
25440 which options are safe to change and which are not; the safest choice
25441 is to use exactly the same options when generating and using the
25442 precompiled header.  The following are known to be safe:
25444 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
25445 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
25446 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
25447 -pedantic-errors}
25449 @end itemize
25451 For all of these except the last, the compiler automatically
25452 ignores the precompiled header if the conditions aren't met.  If you
25453 find an option combination that doesn't work and doesn't cause the
25454 precompiled header to be ignored, please consider filing a bug report,
25455 see @ref{Bugs}.
25457 If you do use differing options when generating and using the
25458 precompiled header, the actual behavior is a mixture of the
25459 behavior for the options.  For instance, if you use @option{-g} to
25460 generate the precompiled header but not when using it, you may or may
25461 not get debugging information for routines in the precompiled header.