PR target/79569
[official-gcc.git] / gcc / doc / invoke.texi
blob31d1095856048da446fa47b2a0eb0cc738b250a4
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
219 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
220 -Wno-non-template-friend  -Wold-style-cast @gol
221 -Woverloaded-virtual  -Wno-pmf-conversions @gol
222 -Wsign-promo  -Wvirtual-inheritance}
224 @item Objective-C and Objective-C++ Language Options
225 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
226 Objective-C and Objective-C++ Dialects}.
227 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
228 -fgnu-runtime  -fnext-runtime @gol
229 -fno-nil-receivers @gol
230 -fobjc-abi-version=@var{n} @gol
231 -fobjc-call-cxx-cdtors @gol
232 -fobjc-direct-dispatch @gol
233 -fobjc-exceptions @gol
234 -fobjc-gc @gol
235 -fobjc-nilcheck @gol
236 -fobjc-std=objc1 @gol
237 -fno-local-ivars @gol
238 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
239 -freplace-objc-classes @gol
240 -fzero-link @gol
241 -gen-decls @gol
242 -Wassign-intercept @gol
243 -Wno-protocol  -Wselector @gol
244 -Wstrict-selector-match @gol
245 -Wundeclared-selector}
247 @item Diagnostic Message Formatting Options
248 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
249 @gccoptlist{-fmessage-length=@var{n}  @gol
250 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
251 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
252 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
253 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
254 -fno-show-column}
256 @item Warning Options
257 @xref{Warning Options,,Options to Request or Suppress Warnings}.
258 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
259 -pedantic-errors @gol
260 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
261 -Walloc-zero  -Walloc-size-larger-than=@var{n}
262 -Walloca  -Walloca-larger-than=@var{n} @gol
263 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
264 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
265 -Wno-builtin-declaration-mismatch @gol
266 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
267 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wcast-align  -Wcast-qual  @gol
268 -Wchar-subscripts  -Wclobbered  -Wcomment  -Wconditionally-supported  @gol
269 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
270 -Wdelete-incomplete @gol
271 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
272 -Wdisabled-optimization @gol
273 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
274 -Wno-div-by-zero  -Wdouble-promotion  -Wduplicated-cond @gol
275 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
276 -Werror  -Werror=*  -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
277 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
278 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
279 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
280 -Wformat-y2k  -Wframe-address @gol
281 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
282 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
283 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
284 -Wimplicit-function-declaration  -Wimplicit-int @gol
285 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
286 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
287 -Winvalid-pch  -Wlarger-than=@var{len} @gol
288 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
289 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
290 -Wmisleading-indentation  -Wmissing-braces @gol
291 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
292 -Wno-multichar  -Wnonnull  -Wnonnull-compare @gol
293 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
294 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
295 -Woverride-init-side-effects  -Woverlength-strings @gol
296 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
297 -Wparentheses  -Wno-pedantic-ms-format @gol
298 -Wplacement-new  -Wplacement-new=@var{n} @gol
299 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
300 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
301 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
302 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
303 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
304 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
305 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
306 -Wno-scalar-storage-order @gol
307 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
308 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
309 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
310 -Wstringop-overflow=@var{n} @gol
311 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
312 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
313 -Wmissing-format-attribute  -Wsubobject-linkage @gol
314 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
315 -Wswitch-unreachable  -Wsync-nand @gol
316 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
317 -Wtype-limits  -Wundef @gol
318 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
319 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
320 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
321 -Wunused-parameter  -Wno-unused-result @gol
322 -Wunused-value  -Wunused-variable @gol
323 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
324 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
325 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
326 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
327 -Wzero-as-null-pointer-constant  -Whsa}
329 @item C and Objective-C-only Warning Options
330 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
331 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
332 -Wold-style-declaration  -Wold-style-definition @gol
333 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
334 -Wdeclaration-after-statement  -Wpointer-sign}
336 @item Debugging Options
337 @xref{Debugging Options,,Options for Debugging Your Program}.
338 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
339 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
340 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
341 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
342 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
343 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
344 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
345 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
346 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
347 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
348 -fvar-tracking  -fvar-tracking-assignments}
350 @item Optimization Options
351 @xref{Optimize Options,,Options that Control Optimization}.
352 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
353 -falign-jumps[=@var{n}] @gol
354 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
355 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
356 -fauto-inc-dec  -fbranch-probabilities @gol
357 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
358 -fbtr-bb-exclusive  -fcaller-saves @gol
359 -fcombine-stack-adjustments  -fconserve-stack @gol
360 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
361 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
362 -fcx-limited-range @gol
363 -fdata-sections  -fdce  -fdelayed-branch @gol
364 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
365 -fdevirtualize-at-ltrans  -fdse @gol
366 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
367 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
368 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
369 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
370 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
371 -fif-conversion2  -findirect-inlining @gol
372 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
373 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
374 -fipa-cp-alignment  -fipa-bit-cp @gol
375 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
376 -fira-algorithm=@var{algorithm} @gol
377 -fira-region=@var{region}  -fira-hoist-pressure @gol
378 -fira-loop-pressure  -fno-ira-share-save-slots @gol
379 -fno-ira-share-spill-slots @gol
380 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
381 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
382 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
383 -floop-block  -floop-interchange  -floop-strip-mine @gol
384 -floop-unroll-and-jam  -floop-nest-optimize @gol
385 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
386 -flto-partition=@var{alg}  -fmerge-all-constants @gol
387 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
388 -fmove-loop-invariants  -fno-branch-count-reg @gol
389 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
390 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
391 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
392 -fno-sched-spec  -fno-signed-zeros @gol
393 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
394 -fomit-frame-pointer  -foptimize-sibling-calls @gol
395 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
396 -fprefetch-loop-arrays @gol
397 -fprofile-correction @gol
398 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
399 -fprofile-reorder-functions @gol
400 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
401 -freorder-blocks-algorithm=@var{algorithm} @gol
402 -freorder-blocks-and-partition  -freorder-functions @gol
403 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
404 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
405 -fsched-spec-load  -fsched-spec-load-dangerous @gol
406 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
407 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
408 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
409 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
410 -fschedule-fusion @gol
411 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
412 -fselective-scheduling  -fselective-scheduling2 @gol
413 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
414 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
415 -fsignaling-nans @gol
416 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
417 -fsplit-paths @gol
418 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
419 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
420 -fstrict-overflow  -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
421 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
422 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
423 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
424 -ftree-loop-if-convert  -ftree-loop-im @gol
425 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
426 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
427 -ftree-loop-vectorize @gol
428 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
429 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
430 -ftree-switch-conversion  -ftree-tail-merge @gol
431 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
432 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
433 -funsafe-math-optimizations  -funswitch-loops @gol
434 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
435 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
436 --param @var{name}=@var{value}
437 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
439 @item Program Instrumentation Options
440 @xref{Instrumentation Options,,Program Instrumentation Options}.
441 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
442 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
443 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
444 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
445 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
446 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
447 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
448 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
449 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
450 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
451 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
452 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
453 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
454 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
455 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
456 -fstack-protector-explicit  -fstack-check @gol
457 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
458 -fno-stack-limit  -fsplit-stack @gol
459 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
460 -fvtv-counts  -fvtv-debug @gol
461 -finstrument-functions @gol
462 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
463 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
465 @item Preprocessor Options
466 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
467 @gccoptlist{-A@var{question}=@var{answer} @gol
468 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
469 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
470 -dD  -dI  -dM  -dN  -dU @gol
471 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
472 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
473 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
474 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
475 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
476 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
477 -H  -imacros @var{file}  -include @var{file} @gol
478 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
479 -no-integrated-cpp  -P  -pthread  -remap @gol
480 -traditional  -traditional-cpp  -trigraphs @gol
481 -U@var{macro}  -undef  @gol
482 -Wp,@var{option}  -Xpreprocessor @var{option}}
484 @item Assembler Options
485 @xref{Assembler Options,,Passing Options to the Assembler}.
486 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
488 @item Linker Options
489 @xref{Link Options,,Options for Linking}.
490 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
491 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
492 -s  -static  -static-libgcc  -static-libstdc++ @gol
493 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
494 -static-libmpx  -static-libmpxwrappers @gol
495 -shared  -shared-libgcc  -symbolic @gol
496 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
497 -u @var{symbol}  -z @var{keyword}}
499 @item Directory Options
500 @xref{Directory Options,,Options for Directory Search}.
501 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
502 -idirafter @var{dir} @gol
503 -imacros @var{file}  -imultilib @var{dir} @gol
504 -iplugindir=@var{dir}  -iprefix @var{file} @gol
505 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
506 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
507 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
508 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
510 @item Code Generation Options
511 @xref{Code Gen Options,,Options for Code Generation Conventions}.
512 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
513 -ffixed-@var{reg}  -fexceptions @gol
514 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
515 -fasynchronous-unwind-tables @gol
516 -fno-gnu-unique @gol
517 -finhibit-size-directive  -fno-common  -fno-ident @gol
518 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
519 -fno-jump-tables @gol
520 -frecord-gcc-switches @gol
521 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
522 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
523 -fleading-underscore  -ftls-model=@var{model} @gol
524 -fstack-reuse=@var{reuse_level} @gol
525 -ftrampolines  -ftrapv  -fwrapv @gol
526 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
527 -fstrict-volatile-bitfields  -fsync-libcalls}
529 @item Developer Options
530 @xref{Developer Options,,GCC Developer Options}.
531 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
532 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
533 -fdbg-cnt=@var{counter-value-list} @gol
534 -fdisable-ipa-@var{pass_name} @gol
535 -fdisable-rtl-@var{pass_name} @gol
536 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
537 -fdisable-tree-@var{pass_name} @gol
538 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
539 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
540 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
541 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
542 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
543 -fdump-passes @gol
544 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
545 -fdump-statistics @gol
546 -fdump-final-insns@r{[}=@var{file}@r{]}
547 -fdump-tree-all @gol
548 -fdump-tree-@var{switch} @gol
549 -fdump-tree-@var{switch}-@var{options} @gol
550 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
551 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
552 -fenable-@var{kind}-@var{pass} @gol
553 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
554 -fira-verbose=@var{n} @gol
555 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
556 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
557 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
558 -fprofile-report @gol
559 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
560 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
561 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
562 -fvar-tracking-assignments-toggle  -gtoggle @gol
563 -print-file-name=@var{library}  -print-libgcc-file-name @gol
564 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
565 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
566 -print-sysroot  -print-sysroot-headers-suffix @gol
567 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
569 @item Machine-Dependent Options
570 @xref{Submodel Options,,Machine-Dependent Options}.
571 @c This list is ordered alphanumerically by subsection name.
572 @c Try and put the significant identifier (CPU or system) first,
573 @c so users have a clue at guessing where the ones they want will be.
575 @emph{AArch64 Options}
576 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
577 -mgeneral-regs-only @gol
578 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
579 -mstrict-align @gol
580 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
581 -mtls-dialect=desc  -mtls-dialect=traditional @gol
582 -mtls-size=@var{size} @gol
583 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
584 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
585 -mlow-precision-recip-sqrt  -mno-low-precision-recip-sqrt@gol
586 -mlow-precision-sqrt  -mno-low-precision-sqrt@gol
587 -mlow-precision-div  -mno-low-precision-div @gol
588 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
590 @emph{Adapteva Epiphany Options}
591 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
592 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
593 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
594 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
595 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
596 -msplit-vecmove-early  -m1reg-@var{reg}}
598 @emph{ARC Options}
599 @gccoptlist{-mbarrel-shifter @gol
600 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
601 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
602 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
603 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
604 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
605 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
606 -mlong-calls  -mmedium-calls  -msdata @gol
607 -mvolatile-cache  -mtp-regno=@var{regno} @gol
608 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
609 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
610 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
611 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
612 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
613 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
614 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
615 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
617 @emph{ARM Options}
618 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
619 -mabi=@var{name} @gol
620 -mapcs-stack-check  -mno-apcs-stack-check @gol
621 -mapcs-reentrant  -mno-apcs-reentrant @gol
622 -msched-prolog  -mno-sched-prolog @gol
623 -mlittle-endian  -mbig-endian @gol
624 -mfloat-abi=@var{name} @gol
625 -mfp16-format=@var{name}
626 -mthumb-interwork  -mno-thumb-interwork @gol
627 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
628 -mtune=@var{name}  -mprint-tune-info @gol
629 -mstructure-size-boundary=@var{n} @gol
630 -mabort-on-noreturn @gol
631 -mlong-calls  -mno-long-calls @gol
632 -msingle-pic-base  -mno-single-pic-base @gol
633 -mpic-register=@var{reg} @gol
634 -mnop-fun-dllimport @gol
635 -mpoke-function-name @gol
636 -mthumb  -marm @gol
637 -mtpcs-frame  -mtpcs-leaf-frame @gol
638 -mcaller-super-interworking  -mcallee-super-interworking @gol
639 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
640 -mword-relocations @gol
641 -mfix-cortex-m3-ldrd @gol
642 -munaligned-access @gol
643 -mneon-for-64bits @gol
644 -mslow-flash-data @gol
645 -masm-syntax-unified @gol
646 -mrestrict-it @gol
647 -mpure-code @gol
648 -mcmse}
650 @emph{AVR Options}
651 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
652 -mbranch-cost=@var{cost} @gol
653 -mcall-prologues  -mint8  -mn_flash=@var{size}  -mno-interrupts @gol
654 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
655 -nodevicelib @gol
656 -Waddr-space-convert  -Wmisspelled-isr}
658 @emph{Blackfin Options}
659 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
660 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
661 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
662 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
663 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
664 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
665 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
666 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
667 -micplb}
669 @emph{C6X Options}
670 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
671 -msim  -msdata=@var{sdata-type}}
673 @emph{CRIS Options}
674 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
675 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
676 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
677 -mstack-align  -mdata-align  -mconst-align @gol
678 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
679 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
680 -mmul-bug-workaround  -mno-mul-bug-workaround}
682 @emph{CR16 Options}
683 @gccoptlist{-mmac @gol
684 -mcr16cplus  -mcr16c @gol
685 -msim  -mint32  -mbit-ops
686 -mdata-model=@var{model}}
688 @emph{Darwin Options}
689 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
690 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
691 -client_name  -compatibility_version  -current_version @gol
692 -dead_strip @gol
693 -dependency-file  -dylib_file  -dylinker_install_name @gol
694 -dynamic  -dynamiclib  -exported_symbols_list @gol
695 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
696 -force_flat_namespace  -headerpad_max_install_names @gol
697 -iframework @gol
698 -image_base  -init  -install_name  -keep_private_externs @gol
699 -multi_module  -multiply_defined  -multiply_defined_unused @gol
700 -noall_load   -no_dead_strip_inits_and_terms @gol
701 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
702 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
703 -private_bundle  -read_only_relocs  -sectalign @gol
704 -sectobjectsymbols  -whyload  -seg1addr @gol
705 -sectcreate  -sectobjectsymbols  -sectorder @gol
706 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
707 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
708 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
709 -single_module  -static  -sub_library  -sub_umbrella @gol
710 -twolevel_namespace  -umbrella  -undefined @gol
711 -unexported_symbols_list  -weak_reference_mismatches @gol
712 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
713 -mkernel  -mone-byte-bool}
715 @emph{DEC Alpha Options}
716 @gccoptlist{-mno-fp-regs  -msoft-float @gol
717 -mieee  -mieee-with-inexact  -mieee-conformant @gol
718 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
719 -mtrap-precision=@var{mode}  -mbuild-constants @gol
720 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
721 -mbwx  -mmax  -mfix  -mcix @gol
722 -mfloat-vax  -mfloat-ieee @gol
723 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
724 -msmall-text  -mlarge-text @gol
725 -mmemory-latency=@var{time}}
727 @emph{FR30 Options}
728 @gccoptlist{-msmall-model  -mno-lsim}
730 @emph{FT32 Options}
731 @gccoptlist{-msim  -mlra  -mnodiv}
733 @emph{FRV Options}
734 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
735 -mhard-float  -msoft-float @gol
736 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
737 -mdouble  -mno-double @gol
738 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
739 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
740 -mlinked-fp  -mlong-calls  -malign-labels @gol
741 -mlibrary-pic  -macc-4  -macc-8 @gol
742 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
743 -moptimize-membar  -mno-optimize-membar @gol
744 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
745 -mvliw-branch  -mno-vliw-branch @gol
746 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
747 -mno-nested-cond-exec  -mtomcat-stats @gol
748 -mTLS  -mtls @gol
749 -mcpu=@var{cpu}}
751 @emph{GNU/Linux Options}
752 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
753 -tno-android-cc  -tno-android-ld}
755 @emph{H8/300 Options}
756 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
758 @emph{HPPA Options}
759 @gccoptlist{-march=@var{architecture-type} @gol
760 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
761 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
762 -mfixed-range=@var{register-range} @gol
763 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
764 -mlong-load-store  -mno-disable-fpregs @gol
765 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
766 -mno-jump-in-delay  -mno-long-load-store @gol
767 -mno-portable-runtime  -mno-soft-float @gol
768 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
769 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
770 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
771 -munix=@var{unix-std}  -nolibdld  -static  -threads}
773 @emph{IA-64 Options}
774 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
775 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
776 -mconstant-gp  -mauto-pic  -mfused-madd @gol
777 -minline-float-divide-min-latency @gol
778 -minline-float-divide-max-throughput @gol
779 -mno-inline-float-divide @gol
780 -minline-int-divide-min-latency @gol
781 -minline-int-divide-max-throughput  @gol
782 -mno-inline-int-divide @gol
783 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
784 -mno-inline-sqrt @gol
785 -mdwarf2-asm  -mearly-stop-bits @gol
786 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
787 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
788 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
789 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
790 -msched-spec-ldc  -msched-spec-control-ldc @gol
791 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
792 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
793 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
794 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
796 @emph{LM32 Options}
797 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
798 -msign-extend-enabled  -muser-enabled}
800 @emph{M32R/D Options}
801 @gccoptlist{-m32r2  -m32rx  -m32r @gol
802 -mdebug @gol
803 -malign-loops  -mno-align-loops @gol
804 -missue-rate=@var{number} @gol
805 -mbranch-cost=@var{number} @gol
806 -mmodel=@var{code-size-model-type} @gol
807 -msdata=@var{sdata-type} @gol
808 -mno-flush-func  -mflush-func=@var{name} @gol
809 -mno-flush-trap  -mflush-trap=@var{number} @gol
810 -G @var{num}}
812 @emph{M32C Options}
813 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
815 @emph{M680x0 Options}
816 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
817 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
818 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
819 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
820 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
821 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
822 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
823 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
824 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
826 @emph{MCore Options}
827 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
828 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
829 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
830 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
831 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
833 @emph{MeP Options}
834 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
835 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
836 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
837 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
838 -mtiny=@var{n}}
840 @emph{MicroBlaze Options}
841 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
842 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
843 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
844 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
845 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
847 @emph{MIPS Options}
848 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
849 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
850 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
851 -mips16  -mno-mips16  -mflip-mips16 @gol
852 -minterlink-compressed  -mno-interlink-compressed @gol
853 -minterlink-mips16  -mno-interlink-mips16 @gol
854 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
855 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
856 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
857 -mno-float  -msingle-float  -mdouble-float @gol
858 -modd-spreg  -mno-odd-spreg @gol
859 -mabs=@var{mode}  -mnan=@var{encoding} @gol
860 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
861 -mmcu  -mmno-mcu @gol
862 -meva  -mno-eva @gol
863 -mvirt  -mno-virt @gol
864 -mxpa  -mno-xpa @gol
865 -mmicromips  -mno-micromips @gol
866 -mmsa  -mno-msa @gol
867 -mfpu=@var{fpu-type} @gol
868 -msmartmips  -mno-smartmips @gol
869 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
870 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
871 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
872 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
873 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
874 -membedded-data  -mno-embedded-data @gol
875 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
876 -mcode-readable=@var{setting} @gol
877 -msplit-addresses  -mno-split-addresses @gol
878 -mexplicit-relocs  -mno-explicit-relocs @gol
879 -mcheck-zero-division  -mno-check-zero-division @gol
880 -mdivide-traps  -mdivide-breaks @gol
881 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
882 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
883 -mfix-24k  -mno-fix-24k @gol
884 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
885 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
886 -mfix-vr4120  -mno-fix-vr4120 @gol
887 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
888 -mflush-func=@var{func}  -mno-flush-func @gol
889 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
890 -mcompact-branches=@var{policy} @gol
891 -mfp-exceptions  -mno-fp-exceptions @gol
892 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
893 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
894 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
895 -mframe-header-opt  -mno-frame-header-opt}
897 @emph{MMIX Options}
898 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
899 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
900 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
901 -mno-base-addresses  -msingle-exit  -mno-single-exit}
903 @emph{MN10300 Options}
904 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
905 -mno-am33  -mam33  -mam33-2  -mam34 @gol
906 -mtune=@var{cpu-type} @gol
907 -mreturn-pointer-on-d0 @gol
908 -mno-crt0  -mrelax  -mliw  -msetlb}
910 @emph{Moxie Options}
911 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
913 @emph{MSP430 Options}
914 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
915 -mwarn-mcu @gol
916 -mcode-region=  -mdata-region= @gol
917 -msilicon-errata=  -msilicon-errata-warn= @gol
918 -mhwmult=  -minrt}
920 @emph{NDS32 Options}
921 @gccoptlist{-mbig-endian  -mlittle-endian @gol
922 -mreduced-regs  -mfull-regs @gol
923 -mcmov  -mno-cmov @gol
924 -mperf-ext  -mno-perf-ext @gol
925 -mv3push  -mno-v3push @gol
926 -m16bit  -mno-16bit @gol
927 -misr-vector-size=@var{num} @gol
928 -mcache-block-size=@var{num} @gol
929 -march=@var{arch} @gol
930 -mcmodel=@var{code-model} @gol
931 -mctor-dtor  -mrelax}
933 @emph{Nios II Options}
934 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
935 -mel  -meb @gol
936 -mno-bypass-cache  -mbypass-cache @gol
937 -mno-cache-volatile  -mcache-volatile @gol
938 -mno-fast-sw-div  -mfast-sw-div @gol
939 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
940 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
941 -mcustom-fpu-cfg=@var{name} @gol
942 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
943 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
945 @emph{Nvidia PTX Options}
946 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
948 @emph{PDP-11 Options}
949 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
950 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
951 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
952 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
953 -mbranch-expensive  -mbranch-cheap @gol
954 -munix-asm  -mdec-asm}
956 @emph{picoChip Options}
957 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
958 -msymbol-as-address  -mno-inefficient-warnings}
960 @emph{PowerPC Options}
961 See RS/6000 and PowerPC Options.
963 @emph{RISC-V Options}
964 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
965 -mmemcpy  -mno-memcpy @gol
966 -mplt  -mno-plt @gol
967 -mabi=@var{ABI-string} @gol
968 -mfdiv  -mno-fdiv @gol
969 -mdiv  -mno-div @gol
970 -march=@var{ISA-string} @gol
971 -mtune=@var{processor-string} @gol
972 -msmall-data-limit=@var{N-bytes} @gol
973 -msave-restore  -mno-save-restore @gol
974 -mcmodel=@var{code-model} @gol
975 -mexplicit-relocs  -mno-explicit-relocs @gol}
977 @emph{RL78 Options}
978 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
979 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
980 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
982 @emph{RS/6000 and PowerPC Options}
983 @gccoptlist{-mcpu=@var{cpu-type} @gol
984 -mtune=@var{cpu-type} @gol
985 -mcmodel=@var{code-model} @gol
986 -mpowerpc64 @gol
987 -maltivec  -mno-altivec @gol
988 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
989 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
990 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
991 -mfprnd  -mno-fprnd @gol
992 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
993 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
994 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
995 -malign-power  -malign-natural @gol
996 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
997 -msingle-float  -mdouble-float  -msimple-fpu @gol
998 -mstring  -mno-string  -mupdate  -mno-update @gol
999 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1000 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1001 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1002 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1003 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1004 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1005 -mprioritize-restricted-insns=@var{priority} @gol
1006 -msched-costly-dep=@var{dependence_type} @gol
1007 -minsert-sched-nops=@var{scheme} @gol
1008 -mcall-sysv  -mcall-netbsd @gol
1009 -maix-struct-return  -msvr4-struct-return @gol
1010 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1011 -mblock-move-inline-limit=@var{num} @gol
1012 -misel  -mno-isel @gol
1013 -misel=yes  -misel=no @gol
1014 -mspe  -mno-spe @gol
1015 -mspe=yes  -mspe=no @gol
1016 -mpaired @gol
1017 -mgen-cell-microcode  -mwarn-cell-microcode @gol
1018 -mvrsave  -mno-vrsave @gol
1019 -mmulhw  -mno-mulhw @gol
1020 -mdlmzb  -mno-dlmzb @gol
1021 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1022 -mprototype  -mno-prototype @gol
1023 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1024 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1025 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1026 -mno-recip-precision @gol
1027 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1028 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1029 -msave-toc-indirect  -mno-save-toc-indirect @gol
1030 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1031 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1032 -mquad-memory  -mno-quad-memory @gol
1033 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1034 -mcompat-align-parm  -mno-compat-align-parm @gol
1035 -mupper-regs-df  -mno-upper-regs-df  -mupper-regs-sf  -mno-upper-regs-sf @gol
1036 -mupper-regs-di  -mno-upper-regs-di @gol
1037 -mupper-regs  -mno-upper-regs @gol
1038 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1039 -mgnu-attribute  -mno-gnu-attribute @gol
1040 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1041 -mstack-protector-guard-offset=@var{offset} @gol
1042 -mlra  -mno-lra}
1044 @emph{RX Options}
1045 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1046 -mcpu=@gol
1047 -mbig-endian-data  -mlittle-endian-data @gol
1048 -msmall-data @gol
1049 -msim  -mno-sim@gol
1050 -mas100-syntax  -mno-as100-syntax@gol
1051 -mrelax@gol
1052 -mmax-constant-size=@gol
1053 -mint-register=@gol
1054 -mpid@gol
1055 -mallow-string-insns  -mno-allow-string-insns@gol
1056 -mjsr@gol
1057 -mno-warn-multiple-fast-interrupts@gol
1058 -msave-acc-in-interrupts}
1060 @emph{S/390 and zSeries Options}
1061 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1062 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1063 -mlong-double-64  -mlong-double-128 @gol
1064 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1065 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1066 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1067 -mhtm  -mvx  -mzvector @gol
1068 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1069 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1070 -mhotpatch=@var{halfwords},@var{halfwords}}
1072 @emph{Score Options}
1073 @gccoptlist{-meb  -mel @gol
1074 -mnhwloop @gol
1075 -muls @gol
1076 -mmac @gol
1077 -mscore5  -mscore5u  -mscore7  -mscore7d}
1079 @emph{SH Options}
1080 @gccoptlist{-m1  -m2  -m2e @gol
1081 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1082 -m3  -m3e @gol
1083 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1084 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1085 -mb  -ml  -mdalign  -mrelax @gol
1086 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1087 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1088 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1089 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1090 -maccumulate-outgoing-args @gol
1091 -matomic-model=@var{atomic-model} @gol
1092 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1093 -mcbranch-force-delay-slot @gol
1094 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1095 -mpretend-cmove  -mtas}
1097 @emph{Solaris 2 Options}
1098 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1099 -pthreads}
1101 @emph{SPARC Options}
1102 @gccoptlist{-mcpu=@var{cpu-type} @gol
1103 -mtune=@var{cpu-type} @gol
1104 -mcmodel=@var{code-model} @gol
1105 -mmemory-model=@var{mem-model} @gol
1106 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1107 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1108 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1109 -mhard-quad-float  -msoft-quad-float @gol
1110 -mstack-bias  -mno-stack-bias @gol
1111 -mstd-struct-return  -mno-std-struct-return @gol
1112 -munaligned-doubles  -mno-unaligned-doubles @gol
1113 -muser-mode  -mno-user-mode @gol
1114 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1115 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1116 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1117 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1118 -mfix-at697f  -mfix-ut699 @gol
1119 -mlra  -mno-lra}
1121 @emph{SPU Options}
1122 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1123 -msafe-dma  -munsafe-dma @gol
1124 -mbranch-hints @gol
1125 -msmall-mem  -mlarge-mem  -mstdmain @gol
1126 -mfixed-range=@var{register-range} @gol
1127 -mea32  -mea64 @gol
1128 -maddress-space-conversion  -mno-address-space-conversion @gol
1129 -mcache-size=@var{cache-size} @gol
1130 -matomic-updates  -mno-atomic-updates}
1132 @emph{System V Options}
1133 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1135 @emph{TILE-Gx Options}
1136 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1137 -mcmodel=@var{code-model}}
1139 @emph{TILEPro Options}
1140 @gccoptlist{-mcpu=@var{cpu}  -m32}
1142 @emph{V850 Options}
1143 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1144 -mprolog-function  -mno-prolog-function  -mspace @gol
1145 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1146 -mapp-regs  -mno-app-regs @gol
1147 -mdisable-callt  -mno-disable-callt @gol
1148 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1149 -mv850e  -mv850  -mv850e3v5 @gol
1150 -mloop @gol
1151 -mrelax @gol
1152 -mlong-jumps @gol
1153 -msoft-float @gol
1154 -mhard-float @gol
1155 -mgcc-abi @gol
1156 -mrh850-abi @gol
1157 -mbig-switch}
1159 @emph{VAX Options}
1160 @gccoptlist{-mg  -mgnu  -munix}
1162 @emph{Visium Options}
1163 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1164 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1166 @emph{VMS Options}
1167 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1168 -mpointer-size=@var{size}}
1170 @emph{VxWorks Options}
1171 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1172 -Xbind-lazy  -Xbind-now}
1174 @emph{x86 Options}
1175 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1176 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1177 -mfpmath=@var{unit} @gol
1178 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1179 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1180 -mno-wide-multiply  -mrtd  -malign-double @gol
1181 -mpreferred-stack-boundary=@var{num} @gol
1182 -mincoming-stack-boundary=@var{num} @gol
1183 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1184 -mrecip  -mrecip=@var{opt} @gol
1185 -mvzeroupper  -mprefer-avx128 @gol
1186 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1187 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1188 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1189 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1190 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1191 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1192 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1193 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1194 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1195 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1196 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1197 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1198 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1199 -mregparm=@var{num}  -msseregparm @gol
1200 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1201 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1202 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1203 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1204 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1205 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1206 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1207 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1208 -mmitigate-rop  -mgeneral-regs-only}
1210 @emph{x86 Windows Options}
1211 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1212 -mnop-fun-dllimport  -mthread @gol
1213 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1215 @emph{Xstormy16 Options}
1216 @gccoptlist{-msim}
1218 @emph{Xtensa Options}
1219 @gccoptlist{-mconst16  -mno-const16 @gol
1220 -mfused-madd  -mno-fused-madd @gol
1221 -mforce-no-pic @gol
1222 -mserialize-volatile  -mno-serialize-volatile @gol
1223 -mtext-section-literals  -mno-text-section-literals @gol
1224 -mauto-litpools  -mno-auto-litpools @gol
1225 -mtarget-align  -mno-target-align @gol
1226 -mlongcalls  -mno-longcalls}
1228 @emph{zSeries Options}
1229 See S/390 and zSeries Options.
1230 @end table
1233 @node Overall Options
1234 @section Options Controlling the Kind of Output
1236 Compilation can involve up to four stages: preprocessing, compilation
1237 proper, assembly and linking, always in that order.  GCC is capable of
1238 preprocessing and compiling several files either into several
1239 assembler input files, or into one assembler input file; then each
1240 assembler input file produces an object file, and linking combines all
1241 the object files (those newly compiled, and those specified as input)
1242 into an executable file.
1244 @cindex file name suffix
1245 For any given input file, the file name suffix determines what kind of
1246 compilation is done:
1248 @table @gcctabopt
1249 @item @var{file}.c
1250 C source code that must be preprocessed.
1252 @item @var{file}.i
1253 C source code that should not be preprocessed.
1255 @item @var{file}.ii
1256 C++ source code that should not be preprocessed.
1258 @item @var{file}.m
1259 Objective-C source code.  Note that you must link with the @file{libobjc}
1260 library to make an Objective-C program work.
1262 @item @var{file}.mi
1263 Objective-C source code that should not be preprocessed.
1265 @item @var{file}.mm
1266 @itemx @var{file}.M
1267 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1268 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1269 to a literal capital M@.
1271 @item @var{file}.mii
1272 Objective-C++ source code that should not be preprocessed.
1274 @item @var{file}.h
1275 C, C++, Objective-C or Objective-C++ header file to be turned into a
1276 precompiled header (default), or C, C++ header file to be turned into an
1277 Ada spec (via the @option{-fdump-ada-spec} switch).
1279 @item @var{file}.cc
1280 @itemx @var{file}.cp
1281 @itemx @var{file}.cxx
1282 @itemx @var{file}.cpp
1283 @itemx @var{file}.CPP
1284 @itemx @var{file}.c++
1285 @itemx @var{file}.C
1286 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1287 the last two letters must both be literally @samp{x}.  Likewise,
1288 @samp{.C} refers to a literal capital C@.
1290 @item @var{file}.mm
1291 @itemx @var{file}.M
1292 Objective-C++ source code that must be preprocessed.
1294 @item @var{file}.mii
1295 Objective-C++ source code that should not be preprocessed.
1297 @item @var{file}.hh
1298 @itemx @var{file}.H
1299 @itemx @var{file}.hp
1300 @itemx @var{file}.hxx
1301 @itemx @var{file}.hpp
1302 @itemx @var{file}.HPP
1303 @itemx @var{file}.h++
1304 @itemx @var{file}.tcc
1305 C++ header file to be turned into a precompiled header or Ada spec.
1307 @item @var{file}.f
1308 @itemx @var{file}.for
1309 @itemx @var{file}.ftn
1310 Fixed form Fortran source code that should not be preprocessed.
1312 @item @var{file}.F
1313 @itemx @var{file}.FOR
1314 @itemx @var{file}.fpp
1315 @itemx @var{file}.FPP
1316 @itemx @var{file}.FTN
1317 Fixed form Fortran source code that must be preprocessed (with the traditional
1318 preprocessor).
1320 @item @var{file}.f90
1321 @itemx @var{file}.f95
1322 @itemx @var{file}.f03
1323 @itemx @var{file}.f08
1324 Free form Fortran source code that should not be preprocessed.
1326 @item @var{file}.F90
1327 @itemx @var{file}.F95
1328 @itemx @var{file}.F03
1329 @itemx @var{file}.F08
1330 Free form Fortran source code that must be preprocessed (with the
1331 traditional preprocessor).
1333 @item @var{file}.go
1334 Go source code.
1336 @item @var{file}.brig
1337 BRIG files (binary representation of HSAIL).
1339 @item @var{file}.ads
1340 Ada source code file that contains a library unit declaration (a
1341 declaration of a package, subprogram, or generic, or a generic
1342 instantiation), or a library unit renaming declaration (a package,
1343 generic, or subprogram renaming declaration).  Such files are also
1344 called @dfn{specs}.
1346 @item @var{file}.adb
1347 Ada source code file containing a library unit body (a subprogram or
1348 package body).  Such files are also called @dfn{bodies}.
1350 @c GCC also knows about some suffixes for languages not yet included:
1351 @c Pascal:
1352 @c @var{file}.p
1353 @c @var{file}.pas
1354 @c Ratfor:
1355 @c @var{file}.r
1357 @item @var{file}.s
1358 Assembler code.
1360 @item @var{file}.S
1361 @itemx @var{file}.sx
1362 Assembler code that must be preprocessed.
1364 @item @var{other}
1365 An object file to be fed straight into linking.
1366 Any file name with no recognized suffix is treated this way.
1367 @end table
1369 @opindex x
1370 You can specify the input language explicitly with the @option{-x} option:
1372 @table @gcctabopt
1373 @item -x @var{language}
1374 Specify explicitly the @var{language} for the following input files
1375 (rather than letting the compiler choose a default based on the file
1376 name suffix).  This option applies to all following input files until
1377 the next @option{-x} option.  Possible values for @var{language} are:
1378 @smallexample
1379 c  c-header  cpp-output
1380 c++  c++-header  c++-cpp-output
1381 objective-c  objective-c-header  objective-c-cpp-output
1382 objective-c++ objective-c++-header objective-c++-cpp-output
1383 assembler  assembler-with-cpp
1385 f77  f77-cpp-input f95  f95-cpp-input
1387 brig
1388 @end smallexample
1390 @item -x none
1391 Turn off any specification of a language, so that subsequent files are
1392 handled according to their file name suffixes (as they are if @option{-x}
1393 has not been used at all).
1394 @end table
1396 If you only want some of the stages of compilation, you can use
1397 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1398 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1399 @command{gcc} is to stop.  Note that some combinations (for example,
1400 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1402 @table @gcctabopt
1403 @item -c
1404 @opindex c
1405 Compile or assemble the source files, but do not link.  The linking
1406 stage simply is not done.  The ultimate output is in the form of an
1407 object file for each source file.
1409 By default, the object file name for a source file is made by replacing
1410 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1412 Unrecognized input files, not requiring compilation or assembly, are
1413 ignored.
1415 @item -S
1416 @opindex S
1417 Stop after the stage of compilation proper; do not assemble.  The output
1418 is in the form of an assembler code file for each non-assembler input
1419 file specified.
1421 By default, the assembler file name for a source file is made by
1422 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1424 Input files that don't require compilation are ignored.
1426 @item -E
1427 @opindex E
1428 Stop after the preprocessing stage; do not run the compiler proper.  The
1429 output is in the form of preprocessed source code, which is sent to the
1430 standard output.
1432 Input files that don't require preprocessing are ignored.
1434 @cindex output file option
1435 @item -o @var{file}
1436 @opindex o
1437 Place output in file @var{file}.  This applies to whatever
1438 sort of output is being produced, whether it be an executable file,
1439 an object file, an assembler file or preprocessed C code.
1441 If @option{-o} is not specified, the default is to put an executable
1442 file in @file{a.out}, the object file for
1443 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1444 assembler file in @file{@var{source}.s}, a precompiled header file in
1445 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1446 standard output.
1448 @item -v
1449 @opindex v
1450 Print (on standard error output) the commands executed to run the stages
1451 of compilation.  Also print the version number of the compiler driver
1452 program and of the preprocessor and the compiler proper.
1454 @item -###
1455 @opindex ###
1456 Like @option{-v} except the commands are not executed and arguments
1457 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1458 This is useful for shell scripts to capture the driver-generated command lines.
1460 @item --help
1461 @opindex help
1462 Print (on the standard output) a description of the command-line options
1463 understood by @command{gcc}.  If the @option{-v} option is also specified
1464 then @option{--help} is also passed on to the various processes
1465 invoked by @command{gcc}, so that they can display the command-line options
1466 they accept.  If the @option{-Wextra} option has also been specified
1467 (prior to the @option{--help} option), then command-line options that
1468 have no documentation associated with them are also displayed.
1470 @item --target-help
1471 @opindex target-help
1472 Print (on the standard output) a description of target-specific command-line
1473 options for each tool.  For some targets extra target-specific
1474 information may also be printed.
1476 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1477 Print (on the standard output) a description of the command-line
1478 options understood by the compiler that fit into all specified classes
1479 and qualifiers.  These are the supported classes:
1481 @table @asis
1482 @item @samp{optimizers}
1483 Display all of the optimization options supported by the
1484 compiler.
1486 @item @samp{warnings}
1487 Display all of the options controlling warning messages
1488 produced by the compiler.
1490 @item @samp{target}
1491 Display target-specific options.  Unlike the
1492 @option{--target-help} option however, target-specific options of the
1493 linker and assembler are not displayed.  This is because those
1494 tools do not currently support the extended @option{--help=} syntax.
1496 @item @samp{params}
1497 Display the values recognized by the @option{--param}
1498 option.
1500 @item @var{language}
1501 Display the options supported for @var{language}, where
1502 @var{language} is the name of one of the languages supported in this
1503 version of GCC@.
1505 @item @samp{common}
1506 Display the options that are common to all languages.
1507 @end table
1509 These are the supported qualifiers:
1511 @table @asis
1512 @item @samp{undocumented}
1513 Display only those options that are undocumented.
1515 @item @samp{joined}
1516 Display options taking an argument that appears after an equal
1517 sign in the same continuous piece of text, such as:
1518 @samp{--help=target}.
1520 @item @samp{separate}
1521 Display options taking an argument that appears as a separate word
1522 following the original option, such as: @samp{-o output-file}.
1523 @end table
1525 Thus for example to display all the undocumented target-specific
1526 switches supported by the compiler, use:
1528 @smallexample
1529 --help=target,undocumented
1530 @end smallexample
1532 The sense of a qualifier can be inverted by prefixing it with the
1533 @samp{^} character, so for example to display all binary warning
1534 options (i.e., ones that are either on or off and that do not take an
1535 argument) that have a description, use:
1537 @smallexample
1538 --help=warnings,^joined,^undocumented
1539 @end smallexample
1541 The argument to @option{--help=} should not consist solely of inverted
1542 qualifiers.
1544 Combining several classes is possible, although this usually
1545 restricts the output so much that there is nothing to display.  One
1546 case where it does work, however, is when one of the classes is
1547 @var{target}.  For example, to display all the target-specific
1548 optimization options, use:
1550 @smallexample
1551 --help=target,optimizers
1552 @end smallexample
1554 The @option{--help=} option can be repeated on the command line.  Each
1555 successive use displays its requested class of options, skipping
1556 those that have already been displayed.
1558 If the @option{-Q} option appears on the command line before the
1559 @option{--help=} option, then the descriptive text displayed by
1560 @option{--help=} is changed.  Instead of describing the displayed
1561 options, an indication is given as to whether the option is enabled,
1562 disabled or set to a specific value (assuming that the compiler
1563 knows this at the point where the @option{--help=} option is used).
1565 Here is a truncated example from the ARM port of @command{gcc}:
1567 @smallexample
1568   % gcc -Q -mabi=2 --help=target -c
1569   The following options are target specific:
1570   -mabi=                                2
1571   -mabort-on-noreturn                   [disabled]
1572   -mapcs                                [disabled]
1573 @end smallexample
1575 The output is sensitive to the effects of previous command-line
1576 options, so for example it is possible to find out which optimizations
1577 are enabled at @option{-O2} by using:
1579 @smallexample
1580 -Q -O2 --help=optimizers
1581 @end smallexample
1583 Alternatively you can discover which binary optimizations are enabled
1584 by @option{-O3} by using:
1586 @smallexample
1587 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1588 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1589 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1590 @end smallexample
1592 @item --version
1593 @opindex version
1594 Display the version number and copyrights of the invoked GCC@.
1596 @item -pass-exit-codes
1597 @opindex pass-exit-codes
1598 Normally the @command{gcc} program exits with the code of 1 if any
1599 phase of the compiler returns a non-success return code.  If you specify
1600 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1601 the numerically highest error produced by any phase returning an error
1602 indication.  The C, C++, and Fortran front ends return 4 if an internal
1603 compiler error is encountered.
1605 @item -pipe
1606 @opindex pipe
1607 Use pipes rather than temporary files for communication between the
1608 various stages of compilation.  This fails to work on some systems where
1609 the assembler is unable to read from a pipe; but the GNU assembler has
1610 no trouble.
1612 @item -specs=@var{file}
1613 @opindex specs
1614 Process @var{file} after the compiler reads in the standard @file{specs}
1615 file, in order to override the defaults which the @command{gcc} driver
1616 program uses when determining what switches to pass to @command{cc1},
1617 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1618 @option{-specs=@var{file}} can be specified on the command line, and they
1619 are processed in order, from left to right.  @xref{Spec Files}, for
1620 information about the format of the @var{file}.
1622 @item -wrapper
1623 @opindex wrapper
1624 Invoke all subcommands under a wrapper program.  The name of the
1625 wrapper program and its parameters are passed as a comma separated
1626 list.
1628 @smallexample
1629 gcc -c t.c -wrapper gdb,--args
1630 @end smallexample
1632 @noindent
1633 This invokes all subprograms of @command{gcc} under
1634 @samp{gdb --args}, thus the invocation of @command{cc1} is
1635 @samp{gdb --args cc1 @dots{}}.
1637 @item -fplugin=@var{name}.so
1638 @opindex fplugin
1639 Load the plugin code in file @var{name}.so, assumed to be a
1640 shared object to be dlopen'd by the compiler.  The base name of
1641 the shared object file is used to identify the plugin for the
1642 purposes of argument parsing (See
1643 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1644 Each plugin should define the callback functions specified in the
1645 Plugins API.
1647 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1648 @opindex fplugin-arg
1649 Define an argument called @var{key} with a value of @var{value}
1650 for the plugin called @var{name}.
1652 @item -fdump-ada-spec@r{[}-slim@r{]}
1653 @opindex fdump-ada-spec
1654 For C and C++ source and include files, generate corresponding Ada specs.
1655 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1656 GNAT User's Guide}, which provides detailed documentation on this feature.
1658 @item -fada-spec-parent=@var{unit}
1659 @opindex fada-spec-parent
1660 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1661 Ada specs as child units of parent @var{unit}.
1663 @item -fdump-go-spec=@var{file}
1664 @opindex fdump-go-spec
1665 For input files in any language, generate corresponding Go
1666 declarations in @var{file}.  This generates Go @code{const},
1667 @code{type}, @code{var}, and @code{func} declarations which may be a
1668 useful way to start writing a Go interface to code written in some
1669 other language.
1671 @include @value{srcdir}/../libiberty/at-file.texi
1672 @end table
1674 @node Invoking G++
1675 @section Compiling C++ Programs
1677 @cindex suffixes for C++ source
1678 @cindex C++ source file suffixes
1679 C++ source files conventionally use one of the suffixes @samp{.C},
1680 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1681 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1682 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1683 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1684 files with these names and compiles them as C++ programs even if you
1685 call the compiler the same way as for compiling C programs (usually
1686 with the name @command{gcc}).
1688 @findex g++
1689 @findex c++
1690 However, the use of @command{gcc} does not add the C++ library.
1691 @command{g++} is a program that calls GCC and automatically specifies linking
1692 against the C++ library.  It treats @samp{.c},
1693 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1694 files unless @option{-x} is used.  This program is also useful when
1695 precompiling a C header file with a @samp{.h} extension for use in C++
1696 compilations.  On many systems, @command{g++} is also installed with
1697 the name @command{c++}.
1699 @cindex invoking @command{g++}
1700 When you compile C++ programs, you may specify many of the same
1701 command-line options that you use for compiling programs in any
1702 language; or command-line options meaningful for C and related
1703 languages; or options that are meaningful only for C++ programs.
1704 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1705 explanations of options for languages related to C@.
1706 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1707 explanations of options that are meaningful only for C++ programs.
1709 @node C Dialect Options
1710 @section Options Controlling C Dialect
1711 @cindex dialect options
1712 @cindex language dialect options
1713 @cindex options, dialect
1715 The following options control the dialect of C (or languages derived
1716 from C, such as C++, Objective-C and Objective-C++) that the compiler
1717 accepts:
1719 @table @gcctabopt
1720 @cindex ANSI support
1721 @cindex ISO support
1722 @item -ansi
1723 @opindex ansi
1724 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1725 equivalent to @option{-std=c++98}.
1727 This turns off certain features of GCC that are incompatible with ISO
1728 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1729 such as the @code{asm} and @code{typeof} keywords, and
1730 predefined macros such as @code{unix} and @code{vax} that identify the
1731 type of system you are using.  It also enables the undesirable and
1732 rarely used ISO trigraph feature.  For the C compiler,
1733 it disables recognition of C++ style @samp{//} comments as well as
1734 the @code{inline} keyword.
1736 The alternate keywords @code{__asm__}, @code{__extension__},
1737 @code{__inline__} and @code{__typeof__} continue to work despite
1738 @option{-ansi}.  You would not want to use them in an ISO C program, of
1739 course, but it is useful to put them in header files that might be included
1740 in compilations done with @option{-ansi}.  Alternate predefined macros
1741 such as @code{__unix__} and @code{__vax__} are also available, with or
1742 without @option{-ansi}.
1744 The @option{-ansi} option does not cause non-ISO programs to be
1745 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1746 addition to @option{-ansi}.  @xref{Warning Options}.
1748 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1749 option is used.  Some header files may notice this macro and refrain
1750 from declaring certain functions or defining certain macros that the
1751 ISO standard doesn't call for; this is to avoid interfering with any
1752 programs that might use these names for other things.
1754 Functions that are normally built in but do not have semantics
1755 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1756 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1757 built-in functions provided by GCC}, for details of the functions
1758 affected.
1760 @item -std=
1761 @opindex std
1762 Determine the language standard. @xref{Standards,,Language Standards
1763 Supported by GCC}, for details of these standard versions.  This option
1764 is currently only supported when compiling C or C++.
1766 The compiler can accept several base standards, such as @samp{c90} or
1767 @samp{c++98}, and GNU dialects of those standards, such as
1768 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1769 compiler accepts all programs following that standard plus those
1770 using GNU extensions that do not contradict it.  For example,
1771 @option{-std=c90} turns off certain features of GCC that are
1772 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1773 keywords, but not other GNU extensions that do not have a meaning in
1774 ISO C90, such as omitting the middle term of a @code{?:}
1775 expression. On the other hand, when a GNU dialect of a standard is
1776 specified, all features supported by the compiler are enabled, even when
1777 those features change the meaning of the base standard.  As a result, some
1778 strict-conforming programs may be rejected.  The particular standard
1779 is used by @option{-Wpedantic} to identify which features are GNU
1780 extensions given that version of the standard. For example
1781 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1782 comments, while @option{-std=gnu99 -Wpedantic} does not.
1784 A value for this option must be provided; possible values are
1786 @table @samp
1787 @item c90
1788 @itemx c89
1789 @itemx iso9899:1990
1790 Support all ISO C90 programs (certain GNU extensions that conflict
1791 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1793 @item iso9899:199409
1794 ISO C90 as modified in amendment 1.
1796 @item c99
1797 @itemx c9x
1798 @itemx iso9899:1999
1799 @itemx iso9899:199x
1800 ISO C99.  This standard is substantially completely supported, modulo
1801 bugs and floating-point issues
1802 (mainly but not entirely relating to optional C99 features from
1803 Annexes F and G).  See
1804 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1805 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1807 @item c11
1808 @itemx c1x
1809 @itemx iso9899:2011
1810 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1811 substantially completely supported, modulo bugs, floating-point issues
1812 (mainly but not entirely relating to optional C11 features from
1813 Annexes F and G) and the optional Annexes K (Bounds-checking
1814 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1816 @item gnu90
1817 @itemx gnu89
1818 GNU dialect of ISO C90 (including some C99 features).
1820 @item gnu99
1821 @itemx gnu9x
1822 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1824 @item gnu11
1825 @itemx gnu1x
1826 GNU dialect of ISO C11.  This is the default for C code.
1827 The name @samp{gnu1x} is deprecated.
1829 @item c++98
1830 @itemx c++03
1831 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1832 additional defect reports. Same as @option{-ansi} for C++ code.
1834 @item gnu++98
1835 @itemx gnu++03
1836 GNU dialect of @option{-std=c++98}.
1838 @item c++11
1839 @itemx c++0x
1840 The 2011 ISO C++ standard plus amendments.
1841 The name @samp{c++0x} is deprecated.
1843 @item gnu++11
1844 @itemx gnu++0x
1845 GNU dialect of @option{-std=c++11}.
1846 The name @samp{gnu++0x} is deprecated.
1848 @item c++14
1849 @itemx c++1y
1850 The 2014 ISO C++ standard plus amendments.
1851 The name @samp{c++1y} is deprecated.
1853 @item gnu++14
1854 @itemx gnu++1y
1855 GNU dialect of @option{-std=c++14}.
1856 This is the default for C++ code.
1857 The name @samp{gnu++1y} is deprecated.
1859 @item c++1z
1860 The next revision of the ISO C++ standard, tentatively planned for
1861 2017.  Support is highly experimental, and will almost certainly
1862 change in incompatible ways in future releases.
1864 @item gnu++1z
1865 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1866 and will almost certainly change in incompatible ways in future
1867 releases.
1868 @end table
1870 @item -fgnu89-inline
1871 @opindex fgnu89-inline
1872 The option @option{-fgnu89-inline} tells GCC to use the traditional
1873 GNU semantics for @code{inline} functions when in C99 mode.
1874 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1875 Using this option is roughly equivalent to adding the
1876 @code{gnu_inline} function attribute to all inline functions
1877 (@pxref{Function Attributes}).
1879 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1880 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1881 specifies the default behavior).
1882 This option is not supported in @option{-std=c90} or
1883 @option{-std=gnu90} mode.
1885 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1886 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1887 in effect for @code{inline} functions.  @xref{Common Predefined
1888 Macros,,,cpp,The C Preprocessor}.
1890 @item -fpermitted-flt-eval-methods=@var{style}
1891 @opindex fpermitted-flt-eval-methods
1892 @opindex fpermitted-flt-eval-methods=c11
1893 @opindex fpermitted-flt-eval-methods=ts-18661-3
1894 ISO/IEC TS 18661-3 defines new permissible values for
1895 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1896 a semantic type that is an interchange or extended format should be
1897 evaluated to the precision and range of that type.  These new values are
1898 a superset of those permitted under C99/C11, which does not specify the
1899 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1900 conforming to C11 may not have been written expecting the possibility of
1901 the new values.
1903 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1904 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1905 or the extended set of values specified in ISO/IEC TS 18661-3.
1907 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1909 The default when in a standards compliant mode (@option{-std=c11} or similar)
1910 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1911 dialect (@option{-std=gnu11} or similar) is
1912 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1914 @item -aux-info @var{filename}
1915 @opindex aux-info
1916 Output to the given filename prototyped declarations for all functions
1917 declared and/or defined in a translation unit, including those in header
1918 files.  This option is silently ignored in any language other than C@.
1920 Besides declarations, the file indicates, in comments, the origin of
1921 each declaration (source file and line), whether the declaration was
1922 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1923 @samp{O} for old, respectively, in the first character after the line
1924 number and the colon), and whether it came from a declaration or a
1925 definition (@samp{C} or @samp{F}, respectively, in the following
1926 character).  In the case of function definitions, a K&R-style list of
1927 arguments followed by their declarations is also provided, inside
1928 comments, after the declaration.
1930 @item -fallow-parameterless-variadic-functions
1931 @opindex fallow-parameterless-variadic-functions
1932 Accept variadic functions without named parameters.
1934 Although it is possible to define such a function, this is not very
1935 useful as it is not possible to read the arguments.  This is only
1936 supported for C as this construct is allowed by C++.
1938 @item -fno-asm
1939 @opindex fno-asm
1940 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1941 keyword, so that code can use these words as identifiers.  You can use
1942 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1943 instead.  @option{-ansi} implies @option{-fno-asm}.
1945 In C++, this switch only affects the @code{typeof} keyword, since
1946 @code{asm} and @code{inline} are standard keywords.  You may want to
1947 use the @option{-fno-gnu-keywords} flag instead, which has the same
1948 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1949 switch only affects the @code{asm} and @code{typeof} keywords, since
1950 @code{inline} is a standard keyword in ISO C99.
1952 @item -fno-builtin
1953 @itemx -fno-builtin-@var{function}
1954 @opindex fno-builtin
1955 @cindex built-in functions
1956 Don't recognize built-in functions that do not begin with
1957 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1958 functions provided by GCC}, for details of the functions affected,
1959 including those which are not built-in functions when @option{-ansi} or
1960 @option{-std} options for strict ISO C conformance are used because they
1961 do not have an ISO standard meaning.
1963 GCC normally generates special code to handle certain built-in functions
1964 more efficiently; for instance, calls to @code{alloca} may become single
1965 instructions which adjust the stack directly, and calls to @code{memcpy}
1966 may become inline copy loops.  The resulting code is often both smaller
1967 and faster, but since the function calls no longer appear as such, you
1968 cannot set a breakpoint on those calls, nor can you change the behavior
1969 of the functions by linking with a different library.  In addition,
1970 when a function is recognized as a built-in function, GCC may use
1971 information about that function to warn about problems with calls to
1972 that function, or to generate more efficient code, even if the
1973 resulting code still contains calls to that function.  For example,
1974 warnings are given with @option{-Wformat} for bad calls to
1975 @code{printf} when @code{printf} is built in and @code{strlen} is
1976 known not to modify global memory.
1978 With the @option{-fno-builtin-@var{function}} option
1979 only the built-in function @var{function} is
1980 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1981 function is named that is not built-in in this version of GCC, this
1982 option is ignored.  There is no corresponding
1983 @option{-fbuiltin-@var{function}} option; if you wish to enable
1984 built-in functions selectively when using @option{-fno-builtin} or
1985 @option{-ffreestanding}, you may define macros such as:
1987 @smallexample
1988 #define abs(n)          __builtin_abs ((n))
1989 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1990 @end smallexample
1992 @item -fgimple
1993 @opindex fgimple
1995 Enable parsing of function definitions marked with @code{__GIMPLE}.
1996 This is an experimental feature that allows unit testing of GIMPLE
1997 passes.
1999 @item -fhosted
2000 @opindex fhosted
2001 @cindex hosted environment
2003 Assert that compilation targets a hosted environment.  This implies
2004 @option{-fbuiltin}.  A hosted environment is one in which the
2005 entire standard library is available, and in which @code{main} has a return
2006 type of @code{int}.  Examples are nearly everything except a kernel.
2007 This is equivalent to @option{-fno-freestanding}.
2009 @item -ffreestanding
2010 @opindex ffreestanding
2011 @cindex hosted environment
2013 Assert that compilation targets a freestanding environment.  This
2014 implies @option{-fno-builtin}.  A freestanding environment
2015 is one in which the standard library may not exist, and program startup may
2016 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2017 This is equivalent to @option{-fno-hosted}.
2019 @xref{Standards,,Language Standards Supported by GCC}, for details of
2020 freestanding and hosted environments.
2022 @item -fopenacc
2023 @opindex fopenacc
2024 @cindex OpenACC accelerator programming
2025 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2026 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2027 compiler generates accelerated code according to the OpenACC Application
2028 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2029 implies @option{-pthread}, and thus is only supported on targets that
2030 have support for @option{-pthread}.
2032 @item -fopenacc-dim=@var{geom}
2033 @opindex fopenacc-dim
2034 @cindex OpenACC accelerator programming
2035 Specify default compute dimensions for parallel offload regions that do
2036 not explicitly specify.  The @var{geom} value is a triple of
2037 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2038 can be omitted, to use a target-specific default value.
2040 @item -fopenmp
2041 @opindex fopenmp
2042 @cindex OpenMP parallel
2043 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2044 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2045 compiler generates parallel code according to the OpenMP Application
2046 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2047 implies @option{-pthread}, and thus is only supported on targets that
2048 have support for @option{-pthread}. @option{-fopenmp} implies
2049 @option{-fopenmp-simd}.
2051 @item -fopenmp-simd
2052 @opindex fopenmp-simd
2053 @cindex OpenMP SIMD
2054 @cindex SIMD
2055 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2056 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2057 are ignored.
2059 @item -fcilkplus
2060 @opindex fcilkplus
2061 @cindex Enable Cilk Plus
2062 Enable the usage of Cilk Plus language extension features for C/C++.
2063 When the option @option{-fcilkplus} is specified, enable the usage of
2064 the Cilk Plus Language extension features for C/C++.  The present
2065 implementation follows ABI version 1.2.  This is an experimental
2066 feature that is only partially complete, and whose interface may
2067 change in future versions of GCC as the official specification
2068 changes.  Currently, all features but @code{_Cilk_for} have been
2069 implemented.
2071 @item -fgnu-tm
2072 @opindex fgnu-tm
2073 When the option @option{-fgnu-tm} is specified, the compiler
2074 generates code for the Linux variant of Intel's current Transactional
2075 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2076 an experimental feature whose interface may change in future versions
2077 of GCC, as the official specification changes.  Please note that not
2078 all architectures are supported for this feature.
2080 For more information on GCC's support for transactional memory,
2081 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2082 Transactional Memory Library}.
2084 Note that the transactional memory feature is not supported with
2085 non-call exceptions (@option{-fnon-call-exceptions}).
2087 @item -fms-extensions
2088 @opindex fms-extensions
2089 Accept some non-standard constructs used in Microsoft header files.
2091 In C++ code, this allows member names in structures to be similar
2092 to previous types declarations.
2094 @smallexample
2095 typedef int UOW;
2096 struct ABC @{
2097   UOW UOW;
2099 @end smallexample
2101 Some cases of unnamed fields in structures and unions are only
2102 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2103 fields within structs/unions}, for details.
2105 Note that this option is off for all targets but x86 
2106 targets using ms-abi.
2108 @item -fplan9-extensions
2109 @opindex fplan9-extensions
2110 Accept some non-standard constructs used in Plan 9 code.
2112 This enables @option{-fms-extensions}, permits passing pointers to
2113 structures with anonymous fields to functions that expect pointers to
2114 elements of the type of the field, and permits referring to anonymous
2115 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2116 struct/union fields within structs/unions}, for details.  This is only
2117 supported for C, not C++.
2119 @item -fcond-mismatch
2120 @opindex fcond-mismatch
2121 Allow conditional expressions with mismatched types in the second and
2122 third arguments.  The value of such an expression is void.  This option
2123 is not supported for C++.
2125 @item -flax-vector-conversions
2126 @opindex flax-vector-conversions
2127 Allow implicit conversions between vectors with differing numbers of
2128 elements and/or incompatible element types.  This option should not be
2129 used for new code.
2131 @item -funsigned-char
2132 @opindex funsigned-char
2133 Let the type @code{char} be unsigned, like @code{unsigned char}.
2135 Each kind of machine has a default for what @code{char} should
2136 be.  It is either like @code{unsigned char} by default or like
2137 @code{signed char} by default.
2139 Ideally, a portable program should always use @code{signed char} or
2140 @code{unsigned char} when it depends on the signedness of an object.
2141 But many programs have been written to use plain @code{char} and
2142 expect it to be signed, or expect it to be unsigned, depending on the
2143 machines they were written for.  This option, and its inverse, let you
2144 make such a program work with the opposite default.
2146 The type @code{char} is always a distinct type from each of
2147 @code{signed char} or @code{unsigned char}, even though its behavior
2148 is always just like one of those two.
2150 @item -fsigned-char
2151 @opindex fsigned-char
2152 Let the type @code{char} be signed, like @code{signed char}.
2154 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2155 the negative form of @option{-funsigned-char}.  Likewise, the option
2156 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2158 @item -fsigned-bitfields
2159 @itemx -funsigned-bitfields
2160 @itemx -fno-signed-bitfields
2161 @itemx -fno-unsigned-bitfields
2162 @opindex fsigned-bitfields
2163 @opindex funsigned-bitfields
2164 @opindex fno-signed-bitfields
2165 @opindex fno-unsigned-bitfields
2166 These options control whether a bit-field is signed or unsigned, when the
2167 declaration does not use either @code{signed} or @code{unsigned}.  By
2168 default, such a bit-field is signed, because this is consistent: the
2169 basic integer types such as @code{int} are signed types.
2171 @item -fsso-struct=@var{endianness}
2172 @opindex fsso-struct
2173 Set the default scalar storage order of structures and unions to the
2174 specified endianness.  The accepted values are @samp{big-endian},
2175 @samp{little-endian} and @samp{native} for the native endianness of
2176 the target (the default).  This option is not supported for C++.
2178 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2179 code that is not binary compatible with code generated without it if the
2180 specified endianness is not the native endianness of the target.
2181 @end table
2183 @node C++ Dialect Options
2184 @section Options Controlling C++ Dialect
2186 @cindex compiler options, C++
2187 @cindex C++ options, command-line
2188 @cindex options, C++
2189 This section describes the command-line options that are only meaningful
2190 for C++ programs.  You can also use most of the GNU compiler options
2191 regardless of what language your program is in.  For example, you
2192 might compile a file @file{firstClass.C} like this:
2194 @smallexample
2195 g++ -g -fstrict-enums -O -c firstClass.C
2196 @end smallexample
2198 @noindent
2199 In this example, only @option{-fstrict-enums} is an option meant
2200 only for C++ programs; you can use the other options with any
2201 language supported by GCC@.
2203 Some options for compiling C programs, such as @option{-std}, are also
2204 relevant for C++ programs.
2205 @xref{C Dialect Options,,Options Controlling C Dialect}.
2207 Here is a list of options that are @emph{only} for compiling C++ programs:
2209 @table @gcctabopt
2211 @item -fabi-version=@var{n}
2212 @opindex fabi-version
2213 Use version @var{n} of the C++ ABI@.  The default is version 0.
2215 Version 0 refers to the version conforming most closely to
2216 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2217 will change in different versions of G++ as ABI bugs are fixed.
2219 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2221 Version 2 is the version of the C++ ABI that first appeared in G++
2222 3.4, and was the default through G++ 4.9.
2224 Version 3 corrects an error in mangling a constant address as a
2225 template argument.
2227 Version 4, which first appeared in G++ 4.5, implements a standard
2228 mangling for vector types.
2230 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2231 attribute const/volatile on function pointer types, decltype of a
2232 plain decl, and use of a function parameter in the declaration of
2233 another parameter.
2235 Version 6, which first appeared in G++ 4.7, corrects the promotion
2236 behavior of C++11 scoped enums and the mangling of template argument
2237 packs, const/static_cast, prefix ++ and --, and a class scope function
2238 used as a template argument.
2240 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2241 builtin type and corrects the mangling of lambdas in default argument
2242 scope.
2244 Version 8, which first appeared in G++ 4.9, corrects the substitution
2245 behavior of function types with function-cv-qualifiers.
2247 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2248 @code{nullptr_t}.
2250 Version 10, which first appeared in G++ 6.1, adds mangling of
2251 attributes that affect type identity, such as ia32 calling convention
2252 attributes (e.g. @samp{stdcall}).
2254 Version 11, which first appeared in G++ 7, corrects the mangling of
2255 sizeof... expressions and operator names.  For multiple entities with
2256 the same name within a function, that are declared in different scopes,
2257 the mangling now changes starting with the twelfth occurrence.  It also
2258 implies @option{-fnew-inheriting-ctors}.
2260 See also @option{-Wabi}.
2262 @item -fabi-compat-version=@var{n}
2263 @opindex fabi-compat-version
2264 On targets that support strong aliases, G++
2265 works around mangling changes by creating an alias with the correct
2266 mangled name when defining a symbol with an incorrect mangled name.
2267 This switch specifies which ABI version to use for the alias.
2269 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2270 compatibility).  If another ABI version is explicitly selected, this
2271 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2272 use @option{-fabi-compat-version=2}.
2274 If this option is not provided but @option{-Wabi=@var{n}} is, that
2275 version is used for compatibility aliases.  If this option is provided
2276 along with @option{-Wabi} (without the version), the version from this
2277 option is used for the warning.
2279 @item -fno-access-control
2280 @opindex fno-access-control
2281 Turn off all access checking.  This switch is mainly useful for working
2282 around bugs in the access control code.
2284 @item -faligned-new
2285 @opindex faligned-new
2286 Enable support for C++17 @code{new} of types that require more
2287 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2288 numeric argument such as @code{-faligned-new=32} can be used to
2289 specify how much alignment (in bytes) is provided by that function,
2290 but few users will need to override the default of
2291 @code{alignof(std::max_align_t)}.
2293 @item -fcheck-new
2294 @opindex fcheck-new
2295 Check that the pointer returned by @code{operator new} is non-null
2296 before attempting to modify the storage allocated.  This check is
2297 normally unnecessary because the C++ standard specifies that
2298 @code{operator new} only returns @code{0} if it is declared
2299 @code{throw()}, in which case the compiler always checks the
2300 return value even without this option.  In all other cases, when
2301 @code{operator new} has a non-empty exception specification, memory
2302 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2303 @samp{new (nothrow)}.
2305 @item -fconcepts
2306 @opindex fconcepts
2307 Enable support for the C++ Extensions for Concepts Technical
2308 Specification, ISO 19217 (2015), which allows code like
2310 @smallexample
2311 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2312 template <Addable T> T add (T a, T b) @{ return a + b; @}
2313 @end smallexample
2315 @item -fconstexpr-depth=@var{n}
2316 @opindex fconstexpr-depth
2317 Set the maximum nested evaluation depth for C++11 constexpr functions
2318 to @var{n}.  A limit is needed to detect endless recursion during
2319 constant expression evaluation.  The minimum specified by the standard
2320 is 512.
2322 @item -fconstexpr-loop-limit=@var{n}
2323 @opindex fconstexpr-loop-limit
2324 Set the maximum number of iterations for a loop in C++14 constexpr functions
2325 to @var{n}.  A limit is needed to detect infinite loops during
2326 constant expression evaluation.  The default is 262144 (1<<18).
2328 @item -fdeduce-init-list
2329 @opindex fdeduce-init-list
2330 Enable deduction of a template type parameter as
2331 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2333 @smallexample
2334 template <class T> auto forward(T t) -> decltype (realfn (t))
2336   return realfn (t);
2339 void f()
2341   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2343 @end smallexample
2345 This deduction was implemented as a possible extension to the
2346 originally proposed semantics for the C++11 standard, but was not part
2347 of the final standard, so it is disabled by default.  This option is
2348 deprecated, and may be removed in a future version of G++.
2350 @item -ffriend-injection
2351 @opindex ffriend-injection
2352 Inject friend functions into the enclosing namespace, so that they are
2353 visible outside the scope of the class in which they are declared.
2354 Friend functions were documented to work this way in the old Annotated
2355 C++ Reference Manual.  
2356 However, in ISO C++ a friend function that is not declared
2357 in an enclosing scope can only be found using argument dependent
2358 lookup.  GCC defaults to the standard behavior.
2360 This option is for compatibility, and may be removed in a future
2361 release of G++.
2363 @item -fno-elide-constructors
2364 @opindex fno-elide-constructors
2365 The C++ standard allows an implementation to omit creating a temporary
2366 that is only used to initialize another object of the same type.
2367 Specifying this option disables that optimization, and forces G++ to
2368 call the copy constructor in all cases.  This option also causes G++
2369 to call trivial member functions which otherwise would be expanded inline.
2371 In C++17, the compiler is required to omit these temporaries, but this
2372 option still affects trivial member functions.
2374 @item -fno-enforce-eh-specs
2375 @opindex fno-enforce-eh-specs
2376 Don't generate code to check for violation of exception specifications
2377 at run time.  This option violates the C++ standard, but may be useful
2378 for reducing code size in production builds, much like defining
2379 @code{NDEBUG}.  This does not give user code permission to throw
2380 exceptions in violation of the exception specifications; the compiler
2381 still optimizes based on the specifications, so throwing an
2382 unexpected exception results in undefined behavior at run time.
2384 @item -fextern-tls-init
2385 @itemx -fno-extern-tls-init
2386 @opindex fextern-tls-init
2387 @opindex fno-extern-tls-init
2388 The C++11 and OpenMP standards allow @code{thread_local} and
2389 @code{threadprivate} variables to have dynamic (runtime)
2390 initialization.  To support this, any use of such a variable goes
2391 through a wrapper function that performs any necessary initialization.
2392 When the use and definition of the variable are in the same
2393 translation unit, this overhead can be optimized away, but when the
2394 use is in a different translation unit there is significant overhead
2395 even if the variable doesn't actually need dynamic initialization.  If
2396 the programmer can be sure that no use of the variable in a
2397 non-defining TU needs to trigger dynamic initialization (either
2398 because the variable is statically initialized, or a use of the
2399 variable in the defining TU will be executed before any uses in
2400 another TU), they can avoid this overhead with the
2401 @option{-fno-extern-tls-init} option.
2403 On targets that support symbol aliases, the default is
2404 @option{-fextern-tls-init}.  On targets that do not support symbol
2405 aliases, the default is @option{-fno-extern-tls-init}.
2407 @item -ffor-scope
2408 @itemx -fno-for-scope
2409 @opindex ffor-scope
2410 @opindex fno-for-scope
2411 If @option{-ffor-scope} is specified, the scope of variables declared in
2412 a @i{for-init-statement} is limited to the @code{for} loop itself,
2413 as specified by the C++ standard.
2414 If @option{-fno-for-scope} is specified, the scope of variables declared in
2415 a @i{for-init-statement} extends to the end of the enclosing scope,
2416 as was the case in old versions of G++, and other (traditional)
2417 implementations of C++.
2419 If neither flag is given, the default is to follow the standard,
2420 but to allow and give a warning for old-style code that would
2421 otherwise be invalid, or have different behavior.
2423 @item -fno-gnu-keywords
2424 @opindex fno-gnu-keywords
2425 Do not recognize @code{typeof} as a keyword, so that code can use this
2426 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2427 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2428 @option{-std=c++98}, @option{-std=c++11}, etc.
2430 @item -fno-implicit-templates
2431 @opindex fno-implicit-templates
2432 Never emit code for non-inline templates that are instantiated
2433 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2434 @xref{Template Instantiation}, for more information.
2436 @item -fno-implicit-inline-templates
2437 @opindex fno-implicit-inline-templates
2438 Don't emit code for implicit instantiations of inline templates, either.
2439 The default is to handle inlines differently so that compiles with and
2440 without optimization need the same set of explicit instantiations.
2442 @item -fno-implement-inlines
2443 @opindex fno-implement-inlines
2444 To save space, do not emit out-of-line copies of inline functions
2445 controlled by @code{#pragma implementation}.  This causes linker
2446 errors if these functions are not inlined everywhere they are called.
2448 @item -fms-extensions
2449 @opindex fms-extensions
2450 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2451 int and getting a pointer to member function via non-standard syntax.
2453 @item -fnew-inheriting-ctors
2454 @opindex fnew-inheriting-ctors
2455 Enable the P0136 adjustment to the semantics of C++11 constructor
2456 inheritance.  This is part of C++17 but also considered to be a Defect
2457 Report against C++11 and C++14.  This flag is enabled by default
2458 unless @option{-fabi-version=10} or lower is specified.
2460 @item -fnew-ttp-matching
2461 @opindex fnew-ttp-matching
2462 Enable the P0522 resolution to Core issue 150, template template
2463 parameters and default arguments: this allows a template with default
2464 template arguments as an argument for a template template parameter
2465 with fewer template parameters.  This flag is enabled by default for
2466 @option{-std=c++1z}.
2468 @item -fno-nonansi-builtins
2469 @opindex fno-nonansi-builtins
2470 Disable built-in declarations of functions that are not mandated by
2471 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2472 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2474 @item -fnothrow-opt
2475 @opindex fnothrow-opt
2476 Treat a @code{throw()} exception specification as if it were a
2477 @code{noexcept} specification to reduce or eliminate the text size
2478 overhead relative to a function with no exception specification.  If
2479 the function has local variables of types with non-trivial
2480 destructors, the exception specification actually makes the
2481 function smaller because the EH cleanups for those variables can be
2482 optimized away.  The semantic effect is that an exception thrown out of
2483 a function with such an exception specification results in a call
2484 to @code{terminate} rather than @code{unexpected}.
2486 @item -fno-operator-names
2487 @opindex fno-operator-names
2488 Do not treat the operator name keywords @code{and}, @code{bitand},
2489 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2490 synonyms as keywords.
2492 @item -fno-optional-diags
2493 @opindex fno-optional-diags
2494 Disable diagnostics that the standard says a compiler does not need to
2495 issue.  Currently, the only such diagnostic issued by G++ is the one for
2496 a name having multiple meanings within a class.
2498 @item -fpermissive
2499 @opindex fpermissive
2500 Downgrade some diagnostics about nonconformant code from errors to
2501 warnings.  Thus, using @option{-fpermissive} allows some
2502 nonconforming code to compile.
2504 @item -fno-pretty-templates
2505 @opindex fno-pretty-templates
2506 When an error message refers to a specialization of a function
2507 template, the compiler normally prints the signature of the
2508 template followed by the template arguments and any typedefs or
2509 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2510 rather than @code{void f(int)}) so that it's clear which template is
2511 involved.  When an error message refers to a specialization of a class
2512 template, the compiler omits any template arguments that match
2513 the default template arguments for that template.  If either of these
2514 behaviors make it harder to understand the error message rather than
2515 easier, you can use @option{-fno-pretty-templates} to disable them.
2517 @item -frepo
2518 @opindex frepo
2519 Enable automatic template instantiation at link time.  This option also
2520 implies @option{-fno-implicit-templates}.  @xref{Template
2521 Instantiation}, for more information.
2523 @item -fno-rtti
2524 @opindex fno-rtti
2525 Disable generation of information about every class with virtual
2526 functions for use by the C++ run-time type identification features
2527 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2528 of the language, you can save some space by using this flag.  Note that
2529 exception handling uses the same information, but G++ generates it as
2530 needed. The @code{dynamic_cast} operator can still be used for casts that
2531 do not require run-time type information, i.e.@: casts to @code{void *} or to
2532 unambiguous base classes.
2534 @item -fsized-deallocation
2535 @opindex fsized-deallocation
2536 Enable the built-in global declarations
2537 @smallexample
2538 void operator delete (void *, std::size_t) noexcept;
2539 void operator delete[] (void *, std::size_t) noexcept;
2540 @end smallexample
2541 as introduced in C++14.  This is useful for user-defined replacement
2542 deallocation functions that, for example, use the size of the object
2543 to make deallocation faster.  Enabled by default under
2544 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2545 warns about places that might want to add a definition.
2547 @item -fstrict-enums
2548 @opindex fstrict-enums
2549 Allow the compiler to optimize using the assumption that a value of
2550 enumerated type can only be one of the values of the enumeration (as
2551 defined in the C++ standard; basically, a value that can be
2552 represented in the minimum number of bits needed to represent all the
2553 enumerators).  This assumption may not be valid if the program uses a
2554 cast to convert an arbitrary integer value to the enumerated type.
2556 @item -fstrong-eval-order
2557 @opindex fstrong-eval-order
2558 Evaluate member access, array subscripting, and shift expressions in
2559 left-to-right order, and evaluate assignment in right-to-left order,
2560 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2561 @option{-fstrong-eval-order=some} enables just the ordering of member
2562 access and shift expressions, and is the default without
2563 @option{-std=c++1z}.
2565 @item -ftemplate-backtrace-limit=@var{n}
2566 @opindex ftemplate-backtrace-limit
2567 Set the maximum number of template instantiation notes for a single
2568 warning or error to @var{n}.  The default value is 10.
2570 @item -ftemplate-depth=@var{n}
2571 @opindex ftemplate-depth
2572 Set the maximum instantiation depth for template classes to @var{n}.
2573 A limit on the template instantiation depth is needed to detect
2574 endless recursions during template class instantiation.  ANSI/ISO C++
2575 conforming programs must not rely on a maximum depth greater than 17
2576 (changed to 1024 in C++11).  The default value is 900, as the compiler
2577 can run out of stack space before hitting 1024 in some situations.
2579 @item -fno-threadsafe-statics
2580 @opindex fno-threadsafe-statics
2581 Do not emit the extra code to use the routines specified in the C++
2582 ABI for thread-safe initialization of local statics.  You can use this
2583 option to reduce code size slightly in code that doesn't need to be
2584 thread-safe.
2586 @item -fuse-cxa-atexit
2587 @opindex fuse-cxa-atexit
2588 Register destructors for objects with static storage duration with the
2589 @code{__cxa_atexit} function rather than the @code{atexit} function.
2590 This option is required for fully standards-compliant handling of static
2591 destructors, but only works if your C library supports
2592 @code{__cxa_atexit}.
2594 @item -fno-use-cxa-get-exception-ptr
2595 @opindex fno-use-cxa-get-exception-ptr
2596 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2597 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2598 if the runtime routine is not available.
2600 @item -fvisibility-inlines-hidden
2601 @opindex fvisibility-inlines-hidden
2602 This switch declares that the user does not attempt to compare
2603 pointers to inline functions or methods where the addresses of the two functions
2604 are taken in different shared objects.
2606 The effect of this is that GCC may, effectively, mark inline methods with
2607 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2608 appear in the export table of a DSO and do not require a PLT indirection
2609 when used within the DSO@.  Enabling this option can have a dramatic effect
2610 on load and link times of a DSO as it massively reduces the size of the
2611 dynamic export table when the library makes heavy use of templates.
2613 The behavior of this switch is not quite the same as marking the
2614 methods as hidden directly, because it does not affect static variables
2615 local to the function or cause the compiler to deduce that
2616 the function is defined in only one shared object.
2618 You may mark a method as having a visibility explicitly to negate the
2619 effect of the switch for that method.  For example, if you do want to
2620 compare pointers to a particular inline method, you might mark it as
2621 having default visibility.  Marking the enclosing class with explicit
2622 visibility has no effect.
2624 Explicitly instantiated inline methods are unaffected by this option
2625 as their linkage might otherwise cross a shared library boundary.
2626 @xref{Template Instantiation}.
2628 @item -fvisibility-ms-compat
2629 @opindex fvisibility-ms-compat
2630 This flag attempts to use visibility settings to make GCC's C++
2631 linkage model compatible with that of Microsoft Visual Studio.
2633 The flag makes these changes to GCC's linkage model:
2635 @enumerate
2636 @item
2637 It sets the default visibility to @code{hidden}, like
2638 @option{-fvisibility=hidden}.
2640 @item
2641 Types, but not their members, are not hidden by default.
2643 @item
2644 The One Definition Rule is relaxed for types without explicit
2645 visibility specifications that are defined in more than one
2646 shared object: those declarations are permitted if they are
2647 permitted when this option is not used.
2648 @end enumerate
2650 In new code it is better to use @option{-fvisibility=hidden} and
2651 export those classes that are intended to be externally visible.
2652 Unfortunately it is possible for code to rely, perhaps accidentally,
2653 on the Visual Studio behavior.
2655 Among the consequences of these changes are that static data members
2656 of the same type with the same name but defined in different shared
2657 objects are different, so changing one does not change the other;
2658 and that pointers to function members defined in different shared
2659 objects may not compare equal.  When this flag is given, it is a
2660 violation of the ODR to define types with the same name differently.
2662 @item -fno-weak
2663 @opindex fno-weak
2664 Do not use weak symbol support, even if it is provided by the linker.
2665 By default, G++ uses weak symbols if they are available.  This
2666 option exists only for testing, and should not be used by end-users;
2667 it results in inferior code and has no benefits.  This option may
2668 be removed in a future release of G++.
2670 @item -nostdinc++
2671 @opindex nostdinc++
2672 Do not search for header files in the standard directories specific to
2673 C++, but do still search the other standard directories.  (This option
2674 is used when building the C++ library.)
2675 @end table
2677 In addition, these optimization, warning, and code generation options
2678 have meanings only for C++ programs:
2680 @table @gcctabopt
2681 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2682 @opindex Wabi
2683 @opindex Wno-abi
2684 Warn when G++ it generates code that is probably not compatible with
2685 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2686 ABI with each major release, normally @option{-Wabi} will warn only if
2687 there is a check added later in a release series for an ABI issue
2688 discovered since the initial release.  @option{-Wabi} will warn about
2689 more things if an older ABI version is selected (with
2690 @option{-fabi-version=@var{n}}).
2692 @option{-Wabi} can also be used with an explicit version number to
2693 warn about compatibility with a particular @option{-fabi-version}
2694 level, e.g. @option{-Wabi=2} to warn about changes relative to
2695 @option{-fabi-version=2}.
2697 If an explicit version number is provided and
2698 @option{-fabi-compat-version} is not specified, the version number
2699 from this option is used for compatibility aliases.  If no explicit
2700 version number is provided with this option, but
2701 @option{-fabi-compat-version} is specified, that version number is
2702 used for ABI warnings.
2704 Although an effort has been made to warn about
2705 all such cases, there are probably some cases that are not warned about,
2706 even though G++ is generating incompatible code.  There may also be
2707 cases where warnings are emitted even though the code that is generated
2708 is compatible.
2710 You should rewrite your code to avoid these warnings if you are
2711 concerned about the fact that code generated by G++ may not be binary
2712 compatible with code generated by other compilers.
2714 Known incompatibilities in @option{-fabi-version=2} (which was the
2715 default from GCC 3.4 to 4.9) include:
2717 @itemize @bullet
2719 @item
2720 A template with a non-type template parameter of reference type was
2721 mangled incorrectly:
2722 @smallexample
2723 extern int N;
2724 template <int &> struct S @{@};
2725 void n (S<N>) @{2@}
2726 @end smallexample
2728 This was fixed in @option{-fabi-version=3}.
2730 @item
2731 SIMD vector types declared using @code{__attribute ((vector_size))} were
2732 mangled in a non-standard way that does not allow for overloading of
2733 functions taking vectors of different sizes.
2735 The mangling was changed in @option{-fabi-version=4}.
2737 @item
2738 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2739 qualifiers, and @code{decltype} of a plain declaration was folded away.
2741 These mangling issues were fixed in @option{-fabi-version=5}.
2743 @item
2744 Scoped enumerators passed as arguments to a variadic function are
2745 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2746 On most targets this does not actually affect the parameter passing
2747 ABI, as there is no way to pass an argument smaller than @code{int}.
2749 Also, the ABI changed the mangling of template argument packs,
2750 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2751 a class scope function used as a template argument.
2753 These issues were corrected in @option{-fabi-version=6}.
2755 @item
2756 Lambdas in default argument scope were mangled incorrectly, and the
2757 ABI changed the mangling of @code{nullptr_t}.
2759 These issues were corrected in @option{-fabi-version=7}.
2761 @item
2762 When mangling a function type with function-cv-qualifiers, the
2763 un-qualified function type was incorrectly treated as a substitution
2764 candidate.
2766 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2768 @item
2769 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2770 unaligned accesses.  Note that this did not affect the ABI of a
2771 function with a @code{nullptr_t} parameter, as parameters have a
2772 minimum alignment.
2774 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2776 @item
2777 Target-specific attributes that affect the identity of a type, such as
2778 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2779 did not affect the mangled name, leading to name collisions when
2780 function pointers were used as template arguments.
2782 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2784 @end itemize
2786 It also warns about psABI-related changes.  The known psABI changes at this
2787 point include:
2789 @itemize @bullet
2791 @item
2792 For SysV/x86-64, unions with @code{long double} members are 
2793 passed in memory as specified in psABI.  For example:
2795 @smallexample
2796 union U @{
2797   long double ld;
2798   int i;
2800 @end smallexample
2802 @noindent
2803 @code{union U} is always passed in memory.
2805 @end itemize
2807 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2808 @opindex Wabi-tag
2809 @opindex -Wabi-tag
2810 Warn when a type with an ABI tag is used in a context that does not
2811 have that ABI tag.  See @ref{C++ Attributes} for more information
2812 about ABI tags.
2814 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2815 @opindex Wctor-dtor-privacy
2816 @opindex Wno-ctor-dtor-privacy
2817 Warn when a class seems unusable because all the constructors or
2818 destructors in that class are private, and it has neither friends nor
2819 public static member functions.  Also warn if there are no non-private
2820 methods, and there's at least one private member function that isn't
2821 a constructor or destructor.
2823 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2824 @opindex Wdelete-non-virtual-dtor
2825 @opindex Wno-delete-non-virtual-dtor
2826 Warn when @code{delete} is used to destroy an instance of a class that
2827 has virtual functions and non-virtual destructor. It is unsafe to delete
2828 an instance of a derived class through a pointer to a base class if the
2829 base class does not have a virtual destructor.  This warning is enabled
2830 by @option{-Wall}.
2832 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2833 @opindex Wliteral-suffix
2834 @opindex Wno-literal-suffix
2835 Warn when a string or character literal is followed by a ud-suffix which does
2836 not begin with an underscore.  As a conforming extension, GCC treats such
2837 suffixes as separate preprocessing tokens in order to maintain backwards
2838 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2839 For example:
2841 @smallexample
2842 #define __STDC_FORMAT_MACROS
2843 #include <inttypes.h>
2844 #include <stdio.h>
2846 int main() @{
2847   int64_t i64 = 123;
2848   printf("My int64: %" PRId64"\n", i64);
2850 @end smallexample
2852 In this case, @code{PRId64} is treated as a separate preprocessing token.
2854 This warning is enabled by default.
2856 @item -Wlto-type-mismatch
2857 @opindex Wlto-type-mismatch
2858 @opindex Wno-lto-type-mismatch
2860 During the link-time optimization warn about type mismatches in
2861 global declarations from different compilation units.
2862 Requires @option{-flto} to be enabled.  Enabled by default.
2864 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2865 @opindex Wnarrowing
2866 @opindex Wno-narrowing
2867 With @option{-std=gnu++98} or @option{-std=c++98}, warn when a narrowing
2868 conversion prohibited by C++11 occurs within
2869 @samp{@{ @}}, e.g.
2871 @smallexample
2872 int i = @{ 2.2 @}; // error: narrowing from double to int
2873 @end smallexample
2875 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2877 When a later standard is in effect, e.g. when using @option{-std=c++11},
2878 narrowing conversions are diagnosed by default, as required by the standard.
2879 A narrowing conversion from a constant produces an error,
2880 and a narrowing conversion from a non-constant produces a warning,
2881 but @option{-Wno-narrowing} suppresses the diagnostic.
2882 Note that this does not affect the meaning of well-formed code;
2883 narrowing conversions are still considered ill-formed in SFINAE contexts.
2885 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2886 @opindex Wnoexcept
2887 @opindex Wno-noexcept
2888 Warn when a noexcept-expression evaluates to false because of a call
2889 to a function that does not have a non-throwing exception
2890 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2891 the compiler to never throw an exception.
2893 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2894 @opindex Wnon-virtual-dtor
2895 @opindex Wno-non-virtual-dtor
2896 Warn when a class has virtual functions and an accessible non-virtual
2897 destructor itself or in an accessible polymorphic base class, in which
2898 case it is possible but unsafe to delete an instance of a derived
2899 class through a pointer to the class itself or base class.  This
2900 warning is automatically enabled if @option{-Weffc++} is specified.
2902 @item -Wregister @r{(C++ and Objective-C++ only)}
2903 @opindex Wregister
2904 @opindex Wno-register
2905 Warn on uses of the @code{register} storage class specifier, except
2906 when it is part of the GNU @ref{Explicit Register Variables} extension.
2907 The use of the @code{register} keyword as storage class specifier has
2908 been deprecated in C++11 and removed in C++17.
2909 Enabled by default with @option{-std=c++1z}.
2911 @item -Wreorder @r{(C++ and Objective-C++ only)}
2912 @opindex Wreorder
2913 @opindex Wno-reorder
2914 @cindex reordering, warning
2915 @cindex warning for reordering of member initializers
2916 Warn when the order of member initializers given in the code does not
2917 match the order in which they must be executed.  For instance:
2919 @smallexample
2920 struct A @{
2921   int i;
2922   int j;
2923   A(): j (0), i (1) @{ @}
2925 @end smallexample
2927 @noindent
2928 The compiler rearranges the member initializers for @code{i}
2929 and @code{j} to match the declaration order of the members, emitting
2930 a warning to that effect.  This warning is enabled by @option{-Wall}.
2932 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2933 @opindex fext-numeric-literals
2934 @opindex fno-ext-numeric-literals
2935 Accept imaginary, fixed-point, or machine-defined
2936 literal number suffixes as GNU extensions.
2937 When this option is turned off these suffixes are treated
2938 as C++11 user-defined literal numeric suffixes.
2939 This is on by default for all pre-C++11 dialects and all GNU dialects:
2940 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2941 @option{-std=gnu++14}.
2942 This option is off by default
2943 for ISO C++11 onwards (@option{-std=c++11}, ...).
2944 @end table
2946 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2948 @table @gcctabopt
2949 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2950 @opindex Weffc++
2951 @opindex Wno-effc++
2952 Warn about violations of the following style guidelines from Scott Meyers'
2953 @cite{Effective C++} series of books:
2955 @itemize @bullet
2956 @item
2957 Define a copy constructor and an assignment operator for classes
2958 with dynamically-allocated memory.
2960 @item
2961 Prefer initialization to assignment in constructors.
2963 @item
2964 Have @code{operator=} return a reference to @code{*this}.
2966 @item
2967 Don't try to return a reference when you must return an object.
2969 @item
2970 Distinguish between prefix and postfix forms of increment and
2971 decrement operators.
2973 @item
2974 Never overload @code{&&}, @code{||}, or @code{,}.
2976 @end itemize
2978 This option also enables @option{-Wnon-virtual-dtor}, which is also
2979 one of the effective C++ recommendations.  However, the check is
2980 extended to warn about the lack of virtual destructor in accessible
2981 non-polymorphic bases classes too.
2983 When selecting this option, be aware that the standard library
2984 headers do not obey all of these guidelines; use @samp{grep -v}
2985 to filter out those warnings.
2987 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2988 @opindex Wstrict-null-sentinel
2989 @opindex Wno-strict-null-sentinel
2990 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2991 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2992 to @code{__null}.  Although it is a null pointer constant rather than a
2993 null pointer, it is guaranteed to be of the same size as a pointer.
2994 But this use is not portable across different compilers.
2996 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2997 @opindex Wno-non-template-friend
2998 @opindex Wnon-template-friend
2999 Disable warnings when non-template friend functions are declared
3000 within a template.  In very old versions of GCC that predate implementation
3001 of the ISO standard, declarations such as 
3002 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3003 could be interpreted as a particular specialization of a template
3004 function; the warning exists to diagnose compatibility problems, 
3005 and is enabled by default.
3007 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3008 @opindex Wold-style-cast
3009 @opindex Wno-old-style-cast
3010 Warn if an old-style (C-style) cast to a non-void type is used within
3011 a C++ program.  The new-style casts (@code{dynamic_cast},
3012 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3013 less vulnerable to unintended effects and much easier to search for.
3015 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3016 @opindex Woverloaded-virtual
3017 @opindex Wno-overloaded-virtual
3018 @cindex overloaded virtual function, warning
3019 @cindex warning for overloaded virtual function
3020 Warn when a function declaration hides virtual functions from a
3021 base class.  For example, in:
3023 @smallexample
3024 struct A @{
3025   virtual void f();
3028 struct B: public A @{
3029   void f(int);
3031 @end smallexample
3033 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3034 like:
3036 @smallexample
3037 B* b;
3038 b->f();
3039 @end smallexample
3041 @noindent
3042 fails to compile.
3044 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3045 @opindex Wno-pmf-conversions
3046 @opindex Wpmf-conversions
3047 Disable the diagnostic for converting a bound pointer to member function
3048 to a plain pointer.
3050 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3051 @opindex Wsign-promo
3052 @opindex Wno-sign-promo
3053 Warn when overload resolution chooses a promotion from unsigned or
3054 enumerated type to a signed type, over a conversion to an unsigned type of
3055 the same size.  Previous versions of G++ tried to preserve
3056 unsignedness, but the standard mandates the current behavior.
3058 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3059 @opindex Wtemplates
3060 Warn when a primary template declaration is encountered.  Some coding
3061 rules disallow templates, and this may be used to enforce that rule.
3062 The warning is inactive inside a system header file, such as the STL, so
3063 one can still use the STL.  One may also instantiate or specialize
3064 templates.
3066 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3067 @opindex Wmultiple-inheritance
3068 Warn when a class is defined with multiple direct base classes.  Some
3069 coding rules disallow multiple inheritance, and this may be used to
3070 enforce that rule.  The warning is inactive inside a system header file,
3071 such as the STL, so one can still use the STL.  One may also define
3072 classes that indirectly use multiple inheritance.
3074 @item -Wvirtual-inheritance
3075 @opindex Wvirtual-inheritance
3076 Warn when a class is defined with a virtual direct base class.  Some
3077 coding rules disallow multiple inheritance, and this may be used to
3078 enforce that rule.  The warning is inactive inside a system header file,
3079 such as the STL, so one can still use the STL.  One may also define
3080 classes that indirectly use virtual inheritance.
3082 @item -Wnamespaces
3083 @opindex Wnamespaces
3084 Warn when a namespace definition is opened.  Some coding rules disallow
3085 namespaces, and this may be used to enforce that rule.  The warning is
3086 inactive inside a system header file, such as the STL, so one can still
3087 use the STL.  One may also use using directives and qualified names.
3089 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3090 @opindex Wterminate
3091 @opindex Wno-terminate
3092 Disable the warning about a throw-expression that will immediately
3093 result in a call to @code{terminate}.
3094 @end table
3096 @node Objective-C and Objective-C++ Dialect Options
3097 @section Options Controlling Objective-C and Objective-C++ Dialects
3099 @cindex compiler options, Objective-C and Objective-C++
3100 @cindex Objective-C and Objective-C++ options, command-line
3101 @cindex options, Objective-C and Objective-C++
3102 (NOTE: This manual does not describe the Objective-C and Objective-C++
3103 languages themselves.  @xref{Standards,,Language Standards
3104 Supported by GCC}, for references.)
3106 This section describes the command-line options that are only meaningful
3107 for Objective-C and Objective-C++ programs.  You can also use most of
3108 the language-independent GNU compiler options.
3109 For example, you might compile a file @file{some_class.m} like this:
3111 @smallexample
3112 gcc -g -fgnu-runtime -O -c some_class.m
3113 @end smallexample
3115 @noindent
3116 In this example, @option{-fgnu-runtime} is an option meant only for
3117 Objective-C and Objective-C++ programs; you can use the other options with
3118 any language supported by GCC@.
3120 Note that since Objective-C is an extension of the C language, Objective-C
3121 compilations may also use options specific to the C front-end (e.g.,
3122 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3123 C++-specific options (e.g., @option{-Wabi}).
3125 Here is a list of options that are @emph{only} for compiling Objective-C
3126 and Objective-C++ programs:
3128 @table @gcctabopt
3129 @item -fconstant-string-class=@var{class-name}
3130 @opindex fconstant-string-class
3131 Use @var{class-name} as the name of the class to instantiate for each
3132 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3133 class name is @code{NXConstantString} if the GNU runtime is being used, and
3134 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3135 @option{-fconstant-cfstrings} option, if also present, overrides the
3136 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3137 to be laid out as constant CoreFoundation strings.
3139 @item -fgnu-runtime
3140 @opindex fgnu-runtime
3141 Generate object code compatible with the standard GNU Objective-C
3142 runtime.  This is the default for most types of systems.
3144 @item -fnext-runtime
3145 @opindex fnext-runtime
3146 Generate output compatible with the NeXT runtime.  This is the default
3147 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3148 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3149 used.
3151 @item -fno-nil-receivers
3152 @opindex fno-nil-receivers
3153 Assume that all Objective-C message dispatches (@code{[receiver
3154 message:arg]}) in this translation unit ensure that the receiver is
3155 not @code{nil}.  This allows for more efficient entry points in the
3156 runtime to be used.  This option is only available in conjunction with
3157 the NeXT runtime and ABI version 0 or 1.
3159 @item -fobjc-abi-version=@var{n}
3160 @opindex fobjc-abi-version
3161 Use version @var{n} of the Objective-C ABI for the selected runtime.
3162 This option is currently supported only for the NeXT runtime.  In that
3163 case, Version 0 is the traditional (32-bit) ABI without support for
3164 properties and other Objective-C 2.0 additions.  Version 1 is the
3165 traditional (32-bit) ABI with support for properties and other
3166 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3167 nothing is specified, the default is Version 0 on 32-bit target
3168 machines, and Version 2 on 64-bit target machines.
3170 @item -fobjc-call-cxx-cdtors
3171 @opindex fobjc-call-cxx-cdtors
3172 For each Objective-C class, check if any of its instance variables is a
3173 C++ object with a non-trivial default constructor.  If so, synthesize a
3174 special @code{- (id) .cxx_construct} instance method which runs
3175 non-trivial default constructors on any such instance variables, in order,
3176 and then return @code{self}.  Similarly, check if any instance variable
3177 is a C++ object with a non-trivial destructor, and if so, synthesize a
3178 special @code{- (void) .cxx_destruct} method which runs
3179 all such default destructors, in reverse order.
3181 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3182 methods thusly generated only operate on instance variables
3183 declared in the current Objective-C class, and not those inherited
3184 from superclasses.  It is the responsibility of the Objective-C
3185 runtime to invoke all such methods in an object's inheritance
3186 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3187 by the runtime immediately after a new object instance is allocated;
3188 the @code{- (void) .cxx_destruct} methods are invoked immediately
3189 before the runtime deallocates an object instance.
3191 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3192 support for invoking the @code{- (id) .cxx_construct} and
3193 @code{- (void) .cxx_destruct} methods.
3195 @item -fobjc-direct-dispatch
3196 @opindex fobjc-direct-dispatch
3197 Allow fast jumps to the message dispatcher.  On Darwin this is
3198 accomplished via the comm page.
3200 @item -fobjc-exceptions
3201 @opindex fobjc-exceptions
3202 Enable syntactic support for structured exception handling in
3203 Objective-C, similar to what is offered by C++.  This option
3204 is required to use the Objective-C keywords @code{@@try},
3205 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3206 @code{@@synchronized}.  This option is available with both the GNU
3207 runtime and the NeXT runtime (but not available in conjunction with
3208 the NeXT runtime on Mac OS X 10.2 and earlier).
3210 @item -fobjc-gc
3211 @opindex fobjc-gc
3212 Enable garbage collection (GC) in Objective-C and Objective-C++
3213 programs.  This option is only available with the NeXT runtime; the
3214 GNU runtime has a different garbage collection implementation that
3215 does not require special compiler flags.
3217 @item -fobjc-nilcheck
3218 @opindex fobjc-nilcheck
3219 For the NeXT runtime with version 2 of the ABI, check for a nil
3220 receiver in method invocations before doing the actual method call.
3221 This is the default and can be disabled using
3222 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3223 checked for nil in this way no matter what this flag is set to.
3224 Currently this flag does nothing when the GNU runtime, or an older
3225 version of the NeXT runtime ABI, is used.
3227 @item -fobjc-std=objc1
3228 @opindex fobjc-std
3229 Conform to the language syntax of Objective-C 1.0, the language
3230 recognized by GCC 4.0.  This only affects the Objective-C additions to
3231 the C/C++ language; it does not affect conformance to C/C++ standards,
3232 which is controlled by the separate C/C++ dialect option flags.  When
3233 this option is used with the Objective-C or Objective-C++ compiler,
3234 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3235 This is useful if you need to make sure that your Objective-C code can
3236 be compiled with older versions of GCC@.
3238 @item -freplace-objc-classes
3239 @opindex freplace-objc-classes
3240 Emit a special marker instructing @command{ld(1)} not to statically link in
3241 the resulting object file, and allow @command{dyld(1)} to load it in at
3242 run time instead.  This is used in conjunction with the Fix-and-Continue
3243 debugging mode, where the object file in question may be recompiled and
3244 dynamically reloaded in the course of program execution, without the need
3245 to restart the program itself.  Currently, Fix-and-Continue functionality
3246 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3247 and later.
3249 @item -fzero-link
3250 @opindex fzero-link
3251 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3252 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3253 compile time) with static class references that get initialized at load time,
3254 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3255 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3256 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3257 for individual class implementations to be modified during program execution.
3258 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3259 regardless of command-line options.
3261 @item -fno-local-ivars
3262 @opindex fno-local-ivars
3263 @opindex flocal-ivars
3264 By default instance variables in Objective-C can be accessed as if
3265 they were local variables from within the methods of the class they're
3266 declared in.  This can lead to shadowing between instance variables
3267 and other variables declared either locally inside a class method or
3268 globally with the same name.  Specifying the @option{-fno-local-ivars}
3269 flag disables this behavior thus avoiding variable shadowing issues.
3271 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3272 @opindex fivar-visibility
3273 Set the default instance variable visibility to the specified option
3274 so that instance variables declared outside the scope of any access
3275 modifier directives default to the specified visibility.
3277 @item -gen-decls
3278 @opindex gen-decls
3279 Dump interface declarations for all classes seen in the source file to a
3280 file named @file{@var{sourcename}.decl}.
3282 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3283 @opindex Wassign-intercept
3284 @opindex Wno-assign-intercept
3285 Warn whenever an Objective-C assignment is being intercepted by the
3286 garbage collector.
3288 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3289 @opindex Wno-protocol
3290 @opindex Wprotocol
3291 If a class is declared to implement a protocol, a warning is issued for
3292 every method in the protocol that is not implemented by the class.  The
3293 default behavior is to issue a warning for every method not explicitly
3294 implemented in the class, even if a method implementation is inherited
3295 from the superclass.  If you use the @option{-Wno-protocol} option, then
3296 methods inherited from the superclass are considered to be implemented,
3297 and no warning is issued for them.
3299 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3300 @opindex Wselector
3301 @opindex Wno-selector
3302 Warn if multiple methods of different types for the same selector are
3303 found during compilation.  The check is performed on the list of methods
3304 in the final stage of compilation.  Additionally, a check is performed
3305 for each selector appearing in a @code{@@selector(@dots{})}
3306 expression, and a corresponding method for that selector has been found
3307 during compilation.  Because these checks scan the method table only at
3308 the end of compilation, these warnings are not produced if the final
3309 stage of compilation is not reached, for example because an error is
3310 found during compilation, or because the @option{-fsyntax-only} option is
3311 being used.
3313 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3314 @opindex Wstrict-selector-match
3315 @opindex Wno-strict-selector-match
3316 Warn if multiple methods with differing argument and/or return types are
3317 found for a given selector when attempting to send a message using this
3318 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3319 is off (which is the default behavior), the compiler omits such warnings
3320 if any differences found are confined to types that share the same size
3321 and alignment.
3323 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3324 @opindex Wundeclared-selector
3325 @opindex Wno-undeclared-selector
3326 Warn if a @code{@@selector(@dots{})} expression referring to an
3327 undeclared selector is found.  A selector is considered undeclared if no
3328 method with that name has been declared before the
3329 @code{@@selector(@dots{})} expression, either explicitly in an
3330 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3331 an @code{@@implementation} section.  This option always performs its
3332 checks as soon as a @code{@@selector(@dots{})} expression is found,
3333 while @option{-Wselector} only performs its checks in the final stage of
3334 compilation.  This also enforces the coding style convention
3335 that methods and selectors must be declared before being used.
3337 @item -print-objc-runtime-info
3338 @opindex print-objc-runtime-info
3339 Generate C header describing the largest structure that is passed by
3340 value, if any.
3342 @end table
3344 @node Diagnostic Message Formatting Options
3345 @section Options to Control Diagnostic Messages Formatting
3346 @cindex options to control diagnostics formatting
3347 @cindex diagnostic messages
3348 @cindex message formatting
3350 Traditionally, diagnostic messages have been formatted irrespective of
3351 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3352 options described below
3353 to control the formatting algorithm for diagnostic messages, 
3354 e.g.@: how many characters per line, how often source location
3355 information should be reported.  Note that some language front ends may not
3356 honor these options.
3358 @table @gcctabopt
3359 @item -fmessage-length=@var{n}
3360 @opindex fmessage-length
3361 Try to format error messages so that they fit on lines of about
3362 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3363 done; each error message appears on a single line.  This is the
3364 default for all front ends.
3366 @item -fdiagnostics-show-location=once
3367 @opindex fdiagnostics-show-location
3368 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3369 reporter to emit source location information @emph{once}; that is, in
3370 case the message is too long to fit on a single physical line and has to
3371 be wrapped, the source location won't be emitted (as prefix) again,
3372 over and over, in subsequent continuation lines.  This is the default
3373 behavior.
3375 @item -fdiagnostics-show-location=every-line
3376 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3377 messages reporter to emit the same source location information (as
3378 prefix) for physical lines that result from the process of breaking
3379 a message which is too long to fit on a single line.
3381 @item -fdiagnostics-color[=@var{WHEN}]
3382 @itemx -fno-diagnostics-color
3383 @opindex fdiagnostics-color
3384 @cindex highlight, color
3385 @vindex GCC_COLORS @r{environment variable}
3386 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3387 or @samp{auto}.  The default depends on how the compiler has been configured,
3388 it can be any of the above @var{WHEN} options or also @samp{never}
3389 if @env{GCC_COLORS} environment variable isn't present in the environment,
3390 and @samp{auto} otherwise.
3391 @samp{auto} means to use color only when the standard error is a terminal.
3392 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3393 aliases for @option{-fdiagnostics-color=always} and
3394 @option{-fdiagnostics-color=never}, respectively.
3396 The colors are defined by the environment variable @env{GCC_COLORS}.
3397 Its value is a colon-separated list of capabilities and Select Graphic
3398 Rendition (SGR) substrings. SGR commands are interpreted by the
3399 terminal or terminal emulator.  (See the section in the documentation
3400 of your text terminal for permitted values and their meanings as
3401 character attributes.)  These substring values are integers in decimal
3402 representation and can be concatenated with semicolons.
3403 Common values to concatenate include
3404 @samp{1} for bold,
3405 @samp{4} for underline,
3406 @samp{5} for blink,
3407 @samp{7} for inverse,
3408 @samp{39} for default foreground color,
3409 @samp{30} to @samp{37} for foreground colors,
3410 @samp{90} to @samp{97} for 16-color mode foreground colors,
3411 @samp{38;5;0} to @samp{38;5;255}
3412 for 88-color and 256-color modes foreground colors,
3413 @samp{49} for default background color,
3414 @samp{40} to @samp{47} for background colors,
3415 @samp{100} to @samp{107} for 16-color mode background colors,
3416 and @samp{48;5;0} to @samp{48;5;255}
3417 for 88-color and 256-color modes background colors.
3419 The default @env{GCC_COLORS} is
3420 @smallexample
3421 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3422 quote=01:fixit-insert=32:fixit-delete=31:\
3423 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
3424 @end smallexample
3425 @noindent
3426 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3427 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3428 @samp{01} is bold, and @samp{31} is red.
3429 Setting @env{GCC_COLORS} to the empty string disables colors.
3430 Supported capabilities are as follows.
3432 @table @code
3433 @item error=
3434 @vindex error GCC_COLORS @r{capability}
3435 SGR substring for error: markers.
3437 @item warning=
3438 @vindex warning GCC_COLORS @r{capability}
3439 SGR substring for warning: markers.
3441 @item note=
3442 @vindex note GCC_COLORS @r{capability}
3443 SGR substring for note: markers.
3445 @item range1=
3446 @vindex range1 GCC_COLORS @r{capability}
3447 SGR substring for first additional range.
3449 @item range2=
3450 @vindex range2 GCC_COLORS @r{capability}
3451 SGR substring for second additional range.
3453 @item locus=
3454 @vindex locus GCC_COLORS @r{capability}
3455 SGR substring for location information, @samp{file:line} or
3456 @samp{file:line:column} etc.
3458 @item quote=
3459 @vindex quote GCC_COLORS @r{capability}
3460 SGR substring for information printed within quotes.
3462 @item fixit-insert=
3463 @vindex fixit-insert GCC_COLORS @r{capability}
3464 SGR substring for fix-it hints suggesting text to
3465 be inserted or replaced.
3467 @item fixit-delete=
3468 @vindex fixit-delete GCC_COLORS @r{capability}
3469 SGR substring for fix-it hints suggesting text to
3470 be deleted.
3472 @item diff-filename=
3473 @vindex diff-filename GCC_COLORS @r{capability}
3474 SGR substring for filename headers within generated patches.
3476 @item diff-hunk=
3477 @vindex diff-hunk GCC_COLORS @r{capability}
3478 SGR substring for the starts of hunks within generated patches.
3480 @item diff-delete=
3481 @vindex diff-delete GCC_COLORS @r{capability}
3482 SGR substring for deleted lines within generated patches.
3484 @item diff-insert=
3485 @vindex diff-insert GCC_COLORS @r{capability}
3486 SGR substring for inserted lines within generated patches.
3487 @end table
3489 @item -fno-diagnostics-show-option
3490 @opindex fno-diagnostics-show-option
3491 @opindex fdiagnostics-show-option
3492 By default, each diagnostic emitted includes text indicating the
3493 command-line option that directly controls the diagnostic (if such an
3494 option is known to the diagnostic machinery).  Specifying the
3495 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3497 @item -fno-diagnostics-show-caret
3498 @opindex fno-diagnostics-show-caret
3499 @opindex fdiagnostics-show-caret
3500 By default, each diagnostic emitted includes the original source line
3501 and a caret @samp{^} indicating the column.  This option suppresses this
3502 information.  The source line is truncated to @var{n} characters, if
3503 the @option{-fmessage-length=n} option is given.  When the output is done
3504 to the terminal, the width is limited to the width given by the
3505 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3507 @item -fdiagnostics-parseable-fixits
3508 @opindex fdiagnostics-parseable-fixits
3509 Emit fix-it hints in a machine-parseable format, suitable for consumption
3510 by IDEs.  For each fix-it, a line will be printed after the relevant
3511 diagnostic, starting with the string ``fix-it:''.  For example:
3513 @smallexample
3514 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3515 @end smallexample
3517 The location is expressed as a half-open range, expressed as a count of
3518 bytes, starting at byte 1 for the initial column.  In the above example,
3519 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3520 given string:
3522 @smallexample
3523 00000000011111111112222222222
3524 12345678901234567890123456789
3525   gtk_widget_showall (dlg);
3526   ^^^^^^^^^^^^^^^^^^
3527   gtk_widget_show_all
3528 @end smallexample
3530 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3531 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3532 (e.g. vertical tab as ``\013'').
3534 An empty replacement string indicates that the given range is to be removed.
3535 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3536 be inserted at the given position.
3538 @item -fdiagnostics-generate-patch
3539 @opindex fdiagnostics-generate-patch
3540 Print fix-it hints to stderr in unified diff format, after any diagnostics
3541 are printed.  For example:
3543 @smallexample
3544 --- test.c
3545 +++ test.c
3546 @@ -42,5 +42,5 @@
3548  void show_cb(GtkDialog *dlg)
3549  @{
3550 -  gtk_widget_showall(dlg);
3551 +  gtk_widget_show_all(dlg);
3552  @}
3554 @end smallexample
3556 The diff may or may not be colorized, following the same rules
3557 as for diagnostics (see @option{-fdiagnostics-color}).
3559 @item -fno-show-column
3560 @opindex fno-show-column
3561 Do not print column numbers in diagnostics.  This may be necessary if
3562 diagnostics are being scanned by a program that does not understand the
3563 column numbers, such as @command{dejagnu}.
3565 @end table
3567 @node Warning Options
3568 @section Options to Request or Suppress Warnings
3569 @cindex options to control warnings
3570 @cindex warning messages
3571 @cindex messages, warning
3572 @cindex suppressing warnings
3574 Warnings are diagnostic messages that report constructions that
3575 are not inherently erroneous but that are risky or suggest there
3576 may have been an error.
3578 The following language-independent options do not enable specific
3579 warnings but control the kinds of diagnostics produced by GCC@.
3581 @table @gcctabopt
3582 @cindex syntax checking
3583 @item -fsyntax-only
3584 @opindex fsyntax-only
3585 Check the code for syntax errors, but don't do anything beyond that.
3587 @item -fmax-errors=@var{n}
3588 @opindex fmax-errors
3589 Limits the maximum number of error messages to @var{n}, at which point
3590 GCC bails out rather than attempting to continue processing the source
3591 code.  If @var{n} is 0 (the default), there is no limit on the number
3592 of error messages produced.  If @option{-Wfatal-errors} is also
3593 specified, then @option{-Wfatal-errors} takes precedence over this
3594 option.
3596 @item -w
3597 @opindex w
3598 Inhibit all warning messages.
3600 @item -Werror
3601 @opindex Werror
3602 @opindex Wno-error
3603 Make all warnings into errors.
3605 @item -Werror=
3606 @opindex Werror=
3607 @opindex Wno-error=
3608 Make the specified warning into an error.  The specifier for a warning
3609 is appended; for example @option{-Werror=switch} turns the warnings
3610 controlled by @option{-Wswitch} into errors.  This switch takes a
3611 negative form, to be used to negate @option{-Werror} for specific
3612 warnings; for example @option{-Wno-error=switch} makes
3613 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3614 is in effect.
3616 The warning message for each controllable warning includes the
3617 option that controls the warning.  That option can then be used with
3618 @option{-Werror=} and @option{-Wno-error=} as described above.
3619 (Printing of the option in the warning message can be disabled using the
3620 @option{-fno-diagnostics-show-option} flag.)
3622 Note that specifying @option{-Werror=}@var{foo} automatically implies
3623 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3624 imply anything.
3626 @item -Wfatal-errors
3627 @opindex Wfatal-errors
3628 @opindex Wno-fatal-errors
3629 This option causes the compiler to abort compilation on the first error
3630 occurred rather than trying to keep going and printing further error
3631 messages.
3633 @end table
3635 You can request many specific warnings with options beginning with
3636 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3637 implicit declarations.  Each of these specific warning options also
3638 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3639 example, @option{-Wno-implicit}.  This manual lists only one of the
3640 two forms, whichever is not the default.  For further
3641 language-specific options also refer to @ref{C++ Dialect Options} and
3642 @ref{Objective-C and Objective-C++ Dialect Options}.
3644 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3645 options, such as @option{-Wunused}, which may turn on further options,
3646 such as @option{-Wunused-value}. The combined effect of positive and
3647 negative forms is that more specific options have priority over less
3648 specific ones, independently of their position in the command-line. For
3649 options of the same specificity, the last one takes effect. Options
3650 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3651 as if they appeared at the end of the command-line.
3653 When an unrecognized warning option is requested (e.g.,
3654 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3655 that the option is not recognized.  However, if the @option{-Wno-} form
3656 is used, the behavior is slightly different: no diagnostic is
3657 produced for @option{-Wno-unknown-warning} unless other diagnostics
3658 are being produced.  This allows the use of new @option{-Wno-} options
3659 with old compilers, but if something goes wrong, the compiler
3660 warns that an unrecognized option is present.
3662 @table @gcctabopt
3663 @item -Wpedantic
3664 @itemx -pedantic
3665 @opindex pedantic
3666 @opindex Wpedantic
3667 Issue all the warnings demanded by strict ISO C and ISO C++;
3668 reject all programs that use forbidden extensions, and some other
3669 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3670 version of the ISO C standard specified by any @option{-std} option used.
3672 Valid ISO C and ISO C++ programs should compile properly with or without
3673 this option (though a rare few require @option{-ansi} or a
3674 @option{-std} option specifying the required version of ISO C)@.  However,
3675 without this option, certain GNU extensions and traditional C and C++
3676 features are supported as well.  With this option, they are rejected.
3678 @option{-Wpedantic} does not cause warning messages for use of the
3679 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3680 warnings are also disabled in the expression that follows
3681 @code{__extension__}.  However, only system header files should use
3682 these escape routes; application programs should avoid them.
3683 @xref{Alternate Keywords}.
3685 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3686 C conformance.  They soon find that it does not do quite what they want:
3687 it finds some non-ISO practices, but not all---only those for which
3688 ISO C @emph{requires} a diagnostic, and some others for which
3689 diagnostics have been added.
3691 A feature to report any failure to conform to ISO C might be useful in
3692 some instances, but would require considerable additional work and would
3693 be quite different from @option{-Wpedantic}.  We don't have plans to
3694 support such a feature in the near future.
3696 Where the standard specified with @option{-std} represents a GNU
3697 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3698 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3699 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3700 where they are required by the base standard.  (It does not make sense
3701 for such warnings to be given only for features not in the specified GNU
3702 C dialect, since by definition the GNU dialects of C include all
3703 features the compiler supports with the given option, and there would be
3704 nothing to warn about.)
3706 @item -pedantic-errors
3707 @opindex pedantic-errors
3708 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3709 requires a diagnostic, in some cases where there is undefined behavior
3710 at compile-time and in some other cases that do not prevent compilation
3711 of programs that are valid according to the standard. This is not
3712 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3713 by this option and not enabled by the latter and vice versa.
3715 @item -Wall
3716 @opindex Wall
3717 @opindex Wno-all
3718 This enables all the warnings about constructions that some users
3719 consider questionable, and that are easy to avoid (or modify to
3720 prevent the warning), even in conjunction with macros.  This also
3721 enables some language-specific warnings described in @ref{C++ Dialect
3722 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3724 @option{-Wall} turns on the following warning flags:
3726 @gccoptlist{-Waddress   @gol
3727 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3728 -Wbool-compare  @gol
3729 -Wbool-operation  @gol
3730 -Wc++11-compat  -Wc++14-compat  @gol
3731 -Wchar-subscripts  @gol
3732 -Wcomment  @gol
3733 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3734 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3735 -Wformat   @gol
3736 -Wint-in-bool-context  @gol
3737 -Wimplicit @r{(C and Objective-C only)} @gol
3738 -Wimplicit-int @r{(C and Objective-C only)} @gol
3739 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3740 -Winit-self @r{(only for C++)} @gol
3741 -Wlogical-not-parentheses @gol
3742 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3743 -Wmaybe-uninitialized @gol
3744 -Wmemset-elt-size @gol
3745 -Wmemset-transposed-args @gol
3746 -Wmisleading-indentation @r{(only for C/C++)} @gol
3747 -Wmissing-braces @r{(only for C/ObjC)} @gol
3748 -Wnarrowing @r{(only for C++)}  @gol
3749 -Wnonnull  @gol
3750 -Wnonnull-compare  @gol
3751 -Wopenmp-simd @gol
3752 -Wparentheses  @gol
3753 -Wpointer-sign  @gol
3754 -Wreorder   @gol
3755 -Wreturn-type  @gol
3756 -Wsequence-point  @gol
3757 -Wsign-compare @r{(only in C++)}  @gol
3758 -Wsizeof-pointer-memaccess @gol
3759 -Wstrict-aliasing  @gol
3760 -Wstrict-overflow=1  @gol
3761 -Wswitch  @gol
3762 -Wtautological-compare  @gol
3763 -Wtrigraphs  @gol
3764 -Wuninitialized  @gol
3765 -Wunknown-pragmas  @gol
3766 -Wunused-function  @gol
3767 -Wunused-label     @gol
3768 -Wunused-value     @gol
3769 -Wunused-variable  @gol
3770 -Wvolatile-register-var @gol
3773 Note that some warning flags are not implied by @option{-Wall}.  Some of
3774 them warn about constructions that users generally do not consider
3775 questionable, but which occasionally you might wish to check for;
3776 others warn about constructions that are necessary or hard to avoid in
3777 some cases, and there is no simple way to modify the code to suppress
3778 the warning. Some of them are enabled by @option{-Wextra} but many of
3779 them must be enabled individually.
3781 @item -Wextra
3782 @opindex W
3783 @opindex Wextra
3784 @opindex Wno-extra
3785 This enables some extra warning flags that are not enabled by
3786 @option{-Wall}. (This option used to be called @option{-W}.  The older
3787 name is still supported, but the newer name is more descriptive.)
3789 @gccoptlist{-Wclobbered  @gol
3790 -Wempty-body  @gol
3791 -Wignored-qualifiers @gol
3792 -Wimplicit-fallthrough=3 @gol
3793 -Wmissing-field-initializers  @gol
3794 -Wmissing-parameter-type @r{(C only)}  @gol
3795 -Wold-style-declaration @r{(C only)}  @gol
3796 -Woverride-init  @gol
3797 -Wsign-compare @r{(C only)} @gol
3798 -Wtype-limits  @gol
3799 -Wuninitialized  @gol
3800 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3801 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3802 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3805 The option @option{-Wextra} also prints warning messages for the
3806 following cases:
3808 @itemize @bullet
3810 @item
3811 A pointer is compared against integer zero with @code{<}, @code{<=},
3812 @code{>}, or @code{>=}.
3814 @item
3815 (C++ only) An enumerator and a non-enumerator both appear in a
3816 conditional expression.
3818 @item
3819 (C++ only) Ambiguous virtual bases.
3821 @item
3822 (C++ only) Subscripting an array that has been declared @code{register}.
3824 @item
3825 (C++ only) Taking the address of a variable that has been declared
3826 @code{register}.
3828 @item
3829 (C++ only) A base class is not initialized in the copy constructor
3830 of a derived class.
3832 @end itemize
3834 @item -Wchar-subscripts
3835 @opindex Wchar-subscripts
3836 @opindex Wno-char-subscripts
3837 Warn if an array subscript has type @code{char}.  This is a common cause
3838 of error, as programmers often forget that this type is signed on some
3839 machines.
3840 This warning is enabled by @option{-Wall}.
3842 @item -Wno-coverage-mismatch
3843 @opindex Wno-coverage-mismatch
3844 Warn if feedback profiles do not match when using the
3845 @option{-fprofile-use} option.
3846 If a source file is changed between compiling with @option{-fprofile-gen} and
3847 with @option{-fprofile-use}, the files with the profile feedback can fail
3848 to match the source file and GCC cannot use the profile feedback
3849 information.  By default, this warning is enabled and is treated as an
3850 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3851 warning or @option{-Wno-error=coverage-mismatch} can be used to
3852 disable the error.  Disabling the error for this warning can result in
3853 poorly optimized code and is useful only in the
3854 case of very minor changes such as bug fixes to an existing code-base.
3855 Completely disabling the warning is not recommended.
3857 @item -Wno-cpp
3858 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3860 Suppress warning messages emitted by @code{#warning} directives.
3862 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3863 @opindex Wdouble-promotion
3864 @opindex Wno-double-promotion
3865 Give a warning when a value of type @code{float} is implicitly
3866 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3867 floating-point unit implement @code{float} in hardware, but emulate
3868 @code{double} in software.  On such a machine, doing computations
3869 using @code{double} values is much more expensive because of the
3870 overhead required for software emulation.
3872 It is easy to accidentally do computations with @code{double} because
3873 floating-point literals are implicitly of type @code{double}.  For
3874 example, in:
3875 @smallexample
3876 @group
3877 float area(float radius)
3879    return 3.14159 * radius * radius;
3881 @end group
3882 @end smallexample
3883 the compiler performs the entire computation with @code{double}
3884 because the floating-point literal is a @code{double}.
3886 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3887 @opindex Wduplicate-decl-specifier
3888 @opindex Wno-duplicate-decl-specifier
3889 Warn if a declaration has duplicate @code{const}, @code{volatile},
3890 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3891 @option{-Wall}.
3893 @item -Wformat
3894 @itemx -Wformat=@var{n}
3895 @opindex Wformat
3896 @opindex Wno-format
3897 @opindex ffreestanding
3898 @opindex fno-builtin
3899 @opindex Wformat=
3900 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3901 the arguments supplied have types appropriate to the format string
3902 specified, and that the conversions specified in the format string make
3903 sense.  This includes standard functions, and others specified by format
3904 attributes (@pxref{Function Attributes}), in the @code{printf},
3905 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3906 not in the C standard) families (or other target-specific families).
3907 Which functions are checked without format attributes having been
3908 specified depends on the standard version selected, and such checks of
3909 functions without the attribute specified are disabled by
3910 @option{-ffreestanding} or @option{-fno-builtin}.
3912 The formats are checked against the format features supported by GNU
3913 libc version 2.2.  These include all ISO C90 and C99 features, as well
3914 as features from the Single Unix Specification and some BSD and GNU
3915 extensions.  Other library implementations may not support all these
3916 features; GCC does not support warning about features that go beyond a
3917 particular library's limitations.  However, if @option{-Wpedantic} is used
3918 with @option{-Wformat}, warnings are given about format features not
3919 in the selected standard version (but not for @code{strfmon} formats,
3920 since those are not in any version of the C standard).  @xref{C Dialect
3921 Options,,Options Controlling C Dialect}.
3923 @table @gcctabopt
3924 @item -Wformat=1
3925 @itemx -Wformat
3926 @opindex Wformat
3927 @opindex Wformat=1
3928 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3929 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3930 @option{-Wformat} also checks for null format arguments for several
3931 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3932 aspects of this level of format checking can be disabled by the
3933 options: @option{-Wno-format-contains-nul},
3934 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3935 @option{-Wformat} is enabled by @option{-Wall}.
3937 @item -Wno-format-contains-nul
3938 @opindex Wno-format-contains-nul
3939 @opindex Wformat-contains-nul
3940 If @option{-Wformat} is specified, do not warn about format strings that
3941 contain NUL bytes.
3943 @item -Wno-format-extra-args
3944 @opindex Wno-format-extra-args
3945 @opindex Wformat-extra-args
3946 If @option{-Wformat} is specified, do not warn about excess arguments to a
3947 @code{printf} or @code{scanf} format function.  The C standard specifies
3948 that such arguments are ignored.
3950 Where the unused arguments lie between used arguments that are
3951 specified with @samp{$} operand number specifications, normally
3952 warnings are still given, since the implementation could not know what
3953 type to pass to @code{va_arg} to skip the unused arguments.  However,
3954 in the case of @code{scanf} formats, this option suppresses the
3955 warning if the unused arguments are all pointers, since the Single
3956 Unix Specification says that such unused arguments are allowed.
3958 @item -Wformat-overflow
3959 @itemx -Wformat-overflow=@var{level}
3960 @opindex Wformat-overflow
3961 @opindex Wno-format-overflow
3962 Warn about calls to formatted input/output functions such as @code{sprintf}
3963 and @code{vsprintf} that might overflow the destination buffer.  When the
3964 exact number of bytes written by a format directive cannot be determined
3965 at compile-time it is estimated based on heuristics that depend on the
3966 @var{level} argument and on optimization.  While enabling optimization
3967 will in most cases improve the accuracy of the warning, it may also
3968 result in false positives.
3970 @table @gcctabopt
3971 @item -Wformat-overflow
3972 @item -Wformat-overflow=1
3973 @opindex Wformat-overflow
3974 @opindex Wno-format-overflow
3975 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
3976 employs a conservative approach that warns only about calls that most
3977 likely overflow the buffer.  At this level, numeric arguments to format
3978 directives with unknown values are assumed to have the value of one, and
3979 strings of unknown length to be empty.  Numeric arguments that are known
3980 to be bounded to a subrange of their type, or string arguments whose output
3981 is bounded either by their directive's precision or by a finite set of
3982 string literals, are assumed to take on the value within the range that
3983 results in the most bytes on output.  For example, the call to @code{sprintf}
3984 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
3985 the terminating NUL character (@code{'\0'}) appended by the function
3986 to the destination buffer will be written past its end.  Increasing
3987 the size of the buffer by a single byte is sufficient to avoid the
3988 warning, though it may not be sufficient to avoid the overflow.
3990 @smallexample
3991 void f (int a, int b)
3993   char buf [12];
3994   sprintf (buf, "a = %i, b = %i\n", a, b);
3996 @end smallexample
3998 @item -Wformat-overflow=2
3999 Level @var{2} warns also about calls that might overflow the destination
4000 buffer given an argument of sufficient length or magnitude.  At level
4001 @var{2}, unknown numeric arguments are assumed to have the minimum
4002 representable value for signed types with a precision greater than 1, and
4003 the maximum representable value otherwise.  Unknown string arguments whose
4004 length cannot be assumed to be bounded either by the directive's precision,
4005 or by a finite set of string literals they may evaluate to, or the character
4006 array they may point to, are assumed to be 1 character long.
4008 At level @var{2}, the call in the example above is again diagnosed, but
4009 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4010 @code{%i} directive will write some of its digits beyond the end of
4011 the destination buffer.  To make the call safe regardless of the values
4012 of the two variables, the size of the destination buffer must be increased
4013 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4014 an informational note following the warning.
4016 An alternative to increasing the size of the destination buffer is to
4017 constrain the range of formatted values.  The maximum length of string
4018 arguments can be bounded by specifying the precision in the format
4019 directive.  When numeric arguments of format directives can be assumed
4020 to be bounded by less than the precision of their type, choosing
4021 an appropriate length modifier to the format specifier will reduce
4022 the required buffer size.  For example, if @var{a} and @var{b} in the
4023 example above can be assumed to be within the precision of
4024 the @code{short int} type then using either the @code{%hi} format
4025 directive or casting the argument to @code{short} reduces the maximum
4026 required size of the buffer to 24 bytes.
4028 @smallexample
4029 void f (int a, int b)
4031   char buf [23];
4032   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4034 @end smallexample
4035 @end table
4037 @item -Wno-format-zero-length
4038 @opindex Wno-format-zero-length
4039 @opindex Wformat-zero-length
4040 If @option{-Wformat} is specified, do not warn about zero-length formats.
4041 The C standard specifies that zero-length formats are allowed.
4044 @item -Wformat=2
4045 @opindex Wformat=2
4046 Enable @option{-Wformat} plus additional format checks.  Currently
4047 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4048 -Wformat-y2k}.
4050 @item -Wformat-nonliteral
4051 @opindex Wformat-nonliteral
4052 @opindex Wno-format-nonliteral
4053 If @option{-Wformat} is specified, also warn if the format string is not a
4054 string literal and so cannot be checked, unless the format function
4055 takes its format arguments as a @code{va_list}.
4057 @item -Wformat-security
4058 @opindex Wformat-security
4059 @opindex Wno-format-security
4060 If @option{-Wformat} is specified, also warn about uses of format
4061 functions that represent possible security problems.  At present, this
4062 warns about calls to @code{printf} and @code{scanf} functions where the
4063 format string is not a string literal and there are no format arguments,
4064 as in @code{printf (foo);}.  This may be a security hole if the format
4065 string came from untrusted input and contains @samp{%n}.  (This is
4066 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4067 in future warnings may be added to @option{-Wformat-security} that are not
4068 included in @option{-Wformat-nonliteral}.)
4070 @item -Wformat-signedness
4071 @opindex Wformat-signedness
4072 @opindex Wno-format-signedness
4073 If @option{-Wformat} is specified, also warn if the format string
4074 requires an unsigned argument and the argument is signed and vice versa.
4076 @item -Wformat-truncation
4077 @itemx -Wformat-truncation=@var{level}
4078 @opindex Wformat-truncation
4079 @opindex Wno-format-truncation
4080 Warn about calls to formatted input/output functions such as @code{snprintf}
4081 and @code{vsnprintf} that might result in output truncation.  When the exact
4082 number of bytes written by a format directive cannot be determined at
4083 compile-time it is estimated based on heuristics that depend on
4084 the @var{level} argument and on optimization.  While enabling optimization
4085 will in most cases improve the accuracy of the warning, it may also result
4086 in false positives.  Except as noted otherwise, the option uses the same
4087 logic @option{-Wformat-overflow}.
4089 @table @gcctabopt
4090 @item -Wformat-truncation
4091 @item -Wformat-truncation=1
4092 @opindex Wformat-truncation
4093 @opindex Wno-format-overflow
4094 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4095 employs a conservative approach that warns only about calls to bounded
4096 functions whose return value is unused and that will most likely result
4097 in output truncation.
4099 @item -Wformat-truncation=2
4100 Level @var{2} warns also about calls to bounded functions whose return
4101 value is used and that might result in truncation given an argument of
4102 sufficient length or magnitude.
4103 @end table
4105 @item -Wformat-y2k
4106 @opindex Wformat-y2k
4107 @opindex Wno-format-y2k
4108 If @option{-Wformat} is specified, also warn about @code{strftime}
4109 formats that may yield only a two-digit year.
4110 @end table
4112 @item -Wnonnull
4113 @opindex Wnonnull
4114 @opindex Wno-nonnull
4115 Warn about passing a null pointer for arguments marked as
4116 requiring a non-null value by the @code{nonnull} function attribute.
4118 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4119 can be disabled with the @option{-Wno-nonnull} option.
4121 @item -Wnonnull-compare
4122 @opindex Wnonnull-compare
4123 @opindex Wno-nonnull-compare
4124 Warn when comparing an argument marked with the @code{nonnull}
4125 function attribute against null inside the function.
4127 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4128 can be disabled with the @option{-Wno-nonnull-compare} option.
4130 @item -Wnull-dereference
4131 @opindex Wnull-dereference
4132 @opindex Wno-null-dereference
4133 Warn if the compiler detects paths that trigger erroneous or
4134 undefined behavior due to dereferencing a null pointer.  This option
4135 is only active when @option{-fdelete-null-pointer-checks} is active,
4136 which is enabled by optimizations in most targets.  The precision of
4137 the warnings depends on the optimization options used.
4139 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4140 @opindex Winit-self
4141 @opindex Wno-init-self
4142 Warn about uninitialized variables that are initialized with themselves.
4143 Note this option can only be used with the @option{-Wuninitialized} option.
4145 For example, GCC warns about @code{i} being uninitialized in the
4146 following snippet only when @option{-Winit-self} has been specified:
4147 @smallexample
4148 @group
4149 int f()
4151   int i = i;
4152   return i;
4154 @end group
4155 @end smallexample
4157 This warning is enabled by @option{-Wall} in C++.
4159 @item -Wimplicit-int @r{(C and Objective-C only)}
4160 @opindex Wimplicit-int
4161 @opindex Wno-implicit-int
4162 Warn when a declaration does not specify a type.
4163 This warning is enabled by @option{-Wall}.
4165 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4166 @opindex Wimplicit-function-declaration
4167 @opindex Wno-implicit-function-declaration
4168 Give a warning whenever a function is used before being declared. In
4169 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4170 enabled by default and it is made into an error by
4171 @option{-pedantic-errors}. This warning is also enabled by
4172 @option{-Wall}.
4174 @item -Wimplicit @r{(C and Objective-C only)}
4175 @opindex Wimplicit
4176 @opindex Wno-implicit
4177 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4178 This warning is enabled by @option{-Wall}.
4180 @item -Wimplicit-fallthrough
4181 @opindex Wimplicit-fallthrough
4182 @opindex Wno-implicit-fallthrough
4183 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4184 and @option{-Wno-implicit-fallthrough} is the same as
4185 @option{-Wimplicit-fallthrough=0}.
4187 @item -Wimplicit-fallthrough=@var{n}
4188 @opindex Wimplicit-fallthrough=
4189 Warn when a switch case falls through.  For example:
4191 @smallexample
4192 @group
4193 switch (cond)
4194   @{
4195   case 1:
4196     a = 1;
4197     break;
4198   case 2:
4199     a = 2;
4200   case 3:
4201     a = 3;
4202     break;
4203   @}
4204 @end group
4205 @end smallexample
4207 This warning does not warn when the last statement of a case cannot
4208 fall through, e.g. when there is a return statement or a call to function
4209 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4210 also takes into account control flow statements, such as ifs, and only
4211 warns when appropriate.  E.g.@:
4213 @smallexample
4214 @group
4215 switch (cond)
4216   @{
4217   case 1:
4218     if (i > 3) @{
4219       bar (5);
4220       break;
4221     @} else if (i < 1) @{
4222       bar (0);
4223     @} else
4224       return;
4225   default:
4226     @dots{}
4227   @}
4228 @end group
4229 @end smallexample
4231 Since there are occasions where a switch case fall through is desirable,
4232 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4233 to be used along with a null statement to suppress this warning that
4234 would normally occur:
4236 @smallexample
4237 @group
4238 switch (cond)
4239   @{
4240   case 1:
4241     bar (0);
4242     __attribute__ ((fallthrough));
4243   default:
4244     @dots{}
4245   @}
4246 @end group
4247 @end smallexample
4249 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4250 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4251 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4252 Instead of the these attributes, it is also possible to add a fallthrough
4253 comment to silence the warning.  The whole body of the C or C++ style comment
4254 should match the given regular expressions listed below.  The option argument
4255 @var{n} specifies what kind of comments are accepted:
4257 @itemize @bullet
4259 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4261 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4262 expression, any comment is used as fallthrough comment.
4264 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4265 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4267 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4268 following regular expressions:
4270 @itemize @bullet
4272 @item @code{-fallthrough}
4274 @item @code{@@fallthrough@@}
4276 @item @code{lint -fallthrough[ \t]*}
4278 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4280 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4282 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4284 @end itemize
4286 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4287 following regular expressions:
4289 @itemize @bullet
4291 @item @code{-fallthrough}
4293 @item @code{@@fallthrough@@}
4295 @item @code{lint -fallthrough[ \t]*}
4297 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4299 @end itemize
4301 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4302 fallthrough comments, only attributes disable the warning.
4304 @end itemize
4306 The comment needs to be followed after optional whitespace and other comments
4307 by @code{case} or @code{default} keywords or by a user label that precedes some
4308 @code{case} or @code{default} label.
4310 @smallexample
4311 @group
4312 switch (cond)
4313   @{
4314   case 1:
4315     bar (0);
4316     /* FALLTHRU */
4317   default:
4318     @dots{}
4319   @}
4320 @end group
4321 @end smallexample
4323 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4325 @item -Wignored-qualifiers @r{(C and C++ only)}
4326 @opindex Wignored-qualifiers
4327 @opindex Wno-ignored-qualifiers
4328 Warn if the return type of a function has a type qualifier
4329 such as @code{const}.  For ISO C such a type qualifier has no effect,
4330 since the value returned by a function is not an lvalue.
4331 For C++, the warning is only emitted for scalar types or @code{void}.
4332 ISO C prohibits qualified @code{void} return types on function
4333 definitions, so such return types always receive a warning
4334 even without this option.
4336 This warning is also enabled by @option{-Wextra}.
4338 @item -Wignored-attributes @r{(C and C++ only)}
4339 @opindex Wignored-attributes
4340 @opindex Wno-ignored-attributes
4341 Warn when an attribute is ignored.  This is different from the
4342 @option{-Wattributes} option in that it warns whenever the compiler decides
4343 to drop an attribute, not that the attribute is either unknown, used in a
4344 wrong place, etc.  This warning is enabled by default.
4346 @item -Wmain
4347 @opindex Wmain
4348 @opindex Wno-main
4349 Warn if the type of @code{main} is suspicious.  @code{main} should be
4350 a function with external linkage, returning int, taking either zero
4351 arguments, two, or three arguments of appropriate types.  This warning
4352 is enabled by default in C++ and is enabled by either @option{-Wall}
4353 or @option{-Wpedantic}.
4355 @item -Wmisleading-indentation @r{(C and C++ only)}
4356 @opindex Wmisleading-indentation
4357 @opindex Wno-misleading-indentation
4358 Warn when the indentation of the code does not reflect the block structure.
4359 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4360 @code{for} clauses with a guarded statement that does not use braces,
4361 followed by an unguarded statement with the same indentation.
4363 In the following example, the call to ``bar'' is misleadingly indented as
4364 if it were guarded by the ``if'' conditional.
4366 @smallexample
4367   if (some_condition ())
4368     foo ();
4369     bar ();  /* Gotcha: this is not guarded by the "if".  */
4370 @end smallexample
4372 In the case of mixed tabs and spaces, the warning uses the
4373 @option{-ftabstop=} option to determine if the statements line up
4374 (defaulting to 8).
4376 The warning is not issued for code involving multiline preprocessor logic
4377 such as the following example.
4379 @smallexample
4380   if (flagA)
4381     foo (0);
4382 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4383   if (flagB)
4384 #endif
4385     foo (1);
4386 @end smallexample
4388 The warning is not issued after a @code{#line} directive, since this
4389 typically indicates autogenerated code, and no assumptions can be made
4390 about the layout of the file that the directive references.
4392 This warning is enabled by @option{-Wall} in C and C++.
4394 @item -Wmissing-braces
4395 @opindex Wmissing-braces
4396 @opindex Wno-missing-braces
4397 Warn if an aggregate or union initializer is not fully bracketed.  In
4398 the following example, the initializer for @code{a} is not fully
4399 bracketed, but that for @code{b} is fully bracketed.  This warning is
4400 enabled by @option{-Wall} in C.
4402 @smallexample
4403 int a[2][2] = @{ 0, 1, 2, 3 @};
4404 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4405 @end smallexample
4407 This warning is enabled by @option{-Wall}.
4409 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4410 @opindex Wmissing-include-dirs
4411 @opindex Wno-missing-include-dirs
4412 Warn if a user-supplied include directory does not exist.
4414 @item -Wparentheses
4415 @opindex Wparentheses
4416 @opindex Wno-parentheses
4417 Warn if parentheses are omitted in certain contexts, such
4418 as when there is an assignment in a context where a truth value
4419 is expected, or when operators are nested whose precedence people
4420 often get confused about.
4422 Also warn if a comparison like @code{x<=y<=z} appears; this is
4423 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4424 interpretation from that of ordinary mathematical notation.
4426 Also warn for dangerous uses of the GNU extension to
4427 @code{?:} with omitted middle operand. When the condition
4428 in the @code{?}: operator is a boolean expression, the omitted value is
4429 always 1.  Often programmers expect it to be a value computed
4430 inside the conditional expression instead.
4432 This warning is enabled by @option{-Wall}.
4434 @item -Wsequence-point
4435 @opindex Wsequence-point
4436 @opindex Wno-sequence-point
4437 Warn about code that may have undefined semantics because of violations
4438 of sequence point rules in the C and C++ standards.
4440 The C and C++ standards define the order in which expressions in a C/C++
4441 program are evaluated in terms of @dfn{sequence points}, which represent
4442 a partial ordering between the execution of parts of the program: those
4443 executed before the sequence point, and those executed after it.  These
4444 occur after the evaluation of a full expression (one which is not part
4445 of a larger expression), after the evaluation of the first operand of a
4446 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4447 function is called (but after the evaluation of its arguments and the
4448 expression denoting the called function), and in certain other places.
4449 Other than as expressed by the sequence point rules, the order of
4450 evaluation of subexpressions of an expression is not specified.  All
4451 these rules describe only a partial order rather than a total order,
4452 since, for example, if two functions are called within one expression
4453 with no sequence point between them, the order in which the functions
4454 are called is not specified.  However, the standards committee have
4455 ruled that function calls do not overlap.
4457 It is not specified when between sequence points modifications to the
4458 values of objects take effect.  Programs whose behavior depends on this
4459 have undefined behavior; the C and C++ standards specify that ``Between
4460 the previous and next sequence point an object shall have its stored
4461 value modified at most once by the evaluation of an expression.
4462 Furthermore, the prior value shall be read only to determine the value
4463 to be stored.''.  If a program breaks these rules, the results on any
4464 particular implementation are entirely unpredictable.
4466 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4467 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4468 diagnosed by this option, and it may give an occasional false positive
4469 result, but in general it has been found fairly effective at detecting
4470 this sort of problem in programs.
4472 The C++17 standard will define the order of evaluation of operands in
4473 more cases: in particular it requires that the right-hand side of an
4474 assignment be evaluated before the left-hand side, so the above
4475 examples are no longer undefined.  But this warning will still warn
4476 about them, to help people avoid writing code that is undefined in C
4477 and earlier revisions of C++.
4479 The standard is worded confusingly, therefore there is some debate
4480 over the precise meaning of the sequence point rules in subtle cases.
4481 Links to discussions of the problem, including proposed formal
4482 definitions, may be found on the GCC readings page, at
4483 @uref{http://gcc.gnu.org/@/readings.html}.
4485 This warning is enabled by @option{-Wall} for C and C++.
4487 @item -Wno-return-local-addr
4488 @opindex Wno-return-local-addr
4489 @opindex Wreturn-local-addr
4490 Do not warn about returning a pointer (or in C++, a reference) to a
4491 variable that goes out of scope after the function returns.
4493 @item -Wreturn-type
4494 @opindex Wreturn-type
4495 @opindex Wno-return-type
4496 Warn whenever a function is defined with a return type that defaults
4497 to @code{int}.  Also warn about any @code{return} statement with no
4498 return value in a function whose return type is not @code{void}
4499 (falling off the end of the function body is considered returning
4500 without a value).
4502 For C only, warn about a @code{return} statement with an expression in a
4503 function whose return type is @code{void}, unless the expression type is
4504 also @code{void}.  As a GNU extension, the latter case is accepted
4505 without a warning unless @option{-Wpedantic} is used.
4507 For C++, a function without return type always produces a diagnostic
4508 message, even when @option{-Wno-return-type} is specified.  The only
4509 exceptions are @code{main} and functions defined in system headers.
4511 This warning is enabled by @option{-Wall}.
4513 @item -Wshift-count-negative
4514 @opindex Wshift-count-negative
4515 @opindex Wno-shift-count-negative
4516 Warn if shift count is negative. This warning is enabled by default.
4518 @item -Wshift-count-overflow
4519 @opindex Wshift-count-overflow
4520 @opindex Wno-shift-count-overflow
4521 Warn if shift count >= width of type. This warning is enabled by default.
4523 @item -Wshift-negative-value
4524 @opindex Wshift-negative-value
4525 @opindex Wno-shift-negative-value
4526 Warn if left shifting a negative value.  This warning is enabled by
4527 @option{-Wextra} in C99 and C++11 modes (and newer).
4529 @item -Wshift-overflow
4530 @itemx -Wshift-overflow=@var{n}
4531 @opindex Wshift-overflow
4532 @opindex Wno-shift-overflow
4533 Warn about left shift overflows.  This warning is enabled by
4534 default in C99 and C++11 modes (and newer).
4536 @table @gcctabopt
4537 @item -Wshift-overflow=1
4538 This is the warning level of @option{-Wshift-overflow} and is enabled
4539 by default in C99 and C++11 modes (and newer).  This warning level does
4540 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4541 an overflow is still rejected in contexts where an integer constant expression
4542 is required.)
4544 @item -Wshift-overflow=2
4545 This warning level also warns about left-shifting 1 into the sign bit,
4546 unless C++14 mode is active.
4547 @end table
4549 @item -Wswitch
4550 @opindex Wswitch
4551 @opindex Wno-switch
4552 Warn whenever a @code{switch} statement has an index of enumerated type
4553 and lacks a @code{case} for one or more of the named codes of that
4554 enumeration.  (The presence of a @code{default} label prevents this
4555 warning.)  @code{case} labels outside the enumeration range also
4556 provoke warnings when this option is used (even if there is a
4557 @code{default} label).
4558 This warning is enabled by @option{-Wall}.
4560 @item -Wswitch-default
4561 @opindex Wswitch-default
4562 @opindex Wno-switch-default
4563 Warn whenever a @code{switch} statement does not have a @code{default}
4564 case.
4566 @item -Wswitch-enum
4567 @opindex Wswitch-enum
4568 @opindex Wno-switch-enum
4569 Warn whenever a @code{switch} statement has an index of enumerated type
4570 and lacks a @code{case} for one or more of the named codes of that
4571 enumeration.  @code{case} labels outside the enumeration range also
4572 provoke warnings when this option is used.  The only difference
4573 between @option{-Wswitch} and this option is that this option gives a
4574 warning about an omitted enumeration code even if there is a
4575 @code{default} label.
4577 @item -Wswitch-bool
4578 @opindex Wswitch-bool
4579 @opindex Wno-switch-bool
4580 Warn whenever a @code{switch} statement has an index of boolean type
4581 and the case values are outside the range of a boolean type.
4582 It is possible to suppress this warning by casting the controlling
4583 expression to a type other than @code{bool}.  For example:
4584 @smallexample
4585 @group
4586 switch ((int) (a == 4))
4587   @{
4588   @dots{}
4589   @}
4590 @end group
4591 @end smallexample
4592 This warning is enabled by default for C and C++ programs.
4594 @item -Wswitch-unreachable
4595 @opindex Wswitch-unreachable
4596 @opindex Wno-switch-unreachable
4597 Warn whenever a @code{switch} statement contains statements between the
4598 controlling expression and the first case label, which will never be
4599 executed.  For example:
4600 @smallexample
4601 @group
4602 switch (cond)
4603   @{
4604    i = 15;
4605   @dots{}
4606    case 5:
4607   @dots{}
4608   @}
4609 @end group
4610 @end smallexample
4611 @option{-Wswitch-unreachable} does not warn if the statement between the
4612 controlling expression and the first case label is just a declaration:
4613 @smallexample
4614 @group
4615 switch (cond)
4616   @{
4617    int i;
4618   @dots{}
4619    case 5:
4620    i = 5;
4621   @dots{}
4622   @}
4623 @end group
4624 @end smallexample
4625 This warning is enabled by default for C and C++ programs.
4627 @item -Wsync-nand @r{(C and C++ only)}
4628 @opindex Wsync-nand
4629 @opindex Wno-sync-nand
4630 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4631 built-in functions are used.  These functions changed semantics in GCC 4.4.
4633 @item -Wunused-but-set-parameter
4634 @opindex Wunused-but-set-parameter
4635 @opindex Wno-unused-but-set-parameter
4636 Warn whenever a function parameter is assigned to, but otherwise unused
4637 (aside from its declaration).
4639 To suppress this warning use the @code{unused} attribute
4640 (@pxref{Variable Attributes}).
4642 This warning is also enabled by @option{-Wunused} together with
4643 @option{-Wextra}.
4645 @item -Wunused-but-set-variable
4646 @opindex Wunused-but-set-variable
4647 @opindex Wno-unused-but-set-variable
4648 Warn whenever a local variable is assigned to, but otherwise unused
4649 (aside from its declaration).
4650 This warning is enabled by @option{-Wall}.
4652 To suppress this warning use the @code{unused} attribute
4653 (@pxref{Variable Attributes}).
4655 This warning is also enabled by @option{-Wunused}, which is enabled
4656 by @option{-Wall}.
4658 @item -Wunused-function
4659 @opindex Wunused-function
4660 @opindex Wno-unused-function
4661 Warn whenever a static function is declared but not defined or a
4662 non-inline static function is unused.
4663 This warning is enabled by @option{-Wall}.
4665 @item -Wunused-label
4666 @opindex Wunused-label
4667 @opindex Wno-unused-label
4668 Warn whenever a label is declared but not used.
4669 This warning is enabled by @option{-Wall}.
4671 To suppress this warning use the @code{unused} attribute
4672 (@pxref{Variable Attributes}).
4674 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4675 @opindex Wunused-local-typedefs
4676 Warn when a typedef locally defined in a function is not used.
4677 This warning is enabled by @option{-Wall}.
4679 @item -Wunused-parameter
4680 @opindex Wunused-parameter
4681 @opindex Wno-unused-parameter
4682 Warn whenever a function parameter is unused aside from its declaration.
4684 To suppress this warning use the @code{unused} attribute
4685 (@pxref{Variable Attributes}).
4687 @item -Wno-unused-result
4688 @opindex Wunused-result
4689 @opindex Wno-unused-result
4690 Do not warn if a caller of a function marked with attribute
4691 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4692 its return value. The default is @option{-Wunused-result}.
4694 @item -Wunused-variable
4695 @opindex Wunused-variable
4696 @opindex Wno-unused-variable
4697 Warn whenever a local or static variable is unused aside from its
4698 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4699 but not for C++. This warning is enabled by @option{-Wall}.
4701 To suppress this warning use the @code{unused} attribute
4702 (@pxref{Variable Attributes}).
4704 @item -Wunused-const-variable
4705 @itemx -Wunused-const-variable=@var{n}
4706 @opindex Wunused-const-variable
4707 @opindex Wno-unused-const-variable
4708 Warn whenever a constant static variable is unused aside from its declaration.
4709 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4710 for C, but not for C++. In C this declares variable storage, but in C++ this
4711 is not an error since const variables take the place of @code{#define}s.
4713 To suppress this warning use the @code{unused} attribute
4714 (@pxref{Variable Attributes}).
4716 @table @gcctabopt
4717 @item -Wunused-const-variable=1
4718 This is the warning level that is enabled by @option{-Wunused-variable} for
4719 C.  It warns only about unused static const variables defined in the main
4720 compilation unit, but not about static const variables declared in any
4721 header included.
4723 @item -Wunused-const-variable=2
4724 This warning level also warns for unused constant static variables in
4725 headers (excluding system headers).  This is the warning level of
4726 @option{-Wunused-const-variable} and must be explicitly requested since
4727 in C++ this isn't an error and in C it might be harder to clean up all
4728 headers included.
4729 @end table
4731 @item -Wunused-value
4732 @opindex Wunused-value
4733 @opindex Wno-unused-value
4734 Warn whenever a statement computes a result that is explicitly not
4735 used. To suppress this warning cast the unused expression to
4736 @code{void}. This includes an expression-statement or the left-hand
4737 side of a comma expression that contains no side effects. For example,
4738 an expression such as @code{x[i,j]} causes a warning, while
4739 @code{x[(void)i,j]} does not.
4741 This warning is enabled by @option{-Wall}.
4743 @item -Wunused
4744 @opindex Wunused
4745 @opindex Wno-unused
4746 All the above @option{-Wunused} options combined.
4748 In order to get a warning about an unused function parameter, you must
4749 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4750 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4752 @item -Wuninitialized
4753 @opindex Wuninitialized
4754 @opindex Wno-uninitialized
4755 Warn if an automatic variable is used without first being initialized
4756 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4757 warn if a non-static reference or non-static @code{const} member
4758 appears in a class without constructors.
4760 If you want to warn about code that uses the uninitialized value of the
4761 variable in its own initializer, use the @option{-Winit-self} option.
4763 These warnings occur for individual uninitialized or clobbered
4764 elements of structure, union or array variables as well as for
4765 variables that are uninitialized or clobbered as a whole.  They do
4766 not occur for variables or elements declared @code{volatile}.  Because
4767 these warnings depend on optimization, the exact variables or elements
4768 for which there are warnings depends on the precise optimization
4769 options and version of GCC used.
4771 Note that there may be no warning about a variable that is used only
4772 to compute a value that itself is never used, because such
4773 computations may be deleted by data flow analysis before the warnings
4774 are printed.
4776 @item -Winvalid-memory-model
4777 @opindex Winvalid-memory-model
4778 @opindex Wno-invalid-memory-model
4779 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4780 and the C11 atomic generic functions with a memory consistency argument
4781 that is either invalid for the operation or outside the range of values
4782 of the @code{memory_order} enumeration.  For example, since the
4783 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4784 defined for the relaxed, release, and sequentially consistent memory
4785 orders the following code is diagnosed:
4787 @smallexample
4788 void store (int *i)
4790   __atomic_store_n (i, 0, memory_order_consume);
4792 @end smallexample
4794 @option{-Winvalid-memory-model} is enabled by default.
4796 @item -Wmaybe-uninitialized
4797 @opindex Wmaybe-uninitialized
4798 @opindex Wno-maybe-uninitialized
4799 For an automatic variable, if there exists a path from the function
4800 entry to a use of the variable that is initialized, but there exist
4801 some other paths for which the variable is not initialized, the compiler
4802 emits a warning if it cannot prove the uninitialized paths are not
4803 executed at run time. These warnings are made optional because GCC is
4804 not smart enough to see all the reasons why the code might be correct
4805 in spite of appearing to have an error.  Here is one example of how
4806 this can happen:
4808 @smallexample
4809 @group
4811   int x;
4812   switch (y)
4813     @{
4814     case 1: x = 1;
4815       break;
4816     case 2: x = 4;
4817       break;
4818     case 3: x = 5;
4819     @}
4820   foo (x);
4822 @end group
4823 @end smallexample
4825 @noindent
4826 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4827 always initialized, but GCC doesn't know this. To suppress the
4828 warning, you need to provide a default case with assert(0) or
4829 similar code.
4831 @cindex @code{longjmp} warnings
4832 This option also warns when a non-volatile automatic variable might be
4833 changed by a call to @code{longjmp}.  These warnings as well are possible
4834 only in optimizing compilation.
4836 The compiler sees only the calls to @code{setjmp}.  It cannot know
4837 where @code{longjmp} will be called; in fact, a signal handler could
4838 call it at any point in the code.  As a result, you may get a warning
4839 even when there is in fact no problem because @code{longjmp} cannot
4840 in fact be called at the place that would cause a problem.
4842 Some spurious warnings can be avoided if you declare all the functions
4843 you use that never return as @code{noreturn}.  @xref{Function
4844 Attributes}.
4846 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4848 @item -Wunknown-pragmas
4849 @opindex Wunknown-pragmas
4850 @opindex Wno-unknown-pragmas
4851 @cindex warning for unknown pragmas
4852 @cindex unknown pragmas, warning
4853 @cindex pragmas, warning of unknown
4854 Warn when a @code{#pragma} directive is encountered that is not understood by 
4855 GCC@.  If this command-line option is used, warnings are even issued
4856 for unknown pragmas in system header files.  This is not the case if
4857 the warnings are only enabled by the @option{-Wall} command-line option.
4859 @item -Wno-pragmas
4860 @opindex Wno-pragmas
4861 @opindex Wpragmas
4862 Do not warn about misuses of pragmas, such as incorrect parameters,
4863 invalid syntax, or conflicts between pragmas.  See also
4864 @option{-Wunknown-pragmas}.
4866 @item -Wstrict-aliasing
4867 @opindex Wstrict-aliasing
4868 @opindex Wno-strict-aliasing
4869 This option is only active when @option{-fstrict-aliasing} is active.
4870 It warns about code that might break the strict aliasing rules that the
4871 compiler is using for optimization.  The warning does not catch all
4872 cases, but does attempt to catch the more common pitfalls.  It is
4873 included in @option{-Wall}.
4874 It is equivalent to @option{-Wstrict-aliasing=3}
4876 @item -Wstrict-aliasing=n
4877 @opindex Wstrict-aliasing=n
4878 This option is only active when @option{-fstrict-aliasing} is active.
4879 It warns about code that might break the strict aliasing rules that the
4880 compiler is using for optimization.
4881 Higher levels correspond to higher accuracy (fewer false positives).
4882 Higher levels also correspond to more effort, similar to the way @option{-O} 
4883 works.
4884 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4886 Level 1: Most aggressive, quick, least accurate.
4887 Possibly useful when higher levels
4888 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4889 false negatives.  However, it has many false positives.
4890 Warns for all pointer conversions between possibly incompatible types,
4891 even if never dereferenced.  Runs in the front end only.
4893 Level 2: Aggressive, quick, not too precise.
4894 May still have many false positives (not as many as level 1 though),
4895 and few false negatives (but possibly more than level 1).
4896 Unlike level 1, it only warns when an address is taken.  Warns about
4897 incomplete types.  Runs in the front end only.
4899 Level 3 (default for @option{-Wstrict-aliasing}):
4900 Should have very few false positives and few false
4901 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4902 Takes care of the common pun+dereference pattern in the front end:
4903 @code{*(int*)&some_float}.
4904 If optimization is enabled, it also runs in the back end, where it deals
4905 with multiple statement cases using flow-sensitive points-to information.
4906 Only warns when the converted pointer is dereferenced.
4907 Does not warn about incomplete types.
4909 @item -Wstrict-overflow
4910 @itemx -Wstrict-overflow=@var{n}
4911 @opindex Wstrict-overflow
4912 @opindex Wno-strict-overflow
4913 This option is only active when @option{-fstrict-overflow} is active.
4914 It warns about cases where the compiler optimizes based on the
4915 assumption that signed overflow does not occur.  Note that it does not
4916 warn about all cases where the code might overflow: it only warns
4917 about cases where the compiler implements some optimization.  Thus
4918 this warning depends on the optimization level.
4920 An optimization that assumes that signed overflow does not occur is
4921 perfectly safe if the values of the variables involved are such that
4922 overflow never does, in fact, occur.  Therefore this warning can
4923 easily give a false positive: a warning about code that is not
4924 actually a problem.  To help focus on important issues, several
4925 warning levels are defined.  No warnings are issued for the use of
4926 undefined signed overflow when estimating how many iterations a loop
4927 requires, in particular when determining whether a loop will be
4928 executed at all.
4930 @table @gcctabopt
4931 @item -Wstrict-overflow=1
4932 Warn about cases that are both questionable and easy to avoid.  For
4933 example,  with @option{-fstrict-overflow}, the compiler simplifies
4934 @code{x + 1 > x} to @code{1}.  This level of
4935 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4936 are not, and must be explicitly requested.
4938 @item -Wstrict-overflow=2
4939 Also warn about other cases where a comparison is simplified to a
4940 constant.  For example: @code{abs (x) >= 0}.  This can only be
4941 simplified when @option{-fstrict-overflow} is in effect, because
4942 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4943 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4944 @option{-Wstrict-overflow=2}.
4946 @item -Wstrict-overflow=3
4947 Also warn about other cases where a comparison is simplified.  For
4948 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4950 @item -Wstrict-overflow=4
4951 Also warn about other simplifications not covered by the above cases.
4952 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4954 @item -Wstrict-overflow=5
4955 Also warn about cases where the compiler reduces the magnitude of a
4956 constant involved in a comparison.  For example: @code{x + 2 > y} is
4957 simplified to @code{x + 1 >= y}.  This is reported only at the
4958 highest warning level because this simplification applies to many
4959 comparisons, so this warning level gives a very large number of
4960 false positives.
4961 @end table
4963 @item -Wstringop-overflow
4964 @itemx -Wstringop-overflow=@var{type}
4965 @opindex Wstringop-overflow
4966 @opindex Wno-stringop-overflow
4967 Warn for calls to string manipulation functions such as @code{memcpy} and
4968 @code{strcpy} that are determined to overflow the destination buffer.  The
4969 optional argument is one greater than the type of Object Size Checking to
4970 perform to determine the size of the destination.  @xref{Object Size Checking}.
4971 The argument is meaningful only for functions that operate on character arrays
4972 but not for raw memory functions like @code{memcpy} which always make use
4973 of Object Size type-0.  The option also warns for calls that specify a size
4974 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
4975 The option produces the best results with optimization enabled but can detect
4976 a small subset of simple buffer overflows even without optimization in
4977 calls to the GCC built-in functions like @code{__builtin_memcpy} that
4978 correspond to the standard functions.  In any case, the option warns about
4979 just a subset of buffer overflows detected by the corresponding overflow
4980 checking built-ins.  For example, the option will issue a warning for
4981 the @code{strcpy} call below because it copies at least 5 characters
4982 (the string @code{"blue"} including the terminating NUL) into the buffer
4983 of size 4.
4985 @smallexample
4986 enum Color @{ blue, purple, yellow @};
4987 const char* f (enum Color clr)
4989   static char buf [4];
4990   const char *str;
4991   switch (clr)
4992     @{
4993       case blue: str = "blue"; break;
4994       case purple: str = "purple"; break;
4995       case yellow: str = "yellow"; break;
4996     @}
4998   return strcpy (buf, str);   // warning here
5000 @end smallexample
5002 Option @option{-Wstringop-overflow=2} is enabled by default.
5004 @table @gcctabopt
5005 @item -Wstringop-overflow
5006 @item -Wstringop-overflow=1
5007 @opindex Wstringop-overflow
5008 @opindex Wno-stringop-overflow
5009 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5010 to determine the sizes of destination objects.  This is the default setting
5011 of the option.  At this setting the option will not warn for writes past
5012 the end of subobjects of larger objects accessed by pointers unless the
5013 size of the largest surrounding object is known.  When the destination may
5014 be one of several objects it is assumed to be the largest one of them.  On
5015 Linux systems, when optimization is enabled at this setting the option warns
5016 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5017 a non-zero value.
5019 @item -Wstringop-overflow=2
5020 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5021 to determine the sizes of destination objects.  At this setting the option
5022 will warn about overflows when writing to members of the largest complete
5023 objects whose exact size is known.  It will, however, not warn for excessive
5024 writes to the same members of unknown objects referenced by pointers since
5025 they may point to arrays containing unknown numbers of elements.
5027 @item -Wstringop-overflow=3
5028 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5029 to determine the sizes of destination objects.  At this setting the option
5030 warns about overflowing the smallest object or data member.  This is the
5031 most restrictive setting of the option that may result in warnings for safe
5032 code.
5034 @item -Wstringop-overflow=4
5035 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5036 to determine the sizes of destination objects.  At this setting the option
5037 will warn about overflowing any data members, and when the destination is
5038 one of several objects it uses the size of the largest of them to decide
5039 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5040 setting of the option may result in warnings for benign code.
5041 @end table
5043 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5044 @opindex Wsuggest-attribute=
5045 @opindex Wno-suggest-attribute=
5046 Warn for cases where adding an attribute may be beneficial. The
5047 attributes currently supported are listed below.
5049 @table @gcctabopt
5050 @item -Wsuggest-attribute=pure
5051 @itemx -Wsuggest-attribute=const
5052 @itemx -Wsuggest-attribute=noreturn
5053 @opindex Wsuggest-attribute=pure
5054 @opindex Wno-suggest-attribute=pure
5055 @opindex Wsuggest-attribute=const
5056 @opindex Wno-suggest-attribute=const
5057 @opindex Wsuggest-attribute=noreturn
5058 @opindex Wno-suggest-attribute=noreturn
5060 Warn about functions that might be candidates for attributes
5061 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5062 functions visible in other compilation units or (in the case of @code{pure} and
5063 @code{const}) if it cannot prove that the function returns normally. A function
5064 returns normally if it doesn't contain an infinite loop or return abnormally
5065 by throwing, calling @code{abort} or trapping.  This analysis requires option
5066 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5067 higher.  Higher optimization levels improve the accuracy of the analysis.
5069 @item -Wsuggest-attribute=format
5070 @itemx -Wmissing-format-attribute
5071 @opindex Wsuggest-attribute=format
5072 @opindex Wmissing-format-attribute
5073 @opindex Wno-suggest-attribute=format
5074 @opindex Wno-missing-format-attribute
5075 @opindex Wformat
5076 @opindex Wno-format
5078 Warn about function pointers that might be candidates for @code{format}
5079 attributes.  Note these are only possible candidates, not absolute ones.
5080 GCC guesses that function pointers with @code{format} attributes that
5081 are used in assignment, initialization, parameter passing or return
5082 statements should have a corresponding @code{format} attribute in the
5083 resulting type.  I.e.@: the left-hand side of the assignment or
5084 initialization, the type of the parameter variable, or the return type
5085 of the containing function respectively should also have a @code{format}
5086 attribute to avoid the warning.
5088 GCC also warns about function definitions that might be
5089 candidates for @code{format} attributes.  Again, these are only
5090 possible candidates.  GCC guesses that @code{format} attributes
5091 might be appropriate for any function that calls a function like
5092 @code{vprintf} or @code{vscanf}, but this might not always be the
5093 case, and some functions for which @code{format} attributes are
5094 appropriate may not be detected.
5095 @end table
5097 @item -Wsuggest-final-types
5098 @opindex Wno-suggest-final-types
5099 @opindex Wsuggest-final-types
5100 Warn about types with virtual methods where code quality would be improved
5101 if the type were declared with the C++11 @code{final} specifier, 
5102 or, if possible,
5103 declared in an anonymous namespace. This allows GCC to more aggressively
5104 devirtualize the polymorphic calls. This warning is more effective with link
5105 time optimization, where the information about the class hierarchy graph is
5106 more complete.
5108 @item -Wsuggest-final-methods
5109 @opindex Wno-suggest-final-methods
5110 @opindex Wsuggest-final-methods
5111 Warn about virtual methods where code quality would be improved if the method
5112 were declared with the C++11 @code{final} specifier, 
5113 or, if possible, its type were
5114 declared in an anonymous namespace or with the @code{final} specifier.
5115 This warning is
5116 more effective with link time optimization, where the information about the
5117 class hierarchy graph is more complete. It is recommended to first consider
5118 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5119 annotations.
5121 @item -Wsuggest-override
5122 Warn about overriding virtual functions that are not marked with the override
5123 keyword.
5125 @item -Walloc-zero
5126 @opindex Wno-alloc-zero
5127 @opindex Walloc-zero
5128 Warn about calls to allocation functions decorated with attribute
5129 @code{alloc_size} that specify zero bytes, including those to the built-in
5130 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5131 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5132 when called with a zero size differs among implementations (and in the case
5133 of @code{realloc} has been deprecated) relying on it may result in subtle
5134 portability bugs and should be avoided.
5136 @item -Walloc-size-larger-than=@var{n}
5137 Warn about calls to functions decorated with attribute @code{alloc_size}
5138 that attempt to allocate objects larger than the specified number of bytes,
5139 or where the result of the size computation in an integer type with infinite
5140 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5141 may end in one of the standard suffixes designating a multiple of bytes
5142 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5143 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5144 @xref{Function Attributes}.
5146 @item -Walloca
5147 @opindex Wno-alloca
5148 @opindex Walloca
5149 This option warns on all uses of @code{alloca} in the source.
5151 @item -Walloca-larger-than=@var{n}
5152 This option warns on calls to @code{alloca} that are not bounded by a
5153 controlling predicate limiting its argument of integer type to at most
5154 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5155 Arguments of non-integer types are considered unbounded even if they
5156 appear to be constrained to the expected range.
5158 For example, a bounded case of @code{alloca} could be:
5160 @smallexample
5161 void func (size_t n)
5163   void *p;
5164   if (n <= 1000)
5165     p = alloca (n);
5166   else
5167     p = malloc (n);
5168   f (p);
5170 @end smallexample
5172 In the above example, passing @code{-Walloca-larger-than=1000} would not
5173 issue a warning because the call to @code{alloca} is known to be at most
5174 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5175 the compiler would emit a warning.
5177 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5178 controlling predicate constraining its integer argument.  For example:
5180 @smallexample
5181 void func ()
5183   void *p = alloca (n);
5184   f (p);
5186 @end smallexample
5188 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5189 a warning, but this time because of the lack of bounds checking.
5191 Note, that even seemingly correct code involving signed integers could
5192 cause a warning:
5194 @smallexample
5195 void func (signed int n)
5197   if (n < 500)
5198     @{
5199       p = alloca (n);
5200       f (p);
5201     @}
5203 @end smallexample
5205 In the above example, @var{n} could be negative, causing a larger than
5206 expected argument to be implicitly cast into the @code{alloca} call.
5208 This option also warns when @code{alloca} is used in a loop.
5210 This warning is not enabled by @option{-Wall}, and is only active when
5211 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5213 See also @option{-Wvla-larger-than=@var{n}}.
5215 @item -Warray-bounds
5216 @itemx -Warray-bounds=@var{n}
5217 @opindex Wno-array-bounds
5218 @opindex Warray-bounds
5219 This option is only active when @option{-ftree-vrp} is active
5220 (default for @option{-O2} and above). It warns about subscripts to arrays
5221 that are always out of bounds. This warning is enabled by @option{-Wall}.
5223 @table @gcctabopt
5224 @item -Warray-bounds=1
5225 This is the warning level of @option{-Warray-bounds} and is enabled
5226 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5228 @item -Warray-bounds=2
5229 This warning level also warns about out of bounds access for
5230 arrays at the end of a struct and for arrays accessed through
5231 pointers. This warning level may give a larger number of
5232 false positives and is deactivated by default.
5233 @end table
5235 @item -Wbool-compare
5236 @opindex Wno-bool-compare
5237 @opindex Wbool-compare
5238 Warn about boolean expression compared with an integer value different from
5239 @code{true}/@code{false}.  For instance, the following comparison is
5240 always false:
5241 @smallexample
5242 int n = 5;
5243 @dots{}
5244 if ((n > 1) == 2) @{ @dots{} @}
5245 @end smallexample
5246 This warning is enabled by @option{-Wall}.
5248 @item -Wbool-operation
5249 @opindex Wno-bool-operation
5250 @opindex Wbool-operation
5251 Warn about suspicious operations on expressions of a boolean type.  For
5252 instance, bitwise negation of a boolean is very likely a bug in the program.
5253 For C, this warning also warns about incrementing or decrementing a boolean,
5254 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5255 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5257 This warning is enabled by @option{-Wall}.
5259 @item -Wduplicated-branches
5260 @opindex Wno-duplicated-branches
5261 @opindex Wduplicated-branches
5262 Warn when an if-else has identical branches.  This warning detects cases like
5263 @smallexample
5264 if (p != NULL)
5265   return 0;
5266 else
5267   return 0;
5268 @end smallexample
5269 It doesn't warn when both branches contain just a null statement.  This warning
5270 also warn for conditional operators:
5271 @smallexample
5272   int i = x ? *p : *p;
5273 @end smallexample
5275 @item -Wduplicated-cond
5276 @opindex Wno-duplicated-cond
5277 @opindex Wduplicated-cond
5278 Warn about duplicated conditions in an if-else-if chain.  For instance,
5279 warn for the following code:
5280 @smallexample
5281 if (p->q != NULL) @{ @dots{} @}
5282 else if (p->q != NULL) @{ @dots{} @}
5283 @end smallexample
5285 @item -Wframe-address
5286 @opindex Wno-frame-address
5287 @opindex Wframe-address
5288 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5289 is called with an argument greater than 0.  Such calls may return indeterminate
5290 values or crash the program.  The warning is included in @option{-Wall}.
5292 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5293 @opindex Wno-discarded-qualifiers
5294 @opindex Wdiscarded-qualifiers
5295 Do not warn if type qualifiers on pointers are being discarded.
5296 Typically, the compiler warns if a @code{const char *} variable is
5297 passed to a function that takes a @code{char *} parameter.  This option
5298 can be used to suppress such a warning.
5300 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5301 @opindex Wno-discarded-array-qualifiers
5302 @opindex Wdiscarded-array-qualifiers
5303 Do not warn if type qualifiers on arrays which are pointer targets
5304 are being discarded. Typically, the compiler warns if a
5305 @code{const int (*)[]} variable is passed to a function that
5306 takes a @code{int (*)[]} parameter.  This option can be used to
5307 suppress such a warning.
5309 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5310 @opindex Wno-incompatible-pointer-types
5311 @opindex Wincompatible-pointer-types
5312 Do not warn when there is a conversion between pointers that have incompatible
5313 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5314 which warns for pointer argument passing or assignment with different
5315 signedness.
5317 @item -Wno-int-conversion @r{(C and Objective-C only)}
5318 @opindex Wno-int-conversion
5319 @opindex Wint-conversion
5320 Do not warn about incompatible integer to pointer and pointer to integer
5321 conversions.  This warning is about implicit conversions; for explicit
5322 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5323 @option{-Wno-pointer-to-int-cast} may be used.
5325 @item -Wno-div-by-zero
5326 @opindex Wno-div-by-zero
5327 @opindex Wdiv-by-zero
5328 Do not warn about compile-time integer division by zero.  Floating-point
5329 division by zero is not warned about, as it can be a legitimate way of
5330 obtaining infinities and NaNs.
5332 @item -Wsystem-headers
5333 @opindex Wsystem-headers
5334 @opindex Wno-system-headers
5335 @cindex warnings from system headers
5336 @cindex system headers, warnings from
5337 Print warning messages for constructs found in system header files.
5338 Warnings from system headers are normally suppressed, on the assumption
5339 that they usually do not indicate real problems and would only make the
5340 compiler output harder to read.  Using this command-line option tells
5341 GCC to emit warnings from system headers as if they occurred in user
5342 code.  However, note that using @option{-Wall} in conjunction with this
5343 option does @emph{not} warn about unknown pragmas in system
5344 headers---for that, @option{-Wunknown-pragmas} must also be used.
5346 @item -Wtautological-compare
5347 @opindex Wtautological-compare
5348 @opindex Wno-tautological-compare
5349 Warn if a self-comparison always evaluates to true or false.  This
5350 warning detects various mistakes such as:
5351 @smallexample
5352 int i = 1;
5353 @dots{}
5354 if (i > i) @{ @dots{} @}
5355 @end smallexample
5356 This warning is enabled by @option{-Wall}.
5358 @item -Wtrampolines
5359 @opindex Wtrampolines
5360 @opindex Wno-trampolines
5361 Warn about trampolines generated for pointers to nested functions.
5362 A trampoline is a small piece of data or code that is created at run
5363 time on the stack when the address of a nested function is taken, and is
5364 used to call the nested function indirectly.  For some targets, it is
5365 made up of data only and thus requires no special treatment.  But, for
5366 most targets, it is made up of code and thus requires the stack to be
5367 made executable in order for the program to work properly.
5369 @item -Wfloat-equal
5370 @opindex Wfloat-equal
5371 @opindex Wno-float-equal
5372 Warn if floating-point values are used in equality comparisons.
5374 The idea behind this is that sometimes it is convenient (for the
5375 programmer) to consider floating-point values as approximations to
5376 infinitely precise real numbers.  If you are doing this, then you need
5377 to compute (by analyzing the code, or in some other way) the maximum or
5378 likely maximum error that the computation introduces, and allow for it
5379 when performing comparisons (and when producing output, but that's a
5380 different problem).  In particular, instead of testing for equality, you
5381 should check to see whether the two values have ranges that overlap; and
5382 this is done with the relational operators, so equality comparisons are
5383 probably mistaken.
5385 @item -Wtraditional @r{(C and Objective-C only)}
5386 @opindex Wtraditional
5387 @opindex Wno-traditional
5388 Warn about certain constructs that behave differently in traditional and
5389 ISO C@.  Also warn about ISO C constructs that have no traditional C
5390 equivalent, and/or problematic constructs that should be avoided.
5392 @itemize @bullet
5393 @item
5394 Macro parameters that appear within string literals in the macro body.
5395 In traditional C macro replacement takes place within string literals,
5396 but in ISO C it does not.
5398 @item
5399 In traditional C, some preprocessor directives did not exist.
5400 Traditional preprocessors only considered a line to be a directive
5401 if the @samp{#} appeared in column 1 on the line.  Therefore
5402 @option{-Wtraditional} warns about directives that traditional C
5403 understands but ignores because the @samp{#} does not appear as the
5404 first character on the line.  It also suggests you hide directives like
5405 @code{#pragma} not understood by traditional C by indenting them.  Some
5406 traditional implementations do not recognize @code{#elif}, so this option
5407 suggests avoiding it altogether.
5409 @item
5410 A function-like macro that appears without arguments.
5412 @item
5413 The unary plus operator.
5415 @item
5416 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5417 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5418 constants.)  Note, these suffixes appear in macros defined in the system
5419 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5420 Use of these macros in user code might normally lead to spurious
5421 warnings, however GCC's integrated preprocessor has enough context to
5422 avoid warning in these cases.
5424 @item
5425 A function declared external in one block and then used after the end of
5426 the block.
5428 @item
5429 A @code{switch} statement has an operand of type @code{long}.
5431 @item
5432 A non-@code{static} function declaration follows a @code{static} one.
5433 This construct is not accepted by some traditional C compilers.
5435 @item
5436 The ISO type of an integer constant has a different width or
5437 signedness from its traditional type.  This warning is only issued if
5438 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5439 typically represent bit patterns, are not warned about.
5441 @item
5442 Usage of ISO string concatenation is detected.
5444 @item
5445 Initialization of automatic aggregates.
5447 @item
5448 Identifier conflicts with labels.  Traditional C lacks a separate
5449 namespace for labels.
5451 @item
5452 Initialization of unions.  If the initializer is zero, the warning is
5453 omitted.  This is done under the assumption that the zero initializer in
5454 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5455 initializer warnings and relies on default initialization to zero in the
5456 traditional C case.
5458 @item
5459 Conversions by prototypes between fixed/floating-point values and vice
5460 versa.  The absence of these prototypes when compiling with traditional
5461 C causes serious problems.  This is a subset of the possible
5462 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5464 @item
5465 Use of ISO C style function definitions.  This warning intentionally is
5466 @emph{not} issued for prototype declarations or variadic functions
5467 because these ISO C features appear in your code when using
5468 libiberty's traditional C compatibility macros, @code{PARAMS} and
5469 @code{VPARAMS}.  This warning is also bypassed for nested functions
5470 because that feature is already a GCC extension and thus not relevant to
5471 traditional C compatibility.
5472 @end itemize
5474 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5475 @opindex Wtraditional-conversion
5476 @opindex Wno-traditional-conversion
5477 Warn if a prototype causes a type conversion that is different from what
5478 would happen to the same argument in the absence of a prototype.  This
5479 includes conversions of fixed point to floating and vice versa, and
5480 conversions changing the width or signedness of a fixed-point argument
5481 except when the same as the default promotion.
5483 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5484 @opindex Wdeclaration-after-statement
5485 @opindex Wno-declaration-after-statement
5486 Warn when a declaration is found after a statement in a block.  This
5487 construct, known from C++, was introduced with ISO C99 and is by default
5488 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5490 @item -Wshadow
5491 @opindex Wshadow
5492 @opindex Wno-shadow
5493 Warn whenever a local variable or type declaration shadows another
5494 variable, parameter, type, class member (in C++), or instance variable
5495 (in Objective-C) or whenever a built-in function is shadowed. Note
5496 that in C++, the compiler warns if a local variable shadows an
5497 explicit typedef, but not if it shadows a struct/class/enum.
5498 Same as @option{-Wshadow=global}.
5500 @item -Wno-shadow-ivar @r{(Objective-C only)}
5501 @opindex Wno-shadow-ivar
5502 @opindex Wshadow-ivar
5503 Do not warn whenever a local variable shadows an instance variable in an
5504 Objective-C method.
5506 @item -Wshadow=global
5507 @opindex Wshadow=local
5508 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5510 @item -Wshadow=local
5511 @opindex Wshadow=local
5512 Warn when a local variable shadows another local variable or parameter.
5513 This warning is enabled by @option{-Wshadow=global}.
5515 @item -Wshadow=compatible-local
5516 @opindex Wshadow=compatible-local
5517 Warn when a local variable shadows another local variable or parameter
5518 whose type is compatible with that of the shadowing variable. In C++,
5519 type compatibility here means the type of the shadowing variable can be
5520 converted to that of the shadowed variable. The creation of this flag
5521 (in addition to @option{-Wshadow=local}) is based on the idea that when
5522 a local variable shadows another one of incompatible type, it is most
5523 likely intentional, not a bug or typo, as shown in the following example:
5525 @smallexample
5526 @group
5527 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5529   for (int i = 0; i < N; ++i)
5530   @{
5531     ...
5532   @}
5533   ...
5535 @end group
5536 @end smallexample
5538 Since the two variable @code{i} in the example above have incompatible types,
5539 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5540 Because their types are incompatible, if a programmer accidentally uses one
5541 in place of the other, type checking will catch that and emit an error or
5542 warning. So not warning (about shadowing) in this case will not lead to
5543 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5544 possibly reduce the number of warnings triggered by intentional shadowing.
5546 This warning is enabled by @option{-Wshadow=local}.
5548 @item -Wlarger-than=@var{len}
5549 @opindex Wlarger-than=@var{len}
5550 @opindex Wlarger-than-@var{len}
5551 Warn whenever an object of larger than @var{len} bytes is defined.
5553 @item -Wframe-larger-than=@var{len}
5554 @opindex Wframe-larger-than
5555 Warn if the size of a function frame is larger than @var{len} bytes.
5556 The computation done to determine the stack frame size is approximate
5557 and not conservative.
5558 The actual requirements may be somewhat greater than @var{len}
5559 even if you do not get a warning.  In addition, any space allocated
5560 via @code{alloca}, variable-length arrays, or related constructs
5561 is not included by the compiler when determining
5562 whether or not to issue a warning.
5564 @item -Wno-free-nonheap-object
5565 @opindex Wno-free-nonheap-object
5566 @opindex Wfree-nonheap-object
5567 Do not warn when attempting to free an object that was not allocated
5568 on the heap.
5570 @item -Wstack-usage=@var{len}
5571 @opindex Wstack-usage
5572 Warn if the stack usage of a function might be larger than @var{len} bytes.
5573 The computation done to determine the stack usage is conservative.
5574 Any space allocated via @code{alloca}, variable-length arrays, or related
5575 constructs is included by the compiler when determining whether or not to
5576 issue a warning.
5578 The message is in keeping with the output of @option{-fstack-usage}.
5580 @itemize
5581 @item
5582 If the stack usage is fully static but exceeds the specified amount, it's:
5584 @smallexample
5585   warning: stack usage is 1120 bytes
5586 @end smallexample
5587 @item
5588 If the stack usage is (partly) dynamic but bounded, it's:
5590 @smallexample
5591   warning: stack usage might be 1648 bytes
5592 @end smallexample
5593 @item
5594 If the stack usage is (partly) dynamic and not bounded, it's:
5596 @smallexample
5597   warning: stack usage might be unbounded
5598 @end smallexample
5599 @end itemize
5601 @item -Wunsafe-loop-optimizations
5602 @opindex Wunsafe-loop-optimizations
5603 @opindex Wno-unsafe-loop-optimizations
5604 Warn if the loop cannot be optimized because the compiler cannot
5605 assume anything on the bounds of the loop indices.  With
5606 @option{-funsafe-loop-optimizations} warn if the compiler makes
5607 such assumptions.
5609 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5610 @opindex Wno-pedantic-ms-format
5611 @opindex Wpedantic-ms-format
5612 When used in combination with @option{-Wformat}
5613 and @option{-pedantic} without GNU extensions, this option
5614 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5615 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5616 which depend on the MS runtime.
5618 @item -Waligned-new
5619 @opindex Waligned-new
5620 @opindex Wno-aligned-new
5621 Warn about a new-expression of a type that requires greater alignment
5622 than the @code{alignof(std::max_align_t)} but uses an allocation
5623 function without an explicit alignment parameter. This option is
5624 enabled by @option{-Wall}.
5626 Normally this only warns about global allocation functions, but
5627 @option{-Waligned-new=all} also warns about class member allocation
5628 functions.
5630 @item -Wplacement-new
5631 @itemx -Wplacement-new=@var{n}
5632 @opindex Wplacement-new
5633 @opindex Wno-placement-new
5634 Warn about placement new expressions with undefined behavior, such as
5635 constructing an object in a buffer that is smaller than the type of
5636 the object.  For example, the placement new expression below is diagnosed
5637 because it attempts to construct an array of 64 integers in a buffer only
5638 64 bytes large.
5639 @smallexample
5640 char buf [64];
5641 new (buf) int[64];
5642 @end smallexample
5643 This warning is enabled by default.
5645 @table @gcctabopt
5646 @item -Wplacement-new=1
5647 This is the default warning level of @option{-Wplacement-new}.  At this
5648 level the warning is not issued for some strictly undefined constructs that
5649 GCC allows as extensions for compatibility with legacy code.  For example,
5650 the following @code{new} expression is not diagnosed at this level even
5651 though it has undefined behavior according to the C++ standard because
5652 it writes past the end of the one-element array.
5653 @smallexample
5654 struct S @{ int n, a[1]; @};
5655 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5656 new (s->a)int [32]();
5657 @end smallexample
5659 @item -Wplacement-new=2
5660 At this level, in addition to diagnosing all the same constructs as at level
5661 1, a diagnostic is also issued for placement new expressions that construct
5662 an object in the last member of structure whose type is an array of a single
5663 element and whose size is less than the size of the object being constructed.
5664 While the previous example would be diagnosed, the following construct makes
5665 use of the flexible member array extension to avoid the warning at level 2.
5666 @smallexample
5667 struct S @{ int n, a[]; @};
5668 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5669 new (s->a)int [32]();
5670 @end smallexample
5672 @end table
5674 @item -Wpointer-arith
5675 @opindex Wpointer-arith
5676 @opindex Wno-pointer-arith
5677 Warn about anything that depends on the ``size of'' a function type or
5678 of @code{void}.  GNU C assigns these types a size of 1, for
5679 convenience in calculations with @code{void *} pointers and pointers
5680 to functions.  In C++, warn also when an arithmetic operation involves
5681 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5683 @item -Wpointer-compare
5684 @opindex Wpointer-compare
5685 @opindex Wno-pointer-compare
5686 Warn if a pointer is compared with a zero character constant.  This usually
5687 means that the pointer was meant to be dereferenced.  For example:
5689 @smallexample
5690 const char *p = foo ();
5691 if (p == '\0')
5692   return 42;
5693 @end smallexample
5695 Note that the code above is invalid in C++11.
5697 This warning is enabled by default.
5699 @item -Wtype-limits
5700 @opindex Wtype-limits
5701 @opindex Wno-type-limits
5702 Warn if a comparison is always true or always false due to the limited
5703 range of the data type, but do not warn for constant expressions.  For
5704 example, warn if an unsigned variable is compared against zero with
5705 @code{<} or @code{>=}.  This warning is also enabled by
5706 @option{-Wextra}.
5708 @include cppwarnopts.texi
5710 @item -Wbad-function-cast @r{(C and Objective-C only)}
5711 @opindex Wbad-function-cast
5712 @opindex Wno-bad-function-cast
5713 Warn when a function call is cast to a non-matching type.
5714 For example, warn if a call to a function returning an integer type 
5715 is cast to a pointer type.
5717 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5718 @opindex Wc90-c99-compat
5719 @opindex Wno-c90-c99-compat
5720 Warn about features not present in ISO C90, but present in ISO C99.
5721 For instance, warn about use of variable length arrays, @code{long long}
5722 type, @code{bool} type, compound literals, designated initializers, and so
5723 on.  This option is independent of the standards mode.  Warnings are disabled
5724 in the expression that follows @code{__extension__}.
5726 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5727 @opindex Wc99-c11-compat
5728 @opindex Wno-c99-c11-compat
5729 Warn about features not present in ISO C99, but present in ISO C11.
5730 For instance, warn about use of anonymous structures and unions,
5731 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5732 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5733 and so on.  This option is independent of the standards mode.  Warnings are
5734 disabled in the expression that follows @code{__extension__}.
5736 @item -Wc++-compat @r{(C and Objective-C only)}
5737 @opindex Wc++-compat
5738 Warn about ISO C constructs that are outside of the common subset of
5739 ISO C and ISO C++, e.g.@: request for implicit conversion from
5740 @code{void *} to a pointer to non-@code{void} type.
5742 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5743 @opindex Wc++11-compat
5744 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5745 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5746 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5747 enabled by @option{-Wall}.
5749 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5750 @opindex Wc++14-compat
5751 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5752 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5754 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5755 @opindex Wc++1z-compat
5756 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5757 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5759 @item -Wcast-qual
5760 @opindex Wcast-qual
5761 @opindex Wno-cast-qual
5762 Warn whenever a pointer is cast so as to remove a type qualifier from
5763 the target type.  For example, warn if a @code{const char *} is cast
5764 to an ordinary @code{char *}.
5766 Also warn when making a cast that introduces a type qualifier in an
5767 unsafe way.  For example, casting @code{char **} to @code{const char **}
5768 is unsafe, as in this example:
5770 @smallexample
5771   /* p is char ** value.  */
5772   const char **q = (const char **) p;
5773   /* Assignment of readonly string to const char * is OK.  */
5774   *q = "string";
5775   /* Now char** pointer points to read-only memory.  */
5776   **p = 'b';
5777 @end smallexample
5779 @item -Wcast-align
5780 @opindex Wcast-align
5781 @opindex Wno-cast-align
5782 Warn whenever a pointer is cast such that the required alignment of the
5783 target is increased.  For example, warn if a @code{char *} is cast to
5784 an @code{int *} on machines where integers can only be accessed at
5785 two- or four-byte boundaries.
5787 @item -Wwrite-strings
5788 @opindex Wwrite-strings
5789 @opindex Wno-write-strings
5790 When compiling C, give string constants the type @code{const
5791 char[@var{length}]} so that copying the address of one into a
5792 non-@code{const} @code{char *} pointer produces a warning.  These
5793 warnings help you find at compile time code that can try to write
5794 into a string constant, but only if you have been very careful about
5795 using @code{const} in declarations and prototypes.  Otherwise, it is
5796 just a nuisance. This is why we did not make @option{-Wall} request
5797 these warnings.
5799 When compiling C++, warn about the deprecated conversion from string
5800 literals to @code{char *}.  This warning is enabled by default for C++
5801 programs.
5803 @item -Wclobbered
5804 @opindex Wclobbered
5805 @opindex Wno-clobbered
5806 Warn for variables that might be changed by @code{longjmp} or
5807 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5809 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5810 @opindex Wconditionally-supported
5811 @opindex Wno-conditionally-supported
5812 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5814 @item -Wconversion
5815 @opindex Wconversion
5816 @opindex Wno-conversion
5817 Warn for implicit conversions that may alter a value. This includes
5818 conversions between real and integer, like @code{abs (x)} when
5819 @code{x} is @code{double}; conversions between signed and unsigned,
5820 like @code{unsigned ui = -1}; and conversions to smaller types, like
5821 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5822 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5823 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5824 conversions between signed and unsigned integers can be disabled by
5825 using @option{-Wno-sign-conversion}.
5827 For C++, also warn for confusing overload resolution for user-defined
5828 conversions; and conversions that never use a type conversion
5829 operator: conversions to @code{void}, the same type, a base class or a
5830 reference to them. Warnings about conversions between signed and
5831 unsigned integers are disabled by default in C++ unless
5832 @option{-Wsign-conversion} is explicitly enabled.
5834 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5835 @opindex Wconversion-null
5836 @opindex Wno-conversion-null
5837 Do not warn for conversions between @code{NULL} and non-pointer
5838 types. @option{-Wconversion-null} is enabled by default.
5840 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5841 @opindex Wzero-as-null-pointer-constant
5842 @opindex Wno-zero-as-null-pointer-constant
5843 Warn when a literal @samp{0} is used as null pointer constant.  This can
5844 be useful to facilitate the conversion to @code{nullptr} in C++11.
5846 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5847 @opindex Wsubobject-linkage
5848 @opindex Wno-subobject-linkage
5849 Warn if a class type has a base or a field whose type uses the anonymous
5850 namespace or depends on a type with no linkage.  If a type A depends on
5851 a type B with no or internal linkage, defining it in multiple
5852 translation units would be an ODR violation because the meaning of B
5853 is different in each translation unit.  If A only appears in a single
5854 translation unit, the best way to silence the warning is to give it
5855 internal linkage by putting it in an anonymous namespace as well.  The
5856 compiler doesn't give this warning for types defined in the main .C
5857 file, as those are unlikely to have multiple definitions.
5858 @option{-Wsubobject-linkage} is enabled by default.
5860 @item -Wdangling-else
5861 @opindex Wdangling-else
5862 @opindex Wno-dangling-else
5863 Warn about constructions where there may be confusion to which
5864 @code{if} statement an @code{else} branch belongs.  Here is an example of
5865 such a case:
5867 @smallexample
5868 @group
5870   if (a)
5871     if (b)
5872       foo ();
5873   else
5874     bar ();
5876 @end group
5877 @end smallexample
5879 In C/C++, every @code{else} branch belongs to the innermost possible
5880 @code{if} statement, which in this example is @code{if (b)}.  This is
5881 often not what the programmer expected, as illustrated in the above
5882 example by indentation the programmer chose.  When there is the
5883 potential for this confusion, GCC issues a warning when this flag
5884 is specified.  To eliminate the warning, add explicit braces around
5885 the innermost @code{if} statement so there is no way the @code{else}
5886 can belong to the enclosing @code{if}.  The resulting code
5887 looks like this:
5889 @smallexample
5890 @group
5892   if (a)
5893     @{
5894       if (b)
5895         foo ();
5896       else
5897         bar ();
5898     @}
5900 @end group
5901 @end smallexample
5903 This warning is enabled by @option{-Wparentheses}.
5905 @item -Wdate-time
5906 @opindex Wdate-time
5907 @opindex Wno-date-time
5908 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5909 are encountered as they might prevent bit-wise-identical reproducible
5910 compilations.
5912 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5913 @opindex Wdelete-incomplete
5914 @opindex Wno-delete-incomplete
5915 Warn when deleting a pointer to incomplete type, which may cause
5916 undefined behavior at runtime.  This warning is enabled by default.
5918 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5919 @opindex Wuseless-cast
5920 @opindex Wno-useless-cast
5921 Warn when an expression is casted to its own type.
5923 @item -Wempty-body
5924 @opindex Wempty-body
5925 @opindex Wno-empty-body
5926 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5927 while} statement.  This warning is also enabled by @option{-Wextra}.
5929 @item -Wenum-compare
5930 @opindex Wenum-compare
5931 @opindex Wno-enum-compare
5932 Warn about a comparison between values of different enumerated types.
5933 In C++ enumerated type mismatches in conditional expressions are also
5934 diagnosed and the warning is enabled by default.  In C this warning is 
5935 enabled by @option{-Wall}.
5937 @item -Wjump-misses-init @r{(C, Objective-C only)}
5938 @opindex Wjump-misses-init
5939 @opindex Wno-jump-misses-init
5940 Warn if a @code{goto} statement or a @code{switch} statement jumps
5941 forward across the initialization of a variable, or jumps backward to a
5942 label after the variable has been initialized.  This only warns about
5943 variables that are initialized when they are declared.  This warning is
5944 only supported for C and Objective-C; in C++ this sort of branch is an
5945 error in any case.
5947 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5948 can be disabled with the @option{-Wno-jump-misses-init} option.
5950 @item -Wsign-compare
5951 @opindex Wsign-compare
5952 @opindex Wno-sign-compare
5953 @cindex warning for comparison of signed and unsigned values
5954 @cindex comparison of signed and unsigned values, warning
5955 @cindex signed and unsigned values, comparison warning
5956 Warn when a comparison between signed and unsigned values could produce
5957 an incorrect result when the signed value is converted to unsigned.
5958 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
5959 also enabled by @option{-Wextra}.
5961 @item -Wsign-conversion
5962 @opindex Wsign-conversion
5963 @opindex Wno-sign-conversion
5964 Warn for implicit conversions that may change the sign of an integer
5965 value, like assigning a signed integer expression to an unsigned
5966 integer variable. An explicit cast silences the warning. In C, this
5967 option is enabled also by @option{-Wconversion}.
5969 @item -Wfloat-conversion
5970 @opindex Wfloat-conversion
5971 @opindex Wno-float-conversion
5972 Warn for implicit conversions that reduce the precision of a real value.
5973 This includes conversions from real to integer, and from higher precision
5974 real to lower precision real values.  This option is also enabled by
5975 @option{-Wconversion}.
5977 @item -Wno-scalar-storage-order
5978 @opindex -Wno-scalar-storage-order
5979 @opindex -Wscalar-storage-order
5980 Do not warn on suspicious constructs involving reverse scalar storage order.
5982 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
5983 @opindex Wsized-deallocation
5984 @opindex Wno-sized-deallocation
5985 Warn about a definition of an unsized deallocation function
5986 @smallexample
5987 void operator delete (void *) noexcept;
5988 void operator delete[] (void *) noexcept;
5989 @end smallexample
5990 without a definition of the corresponding sized deallocation function
5991 @smallexample
5992 void operator delete (void *, std::size_t) noexcept;
5993 void operator delete[] (void *, std::size_t) noexcept;
5994 @end smallexample
5995 or vice versa.  Enabled by @option{-Wextra} along with
5996 @option{-fsized-deallocation}.
5998 @item -Wsizeof-pointer-memaccess
5999 @opindex Wsizeof-pointer-memaccess
6000 @opindex Wno-sizeof-pointer-memaccess
6001 Warn for suspicious length parameters to certain string and memory built-in
6002 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6003 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6004 but a pointer, and suggests a possible fix, or about
6005 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6006 @option{-Wall}.
6008 @item -Wsizeof-array-argument
6009 @opindex Wsizeof-array-argument
6010 @opindex Wno-sizeof-array-argument
6011 Warn when the @code{sizeof} operator is applied to a parameter that is
6012 declared as an array in a function definition.  This warning is enabled by
6013 default for C and C++ programs.
6015 @item -Wmemset-elt-size
6016 @opindex Wmemset-elt-size
6017 @opindex Wno-memset-elt-size
6018 Warn for suspicious calls to the @code{memset} built-in function, if the
6019 first argument references an array, and the third argument is a number
6020 equal to the number of elements, but not equal to the size of the array
6021 in memory.  This indicates that the user has omitted a multiplication by
6022 the element size.  This warning is enabled by @option{-Wall}.
6024 @item -Wmemset-transposed-args
6025 @opindex Wmemset-transposed-args
6026 @opindex Wno-memset-transposed-args
6027 Warn for suspicious calls to the @code{memset} built-in function, if the
6028 second argument is not zero and the third argument is zero.  This warns e.g.@
6029 about @code{memset (buf, sizeof buf, 0)} where most probably
6030 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6031 is only emitted if the third argument is literal zero.  If it is some
6032 expression that is folded to zero, a cast of zero to some type, etc., 
6033 it is far less likely that the user has mistakenly exchanged the arguments 
6034 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6036 @item -Waddress
6037 @opindex Waddress
6038 @opindex Wno-address
6039 Warn about suspicious uses of memory addresses. These include using
6040 the address of a function in a conditional expression, such as
6041 @code{void func(void); if (func)}, and comparisons against the memory
6042 address of a string literal, such as @code{if (x == "abc")}.  Such
6043 uses typically indicate a programmer error: the address of a function
6044 always evaluates to true, so their use in a conditional usually
6045 indicate that the programmer forgot the parentheses in a function
6046 call; and comparisons against string literals result in unspecified
6047 behavior and are not portable in C, so they usually indicate that the
6048 programmer intended to use @code{strcmp}.  This warning is enabled by
6049 @option{-Wall}.
6051 @item -Wlogical-op
6052 @opindex Wlogical-op
6053 @opindex Wno-logical-op
6054 Warn about suspicious uses of logical operators in expressions.
6055 This includes using logical operators in contexts where a
6056 bit-wise operator is likely to be expected.  Also warns when
6057 the operands of a logical operator are the same:
6058 @smallexample
6059 extern int a;
6060 if (a < 0 && a < 0) @{ @dots{} @}
6061 @end smallexample
6063 @item -Wlogical-not-parentheses
6064 @opindex Wlogical-not-parentheses
6065 @opindex Wno-logical-not-parentheses
6066 Warn about logical not used on the left hand side operand of a comparison.
6067 This option does not warn if the right operand is considered to be a boolean
6068 expression.  Its purpose is to detect suspicious code like the following:
6069 @smallexample
6070 int a;
6071 @dots{}
6072 if (!a > 1) @{ @dots{} @}
6073 @end smallexample
6075 It is possible to suppress the warning by wrapping the LHS into
6076 parentheses:
6077 @smallexample
6078 if ((!a) > 1) @{ @dots{} @}
6079 @end smallexample
6081 This warning is enabled by @option{-Wall}.
6083 @item -Waggregate-return
6084 @opindex Waggregate-return
6085 @opindex Wno-aggregate-return
6086 Warn if any functions that return structures or unions are defined or
6087 called.  (In languages where you can return an array, this also elicits
6088 a warning.)
6090 @item -Wno-aggressive-loop-optimizations
6091 @opindex Wno-aggressive-loop-optimizations
6092 @opindex Waggressive-loop-optimizations
6093 Warn if in a loop with constant number of iterations the compiler detects
6094 undefined behavior in some statement during one or more of the iterations.
6096 @item -Wno-attributes
6097 @opindex Wno-attributes
6098 @opindex Wattributes
6099 Do not warn if an unexpected @code{__attribute__} is used, such as
6100 unrecognized attributes, function attributes applied to variables,
6101 etc.  This does not stop errors for incorrect use of supported
6102 attributes.
6104 @item -Wno-builtin-declaration-mismatch
6105 @opindex Wno-builtin-declaration-mismatch
6106 @opindex Wbuiltin-declaration-mismatch
6107 Warn if a built-in function is declared with the wrong signature.
6108 This warning is enabled by default.
6110 @item -Wno-builtin-macro-redefined
6111 @opindex Wno-builtin-macro-redefined
6112 @opindex Wbuiltin-macro-redefined
6113 Do not warn if certain built-in macros are redefined.  This suppresses
6114 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6115 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6117 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6118 @opindex Wstrict-prototypes
6119 @opindex Wno-strict-prototypes
6120 Warn if a function is declared or defined without specifying the
6121 argument types.  (An old-style function definition is permitted without
6122 a warning if preceded by a declaration that specifies the argument
6123 types.)
6125 @item -Wold-style-declaration @r{(C and Objective-C only)}
6126 @opindex Wold-style-declaration
6127 @opindex Wno-old-style-declaration
6128 Warn for obsolescent usages, according to the C Standard, in a
6129 declaration. For example, warn if storage-class specifiers like
6130 @code{static} are not the first things in a declaration.  This warning
6131 is also enabled by @option{-Wextra}.
6133 @item -Wold-style-definition @r{(C and Objective-C only)}
6134 @opindex Wold-style-definition
6135 @opindex Wno-old-style-definition
6136 Warn if an old-style function definition is used.  A warning is given
6137 even if there is a previous prototype.
6139 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6140 @opindex Wmissing-parameter-type
6141 @opindex Wno-missing-parameter-type
6142 A function parameter is declared without a type specifier in K&R-style
6143 functions:
6145 @smallexample
6146 void foo(bar) @{ @}
6147 @end smallexample
6149 This warning is also enabled by @option{-Wextra}.
6151 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6152 @opindex Wmissing-prototypes
6153 @opindex Wno-missing-prototypes
6154 Warn if a global function is defined without a previous prototype
6155 declaration.  This warning is issued even if the definition itself
6156 provides a prototype.  Use this option to detect global functions
6157 that do not have a matching prototype declaration in a header file.
6158 This option is not valid for C++ because all function declarations
6159 provide prototypes and a non-matching declaration declares an
6160 overload rather than conflict with an earlier declaration.
6161 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6163 @item -Wmissing-declarations
6164 @opindex Wmissing-declarations
6165 @opindex Wno-missing-declarations
6166 Warn if a global function is defined without a previous declaration.
6167 Do so even if the definition itself provides a prototype.
6168 Use this option to detect global functions that are not declared in
6169 header files.  In C, no warnings are issued for functions with previous
6170 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6171 missing prototypes.  In C++, no warnings are issued for function templates,
6172 or for inline functions, or for functions in anonymous namespaces.
6174 @item -Wmissing-field-initializers
6175 @opindex Wmissing-field-initializers
6176 @opindex Wno-missing-field-initializers
6177 @opindex W
6178 @opindex Wextra
6179 @opindex Wno-extra
6180 Warn if a structure's initializer has some fields missing.  For
6181 example, the following code causes such a warning, because
6182 @code{x.h} is implicitly zero:
6184 @smallexample
6185 struct s @{ int f, g, h; @};
6186 struct s x = @{ 3, 4 @};
6187 @end smallexample
6189 This option does not warn about designated initializers, so the following
6190 modification does not trigger a warning:
6192 @smallexample
6193 struct s @{ int f, g, h; @};
6194 struct s x = @{ .f = 3, .g = 4 @};
6195 @end smallexample
6197 In C++ this option does not warn either about the empty @{ @}
6198 initializer, for example:
6200 @smallexample
6201 struct s @{ int f, g, h; @};
6202 s x = @{ @};
6203 @end smallexample
6205 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6206 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6208 @item -Wno-multichar
6209 @opindex Wno-multichar
6210 @opindex Wmultichar
6211 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6212 Usually they indicate a typo in the user's code, as they have
6213 implementation-defined values, and should not be used in portable code.
6215 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
6216 @opindex Wnormalized=
6217 @opindex Wnormalized
6218 @opindex Wno-normalized
6219 @cindex NFC
6220 @cindex NFKC
6221 @cindex character set, input normalization
6222 In ISO C and ISO C++, two identifiers are different if they are
6223 different sequences of characters.  However, sometimes when characters
6224 outside the basic ASCII character set are used, you can have two
6225 different character sequences that look the same.  To avoid confusion,
6226 the ISO 10646 standard sets out some @dfn{normalization rules} which
6227 when applied ensure that two sequences that look the same are turned into
6228 the same sequence.  GCC can warn you if you are using identifiers that
6229 have not been normalized; this option controls that warning.
6231 There are four levels of warning supported by GCC@.  The default is
6232 @option{-Wnormalized=nfc}, which warns about any identifier that is
6233 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6234 recommended form for most uses.  It is equivalent to
6235 @option{-Wnormalized}.
6237 Unfortunately, there are some characters allowed in identifiers by
6238 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6239 identifiers.  That is, there's no way to use these symbols in portable
6240 ISO C or C++ and have all your identifiers in NFC@.
6241 @option{-Wnormalized=id} suppresses the warning for these characters.
6242 It is hoped that future versions of the standards involved will correct
6243 this, which is why this option is not the default.
6245 You can switch the warning off for all characters by writing
6246 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6247 only do this if you are using some other normalization scheme (like
6248 ``D''), because otherwise you can easily create bugs that are
6249 literally impossible to see.
6251 Some characters in ISO 10646 have distinct meanings but look identical
6252 in some fonts or display methodologies, especially once formatting has
6253 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6254 LETTER N'', displays just like a regular @code{n} that has been
6255 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6256 normalization scheme to convert all these into a standard form as
6257 well, and GCC warns if your code is not in NFKC if you use
6258 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6259 about every identifier that contains the letter O because it might be
6260 confused with the digit 0, and so is not the default, but may be
6261 useful as a local coding convention if the programming environment 
6262 cannot be fixed to display these characters distinctly.
6264 @item -Wno-deprecated
6265 @opindex Wno-deprecated
6266 @opindex Wdeprecated
6267 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6269 @item -Wno-deprecated-declarations
6270 @opindex Wno-deprecated-declarations
6271 @opindex Wdeprecated-declarations
6272 Do not warn about uses of functions (@pxref{Function Attributes}),
6273 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6274 Attributes}) marked as deprecated by using the @code{deprecated}
6275 attribute.
6277 @item -Wno-overflow
6278 @opindex Wno-overflow
6279 @opindex Woverflow
6280 Do not warn about compile-time overflow in constant expressions.
6282 @item -Wno-odr
6283 @opindex Wno-odr
6284 @opindex Wodr
6285 Warn about One Definition Rule violations during link-time optimization.
6286 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6288 @item -Wopenmp-simd
6289 @opindex Wopenm-simd
6290 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6291 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6292 option can be used to relax the cost model.
6294 @item -Woverride-init @r{(C and Objective-C only)}
6295 @opindex Woverride-init
6296 @opindex Wno-override-init
6297 @opindex W
6298 @opindex Wextra
6299 @opindex Wno-extra
6300 Warn if an initialized field without side effects is overridden when
6301 using designated initializers (@pxref{Designated Inits, , Designated
6302 Initializers}).
6304 This warning is included in @option{-Wextra}.  To get other
6305 @option{-Wextra} warnings without this one, use @option{-Wextra
6306 -Wno-override-init}.
6308 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6309 @opindex Woverride-init-side-effects
6310 @opindex Wno-override-init-side-effects
6311 Warn if an initialized field with side effects is overridden when
6312 using designated initializers (@pxref{Designated Inits, , Designated
6313 Initializers}).  This warning is enabled by default.
6315 @item -Wpacked
6316 @opindex Wpacked
6317 @opindex Wno-packed
6318 Warn if a structure is given the packed attribute, but the packed
6319 attribute has no effect on the layout or size of the structure.
6320 Such structures may be mis-aligned for little benefit.  For
6321 instance, in this code, the variable @code{f.x} in @code{struct bar}
6322 is misaligned even though @code{struct bar} does not itself
6323 have the packed attribute:
6325 @smallexample
6326 @group
6327 struct foo @{
6328   int x;
6329   char a, b, c, d;
6330 @} __attribute__((packed));
6331 struct bar @{
6332   char z;
6333   struct foo f;
6335 @end group
6336 @end smallexample
6338 @item -Wpacked-bitfield-compat
6339 @opindex Wpacked-bitfield-compat
6340 @opindex Wno-packed-bitfield-compat
6341 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6342 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6343 the change can lead to differences in the structure layout.  GCC
6344 informs you when the offset of such a field has changed in GCC 4.4.
6345 For example there is no longer a 4-bit padding between field @code{a}
6346 and @code{b} in this structure:
6348 @smallexample
6349 struct foo
6351   char a:4;
6352   char b:8;
6353 @} __attribute__ ((packed));
6354 @end smallexample
6356 This warning is enabled by default.  Use
6357 @option{-Wno-packed-bitfield-compat} to disable this warning.
6359 @item -Wpadded
6360 @opindex Wpadded
6361 @opindex Wno-padded
6362 Warn if padding is included in a structure, either to align an element
6363 of the structure or to align the whole structure.  Sometimes when this
6364 happens it is possible to rearrange the fields of the structure to
6365 reduce the padding and so make the structure smaller.
6367 @item -Wredundant-decls
6368 @opindex Wredundant-decls
6369 @opindex Wno-redundant-decls
6370 Warn if anything is declared more than once in the same scope, even in
6371 cases where multiple declaration is valid and changes nothing.
6373 @item -Wrestrict
6374 @opindex Wrestrict
6375 @opindex Wno-restrict
6376 Warn when an argument passed to a restrict-qualified parameter
6377 aliases with another argument.
6379 @item -Wnested-externs @r{(C and Objective-C only)}
6380 @opindex Wnested-externs
6381 @opindex Wno-nested-externs
6382 Warn if an @code{extern} declaration is encountered within a function.
6384 @item -Wno-inherited-variadic-ctor
6385 @opindex Winherited-variadic-ctor
6386 @opindex Wno-inherited-variadic-ctor
6387 Suppress warnings about use of C++11 inheriting constructors when the
6388 base class inherited from has a C variadic constructor; the warning is
6389 on by default because the ellipsis is not inherited.
6391 @item -Winline
6392 @opindex Winline
6393 @opindex Wno-inline
6394 Warn if a function that is declared as inline cannot be inlined.
6395 Even with this option, the compiler does not warn about failures to
6396 inline functions declared in system headers.
6398 The compiler uses a variety of heuristics to determine whether or not
6399 to inline a function.  For example, the compiler takes into account
6400 the size of the function being inlined and the amount of inlining
6401 that has already been done in the current function.  Therefore,
6402 seemingly insignificant changes in the source program can cause the
6403 warnings produced by @option{-Winline} to appear or disappear.
6405 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6406 @opindex Wno-invalid-offsetof
6407 @opindex Winvalid-offsetof
6408 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6409 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6410 to a non-standard-layout type is undefined.  In existing C++ implementations,
6411 however, @code{offsetof} typically gives meaningful results.
6412 This flag is for users who are aware that they are
6413 writing nonportable code and who have deliberately chosen to ignore the
6414 warning about it.
6416 The restrictions on @code{offsetof} may be relaxed in a future version
6417 of the C++ standard.
6419 @item -Wint-in-bool-context
6420 @opindex Wint-in-bool-context
6421 @opindex Wno-int-in-bool-context
6422 Warn for suspicious use of integer values where boolean values are expected,
6423 such as conditional expressions (?:) using non-boolean integer constants in
6424 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6425 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6426 for all kinds of multiplications regardless of the data type.
6427 This warning is enabled by @option{-Wall}.
6429 @item -Wno-int-to-pointer-cast
6430 @opindex Wno-int-to-pointer-cast
6431 @opindex Wint-to-pointer-cast
6432 Suppress warnings from casts to pointer type of an integer of a
6433 different size. In C++, casting to a pointer type of smaller size is
6434 an error. @option{Wint-to-pointer-cast} is enabled by default.
6437 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6438 @opindex Wno-pointer-to-int-cast
6439 @opindex Wpointer-to-int-cast
6440 Suppress warnings from casts from a pointer to an integer type of a
6441 different size.
6443 @item -Winvalid-pch
6444 @opindex Winvalid-pch
6445 @opindex Wno-invalid-pch
6446 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6447 the search path but can't be used.
6449 @item -Wlong-long
6450 @opindex Wlong-long
6451 @opindex Wno-long-long
6452 Warn if @code{long long} type is used.  This is enabled by either
6453 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6454 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6456 @item -Wvariadic-macros
6457 @opindex Wvariadic-macros
6458 @opindex Wno-variadic-macros
6459 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6460 alternate syntax is used in ISO C99 mode.  This is enabled by either
6461 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6462 messages, use @option{-Wno-variadic-macros}.
6464 @item -Wvarargs
6465 @opindex Wvarargs
6466 @opindex Wno-varargs
6467 Warn upon questionable usage of the macros used to handle variable
6468 arguments like @code{va_start}.  This is default.  To inhibit the
6469 warning messages, use @option{-Wno-varargs}.
6471 @item -Wvector-operation-performance
6472 @opindex Wvector-operation-performance
6473 @opindex Wno-vector-operation-performance
6474 Warn if vector operation is not implemented via SIMD capabilities of the
6475 architecture.  Mainly useful for the performance tuning.
6476 Vector operation can be implemented @code{piecewise}, which means that the
6477 scalar operation is performed on every vector element; 
6478 @code{in parallel}, which means that the vector operation is implemented
6479 using scalars of wider type, which normally is more performance efficient;
6480 and @code{as a single scalar}, which means that vector fits into a
6481 scalar type.
6483 @item -Wno-virtual-move-assign
6484 @opindex Wvirtual-move-assign
6485 @opindex Wno-virtual-move-assign
6486 Suppress warnings about inheriting from a virtual base with a
6487 non-trivial C++11 move assignment operator.  This is dangerous because
6488 if the virtual base is reachable along more than one path, it is
6489 moved multiple times, which can mean both objects end up in the
6490 moved-from state.  If the move assignment operator is written to avoid
6491 moving from a moved-from object, this warning can be disabled.
6493 @item -Wvla
6494 @opindex Wvla
6495 @opindex Wno-vla
6496 Warn if a variable-length array is used in the code.
6497 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6498 the variable-length array.
6500 @item -Wvla-larger-than=@var{n}
6501 If this option is used, the compiler will warn on uses of
6502 variable-length arrays where the size is either unbounded, or bounded
6503 by an argument that can be larger than @var{n} bytes.  This is similar
6504 to how @option{-Walloca-larger-than=@var{n}} works, but with
6505 variable-length arrays.
6507 Note that GCC may optimize small variable-length arrays of a known
6508 value into plain arrays, so this warning may not get triggered for
6509 such arrays.
6511 This warning is not enabled by @option{-Wall}, and is only active when
6512 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6514 See also @option{-Walloca-larger-than=@var{n}}.
6516 @item -Wvolatile-register-var
6517 @opindex Wvolatile-register-var
6518 @opindex Wno-volatile-register-var
6519 Warn if a register variable is declared volatile.  The volatile
6520 modifier does not inhibit all optimizations that may eliminate reads
6521 and/or writes to register variables.  This warning is enabled by
6522 @option{-Wall}.
6524 @item -Wdisabled-optimization
6525 @opindex Wdisabled-optimization
6526 @opindex Wno-disabled-optimization
6527 Warn if a requested optimization pass is disabled.  This warning does
6528 not generally indicate that there is anything wrong with your code; it
6529 merely indicates that GCC's optimizers are unable to handle the code
6530 effectively.  Often, the problem is that your code is too big or too
6531 complex; GCC refuses to optimize programs when the optimization
6532 itself is likely to take inordinate amounts of time.
6534 @item -Wpointer-sign @r{(C and Objective-C only)}
6535 @opindex Wpointer-sign
6536 @opindex Wno-pointer-sign
6537 Warn for pointer argument passing or assignment with different signedness.
6538 This option is only supported for C and Objective-C@.  It is implied by
6539 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6540 @option{-Wno-pointer-sign}.
6542 @item -Wstack-protector
6543 @opindex Wstack-protector
6544 @opindex Wno-stack-protector
6545 This option is only active when @option{-fstack-protector} is active.  It
6546 warns about functions that are not protected against stack smashing.
6548 @item -Woverlength-strings
6549 @opindex Woverlength-strings
6550 @opindex Wno-overlength-strings
6551 Warn about string constants that are longer than the ``minimum
6552 maximum'' length specified in the C standard.  Modern compilers
6553 generally allow string constants that are much longer than the
6554 standard's minimum limit, but very portable programs should avoid
6555 using longer strings.
6557 The limit applies @emph{after} string constant concatenation, and does
6558 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6559 C99, it was raised to 4095.  C++98 does not specify a normative
6560 minimum maximum, so we do not diagnose overlength strings in C++@.
6562 This option is implied by @option{-Wpedantic}, and can be disabled with
6563 @option{-Wno-overlength-strings}.
6565 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6566 @opindex Wunsuffixed-float-constants
6568 Issue a warning for any floating constant that does not have
6569 a suffix.  When used together with @option{-Wsystem-headers} it
6570 warns about such constants in system header files.  This can be useful
6571 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6572 from the decimal floating-point extension to C99.
6574 @item -Wno-designated-init @r{(C and Objective-C only)}
6575 Suppress warnings when a positional initializer is used to initialize
6576 a structure that has been marked with the @code{designated_init}
6577 attribute.
6579 @item -Whsa
6580 Issue a warning when HSAIL cannot be emitted for the compiled function or
6581 OpenMP construct.
6583 @end table
6585 @node Debugging Options
6586 @section Options for Debugging Your Program
6587 @cindex options, debugging
6588 @cindex debugging information options
6590 To tell GCC to emit extra information for use by a debugger, in almost 
6591 all cases you need only to add @option{-g} to your other options.
6593 GCC allows you to use @option{-g} with
6594 @option{-O}.  The shortcuts taken by optimized code may occasionally
6595 be surprising: some variables you declared may not exist
6596 at all; flow of control may briefly move where you did not expect it;
6597 some statements may not be executed because they compute constant
6598 results or their values are already at hand; some statements may
6599 execute in different places because they have been moved out of loops.
6600 Nevertheless it is possible to debug optimized output.  This makes
6601 it reasonable to use the optimizer for programs that might have bugs.
6603 If you are not using some other optimization option, consider
6604 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6605 With no @option{-O} option at all, some compiler passes that collect
6606 information useful for debugging do not run at all, so that
6607 @option{-Og} may result in a better debugging experience.
6609 @table @gcctabopt
6610 @item -g
6611 @opindex g
6612 Produce debugging information in the operating system's native format
6613 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6614 information.
6616 On most systems that use stabs format, @option{-g} enables use of extra
6617 debugging information that only GDB can use; this extra information
6618 makes debugging work better in GDB but probably makes other debuggers
6619 crash or
6620 refuse to read the program.  If you want to control for certain whether
6621 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6622 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6624 @item -ggdb
6625 @opindex ggdb
6626 Produce debugging information for use by GDB@.  This means to use the
6627 most expressive format available (DWARF, stabs, or the native format
6628 if neither of those are supported), including GDB extensions if at all
6629 possible.
6631 @item -gdwarf
6632 @itemx -gdwarf-@var{version}
6633 @opindex gdwarf
6634 Produce debugging information in DWARF format (if that is supported).
6635 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6636 for most targets is 4.  DWARF Version 5 is only experimental.
6638 Note that with DWARF Version 2, some ports require and always
6639 use some non-conflicting DWARF 3 extensions in the unwind tables.
6641 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6642 for maximum benefit.
6644 GCC no longer supports DWARF Version 1, which is substantially
6645 different than Version 2 and later.  For historical reasons, some
6646 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6647 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6648 in their names, but apply to all currently-supported versions of DWARF.
6650 @item -gstabs
6651 @opindex gstabs
6652 Produce debugging information in stabs format (if that is supported),
6653 without GDB extensions.  This is the format used by DBX on most BSD
6654 systems.  On MIPS, Alpha and System V Release 4 systems this option
6655 produces stabs debugging output that is not understood by DBX or SDB@.
6656 On System V Release 4 systems this option requires the GNU assembler.
6658 @item -gstabs+
6659 @opindex gstabs+
6660 Produce debugging information in stabs format (if that is supported),
6661 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6662 use of these extensions is likely to make other debuggers crash or
6663 refuse to read the program.
6665 @item -gcoff
6666 @opindex gcoff
6667 Produce debugging information in COFF format (if that is supported).
6668 This is the format used by SDB on most System V systems prior to
6669 System V Release 4.
6671 @item -gxcoff
6672 @opindex gxcoff
6673 Produce debugging information in XCOFF format (if that is supported).
6674 This is the format used by the DBX debugger on IBM RS/6000 systems.
6676 @item -gxcoff+
6677 @opindex gxcoff+
6678 Produce debugging information in XCOFF format (if that is supported),
6679 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6680 use of these extensions is likely to make other debuggers crash or
6681 refuse to read the program, and may cause assemblers other than the GNU
6682 assembler (GAS) to fail with an error.
6684 @item -gvms
6685 @opindex gvms
6686 Produce debugging information in Alpha/VMS debug format (if that is
6687 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6689 @item -g@var{level}
6690 @itemx -ggdb@var{level}
6691 @itemx -gstabs@var{level}
6692 @itemx -gcoff@var{level}
6693 @itemx -gxcoff@var{level}
6694 @itemx -gvms@var{level}
6695 Request debugging information and also use @var{level} to specify how
6696 much information.  The default level is 2.
6698 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6699 @option{-g}.
6701 Level 1 produces minimal information, enough for making backtraces in
6702 parts of the program that you don't plan to debug.  This includes
6703 descriptions of functions and external variables, and line number
6704 tables, but no information about local variables.
6706 Level 3 includes extra information, such as all the macro definitions
6707 present in the program.  Some debuggers support macro expansion when
6708 you use @option{-g3}.
6710 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6711 confusion with @option{-gdwarf-@var{level}}.
6712 Instead use an additional @option{-g@var{level}} option to change the
6713 debug level for DWARF.
6715 @item -feliminate-unused-debug-symbols
6716 @opindex feliminate-unused-debug-symbols
6717 Produce debugging information in stabs format (if that is supported),
6718 for only symbols that are actually used.
6720 @item -femit-class-debug-always
6721 @opindex femit-class-debug-always
6722 Instead of emitting debugging information for a C++ class in only one
6723 object file, emit it in all object files using the class.  This option
6724 should be used only with debuggers that are unable to handle the way GCC
6725 normally emits debugging information for classes because using this
6726 option increases the size of debugging information by as much as a
6727 factor of two.
6729 @item -fno-merge-debug-strings
6730 @opindex fmerge-debug-strings
6731 @opindex fno-merge-debug-strings
6732 Direct the linker to not merge together strings in the debugging
6733 information that are identical in different object files.  Merging is
6734 not supported by all assemblers or linkers.  Merging decreases the size
6735 of the debug information in the output file at the cost of increasing
6736 link processing time.  Merging is enabled by default.
6738 @item -fdebug-prefix-map=@var{old}=@var{new}
6739 @opindex fdebug-prefix-map
6740 When compiling files in directory @file{@var{old}}, record debugging
6741 information describing them as in @file{@var{new}} instead.
6743 @item -fvar-tracking
6744 @opindex fvar-tracking
6745 Run variable tracking pass.  It computes where variables are stored at each
6746 position in code.  Better debugging information is then generated
6747 (if the debugging information format supports this information).
6749 It is enabled by default when compiling with optimization (@option{-Os},
6750 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6751 the debug info format supports it.
6753 @item -fvar-tracking-assignments
6754 @opindex fvar-tracking-assignments
6755 @opindex fno-var-tracking-assignments
6756 Annotate assignments to user variables early in the compilation and
6757 attempt to carry the annotations over throughout the compilation all the
6758 way to the end, in an attempt to improve debug information while
6759 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6761 It can be enabled even if var-tracking is disabled, in which case
6762 annotations are created and maintained, but discarded at the end.
6763 By default, this flag is enabled together with @option{-fvar-tracking},
6764 except when selective scheduling is enabled.
6766 @item -gsplit-dwarf
6767 @opindex gsplit-dwarf
6768 Separate as much DWARF debugging information as possible into a
6769 separate output file with the extension @file{.dwo}.  This option allows
6770 the build system to avoid linking files with debug information.  To
6771 be useful, this option requires a debugger capable of reading @file{.dwo}
6772 files.
6774 @item -gpubnames
6775 @opindex gpubnames
6776 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6778 @item -ggnu-pubnames
6779 @opindex ggnu-pubnames
6780 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6781 suitable for conversion into a GDB@ index.  This option is only useful
6782 with a linker that can produce GDB@ index version 7.
6784 @item -fdebug-types-section
6785 @opindex fdebug-types-section
6786 @opindex fno-debug-types-section
6787 When using DWARF Version 4 or higher, type DIEs can be put into
6788 their own @code{.debug_types} section instead of making them part of the
6789 @code{.debug_info} section.  It is more efficient to put them in a separate
6790 comdat sections since the linker can then remove duplicates.
6791 But not all DWARF consumers support @code{.debug_types} sections yet
6792 and on some objects @code{.debug_types} produces larger instead of smaller
6793 debugging information.
6795 @item -grecord-gcc-switches
6796 @item -gno-record-gcc-switches
6797 @opindex grecord-gcc-switches
6798 @opindex gno-record-gcc-switches
6799 This switch causes the command-line options used to invoke the
6800 compiler that may affect code generation to be appended to the
6801 DW_AT_producer attribute in DWARF debugging information.  The options
6802 are concatenated with spaces separating them from each other and from
6803 the compiler version.  
6804 It is enabled by default.
6805 See also @option{-frecord-gcc-switches} for another
6806 way of storing compiler options into the object file.  
6808 @item -gstrict-dwarf
6809 @opindex gstrict-dwarf
6810 Disallow using extensions of later DWARF standard version than selected
6811 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6812 DWARF extensions from later standard versions is allowed.
6814 @item -gno-strict-dwarf
6815 @opindex gno-strict-dwarf
6816 Allow using extensions of later DWARF standard version than selected with
6817 @option{-gdwarf-@var{version}}.
6819 @item -gz@r{[}=@var{type}@r{]}
6820 @opindex gz
6821 Produce compressed debug sections in DWARF format, if that is supported.
6822 If @var{type} is not given, the default type depends on the capabilities
6823 of the assembler and linker used.  @var{type} may be one of
6824 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6825 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6826 compression in traditional GNU format).  If the linker doesn't support
6827 writing compressed debug sections, the option is rejected.  Otherwise,
6828 if the assembler does not support them, @option{-gz} is silently ignored
6829 when producing object files.
6831 @item -feliminate-dwarf2-dups
6832 @opindex feliminate-dwarf2-dups
6833 Compress DWARF debugging information by eliminating duplicated
6834 information about each symbol.  This option only makes sense when
6835 generating DWARF debugging information.
6837 @item -femit-struct-debug-baseonly
6838 @opindex femit-struct-debug-baseonly
6839 Emit debug information for struct-like types
6840 only when the base name of the compilation source file
6841 matches the base name of file in which the struct is defined.
6843 This option substantially reduces the size of debugging information,
6844 but at significant potential loss in type information to the debugger.
6845 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6846 See @option{-femit-struct-debug-detailed} for more detailed control.
6848 This option works only with DWARF debug output.
6850 @item -femit-struct-debug-reduced
6851 @opindex femit-struct-debug-reduced
6852 Emit debug information for struct-like types
6853 only when the base name of the compilation source file
6854 matches the base name of file in which the type is defined,
6855 unless the struct is a template or defined in a system header.
6857 This option significantly reduces the size of debugging information,
6858 with some potential loss in type information to the debugger.
6859 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6860 See @option{-femit-struct-debug-detailed} for more detailed control.
6862 This option works only with DWARF debug output.
6864 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6865 @opindex femit-struct-debug-detailed
6866 Specify the struct-like types
6867 for which the compiler generates debug information.
6868 The intent is to reduce duplicate struct debug information
6869 between different object files within the same program.
6871 This option is a detailed version of
6872 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6873 which serves for most needs.
6875 A specification has the syntax@*
6876 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6878 The optional first word limits the specification to
6879 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6880 A struct type is used directly when it is the type of a variable, member.
6881 Indirect uses arise through pointers to structs.
6882 That is, when use of an incomplete struct is valid, the use is indirect.
6883 An example is
6884 @samp{struct one direct; struct two * indirect;}.
6886 The optional second word limits the specification to
6887 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6888 Generic structs are a bit complicated to explain.
6889 For C++, these are non-explicit specializations of template classes,
6890 or non-template classes within the above.
6891 Other programming languages have generics,
6892 but @option{-femit-struct-debug-detailed} does not yet implement them.
6894 The third word specifies the source files for those
6895 structs for which the compiler should emit debug information.
6896 The values @samp{none} and @samp{any} have the normal meaning.
6897 The value @samp{base} means that
6898 the base of name of the file in which the type declaration appears
6899 must match the base of the name of the main compilation file.
6900 In practice, this means that when compiling @file{foo.c}, debug information
6901 is generated for types declared in that file and @file{foo.h},
6902 but not other header files.
6903 The value @samp{sys} means those types satisfying @samp{base}
6904 or declared in system or compiler headers.
6906 You may need to experiment to determine the best settings for your application.
6908 The default is @option{-femit-struct-debug-detailed=all}.
6910 This option works only with DWARF debug output.
6912 @item -fno-dwarf2-cfi-asm
6913 @opindex fdwarf2-cfi-asm
6914 @opindex fno-dwarf2-cfi-asm
6915 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
6916 instead of using GAS @code{.cfi_*} directives.
6918 @item -fno-eliminate-unused-debug-types
6919 @opindex feliminate-unused-debug-types
6920 @opindex fno-eliminate-unused-debug-types
6921 Normally, when producing DWARF output, GCC avoids producing debug symbol 
6922 output for types that are nowhere used in the source file being compiled.
6923 Sometimes it is useful to have GCC emit debugging
6924 information for all types declared in a compilation
6925 unit, regardless of whether or not they are actually used
6926 in that compilation unit, for example 
6927 if, in the debugger, you want to cast a value to a type that is
6928 not actually used in your program (but is declared).  More often,
6929 however, this results in a significant amount of wasted space.
6930 @end table
6932 @node Optimize Options
6933 @section Options That Control Optimization
6934 @cindex optimize options
6935 @cindex options, optimization
6937 These options control various sorts of optimizations.
6939 Without any optimization option, the compiler's goal is to reduce the
6940 cost of compilation and to make debugging produce the expected
6941 results.  Statements are independent: if you stop the program with a
6942 breakpoint between statements, you can then assign a new value to any
6943 variable or change the program counter to any other statement in the
6944 function and get exactly the results you expect from the source
6945 code.
6947 Turning on optimization flags makes the compiler attempt to improve
6948 the performance and/or code size at the expense of compilation time
6949 and possibly the ability to debug the program.
6951 The compiler performs optimization based on the knowledge it has of the
6952 program.  Compiling multiple files at once to a single output file mode allows
6953 the compiler to use information gained from all of the files when compiling
6954 each of them.
6956 Not all optimizations are controlled directly by a flag.  Only
6957 optimizations that have a flag are listed in this section.
6959 Most optimizations are only enabled if an @option{-O} level is set on
6960 the command line.  Otherwise they are disabled, even if individual
6961 optimization flags are specified.
6963 Depending on the target and how GCC was configured, a slightly different
6964 set of optimizations may be enabled at each @option{-O} level than
6965 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6966 to find out the exact set of optimizations that are enabled at each level.
6967 @xref{Overall Options}, for examples.
6969 @table @gcctabopt
6970 @item -O
6971 @itemx -O1
6972 @opindex O
6973 @opindex O1
6974 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6975 more memory for a large function.
6977 With @option{-O}, the compiler tries to reduce code size and execution
6978 time, without performing any optimizations that take a great deal of
6979 compilation time.
6981 @option{-O} turns on the following optimization flags:
6982 @gccoptlist{
6983 -fauto-inc-dec @gol
6984 -fbranch-count-reg @gol
6985 -fcombine-stack-adjustments @gol
6986 -fcompare-elim @gol
6987 -fcprop-registers @gol
6988 -fdce @gol
6989 -fdefer-pop @gol
6990 -fdelayed-branch @gol
6991 -fdse @gol
6992 -fforward-propagate @gol
6993 -fguess-branch-probability @gol
6994 -fif-conversion2 @gol
6995 -fif-conversion @gol
6996 -finline-functions-called-once @gol
6997 -fipa-pure-const @gol
6998 -fipa-profile @gol
6999 -fipa-reference @gol
7000 -fmerge-constants @gol
7001 -fmove-loop-invariants @gol
7002 -freorder-blocks @gol
7003 -fshrink-wrap @gol
7004 -fshrink-wrap-separate @gol
7005 -fsplit-wide-types @gol
7006 -fssa-backprop @gol
7007 -fssa-phiopt @gol
7008 -ftree-bit-ccp @gol
7009 -ftree-ccp @gol
7010 -ftree-ch @gol
7011 -ftree-coalesce-vars @gol
7012 -ftree-copy-prop @gol
7013 -ftree-dce @gol
7014 -ftree-dominator-opts @gol
7015 -ftree-dse @gol
7016 -ftree-forwprop @gol
7017 -ftree-fre @gol
7018 -ftree-phiprop @gol
7019 -ftree-sink @gol
7020 -ftree-slsr @gol
7021 -ftree-sra @gol
7022 -ftree-pta @gol
7023 -ftree-ter @gol
7024 -funit-at-a-time}
7026 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7027 where doing so does not interfere with debugging.
7029 @item -O2
7030 @opindex O2
7031 Optimize even more.  GCC performs nearly all supported optimizations
7032 that do not involve a space-speed tradeoff.
7033 As compared to @option{-O}, this option increases both compilation time
7034 and the performance of the generated code.
7036 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7037 also turns on the following optimization flags:
7038 @gccoptlist{-fthread-jumps @gol
7039 -falign-functions  -falign-jumps @gol
7040 -falign-loops  -falign-labels @gol
7041 -fcaller-saves @gol
7042 -fcrossjumping @gol
7043 -fcse-follow-jumps  -fcse-skip-blocks @gol
7044 -fdelete-null-pointer-checks @gol
7045 -fdevirtualize -fdevirtualize-speculatively @gol
7046 -fexpensive-optimizations @gol
7047 -fgcse  -fgcse-lm  @gol
7048 -fhoist-adjacent-loads @gol
7049 -finline-small-functions @gol
7050 -findirect-inlining @gol
7051 -fipa-cp @gol
7052 -fipa-cp-alignment @gol
7053 -fipa-bit-cp @gol
7054 -fipa-sra @gol
7055 -fipa-icf @gol
7056 -fisolate-erroneous-paths-dereference @gol
7057 -flra-remat @gol
7058 -foptimize-sibling-calls @gol
7059 -foptimize-strlen @gol
7060 -fpartial-inlining @gol
7061 -fpeephole2 @gol
7062 -freorder-blocks-algorithm=stc @gol
7063 -freorder-blocks-and-partition -freorder-functions @gol
7064 -frerun-cse-after-loop  @gol
7065 -fsched-interblock  -fsched-spec @gol
7066 -fschedule-insns  -fschedule-insns2 @gol
7067 -fstore-merging @gol
7068 -fstrict-aliasing -fstrict-overflow @gol
7069 -ftree-builtin-call-dce @gol
7070 -ftree-switch-conversion -ftree-tail-merge @gol
7071 -fcode-hoisting @gol
7072 -ftree-pre @gol
7073 -ftree-vrp @gol
7074 -fipa-ra}
7076 Please note the warning under @option{-fgcse} about
7077 invoking @option{-O2} on programs that use computed gotos.
7079 @item -O3
7080 @opindex O3
7081 Optimize yet more.  @option{-O3} turns on all optimizations specified
7082 by @option{-O2} and also turns on the @option{-finline-functions},
7083 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7084 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7085 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7086 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7087 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7088 and @option{-fipa-cp-clone} options.
7090 @item -O0
7091 @opindex O0
7092 Reduce compilation time and make debugging produce the expected
7093 results.  This is the default.
7095 @item -Os
7096 @opindex Os
7097 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7098 do not typically increase code size.  It also performs further
7099 optimizations designed to reduce code size.
7101 @option{-Os} disables the following optimization flags:
7102 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7103 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7104 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7106 @item -Ofast
7107 @opindex Ofast
7108 Disregard strict standards compliance.  @option{-Ofast} enables all
7109 @option{-O3} optimizations.  It also enables optimizations that are not
7110 valid for all standard-compliant programs.
7111 It turns on @option{-ffast-math} and the Fortran-specific
7112 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7114 @item -Og
7115 @opindex Og
7116 Optimize debugging experience.  @option{-Og} enables optimizations
7117 that do not interfere with debugging. It should be the optimization
7118 level of choice for the standard edit-compile-debug cycle, offering
7119 a reasonable level of optimization while maintaining fast compilation
7120 and a good debugging experience.
7121 @end table
7123 If you use multiple @option{-O} options, with or without level numbers,
7124 the last such option is the one that is effective.
7126 Options of the form @option{-f@var{flag}} specify machine-independent
7127 flags.  Most flags have both positive and negative forms; the negative
7128 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7129 below, only one of the forms is listed---the one you typically 
7130 use.  You can figure out the other form by either removing @samp{no-}
7131 or adding it.
7133 The following options control specific optimizations.  They are either
7134 activated by @option{-O} options or are related to ones that are.  You
7135 can use the following flags in the rare cases when ``fine-tuning'' of
7136 optimizations to be performed is desired.
7138 @table @gcctabopt
7139 @item -fno-defer-pop
7140 @opindex fno-defer-pop
7141 Always pop the arguments to each function call as soon as that function
7142 returns.  For machines that must pop arguments after a function call,
7143 the compiler normally lets arguments accumulate on the stack for several
7144 function calls and pops them all at once.
7146 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7148 @item -fforward-propagate
7149 @opindex fforward-propagate
7150 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7151 instructions and checks if the result can be simplified.  If loop unrolling
7152 is active, two passes are performed and the second is scheduled after
7153 loop unrolling.
7155 This option is enabled by default at optimization levels @option{-O},
7156 @option{-O2}, @option{-O3}, @option{-Os}.
7158 @item -ffp-contract=@var{style}
7159 @opindex ffp-contract
7160 @option{-ffp-contract=off} disables floating-point expression contraction.
7161 @option{-ffp-contract=fast} enables floating-point expression contraction
7162 such as forming of fused multiply-add operations if the target has
7163 native support for them.
7164 @option{-ffp-contract=on} enables floating-point expression contraction
7165 if allowed by the language standard.  This is currently not implemented
7166 and treated equal to @option{-ffp-contract=off}.
7168 The default is @option{-ffp-contract=fast}.
7170 @item -fomit-frame-pointer
7171 @opindex fomit-frame-pointer
7172 Don't keep the frame pointer in a register for functions that
7173 don't need one.  This avoids the instructions to save, set up and
7174 restore frame pointers; it also makes an extra register available
7175 in many functions.  @strong{It also makes debugging impossible on
7176 some machines.}
7178 On some machines, such as the VAX, this flag has no effect, because
7179 the standard calling sequence automatically handles the frame pointer
7180 and nothing is saved by pretending it doesn't exist.  The
7181 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7182 whether a target machine supports this flag.  @xref{Registers,,Register
7183 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7185 The default setting (when not optimizing for
7186 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7187 @option{-fomit-frame-pointer}.  You can configure GCC with the
7188 @option{--enable-frame-pointer} configure option to change the default.
7190 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7192 @item -foptimize-sibling-calls
7193 @opindex foptimize-sibling-calls
7194 Optimize sibling and tail recursive calls.
7196 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7198 @item -foptimize-strlen
7199 @opindex foptimize-strlen
7200 Optimize various standard C string functions (e.g. @code{strlen},
7201 @code{strchr} or @code{strcpy}) and
7202 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7204 Enabled at levels @option{-O2}, @option{-O3}.
7206 @item -fno-inline
7207 @opindex fno-inline
7208 Do not expand any functions inline apart from those marked with
7209 the @code{always_inline} attribute.  This is the default when not
7210 optimizing.
7212 Single functions can be exempted from inlining by marking them
7213 with the @code{noinline} attribute.
7215 @item -finline-small-functions
7216 @opindex finline-small-functions
7217 Integrate functions into their callers when their body is smaller than expected
7218 function call code (so overall size of program gets smaller).  The compiler
7219 heuristically decides which functions are simple enough to be worth integrating
7220 in this way.  This inlining applies to all functions, even those not declared
7221 inline.
7223 Enabled at level @option{-O2}.
7225 @item -findirect-inlining
7226 @opindex findirect-inlining
7227 Inline also indirect calls that are discovered to be known at compile
7228 time thanks to previous inlining.  This option has any effect only
7229 when inlining itself is turned on by the @option{-finline-functions}
7230 or @option{-finline-small-functions} options.
7232 Enabled at level @option{-O2}.
7234 @item -finline-functions
7235 @opindex finline-functions
7236 Consider all functions for inlining, even if they are not declared inline.
7237 The compiler heuristically decides which functions are worth integrating
7238 in this way.
7240 If all calls to a given function are integrated, and the function is
7241 declared @code{static}, then the function is normally not output as
7242 assembler code in its own right.
7244 Enabled at level @option{-O3}.
7246 @item -finline-functions-called-once
7247 @opindex finline-functions-called-once
7248 Consider all @code{static} functions called once for inlining into their
7249 caller even if they are not marked @code{inline}.  If a call to a given
7250 function is integrated, then the function is not output as assembler code
7251 in its own right.
7253 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7255 @item -fearly-inlining
7256 @opindex fearly-inlining
7257 Inline functions marked by @code{always_inline} and functions whose body seems
7258 smaller than the function call overhead early before doing
7259 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7260 makes profiling significantly cheaper and usually inlining faster on programs
7261 having large chains of nested wrapper functions.
7263 Enabled by default.
7265 @item -fipa-sra
7266 @opindex fipa-sra
7267 Perform interprocedural scalar replacement of aggregates, removal of
7268 unused parameters and replacement of parameters passed by reference
7269 by parameters passed by value.
7271 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7273 @item -finline-limit=@var{n}
7274 @opindex finline-limit
7275 By default, GCC limits the size of functions that can be inlined.  This flag
7276 allows coarse control of this limit.  @var{n} is the size of functions that
7277 can be inlined in number of pseudo instructions.
7279 Inlining is actually controlled by a number of parameters, which may be
7280 specified individually by using @option{--param @var{name}=@var{value}}.
7281 The @option{-finline-limit=@var{n}} option sets some of these parameters
7282 as follows:
7284 @table @gcctabopt
7285 @item max-inline-insns-single
7286 is set to @var{n}/2.
7287 @item max-inline-insns-auto
7288 is set to @var{n}/2.
7289 @end table
7291 See below for a documentation of the individual
7292 parameters controlling inlining and for the defaults of these parameters.
7294 @emph{Note:} there may be no value to @option{-finline-limit} that results
7295 in default behavior.
7297 @emph{Note:} pseudo instruction represents, in this particular context, an
7298 abstract measurement of function's size.  In no way does it represent a count
7299 of assembly instructions and as such its exact meaning might change from one
7300 release to an another.
7302 @item -fno-keep-inline-dllexport
7303 @opindex fno-keep-inline-dllexport
7304 This is a more fine-grained version of @option{-fkeep-inline-functions},
7305 which applies only to functions that are declared using the @code{dllexport}
7306 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7307 Functions}.
7309 @item -fkeep-inline-functions
7310 @opindex fkeep-inline-functions
7311 In C, emit @code{static} functions that are declared @code{inline}
7312 into the object file, even if the function has been inlined into all
7313 of its callers.  This switch does not affect functions using the
7314 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7315 inline functions into the object file.
7317 @item -fkeep-static-functions
7318 @opindex fkeep-static-functions
7319 Emit @code{static} functions into the object file, even if the function
7320 is never used.
7322 @item -fkeep-static-consts
7323 @opindex fkeep-static-consts
7324 Emit variables declared @code{static const} when optimization isn't turned
7325 on, even if the variables aren't referenced.
7327 GCC enables this option by default.  If you want to force the compiler to
7328 check if a variable is referenced, regardless of whether or not
7329 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7331 @item -fmerge-constants
7332 @opindex fmerge-constants
7333 Attempt to merge identical constants (string constants and floating-point
7334 constants) across compilation units.
7336 This option is the default for optimized compilation if the assembler and
7337 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7338 behavior.
7340 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7342 @item -fmerge-all-constants
7343 @opindex fmerge-all-constants
7344 Attempt to merge identical constants and identical variables.
7346 This option implies @option{-fmerge-constants}.  In addition to
7347 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7348 arrays or initialized constant variables with integral or floating-point
7349 types.  Languages like C or C++ require each variable, including multiple
7350 instances of the same variable in recursive calls, to have distinct locations,
7351 so using this option results in non-conforming
7352 behavior.
7354 @item -fmodulo-sched
7355 @opindex fmodulo-sched
7356 Perform swing modulo scheduling immediately before the first scheduling
7357 pass.  This pass looks at innermost loops and reorders their
7358 instructions by overlapping different iterations.
7360 @item -fmodulo-sched-allow-regmoves
7361 @opindex fmodulo-sched-allow-regmoves
7362 Perform more aggressive SMS-based modulo scheduling with register moves
7363 allowed.  By setting this flag certain anti-dependences edges are
7364 deleted, which triggers the generation of reg-moves based on the
7365 life-range analysis.  This option is effective only with
7366 @option{-fmodulo-sched} enabled.
7368 @item -fno-branch-count-reg
7369 @opindex fno-branch-count-reg
7370 Avoid running a pass scanning for opportunities to use ``decrement and
7371 branch'' instructions on a count register instead of generating sequences
7372 of instructions that decrement a register, compare it against zero, and
7373 then branch based upon the result.  This option is only meaningful on
7374 architectures that support such instructions, which include x86, PowerPC,
7375 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7376 doesn't remove the decrement and branch instructions from the generated
7377 instruction stream introduced by other optimization passes.
7379 Enabled by default at @option{-O1} and higher.
7381 The default is @option{-fbranch-count-reg}.
7383 @item -fno-function-cse
7384 @opindex fno-function-cse
7385 Do not put function addresses in registers; make each instruction that
7386 calls a constant function contain the function's address explicitly.
7388 This option results in less efficient code, but some strange hacks
7389 that alter the assembler output may be confused by the optimizations
7390 performed when this option is not used.
7392 The default is @option{-ffunction-cse}
7394 @item -fno-zero-initialized-in-bss
7395 @opindex fno-zero-initialized-in-bss
7396 If the target supports a BSS section, GCC by default puts variables that
7397 are initialized to zero into BSS@.  This can save space in the resulting
7398 code.
7400 This option turns off this behavior because some programs explicitly
7401 rely on variables going to the data section---e.g., so that the
7402 resulting executable can find the beginning of that section and/or make
7403 assumptions based on that.
7405 The default is @option{-fzero-initialized-in-bss}.
7407 @item -fthread-jumps
7408 @opindex fthread-jumps
7409 Perform optimizations that check to see if a jump branches to a
7410 location where another comparison subsumed by the first is found.  If
7411 so, the first branch is redirected to either the destination of the
7412 second branch or a point immediately following it, depending on whether
7413 the condition is known to be true or false.
7415 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7417 @item -fsplit-wide-types
7418 @opindex fsplit-wide-types
7419 When using a type that occupies multiple registers, such as @code{long
7420 long} on a 32-bit system, split the registers apart and allocate them
7421 independently.  This normally generates better code for those types,
7422 but may make debugging more difficult.
7424 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7425 @option{-Os}.
7427 @item -fcse-follow-jumps
7428 @opindex fcse-follow-jumps
7429 In common subexpression elimination (CSE), scan through jump instructions
7430 when the target of the jump is not reached by any other path.  For
7431 example, when CSE encounters an @code{if} statement with an
7432 @code{else} clause, CSE follows the jump when the condition
7433 tested is false.
7435 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7437 @item -fcse-skip-blocks
7438 @opindex fcse-skip-blocks
7439 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7440 follow jumps that conditionally skip over blocks.  When CSE
7441 encounters a simple @code{if} statement with no else clause,
7442 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7443 body of the @code{if}.
7445 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7447 @item -frerun-cse-after-loop
7448 @opindex frerun-cse-after-loop
7449 Re-run common subexpression elimination after loop optimizations are
7450 performed.
7452 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7454 @item -fgcse
7455 @opindex fgcse
7456 Perform a global common subexpression elimination pass.
7457 This pass also performs global constant and copy propagation.
7459 @emph{Note:} When compiling a program using computed gotos, a GCC
7460 extension, you may get better run-time performance if you disable
7461 the global common subexpression elimination pass by adding
7462 @option{-fno-gcse} to the command line.
7464 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7466 @item -fgcse-lm
7467 @opindex fgcse-lm
7468 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7469 attempts to move loads that are only killed by stores into themselves.  This
7470 allows a loop containing a load/store sequence to be changed to a load outside
7471 the loop, and a copy/store within the loop.
7473 Enabled by default when @option{-fgcse} is enabled.
7475 @item -fgcse-sm
7476 @opindex fgcse-sm
7477 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7478 global common subexpression elimination.  This pass attempts to move
7479 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7480 loops containing a load/store sequence can be changed to a load before
7481 the loop and a store after the loop.
7483 Not enabled at any optimization level.
7485 @item -fgcse-las
7486 @opindex fgcse-las
7487 When @option{-fgcse-las} is enabled, the global common subexpression
7488 elimination pass eliminates redundant loads that come after stores to the
7489 same memory location (both partial and full redundancies).
7491 Not enabled at any optimization level.
7493 @item -fgcse-after-reload
7494 @opindex fgcse-after-reload
7495 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7496 pass is performed after reload.  The purpose of this pass is to clean up
7497 redundant spilling.
7499 @item -faggressive-loop-optimizations
7500 @opindex faggressive-loop-optimizations
7501 This option tells the loop optimizer to use language constraints to
7502 derive bounds for the number of iterations of a loop.  This assumes that
7503 loop code does not invoke undefined behavior by for example causing signed
7504 integer overflows or out-of-bound array accesses.  The bounds for the
7505 number of iterations of a loop are used to guide loop unrolling and peeling
7506 and loop exit test optimizations.
7507 This option is enabled by default.
7509 @item -funconstrained-commons
7510 @opindex funconstrained-commons
7511 This option tells the compiler that variables declared in common blocks
7512 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7513 prevents certain optimizations that depend on knowing the array bounds.
7515 @item -fcrossjumping
7516 @opindex fcrossjumping
7517 Perform cross-jumping transformation.
7518 This transformation unifies equivalent code and saves code size.  The
7519 resulting code may or may not perform better than without cross-jumping.
7521 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7523 @item -fauto-inc-dec
7524 @opindex fauto-inc-dec
7525 Combine increments or decrements of addresses with memory accesses.
7526 This pass is always skipped on architectures that do not have
7527 instructions to support this.  Enabled by default at @option{-O} and
7528 higher on architectures that support this.
7530 @item -fdce
7531 @opindex fdce
7532 Perform dead code elimination (DCE) on RTL@.
7533 Enabled by default at @option{-O} and higher.
7535 @item -fdse
7536 @opindex fdse
7537 Perform dead store elimination (DSE) on RTL@.
7538 Enabled by default at @option{-O} and higher.
7540 @item -fif-conversion
7541 @opindex fif-conversion
7542 Attempt to transform conditional jumps into branch-less equivalents.  This
7543 includes use of conditional moves, min, max, set flags and abs instructions, and
7544 some tricks doable by standard arithmetics.  The use of conditional execution
7545 on chips where it is available is controlled by @option{-fif-conversion2}.
7547 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7549 @item -fif-conversion2
7550 @opindex fif-conversion2
7551 Use conditional execution (where available) to transform conditional jumps into
7552 branch-less equivalents.
7554 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7556 @item -fdeclone-ctor-dtor
7557 @opindex fdeclone-ctor-dtor
7558 The C++ ABI requires multiple entry points for constructors and
7559 destructors: one for a base subobject, one for a complete object, and
7560 one for a virtual destructor that calls operator delete afterwards.
7561 For a hierarchy with virtual bases, the base and complete variants are
7562 clones, which means two copies of the function.  With this option, the
7563 base and complete variants are changed to be thunks that call a common
7564 implementation.
7566 Enabled by @option{-Os}.
7568 @item -fdelete-null-pointer-checks
7569 @opindex fdelete-null-pointer-checks
7570 Assume that programs cannot safely dereference null pointers, and that
7571 no code or data element resides at address zero.
7572 This option enables simple constant
7573 folding optimizations at all optimization levels.  In addition, other
7574 optimization passes in GCC use this flag to control global dataflow
7575 analyses that eliminate useless checks for null pointers; these assume
7576 that a memory access to address zero always results in a trap, so
7577 that if a pointer is checked after it has already been dereferenced,
7578 it cannot be null.
7580 Note however that in some environments this assumption is not true.
7581 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7582 for programs that depend on that behavior.
7584 This option is enabled by default on most targets.  On Nios II ELF, it
7585 defaults to off.  On AVR and CR16, this option is completely disabled.  
7587 Passes that use the dataflow information
7588 are enabled independently at different optimization levels.
7590 @item -fdevirtualize
7591 @opindex fdevirtualize
7592 Attempt to convert calls to virtual functions to direct calls.  This
7593 is done both within a procedure and interprocedurally as part of
7594 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7595 propagation (@option{-fipa-cp}).
7596 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7598 @item -fdevirtualize-speculatively
7599 @opindex fdevirtualize-speculatively
7600 Attempt to convert calls to virtual functions to speculative direct calls.
7601 Based on the analysis of the type inheritance graph, determine for a given call
7602 the set of likely targets. If the set is small, preferably of size 1, change
7603 the call into a conditional deciding between direct and indirect calls.  The
7604 speculative calls enable more optimizations, such as inlining.  When they seem
7605 useless after further optimization, they are converted back into original form.
7607 @item -fdevirtualize-at-ltrans
7608 @opindex fdevirtualize-at-ltrans
7609 Stream extra information needed for aggressive devirtualization when running
7610 the link-time optimizer in local transformation mode.  
7611 This option enables more devirtualization but
7612 significantly increases the size of streamed data. For this reason it is
7613 disabled by default.
7615 @item -fexpensive-optimizations
7616 @opindex fexpensive-optimizations
7617 Perform a number of minor optimizations that are relatively expensive.
7619 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7621 @item -free
7622 @opindex free
7623 Attempt to remove redundant extension instructions.  This is especially
7624 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7625 registers after writing to their lower 32-bit half.
7627 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7628 @option{-O3}, @option{-Os}.
7630 @item -fno-lifetime-dse
7631 @opindex fno-lifetime-dse
7632 In C++ the value of an object is only affected by changes within its
7633 lifetime: when the constructor begins, the object has an indeterminate
7634 value, and any changes during the lifetime of the object are dead when
7635 the object is destroyed.  Normally dead store elimination will take
7636 advantage of this; if your code relies on the value of the object
7637 storage persisting beyond the lifetime of the object, you can use this
7638 flag to disable this optimization.  To preserve stores before the
7639 constructor starts (e.g. because your operator new clears the object
7640 storage) but still treat the object as dead after the destructor you,
7641 can use @option{-flifetime-dse=1}.  The default behavior can be
7642 explicitly selected with @option{-flifetime-dse=2}.
7643 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7645 @item -flive-range-shrinkage
7646 @opindex flive-range-shrinkage
7647 Attempt to decrease register pressure through register live range
7648 shrinkage.  This is helpful for fast processors with small or moderate
7649 size register sets.
7651 @item -fira-algorithm=@var{algorithm}
7652 @opindex fira-algorithm
7653 Use the specified coloring algorithm for the integrated register
7654 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7655 specifies Chow's priority coloring, or @samp{CB}, which specifies
7656 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7657 for all architectures, but for those targets that do support it, it is
7658 the default because it generates better code.
7660 @item -fira-region=@var{region}
7661 @opindex fira-region
7662 Use specified regions for the integrated register allocator.  The
7663 @var{region} argument should be one of the following:
7665 @table @samp
7667 @item all
7668 Use all loops as register allocation regions.
7669 This can give the best results for machines with a small and/or
7670 irregular register set.
7672 @item mixed
7673 Use all loops except for loops with small register pressure 
7674 as the regions.  This value usually gives
7675 the best results in most cases and for most architectures,
7676 and is enabled by default when compiling with optimization for speed
7677 (@option{-O}, @option{-O2}, @dots{}).
7679 @item one
7680 Use all functions as a single region.  
7681 This typically results in the smallest code size, and is enabled by default for
7682 @option{-Os} or @option{-O0}.
7684 @end table
7686 @item -fira-hoist-pressure
7687 @opindex fira-hoist-pressure
7688 Use IRA to evaluate register pressure in the code hoisting pass for
7689 decisions to hoist expressions.  This option usually results in smaller
7690 code, but it can slow the compiler down.
7692 This option is enabled at level @option{-Os} for all targets.
7694 @item -fira-loop-pressure
7695 @opindex fira-loop-pressure
7696 Use IRA to evaluate register pressure in loops for decisions to move
7697 loop invariants.  This option usually results in generation
7698 of faster and smaller code on machines with large register files (>= 32
7699 registers), but it can slow the compiler down.
7701 This option is enabled at level @option{-O3} for some targets.
7703 @item -fno-ira-share-save-slots
7704 @opindex fno-ira-share-save-slots
7705 Disable sharing of stack slots used for saving call-used hard
7706 registers living through a call.  Each hard register gets a
7707 separate stack slot, and as a result function stack frames are
7708 larger.
7710 @item -fno-ira-share-spill-slots
7711 @opindex fno-ira-share-spill-slots
7712 Disable sharing of stack slots allocated for pseudo-registers.  Each
7713 pseudo-register that does not get a hard register gets a separate
7714 stack slot, and as a result function stack frames are larger.
7716 @item -flra-remat
7717 @opindex flra-remat
7718 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7719 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7720 values if it is profitable.
7722 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7724 @item -fdelayed-branch
7725 @opindex fdelayed-branch
7726 If supported for the target machine, attempt to reorder instructions
7727 to exploit instruction slots available after delayed branch
7728 instructions.
7730 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7732 @item -fschedule-insns
7733 @opindex fschedule-insns
7734 If supported for the target machine, attempt to reorder instructions to
7735 eliminate execution stalls due to required data being unavailable.  This
7736 helps machines that have slow floating point or memory load instructions
7737 by allowing other instructions to be issued until the result of the load
7738 or floating-point instruction is required.
7740 Enabled at levels @option{-O2}, @option{-O3}.
7742 @item -fschedule-insns2
7743 @opindex fschedule-insns2
7744 Similar to @option{-fschedule-insns}, but requests an additional pass of
7745 instruction scheduling after register allocation has been done.  This is
7746 especially useful on machines with a relatively small number of
7747 registers and where memory load instructions take more than one cycle.
7749 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7751 @item -fno-sched-interblock
7752 @opindex fno-sched-interblock
7753 Don't schedule instructions across basic blocks.  This is normally
7754 enabled by default when scheduling before register allocation, i.e.@:
7755 with @option{-fschedule-insns} or at @option{-O2} or higher.
7757 @item -fno-sched-spec
7758 @opindex fno-sched-spec
7759 Don't allow speculative motion of non-load instructions.  This is normally
7760 enabled by default when scheduling before register allocation, i.e.@:
7761 with @option{-fschedule-insns} or at @option{-O2} or higher.
7763 @item -fsched-pressure
7764 @opindex fsched-pressure
7765 Enable register pressure sensitive insn scheduling before register
7766 allocation.  This only makes sense when scheduling before register
7767 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7768 @option{-O2} or higher.  Usage of this option can improve the
7769 generated code and decrease its size by preventing register pressure
7770 increase above the number of available hard registers and subsequent
7771 spills in register allocation.
7773 @item -fsched-spec-load
7774 @opindex fsched-spec-load
7775 Allow speculative motion of some load instructions.  This only makes
7776 sense when scheduling before register allocation, i.e.@: with
7777 @option{-fschedule-insns} or at @option{-O2} or higher.
7779 @item -fsched-spec-load-dangerous
7780 @opindex fsched-spec-load-dangerous
7781 Allow speculative motion of more load instructions.  This only makes
7782 sense when scheduling before register allocation, i.e.@: with
7783 @option{-fschedule-insns} or at @option{-O2} or higher.
7785 @item -fsched-stalled-insns
7786 @itemx -fsched-stalled-insns=@var{n}
7787 @opindex fsched-stalled-insns
7788 Define how many insns (if any) can be moved prematurely from the queue
7789 of stalled insns into the ready list during the second scheduling pass.
7790 @option{-fno-sched-stalled-insns} means that no insns are moved
7791 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7792 on how many queued insns can be moved prematurely.
7793 @option{-fsched-stalled-insns} without a value is equivalent to
7794 @option{-fsched-stalled-insns=1}.
7796 @item -fsched-stalled-insns-dep
7797 @itemx -fsched-stalled-insns-dep=@var{n}
7798 @opindex fsched-stalled-insns-dep
7799 Define how many insn groups (cycles) are examined for a dependency
7800 on a stalled insn that is a candidate for premature removal from the queue
7801 of stalled insns.  This has an effect only during the second scheduling pass,
7802 and only if @option{-fsched-stalled-insns} is used.
7803 @option{-fno-sched-stalled-insns-dep} is equivalent to
7804 @option{-fsched-stalled-insns-dep=0}.
7805 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7806 @option{-fsched-stalled-insns-dep=1}.
7808 @item -fsched2-use-superblocks
7809 @opindex fsched2-use-superblocks
7810 When scheduling after register allocation, use superblock scheduling.
7811 This allows motion across basic block boundaries,
7812 resulting in faster schedules.  This option is experimental, as not all machine
7813 descriptions used by GCC model the CPU closely enough to avoid unreliable
7814 results from the algorithm.
7816 This only makes sense when scheduling after register allocation, i.e.@: with
7817 @option{-fschedule-insns2} or at @option{-O2} or higher.
7819 @item -fsched-group-heuristic
7820 @opindex fsched-group-heuristic
7821 Enable the group heuristic in the scheduler.  This heuristic favors
7822 the instruction that belongs to a schedule group.  This is enabled
7823 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7824 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7826 @item -fsched-critical-path-heuristic
7827 @opindex fsched-critical-path-heuristic
7828 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7829 instructions on the critical path.  This is enabled by default when
7830 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7831 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7833 @item -fsched-spec-insn-heuristic
7834 @opindex fsched-spec-insn-heuristic
7835 Enable the speculative instruction heuristic in the scheduler.  This
7836 heuristic favors speculative instructions with greater dependency weakness.
7837 This is enabled by default when scheduling is enabled, i.e.@:
7838 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7839 or at @option{-O2} or higher.
7841 @item -fsched-rank-heuristic
7842 @opindex fsched-rank-heuristic
7843 Enable the rank heuristic in the scheduler.  This heuristic favors
7844 the instruction belonging to a basic block with greater size or frequency.
7845 This is enabled by default when scheduling is enabled, i.e.@:
7846 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7847 at @option{-O2} or higher.
7849 @item -fsched-last-insn-heuristic
7850 @opindex fsched-last-insn-heuristic
7851 Enable the last-instruction heuristic in the scheduler.  This heuristic
7852 favors the instruction that is less dependent on the last instruction
7853 scheduled.  This is enabled by default when scheduling is enabled,
7854 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7855 at @option{-O2} or higher.
7857 @item -fsched-dep-count-heuristic
7858 @opindex fsched-dep-count-heuristic
7859 Enable the dependent-count heuristic in the scheduler.  This heuristic
7860 favors the instruction that has more instructions depending on it.
7861 This is enabled by default when scheduling is enabled, i.e.@:
7862 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7863 at @option{-O2} or higher.
7865 @item -freschedule-modulo-scheduled-loops
7866 @opindex freschedule-modulo-scheduled-loops
7867 Modulo scheduling is performed before traditional scheduling.  If a loop
7868 is modulo scheduled, later scheduling passes may change its schedule.  
7869 Use this option to control that behavior.
7871 @item -fselective-scheduling
7872 @opindex fselective-scheduling
7873 Schedule instructions using selective scheduling algorithm.  Selective
7874 scheduling runs instead of the first scheduler pass.
7876 @item -fselective-scheduling2
7877 @opindex fselective-scheduling2
7878 Schedule instructions using selective scheduling algorithm.  Selective
7879 scheduling runs instead of the second scheduler pass.
7881 @item -fsel-sched-pipelining
7882 @opindex fsel-sched-pipelining
7883 Enable software pipelining of innermost loops during selective scheduling.
7884 This option has no effect unless one of @option{-fselective-scheduling} or
7885 @option{-fselective-scheduling2} is turned on.
7887 @item -fsel-sched-pipelining-outer-loops
7888 @opindex fsel-sched-pipelining-outer-loops
7889 When pipelining loops during selective scheduling, also pipeline outer loops.
7890 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7892 @item -fsemantic-interposition
7893 @opindex fsemantic-interposition
7894 Some object formats, like ELF, allow interposing of symbols by the 
7895 dynamic linker.
7896 This means that for symbols exported from the DSO, the compiler cannot perform
7897 interprocedural propagation, inlining and other optimizations in anticipation
7898 that the function or variable in question may change. While this feature is
7899 useful, for example, to rewrite memory allocation functions by a debugging
7900 implementation, it is expensive in the terms of code quality.
7901 With @option{-fno-semantic-interposition} the compiler assumes that 
7902 if interposition happens for functions the overwriting function will have 
7903 precisely the same semantics (and side effects). 
7904 Similarly if interposition happens
7905 for variables, the constructor of the variable will be the same. The flag
7906 has no effect for functions explicitly declared inline 
7907 (where it is never allowed for interposition to change semantics) 
7908 and for symbols explicitly declared weak.
7910 @item -fshrink-wrap
7911 @opindex fshrink-wrap
7912 Emit function prologues only before parts of the function that need it,
7913 rather than at the top of the function.  This flag is enabled by default at
7914 @option{-O} and higher.
7916 @item -fshrink-wrap-separate
7917 @opindex fshrink-wrap-separate
7918 Shrink-wrap separate parts of the prologue and epilogue separately, so that
7919 those parts are only executed when needed.
7920 This option is on by default, but has no effect unless @option{-fshrink-wrap}
7921 is also turned on and the target supports this.
7923 @item -fcaller-saves
7924 @opindex fcaller-saves
7925 Enable allocation of values to registers that are clobbered by
7926 function calls, by emitting extra instructions to save and restore the
7927 registers around such calls.  Such allocation is done only when it
7928 seems to result in better code.
7930 This option is always enabled by default on certain machines, usually
7931 those which have no call-preserved registers to use instead.
7933 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7935 @item -fcombine-stack-adjustments
7936 @opindex fcombine-stack-adjustments
7937 Tracks stack adjustments (pushes and pops) and stack memory references
7938 and then tries to find ways to combine them.
7940 Enabled by default at @option{-O1} and higher.
7942 @item -fipa-ra
7943 @opindex fipa-ra
7944 Use caller save registers for allocation if those registers are not used by
7945 any called function.  In that case it is not necessary to save and restore
7946 them around calls.  This is only possible if called functions are part of
7947 same compilation unit as current function and they are compiled before it.
7949 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
7950 is disabled if generated code will be instrumented for profiling
7951 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
7952 exactly (this happens on targets that do not expose prologues
7953 and epilogues in RTL).
7955 @item -fconserve-stack
7956 @opindex fconserve-stack
7957 Attempt to minimize stack usage.  The compiler attempts to use less
7958 stack space, even if that makes the program slower.  This option
7959 implies setting the @option{large-stack-frame} parameter to 100
7960 and the @option{large-stack-frame-growth} parameter to 400.
7962 @item -ftree-reassoc
7963 @opindex ftree-reassoc
7964 Perform reassociation on trees.  This flag is enabled by default
7965 at @option{-O} and higher.
7967 @item -fcode-hoisting
7968 @opindex fcode-hoisting
7969 Perform code hoisting.  Code hoisting tries to move the
7970 evaluation of expressions executed on all paths to the function exit
7971 as early as possible.  This is especially useful as a code size
7972 optimization, but it often helps for code speed as well.
7973 This flag is enabled by default at @option{-O2} and higher.
7975 @item -ftree-pre
7976 @opindex ftree-pre
7977 Perform partial redundancy elimination (PRE) on trees.  This flag is
7978 enabled by default at @option{-O2} and @option{-O3}.
7980 @item -ftree-partial-pre
7981 @opindex ftree-partial-pre
7982 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7983 enabled by default at @option{-O3}.
7985 @item -ftree-forwprop
7986 @opindex ftree-forwprop
7987 Perform forward propagation on trees.  This flag is enabled by default
7988 at @option{-O} and higher.
7990 @item -ftree-fre
7991 @opindex ftree-fre
7992 Perform full redundancy elimination (FRE) on trees.  The difference
7993 between FRE and PRE is that FRE only considers expressions
7994 that are computed on all paths leading to the redundant computation.
7995 This analysis is faster than PRE, though it exposes fewer redundancies.
7996 This flag is enabled by default at @option{-O} and higher.
7998 @item -ftree-phiprop
7999 @opindex ftree-phiprop
8000 Perform hoisting of loads from conditional pointers on trees.  This
8001 pass is enabled by default at @option{-O} and higher.
8003 @item -fhoist-adjacent-loads
8004 @opindex fhoist-adjacent-loads
8005 Speculatively hoist loads from both branches of an if-then-else if the
8006 loads are from adjacent locations in the same structure and the target
8007 architecture has a conditional move instruction.  This flag is enabled
8008 by default at @option{-O2} and higher.
8010 @item -ftree-copy-prop
8011 @opindex ftree-copy-prop
8012 Perform copy propagation on trees.  This pass eliminates unnecessary
8013 copy operations.  This flag is enabled by default at @option{-O} and
8014 higher.
8016 @item -fipa-pure-const
8017 @opindex fipa-pure-const
8018 Discover which functions are pure or constant.
8019 Enabled by default at @option{-O} and higher.
8021 @item -fipa-reference
8022 @opindex fipa-reference
8023 Discover which static variables do not escape the
8024 compilation unit.
8025 Enabled by default at @option{-O} and higher.
8027 @item -fipa-pta
8028 @opindex fipa-pta
8029 Perform interprocedural pointer analysis and interprocedural modification
8030 and reference analysis.  This option can cause excessive memory and
8031 compile-time usage on large compilation units.  It is not enabled by
8032 default at any optimization level.
8034 @item -fipa-profile
8035 @opindex fipa-profile
8036 Perform interprocedural profile propagation.  The functions called only from
8037 cold functions are marked as cold. Also functions executed once (such as
8038 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8039 functions and loop less parts of functions executed once are then optimized for
8040 size.
8041 Enabled by default at @option{-O} and higher.
8043 @item -fipa-cp
8044 @opindex fipa-cp
8045 Perform interprocedural constant propagation.
8046 This optimization analyzes the program to determine when values passed
8047 to functions are constants and then optimizes accordingly.
8048 This optimization can substantially increase performance
8049 if the application has constants passed to functions.
8050 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8052 @item -fipa-cp-clone
8053 @opindex fipa-cp-clone
8054 Perform function cloning to make interprocedural constant propagation stronger.
8055 When enabled, interprocedural constant propagation performs function cloning
8056 when externally visible function can be called with constant arguments.
8057 Because this optimization can create multiple copies of functions,
8058 it may significantly increase code size
8059 (see @option{--param ipcp-unit-growth=@var{value}}).
8060 This flag is enabled by default at @option{-O3}.
8062 @item -fipa-cp-alignment
8063 @opindex -fipa-cp-alignment
8064 When enabled, this optimization propagates alignment of function
8065 parameters to support better vectorization and string operations.
8067 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8068 requires that @option{-fipa-cp} is enabled.
8069 @option{-fipa-cp-alignment} is obsolete, use @option{-fipa-bit-cp} instead.
8071 @item -fipa-bit-cp
8072 @opindex -fipa-bit-cp
8073 When enabled, perform ipa bitwise constant propagation. This flag is
8074 enabled by default at @option{-O2}. It requires that @option{-fipa-cp}
8075 is enabled.
8077 @item -fipa-icf
8078 @opindex fipa-icf
8079 Perform Identical Code Folding for functions and read-only variables.
8080 The optimization reduces code size and may disturb unwind stacks by replacing
8081 a function by equivalent one with a different name. The optimization works
8082 more effectively with link time optimization enabled.
8084 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8085 works on different levels and thus the optimizations are not same - there are
8086 equivalences that are found only by GCC and equivalences found only by Gold.
8088 This flag is enabled by default at @option{-O2} and @option{-Os}.
8090 @item -fisolate-erroneous-paths-dereference
8091 @opindex fisolate-erroneous-paths-dereference
8092 Detect paths that trigger erroneous or undefined behavior due to
8093 dereferencing a null pointer.  Isolate those paths from the main control
8094 flow and turn the statement with erroneous or undefined behavior into a trap.
8095 This flag is enabled by default at @option{-O2} and higher and depends on
8096 @option{-fdelete-null-pointer-checks} also being enabled.
8098 @item -fisolate-erroneous-paths-attribute
8099 @opindex fisolate-erroneous-paths-attribute
8100 Detect paths that trigger erroneous or undefined behavior due a null value
8101 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8102 attribute.  Isolate those paths from the main control flow and turn the
8103 statement with erroneous or undefined behavior into a trap.  This is not
8104 currently enabled, but may be enabled by @option{-O2} in the future.
8106 @item -ftree-sink
8107 @opindex ftree-sink
8108 Perform forward store motion on trees.  This flag is
8109 enabled by default at @option{-O} and higher.
8111 @item -ftree-bit-ccp
8112 @opindex ftree-bit-ccp
8113 Perform sparse conditional bit constant propagation on trees and propagate
8114 pointer alignment information.
8115 This pass only operates on local scalar variables and is enabled by default
8116 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8118 @item -ftree-ccp
8119 @opindex ftree-ccp
8120 Perform sparse conditional constant propagation (CCP) on trees.  This
8121 pass only operates on local scalar variables and is enabled by default
8122 at @option{-O} and higher.
8124 @item -fssa-backprop
8125 @opindex fssa-backprop
8126 Propagate information about uses of a value up the definition chain
8127 in order to simplify the definitions.  For example, this pass strips
8128 sign operations if the sign of a value never matters.  The flag is
8129 enabled by default at @option{-O} and higher.
8131 @item -fssa-phiopt
8132 @opindex fssa-phiopt
8133 Perform pattern matching on SSA PHI nodes to optimize conditional
8134 code.  This pass is enabled by default at @option{-O} and higher.
8136 @item -ftree-switch-conversion
8137 @opindex ftree-switch-conversion
8138 Perform conversion of simple initializations in a switch to
8139 initializations from a scalar array.  This flag is enabled by default
8140 at @option{-O2} and higher.
8142 @item -ftree-tail-merge
8143 @opindex ftree-tail-merge
8144 Look for identical code sequences.  When found, replace one with a jump to the
8145 other.  This optimization is known as tail merging or cross jumping.  This flag
8146 is enabled by default at @option{-O2} and higher.  The compilation time
8147 in this pass can
8148 be limited using @option{max-tail-merge-comparisons} parameter and
8149 @option{max-tail-merge-iterations} parameter.
8151 @item -ftree-dce
8152 @opindex ftree-dce
8153 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8154 default at @option{-O} and higher.
8156 @item -ftree-builtin-call-dce
8157 @opindex ftree-builtin-call-dce
8158 Perform conditional dead code elimination (DCE) for calls to built-in functions
8159 that may set @code{errno} but are otherwise side-effect free.  This flag is
8160 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8161 specified.
8163 @item -ftree-dominator-opts
8164 @opindex ftree-dominator-opts
8165 Perform a variety of simple scalar cleanups (constant/copy
8166 propagation, redundancy elimination, range propagation and expression
8167 simplification) based on a dominator tree traversal.  This also
8168 performs jump threading (to reduce jumps to jumps). This flag is
8169 enabled by default at @option{-O} and higher.
8171 @item -ftree-dse
8172 @opindex ftree-dse
8173 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8174 a memory location that is later overwritten by another store without
8175 any intervening loads.  In this case the earlier store can be deleted.  This
8176 flag is enabled by default at @option{-O} and higher.
8178 @item -ftree-ch
8179 @opindex ftree-ch
8180 Perform loop header copying on trees.  This is beneficial since it increases
8181 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8182 is enabled by default at @option{-O} and higher.  It is not enabled
8183 for @option{-Os}, since it usually increases code size.
8185 @item -ftree-loop-optimize
8186 @opindex ftree-loop-optimize
8187 Perform loop optimizations on trees.  This flag is enabled by default
8188 at @option{-O} and higher.
8190 @item -ftree-loop-linear
8191 @itemx -floop-interchange
8192 @itemx -floop-strip-mine
8193 @itemx -floop-block
8194 @itemx -floop-unroll-and-jam
8195 @opindex ftree-loop-linear
8196 @opindex floop-interchange
8197 @opindex floop-strip-mine
8198 @opindex floop-block
8199 @opindex floop-unroll-and-jam
8200 Perform loop nest optimizations.  Same as
8201 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8202 to be configured with @option{--with-isl} to enable the Graphite loop
8203 transformation infrastructure.
8205 @item -fgraphite-identity
8206 @opindex fgraphite-identity
8207 Enable the identity transformation for graphite.  For every SCoP we generate
8208 the polyhedral representation and transform it back to gimple.  Using
8209 @option{-fgraphite-identity} we can check the costs or benefits of the
8210 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8211 are also performed by the code generator isl, like index splitting and
8212 dead code elimination in loops.
8214 @item -floop-nest-optimize
8215 @opindex floop-nest-optimize
8216 Enable the isl based loop nest optimizer.  This is a generic loop nest
8217 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8218 structure optimized for data-locality and parallelism.  This option
8219 is experimental.
8221 @item -floop-parallelize-all
8222 @opindex floop-parallelize-all
8223 Use the Graphite data dependence analysis to identify loops that can
8224 be parallelized.  Parallelize all the loops that can be analyzed to
8225 not contain loop carried dependences without checking that it is
8226 profitable to parallelize the loops.
8228 @item -ftree-coalesce-vars
8229 @opindex ftree-coalesce-vars
8230 While transforming the program out of the SSA representation, attempt to
8231 reduce copying by coalescing versions of different user-defined
8232 variables, instead of just compiler temporaries.  This may severely
8233 limit the ability to debug an optimized program compiled with
8234 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8235 prevents SSA coalescing of user variables.  This option is enabled by
8236 default if optimization is enabled, and it does very little otherwise.
8238 @item -ftree-loop-if-convert
8239 @opindex ftree-loop-if-convert
8240 Attempt to transform conditional jumps in the innermost loops to
8241 branch-less equivalents.  The intent is to remove control-flow from
8242 the innermost loops in order to improve the ability of the
8243 vectorization pass to handle these loops.  This is enabled by default
8244 if vectorization is enabled.
8246 @item -ftree-loop-distribution
8247 @opindex ftree-loop-distribution
8248 Perform loop distribution.  This flag can improve cache performance on
8249 big loop bodies and allow further loop optimizations, like
8250 parallelization or vectorization, to take place.  For example, the loop
8251 @smallexample
8252 DO I = 1, N
8253   A(I) = B(I) + C
8254   D(I) = E(I) * F
8255 ENDDO
8256 @end smallexample
8257 is transformed to
8258 @smallexample
8259 DO I = 1, N
8260    A(I) = B(I) + C
8261 ENDDO
8262 DO I = 1, N
8263    D(I) = E(I) * F
8264 ENDDO
8265 @end smallexample
8267 @item -ftree-loop-distribute-patterns
8268 @opindex ftree-loop-distribute-patterns
8269 Perform loop distribution of patterns that can be code generated with
8270 calls to a library.  This flag is enabled by default at @option{-O3}.
8272 This pass distributes the initialization loops and generates a call to
8273 memset zero.  For example, the loop
8274 @smallexample
8275 DO I = 1, N
8276   A(I) = 0
8277   B(I) = A(I) + I
8278 ENDDO
8279 @end smallexample
8280 is transformed to
8281 @smallexample
8282 DO I = 1, N
8283    A(I) = 0
8284 ENDDO
8285 DO I = 1, N
8286    B(I) = A(I) + I
8287 ENDDO
8288 @end smallexample
8289 and the initialization loop is transformed into a call to memset zero.
8291 @item -ftree-loop-im
8292 @opindex ftree-loop-im
8293 Perform loop invariant motion on trees.  This pass moves only invariants that
8294 are hard to handle at RTL level (function calls, operations that expand to
8295 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8296 operands of conditions that are invariant out of the loop, so that we can use
8297 just trivial invariantness analysis in loop unswitching.  The pass also includes
8298 store motion.
8300 @item -ftree-loop-ivcanon
8301 @opindex ftree-loop-ivcanon
8302 Create a canonical counter for number of iterations in loops for which
8303 determining number of iterations requires complicated analysis.  Later
8304 optimizations then may determine the number easily.  Useful especially
8305 in connection with unrolling.
8307 @item -fivopts
8308 @opindex fivopts
8309 Perform induction variable optimizations (strength reduction, induction
8310 variable merging and induction variable elimination) on trees.
8312 @item -ftree-parallelize-loops=n
8313 @opindex ftree-parallelize-loops
8314 Parallelize loops, i.e., split their iteration space to run in n threads.
8315 This is only possible for loops whose iterations are independent
8316 and can be arbitrarily reordered.  The optimization is only
8317 profitable on multiprocessor machines, for loops that are CPU-intensive,
8318 rather than constrained e.g.@: by memory bandwidth.  This option
8319 implies @option{-pthread}, and thus is only supported on targets
8320 that have support for @option{-pthread}.
8322 @item -ftree-pta
8323 @opindex ftree-pta
8324 Perform function-local points-to analysis on trees.  This flag is
8325 enabled by default at @option{-O} and higher.
8327 @item -ftree-sra
8328 @opindex ftree-sra
8329 Perform scalar replacement of aggregates.  This pass replaces structure
8330 references with scalars to prevent committing structures to memory too
8331 early.  This flag is enabled by default at @option{-O} and higher.
8333 @item -fstore-merging
8334 @opindex fstore-merging
8335 Perform merging of narrow stores to consecutive memory addresses.  This pass
8336 merges contiguous stores of immediate values narrower than a word into fewer
8337 wider stores to reduce the number of instructions.  This is enabled by default
8338 at @option{-O2} and higher as well as @option{-Os}.
8340 @item -ftree-ter
8341 @opindex ftree-ter
8342 Perform temporary expression replacement during the SSA->normal phase.  Single
8343 use/single def temporaries are replaced at their use location with their
8344 defining expression.  This results in non-GIMPLE code, but gives the expanders
8345 much more complex trees to work on resulting in better RTL generation.  This is
8346 enabled by default at @option{-O} and higher.
8348 @item -ftree-slsr
8349 @opindex ftree-slsr
8350 Perform straight-line strength reduction on trees.  This recognizes related
8351 expressions involving multiplications and replaces them by less expensive
8352 calculations when possible.  This is enabled by default at @option{-O} and
8353 higher.
8355 @item -ftree-vectorize
8356 @opindex ftree-vectorize
8357 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8358 and @option{-ftree-slp-vectorize} if not explicitly specified.
8360 @item -ftree-loop-vectorize
8361 @opindex ftree-loop-vectorize
8362 Perform loop vectorization on trees. This flag is enabled by default at
8363 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8365 @item -ftree-slp-vectorize
8366 @opindex ftree-slp-vectorize
8367 Perform basic block vectorization on trees. This flag is enabled by default at
8368 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8370 @item -fvect-cost-model=@var{model}
8371 @opindex fvect-cost-model
8372 Alter the cost model used for vectorization.  The @var{model} argument
8373 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8374 With the @samp{unlimited} model the vectorized code-path is assumed
8375 to be profitable while with the @samp{dynamic} model a runtime check
8376 guards the vectorized code-path to enable it only for iteration
8377 counts that will likely execute faster than when executing the original
8378 scalar loop.  The @samp{cheap} model disables vectorization of
8379 loops where doing so would be cost prohibitive for example due to
8380 required runtime checks for data dependence or alignment but otherwise
8381 is equal to the @samp{dynamic} model.
8382 The default cost model depends on other optimization flags and is
8383 either @samp{dynamic} or @samp{cheap}.
8385 @item -fsimd-cost-model=@var{model}
8386 @opindex fsimd-cost-model
8387 Alter the cost model used for vectorization of loops marked with the OpenMP
8388 or Cilk Plus simd directive.  The @var{model} argument should be one of
8389 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8390 have the same meaning as described in @option{-fvect-cost-model} and by
8391 default a cost model defined with @option{-fvect-cost-model} is used.
8393 @item -ftree-vrp
8394 @opindex ftree-vrp
8395 Perform Value Range Propagation on trees.  This is similar to the
8396 constant propagation pass, but instead of values, ranges of values are
8397 propagated.  This allows the optimizers to remove unnecessary range
8398 checks like array bound checks and null pointer checks.  This is
8399 enabled by default at @option{-O2} and higher.  Null pointer check
8400 elimination is only done if @option{-fdelete-null-pointer-checks} is
8401 enabled.
8403 @item -fsplit-paths
8404 @opindex fsplit-paths
8405 Split paths leading to loop backedges.  This can improve dead code
8406 elimination and common subexpression elimination.  This is enabled by
8407 default at @option{-O2} and above.
8409 @item -fsplit-ivs-in-unroller
8410 @opindex fsplit-ivs-in-unroller
8411 Enables expression of values of induction variables in later iterations
8412 of the unrolled loop using the value in the first iteration.  This breaks
8413 long dependency chains, thus improving efficiency of the scheduling passes.
8415 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8416 same effect.  However, that is not reliable in cases where the loop body
8417 is more complicated than a single basic block.  It also does not work at all
8418 on some architectures due to restrictions in the CSE pass.
8420 This optimization is enabled by default.
8422 @item -fvariable-expansion-in-unroller
8423 @opindex fvariable-expansion-in-unroller
8424 With this option, the compiler creates multiple copies of some
8425 local variables when unrolling a loop, which can result in superior code.
8427 @item -fpartial-inlining
8428 @opindex fpartial-inlining
8429 Inline parts of functions.  This option has any effect only
8430 when inlining itself is turned on by the @option{-finline-functions}
8431 or @option{-finline-small-functions} options.
8433 Enabled at level @option{-O2}.
8435 @item -fpredictive-commoning
8436 @opindex fpredictive-commoning
8437 Perform predictive commoning optimization, i.e., reusing computations
8438 (especially memory loads and stores) performed in previous
8439 iterations of loops.
8441 This option is enabled at level @option{-O3}.
8443 @item -fprefetch-loop-arrays
8444 @opindex fprefetch-loop-arrays
8445 If supported by the target machine, generate instructions to prefetch
8446 memory to improve the performance of loops that access large arrays.
8448 This option may generate better or worse code; results are highly
8449 dependent on the structure of loops within the source code.
8451 Disabled at level @option{-Os}.
8453 @item -fno-printf-return-value
8454 @opindex fno-printf-return-value
8455 Do not substitute constants for known return value of formatted output
8456 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8457 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8458 transformation allows GCC to optimize or even eliminate branches based
8459 on the known return value of these functions called with arguments that
8460 are either constant, or whose values are known to be in a range that
8461 makes determining the exact return value possible.  For example, when
8462 @option{-fprintf-return-value} is in effect, both the branch and the
8463 body of the @code{if} statement (but not the call to @code{snprint})
8464 can be optimized away when @code{i} is a 32-bit or smaller integer
8465 because the return value is guaranteed to be at most 8.
8467 @smallexample
8468 char buf[9];
8469 if (snprintf (buf, "%08x", i) >= sizeof buf)
8470   @dots{}
8471 @end smallexample
8473 The @option{-fprintf-return-value} option relies on other optimizations
8474 and yields best results with @option{-O2}.  It works in tandem with the
8475 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8476 The @option{-fprintf-return-value} option is enabled by default.
8478 @item -fno-peephole
8479 @itemx -fno-peephole2
8480 @opindex fno-peephole
8481 @opindex fno-peephole2
8482 Disable any machine-specific peephole optimizations.  The difference
8483 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8484 are implemented in the compiler; some targets use one, some use the
8485 other, a few use both.
8487 @option{-fpeephole} is enabled by default.
8488 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8490 @item -fno-guess-branch-probability
8491 @opindex fno-guess-branch-probability
8492 Do not guess branch probabilities using heuristics.
8494 GCC uses heuristics to guess branch probabilities if they are
8495 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8496 heuristics are based on the control flow graph.  If some branch probabilities
8497 are specified by @code{__builtin_expect}, then the heuristics are
8498 used to guess branch probabilities for the rest of the control flow graph,
8499 taking the @code{__builtin_expect} info into account.  The interactions
8500 between the heuristics and @code{__builtin_expect} can be complex, and in
8501 some cases, it may be useful to disable the heuristics so that the effects
8502 of @code{__builtin_expect} are easier to understand.
8504 The default is @option{-fguess-branch-probability} at levels
8505 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8507 @item -freorder-blocks
8508 @opindex freorder-blocks
8509 Reorder basic blocks in the compiled function in order to reduce number of
8510 taken branches and improve code locality.
8512 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8514 @item -freorder-blocks-algorithm=@var{algorithm}
8515 @opindex freorder-blocks-algorithm
8516 Use the specified algorithm for basic block reordering.  The
8517 @var{algorithm} argument can be @samp{simple}, which does not increase
8518 code size (except sometimes due to secondary effects like alignment),
8519 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8520 put all often executed code together, minimizing the number of branches
8521 executed by making extra copies of code.
8523 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8524 @samp{stc} at levels @option{-O2}, @option{-O3}.
8526 @item -freorder-blocks-and-partition
8527 @opindex freorder-blocks-and-partition
8528 In addition to reordering basic blocks in the compiled function, in order
8529 to reduce number of taken branches, partitions hot and cold basic blocks
8530 into separate sections of the assembly and @file{.o} files, to improve
8531 paging and cache locality performance.
8533 This optimization is automatically turned off in the presence of
8534 exception handling, for linkonce sections, for functions with a user-defined
8535 section attribute and on any architecture that does not support named
8536 sections.
8538 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8540 @item -freorder-functions
8541 @opindex freorder-functions
8542 Reorder functions in the object file in order to
8543 improve code locality.  This is implemented by using special
8544 subsections @code{.text.hot} for most frequently executed functions and
8545 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8546 the linker so object file format must support named sections and linker must
8547 place them in a reasonable way.
8549 Also profile feedback must be available to make this option effective.  See
8550 @option{-fprofile-arcs} for details.
8552 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8554 @item -fstrict-aliasing
8555 @opindex fstrict-aliasing
8556 Allow the compiler to assume the strictest aliasing rules applicable to
8557 the language being compiled.  For C (and C++), this activates
8558 optimizations based on the type of expressions.  In particular, an
8559 object of one type is assumed never to reside at the same address as an
8560 object of a different type, unless the types are almost the same.  For
8561 example, an @code{unsigned int} can alias an @code{int}, but not a
8562 @code{void*} or a @code{double}.  A character type may alias any other
8563 type.
8565 @anchor{Type-punning}Pay special attention to code like this:
8566 @smallexample
8567 union a_union @{
8568   int i;
8569   double d;
8572 int f() @{
8573   union a_union t;
8574   t.d = 3.0;
8575   return t.i;
8577 @end smallexample
8578 The practice of reading from a different union member than the one most
8579 recently written to (called ``type-punning'') is common.  Even with
8580 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8581 is accessed through the union type.  So, the code above works as
8582 expected.  @xref{Structures unions enumerations and bit-fields
8583 implementation}.  However, this code might not:
8584 @smallexample
8585 int f() @{
8586   union a_union t;
8587   int* ip;
8588   t.d = 3.0;
8589   ip = &t.i;
8590   return *ip;
8592 @end smallexample
8594 Similarly, access by taking the address, casting the resulting pointer
8595 and dereferencing the result has undefined behavior, even if the cast
8596 uses a union type, e.g.:
8597 @smallexample
8598 int f() @{
8599   double d = 3.0;
8600   return ((union a_union *) &d)->i;
8602 @end smallexample
8604 The @option{-fstrict-aliasing} option is enabled at levels
8605 @option{-O2}, @option{-O3}, @option{-Os}.
8607 @item -fstrict-overflow
8608 @opindex fstrict-overflow
8609 Allow the compiler to assume strict signed overflow rules, depending
8610 on the language being compiled.  For C (and C++) this means that
8611 overflow when doing arithmetic with signed numbers is undefined, which
8612 means that the compiler may assume that it does not happen.  This
8613 permits various optimizations.  For example, the compiler assumes
8614 that an expression like @code{i + 10 > i} is always true for
8615 signed @code{i}.  This assumption is only valid if signed overflow is
8616 undefined, as the expression is false if @code{i + 10} overflows when
8617 using twos complement arithmetic.  When this option is in effect any
8618 attempt to determine whether an operation on signed numbers 
8619 overflows must be written carefully to not actually involve overflow.
8621 This option also allows the compiler to assume strict pointer
8622 semantics: given a pointer to an object, if adding an offset to that
8623 pointer does not produce a pointer to the same object, the addition is
8624 undefined.  This permits the compiler to conclude that @code{p + u >
8625 p} is always true for a pointer @code{p} and unsigned integer
8626 @code{u}.  This assumption is only valid because pointer wraparound is
8627 undefined, as the expression is false if @code{p + u} overflows using
8628 twos complement arithmetic.
8630 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8631 that integer signed overflow is fully defined: it wraps.  When
8632 @option{-fwrapv} is used, there is no difference between
8633 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8634 integers.  With @option{-fwrapv} certain types of overflow are
8635 permitted.  For example, if the compiler gets an overflow when doing
8636 arithmetic on constants, the overflowed value can still be used with
8637 @option{-fwrapv}, but not otherwise.
8639 The @option{-fstrict-overflow} option is enabled at levels
8640 @option{-O2}, @option{-O3}, @option{-Os}.
8642 @item -falign-functions
8643 @itemx -falign-functions=@var{n}
8644 @opindex falign-functions
8645 Align the start of functions to the next power-of-two greater than
8646 @var{n}, skipping up to @var{n} bytes.  For instance,
8647 @option{-falign-functions=32} aligns functions to the next 32-byte
8648 boundary, but @option{-falign-functions=24} aligns to the next
8649 32-byte boundary only if this can be done by skipping 23 bytes or less.
8651 @option{-fno-align-functions} and @option{-falign-functions=1} are
8652 equivalent and mean that functions are not aligned.
8654 Some assemblers only support this flag when @var{n} is a power of two;
8655 in that case, it is rounded up.
8657 If @var{n} is not specified or is zero, use a machine-dependent default.
8659 Enabled at levels @option{-O2}, @option{-O3}.
8661 @item -flimit-function-alignment
8662 If this option is enabled, the compiler tries to avoid unnecessarily
8663 overaligning functions. It attempts to instruct the assembler to align
8664 by the amount specified by @option{-falign-functions}, but not to
8665 skip more bytes than the size of the function.
8667 @item -falign-labels
8668 @itemx -falign-labels=@var{n}
8669 @opindex falign-labels
8670 Align all branch targets to a power-of-two boundary, skipping up to
8671 @var{n} bytes like @option{-falign-functions}.  This option can easily
8672 make code slower, because it must insert dummy operations for when the
8673 branch target is reached in the usual flow of the code.
8675 @option{-fno-align-labels} and @option{-falign-labels=1} are
8676 equivalent and mean that labels are not aligned.
8678 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8679 are greater than this value, then their values are used instead.
8681 If @var{n} is not specified or is zero, use a machine-dependent default
8682 which is very likely to be @samp{1}, meaning no alignment.
8684 Enabled at levels @option{-O2}, @option{-O3}.
8686 @item -falign-loops
8687 @itemx -falign-loops=@var{n}
8688 @opindex falign-loops
8689 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8690 like @option{-falign-functions}.  If the loops are
8691 executed many times, this makes up for any execution of the dummy
8692 operations.
8694 @option{-fno-align-loops} and @option{-falign-loops=1} are
8695 equivalent and mean that loops are not aligned.
8697 If @var{n} is not specified or is zero, use a machine-dependent default.
8699 Enabled at levels @option{-O2}, @option{-O3}.
8701 @item -falign-jumps
8702 @itemx -falign-jumps=@var{n}
8703 @opindex falign-jumps
8704 Align branch targets to a power-of-two boundary, for branch targets
8705 where the targets can only be reached by jumping, skipping up to @var{n}
8706 bytes like @option{-falign-functions}.  In this case, no dummy operations
8707 need be executed.
8709 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8710 equivalent and mean that loops are not aligned.
8712 If @var{n} is not specified or is zero, use a machine-dependent default.
8714 Enabled at levels @option{-O2}, @option{-O3}.
8716 @item -funit-at-a-time
8717 @opindex funit-at-a-time
8718 This option is left for compatibility reasons. @option{-funit-at-a-time}
8719 has no effect, while @option{-fno-unit-at-a-time} implies
8720 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8722 Enabled by default.
8724 @item -fno-toplevel-reorder
8725 @opindex fno-toplevel-reorder
8726 Do not reorder top-level functions, variables, and @code{asm}
8727 statements.  Output them in the same order that they appear in the
8728 input file.  When this option is used, unreferenced static variables
8729 are not removed.  This option is intended to support existing code
8730 that relies on a particular ordering.  For new code, it is better to
8731 use attributes when possible.
8733 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8734 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8735 targets.
8737 @item -fweb
8738 @opindex fweb
8739 Constructs webs as commonly used for register allocation purposes and assign
8740 each web individual pseudo register.  This allows the register allocation pass
8741 to operate on pseudos directly, but also strengthens several other optimization
8742 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8743 however, make debugging impossible, since variables no longer stay in a
8744 ``home register''.
8746 Enabled by default with @option{-funroll-loops}.
8748 @item -fwhole-program
8749 @opindex fwhole-program
8750 Assume that the current compilation unit represents the whole program being
8751 compiled.  All public functions and variables with the exception of @code{main}
8752 and those merged by attribute @code{externally_visible} become static functions
8753 and in effect are optimized more aggressively by interprocedural optimizers.
8755 This option should not be used in combination with @option{-flto}.
8756 Instead relying on a linker plugin should provide safer and more precise
8757 information.
8759 @item -flto[=@var{n}]
8760 @opindex flto
8761 This option runs the standard link-time optimizer.  When invoked
8762 with source code, it generates GIMPLE (one of GCC's internal
8763 representations) and writes it to special ELF sections in the object
8764 file.  When the object files are linked together, all the function
8765 bodies are read from these ELF sections and instantiated as if they
8766 had been part of the same translation unit.
8768 To use the link-time optimizer, @option{-flto} and optimization
8769 options should be specified at compile time and during the final link.
8770 It is recommended that you compile all the files participating in the
8771 same link with the same options and also specify those options at
8772 link time.  
8773 For example:
8775 @smallexample
8776 gcc -c -O2 -flto foo.c
8777 gcc -c -O2 -flto bar.c
8778 gcc -o myprog -flto -O2 foo.o bar.o
8779 @end smallexample
8781 The first two invocations to GCC save a bytecode representation
8782 of GIMPLE into special ELF sections inside @file{foo.o} and
8783 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8784 @file{foo.o} and @file{bar.o}, merges the two files into a single
8785 internal image, and compiles the result as usual.  Since both
8786 @file{foo.o} and @file{bar.o} are merged into a single image, this
8787 causes all the interprocedural analyses and optimizations in GCC to
8788 work across the two files as if they were a single one.  This means,
8789 for example, that the inliner is able to inline functions in
8790 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8792 Another (simpler) way to enable link-time optimization is:
8794 @smallexample
8795 gcc -o myprog -flto -O2 foo.c bar.c
8796 @end smallexample
8798 The above generates bytecode for @file{foo.c} and @file{bar.c},
8799 merges them together into a single GIMPLE representation and optimizes
8800 them as usual to produce @file{myprog}.
8802 The only important thing to keep in mind is that to enable link-time
8803 optimizations you need to use the GCC driver to perform the link step.
8804 GCC then automatically performs link-time optimization if any of the
8805 objects involved were compiled with the @option{-flto} command-line option.  
8806 You generally
8807 should specify the optimization options to be used for link-time
8808 optimization though GCC tries to be clever at guessing an
8809 optimization level to use from the options used at compile time
8810 if you fail to specify one at link time.  You can always override
8811 the automatic decision to do link-time optimization at link time
8812 by passing @option{-fno-lto} to the link command.
8814 To make whole program optimization effective, it is necessary to make
8815 certain whole program assumptions.  The compiler needs to know
8816 what functions and variables can be accessed by libraries and runtime
8817 outside of the link-time optimized unit.  When supported by the linker,
8818 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8819 to the compiler about used and externally visible symbols.  When
8820 the linker plugin is not available, @option{-fwhole-program} should be
8821 used to allow the compiler to make these assumptions, which leads
8822 to more aggressive optimization decisions.
8824 When @option{-fuse-linker-plugin} is not enabled, when a file is
8825 compiled with @option{-flto}, the generated object file is larger than
8826 a regular object file because it contains GIMPLE bytecodes and the usual
8827 final code (see @option{-ffat-lto-objects}.  This means that
8828 object files with LTO information can be linked as normal object
8829 files; if @option{-fno-lto} is passed to the linker, no
8830 interprocedural optimizations are applied.  Note that when
8831 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8832 but you cannot perform a regular, non-LTO link on them.
8834 Additionally, the optimization flags used to compile individual files
8835 are not necessarily related to those used at link time.  For instance,
8837 @smallexample
8838 gcc -c -O0 -ffat-lto-objects -flto foo.c
8839 gcc -c -O0 -ffat-lto-objects -flto bar.c
8840 gcc -o myprog -O3 foo.o bar.o
8841 @end smallexample
8843 This produces individual object files with unoptimized assembler
8844 code, but the resulting binary @file{myprog} is optimized at
8845 @option{-O3}.  If, instead, the final binary is generated with
8846 @option{-fno-lto}, then @file{myprog} is not optimized.
8848 When producing the final binary, GCC only
8849 applies link-time optimizations to those files that contain bytecode.
8850 Therefore, you can mix and match object files and libraries with
8851 GIMPLE bytecodes and final object code.  GCC automatically selects
8852 which files to optimize in LTO mode and which files to link without
8853 further processing.
8855 There are some code generation flags preserved by GCC when
8856 generating bytecodes, as they need to be used during the final link
8857 stage.  Generally options specified at link time override those
8858 specified at compile time.
8860 If you do not specify an optimization level option @option{-O} at
8861 link time, then GCC uses the highest optimization level 
8862 used when compiling the object files.
8864 Currently, the following options and their settings are taken from
8865 the first object file that explicitly specifies them: 
8866 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8867 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8868 and all the @option{-m} target flags.
8870 Certain ABI-changing flags are required to match in all compilation units,
8871 and trying to override this at link time with a conflicting value
8872 is ignored.  This includes options such as @option{-freg-struct-return}
8873 and @option{-fpcc-struct-return}. 
8875 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8876 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8877 are passed through to the link stage and merged conservatively for
8878 conflicting translation units.  Specifically
8879 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8880 precedence; and for example @option{-ffp-contract=off} takes precedence
8881 over @option{-ffp-contract=fast}.  You can override them at link time.
8883 If LTO encounters objects with C linkage declared with incompatible
8884 types in separate translation units to be linked together (undefined
8885 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8886 issued.  The behavior is still undefined at run time.  Similar
8887 diagnostics may be raised for other languages.
8889 Another feature of LTO is that it is possible to apply interprocedural
8890 optimizations on files written in different languages:
8892 @smallexample
8893 gcc -c -flto foo.c
8894 g++ -c -flto bar.cc
8895 gfortran -c -flto baz.f90
8896 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8897 @end smallexample
8899 Notice that the final link is done with @command{g++} to get the C++
8900 runtime libraries and @option{-lgfortran} is added to get the Fortran
8901 runtime libraries.  In general, when mixing languages in LTO mode, you
8902 should use the same link command options as when mixing languages in a
8903 regular (non-LTO) compilation.
8905 If object files containing GIMPLE bytecode are stored in a library archive, say
8906 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8907 are using a linker with plugin support.  To create static libraries suitable
8908 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8909 and @command{ranlib}; 
8910 to show the symbols of object files with GIMPLE bytecode, use
8911 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8912 and @command{nm} have been compiled with plugin support.  At link time, use the the
8913 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8914 the LTO optimization process:
8916 @smallexample
8917 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8918 @end smallexample
8920 With the linker plugin enabled, the linker extracts the needed
8921 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8922 to make them part of the aggregated GIMPLE image to be optimized.
8924 If you are not using a linker with plugin support and/or do not
8925 enable the linker plugin, then the objects inside @file{libfoo.a}
8926 are extracted and linked as usual, but they do not participate
8927 in the LTO optimization process.  In order to make a static library suitable
8928 for both LTO optimization and usual linkage, compile its object files with
8929 @option{-flto} @option{-ffat-lto-objects}.
8931 Link-time optimizations do not require the presence of the whole program to
8932 operate.  If the program does not require any symbols to be exported, it is
8933 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8934 the interprocedural optimizers to use more aggressive assumptions which may
8935 lead to improved optimization opportunities.
8936 Use of @option{-fwhole-program} is not needed when linker plugin is
8937 active (see @option{-fuse-linker-plugin}).
8939 The current implementation of LTO makes no
8940 attempt to generate bytecode that is portable between different
8941 types of hosts.  The bytecode files are versioned and there is a
8942 strict version check, so bytecode files generated in one version of
8943 GCC do not work with an older or newer version of GCC.
8945 Link-time optimization does not work well with generation of debugging
8946 information.  Combining @option{-flto} with
8947 @option{-g} is currently experimental and expected to produce unexpected
8948 results.
8950 If you specify the optional @var{n}, the optimization and code
8951 generation done at link time is executed in parallel using @var{n}
8952 parallel jobs by utilizing an installed @command{make} program.  The
8953 environment variable @env{MAKE} may be used to override the program
8954 used.  The default value for @var{n} is 1.
8956 You can also specify @option{-flto=jobserver} to use GNU make's
8957 job server mode to determine the number of parallel jobs. This
8958 is useful when the Makefile calling GCC is already executing in parallel.
8959 You must prepend a @samp{+} to the command recipe in the parent Makefile
8960 for this to work.  This option likely only works if @env{MAKE} is
8961 GNU make.
8963 @item -flto-partition=@var{alg}
8964 @opindex flto-partition
8965 Specify the partitioning algorithm used by the link-time optimizer.
8966 The value is either @samp{1to1} to specify a partitioning mirroring
8967 the original source files or @samp{balanced} to specify partitioning
8968 into equally sized chunks (whenever possible) or @samp{max} to create
8969 new partition for every symbol where possible.  Specifying @samp{none}
8970 as an algorithm disables partitioning and streaming completely. 
8971 The default value is @samp{balanced}. While @samp{1to1} can be used
8972 as an workaround for various code ordering issues, the @samp{max}
8973 partitioning is intended for internal testing only.
8974 The value @samp{one} specifies that exactly one partition should be
8975 used while the value @samp{none} bypasses partitioning and executes
8976 the link-time optimization step directly from the WPA phase.
8978 @item -flto-odr-type-merging
8979 @opindex flto-odr-type-merging
8980 Enable streaming of mangled types names of C++ types and their unification
8981 at link time.  This increases size of LTO object files, but enables
8982 diagnostics about One Definition Rule violations.
8984 @item -flto-compression-level=@var{n}
8985 @opindex flto-compression-level
8986 This option specifies the level of compression used for intermediate
8987 language written to LTO object files, and is only meaningful in
8988 conjunction with LTO mode (@option{-flto}).  Valid
8989 values are 0 (no compression) to 9 (maximum compression).  Values
8990 outside this range are clamped to either 0 or 9.  If the option is not
8991 given, a default balanced compression setting is used.
8993 @item -fuse-linker-plugin
8994 @opindex fuse-linker-plugin
8995 Enables the use of a linker plugin during link-time optimization.  This
8996 option relies on plugin support in the linker, which is available in gold
8997 or in GNU ld 2.21 or newer.
8999 This option enables the extraction of object files with GIMPLE bytecode out
9000 of library archives. This improves the quality of optimization by exposing
9001 more code to the link-time optimizer.  This information specifies what
9002 symbols can be accessed externally (by non-LTO object or during dynamic
9003 linking).  Resulting code quality improvements on binaries (and shared
9004 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9005 See @option{-flto} for a description of the effect of this flag and how to
9006 use it.
9008 This option is enabled by default when LTO support in GCC is enabled
9009 and GCC was configured for use with
9010 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9012 @item -ffat-lto-objects
9013 @opindex ffat-lto-objects
9014 Fat LTO objects are object files that contain both the intermediate language
9015 and the object code. This makes them usable for both LTO linking and normal
9016 linking. This option is effective only when compiling with @option{-flto}
9017 and is ignored at link time.
9019 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9020 requires the complete toolchain to be aware of LTO. It requires a linker with
9021 linker plugin support for basic functionality.  Additionally,
9022 @command{nm}, @command{ar} and @command{ranlib}
9023 need to support linker plugins to allow a full-featured build environment
9024 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9025 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9026 to these tools. With non fat LTO makefiles need to be modified to use them.
9028 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9029 support.
9031 @item -fcompare-elim
9032 @opindex fcompare-elim
9033 After register allocation and post-register allocation instruction splitting,
9034 identify arithmetic instructions that compute processor flags similar to a
9035 comparison operation based on that arithmetic.  If possible, eliminate the
9036 explicit comparison operation.
9038 This pass only applies to certain targets that cannot explicitly represent
9039 the comparison operation before register allocation is complete.
9041 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9043 @item -fcprop-registers
9044 @opindex fcprop-registers
9045 After register allocation and post-register allocation instruction splitting,
9046 perform a copy-propagation pass to try to reduce scheduling dependencies
9047 and occasionally eliminate the copy.
9049 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9051 @item -fprofile-correction
9052 @opindex fprofile-correction
9053 Profiles collected using an instrumented binary for multi-threaded programs may
9054 be inconsistent due to missed counter updates. When this option is specified,
9055 GCC uses heuristics to correct or smooth out such inconsistencies. By
9056 default, GCC emits an error message when an inconsistent profile is detected.
9058 @item -fprofile-use
9059 @itemx -fprofile-use=@var{path}
9060 @opindex fprofile-use
9061 Enable profile feedback-directed optimizations, 
9062 and the following optimizations
9063 which are generally profitable only with profile feedback available:
9064 @option{-fbranch-probabilities}, @option{-fvpt},
9065 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9066 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9068 Before you can use this option, you must first generate profiling information.
9069 @xref{Instrumentation Options}, for information about the
9070 @option{-fprofile-generate} option.
9072 By default, GCC emits an error message if the feedback profiles do not
9073 match the source code.  This error can be turned into a warning by using
9074 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9075 code.
9077 If @var{path} is specified, GCC looks at the @var{path} to find
9078 the profile feedback data files. See @option{-fprofile-dir}.
9080 @item -fauto-profile
9081 @itemx -fauto-profile=@var{path}
9082 @opindex fauto-profile
9083 Enable sampling-based feedback-directed optimizations, 
9084 and the following optimizations
9085 which are generally profitable only with profile feedback available:
9086 @option{-fbranch-probabilities}, @option{-fvpt},
9087 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9088 @option{-ftree-vectorize},
9089 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9090 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9091 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9093 @var{path} is the name of a file containing AutoFDO profile information.
9094 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9096 Producing an AutoFDO profile data file requires running your program
9097 with the @command{perf} utility on a supported GNU/Linux target system.
9098 For more information, see @uref{https://perf.wiki.kernel.org/}.
9100 E.g.
9101 @smallexample
9102 perf record -e br_inst_retired:near_taken -b -o perf.data \
9103     -- your_program
9104 @end smallexample
9106 Then use the @command{create_gcov} tool to convert the raw profile data
9107 to a format that can be used by GCC.@  You must also supply the 
9108 unstripped binary for your program to this tool.  
9109 See @uref{https://github.com/google/autofdo}.
9111 E.g.
9112 @smallexample
9113 create_gcov --binary=your_program.unstripped --profile=perf.data \
9114     --gcov=profile.afdo
9115 @end smallexample
9116 @end table
9118 The following options control compiler behavior regarding floating-point 
9119 arithmetic.  These options trade off between speed and
9120 correctness.  All must be specifically enabled.
9122 @table @gcctabopt
9123 @item -ffloat-store
9124 @opindex ffloat-store
9125 Do not store floating-point variables in registers, and inhibit other
9126 options that might change whether a floating-point value is taken from a
9127 register or memory.
9129 @cindex floating-point precision
9130 This option prevents undesirable excess precision on machines such as
9131 the 68000 where the floating registers (of the 68881) keep more
9132 precision than a @code{double} is supposed to have.  Similarly for the
9133 x86 architecture.  For most programs, the excess precision does only
9134 good, but a few programs rely on the precise definition of IEEE floating
9135 point.  Use @option{-ffloat-store} for such programs, after modifying
9136 them to store all pertinent intermediate computations into variables.
9138 @item -fexcess-precision=@var{style}
9139 @opindex fexcess-precision
9140 This option allows further control over excess precision on machines
9141 where floating-point operations occur in a format with more precision or
9142 range than the IEEE standard and interchange floating-point types.  By
9143 default, @option{-fexcess-precision=fast} is in effect; this means that
9144 operations may be carried out in a wider precision than the types specified
9145 in the source if that would result in faster code, and it is unpredictable
9146 when rounding to the types specified in the source code takes place.
9147 When compiling C, if @option{-fexcess-precision=standard} is specified then
9148 excess precision follows the rules specified in ISO C99; in particular,
9149 both casts and assignments cause values to be rounded to their
9150 semantic types (whereas @option{-ffloat-store} only affects
9151 assignments).  This option is enabled by default for C if a strict
9152 conformance option such as @option{-std=c99} is used.
9153 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9154 regardless of whether a strict conformance option is used.
9156 @opindex mfpmath
9157 @option{-fexcess-precision=standard} is not implemented for languages
9158 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9159 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9160 semantics apply without excess precision, and in the latter, rounding
9161 is unpredictable.
9163 @item -ffast-math
9164 @opindex ffast-math
9165 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9166 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9167 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9168 @option{-fexcess-precision=fast}.
9170 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9172 This option is not turned on by any @option{-O} option besides
9173 @option{-Ofast} since it can result in incorrect output for programs
9174 that depend on an exact implementation of IEEE or ISO rules/specifications
9175 for math functions. It may, however, yield faster code for programs
9176 that do not require the guarantees of these specifications.
9178 @item -fno-math-errno
9179 @opindex fno-math-errno
9180 Do not set @code{errno} after calling math functions that are executed
9181 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9182 IEEE exceptions for math error handling may want to use this flag
9183 for speed while maintaining IEEE arithmetic compatibility.
9185 This option is not turned on by any @option{-O} option since
9186 it can result in incorrect output for programs that depend on
9187 an exact implementation of IEEE or ISO rules/specifications for
9188 math functions. It may, however, yield faster code for programs
9189 that do not require the guarantees of these specifications.
9191 The default is @option{-fmath-errno}.
9193 On Darwin systems, the math library never sets @code{errno}.  There is
9194 therefore no reason for the compiler to consider the possibility that
9195 it might, and @option{-fno-math-errno} is the default.
9197 @item -funsafe-math-optimizations
9198 @opindex funsafe-math-optimizations
9200 Allow optimizations for floating-point arithmetic that (a) assume
9201 that arguments and results are valid and (b) may violate IEEE or
9202 ANSI standards.  When used at link time, it may include libraries
9203 or startup files that change the default FPU control word or other
9204 similar optimizations.
9206 This option is not turned on by any @option{-O} option since
9207 it can result in incorrect output for programs that depend on
9208 an exact implementation of IEEE or ISO rules/specifications for
9209 math functions. It may, however, yield faster code for programs
9210 that do not require the guarantees of these specifications.
9211 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9212 @option{-fassociative-math} and @option{-freciprocal-math}.
9214 The default is @option{-fno-unsafe-math-optimizations}.
9216 @item -fassociative-math
9217 @opindex fassociative-math
9219 Allow re-association of operands in series of floating-point operations.
9220 This violates the ISO C and C++ language standard by possibly changing
9221 computation result.  NOTE: re-ordering may change the sign of zero as
9222 well as ignore NaNs and inhibit or create underflow or overflow (and
9223 thus cannot be used on code that relies on rounding behavior like
9224 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9225 and thus may not be used when ordered comparisons are required.
9226 This option requires that both @option{-fno-signed-zeros} and
9227 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9228 much sense with @option{-frounding-math}. For Fortran the option
9229 is automatically enabled when both @option{-fno-signed-zeros} and
9230 @option{-fno-trapping-math} are in effect.
9232 The default is @option{-fno-associative-math}.
9234 @item -freciprocal-math
9235 @opindex freciprocal-math
9237 Allow the reciprocal of a value to be used instead of dividing by
9238 the value if this enables optimizations.  For example @code{x / y}
9239 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9240 is subject to common subexpression elimination.  Note that this loses
9241 precision and increases the number of flops operating on the value.
9243 The default is @option{-fno-reciprocal-math}.
9245 @item -ffinite-math-only
9246 @opindex ffinite-math-only
9247 Allow optimizations for floating-point arithmetic that assume
9248 that arguments and results are not NaNs or +-Infs.
9250 This option is not turned on by any @option{-O} option since
9251 it can result in incorrect output for programs that depend on
9252 an exact implementation of IEEE or ISO rules/specifications for
9253 math functions. It may, however, yield faster code for programs
9254 that do not require the guarantees of these specifications.
9256 The default is @option{-fno-finite-math-only}.
9258 @item -fno-signed-zeros
9259 @opindex fno-signed-zeros
9260 Allow optimizations for floating-point arithmetic that ignore the
9261 signedness of zero.  IEEE arithmetic specifies the behavior of
9262 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9263 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9264 This option implies that the sign of a zero result isn't significant.
9266 The default is @option{-fsigned-zeros}.
9268 @item -fno-trapping-math
9269 @opindex fno-trapping-math
9270 Compile code assuming that floating-point operations cannot generate
9271 user-visible traps.  These traps include division by zero, overflow,
9272 underflow, inexact result and invalid operation.  This option requires
9273 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9274 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9276 This option should never be turned on by any @option{-O} option since
9277 it can result in incorrect output for programs that depend on
9278 an exact implementation of IEEE or ISO rules/specifications for
9279 math functions.
9281 The default is @option{-ftrapping-math}.
9283 @item -frounding-math
9284 @opindex frounding-math
9285 Disable transformations and optimizations that assume default floating-point
9286 rounding behavior.  This is round-to-zero for all floating point
9287 to integer conversions, and round-to-nearest for all other arithmetic
9288 truncations.  This option should be specified for programs that change
9289 the FP rounding mode dynamically, or that may be executed with a
9290 non-default rounding mode.  This option disables constant folding of
9291 floating-point expressions at compile time (which may be affected by
9292 rounding mode) and arithmetic transformations that are unsafe in the
9293 presence of sign-dependent rounding modes.
9295 The default is @option{-fno-rounding-math}.
9297 This option is experimental and does not currently guarantee to
9298 disable all GCC optimizations that are affected by rounding mode.
9299 Future versions of GCC may provide finer control of this setting
9300 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9301 will be used to specify the default state for @code{FENV_ACCESS}.
9303 @item -fsignaling-nans
9304 @opindex fsignaling-nans
9305 Compile code assuming that IEEE signaling NaNs may generate user-visible
9306 traps during floating-point operations.  Setting this option disables
9307 optimizations that may change the number of exceptions visible with
9308 signaling NaNs.  This option implies @option{-ftrapping-math}.
9310 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9311 be defined.
9313 The default is @option{-fno-signaling-nans}.
9315 This option is experimental and does not currently guarantee to
9316 disable all GCC optimizations that affect signaling NaN behavior.
9318 @item -fno-fp-int-builtin-inexact
9319 @opindex fno-fp-int-builtin-inexact
9320 Do not allow the built-in functions @code{ceil}, @code{floor},
9321 @code{round} and @code{trunc}, and their @code{float} and @code{long
9322 double} variants, to generate code that raises the ``inexact''
9323 floating-point exception for noninteger arguments.  ISO C99 and C11
9324 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9325 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9326 functions to do so.
9328 The default is @option{-ffp-int-builtin-inexact}, allowing the
9329 exception to be raised.  This option does nothing unless
9330 @option{-ftrapping-math} is in effect.
9332 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9333 generate a call to a library function then the ``inexact'' exception
9334 may be raised if the library implementation does not follow TS 18661.
9336 @item -fsingle-precision-constant
9337 @opindex fsingle-precision-constant
9338 Treat floating-point constants as single precision instead of
9339 implicitly converting them to double-precision constants.
9341 @item -fcx-limited-range
9342 @opindex fcx-limited-range
9343 When enabled, this option states that a range reduction step is not
9344 needed when performing complex division.  Also, there is no checking
9345 whether the result of a complex multiplication or division is @code{NaN
9346 + I*NaN}, with an attempt to rescue the situation in that case.  The
9347 default is @option{-fno-cx-limited-range}, but is enabled by
9348 @option{-ffast-math}.
9350 This option controls the default setting of the ISO C99
9351 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9352 all languages.
9354 @item -fcx-fortran-rules
9355 @opindex fcx-fortran-rules
9356 Complex multiplication and division follow Fortran rules.  Range
9357 reduction is done as part of complex division, but there is no checking
9358 whether the result of a complex multiplication or division is @code{NaN
9359 + I*NaN}, with an attempt to rescue the situation in that case.
9361 The default is @option{-fno-cx-fortran-rules}.
9363 @end table
9365 The following options control optimizations that may improve
9366 performance, but are not enabled by any @option{-O} options.  This
9367 section includes experimental options that may produce broken code.
9369 @table @gcctabopt
9370 @item -fbranch-probabilities
9371 @opindex fbranch-probabilities
9372 After running a program compiled with @option{-fprofile-arcs}
9373 (@pxref{Instrumentation Options}),
9374 you can compile it a second time using
9375 @option{-fbranch-probabilities}, to improve optimizations based on
9376 the number of times each branch was taken.  When a program
9377 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9378 counts to a file called @file{@var{sourcename}.gcda} for each source
9379 file.  The information in this data file is very dependent on the
9380 structure of the generated code, so you must use the same source code
9381 and the same optimization options for both compilations.
9383 With @option{-fbranch-probabilities}, GCC puts a
9384 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9385 These can be used to improve optimization.  Currently, they are only
9386 used in one place: in @file{reorg.c}, instead of guessing which path a
9387 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9388 exactly determine which path is taken more often.
9390 @item -fprofile-values
9391 @opindex fprofile-values
9392 If combined with @option{-fprofile-arcs}, it adds code so that some
9393 data about values of expressions in the program is gathered.
9395 With @option{-fbranch-probabilities}, it reads back the data gathered
9396 from profiling values of expressions for usage in optimizations.
9398 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9400 @item -fprofile-reorder-functions
9401 @opindex fprofile-reorder-functions
9402 Function reordering based on profile instrumentation collects
9403 first time of execution of a function and orders these functions
9404 in ascending order.
9406 Enabled with @option{-fprofile-use}.
9408 @item -fvpt
9409 @opindex fvpt
9410 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9411 to add code to gather information about values of expressions.
9413 With @option{-fbranch-probabilities}, it reads back the data gathered
9414 and actually performs the optimizations based on them.
9415 Currently the optimizations include specialization of division operations
9416 using the knowledge about the value of the denominator.
9418 @item -frename-registers
9419 @opindex frename-registers
9420 Attempt to avoid false dependencies in scheduled code by making use
9421 of registers left over after register allocation.  This optimization
9422 most benefits processors with lots of registers.  Depending on the
9423 debug information format adopted by the target, however, it can
9424 make debugging impossible, since variables no longer stay in
9425 a ``home register''.
9427 Enabled by default with @option{-funroll-loops}.
9429 @item -fschedule-fusion
9430 @opindex fschedule-fusion
9431 Performs a target dependent pass over the instruction stream to schedule
9432 instructions of same type together because target machine can execute them
9433 more efficiently if they are adjacent to each other in the instruction flow.
9435 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9437 @item -ftracer
9438 @opindex ftracer
9439 Perform tail duplication to enlarge superblock size.  This transformation
9440 simplifies the control flow of the function allowing other optimizations to do
9441 a better job.
9443 Enabled with @option{-fprofile-use}.
9445 @item -funroll-loops
9446 @opindex funroll-loops
9447 Unroll loops whose number of iterations can be determined at compile time or
9448 upon entry to the loop.  @option{-funroll-loops} implies
9449 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9450 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9451 a small constant number of iterations).  This option makes code larger, and may
9452 or may not make it run faster.
9454 Enabled with @option{-fprofile-use}.
9456 @item -funroll-all-loops
9457 @opindex funroll-all-loops
9458 Unroll all loops, even if their number of iterations is uncertain when
9459 the loop is entered.  This usually makes programs run more slowly.
9460 @option{-funroll-all-loops} implies the same options as
9461 @option{-funroll-loops}.
9463 @item -fpeel-loops
9464 @opindex fpeel-loops
9465 Peels loops for which there is enough information that they do not
9466 roll much (from profile feedback or static analysis).  It also turns on
9467 complete loop peeling (i.e.@: complete removal of loops with small constant
9468 number of iterations).
9470 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9472 @item -fmove-loop-invariants
9473 @opindex fmove-loop-invariants
9474 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9475 at level @option{-O1}
9477 @item -fsplit-loops
9478 @opindex fsplit-loops
9479 Split a loop into two if it contains a condition that's always true
9480 for one side of the iteration space and false for the other.
9482 @item -funswitch-loops
9483 @opindex funswitch-loops
9484 Move branches with loop invariant conditions out of the loop, with duplicates
9485 of the loop on both branches (modified according to result of the condition).
9487 @item -ffunction-sections
9488 @itemx -fdata-sections
9489 @opindex ffunction-sections
9490 @opindex fdata-sections
9491 Place each function or data item into its own section in the output
9492 file if the target supports arbitrary sections.  The name of the
9493 function or the name of the data item determines the section's name
9494 in the output file.
9496 Use these options on systems where the linker can perform optimizations
9497 to improve locality of reference in the instruction space.  Most systems
9498 using the ELF object format and SPARC processors running Solaris 2 have
9499 linkers with such optimizations.  AIX may have these optimizations in
9500 the future.
9502 Only use these options when there are significant benefits from doing
9503 so.  When you specify these options, the assembler and linker
9504 create larger object and executable files and are also slower.
9505 You cannot use @command{gprof} on all systems if you
9506 specify this option, and you may have problems with debugging if
9507 you specify both this option and @option{-g}.
9509 @item -fbranch-target-load-optimize
9510 @opindex fbranch-target-load-optimize
9511 Perform branch target register load optimization before prologue / epilogue
9512 threading.
9513 The use of target registers can typically be exposed only during reload,
9514 thus hoisting loads out of loops and doing inter-block scheduling needs
9515 a separate optimization pass.
9517 @item -fbranch-target-load-optimize2
9518 @opindex fbranch-target-load-optimize2
9519 Perform branch target register load optimization after prologue / epilogue
9520 threading.
9522 @item -fbtr-bb-exclusive
9523 @opindex fbtr-bb-exclusive
9524 When performing branch target register load optimization, don't reuse
9525 branch target registers within any basic block.
9527 @item -fstdarg-opt
9528 @opindex fstdarg-opt
9529 Optimize the prologue of variadic argument functions with respect to usage of
9530 those arguments.
9532 @item -fsection-anchors
9533 @opindex fsection-anchors
9534 Try to reduce the number of symbolic address calculations by using
9535 shared ``anchor'' symbols to address nearby objects.  This transformation
9536 can help to reduce the number of GOT entries and GOT accesses on some
9537 targets.
9539 For example, the implementation of the following function @code{foo}:
9541 @smallexample
9542 static int a, b, c;
9543 int foo (void) @{ return a + b + c; @}
9544 @end smallexample
9546 @noindent
9547 usually calculates the addresses of all three variables, but if you
9548 compile it with @option{-fsection-anchors}, it accesses the variables
9549 from a common anchor point instead.  The effect is similar to the
9550 following pseudocode (which isn't valid C):
9552 @smallexample
9553 int foo (void)
9555   register int *xr = &x;
9556   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9558 @end smallexample
9560 Not all targets support this option.
9562 @item --param @var{name}=@var{value}
9563 @opindex param
9564 In some places, GCC uses various constants to control the amount of
9565 optimization that is done.  For example, GCC does not inline functions
9566 that contain more than a certain number of instructions.  You can
9567 control some of these constants on the command line using the
9568 @option{--param} option.
9570 The names of specific parameters, and the meaning of the values, are
9571 tied to the internals of the compiler, and are subject to change
9572 without notice in future releases.
9574 In each case, the @var{value} is an integer.  The allowable choices for
9575 @var{name} are:
9577 @table @gcctabopt
9578 @item predictable-branch-outcome
9579 When branch is predicted to be taken with probability lower than this threshold
9580 (in percent), then it is considered well predictable. The default is 10.
9582 @item max-rtl-if-conversion-insns
9583 RTL if-conversion tries to remove conditional branches around a block and
9584 replace them with conditionally executed instructions.  This parameter
9585 gives the maximum number of instructions in a block which should be
9586 considered for if-conversion.  The default is 10, though the compiler will
9587 also use other heuristics to decide whether if-conversion is likely to be
9588 profitable.
9590 @item max-rtl-if-conversion-predictable-cost
9591 @item max-rtl-if-conversion-unpredictable-cost
9592 RTL if-conversion will try to remove conditional branches around a block
9593 and replace them with conditionally executed instructions.  These parameters
9594 give the maximum permissible cost for the sequence that would be generated
9595 by if-conversion depending on whether the branch is statically determined
9596 to be predictable or not.  The units for this parameter are the same as
9597 those for the GCC internal seq_cost metric.  The compiler will try to
9598 provide a reasonable default for this parameter using the BRANCH_COST
9599 target macro.
9601 @item max-crossjump-edges
9602 The maximum number of incoming edges to consider for cross-jumping.
9603 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9604 the number of edges incoming to each block.  Increasing values mean
9605 more aggressive optimization, making the compilation time increase with
9606 probably small improvement in executable size.
9608 @item min-crossjump-insns
9609 The minimum number of instructions that must be matched at the end
9610 of two blocks before cross-jumping is performed on them.  This
9611 value is ignored in the case where all instructions in the block being
9612 cross-jumped from are matched.  The default value is 5.
9614 @item max-grow-copy-bb-insns
9615 The maximum code size expansion factor when copying basic blocks
9616 instead of jumping.  The expansion is relative to a jump instruction.
9617 The default value is 8.
9619 @item max-goto-duplication-insns
9620 The maximum number of instructions to duplicate to a block that jumps
9621 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9622 passes, GCC factors computed gotos early in the compilation process,
9623 and unfactors them as late as possible.  Only computed jumps at the
9624 end of a basic blocks with no more than max-goto-duplication-insns are
9625 unfactored.  The default value is 8.
9627 @item max-delay-slot-insn-search
9628 The maximum number of instructions to consider when looking for an
9629 instruction to fill a delay slot.  If more than this arbitrary number of
9630 instructions are searched, the time savings from filling the delay slot
9631 are minimal, so stop searching.  Increasing values mean more
9632 aggressive optimization, making the compilation time increase with probably
9633 small improvement in execution time.
9635 @item max-delay-slot-live-search
9636 When trying to fill delay slots, the maximum number of instructions to
9637 consider when searching for a block with valid live register
9638 information.  Increasing this arbitrarily chosen value means more
9639 aggressive optimization, increasing the compilation time.  This parameter
9640 should be removed when the delay slot code is rewritten to maintain the
9641 control-flow graph.
9643 @item max-gcse-memory
9644 The approximate maximum amount of memory that can be allocated in
9645 order to perform the global common subexpression elimination
9646 optimization.  If more memory than specified is required, the
9647 optimization is not done.
9649 @item max-gcse-insertion-ratio
9650 If the ratio of expression insertions to deletions is larger than this value
9651 for any expression, then RTL PRE inserts or removes the expression and thus
9652 leaves partially redundant computations in the instruction stream.  The default value is 20.
9654 @item max-pending-list-length
9655 The maximum number of pending dependencies scheduling allows
9656 before flushing the current state and starting over.  Large functions
9657 with few branches or calls can create excessively large lists which
9658 needlessly consume memory and resources.
9660 @item max-modulo-backtrack-attempts
9661 The maximum number of backtrack attempts the scheduler should make
9662 when modulo scheduling a loop.  Larger values can exponentially increase
9663 compilation time.
9665 @item max-inline-insns-single
9666 Several parameters control the tree inliner used in GCC@.
9667 This number sets the maximum number of instructions (counted in GCC's
9668 internal representation) in a single function that the tree inliner
9669 considers for inlining.  This only affects functions declared
9670 inline and methods implemented in a class declaration (C++).
9671 The default value is 400.
9673 @item max-inline-insns-auto
9674 When you use @option{-finline-functions} (included in @option{-O3}),
9675 a lot of functions that would otherwise not be considered for inlining
9676 by the compiler are investigated.  To those functions, a different
9677 (more restrictive) limit compared to functions declared inline can
9678 be applied.
9679 The default value is 40.
9681 @item inline-min-speedup
9682 When estimated performance improvement of caller + callee runtime exceeds this
9683 threshold (in percent), the function can be inlined regardless of the limit on
9684 @option{--param max-inline-insns-single} and @option{--param
9685 max-inline-insns-auto}.
9687 @item large-function-insns
9688 The limit specifying really large functions.  For functions larger than this
9689 limit after inlining, inlining is constrained by
9690 @option{--param large-function-growth}.  This parameter is useful primarily
9691 to avoid extreme compilation time caused by non-linear algorithms used by the
9692 back end.
9693 The default value is 2700.
9695 @item large-function-growth
9696 Specifies maximal growth of large function caused by inlining in percents.
9697 The default value is 100 which limits large function growth to 2.0 times
9698 the original size.
9700 @item large-unit-insns
9701 The limit specifying large translation unit.  Growth caused by inlining of
9702 units larger than this limit is limited by @option{--param inline-unit-growth}.
9703 For small units this might be too tight.
9704 For example, consider a unit consisting of function A
9705 that is inline and B that just calls A three times.  If B is small relative to
9706 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9707 large units consisting of small inlineable functions, however, the overall unit
9708 growth limit is needed to avoid exponential explosion of code size.  Thus for
9709 smaller units, the size is increased to @option{--param large-unit-insns}
9710 before applying @option{--param inline-unit-growth}.  The default is 10000.
9712 @item inline-unit-growth
9713 Specifies maximal overall growth of the compilation unit caused by inlining.
9714 The default value is 20 which limits unit growth to 1.2 times the original
9715 size. Cold functions (either marked cold via an attribute or by profile
9716 feedback) are not accounted into the unit size.
9718 @item ipcp-unit-growth
9719 Specifies maximal overall growth of the compilation unit caused by
9720 interprocedural constant propagation.  The default value is 10 which limits
9721 unit growth to 1.1 times the original size.
9723 @item large-stack-frame
9724 The limit specifying large stack frames.  While inlining the algorithm is trying
9725 to not grow past this limit too much.  The default value is 256 bytes.
9727 @item large-stack-frame-growth
9728 Specifies maximal growth of large stack frames caused by inlining in percents.
9729 The default value is 1000 which limits large stack frame growth to 11 times
9730 the original size.
9732 @item max-inline-insns-recursive
9733 @itemx max-inline-insns-recursive-auto
9734 Specifies the maximum number of instructions an out-of-line copy of a
9735 self-recursive inline
9736 function can grow into by performing recursive inlining.
9738 @option{--param max-inline-insns-recursive} applies to functions
9739 declared inline.
9740 For functions not declared inline, recursive inlining
9741 happens only when @option{-finline-functions} (included in @option{-O3}) is
9742 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9743 default value is 450.
9745 @item max-inline-recursive-depth
9746 @itemx max-inline-recursive-depth-auto
9747 Specifies the maximum recursion depth used for recursive inlining.
9749 @option{--param max-inline-recursive-depth} applies to functions
9750 declared inline.  For functions not declared inline, recursive inlining
9751 happens only when @option{-finline-functions} (included in @option{-O3}) is
9752 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9753 default value is 8.
9755 @item min-inline-recursive-probability
9756 Recursive inlining is profitable only for function having deep recursion
9757 in average and can hurt for function having little recursion depth by
9758 increasing the prologue size or complexity of function body to other
9759 optimizers.
9761 When profile feedback is available (see @option{-fprofile-generate}) the actual
9762 recursion depth can be guessed from the probability that function recurses
9763 via a given call expression.  This parameter limits inlining only to call
9764 expressions whose probability exceeds the given threshold (in percents).
9765 The default value is 10.
9767 @item early-inlining-insns
9768 Specify growth that the early inliner can make.  In effect it increases
9769 the amount of inlining for code having a large abstraction penalty.
9770 The default value is 14.
9772 @item max-early-inliner-iterations
9773 Limit of iterations of the early inliner.  This basically bounds
9774 the number of nested indirect calls the early inliner can resolve.
9775 Deeper chains are still handled by late inlining.
9777 @item comdat-sharing-probability
9778 Probability (in percent) that C++ inline function with comdat visibility
9779 are shared across multiple compilation units.  The default value is 20.
9781 @item profile-func-internal-id
9782 A parameter to control whether to use function internal id in profile
9783 database lookup. If the value is 0, the compiler uses an id that
9784 is based on function assembler name and filename, which makes old profile
9785 data more tolerant to source changes such as function reordering etc.
9786 The default value is 0.
9788 @item min-vect-loop-bound
9789 The minimum number of iterations under which loops are not vectorized
9790 when @option{-ftree-vectorize} is used.  The number of iterations after
9791 vectorization needs to be greater than the value specified by this option
9792 to allow vectorization.  The default value is 0.
9794 @item gcse-cost-distance-ratio
9795 Scaling factor in calculation of maximum distance an expression
9796 can be moved by GCSE optimizations.  This is currently supported only in the
9797 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9798 is with simple expressions, i.e., the expressions that have cost
9799 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9800 hoisting of simple expressions.  The default value is 10.
9802 @item gcse-unrestricted-cost
9803 Cost, roughly measured as the cost of a single typical machine
9804 instruction, at which GCSE optimizations do not constrain
9805 the distance an expression can travel.  This is currently
9806 supported only in the code hoisting pass.  The lesser the cost,
9807 the more aggressive code hoisting is.  Specifying 0 
9808 allows all expressions to travel unrestricted distances.
9809 The default value is 3.
9811 @item max-hoist-depth
9812 The depth of search in the dominator tree for expressions to hoist.
9813 This is used to avoid quadratic behavior in hoisting algorithm.
9814 The value of 0 does not limit on the search, but may slow down compilation
9815 of huge functions.  The default value is 30.
9817 @item max-tail-merge-comparisons
9818 The maximum amount of similar bbs to compare a bb with.  This is used to
9819 avoid quadratic behavior in tree tail merging.  The default value is 10.
9821 @item max-tail-merge-iterations
9822 The maximum amount of iterations of the pass over the function.  This is used to
9823 limit compilation time in tree tail merging.  The default value is 2.
9825 @item store-merging-allow-unaligned
9826 Allow the store merging pass to introduce unaligned stores if it is legal to
9827 do so.  The default value is 1.
9829 @item max-stores-to-merge
9830 The maximum number of stores to attempt to merge into wider stores in the store
9831 merging pass.  The minimum value is 2 and the default is 64.
9833 @item max-unrolled-insns
9834 The maximum number of instructions that a loop may have to be unrolled.
9835 If a loop is unrolled, this parameter also determines how many times
9836 the loop code is unrolled.
9838 @item max-average-unrolled-insns
9839 The maximum number of instructions biased by probabilities of their execution
9840 that a loop may have to be unrolled.  If a loop is unrolled,
9841 this parameter also determines how many times the loop code is unrolled.
9843 @item max-unroll-times
9844 The maximum number of unrollings of a single loop.
9846 @item max-peeled-insns
9847 The maximum number of instructions that a loop may have to be peeled.
9848 If a loop is peeled, this parameter also determines how many times
9849 the loop code is peeled.
9851 @item max-peel-times
9852 The maximum number of peelings of a single loop.
9854 @item max-peel-branches
9855 The maximum number of branches on the hot path through the peeled sequence.
9857 @item max-completely-peeled-insns
9858 The maximum number of insns of a completely peeled loop.
9860 @item max-completely-peel-times
9861 The maximum number of iterations of a loop to be suitable for complete peeling.
9863 @item max-completely-peel-loop-nest-depth
9864 The maximum depth of a loop nest suitable for complete peeling.
9866 @item max-unswitch-insns
9867 The maximum number of insns of an unswitched loop.
9869 @item max-unswitch-level
9870 The maximum number of branches unswitched in a single loop.
9872 @item max-loop-headers-insns
9873 The maximum number of insns in loop header duplicated by he copy loop headers
9874 pass.
9876 @item lim-expensive
9877 The minimum cost of an expensive expression in the loop invariant motion.
9879 @item iv-consider-all-candidates-bound
9880 Bound on number of candidates for induction variables, below which
9881 all candidates are considered for each use in induction variable
9882 optimizations.  If there are more candidates than this,
9883 only the most relevant ones are considered to avoid quadratic time complexity.
9885 @item iv-max-considered-uses
9886 The induction variable optimizations give up on loops that contain more
9887 induction variable uses.
9889 @item iv-always-prune-cand-set-bound
9890 If the number of candidates in the set is smaller than this value,
9891 always try to remove unnecessary ivs from the set
9892 when adding a new one.
9894 @item avg-loop-niter
9895 Average number of iterations of a loop.
9897 @item dse-max-object-size
9898 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
9899 Larger values may result in larger compilation times.
9901 @item scev-max-expr-size
9902 Bound on size of expressions used in the scalar evolutions analyzer.
9903 Large expressions slow the analyzer.
9905 @item scev-max-expr-complexity
9906 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9907 Complex expressions slow the analyzer.
9909 @item max-tree-if-conversion-phi-args
9910 Maximum number of arguments in a PHI supported by TREE if conversion
9911 unless the loop is marked with simd pragma.
9913 @item vect-max-version-for-alignment-checks
9914 The maximum number of run-time checks that can be performed when
9915 doing loop versioning for alignment in the vectorizer.
9917 @item vect-max-version-for-alias-checks
9918 The maximum number of run-time checks that can be performed when
9919 doing loop versioning for alias in the vectorizer.
9921 @item vect-max-peeling-for-alignment
9922 The maximum number of loop peels to enhance access alignment
9923 for vectorizer. Value -1 means no limit.
9925 @item max-iterations-to-track
9926 The maximum number of iterations of a loop the brute-force algorithm
9927 for analysis of the number of iterations of the loop tries to evaluate.
9929 @item hot-bb-count-ws-permille
9930 A basic block profile count is considered hot if it contributes to 
9931 the given permillage (i.e. 0...1000) of the entire profiled execution.
9933 @item hot-bb-frequency-fraction
9934 Select fraction of the entry block frequency of executions of basic block in
9935 function given basic block needs to have to be considered hot.
9937 @item max-predicted-iterations
9938 The maximum number of loop iterations we predict statically.  This is useful
9939 in cases where a function contains a single loop with known bound and
9940 another loop with unknown bound.
9941 The known number of iterations is predicted correctly, while
9942 the unknown number of iterations average to roughly 10.  This means that the
9943 loop without bounds appears artificially cold relative to the other one.
9945 @item builtin-expect-probability
9946 Control the probability of the expression having the specified value. This
9947 parameter takes a percentage (i.e. 0 ... 100) as input.
9948 The default probability of 90 is obtained empirically.
9950 @item align-threshold
9952 Select fraction of the maximal frequency of executions of a basic block in
9953 a function to align the basic block.
9955 @item align-loop-iterations
9957 A loop expected to iterate at least the selected number of iterations is
9958 aligned.
9960 @item tracer-dynamic-coverage
9961 @itemx tracer-dynamic-coverage-feedback
9963 This value is used to limit superblock formation once the given percentage of
9964 executed instructions is covered.  This limits unnecessary code size
9965 expansion.
9967 The @option{tracer-dynamic-coverage-feedback} parameter
9968 is used only when profile
9969 feedback is available.  The real profiles (as opposed to statically estimated
9970 ones) are much less balanced allowing the threshold to be larger value.
9972 @item tracer-max-code-growth
9973 Stop tail duplication once code growth has reached given percentage.  This is
9974 a rather artificial limit, as most of the duplicates are eliminated later in
9975 cross jumping, so it may be set to much higher values than is the desired code
9976 growth.
9978 @item tracer-min-branch-ratio
9980 Stop reverse growth when the reverse probability of best edge is less than this
9981 threshold (in percent).
9983 @item tracer-min-branch-probability
9984 @itemx tracer-min-branch-probability-feedback
9986 Stop forward growth if the best edge has probability lower than this
9987 threshold.
9989 Similarly to @option{tracer-dynamic-coverage} two parameters are
9990 provided.  @option{tracer-min-branch-probability-feedback} is used for
9991 compilation with profile feedback and @option{tracer-min-branch-probability}
9992 compilation without.  The value for compilation with profile feedback
9993 needs to be more conservative (higher) in order to make tracer
9994 effective.
9996 @item max-cse-path-length
9998 The maximum number of basic blocks on path that CSE considers.
9999 The default is 10.
10001 @item max-cse-insns
10002 The maximum number of instructions CSE processes before flushing.
10003 The default is 1000.
10005 @item ggc-min-expand
10007 GCC uses a garbage collector to manage its own memory allocation.  This
10008 parameter specifies the minimum percentage by which the garbage
10009 collector's heap should be allowed to expand between collections.
10010 Tuning this may improve compilation speed; it has no effect on code
10011 generation.
10013 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10014 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10015 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10016 GCC is not able to calculate RAM on a particular platform, the lower
10017 bound of 30% is used.  Setting this parameter and
10018 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10019 every opportunity.  This is extremely slow, but can be useful for
10020 debugging.
10022 @item ggc-min-heapsize
10024 Minimum size of the garbage collector's heap before it begins bothering
10025 to collect garbage.  The first collection occurs after the heap expands
10026 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10027 tuning this may improve compilation speed, and has no effect on code
10028 generation.
10030 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10031 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10032 with a lower bound of 4096 (four megabytes) and an upper bound of
10033 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10034 particular platform, the lower bound is used.  Setting this parameter
10035 very large effectively disables garbage collection.  Setting this
10036 parameter and @option{ggc-min-expand} to zero causes a full collection
10037 to occur at every opportunity.
10039 @item max-reload-search-insns
10040 The maximum number of instruction reload should look backward for equivalent
10041 register.  Increasing values mean more aggressive optimization, making the
10042 compilation time increase with probably slightly better performance.
10043 The default value is 100.
10045 @item max-cselib-memory-locations
10046 The maximum number of memory locations cselib should take into account.
10047 Increasing values mean more aggressive optimization, making the compilation time
10048 increase with probably slightly better performance.  The default value is 500.
10050 @item max-sched-ready-insns
10051 The maximum number of instructions ready to be issued the scheduler should
10052 consider at any given time during the first scheduling pass.  Increasing
10053 values mean more thorough searches, making the compilation time increase
10054 with probably little benefit.  The default value is 100.
10056 @item max-sched-region-blocks
10057 The maximum number of blocks in a region to be considered for
10058 interblock scheduling.  The default value is 10.
10060 @item max-pipeline-region-blocks
10061 The maximum number of blocks in a region to be considered for
10062 pipelining in the selective scheduler.  The default value is 15.
10064 @item max-sched-region-insns
10065 The maximum number of insns in a region to be considered for
10066 interblock scheduling.  The default value is 100.
10068 @item max-pipeline-region-insns
10069 The maximum number of insns in a region to be considered for
10070 pipelining in the selective scheduler.  The default value is 200.
10072 @item min-spec-prob
10073 The minimum probability (in percents) of reaching a source block
10074 for interblock speculative scheduling.  The default value is 40.
10076 @item max-sched-extend-regions-iters
10077 The maximum number of iterations through CFG to extend regions.
10078 A value of 0 (the default) disables region extensions.
10080 @item max-sched-insn-conflict-delay
10081 The maximum conflict delay for an insn to be considered for speculative motion.
10082 The default value is 3.
10084 @item sched-spec-prob-cutoff
10085 The minimal probability of speculation success (in percents), so that
10086 speculative insns are scheduled.
10087 The default value is 40.
10089 @item sched-state-edge-prob-cutoff
10090 The minimum probability an edge must have for the scheduler to save its
10091 state across it.
10092 The default value is 10.
10094 @item sched-mem-true-dep-cost
10095 Minimal distance (in CPU cycles) between store and load targeting same
10096 memory locations.  The default value is 1.
10098 @item selsched-max-lookahead
10099 The maximum size of the lookahead window of selective scheduling.  It is a
10100 depth of search for available instructions.
10101 The default value is 50.
10103 @item selsched-max-sched-times
10104 The maximum number of times that an instruction is scheduled during
10105 selective scheduling.  This is the limit on the number of iterations
10106 through which the instruction may be pipelined.  The default value is 2.
10108 @item selsched-insns-to-rename
10109 The maximum number of best instructions in the ready list that are considered
10110 for renaming in the selective scheduler.  The default value is 2.
10112 @item sms-min-sc
10113 The minimum value of stage count that swing modulo scheduler
10114 generates.  The default value is 2.
10116 @item max-last-value-rtl
10117 The maximum size measured as number of RTLs that can be recorded in an expression
10118 in combiner for a pseudo register as last known value of that register.  The default
10119 is 10000.
10121 @item max-combine-insns
10122 The maximum number of instructions the RTL combiner tries to combine.
10123 The default value is 2 at @option{-Og} and 4 otherwise.
10125 @item integer-share-limit
10126 Small integer constants can use a shared data structure, reducing the
10127 compiler's memory usage and increasing its speed.  This sets the maximum
10128 value of a shared integer constant.  The default value is 256.
10130 @item ssp-buffer-size
10131 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10132 protection when @option{-fstack-protection} is used.
10134 @item min-size-for-stack-sharing
10135 The minimum size of variables taking part in stack slot sharing when not
10136 optimizing. The default value is 32.
10138 @item max-jump-thread-duplication-stmts
10139 Maximum number of statements allowed in a block that needs to be
10140 duplicated when threading jumps.
10142 @item max-fields-for-field-sensitive
10143 Maximum number of fields in a structure treated in
10144 a field sensitive manner during pointer analysis.  The default is zero
10145 for @option{-O0} and @option{-O1},
10146 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10148 @item prefetch-latency
10149 Estimate on average number of instructions that are executed before
10150 prefetch finishes.  The distance prefetched ahead is proportional
10151 to this constant.  Increasing this number may also lead to less
10152 streams being prefetched (see @option{simultaneous-prefetches}).
10154 @item simultaneous-prefetches
10155 Maximum number of prefetches that can run at the same time.
10157 @item l1-cache-line-size
10158 The size of cache line in L1 cache, in bytes.
10160 @item l1-cache-size
10161 The size of L1 cache, in kilobytes.
10163 @item l2-cache-size
10164 The size of L2 cache, in kilobytes.
10166 @item min-insn-to-prefetch-ratio
10167 The minimum ratio between the number of instructions and the
10168 number of prefetches to enable prefetching in a loop.
10170 @item prefetch-min-insn-to-mem-ratio
10171 The minimum ratio between the number of instructions and the
10172 number of memory references to enable prefetching in a loop.
10174 @item use-canonical-types
10175 Whether the compiler should use the ``canonical'' type system.  By
10176 default, this should always be 1, which uses a more efficient internal
10177 mechanism for comparing types in C++ and Objective-C++.  However, if
10178 bugs in the canonical type system are causing compilation failures,
10179 set this value to 0 to disable canonical types.
10181 @item switch-conversion-max-branch-ratio
10182 Switch initialization conversion refuses to create arrays that are
10183 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10184 branches in the switch.
10186 @item max-partial-antic-length
10187 Maximum length of the partial antic set computed during the tree
10188 partial redundancy elimination optimization (@option{-ftree-pre}) when
10189 optimizing at @option{-O3} and above.  For some sorts of source code
10190 the enhanced partial redundancy elimination optimization can run away,
10191 consuming all of the memory available on the host machine.  This
10192 parameter sets a limit on the length of the sets that are computed,
10193 which prevents the runaway behavior.  Setting a value of 0 for
10194 this parameter allows an unlimited set length.
10196 @item sccvn-max-scc-size
10197 Maximum size of a strongly connected component (SCC) during SCCVN
10198 processing.  If this limit is hit, SCCVN processing for the whole
10199 function is not done and optimizations depending on it are
10200 disabled.  The default maximum SCC size is 10000.
10202 @item sccvn-max-alias-queries-per-access
10203 Maximum number of alias-oracle queries we perform when looking for
10204 redundancies for loads and stores.  If this limit is hit the search
10205 is aborted and the load or store is not considered redundant.  The
10206 number of queries is algorithmically limited to the number of
10207 stores on all paths from the load to the function entry.
10208 The default maximum number of queries is 1000.
10210 @item ira-max-loops-num
10211 IRA uses regional register allocation by default.  If a function
10212 contains more loops than the number given by this parameter, only at most
10213 the given number of the most frequently-executed loops form regions
10214 for regional register allocation.  The default value of the
10215 parameter is 100.
10217 @item ira-max-conflict-table-size 
10218 Although IRA uses a sophisticated algorithm to compress the conflict
10219 table, the table can still require excessive amounts of memory for
10220 huge functions.  If the conflict table for a function could be more
10221 than the size in MB given by this parameter, the register allocator
10222 instead uses a faster, simpler, and lower-quality
10223 algorithm that does not require building a pseudo-register conflict table.  
10224 The default value of the parameter is 2000.
10226 @item ira-loop-reserved-regs
10227 IRA can be used to evaluate more accurate register pressure in loops
10228 for decisions to move loop invariants (see @option{-O3}).  The number
10229 of available registers reserved for some other purposes is given
10230 by this parameter.  The default value of the parameter is 2, which is
10231 the minimal number of registers needed by typical instructions.
10232 This value is the best found from numerous experiments.
10234 @item lra-inheritance-ebb-probability-cutoff
10235 LRA tries to reuse values reloaded in registers in subsequent insns.
10236 This optimization is called inheritance.  EBB is used as a region to
10237 do this optimization.  The parameter defines a minimal fall-through
10238 edge probability in percentage used to add BB to inheritance EBB in
10239 LRA.  The default value of the parameter is 40.  The value was chosen
10240 from numerous runs of SPEC2000 on x86-64.
10242 @item loop-invariant-max-bbs-in-loop
10243 Loop invariant motion can be very expensive, both in compilation time and
10244 in amount of needed compile-time memory, with very large loops.  Loops
10245 with more basic blocks than this parameter won't have loop invariant
10246 motion optimization performed on them.  The default value of the
10247 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10249 @item loop-max-datarefs-for-datadeps
10250 Building data dependencies is expensive for very large loops.  This
10251 parameter limits the number of data references in loops that are
10252 considered for data dependence analysis.  These large loops are no
10253 handled by the optimizations using loop data dependencies.
10254 The default value is 1000.
10256 @item max-vartrack-size
10257 Sets a maximum number of hash table slots to use during variable
10258 tracking dataflow analysis of any function.  If this limit is exceeded
10259 with variable tracking at assignments enabled, analysis for that
10260 function is retried without it, after removing all debug insns from
10261 the function.  If the limit is exceeded even without debug insns, var
10262 tracking analysis is completely disabled for the function.  Setting
10263 the parameter to zero makes it unlimited.
10265 @item max-vartrack-expr-depth
10266 Sets a maximum number of recursion levels when attempting to map
10267 variable names or debug temporaries to value expressions.  This trades
10268 compilation time for more complete debug information.  If this is set too
10269 low, value expressions that are available and could be represented in
10270 debug information may end up not being used; setting this higher may
10271 enable the compiler to find more complex debug expressions, but compile
10272 time and memory use may grow.  The default is 12.
10274 @item min-nondebug-insn-uid
10275 Use uids starting at this parameter for nondebug insns.  The range below
10276 the parameter is reserved exclusively for debug insns created by
10277 @option{-fvar-tracking-assignments}, but debug insns may get
10278 (non-overlapping) uids above it if the reserved range is exhausted.
10280 @item ipa-sra-ptr-growth-factor
10281 IPA-SRA replaces a pointer to an aggregate with one or more new
10282 parameters only when their cumulative size is less or equal to
10283 @option{ipa-sra-ptr-growth-factor} times the size of the original
10284 pointer parameter.
10286 @item sra-max-scalarization-size-Ospeed
10287 @item sra-max-scalarization-size-Osize
10288 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10289 replace scalar parts of aggregates with uses of independent scalar
10290 variables.  These parameters control the maximum size, in storage units,
10291 of aggregate which is considered for replacement when compiling for
10292 speed
10293 (@option{sra-max-scalarization-size-Ospeed}) or size
10294 (@option{sra-max-scalarization-size-Osize}) respectively.
10296 @item tm-max-aggregate-size
10297 When making copies of thread-local variables in a transaction, this
10298 parameter specifies the size in bytes after which variables are
10299 saved with the logging functions as opposed to save/restore code
10300 sequence pairs.  This option only applies when using
10301 @option{-fgnu-tm}.
10303 @item graphite-max-nb-scop-params
10304 To avoid exponential effects in the Graphite loop transforms, the
10305 number of parameters in a Static Control Part (SCoP) is bounded.  The
10306 default value is 10 parameters.  A variable whose value is unknown at
10307 compilation time and defined outside a SCoP is a parameter of the SCoP.
10309 @item graphite-max-bbs-per-function
10310 To avoid exponential effects in the detection of SCoPs, the size of
10311 the functions analyzed by Graphite is bounded.  The default value is
10312 100 basic blocks.
10314 @item loop-block-tile-size
10315 Loop blocking or strip mining transforms, enabled with
10316 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10317 loop in the loop nest by a given number of iterations.  The strip
10318 length can be changed using the @option{loop-block-tile-size}
10319 parameter.  The default value is 51 iterations.
10321 @item loop-unroll-jam-size
10322 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10323 default value is 4.
10325 @item loop-unroll-jam-depth
10326 Specify the dimension to be unrolled (counting from the most inner loop)
10327 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10329 @item ipa-cp-value-list-size
10330 IPA-CP attempts to track all possible values and types passed to a function's
10331 parameter in order to propagate them and perform devirtualization.
10332 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10333 stores per one formal parameter of a function.
10335 @item ipa-cp-eval-threshold
10336 IPA-CP calculates its own score of cloning profitability heuristics
10337 and performs those cloning opportunities with scores that exceed
10338 @option{ipa-cp-eval-threshold}.
10340 @item ipa-cp-recursion-penalty
10341 Percentage penalty the recursive functions will receive when they
10342 are evaluated for cloning.
10344 @item ipa-cp-single-call-penalty
10345 Percentage penalty functions containing a single call to another
10346 function will receive when they are evaluated for cloning.
10349 @item ipa-max-agg-items
10350 IPA-CP is also capable to propagate a number of scalar values passed
10351 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10352 number of such values per one parameter.
10354 @item ipa-cp-loop-hint-bonus
10355 When IPA-CP determines that a cloning candidate would make the number
10356 of iterations of a loop known, it adds a bonus of
10357 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10358 the candidate.
10360 @item ipa-cp-array-index-hint-bonus
10361 When IPA-CP determines that a cloning candidate would make the index of
10362 an array access known, it adds a bonus of
10363 @option{ipa-cp-array-index-hint-bonus} to the profitability
10364 score of the candidate.
10366 @item ipa-max-aa-steps
10367 During its analysis of function bodies, IPA-CP employs alias analysis
10368 in order to track values pointed to by function parameters.  In order
10369 not spend too much time analyzing huge functions, it gives up and
10370 consider all memory clobbered after examining
10371 @option{ipa-max-aa-steps} statements modifying memory.
10373 @item lto-partitions
10374 Specify desired number of partitions produced during WHOPR compilation.
10375 The number of partitions should exceed the number of CPUs used for compilation.
10376 The default value is 32.
10378 @item lto-min-partition
10379 Size of minimal partition for WHOPR (in estimated instructions).
10380 This prevents expenses of splitting very small programs into too many
10381 partitions.
10383 @item lto-max-partition
10384 Size of max partition for WHOPR (in estimated instructions).
10385 to provide an upper bound for individual size of partition.
10386 Meant to be used only with balanced partitioning.
10388 @item cxx-max-namespaces-for-diagnostic-help
10389 The maximum number of namespaces to consult for suggestions when C++
10390 name lookup fails for an identifier.  The default is 1000.
10392 @item sink-frequency-threshold
10393 The maximum relative execution frequency (in percents) of the target block
10394 relative to a statement's original block to allow statement sinking of a
10395 statement.  Larger numbers result in more aggressive statement sinking.
10396 The default value is 75.  A small positive adjustment is applied for
10397 statements with memory operands as those are even more profitable so sink.
10399 @item max-stores-to-sink
10400 The maximum number of conditional store pairs that can be sunk.  Set to 0
10401 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10402 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10404 @item allow-store-data-races
10405 Allow optimizers to introduce new data races on stores.
10406 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10407 at optimization level @option{-Ofast}.
10409 @item case-values-threshold
10410 The smallest number of different values for which it is best to use a
10411 jump-table instead of a tree of conditional branches.  If the value is
10412 0, use the default for the machine.  The default is 0.
10414 @item tree-reassoc-width
10415 Set the maximum number of instructions executed in parallel in
10416 reassociated tree. This parameter overrides target dependent
10417 heuristics used by default if has non zero value.
10419 @item sched-pressure-algorithm
10420 Choose between the two available implementations of
10421 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10422 and is the more likely to prevent instructions from being reordered.
10423 Algorithm 2 was designed to be a compromise between the relatively
10424 conservative approach taken by algorithm 1 and the rather aggressive
10425 approach taken by the default scheduler.  It relies more heavily on
10426 having a regular register file and accurate register pressure classes.
10427 See @file{haifa-sched.c} in the GCC sources for more details.
10429 The default choice depends on the target.
10431 @item max-slsr-cand-scan
10432 Set the maximum number of existing candidates that are considered when
10433 seeking a basis for a new straight-line strength reduction candidate.
10435 @item asan-globals
10436 Enable buffer overflow detection for global objects.  This kind
10437 of protection is enabled by default if you are using
10438 @option{-fsanitize=address} option.
10439 To disable global objects protection use @option{--param asan-globals=0}.
10441 @item asan-stack
10442 Enable buffer overflow detection for stack objects.  This kind of
10443 protection is enabled by default when using @option{-fsanitize=address}.
10444 To disable stack protection use @option{--param asan-stack=0} option.
10446 @item asan-instrument-reads
10447 Enable buffer overflow detection for memory reads.  This kind of
10448 protection is enabled by default when using @option{-fsanitize=address}.
10449 To disable memory reads protection use
10450 @option{--param asan-instrument-reads=0}.
10452 @item asan-instrument-writes
10453 Enable buffer overflow detection for memory writes.  This kind of
10454 protection is enabled by default when using @option{-fsanitize=address}.
10455 To disable memory writes protection use
10456 @option{--param asan-instrument-writes=0} option.
10458 @item asan-memintrin
10459 Enable detection for built-in functions.  This kind of protection
10460 is enabled by default when using @option{-fsanitize=address}.
10461 To disable built-in functions protection use
10462 @option{--param asan-memintrin=0}.
10464 @item asan-use-after-return
10465 Enable detection of use-after-return.  This kind of protection
10466 is enabled by default when using @option{-fsanitize=address} option.
10467 To disable use-after-return detection use 
10468 @option{--param asan-use-after-return=0}.
10470 Note: The check is disabled by default at runtime.  To enable the check,
10471 you should set environment variable @env{ASAN_OPTIONS} to
10472 @code{detect_stack_use_after_return=1}.
10474 @item asan-instrumentation-with-call-threshold
10475 If number of memory accesses in function being instrumented
10476 is greater or equal to this number, use callbacks instead of inline checks.
10477 E.g. to disable inline code use
10478 @option{--param asan-instrumentation-with-call-threshold=0}.
10480 @item use-after-scope-direct-emission-threshold
10481 If size of a local variable in bytes is smaller or equal to this number,
10482 direct instruction emission is utilized to poison and unpoison local variables.
10483 Default value in 256.
10485 @item chkp-max-ctor-size
10486 Static constructors generated by Pointer Bounds Checker may become very
10487 large and significantly increase compile time at optimization level
10488 @option{-O1} and higher.  This parameter is a maximum number of statements
10489 in a single generated constructor.  Default value is 5000.
10491 @item max-fsm-thread-path-insns
10492 Maximum number of instructions to copy when duplicating blocks on a
10493 finite state automaton jump thread path.  The default is 100.
10495 @item max-fsm-thread-length
10496 Maximum number of basic blocks on a finite state automaton jump thread
10497 path.  The default is 10.
10499 @item max-fsm-thread-paths
10500 Maximum number of new jump thread paths to create for a finite state
10501 automaton.  The default is 50.
10503 @item parloops-chunk-size
10504 Chunk size of omp schedule for loops parallelized by parloops.  The default
10505 is 0.
10507 @item parloops-schedule
10508 Schedule type of omp schedule for loops parallelized by parloops (static,
10509 dynamic, guided, auto, runtime).  The default is static.
10511 @item max-ssa-name-query-depth
10512 Maximum depth of recursion when querying properties of SSA names in things
10513 like fold routines.  One level of recursion corresponds to following a
10514 use-def chain.
10516 @item hsa-gen-debug-stores
10517 Enable emission of special debug stores within HSA kernels which are
10518 then read and reported by libgomp plugin.  Generation of these stores
10519 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10520 enable it.
10522 @item max-speculative-devirt-maydefs
10523 The maximum number of may-defs we analyze when looking for a must-def
10524 specifying the dynamic type of an object that invokes a virtual call
10525 we may be able to devirtualize speculatively.
10527 @item max-vrp-switch-assertions
10528 The maximum number of assertions to add along the default edge of a switch
10529 statement during VRP.  The default is 10.
10530 @end table
10531 @end table
10533 @node Instrumentation Options
10534 @section Program Instrumentation Options
10535 @cindex instrumentation options
10536 @cindex program instrumentation options
10537 @cindex run-time error checking options
10538 @cindex profiling options
10539 @cindex options, program instrumentation
10540 @cindex options, run-time error checking
10541 @cindex options, profiling
10543 GCC supports a number of command-line options that control adding
10544 run-time instrumentation to the code it normally generates.  
10545 For example, one purpose of instrumentation is collect profiling
10546 statistics for use in finding program hot spots, code coverage
10547 analysis, or profile-guided optimizations.
10548 Another class of program instrumentation is adding run-time checking 
10549 to detect programming errors like invalid pointer
10550 dereferences or out-of-bounds array accesses, as well as deliberately
10551 hostile attacks such as stack smashing or C++ vtable hijacking.
10552 There is also a general hook which can be used to implement other
10553 forms of tracing or function-level instrumentation for debug or
10554 program analysis purposes.
10556 @table @gcctabopt
10557 @cindex @command{prof}
10558 @item -p
10559 @opindex p
10560 Generate extra code to write profile information suitable for the
10561 analysis program @command{prof}.  You must use this option when compiling
10562 the source files you want data about, and you must also use it when
10563 linking.
10565 @cindex @command{gprof}
10566 @item -pg
10567 @opindex pg
10568 Generate extra code to write profile information suitable for the
10569 analysis program @command{gprof}.  You must use this option when compiling
10570 the source files you want data about, and you must also use it when
10571 linking.
10573 @item -fprofile-arcs
10574 @opindex fprofile-arcs
10575 Add code so that program flow @dfn{arcs} are instrumented.  During
10576 execution the program records how many times each branch and call is
10577 executed and how many times it is taken or returns.  On targets that support
10578 constructors with priority support, profiling properly handles constructors,
10579 destructors and C++ constructors (and destructors) of classes which are used
10580 as a type of a global variable.
10582 When the compiled
10583 program exits it saves this data to a file called
10584 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10585 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10586 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10587 @var{auxname} is generated from the name of the output file, if
10588 explicitly specified and it is not the final executable, otherwise it is
10589 the basename of the source file.  In both cases any suffix is removed
10590 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10591 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10592 @xref{Cross-profiling}.
10594 @cindex @command{gcov}
10595 @item --coverage
10596 @opindex coverage
10598 This option is used to compile and link code instrumented for coverage
10599 analysis.  The option is a synonym for @option{-fprofile-arcs}
10600 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10601 linking).  See the documentation for those options for more details.
10603 @itemize
10605 @item
10606 Compile the source files with @option{-fprofile-arcs} plus optimization
10607 and code generation options.  For test coverage analysis, use the
10608 additional @option{-ftest-coverage} option.  You do not need to profile
10609 every source file in a program.
10611 @item
10612 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10613 (the latter implies the former).
10615 @item
10616 Run the program on a representative workload to generate the arc profile
10617 information.  This may be repeated any number of times.  You can run
10618 concurrent instances of your program, and provided that the file system
10619 supports locking, the data files will be correctly updated.  Also
10620 @code{fork} calls are detected and correctly handled (double counting
10621 will not happen).
10623 @item
10624 For profile-directed optimizations, compile the source files again with
10625 the same optimization and code generation options plus
10626 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10627 Control Optimization}).
10629 @item
10630 For test coverage analysis, use @command{gcov} to produce human readable
10631 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10632 @command{gcov} documentation for further information.
10634 @end itemize
10636 With @option{-fprofile-arcs}, for each function of your program GCC
10637 creates a program flow graph, then finds a spanning tree for the graph.
10638 Only arcs that are not on the spanning tree have to be instrumented: the
10639 compiler adds code to count the number of times that these arcs are
10640 executed.  When an arc is the only exit or only entrance to a block, the
10641 instrumentation code can be added to the block; otherwise, a new basic
10642 block must be created to hold the instrumentation code.
10644 @need 2000
10645 @item -ftest-coverage
10646 @opindex ftest-coverage
10647 Produce a notes file that the @command{gcov} code-coverage utility
10648 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10649 show program coverage.  Each source file's note file is called
10650 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10651 above for a description of @var{auxname} and instructions on how to
10652 generate test coverage data.  Coverage data matches the source files
10653 more closely if you do not optimize.
10655 @item -fprofile-dir=@var{path}
10656 @opindex fprofile-dir
10658 Set the directory to search for the profile data files in to @var{path}.
10659 This option affects only the profile data generated by
10660 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10661 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10662 and its related options.  Both absolute and relative paths can be used.
10663 By default, GCC uses the current directory as @var{path}, thus the
10664 profile data file appears in the same directory as the object file.
10666 @item -fprofile-generate
10667 @itemx -fprofile-generate=@var{path}
10668 @opindex fprofile-generate
10670 Enable options usually used for instrumenting application to produce
10671 profile useful for later recompilation with profile feedback based
10672 optimization.  You must use @option{-fprofile-generate} both when
10673 compiling and when linking your program.
10675 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10677 If @var{path} is specified, GCC looks at the @var{path} to find
10678 the profile feedback data files. See @option{-fprofile-dir}.
10680 To optimize the program based on the collected profile information, use
10681 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10683 @item -fprofile-update=@var{method}
10684 @opindex fprofile-update
10686 Alter the update method for an application instrumented for profile
10687 feedback based optimization.  The @var{method} argument should be one of
10688 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10689 The first one is useful for single-threaded applications,
10690 while the second one prevents profile corruption by emitting thread-safe code.
10692 @strong{Warning:} When an application does not properly join all threads
10693 (or creates an detached thread), a profile file can be still corrupted.
10695 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10696 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10697 automatically selects @samp{prefer-atomic} when @option{-pthread}
10698 is present in the command line.
10700 @item -fsanitize=address
10701 @opindex fsanitize=address
10702 Enable AddressSanitizer, a fast memory error detector.
10703 Memory access instructions are instrumented to detect
10704 out-of-bounds and use-after-free bugs.
10705 The option enables @option{-fsanitize-address-use-after-scope}.
10706 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10707 more details.  The run-time behavior can be influenced using the
10708 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10709 the available options are shown at startup of the instrumented program.  See
10710 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10711 for a list of supported options.
10712 The option can't be combined with @option{-fsanitize=thread}.
10714 @item -fsanitize=kernel-address
10715 @opindex fsanitize=kernel-address
10716 Enable AddressSanitizer for Linux kernel.
10717 See @uref{https://github.com/google/kasan/wiki} for more details.
10719 @item -fsanitize=thread
10720 @opindex fsanitize=thread
10721 Enable ThreadSanitizer, a fast data race detector.
10722 Memory access instructions are instrumented to detect
10723 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10724 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10725 environment variable; see
10726 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10727 supported options.
10728 The option can't be combined with @option{-fsanitize=address}
10729 and/or @option{-fsanitize=leak}.
10731 @item -fsanitize=leak
10732 @opindex fsanitize=leak
10733 Enable LeakSanitizer, a memory leak detector.
10734 This option only matters for linking of executables and
10735 the executable is linked against a library that overrides @code{malloc}
10736 and other allocator functions.  See
10737 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10738 details.  The run-time behavior can be influenced using the
10739 @env{LSAN_OPTIONS} environment variable.
10740 The option can't be combined with @option{-fsanitize=thread}.
10742 @item -fsanitize=undefined
10743 @opindex fsanitize=undefined
10744 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10745 Various computations are instrumented to detect undefined behavior
10746 at runtime.  Current suboptions are:
10748 @table @gcctabopt
10750 @item -fsanitize=shift
10751 @opindex fsanitize=shift
10752 This option enables checking that the result of a shift operation is
10753 not undefined.  Note that what exactly is considered undefined differs
10754 slightly between C and C++, as well as between ISO C90 and C99, etc.
10755 This option has two suboptions, @option{-fsanitize=shift-base} and
10756 @option{-fsanitize=shift-exponent}.
10758 @item -fsanitize=shift-exponent
10759 @opindex fsanitize=shift-exponent
10760 This option enables checking that the second argument of a shift operation
10761 is not negative and is smaller than the precision of the promoted first
10762 argument.
10764 @item -fsanitize=shift-base
10765 @opindex fsanitize=shift-base
10766 If the second argument of a shift operation is within range, check that the
10767 result of a shift operation is not undefined.  Note that what exactly is
10768 considered undefined differs slightly between C and C++, as well as between
10769 ISO C90 and C99, etc.
10771 @item -fsanitize=integer-divide-by-zero
10772 @opindex fsanitize=integer-divide-by-zero
10773 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10775 @item -fsanitize=unreachable
10776 @opindex fsanitize=unreachable
10777 With this option, the compiler turns the @code{__builtin_unreachable}
10778 call into a diagnostics message call instead.  When reaching the
10779 @code{__builtin_unreachable} call, the behavior is undefined.
10781 @item -fsanitize=vla-bound
10782 @opindex fsanitize=vla-bound
10783 This option instructs the compiler to check that the size of a variable
10784 length array is positive.
10786 @item -fsanitize=null
10787 @opindex fsanitize=null
10788 This option enables pointer checking.  Particularly, the application
10789 built with this option turned on will issue an error message when it
10790 tries to dereference a NULL pointer, or if a reference (possibly an
10791 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10792 on an object pointed by a NULL pointer.
10794 @item -fsanitize=return
10795 @opindex fsanitize=return
10796 This option enables return statement checking.  Programs
10797 built with this option turned on will issue an error message
10798 when the end of a non-void function is reached without actually
10799 returning a value.  This option works in C++ only.
10801 @item -fsanitize=signed-integer-overflow
10802 @opindex fsanitize=signed-integer-overflow
10803 This option enables signed integer overflow checking.  We check that
10804 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10805 does not overflow in the signed arithmetics.  Note, integer promotion
10806 rules must be taken into account.  That is, the following is not an
10807 overflow:
10808 @smallexample
10809 signed char a = SCHAR_MAX;
10810 a++;
10811 @end smallexample
10813 @item -fsanitize=bounds
10814 @opindex fsanitize=bounds
10815 This option enables instrumentation of array bounds.  Various out of bounds
10816 accesses are detected.  Flexible array members, flexible array member-like
10817 arrays, and initializers of variables with static storage are not instrumented.
10819 @item -fsanitize=bounds-strict
10820 @opindex fsanitize=bounds-strict
10821 This option enables strict instrumentation of array bounds.  Most out of bounds
10822 accesses are detected, including flexible array members and flexible array
10823 member-like arrays.  Initializers of variables with static storage are not
10824 instrumented.
10826 @item -fsanitize=alignment
10827 @opindex fsanitize=alignment
10829 This option enables checking of alignment of pointers when they are
10830 dereferenced, or when a reference is bound to insufficiently aligned target,
10831 or when a method or constructor is invoked on insufficiently aligned object.
10833 @item -fsanitize=object-size
10834 @opindex fsanitize=object-size
10835 This option enables instrumentation of memory references using the
10836 @code{__builtin_object_size} function.  Various out of bounds pointer
10837 accesses are detected.
10839 @item -fsanitize=float-divide-by-zero
10840 @opindex fsanitize=float-divide-by-zero
10841 Detect floating-point division by zero.  Unlike other similar options,
10842 @option{-fsanitize=float-divide-by-zero} is not enabled by
10843 @option{-fsanitize=undefined}, since floating-point division by zero can
10844 be a legitimate way of obtaining infinities and NaNs.
10846 @item -fsanitize=float-cast-overflow
10847 @opindex fsanitize=float-cast-overflow
10848 This option enables floating-point type to integer conversion checking.
10849 We check that the result of the conversion does not overflow.
10850 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10851 not enabled by @option{-fsanitize=undefined}.
10852 This option does not work well with @code{FE_INVALID} exceptions enabled.
10854 @item -fsanitize=nonnull-attribute
10855 @opindex fsanitize=nonnull-attribute
10857 This option enables instrumentation of calls, checking whether null values
10858 are not passed to arguments marked as requiring a non-null value by the
10859 @code{nonnull} function attribute.
10861 @item -fsanitize=returns-nonnull-attribute
10862 @opindex fsanitize=returns-nonnull-attribute
10864 This option enables instrumentation of return statements in functions
10865 marked with @code{returns_nonnull} function attribute, to detect returning
10866 of null values from such functions.
10868 @item -fsanitize=bool
10869 @opindex fsanitize=bool
10871 This option enables instrumentation of loads from bool.  If a value other
10872 than 0/1 is loaded, a run-time error is issued.
10874 @item -fsanitize=enum
10875 @opindex fsanitize=enum
10877 This option enables instrumentation of loads from an enum type.  If
10878 a value outside the range of values for the enum type is loaded,
10879 a run-time error is issued.
10881 @item -fsanitize=vptr
10882 @opindex fsanitize=vptr
10884 This option enables instrumentation of C++ member function calls, member
10885 accesses and some conversions between pointers to base and derived classes,
10886 to verify the referenced object has the correct dynamic type.
10888 @end table
10890 While @option{-ftrapv} causes traps for signed overflows to be emitted,
10891 @option{-fsanitize=undefined} gives a diagnostic message.
10892 This currently works only for the C family of languages.
10894 @item -fno-sanitize=all
10895 @opindex fno-sanitize=all
10897 This option disables all previously enabled sanitizers.
10898 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
10899 together.
10901 @item -fasan-shadow-offset=@var{number}
10902 @opindex fasan-shadow-offset
10903 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
10904 It is useful for experimenting with different shadow memory layouts in
10905 Kernel AddressSanitizer.
10907 @item -fsanitize-sections=@var{s1},@var{s2},...
10908 @opindex fsanitize-sections
10909 Sanitize global variables in selected user-defined sections.  @var{si} may
10910 contain wildcards.
10912 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
10913 @opindex fsanitize-recover
10914 @opindex fno-sanitize-recover
10915 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
10916 mentioned in comma-separated list of @var{opts}.  Enabling this option
10917 for a sanitizer component causes it to attempt to continue
10918 running the program as if no error happened.  This means multiple
10919 runtime errors can be reported in a single program run, and the exit
10920 code of the program may indicate success even when errors
10921 have been reported.  The @option{-fno-sanitize-recover=} option
10922 can be used to alter
10923 this behavior: only the first detected error is reported
10924 and program then exits with a non-zero exit code.
10926 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
10927 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
10928 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
10929 @option{-fsanitize=bounds-strict},
10930 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
10931 For these sanitizers error recovery is turned on by default,
10932 except @option{-fsanitize=address}, for which this feature is experimental.
10933 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
10934 accepted, the former enables recovery for all sanitizers that support it,
10935 the latter disables recovery for all sanitizers that support it.
10937 Even if a recovery mode is turned on the compiler side, it needs to be also
10938 enabled on the runtime library side, otherwise the failures are still fatal.
10939 The runtime library defaults to @code{halt_on_error=0} for
10940 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
10941 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
10942 setting the @code{halt_on_error} flag in the corresponding environment variable.
10944 Syntax without an explicit @var{opts} parameter is deprecated.  It is
10945 equivalent to specifying an @var{opts} list of:
10947 @smallexample
10948 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
10949 @end smallexample
10951 @item -fsanitize-address-use-after-scope
10952 @opindex fsanitize-address-use-after-scope
10953 Enable sanitization of local variables to detect use-after-scope bugs.
10954 The option sets @option{-fstack-reuse} to @samp{none}.
10956 @item -fsanitize-undefined-trap-on-error
10957 @opindex fsanitize-undefined-trap-on-error
10958 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
10959 report undefined behavior using @code{__builtin_trap} rather than
10960 a @code{libubsan} library routine.  The advantage of this is that the
10961 @code{libubsan} library is not needed and is not linked in, so this
10962 is usable even in freestanding environments.
10964 @item -fsanitize-coverage=trace-pc
10965 @opindex fsanitize-coverage=trace-pc
10966 Enable coverage-guided fuzzing code instrumentation.
10967 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
10969 @item -fbounds-check
10970 @opindex fbounds-check
10971 For front ends that support it, generate additional code to check that
10972 indices used to access arrays are within the declared range.  This is
10973 currently only supported by the Fortran front end, where this option
10974 defaults to false.
10976 @item -fcheck-pointer-bounds
10977 @opindex fcheck-pointer-bounds
10978 @opindex fno-check-pointer-bounds
10979 @cindex Pointer Bounds Checker options
10980 Enable Pointer Bounds Checker instrumentation.  Each memory reference
10981 is instrumented with checks of the pointer used for memory access against
10982 bounds associated with that pointer.  
10984 Currently there
10985 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
10986 and @option{-mmpx} are required to enable this feature.  
10987 MPX-based instrumentation requires
10988 a runtime library to enable MPX in hardware and handle bounds
10989 violation signals.  By default when @option{-fcheck-pointer-bounds}
10990 and @option{-mmpx} options are used to link a program, the GCC driver
10991 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
10992 Bounds checking on calls to dynamic libraries requires a linker
10993 with @option{-z bndplt} support; if GCC was configured with a linker
10994 without support for this option (including the Gold linker and older
10995 versions of ld), a warning is given if you link with @option{-mmpx}
10996 without also specifying @option{-static}, since the overall effectiveness
10997 of the bounds checking protection is reduced.
10998 See also @option{-static-libmpxwrappers}.
11000 MPX-based instrumentation
11001 may be used for debugging and also may be included in production code
11002 to increase program security.  Depending on usage, you may
11003 have different requirements for the runtime library.  The current version
11004 of the MPX runtime library is more oriented for use as a debugging
11005 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11006 also @option{-static-libmpx}.  The runtime library  behavior can be
11007 influenced using various @env{CHKP_RT_*} environment variables.  See
11008 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11009 for more details.
11011 Generated instrumentation may be controlled by various
11012 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11013 structure field attribute (@pxref{Type Attributes}) and
11014 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11015 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11016 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11017 Bounds Checker builtins}, for more information.
11019 @item -fchkp-check-incomplete-type
11020 @opindex fchkp-check-incomplete-type
11021 @opindex fno-chkp-check-incomplete-type
11022 Generate pointer bounds checks for variables with incomplete type.
11023 Enabled by default.
11025 @item -fchkp-narrow-bounds
11026 @opindex fchkp-narrow-bounds
11027 @opindex fno-chkp-narrow-bounds
11028 Controls bounds used by Pointer Bounds Checker for pointers to object
11029 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11030 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11031 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11033 @item -fchkp-first-field-has-own-bounds
11034 @opindex fchkp-first-field-has-own-bounds
11035 @opindex fno-chkp-first-field-has-own-bounds
11036 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11037 first field in the structure.  By default a pointer to the first field has
11038 the same bounds as a pointer to the whole structure.
11040 @item -fchkp-flexible-struct-trailing-arrays
11041 @opindex fchkp-flexible-struct-trailing-arrays
11042 @opindex fno-chkp-flexible-struct-trailing-arrays
11043 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11044 possibly flexible.  By default only array fields with zero length or that are
11045 marked with attribute bnd_variable_size are treated as flexible.
11047 @item -fchkp-narrow-to-innermost-array
11048 @opindex fchkp-narrow-to-innermost-array
11049 @opindex fno-chkp-narrow-to-innermost-array
11050 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11051 case of nested static array access.  By default this option is disabled and
11052 bounds of the outermost array are used.
11054 @item -fchkp-optimize
11055 @opindex fchkp-optimize
11056 @opindex fno-chkp-optimize
11057 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11058 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11060 @item -fchkp-use-fast-string-functions
11061 @opindex fchkp-use-fast-string-functions
11062 @opindex fno-chkp-use-fast-string-functions
11063 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11064 by Pointer Bounds Checker.  Disabled by default.
11066 @item -fchkp-use-nochk-string-functions
11067 @opindex fchkp-use-nochk-string-functions
11068 @opindex fno-chkp-use-nochk-string-functions
11069 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11070 by Pointer Bounds Checker.  Disabled by default.
11072 @item -fchkp-use-static-bounds
11073 @opindex fchkp-use-static-bounds
11074 @opindex fno-chkp-use-static-bounds
11075 Allow Pointer Bounds Checker to generate static bounds holding
11076 bounds of static variables.  Enabled by default.
11078 @item -fchkp-use-static-const-bounds
11079 @opindex fchkp-use-static-const-bounds
11080 @opindex fno-chkp-use-static-const-bounds
11081 Use statically-initialized bounds for constant bounds instead of
11082 generating them each time they are required.  By default enabled when
11083 @option{-fchkp-use-static-bounds} is enabled.
11085 @item -fchkp-treat-zero-dynamic-size-as-infinite
11086 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11087 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11088 With this option, objects with incomplete type whose
11089 dynamically-obtained size is zero are treated as having infinite size
11090 instead by Pointer Bounds
11091 Checker.  This option may be helpful if a program is linked with a library
11092 missing size information for some symbols.  Disabled by default.
11094 @item -fchkp-check-read
11095 @opindex fchkp-check-read
11096 @opindex fno-chkp-check-read
11097 Instructs Pointer Bounds Checker to generate checks for all read
11098 accesses to memory.  Enabled by default.
11100 @item -fchkp-check-write
11101 @opindex fchkp-check-write
11102 @opindex fno-chkp-check-write
11103 Instructs Pointer Bounds Checker to generate checks for all write
11104 accesses to memory.  Enabled by default.
11106 @item -fchkp-store-bounds
11107 @opindex fchkp-store-bounds
11108 @opindex fno-chkp-store-bounds
11109 Instructs Pointer Bounds Checker to generate bounds stores for
11110 pointer writes.  Enabled by default.
11112 @item -fchkp-instrument-calls
11113 @opindex fchkp-instrument-calls
11114 @opindex fno-chkp-instrument-calls
11115 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11116 Enabled by default.
11118 @item -fchkp-instrument-marked-only
11119 @opindex fchkp-instrument-marked-only
11120 @opindex fno-chkp-instrument-marked-only
11121 Instructs Pointer Bounds Checker to instrument only functions
11122 marked with the @code{bnd_instrument} attribute
11123 (@pxref{Function Attributes}).  Disabled by default.
11125 @item -fchkp-use-wrappers
11126 @opindex fchkp-use-wrappers
11127 @opindex fno-chkp-use-wrappers
11128 Allows Pointer Bounds Checker to replace calls to built-in functions
11129 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11130 is used to link a program, the GCC driver automatically links
11131 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11132 Enabled by default.
11134 @item -fstack-protector
11135 @opindex fstack-protector
11136 Emit extra code to check for buffer overflows, such as stack smashing
11137 attacks.  This is done by adding a guard variable to functions with
11138 vulnerable objects.  This includes functions that call @code{alloca}, and
11139 functions with buffers larger than 8 bytes.  The guards are initialized
11140 when a function is entered and then checked when the function exits.
11141 If a guard check fails, an error message is printed and the program exits.
11143 @item -fstack-protector-all
11144 @opindex fstack-protector-all
11145 Like @option{-fstack-protector} except that all functions are protected.
11147 @item -fstack-protector-strong
11148 @opindex fstack-protector-strong
11149 Like @option{-fstack-protector} but includes additional functions to
11150 be protected --- those that have local array definitions, or have
11151 references to local frame addresses.
11153 @item -fstack-protector-explicit
11154 @opindex fstack-protector-explicit
11155 Like @option{-fstack-protector} but only protects those functions which
11156 have the @code{stack_protect} attribute.
11158 @item -fstack-check
11159 @opindex fstack-check
11160 Generate code to verify that you do not go beyond the boundary of the
11161 stack.  You should specify this flag if you are running in an
11162 environment with multiple threads, but you only rarely need to specify it in
11163 a single-threaded environment since stack overflow is automatically
11164 detected on nearly all systems if there is only one stack.
11166 Note that this switch does not actually cause checking to be done; the
11167 operating system or the language runtime must do that.  The switch causes
11168 generation of code to ensure that they see the stack being extended.
11170 You can additionally specify a string parameter: @samp{no} means no
11171 checking, @samp{generic} means force the use of old-style checking,
11172 @samp{specific} means use the best checking method and is equivalent
11173 to bare @option{-fstack-check}.
11175 Old-style checking is a generic mechanism that requires no specific
11176 target support in the compiler but comes with the following drawbacks:
11178 @enumerate
11179 @item
11180 Modified allocation strategy for large objects: they are always
11181 allocated dynamically if their size exceeds a fixed threshold.
11183 @item
11184 Fixed limit on the size of the static frame of functions: when it is
11185 topped by a particular function, stack checking is not reliable and
11186 a warning is issued by the compiler.
11188 @item
11189 Inefficiency: because of both the modified allocation strategy and the
11190 generic implementation, code performance is hampered.
11191 @end enumerate
11193 Note that old-style stack checking is also the fallback method for
11194 @samp{specific} if no target support has been added in the compiler.
11196 @item -fstack-limit-register=@var{reg}
11197 @itemx -fstack-limit-symbol=@var{sym}
11198 @itemx -fno-stack-limit
11199 @opindex fstack-limit-register
11200 @opindex fstack-limit-symbol
11201 @opindex fno-stack-limit
11202 Generate code to ensure that the stack does not grow beyond a certain value,
11203 either the value of a register or the address of a symbol.  If a larger
11204 stack is required, a signal is raised at run time.  For most targets,
11205 the signal is raised before the stack overruns the boundary, so
11206 it is possible to catch the signal without taking special precautions.
11208 For instance, if the stack starts at absolute address @samp{0x80000000}
11209 and grows downwards, you can use the flags
11210 @option{-fstack-limit-symbol=__stack_limit} and
11211 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11212 of 128KB@.  Note that this may only work with the GNU linker.
11214 You can locally override stack limit checking by using the
11215 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11217 @item -fsplit-stack
11218 @opindex fsplit-stack
11219 Generate code to automatically split the stack before it overflows.
11220 The resulting program has a discontiguous stack which can only
11221 overflow if the program is unable to allocate any more memory.  This
11222 is most useful when running threaded programs, as it is no longer
11223 necessary to calculate a good stack size to use for each thread.  This
11224 is currently only implemented for the x86 targets running
11225 GNU/Linux.
11227 When code compiled with @option{-fsplit-stack} calls code compiled
11228 without @option{-fsplit-stack}, there may not be much stack space
11229 available for the latter code to run.  If compiling all code,
11230 including library code, with @option{-fsplit-stack} is not an option,
11231 then the linker can fix up these calls so that the code compiled
11232 without @option{-fsplit-stack} always has a large stack.  Support for
11233 this is implemented in the gold linker in GNU binutils release 2.21
11234 and later.
11236 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11237 @opindex fvtable-verify
11238 This option is only available when compiling C++ code.
11239 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11240 feature that verifies at run time, for every virtual call, that
11241 the vtable pointer through which the call is made is valid for the type of
11242 the object, and has not been corrupted or overwritten.  If an invalid vtable
11243 pointer is detected at run time, an error is reported and execution of the
11244 program is immediately halted.
11246 This option causes run-time data structures to be built at program startup,
11247 which are used for verifying the vtable pointers.  
11248 The options @samp{std} and @samp{preinit}
11249 control the timing of when these data structures are built.  In both cases the
11250 data structures are built before execution reaches @code{main}.  Using
11251 @option{-fvtable-verify=std} causes the data structures to be built after
11252 shared libraries have been loaded and initialized.
11253 @option{-fvtable-verify=preinit} causes them to be built before shared
11254 libraries have been loaded and initialized.
11256 If this option appears multiple times in the command line with different
11257 values specified, @samp{none} takes highest priority over both @samp{std} and
11258 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11260 @item -fvtv-debug
11261 @opindex fvtv-debug
11262 When used in conjunction with @option{-fvtable-verify=std} or 
11263 @option{-fvtable-verify=preinit}, causes debug versions of the 
11264 runtime functions for the vtable verification feature to be called.  
11265 This flag also causes the compiler to log information about which 
11266 vtable pointers it finds for each class.
11267 This information is written to a file named @file{vtv_set_ptr_data.log} 
11268 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11269 if that is defined or the current working directory otherwise.
11271 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11272 file, be sure to delete any existing one.
11274 @item -fvtv-counts
11275 @opindex fvtv-counts
11276 This is a debugging flag.  When used in conjunction with
11277 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11278 causes the compiler to keep track of the total number of virtual calls
11279 it encounters and the number of verifications it inserts.  It also
11280 counts the number of calls to certain run-time library functions
11281 that it inserts and logs this information for each compilation unit.
11282 The compiler writes this information to a file named
11283 @file{vtv_count_data.log} in the directory named by the environment
11284 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11285 directory otherwise.  It also counts the size of the vtable pointer sets
11286 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11287 in the same directory.
11289 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11290 files, be sure to delete any existing ones.
11292 @item -finstrument-functions
11293 @opindex finstrument-functions
11294 Generate instrumentation calls for entry and exit to functions.  Just
11295 after function entry and just before function exit, the following
11296 profiling functions are called with the address of the current
11297 function and its call site.  (On some platforms,
11298 @code{__builtin_return_address} does not work beyond the current
11299 function, so the call site information may not be available to the
11300 profiling functions otherwise.)
11302 @smallexample
11303 void __cyg_profile_func_enter (void *this_fn,
11304                                void *call_site);
11305 void __cyg_profile_func_exit  (void *this_fn,
11306                                void *call_site);
11307 @end smallexample
11309 The first argument is the address of the start of the current function,
11310 which may be looked up exactly in the symbol table.
11312 This instrumentation is also done for functions expanded inline in other
11313 functions.  The profiling calls indicate where, conceptually, the
11314 inline function is entered and exited.  This means that addressable
11315 versions of such functions must be available.  If all your uses of a
11316 function are expanded inline, this may mean an additional expansion of
11317 code size.  If you use @code{extern inline} in your C code, an
11318 addressable version of such functions must be provided.  (This is
11319 normally the case anyway, but if you get lucky and the optimizer always
11320 expands the functions inline, you might have gotten away without
11321 providing static copies.)
11323 A function may be given the attribute @code{no_instrument_function}, in
11324 which case this instrumentation is not done.  This can be used, for
11325 example, for the profiling functions listed above, high-priority
11326 interrupt routines, and any functions from which the profiling functions
11327 cannot safely be called (perhaps signal handlers, if the profiling
11328 routines generate output or allocate memory).
11330 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11331 @opindex finstrument-functions-exclude-file-list
11333 Set the list of functions that are excluded from instrumentation (see
11334 the description of @option{-finstrument-functions}).  If the file that
11335 contains a function definition matches with one of @var{file}, then
11336 that function is not instrumented.  The match is done on substrings:
11337 if the @var{file} parameter is a substring of the file name, it is
11338 considered to be a match.
11340 For example:
11342 @smallexample
11343 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11344 @end smallexample
11346 @noindent
11347 excludes any inline function defined in files whose pathnames
11348 contain @file{/bits/stl} or @file{include/sys}.
11350 If, for some reason, you want to include letter @samp{,} in one of
11351 @var{sym}, write @samp{\,}. For example,
11352 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11353 (note the single quote surrounding the option).
11355 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11356 @opindex finstrument-functions-exclude-function-list
11358 This is similar to @option{-finstrument-functions-exclude-file-list},
11359 but this option sets the list of function names to be excluded from
11360 instrumentation.  The function name to be matched is its user-visible
11361 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11362 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11363 match is done on substrings: if the @var{sym} parameter is a substring
11364 of the function name, it is considered to be a match.  For C99 and C++
11365 extended identifiers, the function name must be given in UTF-8, not
11366 using universal character names.
11368 @end table
11371 @node Preprocessor Options
11372 @section Options Controlling the Preprocessor
11373 @cindex preprocessor options
11374 @cindex options, preprocessor
11376 These options control the C preprocessor, which is run on each C source
11377 file before actual compilation.
11379 If you use the @option{-E} option, nothing is done except preprocessing.
11380 Some of these options make sense only together with @option{-E} because
11381 they cause the preprocessor output to be unsuitable for actual
11382 compilation.
11384 In addition to the options listed here, there are a number of options 
11385 to control search paths for include files documented in 
11386 @ref{Directory Options}.  
11387 Options to control preprocessor diagnostics are listed in 
11388 @ref{Warning Options}.
11390 @table @gcctabopt
11391 @include cppopts.texi
11393 @item -Wp,@var{option}
11394 @opindex Wp
11395 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11396 and pass @var{option} directly through to the preprocessor.  If
11397 @var{option} contains commas, it is split into multiple options at the
11398 commas.  However, many options are modified, translated or interpreted
11399 by the compiler driver before being passed to the preprocessor, and
11400 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11401 interface is undocumented and subject to change, so whenever possible
11402 you should avoid using @option{-Wp} and let the driver handle the
11403 options instead.
11405 @item -Xpreprocessor @var{option}
11406 @opindex Xpreprocessor
11407 Pass @var{option} as an option to the preprocessor.  You can use this to
11408 supply system-specific preprocessor options that GCC does not 
11409 recognize.
11411 If you want to pass an option that takes an argument, you must use
11412 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11414 @item -no-integrated-cpp
11415 @opindex no-integrated-cpp
11416 Perform preprocessing as a separate pass before compilation.
11417 By default, GCC performs preprocessing as an integrated part of
11418 input tokenization and parsing.
11419 If this option is provided, the appropriate language front end
11420 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11421 and Objective-C, respectively) is instead invoked twice,
11422 once for preprocessing only and once for actual compilation
11423 of the preprocessed input.
11424 This option may be useful in conjunction with the @option{-B} or
11425 @option{-wrapper} options to specify an alternate preprocessor or
11426 perform additional processing of the program source between
11427 normal preprocessing and compilation.
11429 @end table
11431 @node Assembler Options
11432 @section Passing Options to the Assembler
11434 @c prevent bad page break with this line
11435 You can pass options to the assembler.
11437 @table @gcctabopt
11438 @item -Wa,@var{option}
11439 @opindex Wa
11440 Pass @var{option} as an option to the assembler.  If @var{option}
11441 contains commas, it is split into multiple options at the commas.
11443 @item -Xassembler @var{option}
11444 @opindex Xassembler
11445 Pass @var{option} as an option to the assembler.  You can use this to
11446 supply system-specific assembler options that GCC does not
11447 recognize.
11449 If you want to pass an option that takes an argument, you must use
11450 @option{-Xassembler} twice, once for the option and once for the argument.
11452 @end table
11454 @node Link Options
11455 @section Options for Linking
11456 @cindex link options
11457 @cindex options, linking
11459 These options come into play when the compiler links object files into
11460 an executable output file.  They are meaningless if the compiler is
11461 not doing a link step.
11463 @table @gcctabopt
11464 @cindex file names
11465 @item @var{object-file-name}
11466 A file name that does not end in a special recognized suffix is
11467 considered to name an object file or library.  (Object files are
11468 distinguished from libraries by the linker according to the file
11469 contents.)  If linking is done, these object files are used as input
11470 to the linker.
11472 @item -c
11473 @itemx -S
11474 @itemx -E
11475 @opindex c
11476 @opindex S
11477 @opindex E
11478 If any of these options is used, then the linker is not run, and
11479 object file names should not be used as arguments.  @xref{Overall
11480 Options}.
11482 @item -fuse-ld=bfd
11483 @opindex fuse-ld=bfd
11484 Use the @command{bfd} linker instead of the default linker.
11486 @item -fuse-ld=gold
11487 @opindex fuse-ld=gold
11488 Use the @command{gold} linker instead of the default linker.
11490 @cindex Libraries
11491 @item -l@var{library}
11492 @itemx -l @var{library}
11493 @opindex l
11494 Search the library named @var{library} when linking.  (The second
11495 alternative with the library as a separate argument is only for
11496 POSIX compliance and is not recommended.)
11498 It makes a difference where in the command you write this option; the
11499 linker searches and processes libraries and object files in the order they
11500 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11501 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11502 to functions in @samp{z}, those functions may not be loaded.
11504 The linker searches a standard list of directories for the library,
11505 which is actually a file named @file{lib@var{library}.a}.  The linker
11506 then uses this file as if it had been specified precisely by name.
11508 The directories searched include several standard system directories
11509 plus any that you specify with @option{-L}.
11511 Normally the files found this way are library files---archive files
11512 whose members are object files.  The linker handles an archive file by
11513 scanning through it for members which define symbols that have so far
11514 been referenced but not defined.  But if the file that is found is an
11515 ordinary object file, it is linked in the usual fashion.  The only
11516 difference between using an @option{-l} option and specifying a file name
11517 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11518 and searches several directories.
11520 @item -lobjc
11521 @opindex lobjc
11522 You need this special case of the @option{-l} option in order to
11523 link an Objective-C or Objective-C++ program.
11525 @item -nostartfiles
11526 @opindex nostartfiles
11527 Do not use the standard system startup files when linking.
11528 The standard system libraries are used normally, unless @option{-nostdlib}
11529 or @option{-nodefaultlibs} is used.
11531 @item -nodefaultlibs
11532 @opindex nodefaultlibs
11533 Do not use the standard system libraries when linking.
11534 Only the libraries you specify are passed to the linker, and options
11535 specifying linkage of the system libraries, such as @option{-static-libgcc}
11536 or @option{-shared-libgcc}, are ignored.  
11537 The standard startup files are used normally, unless @option{-nostartfiles}
11538 is used.  
11540 The compiler may generate calls to @code{memcmp},
11541 @code{memset}, @code{memcpy} and @code{memmove}.
11542 These entries are usually resolved by entries in
11543 libc.  These entry points should be supplied through some other
11544 mechanism when this option is specified.
11546 @item -nostdlib
11547 @opindex nostdlib
11548 Do not use the standard system startup files or libraries when linking.
11549 No startup files and only the libraries you specify are passed to
11550 the linker, and options specifying linkage of the system libraries, such as
11551 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11553 The compiler may generate calls to @code{memcmp}, @code{memset},
11554 @code{memcpy} and @code{memmove}.
11555 These entries are usually resolved by entries in
11556 libc.  These entry points should be supplied through some other
11557 mechanism when this option is specified.
11559 @cindex @option{-lgcc}, use with @option{-nostdlib}
11560 @cindex @option{-nostdlib} and unresolved references
11561 @cindex unresolved references and @option{-nostdlib}
11562 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11563 @cindex @option{-nodefaultlibs} and unresolved references
11564 @cindex unresolved references and @option{-nodefaultlibs}
11565 One of the standard libraries bypassed by @option{-nostdlib} and
11566 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11567 which GCC uses to overcome shortcomings of particular machines, or special
11568 needs for some languages.
11569 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11570 Collection (GCC) Internals},
11571 for more discussion of @file{libgcc.a}.)
11572 In most cases, you need @file{libgcc.a} even when you want to avoid
11573 other standard libraries.  In other words, when you specify @option{-nostdlib}
11574 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11575 This ensures that you have no unresolved references to internal GCC
11576 library subroutines.
11577 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11578 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11579 GNU Compiler Collection (GCC) Internals}.)
11581 @item -pie
11582 @opindex pie
11583 Produce a position independent executable on targets that support it.
11584 For predictable results, you must also specify the same set of options
11585 used for compilation (@option{-fpie}, @option{-fPIE},
11586 or model suboptions) when you specify this linker option.
11588 @item -no-pie
11589 @opindex no-pie
11590 Don't produce a position independent executable.
11592 @item -pthread
11593 @opindex pthread
11594 Link with the POSIX threads library.  This option is supported on 
11595 GNU/Linux targets, most other Unix derivatives, and also on 
11596 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11597 flags for the preprocessor, so it should be used consistently for both
11598 compilation and linking.
11600 @item -rdynamic
11601 @opindex rdynamic
11602 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11603 that support it. This instructs the linker to add all symbols, not
11604 only used ones, to the dynamic symbol table. This option is needed
11605 for some uses of @code{dlopen} or to allow obtaining backtraces
11606 from within a program.
11608 @item -s
11609 @opindex s
11610 Remove all symbol table and relocation information from the executable.
11612 @item -static
11613 @opindex static
11614 On systems that support dynamic linking, this prevents linking with the shared
11615 libraries.  On other systems, this option has no effect.
11617 @item -shared
11618 @opindex shared
11619 Produce a shared object which can then be linked with other objects to
11620 form an executable.  Not all systems support this option.  For predictable
11621 results, you must also specify the same set of options used for compilation
11622 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11623 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11624 needs to build supplementary stub code for constructors to work.  On
11625 multi-libbed systems, @samp{gcc -shared} must select the correct support
11626 libraries to link against.  Failing to supply the correct flags may lead
11627 to subtle defects.  Supplying them in cases where they are not necessary
11628 is innocuous.}
11630 @item -shared-libgcc
11631 @itemx -static-libgcc
11632 @opindex shared-libgcc
11633 @opindex static-libgcc
11634 On systems that provide @file{libgcc} as a shared library, these options
11635 force the use of either the shared or static version, respectively.
11636 If no shared version of @file{libgcc} was built when the compiler was
11637 configured, these options have no effect.
11639 There are several situations in which an application should use the
11640 shared @file{libgcc} instead of the static version.  The most common
11641 of these is when the application wishes to throw and catch exceptions
11642 across different shared libraries.  In that case, each of the libraries
11643 as well as the application itself should use the shared @file{libgcc}.
11645 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11646  whenever you build a shared library or a main executable, because C++
11647  programs typically use exceptions, so this is the right thing to do.
11649 If, instead, you use the GCC driver to create shared libraries, you may
11650 find that they are not always linked with the shared @file{libgcc}.
11651 If GCC finds, at its configuration time, that you have a non-GNU linker
11652 or a GNU linker that does not support option @option{--eh-frame-hdr},
11653 it links the shared version of @file{libgcc} into shared libraries
11654 by default.  Otherwise, it takes advantage of the linker and optimizes
11655 away the linking with the shared version of @file{libgcc}, linking with
11656 the static version of libgcc by default.  This allows exceptions to
11657 propagate through such shared libraries, without incurring relocation
11658 costs at library load time.
11660 However, if a library or main executable is supposed to throw or catch
11661 exceptions, you must link it using the G++ driver, as appropriate
11662 for the languages used in the program, or using the option
11663 @option{-shared-libgcc}, such that it is linked with the shared
11664 @file{libgcc}.
11666 @item -static-libasan
11667 @opindex static-libasan
11668 When the @option{-fsanitize=address} option is used to link a program,
11669 the GCC driver automatically links against @option{libasan}.  If
11670 @file{libasan} is available as a shared library, and the @option{-static}
11671 option is not used, then this links against the shared version of
11672 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11673 driver to link @file{libasan} statically, without necessarily linking
11674 other libraries statically.
11676 @item -static-libtsan
11677 @opindex static-libtsan
11678 When the @option{-fsanitize=thread} option is used to link a program,
11679 the GCC driver automatically links against @option{libtsan}.  If
11680 @file{libtsan} is available as a shared library, and the @option{-static}
11681 option is not used, then this links against the shared version of
11682 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11683 driver to link @file{libtsan} statically, without necessarily linking
11684 other libraries statically.
11686 @item -static-liblsan
11687 @opindex static-liblsan
11688 When the @option{-fsanitize=leak} option is used to link a program,
11689 the GCC driver automatically links against @option{liblsan}.  If
11690 @file{liblsan} is available as a shared library, and the @option{-static}
11691 option is not used, then this links against the shared version of
11692 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11693 driver to link @file{liblsan} statically, without necessarily linking
11694 other libraries statically.
11696 @item -static-libubsan
11697 @opindex static-libubsan
11698 When the @option{-fsanitize=undefined} option is used to link a program,
11699 the GCC driver automatically links against @option{libubsan}.  If
11700 @file{libubsan} is available as a shared library, and the @option{-static}
11701 option is not used, then this links against the shared version of
11702 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11703 driver to link @file{libubsan} statically, without necessarily linking
11704 other libraries statically.
11706 @item -static-libmpx
11707 @opindex static-libmpx
11708 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11709 used to link a program, the GCC driver automatically links against
11710 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11711 and the @option{-static} option is not used, then this links against
11712 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11713 option directs the GCC driver to link @file{libmpx} statically,
11714 without necessarily linking other libraries statically.
11716 @item -static-libmpxwrappers
11717 @opindex static-libmpxwrappers
11718 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11719 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11720 GCC driver automatically links against @file{libmpxwrappers}.  If
11721 @file{libmpxwrappers} is available as a shared library, and the
11722 @option{-static} option is not used, then this links against the shared
11723 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11724 option directs the GCC driver to link @file{libmpxwrappers} statically,
11725 without necessarily linking other libraries statically.
11727 @item -static-libstdc++
11728 @opindex static-libstdc++
11729 When the @command{g++} program is used to link a C++ program, it
11730 normally automatically links against @option{libstdc++}.  If
11731 @file{libstdc++} is available as a shared library, and the
11732 @option{-static} option is not used, then this links against the
11733 shared version of @file{libstdc++}.  That is normally fine.  However, it
11734 is sometimes useful to freeze the version of @file{libstdc++} used by
11735 the program without going all the way to a fully static link.  The
11736 @option{-static-libstdc++} option directs the @command{g++} driver to
11737 link @file{libstdc++} statically, without necessarily linking other
11738 libraries statically.
11740 @item -symbolic
11741 @opindex symbolic
11742 Bind references to global symbols when building a shared object.  Warn
11743 about any unresolved references (unless overridden by the link editor
11744 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11745 this option.
11747 @item -T @var{script}
11748 @opindex T
11749 @cindex linker script
11750 Use @var{script} as the linker script.  This option is supported by most
11751 systems using the GNU linker.  On some targets, such as bare-board
11752 targets without an operating system, the @option{-T} option may be required
11753 when linking to avoid references to undefined symbols.
11755 @item -Xlinker @var{option}
11756 @opindex Xlinker
11757 Pass @var{option} as an option to the linker.  You can use this to
11758 supply system-specific linker options that GCC does not recognize.
11760 If you want to pass an option that takes a separate argument, you must use
11761 @option{-Xlinker} twice, once for the option and once for the argument.
11762 For example, to pass @option{-assert definitions}, you must write
11763 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11764 @option{-Xlinker "-assert definitions"}, because this passes the entire
11765 string as a single argument, which is not what the linker expects.
11767 When using the GNU linker, it is usually more convenient to pass
11768 arguments to linker options using the @option{@var{option}=@var{value}}
11769 syntax than as separate arguments.  For example, you can specify
11770 @option{-Xlinker -Map=output.map} rather than
11771 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11772 this syntax for command-line options.
11774 @item -Wl,@var{option}
11775 @opindex Wl
11776 Pass @var{option} as an option to the linker.  If @var{option} contains
11777 commas, it is split into multiple options at the commas.  You can use this
11778 syntax to pass an argument to the option.
11779 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11780 linker.  When using the GNU linker, you can also get the same effect with
11781 @option{-Wl,-Map=output.map}.
11783 @item -u @var{symbol}
11784 @opindex u
11785 Pretend the symbol @var{symbol} is undefined, to force linking of
11786 library modules to define it.  You can use @option{-u} multiple times with
11787 different symbols to force loading of additional library modules.
11789 @item -z @var{keyword}
11790 @opindex z
11791 @option{-z} is passed directly on to the linker along with the keyword
11792 @var{keyword}. See the section in the documentation of your linker for
11793 permitted values and their meanings.
11794 @end table
11796 @node Directory Options
11797 @section Options for Directory Search
11798 @cindex directory options
11799 @cindex options, directory search
11800 @cindex search path
11802 These options specify directories to search for header files, for
11803 libraries and for parts of the compiler:
11805 @table @gcctabopt
11806 @include cppdiropts.texi
11808 @item -iplugindir=@var{dir}
11809 @opindex iplugindir=
11810 Set the directory to search for plugins that are passed
11811 by @option{-fplugin=@var{name}} instead of
11812 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11813 to be used by the user, but only passed by the driver.
11815 @item -L@var{dir}
11816 @opindex L
11817 Add directory @var{dir} to the list of directories to be searched
11818 for @option{-l}.
11820 @item -B@var{prefix}
11821 @opindex B
11822 This option specifies where to find the executables, libraries,
11823 include files, and data files of the compiler itself.
11825 The compiler driver program runs one or more of the subprograms
11826 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11827 @var{prefix} as a prefix for each program it tries to run, both with and
11828 without @samp{@var{machine}/@var{version}/} for the corresponding target
11829 machine and compiler version.
11831 For each subprogram to be run, the compiler driver first tries the
11832 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11833 is not specified, the driver tries two standard prefixes, 
11834 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11835 those results in a file name that is found, the unmodified program
11836 name is searched for using the directories specified in your
11837 @env{PATH} environment variable.
11839 The compiler checks to see if the path provided by @option{-B}
11840 refers to a directory, and if necessary it adds a directory
11841 separator character at the end of the path.
11843 @option{-B} prefixes that effectively specify directory names also apply
11844 to libraries in the linker, because the compiler translates these
11845 options into @option{-L} options for the linker.  They also apply to
11846 include files in the preprocessor, because the compiler translates these
11847 options into @option{-isystem} options for the preprocessor.  In this case,
11848 the compiler appends @samp{include} to the prefix.
11850 The runtime support file @file{libgcc.a} can also be searched for using
11851 the @option{-B} prefix, if needed.  If it is not found there, the two
11852 standard prefixes above are tried, and that is all.  The file is left
11853 out of the link if it is not found by those means.
11855 Another way to specify a prefix much like the @option{-B} prefix is to use
11856 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11857 Variables}.
11859 As a special kludge, if the path provided by @option{-B} is
11860 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11861 9, then it is replaced by @file{[dir/]include}.  This is to help
11862 with boot-strapping the compiler.
11864 @item -no-canonical-prefixes
11865 @opindex no-canonical-prefixes
11866 Do not expand any symbolic links, resolve references to @samp{/../}
11867 or @samp{/./}, or make the path absolute when generating a relative
11868 prefix.
11870 @item --sysroot=@var{dir}
11871 @opindex sysroot
11872 Use @var{dir} as the logical root directory for headers and libraries.
11873 For example, if the compiler normally searches for headers in
11874 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11875 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11877 If you use both this option and the @option{-isysroot} option, then
11878 the @option{--sysroot} option applies to libraries, but the
11879 @option{-isysroot} option applies to header files.
11881 The GNU linker (beginning with version 2.16) has the necessary support
11882 for this option.  If your linker does not support this option, the
11883 header file aspect of @option{--sysroot} still works, but the
11884 library aspect does not.
11886 @item --no-sysroot-suffix
11887 @opindex no-sysroot-suffix
11888 For some targets, a suffix is added to the root directory specified
11889 with @option{--sysroot}, depending on the other options used, so that
11890 headers may for example be found in
11891 @file{@var{dir}/@var{suffix}/usr/include} instead of
11892 @file{@var{dir}/usr/include}.  This option disables the addition of
11893 such a suffix.
11895 @end table
11897 @node Code Gen Options
11898 @section Options for Code Generation Conventions
11899 @cindex code generation conventions
11900 @cindex options, code generation
11901 @cindex run-time options
11903 These machine-independent options control the interface conventions
11904 used in code generation.
11906 Most of them have both positive and negative forms; the negative form
11907 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
11908 one of the forms is listed---the one that is not the default.  You
11909 can figure out the other form by either removing @samp{no-} or adding
11912 @table @gcctabopt
11913 @item -fstack-reuse=@var{reuse-level}
11914 @opindex fstack_reuse
11915 This option controls stack space reuse for user declared local/auto variables
11916 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
11917 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
11918 local variables and temporaries, @samp{named_vars} enables the reuse only for
11919 user defined local variables with names, and @samp{none} disables stack reuse
11920 completely. The default value is @samp{all}. The option is needed when the
11921 program extends the lifetime of a scoped local variable or a compiler generated
11922 temporary beyond the end point defined by the language.  When a lifetime of
11923 a variable ends, and if the variable lives in memory, the optimizing compiler
11924 has the freedom to reuse its stack space with other temporaries or scoped
11925 local variables whose live range does not overlap with it. Legacy code extending
11926 local lifetime is likely to break with the stack reuse optimization.
11928 For example,
11930 @smallexample
11931    int *p;
11932    @{
11933      int local1;
11935      p = &local1;
11936      local1 = 10;
11937      ....
11938    @}
11939    @{
11940       int local2;
11941       local2 = 20;
11942       ...
11943    @}
11945    if (*p == 10)  // out of scope use of local1
11946      @{
11948      @}
11949 @end smallexample
11951 Another example:
11952 @smallexample
11954    struct A
11955    @{
11956        A(int k) : i(k), j(k) @{ @}
11957        int i;
11958        int j;
11959    @};
11961    A *ap;
11963    void foo(const A& ar)
11964    @{
11965       ap = &ar;
11966    @}
11968    void bar()
11969    @{
11970       foo(A(10)); // temp object's lifetime ends when foo returns
11972       @{
11973         A a(20);
11974         ....
11975       @}
11976       ap->i+= 10;  // ap references out of scope temp whose space
11977                    // is reused with a. What is the value of ap->i?
11978    @}
11980 @end smallexample
11982 The lifetime of a compiler generated temporary is well defined by the C++
11983 standard. When a lifetime of a temporary ends, and if the temporary lives
11984 in memory, the optimizing compiler has the freedom to reuse its stack
11985 space with other temporaries or scoped local variables whose live range
11986 does not overlap with it. However some of the legacy code relies on
11987 the behavior of older compilers in which temporaries' stack space is
11988 not reused, the aggressive stack reuse can lead to runtime errors. This
11989 option is used to control the temporary stack reuse optimization.
11991 @item -ftrapv
11992 @opindex ftrapv
11993 This option generates traps for signed overflow on addition, subtraction,
11994 multiplication operations.
11995 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
11996 @option{-ftrapv} @option{-fwrapv} on the command-line results in
11997 @option{-fwrapv} being effective.  Note that only active options override, so
11998 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
11999 results in @option{-ftrapv} being effective.
12001 @item -fwrapv
12002 @opindex fwrapv
12003 This option instructs the compiler to assume that signed arithmetic
12004 overflow of addition, subtraction and multiplication wraps around
12005 using twos-complement representation.  This flag enables some optimizations
12006 and disables others.
12007 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12008 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12009 @option{-fwrapv} being effective.  Note that only active options override, so
12010 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12011 results in @option{-ftrapv} being effective.
12013 @item -fexceptions
12014 @opindex fexceptions
12015 Enable exception handling.  Generates extra code needed to propagate
12016 exceptions.  For some targets, this implies GCC generates frame
12017 unwind information for all functions, which can produce significant data
12018 size overhead, although it does not affect execution.  If you do not
12019 specify this option, GCC enables it by default for languages like
12020 C++ that normally require exception handling, and disables it for
12021 languages like C that do not normally require it.  However, you may need
12022 to enable this option when compiling C code that needs to interoperate
12023 properly with exception handlers written in C++.  You may also wish to
12024 disable this option if you are compiling older C++ programs that don't
12025 use exception handling.
12027 @item -fnon-call-exceptions
12028 @opindex fnon-call-exceptions
12029 Generate code that allows trapping instructions to throw exceptions.
12030 Note that this requires platform-specific runtime support that does
12031 not exist everywhere.  Moreover, it only allows @emph{trapping}
12032 instructions to throw exceptions, i.e.@: memory references or floating-point
12033 instructions.  It does not allow exceptions to be thrown from
12034 arbitrary signal handlers such as @code{SIGALRM}.
12036 @item -fdelete-dead-exceptions
12037 @opindex fdelete-dead-exceptions
12038 Consider that instructions that may throw exceptions but don't otherwise
12039 contribute to the execution of the program can be optimized away.
12040 This option is enabled by default for the Ada front end, as permitted by
12041 the Ada language specification.
12042 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12044 @item -funwind-tables
12045 @opindex funwind-tables
12046 Similar to @option{-fexceptions}, except that it just generates any needed
12047 static data, but does not affect the generated code in any other way.
12048 You normally do not need to enable this option; instead, a language processor
12049 that needs this handling enables it on your behalf.
12051 @item -fasynchronous-unwind-tables
12052 @opindex fasynchronous-unwind-tables
12053 Generate unwind table in DWARF format, if supported by target machine.  The
12054 table is exact at each instruction boundary, so it can be used for stack
12055 unwinding from asynchronous events (such as debugger or garbage collector).
12057 @item -fno-gnu-unique
12058 @opindex fno-gnu-unique
12059 On systems with recent GNU assembler and C library, the C++ compiler
12060 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12061 of template static data members and static local variables in inline
12062 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12063 is necessary to avoid problems with a library used by two different
12064 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12065 therefore disagreeing with the other one about the binding of the
12066 symbol.  But this causes @code{dlclose} to be ignored for affected
12067 DSOs; if your program relies on reinitialization of a DSO via
12068 @code{dlclose} and @code{dlopen}, you can use
12069 @option{-fno-gnu-unique}.
12071 @item -fpcc-struct-return
12072 @opindex fpcc-struct-return
12073 Return ``short'' @code{struct} and @code{union} values in memory like
12074 longer ones, rather than in registers.  This convention is less
12075 efficient, but it has the advantage of allowing intercallability between
12076 GCC-compiled files and files compiled with other compilers, particularly
12077 the Portable C Compiler (pcc).
12079 The precise convention for returning structures in memory depends
12080 on the target configuration macros.
12082 Short structures and unions are those whose size and alignment match
12083 that of some integer type.
12085 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12086 switch is not binary compatible with code compiled with the
12087 @option{-freg-struct-return} switch.
12088 Use it to conform to a non-default application binary interface.
12090 @item -freg-struct-return
12091 @opindex freg-struct-return
12092 Return @code{struct} and @code{union} values in registers when possible.
12093 This is more efficient for small structures than
12094 @option{-fpcc-struct-return}.
12096 If you specify neither @option{-fpcc-struct-return} nor
12097 @option{-freg-struct-return}, GCC defaults to whichever convention is
12098 standard for the target.  If there is no standard convention, GCC
12099 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12100 the principal compiler.  In those cases, we can choose the standard, and
12101 we chose the more efficient register return alternative.
12103 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12104 switch is not binary compatible with code compiled with the
12105 @option{-fpcc-struct-return} switch.
12106 Use it to conform to a non-default application binary interface.
12108 @item -fshort-enums
12109 @opindex fshort-enums
12110 Allocate to an @code{enum} type only as many bytes as it needs for the
12111 declared range of possible values.  Specifically, the @code{enum} type
12112 is equivalent to the smallest integer type that has enough room.
12114 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12115 code that is not binary compatible with code generated without that switch.
12116 Use it to conform to a non-default application binary interface.
12118 @item -fshort-wchar
12119 @opindex fshort-wchar
12120 Override the underlying type for @code{wchar_t} to be @code{short
12121 unsigned int} instead of the default for the target.  This option is
12122 useful for building programs to run under WINE@.
12124 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12125 code that is not binary compatible with code generated without that switch.
12126 Use it to conform to a non-default application binary interface.
12128 @item -fno-common
12129 @opindex fno-common
12130 @cindex tentative definitions
12131 In C code, this option controls the placement of global variables 
12132 defined without an initializer, known as @dfn{tentative definitions} 
12133 in the C standard.  Tentative definitions are distinct from declarations 
12134 of a variable with the @code{extern} keyword, which do not allocate storage.
12136 Unix C compilers have traditionally allocated storage for
12137 uninitialized global variables in a common block.  This allows the
12138 linker to resolve all tentative definitions of the same variable
12139 in different compilation units to the same object, or to a non-tentative
12140 definition.  
12141 This is the behavior specified by @option{-fcommon}, and is the default for 
12142 GCC on most targets.  
12143 On the other hand, this behavior is not required by ISO
12144 C, and on some targets may carry a speed or code size penalty on
12145 variable references.
12147 The @option{-fno-common} option specifies that the compiler should instead
12148 place uninitialized global variables in the data section of the object file.
12149 This inhibits the merging of tentative definitions by the linker so
12150 you get a multiple-definition error if the same 
12151 variable is defined in more than one compilation unit.
12152 Compiling with @option{-fno-common} is useful on targets for which
12153 it provides better performance, or if you wish to verify that the
12154 program will work on other systems that always treat uninitialized
12155 variable definitions this way.
12157 @item -fno-ident
12158 @opindex fno-ident
12159 Ignore the @code{#ident} directive.
12161 @item -finhibit-size-directive
12162 @opindex finhibit-size-directive
12163 Don't output a @code{.size} assembler directive, or anything else that
12164 would cause trouble if the function is split in the middle, and the
12165 two halves are placed at locations far apart in memory.  This option is
12166 used when compiling @file{crtstuff.c}; you should not need to use it
12167 for anything else.
12169 @item -fverbose-asm
12170 @opindex fverbose-asm
12171 Put extra commentary information in the generated assembly code to
12172 make it more readable.  This option is generally only of use to those
12173 who actually need to read the generated assembly code (perhaps while
12174 debugging the compiler itself).
12176 @option{-fno-verbose-asm}, the default, causes the
12177 extra information to be omitted and is useful when comparing two assembler
12178 files.
12180 The added comments include:
12182 @itemize @bullet
12184 @item
12185 information on the compiler version and command-line options,
12187 @item
12188 the source code lines associated with the assembly instructions,
12189 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12191 @item
12192 hints on which high-level expressions correspond to
12193 the various assembly instruction operands.
12195 @end itemize
12197 For example, given this C source file:
12199 @smallexample
12200 int test (int n)
12202   int i;
12203   int total = 0;
12205   for (i = 0; i < n; i++)
12206     total += i * i;
12208   return total;
12210 @end smallexample
12212 compiling to (x86_64) assembly via @option{-S} and emitting the result
12213 direct to stdout via @option{-o} @option{-}
12215 @smallexample
12216 gcc -S test.c -fverbose-asm -Os -o -
12217 @end smallexample
12219 gives output similar to this:
12221 @smallexample
12222         .file   "test.c"
12223 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12224   [...snip...]
12225 # options passed:
12226   [...snip...]
12228         .text
12229         .globl  test
12230         .type   test, @@function
12231 test:
12232 .LFB0:
12233         .cfi_startproc
12234 # test.c:4:   int total = 0;
12235         xorl    %eax, %eax      # <retval>
12236 # test.c:6:   for (i = 0; i < n; i++)
12237         xorl    %edx, %edx      # i
12238 .L2:
12239 # test.c:6:   for (i = 0; i < n; i++)
12240         cmpl    %edi, %edx      # n, i
12241         jge     .L5     #,
12242 # test.c:7:     total += i * i;
12243         movl    %edx, %ecx      # i, tmp92
12244         imull   %edx, %ecx      # i, tmp92
12245 # test.c:6:   for (i = 0; i < n; i++)
12246         incl    %edx    # i
12247 # test.c:7:     total += i * i;
12248         addl    %ecx, %eax      # tmp92, <retval>
12249         jmp     .L2     #
12250 .L5:
12251 # test.c:10: @}
12252         ret
12253         .cfi_endproc
12254 .LFE0:
12255         .size   test, .-test
12256         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12257         .section        .note.GNU-stack,"",@@progbits
12258 @end smallexample
12260 The comments are intended for humans rather than machines and hence the
12261 precise format of the comments is subject to change.
12263 @item -frecord-gcc-switches
12264 @opindex frecord-gcc-switches
12265 This switch causes the command line used to invoke the
12266 compiler to be recorded into the object file that is being created.
12267 This switch is only implemented on some targets and the exact format
12268 of the recording is target and binary file format dependent, but it
12269 usually takes the form of a section containing ASCII text.  This
12270 switch is related to the @option{-fverbose-asm} switch, but that
12271 switch only records information in the assembler output file as
12272 comments, so it never reaches the object file.
12273 See also @option{-grecord-gcc-switches} for another
12274 way of storing compiler options into the object file.
12276 @item -fpic
12277 @opindex fpic
12278 @cindex global offset table
12279 @cindex PIC
12280 Generate position-independent code (PIC) suitable for use in a shared
12281 library, if supported for the target machine.  Such code accesses all
12282 constant addresses through a global offset table (GOT)@.  The dynamic
12283 loader resolves the GOT entries when the program starts (the dynamic
12284 loader is not part of GCC; it is part of the operating system).  If
12285 the GOT size for the linked executable exceeds a machine-specific
12286 maximum size, you get an error message from the linker indicating that
12287 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12288 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12289 on the m68k and RS/6000.  The x86 has no such limit.)
12291 Position-independent code requires special support, and therefore works
12292 only on certain machines.  For the x86, GCC supports PIC for System V
12293 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12294 position-independent.
12296 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12297 are defined to 1.
12299 @item -fPIC
12300 @opindex fPIC
12301 If supported for the target machine, emit position-independent code,
12302 suitable for dynamic linking and avoiding any limit on the size of the
12303 global offset table.  This option makes a difference on AArch64, m68k,
12304 PowerPC and SPARC@.
12306 Position-independent code requires special support, and therefore works
12307 only on certain machines.
12309 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12310 are defined to 2.
12312 @item -fpie
12313 @itemx -fPIE
12314 @opindex fpie
12315 @opindex fPIE
12316 These options are similar to @option{-fpic} and @option{-fPIC}, but
12317 generated position independent code can be only linked into executables.
12318 Usually these options are used when @option{-pie} GCC option is
12319 used during linking.
12321 @option{-fpie} and @option{-fPIE} both define the macros
12322 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12323 for @option{-fpie} and 2 for @option{-fPIE}.
12325 @item -fno-plt
12326 @opindex fno-plt
12327 Do not use the PLT for external function calls in position-independent code.
12328 Instead, load the callee address at call sites from the GOT and branch to it.
12329 This leads to more efficient code by eliminating PLT stubs and exposing
12330 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12331 PLT stubs expect the GOT pointer in a specific register, this gives more
12332 register allocation freedom to the compiler.
12333 Lazy binding requires use of the PLT; 
12334 with @option{-fno-plt} all external symbols are resolved at load time.
12336 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12337 through the PLT for specific external functions.
12339 In position-dependent code, a few targets also convert calls to
12340 functions that are marked to not use the PLT to use the GOT instead.
12342 @item -fno-jump-tables
12343 @opindex fno-jump-tables
12344 Do not use jump tables for switch statements even where it would be
12345 more efficient than other code generation strategies.  This option is
12346 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12347 building code that forms part of a dynamic linker and cannot
12348 reference the address of a jump table.  On some targets, jump tables
12349 do not require a GOT and this option is not needed.
12351 @item -ffixed-@var{reg}
12352 @opindex ffixed
12353 Treat the register named @var{reg} as a fixed register; generated code
12354 should never refer to it (except perhaps as a stack pointer, frame
12355 pointer or in some other fixed role).
12357 @var{reg} must be the name of a register.  The register names accepted
12358 are machine-specific and are defined in the @code{REGISTER_NAMES}
12359 macro in the machine description macro file.
12361 This flag does not have a negative form, because it specifies a
12362 three-way choice.
12364 @item -fcall-used-@var{reg}
12365 @opindex fcall-used
12366 Treat the register named @var{reg} as an allocable register that is
12367 clobbered by function calls.  It may be allocated for temporaries or
12368 variables that do not live across a call.  Functions compiled this way
12369 do not save and restore the register @var{reg}.
12371 It is an error to use this flag with the frame pointer or stack pointer.
12372 Use of this flag for other registers that have fixed pervasive roles in
12373 the machine's execution model produces disastrous results.
12375 This flag does not have a negative form, because it specifies a
12376 three-way choice.
12378 @item -fcall-saved-@var{reg}
12379 @opindex fcall-saved
12380 Treat the register named @var{reg} as an allocable register saved by
12381 functions.  It may be allocated even for temporaries or variables that
12382 live across a call.  Functions compiled this way save and restore
12383 the register @var{reg} if they use it.
12385 It is an error to use this flag with the frame pointer or stack pointer.
12386 Use of this flag for other registers that have fixed pervasive roles in
12387 the machine's execution model produces disastrous results.
12389 A different sort of disaster results from the use of this flag for
12390 a register in which function values may be returned.
12392 This flag does not have a negative form, because it specifies a
12393 three-way choice.
12395 @item -fpack-struct[=@var{n}]
12396 @opindex fpack-struct
12397 Without a value specified, pack all structure members together without
12398 holes.  When a value is specified (which must be a small power of two), pack
12399 structure members according to this value, representing the maximum
12400 alignment (that is, objects with default alignment requirements larger than
12401 this are output potentially unaligned at the next fitting location.
12403 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12404 code that is not binary compatible with code generated without that switch.
12405 Additionally, it makes the code suboptimal.
12406 Use it to conform to a non-default application binary interface.
12408 @item -fleading-underscore
12409 @opindex fleading-underscore
12410 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12411 change the way C symbols are represented in the object file.  One use
12412 is to help link with legacy assembly code.
12414 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12415 generate code that is not binary compatible with code generated without that
12416 switch.  Use it to conform to a non-default application binary interface.
12417 Not all targets provide complete support for this switch.
12419 @item -ftls-model=@var{model}
12420 @opindex ftls-model
12421 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12422 The @var{model} argument should be one of @samp{global-dynamic},
12423 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12424 Note that the choice is subject to optimization: the compiler may use
12425 a more efficient model for symbols not visible outside of the translation
12426 unit, or if @option{-fpic} is not given on the command line.
12428 The default without @option{-fpic} is @samp{initial-exec}; with
12429 @option{-fpic} the default is @samp{global-dynamic}.
12431 @item -ftrampolines
12432 @opindex ftrampolines
12433 For targets that normally need trampolines for nested functions, always
12434 generate them instead of using descriptors.  Otherwise, for targets that
12435 do not need them, like for example HP-PA or IA-64, do nothing.
12437 A trampoline is a small piece of code that is created at run time on the
12438 stack when the address of a nested function is taken, and is used to call
12439 the nested function indirectly.  Therefore, it requires the stack to be
12440 made executable in order for the program to work properly.
12442 @option{-fno-trampolines} is enabled by default on a language by language
12443 basis to let the compiler avoid generating them, if it computes that this
12444 is safe, and replace them with descriptors.  Descriptors are made up of data
12445 only, but the generated code must be prepared to deal with them.  As of this
12446 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12448 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12449 @option{-fno-trampolines} are not binary compatible if nested functions are
12450 present.  This option must therefore be used on a program-wide basis and be
12451 manipulated with extreme care.
12453 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12454 @opindex fvisibility
12455 Set the default ELF image symbol visibility to the specified option---all
12456 symbols are marked with this unless overridden within the code.
12457 Using this feature can very substantially improve linking and
12458 load times of shared object libraries, produce more optimized
12459 code, provide near-perfect API export and prevent symbol clashes.
12460 It is @strong{strongly} recommended that you use this in any shared objects
12461 you distribute.
12463 Despite the nomenclature, @samp{default} always means public; i.e.,
12464 available to be linked against from outside the shared object.
12465 @samp{protected} and @samp{internal} are pretty useless in real-world
12466 usage so the only other commonly used option is @samp{hidden}.
12467 The default if @option{-fvisibility} isn't specified is
12468 @samp{default}, i.e., make every symbol public.
12470 A good explanation of the benefits offered by ensuring ELF
12471 symbols have the correct visibility is given by ``How To Write
12472 Shared Libraries'' by Ulrich Drepper (which can be found at
12473 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12474 solution made possible by this option to marking things hidden when
12475 the default is public is to make the default hidden and mark things
12476 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12477 and @code{__attribute__ ((visibility("default")))} instead of
12478 @code{__declspec(dllexport)} you get almost identical semantics with
12479 identical syntax.  This is a great boon to those working with
12480 cross-platform projects.
12482 For those adding visibility support to existing code, you may find
12483 @code{#pragma GCC visibility} of use.  This works by you enclosing
12484 the declarations you wish to set visibility for with (for example)
12485 @code{#pragma GCC visibility push(hidden)} and
12486 @code{#pragma GCC visibility pop}.
12487 Bear in mind that symbol visibility should be viewed @strong{as
12488 part of the API interface contract} and thus all new code should
12489 always specify visibility when it is not the default; i.e., declarations
12490 only for use within the local DSO should @strong{always} be marked explicitly
12491 as hidden as so to avoid PLT indirection overheads---making this
12492 abundantly clear also aids readability and self-documentation of the code.
12493 Note that due to ISO C++ specification requirements, @code{operator new} and
12494 @code{operator delete} must always be of default visibility.
12496 Be aware that headers from outside your project, in particular system
12497 headers and headers from any other library you use, may not be
12498 expecting to be compiled with visibility other than the default.  You
12499 may need to explicitly say @code{#pragma GCC visibility push(default)}
12500 before including any such headers.
12502 @code{extern} declarations are not affected by @option{-fvisibility}, so
12503 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12504 no modifications.  However, this means that calls to @code{extern}
12505 functions with no explicit visibility use the PLT, so it is more
12506 effective to use @code{__attribute ((visibility))} and/or
12507 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12508 declarations should be treated as hidden.
12510 Note that @option{-fvisibility} does affect C++ vague linkage
12511 entities. This means that, for instance, an exception class that is
12512 be thrown between DSOs must be explicitly marked with default
12513 visibility so that the @samp{type_info} nodes are unified between
12514 the DSOs.
12516 An overview of these techniques, their benefits and how to use them
12517 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12519 @item -fstrict-volatile-bitfields
12520 @opindex fstrict-volatile-bitfields
12521 This option should be used if accesses to volatile bit-fields (or other
12522 structure fields, although the compiler usually honors those types
12523 anyway) should use a single access of the width of the
12524 field's type, aligned to a natural alignment if possible.  For
12525 example, targets with memory-mapped peripheral registers might require
12526 all such accesses to be 16 bits wide; with this flag you can
12527 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12528 is 16 bits on these targets) to force GCC to use 16-bit accesses
12529 instead of, perhaps, a more efficient 32-bit access.
12531 If this option is disabled, the compiler uses the most efficient
12532 instruction.  In the previous example, that might be a 32-bit load
12533 instruction, even though that accesses bytes that do not contain
12534 any portion of the bit-field, or memory-mapped registers unrelated to
12535 the one being updated.
12537 In some cases, such as when the @code{packed} attribute is applied to a 
12538 structure field, it may not be possible to access the field with a single
12539 read or write that is correctly aligned for the target machine.  In this
12540 case GCC falls back to generating multiple accesses rather than code that 
12541 will fault or truncate the result at run time.
12543 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12544 not allowed to touch non bit-field members.  It is therefore recommended
12545 to define all bits of the field's type as bit-field members.
12547 The default value of this option is determined by the application binary
12548 interface for the target processor.
12550 @item -fsync-libcalls
12551 @opindex fsync-libcalls
12552 This option controls whether any out-of-line instance of the @code{__sync}
12553 family of functions may be used to implement the C++11 @code{__atomic}
12554 family of functions.
12556 The default value of this option is enabled, thus the only useful form
12557 of the option is @option{-fno-sync-libcalls}.  This option is used in
12558 the implementation of the @file{libatomic} runtime library.
12560 @end table
12562 @node Developer Options
12563 @section GCC Developer Options
12564 @cindex developer options
12565 @cindex debugging GCC
12566 @cindex debug dump options
12567 @cindex dump options
12568 @cindex compilation statistics
12570 This section describes command-line options that are primarily of
12571 interest to GCC developers, including options to support compiler
12572 testing and investigation of compiler bugs and compile-time
12573 performance problems.  This includes options that produce debug dumps
12574 at various points in the compilation; that print statistics such as
12575 memory use and execution time; and that print information about GCC's
12576 configuration, such as where it searches for libraries.  You should
12577 rarely need to use any of these options for ordinary compilation and
12578 linking tasks.
12580 @table @gcctabopt
12582 @item -d@var{letters}
12583 @itemx -fdump-rtl-@var{pass}
12584 @itemx -fdump-rtl-@var{pass}=@var{filename}
12585 @opindex d
12586 @opindex fdump-rtl-@var{pass}
12587 Says to make debugging dumps during compilation at times specified by
12588 @var{letters}.  This is used for debugging the RTL-based passes of the
12589 compiler.  The file names for most of the dumps are made by appending
12590 a pass number and a word to the @var{dumpname}, and the files are
12591 created in the directory of the output file.  In case of
12592 @option{=@var{filename}} option, the dump is output on the given file
12593 instead of the pass numbered dump files.  Note that the pass number is
12594 assigned as passes are registered into the pass manager.  Most passes
12595 are registered in the order that they will execute and for these passes
12596 the number corresponds to the pass execution order.  However, passes
12597 registered by plugins, passes specific to compilation targets, or
12598 passes that are otherwise registered after all the other passes are
12599 numbered higher than a pass named "final", even if they are executed
12600 earlier.  @var{dumpname} is generated from the name of the output
12601 file if explicitly specified and not an executable, otherwise it is
12602 the basename of the source file.  
12604 Some @option{-d@var{letters}} switches have different meaning when
12605 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12606 for information about preprocessor-specific dump options.
12608 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12609 @option{-d} option @var{letters}.  Here are the possible
12610 letters for use in @var{pass} and @var{letters}, and their meanings:
12612 @table @gcctabopt
12614 @item -fdump-rtl-alignments
12615 @opindex fdump-rtl-alignments
12616 Dump after branch alignments have been computed.
12618 @item -fdump-rtl-asmcons
12619 @opindex fdump-rtl-asmcons
12620 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12622 @item -fdump-rtl-auto_inc_dec
12623 @opindex fdump-rtl-auto_inc_dec
12624 Dump after auto-inc-dec discovery.  This pass is only run on
12625 architectures that have auto inc or auto dec instructions.
12627 @item -fdump-rtl-barriers
12628 @opindex fdump-rtl-barriers
12629 Dump after cleaning up the barrier instructions.
12631 @item -fdump-rtl-bbpart
12632 @opindex fdump-rtl-bbpart
12633 Dump after partitioning hot and cold basic blocks.
12635 @item -fdump-rtl-bbro
12636 @opindex fdump-rtl-bbro
12637 Dump after block reordering.
12639 @item -fdump-rtl-btl1
12640 @itemx -fdump-rtl-btl2
12641 @opindex fdump-rtl-btl2
12642 @opindex fdump-rtl-btl2
12643 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12644 after the two branch
12645 target load optimization passes.
12647 @item -fdump-rtl-bypass
12648 @opindex fdump-rtl-bypass
12649 Dump after jump bypassing and control flow optimizations.
12651 @item -fdump-rtl-combine
12652 @opindex fdump-rtl-combine
12653 Dump after the RTL instruction combination pass.
12655 @item -fdump-rtl-compgotos
12656 @opindex fdump-rtl-compgotos
12657 Dump after duplicating the computed gotos.
12659 @item -fdump-rtl-ce1
12660 @itemx -fdump-rtl-ce2
12661 @itemx -fdump-rtl-ce3
12662 @opindex fdump-rtl-ce1
12663 @opindex fdump-rtl-ce2
12664 @opindex fdump-rtl-ce3
12665 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12666 @option{-fdump-rtl-ce3} enable dumping after the three
12667 if conversion passes.
12669 @item -fdump-rtl-cprop_hardreg
12670 @opindex fdump-rtl-cprop_hardreg
12671 Dump after hard register copy propagation.
12673 @item -fdump-rtl-csa
12674 @opindex fdump-rtl-csa
12675 Dump after combining stack adjustments.
12677 @item -fdump-rtl-cse1
12678 @itemx -fdump-rtl-cse2
12679 @opindex fdump-rtl-cse1
12680 @opindex fdump-rtl-cse2
12681 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12682 the two common subexpression elimination passes.
12684 @item -fdump-rtl-dce
12685 @opindex fdump-rtl-dce
12686 Dump after the standalone dead code elimination passes.
12688 @item -fdump-rtl-dbr
12689 @opindex fdump-rtl-dbr
12690 Dump after delayed branch scheduling.
12692 @item -fdump-rtl-dce1
12693 @itemx -fdump-rtl-dce2
12694 @opindex fdump-rtl-dce1
12695 @opindex fdump-rtl-dce2
12696 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12697 the two dead store elimination passes.
12699 @item -fdump-rtl-eh
12700 @opindex fdump-rtl-eh
12701 Dump after finalization of EH handling code.
12703 @item -fdump-rtl-eh_ranges
12704 @opindex fdump-rtl-eh_ranges
12705 Dump after conversion of EH handling range regions.
12707 @item -fdump-rtl-expand
12708 @opindex fdump-rtl-expand
12709 Dump after RTL generation.
12711 @item -fdump-rtl-fwprop1
12712 @itemx -fdump-rtl-fwprop2
12713 @opindex fdump-rtl-fwprop1
12714 @opindex fdump-rtl-fwprop2
12715 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12716 dumping after the two forward propagation passes.
12718 @item -fdump-rtl-gcse1
12719 @itemx -fdump-rtl-gcse2
12720 @opindex fdump-rtl-gcse1
12721 @opindex fdump-rtl-gcse2
12722 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12723 after global common subexpression elimination.
12725 @item -fdump-rtl-init-regs
12726 @opindex fdump-rtl-init-regs
12727 Dump after the initialization of the registers.
12729 @item -fdump-rtl-initvals
12730 @opindex fdump-rtl-initvals
12731 Dump after the computation of the initial value sets.
12733 @item -fdump-rtl-into_cfglayout
12734 @opindex fdump-rtl-into_cfglayout
12735 Dump after converting to cfglayout mode.
12737 @item -fdump-rtl-ira
12738 @opindex fdump-rtl-ira
12739 Dump after iterated register allocation.
12741 @item -fdump-rtl-jump
12742 @opindex fdump-rtl-jump
12743 Dump after the second jump optimization.
12745 @item -fdump-rtl-loop2
12746 @opindex fdump-rtl-loop2
12747 @option{-fdump-rtl-loop2} enables dumping after the rtl
12748 loop optimization passes.
12750 @item -fdump-rtl-mach
12751 @opindex fdump-rtl-mach
12752 Dump after performing the machine dependent reorganization pass, if that
12753 pass exists.
12755 @item -fdump-rtl-mode_sw
12756 @opindex fdump-rtl-mode_sw
12757 Dump after removing redundant mode switches.
12759 @item -fdump-rtl-rnreg
12760 @opindex fdump-rtl-rnreg
12761 Dump after register renumbering.
12763 @item -fdump-rtl-outof_cfglayout
12764 @opindex fdump-rtl-outof_cfglayout
12765 Dump after converting from cfglayout mode.
12767 @item -fdump-rtl-peephole2
12768 @opindex fdump-rtl-peephole2
12769 Dump after the peephole pass.
12771 @item -fdump-rtl-postreload
12772 @opindex fdump-rtl-postreload
12773 Dump after post-reload optimizations.
12775 @item -fdump-rtl-pro_and_epilogue
12776 @opindex fdump-rtl-pro_and_epilogue
12777 Dump after generating the function prologues and epilogues.
12779 @item -fdump-rtl-sched1
12780 @itemx -fdump-rtl-sched2
12781 @opindex fdump-rtl-sched1
12782 @opindex fdump-rtl-sched2
12783 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12784 after the basic block scheduling passes.
12786 @item -fdump-rtl-ree
12787 @opindex fdump-rtl-ree
12788 Dump after sign/zero extension elimination.
12790 @item -fdump-rtl-seqabstr
12791 @opindex fdump-rtl-seqabstr
12792 Dump after common sequence discovery.
12794 @item -fdump-rtl-shorten
12795 @opindex fdump-rtl-shorten
12796 Dump after shortening branches.
12798 @item -fdump-rtl-sibling
12799 @opindex fdump-rtl-sibling
12800 Dump after sibling call optimizations.
12802 @item -fdump-rtl-split1
12803 @itemx -fdump-rtl-split2
12804 @itemx -fdump-rtl-split3
12805 @itemx -fdump-rtl-split4
12806 @itemx -fdump-rtl-split5
12807 @opindex fdump-rtl-split1
12808 @opindex fdump-rtl-split2
12809 @opindex fdump-rtl-split3
12810 @opindex fdump-rtl-split4
12811 @opindex fdump-rtl-split5
12812 These options enable dumping after five rounds of
12813 instruction splitting.
12815 @item -fdump-rtl-sms
12816 @opindex fdump-rtl-sms
12817 Dump after modulo scheduling.  This pass is only run on some
12818 architectures.
12820 @item -fdump-rtl-stack
12821 @opindex fdump-rtl-stack
12822 Dump after conversion from GCC's ``flat register file'' registers to the
12823 x87's stack-like registers.  This pass is only run on x86 variants.
12825 @item -fdump-rtl-subreg1
12826 @itemx -fdump-rtl-subreg2
12827 @opindex fdump-rtl-subreg1
12828 @opindex fdump-rtl-subreg2
12829 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12830 the two subreg expansion passes.
12832 @item -fdump-rtl-unshare
12833 @opindex fdump-rtl-unshare
12834 Dump after all rtl has been unshared.
12836 @item -fdump-rtl-vartrack
12837 @opindex fdump-rtl-vartrack
12838 Dump after variable tracking.
12840 @item -fdump-rtl-vregs
12841 @opindex fdump-rtl-vregs
12842 Dump after converting virtual registers to hard registers.
12844 @item -fdump-rtl-web
12845 @opindex fdump-rtl-web
12846 Dump after live range splitting.
12848 @item -fdump-rtl-regclass
12849 @itemx -fdump-rtl-subregs_of_mode_init
12850 @itemx -fdump-rtl-subregs_of_mode_finish
12851 @itemx -fdump-rtl-dfinit
12852 @itemx -fdump-rtl-dfinish
12853 @opindex fdump-rtl-regclass
12854 @opindex fdump-rtl-subregs_of_mode_init
12855 @opindex fdump-rtl-subregs_of_mode_finish
12856 @opindex fdump-rtl-dfinit
12857 @opindex fdump-rtl-dfinish
12858 These dumps are defined but always produce empty files.
12860 @item -da
12861 @itemx -fdump-rtl-all
12862 @opindex da
12863 @opindex fdump-rtl-all
12864 Produce all the dumps listed above.
12866 @item -dA
12867 @opindex dA
12868 Annotate the assembler output with miscellaneous debugging information.
12870 @item -dD
12871 @opindex dD
12872 Dump all macro definitions, at the end of preprocessing, in addition to
12873 normal output.
12875 @item -dH
12876 @opindex dH
12877 Produce a core dump whenever an error occurs.
12879 @item -dp
12880 @opindex dp
12881 Annotate the assembler output with a comment indicating which
12882 pattern and alternative is used.  The length of each instruction is
12883 also printed.
12885 @item -dP
12886 @opindex dP
12887 Dump the RTL in the assembler output as a comment before each instruction.
12888 Also turns on @option{-dp} annotation.
12890 @item -dx
12891 @opindex dx
12892 Just generate RTL for a function instead of compiling it.  Usually used
12893 with @option{-fdump-rtl-expand}.
12894 @end table
12896 @item -fdump-noaddr
12897 @opindex fdump-noaddr
12898 When doing debugging dumps, suppress address output.  This makes it more
12899 feasible to use diff on debugging dumps for compiler invocations with
12900 different compiler binaries and/or different
12901 text / bss / data / heap / stack / dso start locations.
12903 @item -freport-bug
12904 @opindex freport-bug
12905 Collect and dump debug information into a temporary file if an
12906 internal compiler error (ICE) occurs.
12908 @item -fdump-unnumbered
12909 @opindex fdump-unnumbered
12910 When doing debugging dumps, suppress instruction numbers and address output.
12911 This makes it more feasible to use diff on debugging dumps for compiler
12912 invocations with different options, in particular with and without
12913 @option{-g}.
12915 @item -fdump-unnumbered-links
12916 @opindex fdump-unnumbered-links
12917 When doing debugging dumps (see @option{-d} option above), suppress
12918 instruction numbers for the links to the previous and next instructions
12919 in a sequence.
12921 @item -fdump-translation-unit @r{(C++ only)}
12922 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
12923 @opindex fdump-translation-unit
12924 Dump a representation of the tree structure for the entire translation
12925 unit to a file.  The file name is made by appending @file{.tu} to the
12926 source file name, and the file is created in the same directory as the
12927 output file.  If the @samp{-@var{options}} form is used, @var{options}
12928 controls the details of the dump as described for the
12929 @option{-fdump-tree} options.
12931 @item -fdump-class-hierarchy @r{(C++ only)}
12932 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
12933 @opindex fdump-class-hierarchy
12934 Dump a representation of each class's hierarchy and virtual function
12935 table layout to a file.  The file name is made by appending
12936 @file{.class} to the source file name, and the file is created in the
12937 same directory as the output file.  If the @samp{-@var{options}} form
12938 is used, @var{options} controls the details of the dump as described
12939 for the @option{-fdump-tree} options.
12941 @item -fdump-ipa-@var{switch}
12942 @opindex fdump-ipa
12943 Control the dumping at various stages of inter-procedural analysis
12944 language tree to a file.  The file name is generated by appending a
12945 switch specific suffix to the source file name, and the file is created
12946 in the same directory as the output file.  The following dumps are
12947 possible:
12949 @table @samp
12950 @item all
12951 Enables all inter-procedural analysis dumps.
12953 @item cgraph
12954 Dumps information about call-graph optimization, unused function removal,
12955 and inlining decisions.
12957 @item inline
12958 Dump after function inlining.
12960 @end table
12962 @item -fdump-passes
12963 @opindex fdump-passes
12964 Print on @file{stderr} the list of optimization passes that are turned
12965 on and off by the current command-line options.
12967 @item -fdump-statistics-@var{option}
12968 @opindex fdump-statistics
12969 Enable and control dumping of pass statistics in a separate file.  The
12970 file name is generated by appending a suffix ending in
12971 @samp{.statistics} to the source file name, and the file is created in
12972 the same directory as the output file.  If the @samp{-@var{option}}
12973 form is used, @samp{-stats} causes counters to be summed over the
12974 whole compilation unit while @samp{-details} dumps every event as
12975 the passes generate them.  The default with no option is to sum
12976 counters for each function compiled.
12978 @item -fdump-tree-all
12979 @itemx -fdump-tree-@var{switch}
12980 @itemx -fdump-tree-@var{switch}-@var{options}
12981 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
12982 @opindex fdump-tree-all
12983 @opindex fdump-tree
12984 Control the dumping at various stages of processing the intermediate
12985 language tree to a file.  The file name is generated by appending a
12986 switch-specific suffix to the source file name, and the file is
12987 created in the same directory as the output file. In case of
12988 @option{=@var{filename}} option, the dump is output on the given file
12989 instead of the auto named dump files.  If the @samp{-@var{options}}
12990 form is used, @var{options} is a list of @samp{-} separated options
12991 which control the details of the dump.  Not all options are applicable
12992 to all dumps; those that are not meaningful are ignored.  The
12993 following options are available
12995 @table @samp
12996 @item address
12997 Print the address of each node.  Usually this is not meaningful as it
12998 changes according to the environment and source file.  Its primary use
12999 is for tying up a dump file with a debug environment.
13000 @item asmname
13001 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13002 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13003 use working backward from mangled names in the assembly file.
13004 @item slim
13005 When dumping front-end intermediate representations, inhibit dumping
13006 of members of a scope or body of a function merely because that scope
13007 has been reached.  Only dump such items when they are directly reachable
13008 by some other path.
13010 When dumping pretty-printed trees, this option inhibits dumping the
13011 bodies of control structures.
13013 When dumping RTL, print the RTL in slim (condensed) form instead of
13014 the default LISP-like representation.
13015 @item raw
13016 Print a raw representation of the tree.  By default, trees are
13017 pretty-printed into a C-like representation.
13018 @item details
13019 Enable more detailed dumps (not honored by every dump option). Also
13020 include information from the optimization passes.
13021 @item stats
13022 Enable dumping various statistics about the pass (not honored by every dump
13023 option).
13024 @item blocks
13025 Enable showing basic block boundaries (disabled in raw dumps).
13026 @item graph
13027 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13028 dump a representation of the control flow graph suitable for viewing with
13029 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13030 the file is pretty-printed as a subgraph, so that GraphViz can render them
13031 all in a single plot.
13033 This option currently only works for RTL dumps, and the RTL is always
13034 dumped in slim form.
13035 @item vops
13036 Enable showing virtual operands for every statement.
13037 @item lineno
13038 Enable showing line numbers for statements.
13039 @item uid
13040 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13041 @item verbose
13042 Enable showing the tree dump for each statement.
13043 @item eh
13044 Enable showing the EH region number holding each statement.
13045 @item scev
13046 Enable showing scalar evolution analysis details.
13047 @item optimized
13048 Enable showing optimization information (only available in certain
13049 passes).
13050 @item missed
13051 Enable showing missed optimization information (only available in certain
13052 passes).
13053 @item note
13054 Enable other detailed optimization information (only available in
13055 certain passes).
13056 @item =@var{filename}
13057 Instead of an auto named dump file, output into the given file
13058 name. The file names @file{stdout} and @file{stderr} are treated
13059 specially and are considered already open standard streams. For
13060 example,
13062 @smallexample
13063 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13064      -fdump-tree-pre=/dev/stderr file.c
13065 @end smallexample
13067 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13068 output on to @file{stderr}. If two conflicting dump filenames are
13069 given for the same pass, then the latter option overrides the earlier
13070 one.
13072 @item all
13073 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13074 and @option{lineno}.
13076 @item optall
13077 Turn on all optimization options, i.e., @option{optimized},
13078 @option{missed}, and @option{note}.
13079 @end table
13081 To determine what tree dumps are available or find the dump for a pass
13082 of interest follow the steps below.
13084 @enumerate
13085 @item
13086 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13087 look for a code that corresponds to the pass you are interested in.
13088 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13089 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13090 The number at the end distinguishes distinct invocations of the same pass.
13091 @item
13092 To enable the creation of the dump file, append the pass code to
13093 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13094 to enable the dump from the Early Value Range Propagation pass, invoke
13095 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13096 specify the name of the dump file.  If you don't specify one, GCC
13097 creates as described below.
13098 @item
13099 Find the pass dump in a file whose name is composed of three components
13100 separated by a period: the name of the source file GCC was invoked to
13101 compile, a numeric suffix indicating the pass number followed by the
13102 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13103 and finally the pass code.  For example, the Early VRP pass dump might
13104 be in a file named @file{myfile.c.038t.evrp} in the current working
13105 directory.  Note that the numeric codes are not stable and may change
13106 from one version of GCC to another.
13107 @end enumerate
13109 @item -fopt-info
13110 @itemx -fopt-info-@var{options}
13111 @itemx -fopt-info-@var{options}=@var{filename}
13112 @opindex fopt-info
13113 Controls optimization dumps from various optimization passes. If the
13114 @samp{-@var{options}} form is used, @var{options} is a list of
13115 @samp{-} separated option keywords to select the dump details and
13116 optimizations.  
13118 The @var{options} can be divided into two groups: options describing the
13119 verbosity of the dump, and options describing which optimizations
13120 should be included. The options from both the groups can be freely
13121 mixed as they are non-overlapping. However, in case of any conflicts,
13122 the later options override the earlier options on the command
13123 line. 
13125 The following options control the dump verbosity:
13127 @table @samp
13128 @item optimized
13129 Print information when an optimization is successfully applied. It is
13130 up to a pass to decide which information is relevant. For example, the
13131 vectorizer passes print the source location of loops which are
13132 successfully vectorized.
13133 @item missed
13134 Print information about missed optimizations. Individual passes
13135 control which information to include in the output. 
13136 @item note
13137 Print verbose information about optimizations, such as certain
13138 transformations, more detailed messages about decisions etc.
13139 @item all
13140 Print detailed optimization information. This includes
13141 @samp{optimized}, @samp{missed}, and @samp{note}.
13142 @end table
13144 One or more of the following option keywords can be used to describe a
13145 group of optimizations:
13147 @table @samp
13148 @item ipa
13149 Enable dumps from all interprocedural optimizations.
13150 @item loop
13151 Enable dumps from all loop optimizations.
13152 @item inline
13153 Enable dumps from all inlining optimizations.
13154 @item vec
13155 Enable dumps from all vectorization optimizations.
13156 @item optall
13157 Enable dumps from all optimizations. This is a superset of
13158 the optimization groups listed above.
13159 @end table
13161 If @var{options} is
13162 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13163 info about successful optimizations from all the passes.  
13165 If the @var{filename} is provided, then the dumps from all the
13166 applicable optimizations are concatenated into the @var{filename}.
13167 Otherwise the dump is output onto @file{stderr}. Though multiple
13168 @option{-fopt-info} options are accepted, only one of them can include
13169 a @var{filename}. If other filenames are provided then all but the
13170 first such option are ignored.
13172 Note that the output @var{filename} is overwritten
13173 in case of multiple translation units. If a combined output from
13174 multiple translation units is desired, @file{stderr} should be used
13175 instead.
13177 In the following example, the optimization info is output to
13178 @file{stderr}:
13180 @smallexample
13181 gcc -O3 -fopt-info
13182 @end smallexample
13184 This example:
13185 @smallexample
13186 gcc -O3 -fopt-info-missed=missed.all
13187 @end smallexample
13189 @noindent
13190 outputs missed optimization report from all the passes into
13191 @file{missed.all}, and this one:
13193 @smallexample
13194 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13195 @end smallexample
13197 @noindent
13198 prints information about missed optimization opportunities from
13199 vectorization passes on @file{stderr}.  
13200 Note that @option{-fopt-info-vec-missed} is equivalent to 
13201 @option{-fopt-info-missed-vec}.
13203 As another example,
13204 @smallexample
13205 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13206 @end smallexample
13208 @noindent
13209 outputs information about missed optimizations as well as
13210 optimized locations from all the inlining passes into
13211 @file{inline.txt}.
13213 Finally, consider:
13215 @smallexample
13216 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13217 @end smallexample
13219 @noindent
13220 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13221 in conflict since only one output file is allowed. In this case, only
13222 the first option takes effect and the subsequent options are
13223 ignored. Thus only @file{vec.miss} is produced which contains
13224 dumps from the vectorizer about missed opportunities.
13226 @item -fsched-verbose=@var{n}
13227 @opindex fsched-verbose
13228 On targets that use instruction scheduling, this option controls the
13229 amount of debugging output the scheduler prints to the dump files.
13231 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13232 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13233 For @var{n} greater than one, it also output basic block probabilities,
13234 detailed ready list information and unit/insn info.  For @var{n} greater
13235 than two, it includes RTL at abort point, control-flow and regions info.
13236 And for @var{n} over four, @option{-fsched-verbose} also includes
13237 dependence info.
13241 @item -fenable-@var{kind}-@var{pass}
13242 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13243 @opindex fdisable-
13244 @opindex fenable-
13246 This is a set of options that are used to explicitly disable/enable
13247 optimization passes.  These options are intended for use for debugging GCC.
13248 Compiler users should use regular options for enabling/disabling
13249 passes instead.
13251 @table @gcctabopt
13253 @item -fdisable-ipa-@var{pass}
13254 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13255 statically invoked in the compiler multiple times, the pass name should be
13256 appended with a sequential number starting from 1.
13258 @item -fdisable-rtl-@var{pass}
13259 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13260 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13261 statically invoked in the compiler multiple times, the pass name should be
13262 appended with a sequential number starting from 1.  @var{range-list} is a 
13263 comma-separated list of function ranges or assembler names.  Each range is a number
13264 pair separated by a colon.  The range is inclusive in both ends.  If the range
13265 is trivial, the number pair can be simplified as a single number.  If the
13266 function's call graph node's @var{uid} falls within one of the specified ranges,
13267 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13268 function header of a dump file, and the pass names can be dumped by using
13269 option @option{-fdump-passes}.
13271 @item -fdisable-tree-@var{pass}
13272 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13273 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13274 option arguments.
13276 @item -fenable-ipa-@var{pass}
13277 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13278 statically invoked in the compiler multiple times, the pass name should be
13279 appended with a sequential number starting from 1.
13281 @item -fenable-rtl-@var{pass}
13282 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13283 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13284 description and examples.
13286 @item -fenable-tree-@var{pass}
13287 @itemx -fenable-tree-@var{pass}=@var{range-list}
13288 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13289 of option arguments.
13291 @end table
13293 Here are some examples showing uses of these options.
13295 @smallexample
13297 # disable ccp1 for all functions
13298    -fdisable-tree-ccp1
13299 # disable complete unroll for function whose cgraph node uid is 1
13300    -fenable-tree-cunroll=1
13301 # disable gcse2 for functions at the following ranges [1,1],
13302 # [300,400], and [400,1000]
13303 # disable gcse2 for functions foo and foo2
13304    -fdisable-rtl-gcse2=foo,foo2
13305 # disable early inlining
13306    -fdisable-tree-einline
13307 # disable ipa inlining
13308    -fdisable-ipa-inline
13309 # enable tree full unroll
13310    -fenable-tree-unroll
13312 @end smallexample
13314 @item -fchecking
13315 @itemx -fchecking=@var{n}
13316 @opindex fchecking
13317 @opindex fno-checking
13318 Enable internal consistency checking.  The default depends on
13319 the compiler configuration.  @option{-fchecking=2} enables further
13320 internal consistency checking that might affect code generation.
13322 @item -frandom-seed=@var{string}
13323 @opindex frandom-seed
13324 This option provides a seed that GCC uses in place of
13325 random numbers in generating certain symbol names
13326 that have to be different in every compiled file.  It is also used to
13327 place unique stamps in coverage data files and the object files that
13328 produce them.  You can use the @option{-frandom-seed} option to produce
13329 reproducibly identical object files.
13331 The @var{string} can either be a number (decimal, octal or hex) or an
13332 arbitrary string (in which case it's converted to a number by
13333 computing CRC32).
13335 The @var{string} should be different for every file you compile.
13337 @item -save-temps
13338 @itemx -save-temps=cwd
13339 @opindex save-temps
13340 Store the usual ``temporary'' intermediate files permanently; place them
13341 in the current directory and name them based on the source file.  Thus,
13342 compiling @file{foo.c} with @option{-c -save-temps} produces files
13343 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13344 preprocessed @file{foo.i} output file even though the compiler now
13345 normally uses an integrated preprocessor.
13347 When used in combination with the @option{-x} command-line option,
13348 @option{-save-temps} is sensible enough to avoid over writing an
13349 input source file with the same extension as an intermediate file.
13350 The corresponding intermediate file may be obtained by renaming the
13351 source file before using @option{-save-temps}.
13353 If you invoke GCC in parallel, compiling several different source
13354 files that share a common base name in different subdirectories or the
13355 same source file compiled for multiple output destinations, it is
13356 likely that the different parallel compilers will interfere with each
13357 other, and overwrite the temporary files.  For instance:
13359 @smallexample
13360 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13361 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13362 @end smallexample
13364 may result in @file{foo.i} and @file{foo.o} being written to
13365 simultaneously by both compilers.
13367 @item -save-temps=obj
13368 @opindex save-temps=obj
13369 Store the usual ``temporary'' intermediate files permanently.  If the
13370 @option{-o} option is used, the temporary files are based on the
13371 object file.  If the @option{-o} option is not used, the
13372 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13374 For example:
13376 @smallexample
13377 gcc -save-temps=obj -c foo.c
13378 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13379 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13380 @end smallexample
13382 @noindent
13383 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13384 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13385 @file{dir2/yfoobar.o}.
13387 @item -time@r{[}=@var{file}@r{]}
13388 @opindex time
13389 Report the CPU time taken by each subprocess in the compilation
13390 sequence.  For C source files, this is the compiler proper and assembler
13391 (plus the linker if linking is done).
13393 Without the specification of an output file, the output looks like this:
13395 @smallexample
13396 # cc1 0.12 0.01
13397 # as 0.00 0.01
13398 @end smallexample
13400 The first number on each line is the ``user time'', that is time spent
13401 executing the program itself.  The second number is ``system time'',
13402 time spent executing operating system routines on behalf of the program.
13403 Both numbers are in seconds.
13405 With the specification of an output file, the output is appended to the
13406 named file, and it looks like this:
13408 @smallexample
13409 0.12 0.01 cc1 @var{options}
13410 0.00 0.01 as @var{options}
13411 @end smallexample
13413 The ``user time'' and the ``system time'' are moved before the program
13414 name, and the options passed to the program are displayed, so that one
13415 can later tell what file was being compiled, and with which options.
13417 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13418 @opindex fdump-final-insns
13419 Dump the final internal representation (RTL) to @var{file}.  If the
13420 optional argument is omitted (or if @var{file} is @code{.}), the name
13421 of the dump file is determined by appending @code{.gkd} to the
13422 compilation output file name.
13424 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13425 @opindex fcompare-debug
13426 @opindex fno-compare-debug
13427 If no error occurs during compilation, run the compiler a second time,
13428 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13429 passed to the second compilation.  Dump the final internal
13430 representation in both compilations, and print an error if they differ.
13432 If the equal sign is omitted, the default @option{-gtoggle} is used.
13434 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13435 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13436 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13437 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13438 is used.
13440 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13441 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13442 of the final representation and the second compilation, preventing even
13443 @env{GCC_COMPARE_DEBUG} from taking effect.
13445 To verify full coverage during @option{-fcompare-debug} testing, set
13446 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13447 which GCC rejects as an invalid option in any actual compilation
13448 (rather than preprocessing, assembly or linking).  To get just a
13449 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13450 not overridden} will do.
13452 @item -fcompare-debug-second
13453 @opindex fcompare-debug-second
13454 This option is implicitly passed to the compiler for the second
13455 compilation requested by @option{-fcompare-debug}, along with options to
13456 silence warnings, and omitting other options that would cause
13457 side-effect compiler outputs to files or to the standard output.  Dump
13458 files and preserved temporary files are renamed so as to contain the
13459 @code{.gk} additional extension during the second compilation, to avoid
13460 overwriting those generated by the first.
13462 When this option is passed to the compiler driver, it causes the
13463 @emph{first} compilation to be skipped, which makes it useful for little
13464 other than debugging the compiler proper.
13466 @item -gtoggle
13467 @opindex gtoggle
13468 Turn off generation of debug info, if leaving out this option
13469 generates it, or turn it on at level 2 otherwise.  The position of this
13470 argument in the command line does not matter; it takes effect after all
13471 other options are processed, and it does so only once, no matter how
13472 many times it is given.  This is mainly intended to be used with
13473 @option{-fcompare-debug}.
13475 @item -fvar-tracking-assignments-toggle
13476 @opindex fvar-tracking-assignments-toggle
13477 @opindex fno-var-tracking-assignments-toggle
13478 Toggle @option{-fvar-tracking-assignments}, in the same way that
13479 @option{-gtoggle} toggles @option{-g}.
13481 @item -Q
13482 @opindex Q
13483 Makes the compiler print out each function name as it is compiled, and
13484 print some statistics about each pass when it finishes.
13486 @item -ftime-report
13487 @opindex ftime-report
13488 Makes the compiler print some statistics about the time consumed by each
13489 pass when it finishes.
13491 @item -ftime-report-details
13492 @opindex ftime-report-details
13493 Record the time consumed by infrastructure parts separately for each pass.
13495 @item -fira-verbose=@var{n}
13496 @opindex fira-verbose
13497 Control the verbosity of the dump file for the integrated register allocator.
13498 The default value is 5.  If the value @var{n} is greater or equal to 10,
13499 the dump output is sent to stderr using the same format as @var{n} minus 10.
13501 @item -flto-report
13502 @opindex flto-report
13503 Prints a report with internal details on the workings of the link-time
13504 optimizer.  The contents of this report vary from version to version.
13505 It is meant to be useful to GCC developers when processing object
13506 files in LTO mode (via @option{-flto}).
13508 Disabled by default.
13510 @item -flto-report-wpa
13511 @opindex flto-report-wpa
13512 Like @option{-flto-report}, but only print for the WPA phase of Link
13513 Time Optimization.
13515 @item -fmem-report
13516 @opindex fmem-report
13517 Makes the compiler print some statistics about permanent memory
13518 allocation when it finishes.
13520 @item -fmem-report-wpa
13521 @opindex fmem-report-wpa
13522 Makes the compiler print some statistics about permanent memory
13523 allocation for the WPA phase only.
13525 @item -fpre-ipa-mem-report
13526 @opindex fpre-ipa-mem-report
13527 @item -fpost-ipa-mem-report
13528 @opindex fpost-ipa-mem-report
13529 Makes the compiler print some statistics about permanent memory
13530 allocation before or after interprocedural optimization.
13532 @item -fprofile-report
13533 @opindex fprofile-report
13534 Makes the compiler print some statistics about consistency of the
13535 (estimated) profile and effect of individual passes.
13537 @item -fstack-usage
13538 @opindex fstack-usage
13539 Makes the compiler output stack usage information for the program, on a
13540 per-function basis.  The filename for the dump is made by appending
13541 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13542 the output file, if explicitly specified and it is not an executable,
13543 otherwise it is the basename of the source file.  An entry is made up
13544 of three fields:
13546 @itemize
13547 @item
13548 The name of the function.
13549 @item
13550 A number of bytes.
13551 @item
13552 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13553 @end itemize
13555 The qualifier @code{static} means that the function manipulates the stack
13556 statically: a fixed number of bytes are allocated for the frame on function
13557 entry and released on function exit; no stack adjustments are otherwise made
13558 in the function.  The second field is this fixed number of bytes.
13560 The qualifier @code{dynamic} means that the function manipulates the stack
13561 dynamically: in addition to the static allocation described above, stack
13562 adjustments are made in the body of the function, for example to push/pop
13563 arguments around function calls.  If the qualifier @code{bounded} is also
13564 present, the amount of these adjustments is bounded at compile time and
13565 the second field is an upper bound of the total amount of stack used by
13566 the function.  If it is not present, the amount of these adjustments is
13567 not bounded at compile time and the second field only represents the
13568 bounded part.
13570 @item -fstats
13571 @opindex fstats
13572 Emit statistics about front-end processing at the end of the compilation.
13573 This option is supported only by the C++ front end, and
13574 the information is generally only useful to the G++ development team.
13576 @item -fdbg-cnt-list
13577 @opindex fdbg-cnt-list
13578 Print the name and the counter upper bound for all debug counters.
13581 @item -fdbg-cnt=@var{counter-value-list}
13582 @opindex fdbg-cnt
13583 Set the internal debug counter upper bound.  @var{counter-value-list}
13584 is a comma-separated list of @var{name}:@var{value} pairs
13585 which sets the upper bound of each debug counter @var{name} to @var{value}.
13586 All debug counters have the initial upper bound of @code{UINT_MAX};
13587 thus @code{dbg_cnt} returns true always unless the upper bound
13588 is set by this option.
13589 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13590 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13592 @item -print-file-name=@var{library}
13593 @opindex print-file-name
13594 Print the full absolute name of the library file @var{library} that
13595 would be used when linking---and don't do anything else.  With this
13596 option, GCC does not compile or link anything; it just prints the
13597 file name.
13599 @item -print-multi-directory
13600 @opindex print-multi-directory
13601 Print the directory name corresponding to the multilib selected by any
13602 other switches present in the command line.  This directory is supposed
13603 to exist in @env{GCC_EXEC_PREFIX}.
13605 @item -print-multi-lib
13606 @opindex print-multi-lib
13607 Print the mapping from multilib directory names to compiler switches
13608 that enable them.  The directory name is separated from the switches by
13609 @samp{;}, and each switch starts with an @samp{@@} instead of the
13610 @samp{-}, without spaces between multiple switches.  This is supposed to
13611 ease shell processing.
13613 @item -print-multi-os-directory
13614 @opindex print-multi-os-directory
13615 Print the path to OS libraries for the selected
13616 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13617 present in the @file{lib} subdirectory and no multilibs are used, this is
13618 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13619 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13620 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13621 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13623 @item -print-multiarch
13624 @opindex print-multiarch
13625 Print the path to OS libraries for the selected multiarch,
13626 relative to some @file{lib} subdirectory.
13628 @item -print-prog-name=@var{program}
13629 @opindex print-prog-name
13630 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13632 @item -print-libgcc-file-name
13633 @opindex print-libgcc-file-name
13634 Same as @option{-print-file-name=libgcc.a}.
13636 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13637 but you do want to link with @file{libgcc.a}.  You can do:
13639 @smallexample
13640 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13641 @end smallexample
13643 @item -print-search-dirs
13644 @opindex print-search-dirs
13645 Print the name of the configured installation directory and a list of
13646 program and library directories @command{gcc} searches---and don't do anything else.
13648 This is useful when @command{gcc} prints the error message
13649 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13650 To resolve this you either need to put @file{cpp0} and the other compiler
13651 components where @command{gcc} expects to find them, or you can set the environment
13652 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13653 Don't forget the trailing @samp{/}.
13654 @xref{Environment Variables}.
13656 @item -print-sysroot
13657 @opindex print-sysroot
13658 Print the target sysroot directory that is used during
13659 compilation.  This is the target sysroot specified either at configure
13660 time or using the @option{--sysroot} option, possibly with an extra
13661 suffix that depends on compilation options.  If no target sysroot is
13662 specified, the option prints nothing.
13664 @item -print-sysroot-headers-suffix
13665 @opindex print-sysroot-headers-suffix
13666 Print the suffix added to the target sysroot when searching for
13667 headers, or give an error if the compiler is not configured with such
13668 a suffix---and don't do anything else.
13670 @item -dumpmachine
13671 @opindex dumpmachine
13672 Print the compiler's target machine (for example,
13673 @samp{i686-pc-linux-gnu})---and don't do anything else.
13675 @item -dumpversion
13676 @opindex dumpversion
13677 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13678 anything else.  This is the compiler version used in filesystem paths,
13679 specs, can be depending on how the compiler has been configured just
13680 a single number (major version), two numbers separated by dot (major and
13681 minor version) or three numbers separated by dots (major, minor and patchlevel
13682 version).
13684 @item -dumpfullversion
13685 @opindex dumpfullversion
13686 Print the full compiler version, always 3 numbers separated by dots,
13687 major, minor and patchlevel version.
13689 @item -dumpspecs
13690 @opindex dumpspecs
13691 Print the compiler's built-in specs---and don't do anything else.  (This
13692 is used when GCC itself is being built.)  @xref{Spec Files}.
13693 @end table
13695 @node Submodel Options
13696 @section Machine-Dependent Options
13697 @cindex submodel options
13698 @cindex specifying hardware config
13699 @cindex hardware models and configurations, specifying
13700 @cindex target-dependent options
13701 @cindex machine-dependent options
13703 Each target machine supported by GCC can have its own options---for
13704 example, to allow you to compile for a particular processor variant or
13705 ABI, or to control optimizations specific to that machine.  By
13706 convention, the names of machine-specific options start with
13707 @samp{-m}.
13709 Some configurations of the compiler also support additional target-specific
13710 options, usually for compatibility with other compilers on the same
13711 platform.
13713 @c This list is ordered alphanumerically by subsection name.
13714 @c It should be the same order and spelling as these options are listed
13715 @c in Machine Dependent Options
13717 @menu
13718 * AArch64 Options::
13719 * Adapteva Epiphany Options::
13720 * ARC Options::
13721 * ARM Options::
13722 * AVR Options::
13723 * Blackfin Options::
13724 * C6X Options::
13725 * CRIS Options::
13726 * CR16 Options::
13727 * Darwin Options::
13728 * DEC Alpha Options::
13729 * FR30 Options::
13730 * FT32 Options::
13731 * FRV Options::
13732 * GNU/Linux Options::
13733 * H8/300 Options::
13734 * HPPA Options::
13735 * IA-64 Options::
13736 * LM32 Options::
13737 * M32C Options::
13738 * M32R/D Options::
13739 * M680x0 Options::
13740 * MCore Options::
13741 * MeP Options::
13742 * MicroBlaze Options::
13743 * MIPS Options::
13744 * MMIX Options::
13745 * MN10300 Options::
13746 * Moxie Options::
13747 * MSP430 Options::
13748 * NDS32 Options::
13749 * Nios II Options::
13750 * Nvidia PTX Options::
13751 * PDP-11 Options::
13752 * picoChip Options::
13753 * PowerPC Options::
13754 * RISC-V Options::
13755 * RL78 Options::
13756 * RS/6000 and PowerPC Options::
13757 * RX Options::
13758 * S/390 and zSeries Options::
13759 * Score Options::
13760 * SH Options::
13761 * Solaris 2 Options::
13762 * SPARC Options::
13763 * SPU Options::
13764 * System V Options::
13765 * TILE-Gx Options::
13766 * TILEPro Options::
13767 * V850 Options::
13768 * VAX Options::
13769 * Visium Options::
13770 * VMS Options::
13771 * VxWorks Options::
13772 * x86 Options::
13773 * x86 Windows Options::
13774 * Xstormy16 Options::
13775 * Xtensa Options::
13776 * zSeries Options::
13777 @end menu
13779 @node AArch64 Options
13780 @subsection AArch64 Options
13781 @cindex AArch64 Options
13783 These options are defined for AArch64 implementations:
13785 @table @gcctabopt
13787 @item -mabi=@var{name}
13788 @opindex mabi
13789 Generate code for the specified data model.  Permissible values
13790 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13791 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13792 but long int and pointers are 64 bits.
13794 The default depends on the specific target configuration.  Note that
13795 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13796 entire program with the same ABI, and link with a compatible set of libraries.
13798 @item -mbig-endian
13799 @opindex mbig-endian
13800 Generate big-endian code.  This is the default when GCC is configured for an
13801 @samp{aarch64_be-*-*} target.
13803 @item -mgeneral-regs-only
13804 @opindex mgeneral-regs-only
13805 Generate code which uses only the general-purpose registers.  This will prevent
13806 the compiler from using floating-point and Advanced SIMD registers but will not
13807 impose any restrictions on the assembler.
13809 @item -mlittle-endian
13810 @opindex mlittle-endian
13811 Generate little-endian code.  This is the default when GCC is configured for an
13812 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13814 @item -mcmodel=tiny
13815 @opindex mcmodel=tiny
13816 Generate code for the tiny code model.  The program and its statically defined
13817 symbols must be within 1MB of each other.  Programs can be statically or
13818 dynamically linked.
13820 @item -mcmodel=small
13821 @opindex mcmodel=small
13822 Generate code for the small code model.  The program and its statically defined
13823 symbols must be within 4GB of each other.  Programs can be statically or
13824 dynamically linked.  This is the default code model.
13826 @item -mcmodel=large
13827 @opindex mcmodel=large
13828 Generate code for the large code model.  This makes no assumptions about
13829 addresses and sizes of sections.  Programs can be statically linked only.
13831 @item -mstrict-align
13832 @opindex mstrict-align
13833 Avoid generating memory accesses that may not be aligned on a natural object
13834 boundary as described in the architecture specification.
13836 @item -momit-leaf-frame-pointer
13837 @itemx -mno-omit-leaf-frame-pointer
13838 @opindex momit-leaf-frame-pointer
13839 @opindex mno-omit-leaf-frame-pointer
13840 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13841 default.
13843 @item -mtls-dialect=desc
13844 @opindex mtls-dialect=desc
13845 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13846 of TLS variables.  This is the default.
13848 @item -mtls-dialect=traditional
13849 @opindex mtls-dialect=traditional
13850 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13851 of TLS variables.
13853 @item -mtls-size=@var{size}
13854 @opindex mtls-size
13855 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13856 This option requires binutils 2.26 or newer.
13858 @item -mfix-cortex-a53-835769
13859 @itemx -mno-fix-cortex-a53-835769
13860 @opindex mfix-cortex-a53-835769
13861 @opindex mno-fix-cortex-a53-835769
13862 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13863 This involves inserting a NOP instruction between memory instructions and
13864 64-bit integer multiply-accumulate instructions.
13866 @item -mfix-cortex-a53-843419
13867 @itemx -mno-fix-cortex-a53-843419
13868 @opindex mfix-cortex-a53-843419
13869 @opindex mno-fix-cortex-a53-843419
13870 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
13871 This erratum workaround is made at link time and this will only pass the
13872 corresponding flag to the linker.
13874 @item -mlow-precision-recip-sqrt
13875 @item -mno-low-precision-recip-sqrt
13876 @opindex mlow-precision-recip-sqrt
13877 @opindex mno-low-precision-recip-sqrt
13878 Enable or disable the reciprocal square root approximation.
13879 This option only has an effect if @option{-ffast-math} or
13880 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13881 precision of reciprocal square root results to about 16 bits for
13882 single precision and to 32 bits for double precision.
13884 @item -mlow-precision-sqrt
13885 @item -mno-low-precision-sqrt
13886 @opindex -mlow-precision-sqrt
13887 @opindex -mno-low-precision-sqrt
13888 Enable or disable the square root approximation.
13889 This option only has an effect if @option{-ffast-math} or
13890 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13891 precision of square root results to about 16 bits for
13892 single precision and to 32 bits for double precision.
13893 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
13895 @item -mlow-precision-div
13896 @item -mno-low-precision-div
13897 @opindex -mlow-precision-div
13898 @opindex -mno-low-precision-div
13899 Enable or disable the division approximation.
13900 This option only has an effect if @option{-ffast-math} or
13901 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13902 precision of division results to about 16 bits for
13903 single precision and to 32 bits for double precision.
13905 @item -march=@var{name}
13906 @opindex march
13907 Specify the name of the target architecture and, optionally, one or
13908 more feature modifiers.  This option has the form
13909 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
13911 The permissible values for @var{arch} are @samp{armv8-a},
13912 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
13914 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
13915 support for the ARMv8.3-A architecture extensions.
13917 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
13918 support for the ARMv8.2-A architecture extensions.
13920 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
13921 support for the ARMv8.1-A architecture extension.  In particular, it
13922 enables the @samp{+crc} and @samp{+lse} features.
13924 The value @samp{native} is available on native AArch64 GNU/Linux and
13925 causes the compiler to pick the architecture of the host system.  This
13926 option has no effect if the compiler is unable to recognize the
13927 architecture of the host system,
13929 The permissible values for @var{feature} are listed in the sub-section
13930 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13931 Feature Modifiers}.  Where conflicting feature modifiers are
13932 specified, the right-most feature is used.
13934 GCC uses @var{name} to determine what kind of instructions it can emit
13935 when generating assembly code.  If @option{-march} is specified
13936 without either of @option{-mtune} or @option{-mcpu} also being
13937 specified, the code is tuned to perform well across a range of target
13938 processors implementing the target architecture.
13940 @item -mtune=@var{name}
13941 @opindex mtune
13942 Specify the name of the target processor for which GCC should tune the
13943 performance of the code.  Permissible values for this option are:
13944 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
13945 @samp{cortex-a72}, @samp{cortex-a73}, @samp{exynos-m1}, @samp{falkor},
13946 @samp{qdf24xx}, @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
13947 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
13948 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
13949 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
13950 @samp{cortex-a73.cortex-a53}, @samp{native}.
13952 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
13953 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}
13954 specify that GCC should tune for a big.LITTLE system.
13956 Additionally on native AArch64 GNU/Linux systems the value
13957 @samp{native} tunes performance to the host system.  This option has no effect
13958 if the compiler is unable to recognize the processor of the host system.
13960 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
13961 are specified, the code is tuned to perform well across a range
13962 of target processors.
13964 This option cannot be suffixed by feature modifiers.
13966 @item -mcpu=@var{name}
13967 @opindex mcpu
13968 Specify the name of the target processor, optionally suffixed by one
13969 or more feature modifiers.  This option has the form
13970 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
13971 the permissible values for @var{cpu} are the same as those available
13972 for @option{-mtune}.  The permissible values for @var{feature} are
13973 documented in the sub-section on
13974 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13975 Feature Modifiers}.  Where conflicting feature modifiers are
13976 specified, the right-most feature is used.
13978 GCC uses @var{name} to determine what kind of instructions it can emit when
13979 generating assembly code (as if by @option{-march}) and to determine
13980 the target processor for which to tune for performance (as if
13981 by @option{-mtune}).  Where this option is used in conjunction
13982 with @option{-march} or @option{-mtune}, those options take precedence
13983 over the appropriate part of this option.
13985 @item -moverride=@var{string}
13986 @opindex moverride
13987 Override tuning decisions made by the back-end in response to a
13988 @option{-mtune=} switch.  The syntax, semantics, and accepted values
13989 for @var{string} in this option are not guaranteed to be consistent
13990 across releases.
13992 This option is only intended to be useful when developing GCC.
13994 @item -mpc-relative-literal-loads
13995 @opindex mpc-relative-literal-loads
13996 Enable PC-relative literal loads.  With this option literal pools are
13997 accessed using a single instruction and emitted after each function.  This
13998 limits the maximum size of functions to 1MB.  This is enabled by default for
13999 @option{-mcmodel=tiny}.
14001 @item -msign-return-address=@var{scope}
14002 @opindex msign-return-address
14003 Select the function scope on which return address signing will be applied.
14004 Permissible values are @samp{none}, which disables return address signing,
14005 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14006 functions, and @samp{all}, which enables pointer signing for all functions.  The
14007 default value is @samp{none}.
14009 @end table
14011 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14012 @anchor{aarch64-feature-modifiers}
14013 @cindex @option{-march} feature modifiers
14014 @cindex @option{-mcpu} feature modifiers
14015 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14016 the following and their inverses @option{no@var{feature}}:
14018 @table @samp
14019 @item crc
14020 Enable CRC extension.  This is on by default for
14021 @option{-march=armv8.1-a}.
14022 @item crypto
14023 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14024 instructions.
14025 @item fp
14026 Enable floating-point instructions.  This is on by default for all possible
14027 values for options @option{-march} and @option{-mcpu}.
14028 @item simd
14029 Enable Advanced SIMD instructions.  This also enables floating-point
14030 instructions.  This is on by default for all possible values for options
14031 @option{-march} and @option{-mcpu}.
14032 @item lse
14033 Enable Large System Extension instructions.  This is on by default for
14034 @option{-march=armv8.1-a}.
14035 @item fp16
14036 Enable FP16 extension.  This also enables floating-point instructions.
14038 @end table
14040 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14041 Conversely, @option{nofp} implies @option{nosimd}, which implies
14042 @option{nocrypto}.
14044 @node Adapteva Epiphany Options
14045 @subsection Adapteva Epiphany Options
14047 These @samp{-m} options are defined for Adapteva Epiphany:
14049 @table @gcctabopt
14050 @item -mhalf-reg-file
14051 @opindex mhalf-reg-file
14052 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14053 That allows code to run on hardware variants that lack these registers.
14055 @item -mprefer-short-insn-regs
14056 @opindex mprefer-short-insn-regs
14057 Preferentially allocate registers that allow short instruction generation.
14058 This can result in increased instruction count, so this may either reduce or
14059 increase overall code size.
14061 @item -mbranch-cost=@var{num}
14062 @opindex mbranch-cost
14063 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14064 This cost is only a heuristic and is not guaranteed to produce
14065 consistent results across releases.
14067 @item -mcmove
14068 @opindex mcmove
14069 Enable the generation of conditional moves.
14071 @item -mnops=@var{num}
14072 @opindex mnops
14073 Emit @var{num} NOPs before every other generated instruction.
14075 @item -mno-soft-cmpsf
14076 @opindex mno-soft-cmpsf
14077 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14078 and test the flags.  This is faster than a software comparison, but can
14079 get incorrect results in the presence of NaNs, or when two different small
14080 numbers are compared such that their difference is calculated as zero.
14081 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14082 software comparisons.
14084 @item -mstack-offset=@var{num}
14085 @opindex mstack-offset
14086 Set the offset between the top of the stack and the stack pointer.
14087 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14088 can be used by leaf functions without stack allocation.
14089 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14090 Note also that this option changes the ABI; compiling a program with a
14091 different stack offset than the libraries have been compiled with
14092 generally does not work.
14093 This option can be useful if you want to evaluate if a different stack
14094 offset would give you better code, but to actually use a different stack
14095 offset to build working programs, it is recommended to configure the
14096 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14098 @item -mno-round-nearest
14099 @opindex mno-round-nearest
14100 Make the scheduler assume that the rounding mode has been set to
14101 truncating.  The default is @option{-mround-nearest}.
14103 @item -mlong-calls
14104 @opindex mlong-calls
14105 If not otherwise specified by an attribute, assume all calls might be beyond
14106 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14107 function address into a register before performing a (otherwise direct) call.
14108 This is the default.
14110 @item -mshort-calls
14111 @opindex short-calls
14112 If not otherwise specified by an attribute, assume all direct calls are
14113 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14114 for direct calls.  The default is @option{-mlong-calls}.
14116 @item -msmall16
14117 @opindex msmall16
14118 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14119 apply to function addresses for which @option{-mlong-calls} semantics
14120 are in effect.
14122 @item -mfp-mode=@var{mode}
14123 @opindex mfp-mode
14124 Set the prevailing mode of the floating-point unit.
14125 This determines the floating-point mode that is provided and expected
14126 at function call and return time.  Making this mode match the mode you
14127 predominantly need at function start can make your programs smaller and
14128 faster by avoiding unnecessary mode switches.
14130 @var{mode} can be set to one the following values:
14132 @table @samp
14133 @item caller
14134 Any mode at function entry is valid, and retained or restored when
14135 the function returns, and when it calls other functions.
14136 This mode is useful for compiling libraries or other compilation units
14137 you might want to incorporate into different programs with different
14138 prevailing FPU modes, and the convenience of being able to use a single
14139 object file outweighs the size and speed overhead for any extra
14140 mode switching that might be needed, compared with what would be needed
14141 with a more specific choice of prevailing FPU mode.
14143 @item truncate
14144 This is the mode used for floating-point calculations with
14145 truncating (i.e.@: round towards zero) rounding mode.  That includes
14146 conversion from floating point to integer.
14148 @item round-nearest
14149 This is the mode used for floating-point calculations with
14150 round-to-nearest-or-even rounding mode.
14152 @item int
14153 This is the mode used to perform integer calculations in the FPU, e.g.@:
14154 integer multiply, or integer multiply-and-accumulate.
14155 @end table
14157 The default is @option{-mfp-mode=caller}
14159 @item -mnosplit-lohi
14160 @itemx -mno-postinc
14161 @itemx -mno-postmodify
14162 @opindex mnosplit-lohi
14163 @opindex mno-postinc
14164 @opindex mno-postmodify
14165 Code generation tweaks that disable, respectively, splitting of 32-bit
14166 loads, generation of post-increment addresses, and generation of
14167 post-modify addresses.  The defaults are @option{msplit-lohi},
14168 @option{-mpost-inc}, and @option{-mpost-modify}.
14170 @item -mnovect-double
14171 @opindex mno-vect-double
14172 Change the preferred SIMD mode to SImode.  The default is
14173 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14175 @item -max-vect-align=@var{num}
14176 @opindex max-vect-align
14177 The maximum alignment for SIMD vector mode types.
14178 @var{num} may be 4 or 8.  The default is 8.
14179 Note that this is an ABI change, even though many library function
14180 interfaces are unaffected if they don't use SIMD vector modes
14181 in places that affect size and/or alignment of relevant types.
14183 @item -msplit-vecmove-early
14184 @opindex msplit-vecmove-early
14185 Split vector moves into single word moves before reload.  In theory this
14186 can give better register allocation, but so far the reverse seems to be
14187 generally the case.
14189 @item -m1reg-@var{reg}
14190 @opindex m1reg-
14191 Specify a register to hold the constant @minus{}1, which makes loading small negative
14192 constants and certain bitmasks faster.
14193 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14194 which specify use of that register as a fixed register,
14195 and @samp{none}, which means that no register is used for this
14196 purpose.  The default is @option{-m1reg-none}.
14198 @end table
14200 @node ARC Options
14201 @subsection ARC Options
14202 @cindex ARC options
14204 The following options control the architecture variant for which code
14205 is being compiled:
14207 @c architecture variants
14208 @table @gcctabopt
14210 @item -mbarrel-shifter
14211 @opindex mbarrel-shifter
14212 Generate instructions supported by barrel shifter.  This is the default
14213 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14215 @item -mcpu=@var{cpu}
14216 @opindex mcpu
14217 Set architecture type, register usage, and instruction scheduling
14218 parameters for @var{cpu}.  There are also shortcut alias options
14219 available for backward compatibility and convenience.  Supported
14220 values for @var{cpu} are
14222 @table @samp
14223 @opindex mA6
14224 @opindex mARC600
14225 @item arc600
14226 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14228 @item arc601
14229 @opindex mARC601
14230 Compile for ARC601.  Alias: @option{-mARC601}.
14232 @item arc700
14233 @opindex mA7
14234 @opindex mARC700
14235 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14236 This is the default when configured with @option{--with-cpu=arc700}@.
14238 @item arcem
14239 Compile for ARC EM.
14241 @item archs
14242 Compile for ARC HS.
14244 @item em
14245 @opindex em
14246 Compile for ARC EM cpu with no hardware extension.
14248 @item em4
14249 @opindex em4
14250 Compile for ARC EM4 cpu.
14252 @item em4_dmips
14253 @opindex em4_dmips
14254 Compile for ARC EM4 DMIPS cpu.
14256 @item em4_fpus
14257 @opindex em4_fpus
14258 Compile for ARC EM4 DMIPS cpu with single precision floating point
14259 extension.
14261 @item em4_fpuda
14262 @opindex em4_fpuda
14263 Compile for ARC EM4 DMIPS cpu with single precision floating point and
14264 double assists instructions.
14266 @item hs
14267 @opindex hs
14268 Compile for ARC HS cpu with no hardware extension, except the atomic
14269 instructions.
14271 @item hs34
14272 @opindex hs34
14273 Compile for ARC HS34 cpu.
14275 @item hs38
14276 @opindex hs38
14277 Compile for ARC HS38 cpu.
14279 @item hs38_linux
14280 @opindex hs38_linux
14281 Compile for ARC HS38 cpu with all hardware extensions on.
14283 @item arc600_norm
14284 @opindex arc600_norm
14285 Compile for ARC 600 cpu with norm instruction enabled.
14287 @item arc600_mul32x16
14288 @opindex arc600_mul32x16
14289 Compile for ARC 600 cpu with norm and mul32x16 instructions enabled.
14291 @item arc600_mul64
14292 @opindex arc600_mul64
14293 Compile for ARC 600 cpu with norm and mul64 instructions enabled.
14295 @item arc601_norm
14296 @opindex arc601_norm
14297 Compile for ARC 601 cpu with norm instruction enabled.
14299 @item arc601_mul32x16
14300 @opindex arc601_mul32x16
14301 Compile for ARC 601 cpu with norm and mul32x16 instructions enabled.
14303 @item arc601_mul64
14304 @opindex arc601_mul64
14305 Compile for ARC 601 cpu with norm and mul64 instructions enabled.
14307 @item nps400
14308 @opindex nps400
14309 Compile for ARC 700 on NPS400 chip.
14311 @end table
14313 @item -mdpfp
14314 @opindex mdpfp
14315 @itemx -mdpfp-compact
14316 @opindex mdpfp-compact
14317 FPX: Generate Double Precision FPX instructions, tuned for the compact
14318 implementation.
14320 @item -mdpfp-fast
14321 @opindex mdpfp-fast
14322 FPX: Generate Double Precision FPX instructions, tuned for the fast
14323 implementation.
14325 @item -mno-dpfp-lrsr
14326 @opindex mno-dpfp-lrsr
14327 Disable LR and SR instructions from using FPX extension aux registers.
14329 @item -mea
14330 @opindex mea
14331 Generate Extended arithmetic instructions.  Currently only
14332 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14333 supported.  This is always enabled for @option{-mcpu=ARC700}.
14335 @item -mno-mpy
14336 @opindex mno-mpy
14337 Do not generate mpy instructions for ARC700.  This instruction is
14338 deprecated.
14340 @item -mmul32x16
14341 @opindex mmul32x16
14342 Generate 32x16 bit multiply and mac instructions.
14344 @item -mmul64
14345 @opindex mmul64
14346 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
14348 @item -mnorm
14349 @opindex mnorm
14350 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
14351 is in effect.
14353 @item -mspfp
14354 @opindex mspfp
14355 @itemx -mspfp-compact
14356 @opindex mspfp-compact
14357 FPX: Generate Single Precision FPX instructions, tuned for the compact
14358 implementation.
14360 @item -mspfp-fast
14361 @opindex mspfp-fast
14362 FPX: Generate Single Precision FPX instructions, tuned for the fast
14363 implementation.
14365 @item -msimd
14366 @opindex msimd
14367 Enable generation of ARC SIMD instructions via target-specific
14368 builtins.  Only valid for @option{-mcpu=ARC700}.
14370 @item -msoft-float
14371 @opindex msoft-float
14372 This option ignored; it is provided for compatibility purposes only.
14373 Software floating point code is emitted by default, and this default
14374 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
14375 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
14376 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
14378 @item -mswap
14379 @opindex mswap
14380 Generate swap instructions.
14382 @item -matomic
14383 @opindex matomic
14384 This enables Locked Load/Store Conditional extension to implement
14385 atomic memopry built-in functions.  Not available for ARC 6xx or ARC
14386 EM cores.
14388 @item -mdiv-rem
14389 @opindex mdiv-rem
14390 Enable DIV/REM instructions for ARCv2 cores.
14392 @item -mcode-density
14393 @opindex mcode-density
14394 Enable code density instructions for ARC EM, default on for ARC HS.
14396 @item -mll64
14397 @opindex mll64
14398 Enable double load/store operations for ARC HS cores.
14400 @item -mtp-regno=@var{regno}
14401 @opindex mtp-regno
14402 Specify thread pointer register number.
14404 @item -mmpy-option=@var{multo}
14405 @opindex mmpy-option
14406 Compile ARCv2 code with a multiplier design option.  @samp{wlh1} is
14407 the default value.  The recognized values for @var{multo} are:
14409 @table @samp
14410 @item 0
14411 No multiplier available.
14413 @item 1
14414 @opindex w
14415 The multiply option is set to w: 16x16 multiplier, fully pipelined.
14416 The following instructions are enabled: MPYW, and MPYUW.
14418 @item 2
14419 @opindex wlh1
14420 The multiply option is set to wlh1: 32x32 multiplier, fully
14421 pipelined (1 stage).  The following instructions are additionally
14422 enabled: MPY, MPYU, MPYM, MPYMU, and MPY_S.
14424 @item 3
14425 @opindex wlh2
14426 The multiply option is set to wlh2: 32x32 multiplier, fully pipelined
14427 (2 stages).  The following instructions are additionally enabled: MPY,
14428 MPYU, MPYM, MPYMU, and MPY_S.
14430 @item 4
14431 @opindex wlh3
14432 The multiply option is set to wlh3: Two 16x16 multiplier, blocking,
14433 sequential.  The following instructions are additionally enabled: MPY,
14434 MPYU, MPYM, MPYMU, and MPY_S.
14436 @item 5
14437 @opindex wlh4
14438 The multiply option is set to wlh4: One 16x16 multiplier, blocking,
14439 sequential.  The following instructions are additionally enabled: MPY,
14440 MPYU, MPYM, MPYMU, and MPY_S.
14442 @item 6
14443 @opindex wlh5
14444 The multiply option is set to wlh5: One 32x4 multiplier, blocking,
14445 sequential.  The following instructions are additionally enabled: MPY,
14446 MPYU, MPYM, MPYMU, and MPY_S.
14448 @end table
14450 This option is only available for ARCv2 cores@.
14452 @item -mfpu=@var{fpu}
14453 @opindex mfpu
14454 Enables specific floating-point hardware extension for ARCv2
14455 core.  Supported values for @var{fpu} are:
14457 @table @samp
14459 @item fpus
14460 @opindex fpus
14461 Enables support for single precision floating point hardware
14462 extensions@.
14464 @item fpud
14465 @opindex fpud
14466 Enables support for double precision floating point hardware
14467 extensions.  The single precision floating point extension is also
14468 enabled.  Not available for ARC EM@.
14470 @item fpuda
14471 @opindex fpuda
14472 Enables support for double precision floating point hardware
14473 extensions using double precision assist instructions.  The single
14474 precision floating point extension is also enabled.  This option is
14475 only available for ARC EM@.
14477 @item fpuda_div
14478 @opindex fpuda_div
14479 Enables support for double precision floating point hardware
14480 extensions using double precision assist instructions, and simple
14481 precision square-root and divide hardware extensions.  The single
14482 precision floating point extension is also enabled.  This option is
14483 only available for ARC EM@.
14485 @item fpuda_fma
14486 @opindex fpuda_fma
14487 Enables support for double precision floating point hardware
14488 extensions using double precision assist instructions, and simple
14489 precision fused multiple and add hardware extension.  The single
14490 precision floating point extension is also enabled.  This option is
14491 only available for ARC EM@.
14493 @item fpuda_all
14494 @opindex fpuda_all
14495 Enables support for double precision floating point hardware
14496 extensions using double precision assist instructions, and all simple
14497 precision hardware extensions.  The single precision floating point
14498 extension is also enabled.  This option is only available for ARC EM@.
14500 @item fpus_div
14501 @opindex fpus_div
14502 Enables support for single precision floating point, and single
14503 precision square-root and divide hardware extensions@.
14505 @item fpud_div
14506 @opindex fpud_div
14507 Enables support for double precision floating point, and double
14508 precision square-root and divide hardware extensions.  This option
14509 includes option @samp{fpus_div}. Not available for ARC EM@.
14511 @item fpus_fma
14512 @opindex fpus_fma
14513 Enables support for single precision floating point, and single
14514 precision fused multiple and add hardware extensions@.
14516 @item fpud_fma
14517 @opindex fpud_fma
14518 Enables support for double precision floating point, and double
14519 precision fused multiple and add hardware extensions.  This option
14520 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14522 @item fpus_all
14523 @opindex fpus_all
14524 Enables support for all single precision floating point hardware
14525 extensions@.
14527 @item fpud_all
14528 @opindex fpud_all
14529 Enables support for all single and double precision floating point
14530 hardware extensions.  Not available for ARC EM@.
14532 @end table
14534 @end table
14536 The following options are passed through to the assembler, and also
14537 define preprocessor macro symbols.
14539 @c Flags used by the assembler, but for which we define preprocessor
14540 @c macro symbols as well.
14541 @table @gcctabopt
14542 @item -mdsp-packa
14543 @opindex mdsp-packa
14544 Passed down to the assembler to enable the DSP Pack A extensions.
14545 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14546 deprecated.
14548 @item -mdvbf
14549 @opindex mdvbf
14550 Passed down to the assembler to enable the dual viterbi butterfly
14551 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14552 option is deprecated.
14554 @c ARC700 4.10 extension instruction
14555 @item -mlock
14556 @opindex mlock
14557 Passed down to the assembler to enable the Locked Load/Store
14558 Conditional extension.  Also sets the preprocessor symbol
14559 @code{__Xlock}.
14561 @item -mmac-d16
14562 @opindex mmac-d16
14563 Passed down to the assembler.  Also sets the preprocessor symbol
14564 @code{__Xxmac_d16}.  This option is deprecated.
14566 @item -mmac-24
14567 @opindex mmac-24
14568 Passed down to the assembler.  Also sets the preprocessor symbol
14569 @code{__Xxmac_24}.  This option is deprecated.
14571 @c ARC700 4.10 extension instruction
14572 @item -mrtsc
14573 @opindex mrtsc
14574 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
14575 extension instruction.  Also sets the preprocessor symbol
14576 @code{__Xrtsc}.  This option is deprecated.
14578 @c ARC700 4.10 extension instruction
14579 @item -mswape
14580 @opindex mswape
14581 Passed down to the assembler to enable the swap byte ordering
14582 extension instruction.  Also sets the preprocessor symbol
14583 @code{__Xswape}.
14585 @item -mtelephony
14586 @opindex mtelephony
14587 Passed down to the assembler to enable dual and single operand
14588 instructions for telephony.  Also sets the preprocessor symbol
14589 @code{__Xtelephony}.  This option is deprecated.
14591 @item -mxy
14592 @opindex mxy
14593 Passed down to the assembler to enable the XY Memory extension.  Also
14594 sets the preprocessor symbol @code{__Xxy}.
14596 @end table
14598 The following options control how the assembly code is annotated:
14600 @c Assembly annotation options
14601 @table @gcctabopt
14602 @item -misize
14603 @opindex misize
14604 Annotate assembler instructions with estimated addresses.
14606 @item -mannotate-align
14607 @opindex mannotate-align
14608 Explain what alignment considerations lead to the decision to make an
14609 instruction short or long.
14611 @end table
14613 The following options are passed through to the linker:
14615 @c options passed through to the linker
14616 @table @gcctabopt
14617 @item -marclinux
14618 @opindex marclinux
14619 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14620 This option is enabled by default in tool chains built for
14621 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14622 when profiling is not requested.
14624 @item -marclinux_prof
14625 @opindex marclinux_prof
14626 Passed through to the linker, to specify use of the
14627 @code{arclinux_prof} emulation.  This option is enabled by default in
14628 tool chains built for @w{@code{arc-linux-uclibc}} and
14629 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14631 @end table
14633 The following options control the semantics of generated code:
14635 @c semantically relevant code generation options
14636 @table @gcctabopt
14637 @item -mlong-calls
14638 @opindex mlong-calls
14639 Generate call insns as register indirect calls, thus providing access
14640 to the full 32-bit address range.
14642 @item -mmedium-calls
14643 @opindex mmedium-calls
14644 Don't use less than 25 bit addressing range for calls, which is the
14645 offset available for an unconditional branch-and-link
14646 instruction.  Conditional execution of function calls is suppressed, to
14647 allow use of the 25-bit range, rather than the 21-bit range with
14648 conditional branch-and-link.  This is the default for tool chains built
14649 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14651 @item -mno-sdata
14652 @opindex mno-sdata
14653 Do not generate sdata references.  This is the default for tool chains
14654 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14655 targets.
14657 @item -mvolatile-cache
14658 @opindex mvolatile-cache
14659 Use ordinarily cached memory accesses for volatile references.  This is the
14660 default.
14662 @item -mno-volatile-cache
14663 @opindex mno-volatile-cache
14664 Enable cache bypass for volatile references.
14666 @end table
14668 The following options fine tune code generation:
14669 @c code generation tuning options
14670 @table @gcctabopt
14671 @item -malign-call
14672 @opindex malign-call
14673 Do alignment optimizations for call instructions.
14675 @item -mauto-modify-reg
14676 @opindex mauto-modify-reg
14677 Enable the use of pre/post modify with register displacement.
14679 @item -mbbit-peephole
14680 @opindex mbbit-peephole
14681 Enable bbit peephole2.
14683 @item -mno-brcc
14684 @opindex mno-brcc
14685 This option disables a target-specific pass in @file{arc_reorg} to
14686 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
14687 generation driven by the combiner pass.
14689 @item -mcase-vector-pcrel
14690 @opindex mcase-vector-pcrel
14691 Use pc-relative switch case tables - this enables case table shortening.
14692 This is the default for @option{-Os}.
14694 @item -mcompact-casesi
14695 @opindex mcompact-casesi
14696 Enable compact casesi pattern.  This is the default for @option{-Os},
14697 and only available for ARCv1 cores.
14699 @item -mno-cond-exec
14700 @opindex mno-cond-exec
14701 Disable ARCompact specific pass to generate conditional execution instructions.
14702 Due to delay slot scheduling and interactions between operand numbers,
14703 literal sizes, instruction lengths, and the support for conditional execution,
14704 the target-independent pass to generate conditional execution is often lacking,
14705 so the ARC port has kept a special pass around that tries to find more
14706 conditional execution generating opportunities after register allocation,
14707 branch shortening, and delay slot scheduling have been done.  This pass
14708 generally, but not always, improves performance and code size, at the cost of
14709 extra compilation time, which is why there is an option to switch it off.
14710 If you have a problem with call instructions exceeding their allowable
14711 offset range because they are conditionalized, you should consider using
14712 @option{-mmedium-calls} instead.
14714 @item -mearly-cbranchsi
14715 @opindex mearly-cbranchsi
14716 Enable pre-reload use of the cbranchsi pattern.
14718 @item -mexpand-adddi
14719 @opindex mexpand-adddi
14720 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
14721 @code{add.f}, @code{adc} etc.
14723 @item -mindexed-loads
14724 @opindex mindexed-loads
14725 Enable the use of indexed loads.  This can be problematic because some
14726 optimizers then assume that indexed stores exist, which is not
14727 the case.
14729 @opindex mlra
14730 Enable Local Register Allocation.  This is still experimental for ARC,
14731 so by default the compiler uses standard reload
14732 (i.e. @option{-mno-lra}).
14734 @item -mlra-priority-none
14735 @opindex mlra-priority-none
14736 Don't indicate any priority for target registers.
14738 @item -mlra-priority-compact
14739 @opindex mlra-priority-compact
14740 Indicate target register priority for r0..r3 / r12..r15.
14742 @item -mlra-priority-noncompact
14743 @opindex mlra-priority-noncompact
14744 Reduce target register priority for r0..r3 / r12..r15.
14746 @item -mno-millicode
14747 @opindex mno-millicode
14748 When optimizing for size (using @option{-Os}), prologues and epilogues
14749 that have to save or restore a large number of registers are often
14750 shortened by using call to a special function in libgcc; this is
14751 referred to as a @emph{millicode} call.  As these calls can pose
14752 performance issues, and/or cause linking issues when linking in a
14753 nonstandard way, this option is provided to turn off millicode call
14754 generation.
14756 @item -mmixed-code
14757 @opindex mmixed-code
14758 Tweak register allocation to help 16-bit instruction generation.
14759 This generally has the effect of decreasing the average instruction size
14760 while increasing the instruction count.
14762 @item -mq-class
14763 @opindex mq-class
14764 Enable 'q' instruction alternatives.
14765 This is the default for @option{-Os}.
14767 @item -mRcq
14768 @opindex mRcq
14769 Enable Rcq constraint handling - most short code generation depends on this.
14770 This is the default.
14772 @item -mRcw
14773 @opindex mRcw
14774 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
14775 This is the default.
14777 @item -msize-level=@var{level}
14778 @opindex msize-level
14779 Fine-tune size optimization with regards to instruction lengths and alignment.
14780 The recognized values for @var{level} are:
14781 @table @samp
14782 @item 0
14783 No size optimization.  This level is deprecated and treated like @samp{1}.
14785 @item 1
14786 Short instructions are used opportunistically.
14788 @item 2
14789 In addition, alignment of loops and of code after barriers are dropped.
14791 @item 3
14792 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14794 @end table
14796 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14797 the behavior when this is not set is equivalent to level @samp{1}.
14799 @item -mtune=@var{cpu}
14800 @opindex mtune
14801 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14802 by @option{-mcpu=}.
14804 Supported values for @var{cpu} are
14806 @table @samp
14807 @item ARC600
14808 Tune for ARC600 cpu.
14810 @item ARC601
14811 Tune for ARC601 cpu.
14813 @item ARC700
14814 Tune for ARC700 cpu with standard multiplier block.
14816 @item ARC700-xmac
14817 Tune for ARC700 cpu with XMAC block.
14819 @item ARC725D
14820 Tune for ARC725D cpu.
14822 @item ARC750D
14823 Tune for ARC750D cpu.
14825 @end table
14827 @item -mmultcost=@var{num}
14828 @opindex mmultcost
14829 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14830 normal instruction.
14832 @item -munalign-prob-threshold=@var{probability}
14833 @opindex munalign-prob-threshold
14834 Set probability threshold for unaligning branches.
14835 When tuning for @samp{ARC700} and optimizing for speed, branches without
14836 filled delay slot are preferably emitted unaligned and long, unless
14837 profiling indicates that the probability for the branch to be taken
14838 is below @var{probability}.  @xref{Cross-profiling}.
14839 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14841 @end table
14843 The following options are maintained for backward compatibility, but
14844 are now deprecated and will be removed in a future release:
14846 @c Deprecated options
14847 @table @gcctabopt
14849 @item -margonaut
14850 @opindex margonaut
14851 Obsolete FPX.
14853 @item -mbig-endian
14854 @opindex mbig-endian
14855 @itemx -EB
14856 @opindex EB
14857 Compile code for big endian targets.  Use of these options is now
14858 deprecated.  Users wanting big-endian code, should use the
14859 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
14860 building the tool chain, for which big-endian is the default.
14862 @item -mlittle-endian
14863 @opindex mlittle-endian
14864 @itemx -EL
14865 @opindex EL
14866 Compile code for little endian targets.  Use of these options is now
14867 deprecated.  Users wanting little-endian code should use the
14868 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
14869 building the tool chain, for which little-endian is the default.
14871 @item -mbarrel_shifter
14872 @opindex mbarrel_shifter
14873 Replaced by @option{-mbarrel-shifter}.
14875 @item -mdpfp_compact
14876 @opindex mdpfp_compact
14877 Replaced by @option{-mdpfp-compact}.
14879 @item -mdpfp_fast
14880 @opindex mdpfp_fast
14881 Replaced by @option{-mdpfp-fast}.
14883 @item -mdsp_packa
14884 @opindex mdsp_packa
14885 Replaced by @option{-mdsp-packa}.
14887 @item -mEA
14888 @opindex mEA
14889 Replaced by @option{-mea}.
14891 @item -mmac_24
14892 @opindex mmac_24
14893 Replaced by @option{-mmac-24}.
14895 @item -mmac_d16
14896 @opindex mmac_d16
14897 Replaced by @option{-mmac-d16}.
14899 @item -mspfp_compact
14900 @opindex mspfp_compact
14901 Replaced by @option{-mspfp-compact}.
14903 @item -mspfp_fast
14904 @opindex mspfp_fast
14905 Replaced by @option{-mspfp-fast}.
14907 @item -mtune=@var{cpu}
14908 @opindex mtune
14909 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
14910 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
14911 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
14913 @item -multcost=@var{num}
14914 @opindex multcost
14915 Replaced by @option{-mmultcost}.
14917 @end table
14919 @node ARM Options
14920 @subsection ARM Options
14921 @cindex ARM options
14923 These @samp{-m} options are defined for the ARM port:
14925 @table @gcctabopt
14926 @item -mabi=@var{name}
14927 @opindex mabi
14928 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
14929 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
14931 @item -mapcs-frame
14932 @opindex mapcs-frame
14933 Generate a stack frame that is compliant with the ARM Procedure Call
14934 Standard for all functions, even if this is not strictly necessary for
14935 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
14936 with this option causes the stack frames not to be generated for
14937 leaf functions.  The default is @option{-mno-apcs-frame}.
14938 This option is deprecated.
14940 @item -mapcs
14941 @opindex mapcs
14942 This is a synonym for @option{-mapcs-frame} and is deprecated.
14944 @ignore
14945 @c not currently implemented
14946 @item -mapcs-stack-check
14947 @opindex mapcs-stack-check
14948 Generate code to check the amount of stack space available upon entry to
14949 every function (that actually uses some stack space).  If there is
14950 insufficient space available then either the function
14951 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
14952 called, depending upon the amount of stack space required.  The runtime
14953 system is required to provide these functions.  The default is
14954 @option{-mno-apcs-stack-check}, since this produces smaller code.
14956 @c not currently implemented
14957 @item -mapcs-reentrant
14958 @opindex mapcs-reentrant
14959 Generate reentrant, position-independent code.  The default is
14960 @option{-mno-apcs-reentrant}.
14961 @end ignore
14963 @item -mthumb-interwork
14964 @opindex mthumb-interwork
14965 Generate code that supports calling between the ARM and Thumb
14966 instruction sets.  Without this option, on pre-v5 architectures, the
14967 two instruction sets cannot be reliably used inside one program.  The
14968 default is @option{-mno-thumb-interwork}, since slightly larger code
14969 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
14970 configurations this option is meaningless.
14972 @item -mno-sched-prolog
14973 @opindex mno-sched-prolog
14974 Prevent the reordering of instructions in the function prologue, or the
14975 merging of those instruction with the instructions in the function's
14976 body.  This means that all functions start with a recognizable set
14977 of instructions (or in fact one of a choice from a small set of
14978 different function prologues), and this information can be used to
14979 locate the start of functions inside an executable piece of code.  The
14980 default is @option{-msched-prolog}.
14982 @item -mfloat-abi=@var{name}
14983 @opindex mfloat-abi
14984 Specifies which floating-point ABI to use.  Permissible values
14985 are: @samp{soft}, @samp{softfp} and @samp{hard}.
14987 Specifying @samp{soft} causes GCC to generate output containing
14988 library calls for floating-point operations.
14989 @samp{softfp} allows the generation of code using hardware floating-point
14990 instructions, but still uses the soft-float calling conventions.
14991 @samp{hard} allows generation of floating-point instructions
14992 and uses FPU-specific calling conventions.
14994 The default depends on the specific target configuration.  Note that
14995 the hard-float and soft-float ABIs are not link-compatible; you must
14996 compile your entire program with the same ABI, and link with a
14997 compatible set of libraries.
14999 @item -mlittle-endian
15000 @opindex mlittle-endian
15001 Generate code for a processor running in little-endian mode.  This is
15002 the default for all standard configurations.
15004 @item -mbig-endian
15005 @opindex mbig-endian
15006 Generate code for a processor running in big-endian mode; the default is
15007 to compile code for a little-endian processor.
15009 @item -march=@var{name}
15010 @opindex march
15011 This specifies the name of the target ARM architecture.  GCC uses this
15012 name to determine what kind of instructions it can emit when generating
15013 assembly code.  This option can be used in conjunction with or instead
15014 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
15015 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
15016 @samp{armv5}, @samp{armv5e}, @samp{armv5t}, @samp{armv5te},
15017 @samp{armv6}, @samp{armv6-m}, @samp{armv6j}, @samp{armv6k},
15018 @samp{armv6kz}, @samp{armv6s-m},
15019 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk},
15020 @samp{armv7}, @samp{armv7-a}, @samp{armv7-m}, @samp{armv7-r}, @samp{armv7e-m},
15021 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
15022 @samp{armv8.1-a+crc}, @samp{armv8-m.base}, @samp{armv8-m.main},
15023 @samp{armv8-m.main+dsp}, @samp{iwmmxt}, @samp{iwmmxt2}.
15025 Architecture revisions older than @samp{armv4t} are deprecated.
15027 @option{-march=armv6s-m} is the @samp{armv6-m} architecture with support for
15028 the (now mandatory) SVC instruction.
15030 @option{-march=armv6zk} is an alias for @samp{armv6kz}, existing for backwards
15031 compatibility.
15033 @option{-march=armv7ve} is the @samp{armv7-a} architecture with virtualization
15034 extensions.
15036 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
15037 architecture together with the optional CRC32 extensions.
15039 @option{-march=armv8.1-a} enables compiler support for the ARMv8.1-A
15040 architecture.  This also enables the features provided by
15041 @option{-march=armv8-a+crc}.
15043 @option{-march=armv8.2-a} enables compiler support for the ARMv8.2-A
15044 architecture.  This also enables the features provided by
15045 @option{-march=armv8.1-a}.
15047 @option{-march=armv8.2-a+fp16} enables compiler support for the
15048 ARMv8.2-A architecture with the optional FP16 instructions extension.
15049 This also enables the features provided by @option{-march=armv8.1-a}
15050 and implies @option{-mfp16-format=ieee}.
15052 @option{-march=native} causes the compiler to auto-detect the architecture
15053 of the build computer.  At present, this feature is only supported on
15054 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15055 is unsuccessful the option has no effect.
15057 @item -mtune=@var{name}
15058 @opindex mtune
15059 This option specifies the name of the target ARM processor for
15060 which GCC should tune the performance of the code.
15061 For some ARM implementations better performance can be obtained by using
15062 this option.
15063 Permissible names are: @samp{arm2}, @samp{arm250},
15064 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15065 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15066 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15067 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15068 @samp{arm720},
15069 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15070 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15071 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15072 @samp{strongarm1110},
15073 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15074 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15075 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15076 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15077 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15078 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15079 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15080 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15081 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15082 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
15083 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
15084 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15085 @samp{cortex-m33},
15086 @samp{cortex-m23},
15087 @samp{cortex-m7},
15088 @samp{cortex-m4},
15089 @samp{cortex-m3},
15090 @samp{cortex-m1},
15091 @samp{cortex-m0},
15092 @samp{cortex-m0plus},
15093 @samp{cortex-m1.small-multiply},
15094 @samp{cortex-m0.small-multiply},
15095 @samp{cortex-m0plus.small-multiply},
15096 @samp{exynos-m1},
15097 @samp{falkor},
15098 @samp{qdf24xx},
15099 @samp{marvell-pj4},
15100 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15101 @samp{fa526}, @samp{fa626},
15102 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15103 @samp{xgene1}.
15105 Additionally, this option can specify that GCC should tune the performance
15106 of the code for a big.LITTLE system.  Permissible names are:
15107 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15108 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15109 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
15111 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15112 performance for a blend of processors within architecture @var{arch}.
15113 The aim is to generate code that run well on the current most popular
15114 processors, balancing between optimizations that benefit some CPUs in the
15115 range, and avoiding performance pitfalls of other CPUs.  The effects of
15116 this option may change in future GCC versions as CPU models come and go.
15118 @option{-mtune=native} causes the compiler to auto-detect the CPU
15119 of the build computer.  At present, this feature is only supported on
15120 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15121 unsuccessful the option has no effect.
15123 @item -mcpu=@var{name}
15124 @opindex mcpu
15125 This specifies the name of the target ARM processor.  GCC uses this name
15126 to derive the name of the target ARM architecture (as if specified
15127 by @option{-march}) and the ARM processor type for which to tune for
15128 performance (as if specified by @option{-mtune}).  Where this option
15129 is used in conjunction with @option{-march} or @option{-mtune},
15130 those options take precedence over the appropriate part of this option.
15132 Permissible names for this option are the same as those for
15133 @option{-mtune}.
15135 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15136 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15137 See @option{-mtune} for more information.
15139 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15140 of the build computer.  At present, this feature is only supported on
15141 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15142 is unsuccessful the option has no effect.
15144 @item -mfpu=@var{name}
15145 @opindex mfpu
15146 This specifies what floating-point hardware (or hardware emulation) is
15147 available on the target.  Permissible names are: @samp{vfpv2}, @samp{vfpv3},
15148 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15149 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15150 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15151 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15152 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15153 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15154 is an alias for @samp{vfpv2}.
15156 If @option{-msoft-float} is specified this specifies the format of
15157 floating-point values.
15159 If the selected floating-point hardware includes the NEON extension
15160 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
15161 operations are not generated by GCC's auto-vectorization pass unless
15162 @option{-funsafe-math-optimizations} is also specified.  This is
15163 because NEON hardware does not fully implement the IEEE 754 standard for
15164 floating-point arithmetic (in particular denormal values are treated as
15165 zero), so the use of NEON instructions may lead to a loss of precision.
15167 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}).
15169 @item -mfp16-format=@var{name}
15170 @opindex mfp16-format
15171 Specify the format of the @code{__fp16} half-precision floating-point type.
15172 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15173 the default is @samp{none}, in which case the @code{__fp16} type is not
15174 defined.  @xref{Half-Precision}, for more information.
15176 @item -mstructure-size-boundary=@var{n}
15177 @opindex mstructure-size-boundary
15178 The sizes of all structures and unions are rounded up to a multiple
15179 of the number of bits set by this option.  Permissible values are 8, 32
15180 and 64.  The default value varies for different toolchains.  For the COFF
15181 targeted toolchain the default value is 8.  A value of 64 is only allowed
15182 if the underlying ABI supports it.
15184 Specifying a larger number can produce faster, more efficient code, but
15185 can also increase the size of the program.  Different values are potentially
15186 incompatible.  Code compiled with one value cannot necessarily expect to
15187 work with code or libraries compiled with another value, if they exchange
15188 information using structures or unions.
15190 @item -mabort-on-noreturn
15191 @opindex mabort-on-noreturn
15192 Generate a call to the function @code{abort} at the end of a
15193 @code{noreturn} function.  It is executed if the function tries to
15194 return.
15196 @item -mlong-calls
15197 @itemx -mno-long-calls
15198 @opindex mlong-calls
15199 @opindex mno-long-calls
15200 Tells the compiler to perform function calls by first loading the
15201 address of the function into a register and then performing a subroutine
15202 call on this register.  This switch is needed if the target function
15203 lies outside of the 64-megabyte addressing range of the offset-based
15204 version of subroutine call instruction.
15206 Even if this switch is enabled, not all function calls are turned
15207 into long calls.  The heuristic is that static functions, functions
15208 that have the @code{short_call} attribute, functions that are inside
15209 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15210 definitions have already been compiled within the current compilation
15211 unit are not turned into long calls.  The exceptions to this rule are
15212 that weak function definitions, functions with the @code{long_call}
15213 attribute or the @code{section} attribute, and functions that are within
15214 the scope of a @code{#pragma long_calls} directive are always
15215 turned into long calls.
15217 This feature is not enabled by default.  Specifying
15218 @option{-mno-long-calls} restores the default behavior, as does
15219 placing the function calls within the scope of a @code{#pragma
15220 long_calls_off} directive.  Note these switches have no effect on how
15221 the compiler generates code to handle function calls via function
15222 pointers.
15224 @item -msingle-pic-base
15225 @opindex msingle-pic-base
15226 Treat the register used for PIC addressing as read-only, rather than
15227 loading it in the prologue for each function.  The runtime system is
15228 responsible for initializing this register with an appropriate value
15229 before execution begins.
15231 @item -mpic-register=@var{reg}
15232 @opindex mpic-register
15233 Specify the register to be used for PIC addressing.
15234 For standard PIC base case, the default is any suitable register
15235 determined by compiler.  For single PIC base case, the default is
15236 @samp{R9} if target is EABI based or stack-checking is enabled,
15237 otherwise the default is @samp{R10}.
15239 @item -mpic-data-is-text-relative
15240 @opindex mpic-data-is-text-relative
15241 Assume that the displacement between the text and data segments is fixed
15242 at static link time.  This permits using PC-relative addressing
15243 operations to access data known to be in the data segment.  For
15244 non-VxWorks RTP targets, this option is enabled by default.  When
15245 disabled on such targets, it will enable @option{-msingle-pic-base} by
15246 default.
15248 @item -mpoke-function-name
15249 @opindex mpoke-function-name
15250 Write the name of each function into the text section, directly
15251 preceding the function prologue.  The generated code is similar to this:
15253 @smallexample
15254      t0
15255          .ascii "arm_poke_function_name", 0
15256          .align
15257      t1
15258          .word 0xff000000 + (t1 - t0)
15259      arm_poke_function_name
15260          mov     ip, sp
15261          stmfd   sp!, @{fp, ip, lr, pc@}
15262          sub     fp, ip, #4
15263 @end smallexample
15265 When performing a stack backtrace, code can inspect the value of
15266 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15267 location @code{pc - 12} and the top 8 bits are set, then we know that
15268 there is a function name embedded immediately preceding this location
15269 and has length @code{((pc[-3]) & 0xff000000)}.
15271 @item -mthumb
15272 @itemx -marm
15273 @opindex marm
15274 @opindex mthumb
15276 Select between generating code that executes in ARM and Thumb
15277 states.  The default for most configurations is to generate code
15278 that executes in ARM state, but the default can be changed by
15279 configuring GCC with the @option{--with-mode=}@var{state}
15280 configure option.
15282 You can also override the ARM and Thumb mode for each function
15283 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15284 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15286 @item -mtpcs-frame
15287 @opindex mtpcs-frame
15288 Generate a stack frame that is compliant with the Thumb Procedure Call
15289 Standard for all non-leaf functions.  (A leaf function is one that does
15290 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15292 @item -mtpcs-leaf-frame
15293 @opindex mtpcs-leaf-frame
15294 Generate a stack frame that is compliant with the Thumb Procedure Call
15295 Standard for all leaf functions.  (A leaf function is one that does
15296 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15298 @item -mcallee-super-interworking
15299 @opindex mcallee-super-interworking
15300 Gives all externally visible functions in the file being compiled an ARM
15301 instruction set header which switches to Thumb mode before executing the
15302 rest of the function.  This allows these functions to be called from
15303 non-interworking code.  This option is not valid in AAPCS configurations
15304 because interworking is enabled by default.
15306 @item -mcaller-super-interworking
15307 @opindex mcaller-super-interworking
15308 Allows calls via function pointers (including virtual functions) to
15309 execute correctly regardless of whether the target code has been
15310 compiled for interworking or not.  There is a small overhead in the cost
15311 of executing a function pointer if this option is enabled.  This option
15312 is not valid in AAPCS configurations because interworking is enabled
15313 by default.
15315 @item -mtp=@var{name}
15316 @opindex mtp
15317 Specify the access model for the thread local storage pointer.  The valid
15318 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15319 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15320 (supported in the arm6k architecture), and @samp{auto}, which uses the
15321 best available method for the selected processor.  The default setting is
15322 @samp{auto}.
15324 @item -mtls-dialect=@var{dialect}
15325 @opindex mtls-dialect
15326 Specify the dialect to use for accessing thread local storage.  Two
15327 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15328 @samp{gnu} dialect selects the original GNU scheme for supporting
15329 local and global dynamic TLS models.  The @samp{gnu2} dialect
15330 selects the GNU descriptor scheme, which provides better performance
15331 for shared libraries.  The GNU descriptor scheme is compatible with
15332 the original scheme, but does require new assembler, linker and
15333 library support.  Initial and local exec TLS models are unaffected by
15334 this option and always use the original scheme.
15336 @item -mword-relocations
15337 @opindex mword-relocations
15338 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15339 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15340 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15341 is specified.
15343 @item -mfix-cortex-m3-ldrd
15344 @opindex mfix-cortex-m3-ldrd
15345 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15346 with overlapping destination and base registers are used.  This option avoids
15347 generating these instructions.  This option is enabled by default when
15348 @option{-mcpu=cortex-m3} is specified.
15350 @item -munaligned-access
15351 @itemx -mno-unaligned-access
15352 @opindex munaligned-access
15353 @opindex mno-unaligned-access
15354 Enables (or disables) reading and writing of 16- and 32- bit values
15355 from addresses that are not 16- or 32- bit aligned.  By default
15356 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15357 ARMv8-M Baseline architectures, and enabled for all other
15358 architectures.  If unaligned access is not enabled then words in packed
15359 data structures are accessed a byte at a time.
15361 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15362 generated object file to either true or false, depending upon the
15363 setting of this option.  If unaligned access is enabled then the
15364 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15365 defined.
15367 @item -mneon-for-64bits
15368 @opindex mneon-for-64bits
15369 Enables using Neon to handle scalar 64-bits operations. This is
15370 disabled by default since the cost of moving data from core registers
15371 to Neon is high.
15373 @item -mslow-flash-data
15374 @opindex mslow-flash-data
15375 Assume loading data from flash is slower than fetching instruction.
15376 Therefore literal load is minimized for better performance.
15377 This option is only supported when compiling for ARMv7 M-profile and
15378 off by default.
15380 @item -masm-syntax-unified
15381 @opindex masm-syntax-unified
15382 Assume inline assembler is using unified asm syntax.  The default is
15383 currently off which implies divided syntax.  This option has no impact
15384 on Thumb2. However, this may change in future releases of GCC.
15385 Divided syntax should be considered deprecated.
15387 @item -mrestrict-it
15388 @opindex mrestrict-it
15389 Restricts generation of IT blocks to conform to the rules of ARMv8.
15390 IT blocks can only contain a single 16-bit instruction from a select
15391 set of instructions. This option is on by default for ARMv8 Thumb mode.
15393 @item -mprint-tune-info
15394 @opindex mprint-tune-info
15395 Print CPU tuning information as comment in assembler file.  This is
15396 an option used only for regression testing of the compiler and not
15397 intended for ordinary use in compiling code.  This option is disabled
15398 by default.
15400 @item -mpure-code
15401 @opindex mpure-code
15402 Do not allow constant data to be placed in code sections.
15403 Additionally, when compiling for ELF object format give all text sections the
15404 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15405 is only available when generating non-pic code for ARMv7-M targets.
15407 @item -mcmse
15408 @opindex mcmse
15409 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15410 Development Tools Engineering Specification", which can be found on
15411 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15412 @end table
15414 @node AVR Options
15415 @subsection AVR Options
15416 @cindex AVR Options
15418 These options are defined for AVR implementations:
15420 @table @gcctabopt
15421 @item -mmcu=@var{mcu}
15422 @opindex mmcu
15423 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15425 The default for this option is@tie{}@samp{avr2}.
15427 GCC supports the following AVR devices and ISAs:
15429 @include avr-mmcu.texi
15431 @item -mabsdata
15432 @opindex mabsdata
15434 Assume that all data in static storage can be accessed by LDS / STS
15435 instructions.  This option has only an effect on reduced Tiny devices like
15436 ATtiny40.  See also the @code{absdata}
15437 @ref{AVR Variable Attributes,variable attribute}.
15439 @item -maccumulate-args
15440 @opindex maccumulate-args
15441 Accumulate outgoing function arguments and acquire/release the needed
15442 stack space for outgoing function arguments once in function
15443 prologue/epilogue.  Without this option, outgoing arguments are pushed
15444 before calling a function and popped afterwards.
15446 Popping the arguments after the function call can be expensive on
15447 AVR so that accumulating the stack space might lead to smaller
15448 executables because arguments need not be removed from the
15449 stack after such a function call.
15451 This option can lead to reduced code size for functions that perform
15452 several calls to functions that get their arguments on the stack like
15453 calls to printf-like functions.
15455 @item -mbranch-cost=@var{cost}
15456 @opindex mbranch-cost
15457 Set the branch costs for conditional branch instructions to
15458 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15459 integers. The default branch cost is 0.
15461 @item -mcall-prologues
15462 @opindex mcall-prologues
15463 Functions prologues/epilogues are expanded as calls to appropriate
15464 subroutines.  Code size is smaller.
15466 @item -mint8
15467 @opindex mint8
15468 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15469 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15470 and @code{long long} is 4 bytes.  Please note that this option does not
15471 conform to the C standards, but it results in smaller code
15472 size.
15474 @item -mn-flash=@var{num}
15475 @opindex mn-flash
15476 Assume that the flash memory has a size of 
15477 @var{num} times 64@tie{}KiB.
15479 @item -mno-interrupts
15480 @opindex mno-interrupts
15481 Generated code is not compatible with hardware interrupts.
15482 Code size is smaller.
15484 @item -mrelax
15485 @opindex mrelax
15486 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15487 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15488 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15489 the assembler's command line and the @option{--relax} option to the
15490 linker's command line.
15492 Jump relaxing is performed by the linker because jump offsets are not
15493 known before code is located. Therefore, the assembler code generated by the
15494 compiler is the same, but the instructions in the executable may
15495 differ from instructions in the assembler code.
15497 Relaxing must be turned on if linker stubs are needed, see the
15498 section on @code{EIND} and linker stubs below.
15500 @item -mrmw
15501 @opindex mrmw
15502 Assume that the device supports the Read-Modify-Write
15503 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15505 @item -msp8
15506 @opindex msp8
15507 Treat the stack pointer register as an 8-bit register,
15508 i.e.@: assume the high byte of the stack pointer is zero.
15509 In general, you don't need to set this option by hand.
15511 This option is used internally by the compiler to select and
15512 build multilibs for architectures @code{avr2} and @code{avr25}.
15513 These architectures mix devices with and without @code{SPH}.
15514 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15515 the compiler driver adds or removes this option from the compiler
15516 proper's command line, because the compiler then knows if the device
15517 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15518 register or not.
15520 @item -mstrict-X
15521 @opindex mstrict-X
15522 Use address register @code{X} in a way proposed by the hardware.  This means
15523 that @code{X} is only used in indirect, post-increment or
15524 pre-decrement addressing.
15526 Without this option, the @code{X} register may be used in the same way
15527 as @code{Y} or @code{Z} which then is emulated by additional
15528 instructions.  
15529 For example, loading a value with @code{X+const} addressing with a
15530 small non-negative @code{const < 64} to a register @var{Rn} is
15531 performed as
15533 @example
15534 adiw r26, const   ; X += const
15535 ld   @var{Rn}, X        ; @var{Rn} = *X
15536 sbiw r26, const   ; X -= const
15537 @end example
15539 @item -mtiny-stack
15540 @opindex mtiny-stack
15541 Only change the lower 8@tie{}bits of the stack pointer.
15543 @item -mfract-convert-truncate
15544 @opindex mfract-convert-truncate
15545 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
15547 @item -nodevicelib
15548 @opindex nodevicelib
15549 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
15551 @item -Waddr-space-convert
15552 @opindex Waddr-space-convert
15553 Warn about conversions between address spaces in the case where the
15554 resulting address space is not contained in the incoming address space.
15556 @item -Wmisspelled-isr
15557 @opindex Wmisspelled-isr
15558 Warn if the ISR is misspelled, i.e. without __vector prefix.
15559 Enabled by default.
15560 @end table
15562 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
15563 @cindex @code{EIND}
15564 Pointers in the implementation are 16@tie{}bits wide.
15565 The address of a function or label is represented as word address so
15566 that indirect jumps and calls can target any code address in the
15567 range of 64@tie{}Ki words.
15569 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
15570 bytes of program memory space, there is a special function register called
15571 @code{EIND} that serves as most significant part of the target address
15572 when @code{EICALL} or @code{EIJMP} instructions are used.
15574 Indirect jumps and calls on these devices are handled as follows by
15575 the compiler and are subject to some limitations:
15577 @itemize @bullet
15579 @item
15580 The compiler never sets @code{EIND}.
15582 @item
15583 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
15584 instructions or might read @code{EIND} directly in order to emulate an
15585 indirect call/jump by means of a @code{RET} instruction.
15587 @item
15588 The compiler assumes that @code{EIND} never changes during the startup
15589 code or during the application. In particular, @code{EIND} is not
15590 saved/restored in function or interrupt service routine
15591 prologue/epilogue.
15593 @item
15594 For indirect calls to functions and computed goto, the linker
15595 generates @emph{stubs}. Stubs are jump pads sometimes also called
15596 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
15597 The stub contains a direct jump to the desired address.
15599 @item
15600 Linker relaxation must be turned on so that the linker generates
15601 the stubs correctly in all situations. See the compiler option
15602 @option{-mrelax} and the linker option @option{--relax}.
15603 There are corner cases where the linker is supposed to generate stubs
15604 but aborts without relaxation and without a helpful error message.
15606 @item
15607 The default linker script is arranged for code with @code{EIND = 0}.
15608 If code is supposed to work for a setup with @code{EIND != 0}, a custom
15609 linker script has to be used in order to place the sections whose
15610 name start with @code{.trampolines} into the segment where @code{EIND}
15611 points to.
15613 @item
15614 The startup code from libgcc never sets @code{EIND}.
15615 Notice that startup code is a blend of code from libgcc and AVR-LibC.
15616 For the impact of AVR-LibC on @code{EIND}, see the
15617 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
15619 @item
15620 It is legitimate for user-specific startup code to set up @code{EIND}
15621 early, for example by means of initialization code located in
15622 section @code{.init3}. Such code runs prior to general startup code
15623 that initializes RAM and calls constructors, but after the bit
15624 of startup code from AVR-LibC that sets @code{EIND} to the segment
15625 where the vector table is located.
15626 @example
15627 #include <avr/io.h>
15629 static void
15630 __attribute__((section(".init3"),naked,used,no_instrument_function))
15631 init3_set_eind (void)
15633   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
15634                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
15636 @end example
15638 @noindent
15639 The @code{__trampolines_start} symbol is defined in the linker script.
15641 @item
15642 Stubs are generated automatically by the linker if
15643 the following two conditions are met:
15644 @itemize @minus
15646 @item The address of a label is taken by means of the @code{gs} modifier
15647 (short for @emph{generate stubs}) like so:
15648 @example
15649 LDI r24, lo8(gs(@var{func}))
15650 LDI r25, hi8(gs(@var{func}))
15651 @end example
15652 @item The final location of that label is in a code segment
15653 @emph{outside} the segment where the stubs are located.
15654 @end itemize
15656 @item
15657 The compiler emits such @code{gs} modifiers for code labels in the
15658 following situations:
15659 @itemize @minus
15660 @item Taking address of a function or code label.
15661 @item Computed goto.
15662 @item If prologue-save function is used, see @option{-mcall-prologues}
15663 command-line option.
15664 @item Switch/case dispatch tables. If you do not want such dispatch
15665 tables you can specify the @option{-fno-jump-tables} command-line option.
15666 @item C and C++ constructors/destructors called during startup/shutdown.
15667 @item If the tools hit a @code{gs()} modifier explained above.
15668 @end itemize
15670 @item
15671 Jumping to non-symbolic addresses like so is @emph{not} supported:
15673 @example
15674 int main (void)
15676     /* Call function at word address 0x2 */
15677     return ((int(*)(void)) 0x2)();
15679 @end example
15681 Instead, a stub has to be set up, i.e.@: the function has to be called
15682 through a symbol (@code{func_4} in the example):
15684 @example
15685 int main (void)
15687     extern int func_4 (void);
15689     /* Call function at byte address 0x4 */
15690     return func_4();
15692 @end example
15694 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
15695 Alternatively, @code{func_4} can be defined in the linker script.
15696 @end itemize
15698 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
15699 @cindex @code{RAMPD}
15700 @cindex @code{RAMPX}
15701 @cindex @code{RAMPY}
15702 @cindex @code{RAMPZ}
15703 Some AVR devices support memories larger than the 64@tie{}KiB range
15704 that can be accessed with 16-bit pointers.  To access memory locations
15705 outside this 64@tie{}KiB range, the content of a @code{RAMP}
15706 register is used as high part of the address:
15707 The @code{X}, @code{Y}, @code{Z} address register is concatenated
15708 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
15709 register, respectively, to get a wide address. Similarly,
15710 @code{RAMPD} is used together with direct addressing.
15712 @itemize
15713 @item
15714 The startup code initializes the @code{RAMP} special function
15715 registers with zero.
15717 @item
15718 If a @ref{AVR Named Address Spaces,named address space} other than
15719 generic or @code{__flash} is used, then @code{RAMPZ} is set
15720 as needed before the operation.
15722 @item
15723 If the device supports RAM larger than 64@tie{}KiB and the compiler
15724 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
15725 is reset to zero after the operation.
15727 @item
15728 If the device comes with a specific @code{RAMP} register, the ISR
15729 prologue/epilogue saves/restores that SFR and initializes it with
15730 zero in case the ISR code might (implicitly) use it.
15732 @item
15733 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
15734 If you use inline assembler to read from locations outside the
15735 16-bit address range and change one of the @code{RAMP} registers,
15736 you must reset it to zero after the access.
15738 @end itemize
15740 @subsubsection AVR Built-in Macros
15742 GCC defines several built-in macros so that the user code can test
15743 for the presence or absence of features.  Almost any of the following
15744 built-in macros are deduced from device capabilities and thus
15745 triggered by the @option{-mmcu=} command-line option.
15747 For even more AVR-specific built-in macros see
15748 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
15750 @table @code
15752 @item __AVR_ARCH__
15753 Build-in macro that resolves to a decimal number that identifies the
15754 architecture and depends on the @option{-mmcu=@var{mcu}} option.
15755 Possible values are:
15757 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
15758 @code{4}, @code{5}, @code{51}, @code{6}
15760 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
15761 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
15763 respectively and
15765 @code{100}, @code{102}, @code{104},
15766 @code{105}, @code{106}, @code{107}
15768 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
15769 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
15770 If @var{mcu} specifies a device, this built-in macro is set
15771 accordingly. For example, with @option{-mmcu=atmega8} the macro is
15772 defined to @code{4}.
15774 @item __AVR_@var{Device}__
15775 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
15776 the device's name. For example, @option{-mmcu=atmega8} defines the
15777 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
15778 @code{__AVR_ATtiny261A__}, etc.
15780 The built-in macros' names follow
15781 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
15782 the device name as from the AVR user manual. The difference between
15783 @var{Device} in the built-in macro and @var{device} in
15784 @option{-mmcu=@var{device}} is that the latter is always lowercase.
15786 If @var{device} is not a device but only a core architecture like
15787 @samp{avr51}, this macro is not defined.
15789 @item __AVR_DEVICE_NAME__
15790 Setting @option{-mmcu=@var{device}} defines this built-in macro to
15791 the device's name. For example, with @option{-mmcu=atmega8} the macro
15792 is defined to @code{atmega8}.
15794 If @var{device} is not a device but only a core architecture like
15795 @samp{avr51}, this macro is not defined.
15797 @item __AVR_XMEGA__
15798 The device / architecture belongs to the XMEGA family of devices.
15800 @item __AVR_HAVE_ELPM__
15801 The device has the @code{ELPM} instruction.
15803 @item __AVR_HAVE_ELPMX__
15804 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
15805 R@var{n},Z+} instructions.
15807 @item __AVR_HAVE_MOVW__
15808 The device has the @code{MOVW} instruction to perform 16-bit
15809 register-register moves.
15811 @item __AVR_HAVE_LPMX__
15812 The device has the @code{LPM R@var{n},Z} and
15813 @code{LPM R@var{n},Z+} instructions.
15815 @item __AVR_HAVE_MUL__
15816 The device has a hardware multiplier. 
15818 @item __AVR_HAVE_JMP_CALL__
15819 The device has the @code{JMP} and @code{CALL} instructions.
15820 This is the case for devices with at least 16@tie{}KiB of program
15821 memory.
15823 @item __AVR_HAVE_EIJMP_EICALL__
15824 @itemx __AVR_3_BYTE_PC__
15825 The device has the @code{EIJMP} and @code{EICALL} instructions.
15826 This is the case for devices with more than 128@tie{}KiB of program memory.
15827 This also means that the program counter
15828 (PC) is 3@tie{}bytes wide.
15830 @item __AVR_2_BYTE_PC__
15831 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
15832 with up to 128@tie{}KiB of program memory.
15834 @item __AVR_HAVE_8BIT_SP__
15835 @itemx __AVR_HAVE_16BIT_SP__
15836 The stack pointer (SP) register is treated as 8-bit respectively
15837 16-bit register by the compiler.
15838 The definition of these macros is affected by @option{-mtiny-stack}.
15840 @item __AVR_HAVE_SPH__
15841 @itemx __AVR_SP8__
15842 The device has the SPH (high part of stack pointer) special function
15843 register or has an 8-bit stack pointer, respectively.
15844 The definition of these macros is affected by @option{-mmcu=} and
15845 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
15846 by @option{-msp8}.
15848 @item __AVR_HAVE_RAMPD__
15849 @itemx __AVR_HAVE_RAMPX__
15850 @itemx __AVR_HAVE_RAMPY__
15851 @itemx __AVR_HAVE_RAMPZ__
15852 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
15853 @code{RAMPZ} special function register, respectively.
15855 @item __NO_INTERRUPTS__
15856 This macro reflects the @option{-mno-interrupts} command-line option.
15858 @item __AVR_ERRATA_SKIP__
15859 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
15860 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
15861 instructions because of a hardware erratum.  Skip instructions are
15862 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
15863 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
15864 set.
15866 @item __AVR_ISA_RMW__
15867 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
15869 @item __AVR_SFR_OFFSET__=@var{offset}
15870 Instructions that can address I/O special function registers directly
15871 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
15872 address as if addressed by an instruction to access RAM like @code{LD}
15873 or @code{STS}. This offset depends on the device architecture and has
15874 to be subtracted from the RAM address in order to get the
15875 respective I/O@tie{}address.
15877 @item __WITH_AVRLIBC__
15878 The compiler is configured to be used together with AVR-Libc.
15879 See the @option{--with-avrlibc} configure option.
15881 @end table
15883 @node Blackfin Options
15884 @subsection Blackfin Options
15885 @cindex Blackfin Options
15887 @table @gcctabopt
15888 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
15889 @opindex mcpu=
15890 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
15891 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
15892 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
15893 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
15894 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
15895 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
15896 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
15897 @samp{bf561}, @samp{bf592}.
15899 The optional @var{sirevision} specifies the silicon revision of the target
15900 Blackfin processor.  Any workarounds available for the targeted silicon revision
15901 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
15902 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
15903 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
15904 hexadecimal digits representing the major and minor numbers in the silicon
15905 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
15906 is not defined.  If @var{sirevision} is @samp{any}, the
15907 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
15908 If this optional @var{sirevision} is not used, GCC assumes the latest known
15909 silicon revision of the targeted Blackfin processor.
15911 GCC defines a preprocessor macro for the specified @var{cpu}.
15912 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
15913 provided by libgloss to be linked in if @option{-msim} is not given.
15915 Without this option, @samp{bf532} is used as the processor by default.
15917 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
15918 only the preprocessor macro is defined.
15920 @item -msim
15921 @opindex msim
15922 Specifies that the program will be run on the simulator.  This causes
15923 the simulator BSP provided by libgloss to be linked in.  This option
15924 has effect only for @samp{bfin-elf} toolchain.
15925 Certain other options, such as @option{-mid-shared-library} and
15926 @option{-mfdpic}, imply @option{-msim}.
15928 @item -momit-leaf-frame-pointer
15929 @opindex momit-leaf-frame-pointer
15930 Don't keep the frame pointer in a register for leaf functions.  This
15931 avoids the instructions to save, set up and restore frame pointers and
15932 makes an extra register available in leaf functions.  The option
15933 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
15934 which might make debugging harder.
15936 @item -mspecld-anomaly
15937 @opindex mspecld-anomaly
15938 When enabled, the compiler ensures that the generated code does not
15939 contain speculative loads after jump instructions. If this option is used,
15940 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
15942 @item -mno-specld-anomaly
15943 @opindex mno-specld-anomaly
15944 Don't generate extra code to prevent speculative loads from occurring.
15946 @item -mcsync-anomaly
15947 @opindex mcsync-anomaly
15948 When enabled, the compiler ensures that the generated code does not
15949 contain CSYNC or SSYNC instructions too soon after conditional branches.
15950 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
15952 @item -mno-csync-anomaly
15953 @opindex mno-csync-anomaly
15954 Don't generate extra code to prevent CSYNC or SSYNC instructions from
15955 occurring too soon after a conditional branch.
15957 @item -mlow-64k
15958 @opindex mlow-64k
15959 When enabled, the compiler is free to take advantage of the knowledge that
15960 the entire program fits into the low 64k of memory.
15962 @item -mno-low-64k
15963 @opindex mno-low-64k
15964 Assume that the program is arbitrarily large.  This is the default.
15966 @item -mstack-check-l1
15967 @opindex mstack-check-l1
15968 Do stack checking using information placed into L1 scratchpad memory by the
15969 uClinux kernel.
15971 @item -mid-shared-library
15972 @opindex mid-shared-library
15973 Generate code that supports shared libraries via the library ID method.
15974 This allows for execute in place and shared libraries in an environment
15975 without virtual memory management.  This option implies @option{-fPIC}.
15976 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15978 @item -mno-id-shared-library
15979 @opindex mno-id-shared-library
15980 Generate code that doesn't assume ID-based shared libraries are being used.
15981 This is the default.
15983 @item -mleaf-id-shared-library
15984 @opindex mleaf-id-shared-library
15985 Generate code that supports shared libraries via the library ID method,
15986 but assumes that this library or executable won't link against any other
15987 ID shared libraries.  That allows the compiler to use faster code for jumps
15988 and calls.
15990 @item -mno-leaf-id-shared-library
15991 @opindex mno-leaf-id-shared-library
15992 Do not assume that the code being compiled won't link against any ID shared
15993 libraries.  Slower code is generated for jump and call insns.
15995 @item -mshared-library-id=n
15996 @opindex mshared-library-id
15997 Specifies the identification number of the ID-based shared library being
15998 compiled.  Specifying a value of 0 generates more compact code; specifying
15999 other values forces the allocation of that number to the current
16000 library but is no more space- or time-efficient than omitting this option.
16002 @item -msep-data
16003 @opindex msep-data
16004 Generate code that allows the data segment to be located in a different
16005 area of memory from the text segment.  This allows for execute in place in
16006 an environment without virtual memory management by eliminating relocations
16007 against the text section.
16009 @item -mno-sep-data
16010 @opindex mno-sep-data
16011 Generate code that assumes that the data segment follows the text segment.
16012 This is the default.
16014 @item -mlong-calls
16015 @itemx -mno-long-calls
16016 @opindex mlong-calls
16017 @opindex mno-long-calls
16018 Tells the compiler to perform function calls by first loading the
16019 address of the function into a register and then performing a subroutine
16020 call on this register.  This switch is needed if the target function
16021 lies outside of the 24-bit addressing range of the offset-based
16022 version of subroutine call instruction.
16024 This feature is not enabled by default.  Specifying
16025 @option{-mno-long-calls} restores the default behavior.  Note these
16026 switches have no effect on how the compiler generates code to handle
16027 function calls via function pointers.
16029 @item -mfast-fp
16030 @opindex mfast-fp
16031 Link with the fast floating-point library. This library relaxes some of
16032 the IEEE floating-point standard's rules for checking inputs against
16033 Not-a-Number (NAN), in the interest of performance.
16035 @item -minline-plt
16036 @opindex minline-plt
16037 Enable inlining of PLT entries in function calls to functions that are
16038 not known to bind locally.  It has no effect without @option{-mfdpic}.
16040 @item -mmulticore
16041 @opindex mmulticore
16042 Build a standalone application for multicore Blackfin processors. 
16043 This option causes proper start files and link scripts supporting 
16044 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16045 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16047 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16048 selects the one-application-per-core programming model.  Without
16049 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16050 programming model is used. In this model, the main function of Core B
16051 should be named as @code{coreb_main}.
16053 If this option is not used, the single-core application programming
16054 model is used.
16056 @item -mcorea
16057 @opindex mcorea
16058 Build a standalone application for Core A of BF561 when using
16059 the one-application-per-core programming model. Proper start files
16060 and link scripts are used to support Core A, and the macro
16061 @code{__BFIN_COREA} is defined.
16062 This option can only be used in conjunction with @option{-mmulticore}.
16064 @item -mcoreb
16065 @opindex mcoreb
16066 Build a standalone application for Core B of BF561 when using
16067 the one-application-per-core programming model. Proper start files
16068 and link scripts are used to support Core B, and the macro
16069 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16070 should be used instead of @code{main}. 
16071 This option can only be used in conjunction with @option{-mmulticore}.
16073 @item -msdram
16074 @opindex msdram
16075 Build a standalone application for SDRAM. Proper start files and
16076 link scripts are used to put the application into SDRAM, and the macro
16077 @code{__BFIN_SDRAM} is defined.
16078 The loader should initialize SDRAM before loading the application.
16080 @item -micplb
16081 @opindex micplb
16082 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16083 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16084 are enabled; for standalone applications the default is off.
16085 @end table
16087 @node C6X Options
16088 @subsection C6X Options
16089 @cindex C6X Options
16091 @table @gcctabopt
16092 @item -march=@var{name}
16093 @opindex march
16094 This specifies the name of the target architecture.  GCC uses this
16095 name to determine what kind of instructions it can emit when generating
16096 assembly code.  Permissible names are: @samp{c62x},
16097 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16099 @item -mbig-endian
16100 @opindex mbig-endian
16101 Generate code for a big-endian target.
16103 @item -mlittle-endian
16104 @opindex mlittle-endian
16105 Generate code for a little-endian target.  This is the default.
16107 @item -msim
16108 @opindex msim
16109 Choose startup files and linker script suitable for the simulator.
16111 @item -msdata=default
16112 @opindex msdata=default
16113 Put small global and static data in the @code{.neardata} section,
16114 which is pointed to by register @code{B14}.  Put small uninitialized
16115 global and static data in the @code{.bss} section, which is adjacent
16116 to the @code{.neardata} section.  Put small read-only data into the
16117 @code{.rodata} section.  The corresponding sections used for large
16118 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16120 @item -msdata=all
16121 @opindex msdata=all
16122 Put all data, not just small objects, into the sections reserved for
16123 small data, and use addressing relative to the @code{B14} register to
16124 access them.
16126 @item -msdata=none
16127 @opindex msdata=none
16128 Make no use of the sections reserved for small data, and use absolute
16129 addresses to access all data.  Put all initialized global and static
16130 data in the @code{.fardata} section, and all uninitialized data in the
16131 @code{.far} section.  Put all constant data into the @code{.const}
16132 section.
16133 @end table
16135 @node CRIS Options
16136 @subsection CRIS Options
16137 @cindex CRIS Options
16139 These options are defined specifically for the CRIS ports.
16141 @table @gcctabopt
16142 @item -march=@var{architecture-type}
16143 @itemx -mcpu=@var{architecture-type}
16144 @opindex march
16145 @opindex mcpu
16146 Generate code for the specified architecture.  The choices for
16147 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16148 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16149 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16150 @samp{v10}.
16152 @item -mtune=@var{architecture-type}
16153 @opindex mtune
16154 Tune to @var{architecture-type} everything applicable about the generated
16155 code, except for the ABI and the set of available instructions.  The
16156 choices for @var{architecture-type} are the same as for
16157 @option{-march=@var{architecture-type}}.
16159 @item -mmax-stack-frame=@var{n}
16160 @opindex mmax-stack-frame
16161 Warn when the stack frame of a function exceeds @var{n} bytes.
16163 @item -metrax4
16164 @itemx -metrax100
16165 @opindex metrax4
16166 @opindex metrax100
16167 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16168 @option{-march=v3} and @option{-march=v8} respectively.
16170 @item -mmul-bug-workaround
16171 @itemx -mno-mul-bug-workaround
16172 @opindex mmul-bug-workaround
16173 @opindex mno-mul-bug-workaround
16174 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16175 models where it applies.  This option is active by default.
16177 @item -mpdebug
16178 @opindex mpdebug
16179 Enable CRIS-specific verbose debug-related information in the assembly
16180 code.  This option also has the effect of turning off the @samp{#NO_APP}
16181 formatted-code indicator to the assembler at the beginning of the
16182 assembly file.
16184 @item -mcc-init
16185 @opindex mcc-init
16186 Do not use condition-code results from previous instruction; always emit
16187 compare and test instructions before use of condition codes.
16189 @item -mno-side-effects
16190 @opindex mno-side-effects
16191 Do not emit instructions with side effects in addressing modes other than
16192 post-increment.
16194 @item -mstack-align
16195 @itemx -mno-stack-align
16196 @itemx -mdata-align
16197 @itemx -mno-data-align
16198 @itemx -mconst-align
16199 @itemx -mno-const-align
16200 @opindex mstack-align
16201 @opindex mno-stack-align
16202 @opindex mdata-align
16203 @opindex mno-data-align
16204 @opindex mconst-align
16205 @opindex mno-const-align
16206 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16207 stack frame, individual data and constants to be aligned for the maximum
16208 single data access size for the chosen CPU model.  The default is to
16209 arrange for 32-bit alignment.  ABI details such as structure layout are
16210 not affected by these options.
16212 @item -m32-bit
16213 @itemx -m16-bit
16214 @itemx -m8-bit
16215 @opindex m32-bit
16216 @opindex m16-bit
16217 @opindex m8-bit
16218 Similar to the stack- data- and const-align options above, these options
16219 arrange for stack frame, writable data and constants to all be 32-bit,
16220 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16222 @item -mno-prologue-epilogue
16223 @itemx -mprologue-epilogue
16224 @opindex mno-prologue-epilogue
16225 @opindex mprologue-epilogue
16226 With @option{-mno-prologue-epilogue}, the normal function prologue and
16227 epilogue which set up the stack frame are omitted and no return
16228 instructions or return sequences are generated in the code.  Use this
16229 option only together with visual inspection of the compiled code: no
16230 warnings or errors are generated when call-saved registers must be saved,
16231 or storage for local variables needs to be allocated.
16233 @item -mno-gotplt
16234 @itemx -mgotplt
16235 @opindex mno-gotplt
16236 @opindex mgotplt
16237 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16238 instruction sequences that load addresses for functions from the PLT part
16239 of the GOT rather than (traditional on other architectures) calls to the
16240 PLT@.  The default is @option{-mgotplt}.
16242 @item -melf
16243 @opindex melf
16244 Legacy no-op option only recognized with the cris-axis-elf and
16245 cris-axis-linux-gnu targets.
16247 @item -mlinux
16248 @opindex mlinux
16249 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16251 @item -sim
16252 @opindex sim
16253 This option, recognized for the cris-axis-elf, arranges
16254 to link with input-output functions from a simulator library.  Code,
16255 initialized data and zero-initialized data are allocated consecutively.
16257 @item -sim2
16258 @opindex sim2
16259 Like @option{-sim}, but pass linker options to locate initialized data at
16260 0x40000000 and zero-initialized data at 0x80000000.
16261 @end table
16263 @node CR16 Options
16264 @subsection CR16 Options
16265 @cindex CR16 Options
16267 These options are defined specifically for the CR16 ports.
16269 @table @gcctabopt
16271 @item -mmac
16272 @opindex mmac
16273 Enable the use of multiply-accumulate instructions. Disabled by default.
16275 @item -mcr16cplus
16276 @itemx -mcr16c
16277 @opindex mcr16cplus
16278 @opindex mcr16c
16279 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16280 is default.
16282 @item -msim
16283 @opindex msim
16284 Links the library libsim.a which is in compatible with simulator. Applicable
16285 to ELF compiler only.
16287 @item -mint32
16288 @opindex mint32
16289 Choose integer type as 32-bit wide.
16291 @item -mbit-ops
16292 @opindex mbit-ops
16293 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16295 @item -mdata-model=@var{model}
16296 @opindex mdata-model
16297 Choose a data model. The choices for @var{model} are @samp{near},
16298 @samp{far} or @samp{medium}. @samp{medium} is default.
16299 However, @samp{far} is not valid with @option{-mcr16c}, as the
16300 CR16C architecture does not support the far data model.
16301 @end table
16303 @node Darwin Options
16304 @subsection Darwin Options
16305 @cindex Darwin options
16307 These options are defined for all architectures running the Darwin operating
16308 system.
16310 FSF GCC on Darwin does not create ``fat'' object files; it creates
16311 an object file for the single architecture that GCC was built to
16312 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16313 @option{-arch} options are used; it does so by running the compiler or
16314 linker multiple times and joining the results together with
16315 @file{lipo}.
16317 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16318 @samp{i686}) is determined by the flags that specify the ISA
16319 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16320 @option{-force_cpusubtype_ALL} option can be used to override this.
16322 The Darwin tools vary in their behavior when presented with an ISA
16323 mismatch.  The assembler, @file{as}, only permits instructions to
16324 be used that are valid for the subtype of the file it is generating,
16325 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16326 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16327 and prints an error if asked to create a shared library with a less
16328 restrictive subtype than its input files (for instance, trying to put
16329 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16330 for executables, @command{ld}, quietly gives the executable the most
16331 restrictive subtype of any of its input files.
16333 @table @gcctabopt
16334 @item -F@var{dir}
16335 @opindex F
16336 Add the framework directory @var{dir} to the head of the list of
16337 directories to be searched for header files.  These directories are
16338 interleaved with those specified by @option{-I} options and are
16339 scanned in a left-to-right order.
16341 A framework directory is a directory with frameworks in it.  A
16342 framework is a directory with a @file{Headers} and/or
16343 @file{PrivateHeaders} directory contained directly in it that ends
16344 in @file{.framework}.  The name of a framework is the name of this
16345 directory excluding the @file{.framework}.  Headers associated with
16346 the framework are found in one of those two directories, with
16347 @file{Headers} being searched first.  A subframework is a framework
16348 directory that is in a framework's @file{Frameworks} directory.
16349 Includes of subframework headers can only appear in a header of a
16350 framework that contains the subframework, or in a sibling subframework
16351 header.  Two subframeworks are siblings if they occur in the same
16352 framework.  A subframework should not have the same name as a
16353 framework; a warning is issued if this is violated.  Currently a
16354 subframework cannot have subframeworks; in the future, the mechanism
16355 may be extended to support this.  The standard frameworks can be found
16356 in @file{/System/Library/Frameworks} and
16357 @file{/Library/Frameworks}.  An example include looks like
16358 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16359 the name of the framework and @file{header.h} is found in the
16360 @file{PrivateHeaders} or @file{Headers} directory.
16362 @item -iframework@var{dir}
16363 @opindex iframework
16364 Like @option{-F} except the directory is a treated as a system
16365 directory.  The main difference between this @option{-iframework} and
16366 @option{-F} is that with @option{-iframework} the compiler does not
16367 warn about constructs contained within header files found via
16368 @var{dir}.  This option is valid only for the C family of languages.
16370 @item -gused
16371 @opindex gused
16372 Emit debugging information for symbols that are used.  For stabs
16373 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16374 This is by default ON@.
16376 @item -gfull
16377 @opindex gfull
16378 Emit debugging information for all symbols and types.
16380 @item -mmacosx-version-min=@var{version}
16381 The earliest version of MacOS X that this executable will run on
16382 is @var{version}.  Typical values of @var{version} include @code{10.1},
16383 @code{10.2}, and @code{10.3.9}.
16385 If the compiler was built to use the system's headers by default,
16386 then the default for this option is the system version on which the
16387 compiler is running, otherwise the default is to make choices that
16388 are compatible with as many systems and code bases as possible.
16390 @item -mkernel
16391 @opindex mkernel
16392 Enable kernel development mode.  The @option{-mkernel} option sets
16393 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16394 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16395 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16396 applicable.  This mode also sets @option{-mno-altivec},
16397 @option{-msoft-float}, @option{-fno-builtin} and
16398 @option{-mlong-branch} for PowerPC targets.
16400 @item -mone-byte-bool
16401 @opindex mone-byte-bool
16402 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16403 By default @code{sizeof(bool)} is @code{4} when compiling for
16404 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16405 option has no effect on x86.
16407 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16408 to generate code that is not binary compatible with code generated
16409 without that switch.  Using this switch may require recompiling all
16410 other modules in a program, including system libraries.  Use this
16411 switch to conform to a non-default data model.
16413 @item -mfix-and-continue
16414 @itemx -ffix-and-continue
16415 @itemx -findirect-data
16416 @opindex mfix-and-continue
16417 @opindex ffix-and-continue
16418 @opindex findirect-data
16419 Generate code suitable for fast turnaround development, such as to
16420 allow GDB to dynamically load @file{.o} files into already-running
16421 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16422 are provided for backwards compatibility.
16424 @item -all_load
16425 @opindex all_load
16426 Loads all members of static archive libraries.
16427 See man ld(1) for more information.
16429 @item -arch_errors_fatal
16430 @opindex arch_errors_fatal
16431 Cause the errors having to do with files that have the wrong architecture
16432 to be fatal.
16434 @item -bind_at_load
16435 @opindex bind_at_load
16436 Causes the output file to be marked such that the dynamic linker will
16437 bind all undefined references when the file is loaded or launched.
16439 @item -bundle
16440 @opindex bundle
16441 Produce a Mach-o bundle format file.
16442 See man ld(1) for more information.
16444 @item -bundle_loader @var{executable}
16445 @opindex bundle_loader
16446 This option specifies the @var{executable} that will load the build
16447 output file being linked.  See man ld(1) for more information.
16449 @item -dynamiclib
16450 @opindex dynamiclib
16451 When passed this option, GCC produces a dynamic library instead of
16452 an executable when linking, using the Darwin @file{libtool} command.
16454 @item -force_cpusubtype_ALL
16455 @opindex force_cpusubtype_ALL
16456 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16457 one controlled by the @option{-mcpu} or @option{-march} option.
16459 @item -allowable_client  @var{client_name}
16460 @itemx -client_name
16461 @itemx -compatibility_version
16462 @itemx -current_version
16463 @itemx -dead_strip
16464 @itemx -dependency-file
16465 @itemx -dylib_file
16466 @itemx -dylinker_install_name
16467 @itemx -dynamic
16468 @itemx -exported_symbols_list
16469 @itemx -filelist
16470 @need 800
16471 @itemx -flat_namespace
16472 @itemx -force_flat_namespace
16473 @itemx -headerpad_max_install_names
16474 @itemx -image_base
16475 @itemx -init
16476 @itemx -install_name
16477 @itemx -keep_private_externs
16478 @itemx -multi_module
16479 @itemx -multiply_defined
16480 @itemx -multiply_defined_unused
16481 @need 800
16482 @itemx -noall_load
16483 @itemx -no_dead_strip_inits_and_terms
16484 @itemx -nofixprebinding
16485 @itemx -nomultidefs
16486 @itemx -noprebind
16487 @itemx -noseglinkedit
16488 @itemx -pagezero_size
16489 @itemx -prebind
16490 @itemx -prebind_all_twolevel_modules
16491 @itemx -private_bundle
16492 @need 800
16493 @itemx -read_only_relocs
16494 @itemx -sectalign
16495 @itemx -sectobjectsymbols
16496 @itemx -whyload
16497 @itemx -seg1addr
16498 @itemx -sectcreate
16499 @itemx -sectobjectsymbols
16500 @itemx -sectorder
16501 @itemx -segaddr
16502 @itemx -segs_read_only_addr
16503 @need 800
16504 @itemx -segs_read_write_addr
16505 @itemx -seg_addr_table
16506 @itemx -seg_addr_table_filename
16507 @itemx -seglinkedit
16508 @itemx -segprot
16509 @itemx -segs_read_only_addr
16510 @itemx -segs_read_write_addr
16511 @itemx -single_module
16512 @itemx -static
16513 @itemx -sub_library
16514 @need 800
16515 @itemx -sub_umbrella
16516 @itemx -twolevel_namespace
16517 @itemx -umbrella
16518 @itemx -undefined
16519 @itemx -unexported_symbols_list
16520 @itemx -weak_reference_mismatches
16521 @itemx -whatsloaded
16522 @opindex allowable_client
16523 @opindex client_name
16524 @opindex compatibility_version
16525 @opindex current_version
16526 @opindex dead_strip
16527 @opindex dependency-file
16528 @opindex dylib_file
16529 @opindex dylinker_install_name
16530 @opindex dynamic
16531 @opindex exported_symbols_list
16532 @opindex filelist
16533 @opindex flat_namespace
16534 @opindex force_flat_namespace
16535 @opindex headerpad_max_install_names
16536 @opindex image_base
16537 @opindex init
16538 @opindex install_name
16539 @opindex keep_private_externs
16540 @opindex multi_module
16541 @opindex multiply_defined
16542 @opindex multiply_defined_unused
16543 @opindex noall_load
16544 @opindex no_dead_strip_inits_and_terms
16545 @opindex nofixprebinding
16546 @opindex nomultidefs
16547 @opindex noprebind
16548 @opindex noseglinkedit
16549 @opindex pagezero_size
16550 @opindex prebind
16551 @opindex prebind_all_twolevel_modules
16552 @opindex private_bundle
16553 @opindex read_only_relocs
16554 @opindex sectalign
16555 @opindex sectobjectsymbols
16556 @opindex whyload
16557 @opindex seg1addr
16558 @opindex sectcreate
16559 @opindex sectobjectsymbols
16560 @opindex sectorder
16561 @opindex segaddr
16562 @opindex segs_read_only_addr
16563 @opindex segs_read_write_addr
16564 @opindex seg_addr_table
16565 @opindex seg_addr_table_filename
16566 @opindex seglinkedit
16567 @opindex segprot
16568 @opindex segs_read_only_addr
16569 @opindex segs_read_write_addr
16570 @opindex single_module
16571 @opindex static
16572 @opindex sub_library
16573 @opindex sub_umbrella
16574 @opindex twolevel_namespace
16575 @opindex umbrella
16576 @opindex undefined
16577 @opindex unexported_symbols_list
16578 @opindex weak_reference_mismatches
16579 @opindex whatsloaded
16580 These options are passed to the Darwin linker.  The Darwin linker man page
16581 describes them in detail.
16582 @end table
16584 @node DEC Alpha Options
16585 @subsection DEC Alpha Options
16587 These @samp{-m} options are defined for the DEC Alpha implementations:
16589 @table @gcctabopt
16590 @item -mno-soft-float
16591 @itemx -msoft-float
16592 @opindex mno-soft-float
16593 @opindex msoft-float
16594 Use (do not use) the hardware floating-point instructions for
16595 floating-point operations.  When @option{-msoft-float} is specified,
16596 functions in @file{libgcc.a} are used to perform floating-point
16597 operations.  Unless they are replaced by routines that emulate the
16598 floating-point operations, or compiled in such a way as to call such
16599 emulations routines, these routines issue floating-point
16600 operations.   If you are compiling for an Alpha without floating-point
16601 operations, you must ensure that the library is built so as not to call
16602 them.
16604 Note that Alpha implementations without floating-point operations are
16605 required to have floating-point registers.
16607 @item -mfp-reg
16608 @itemx -mno-fp-regs
16609 @opindex mfp-reg
16610 @opindex mno-fp-regs
16611 Generate code that uses (does not use) the floating-point register set.
16612 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
16613 register set is not used, floating-point operands are passed in integer
16614 registers as if they were integers and floating-point results are passed
16615 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
16616 so any function with a floating-point argument or return value called by code
16617 compiled with @option{-mno-fp-regs} must also be compiled with that
16618 option.
16620 A typical use of this option is building a kernel that does not use,
16621 and hence need not save and restore, any floating-point registers.
16623 @item -mieee
16624 @opindex mieee
16625 The Alpha architecture implements floating-point hardware optimized for
16626 maximum performance.  It is mostly compliant with the IEEE floating-point
16627 standard.  However, for full compliance, software assistance is
16628 required.  This option generates code fully IEEE-compliant code
16629 @emph{except} that the @var{inexact-flag} is not maintained (see below).
16630 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
16631 defined during compilation.  The resulting code is less efficient but is
16632 able to correctly support denormalized numbers and exceptional IEEE
16633 values such as not-a-number and plus/minus infinity.  Other Alpha
16634 compilers call this option @option{-ieee_with_no_inexact}.
16636 @item -mieee-with-inexact
16637 @opindex mieee-with-inexact
16638 This is like @option{-mieee} except the generated code also maintains
16639 the IEEE @var{inexact-flag}.  Turning on this option causes the
16640 generated code to implement fully-compliant IEEE math.  In addition to
16641 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
16642 macro.  On some Alpha implementations the resulting code may execute
16643 significantly slower than the code generated by default.  Since there is
16644 very little code that depends on the @var{inexact-flag}, you should
16645 normally not specify this option.  Other Alpha compilers call this
16646 option @option{-ieee_with_inexact}.
16648 @item -mfp-trap-mode=@var{trap-mode}
16649 @opindex mfp-trap-mode
16650 This option controls what floating-point related traps are enabled.
16651 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
16652 The trap mode can be set to one of four values:
16654 @table @samp
16655 @item n
16656 This is the default (normal) setting.  The only traps that are enabled
16657 are the ones that cannot be disabled in software (e.g., division by zero
16658 trap).
16660 @item u
16661 In addition to the traps enabled by @samp{n}, underflow traps are enabled
16662 as well.
16664 @item su
16665 Like @samp{u}, but the instructions are marked to be safe for software
16666 completion (see Alpha architecture manual for details).
16668 @item sui
16669 Like @samp{su}, but inexact traps are enabled as well.
16670 @end table
16672 @item -mfp-rounding-mode=@var{rounding-mode}
16673 @opindex mfp-rounding-mode
16674 Selects the IEEE rounding mode.  Other Alpha compilers call this option
16675 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
16678 @table @samp
16679 @item n
16680 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
16681 the nearest machine number or towards the even machine number in case
16682 of a tie.
16684 @item m
16685 Round towards minus infinity.
16687 @item c
16688 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
16690 @item d
16691 Dynamic rounding mode.  A field in the floating-point control register
16692 (@var{fpcr}, see Alpha architecture reference manual) controls the
16693 rounding mode in effect.  The C library initializes this register for
16694 rounding towards plus infinity.  Thus, unless your program modifies the
16695 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
16696 @end table
16698 @item -mtrap-precision=@var{trap-precision}
16699 @opindex mtrap-precision
16700 In the Alpha architecture, floating-point traps are imprecise.  This
16701 means without software assistance it is impossible to recover from a
16702 floating trap and program execution normally needs to be terminated.
16703 GCC can generate code that can assist operating system trap handlers
16704 in determining the exact location that caused a floating-point trap.
16705 Depending on the requirements of an application, different levels of
16706 precisions can be selected:
16708 @table @samp
16709 @item p
16710 Program precision.  This option is the default and means a trap handler
16711 can only identify which program caused a floating-point exception.
16713 @item f
16714 Function precision.  The trap handler can determine the function that
16715 caused a floating-point exception.
16717 @item i
16718 Instruction precision.  The trap handler can determine the exact
16719 instruction that caused a floating-point exception.
16720 @end table
16722 Other Alpha compilers provide the equivalent options called
16723 @option{-scope_safe} and @option{-resumption_safe}.
16725 @item -mieee-conformant
16726 @opindex mieee-conformant
16727 This option marks the generated code as IEEE conformant.  You must not
16728 use this option unless you also specify @option{-mtrap-precision=i} and either
16729 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
16730 is to emit the line @samp{.eflag 48} in the function prologue of the
16731 generated assembly file.
16733 @item -mbuild-constants
16734 @opindex mbuild-constants
16735 Normally GCC examines a 32- or 64-bit integer constant to
16736 see if it can construct it from smaller constants in two or three
16737 instructions.  If it cannot, it outputs the constant as a literal and
16738 generates code to load it from the data segment at run time.
16740 Use this option to require GCC to construct @emph{all} integer constants
16741 using code, even if it takes more instructions (the maximum is six).
16743 You typically use this option to build a shared library dynamic
16744 loader.  Itself a shared library, it must relocate itself in memory
16745 before it can find the variables and constants in its own data segment.
16747 @item -mbwx
16748 @itemx -mno-bwx
16749 @itemx -mcix
16750 @itemx -mno-cix
16751 @itemx -mfix
16752 @itemx -mno-fix
16753 @itemx -mmax
16754 @itemx -mno-max
16755 @opindex mbwx
16756 @opindex mno-bwx
16757 @opindex mcix
16758 @opindex mno-cix
16759 @opindex mfix
16760 @opindex mno-fix
16761 @opindex mmax
16762 @opindex mno-max
16763 Indicate whether GCC should generate code to use the optional BWX,
16764 CIX, FIX and MAX instruction sets.  The default is to use the instruction
16765 sets supported by the CPU type specified via @option{-mcpu=} option or that
16766 of the CPU on which GCC was built if none is specified.
16768 @item -mfloat-vax
16769 @itemx -mfloat-ieee
16770 @opindex mfloat-vax
16771 @opindex mfloat-ieee
16772 Generate code that uses (does not use) VAX F and G floating-point
16773 arithmetic instead of IEEE single and double precision.
16775 @item -mexplicit-relocs
16776 @itemx -mno-explicit-relocs
16777 @opindex mexplicit-relocs
16778 @opindex mno-explicit-relocs
16779 Older Alpha assemblers provided no way to generate symbol relocations
16780 except via assembler macros.  Use of these macros does not allow
16781 optimal instruction scheduling.  GNU binutils as of version 2.12
16782 supports a new syntax that allows the compiler to explicitly mark
16783 which relocations should apply to which instructions.  This option
16784 is mostly useful for debugging, as GCC detects the capabilities of
16785 the assembler when it is built and sets the default accordingly.
16787 @item -msmall-data
16788 @itemx -mlarge-data
16789 @opindex msmall-data
16790 @opindex mlarge-data
16791 When @option{-mexplicit-relocs} is in effect, static data is
16792 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
16793 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
16794 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
16795 16-bit relocations off of the @code{$gp} register.  This limits the
16796 size of the small data area to 64KB, but allows the variables to be
16797 directly accessed via a single instruction.
16799 The default is @option{-mlarge-data}.  With this option the data area
16800 is limited to just below 2GB@.  Programs that require more than 2GB of
16801 data must use @code{malloc} or @code{mmap} to allocate the data in the
16802 heap instead of in the program's data segment.
16804 When generating code for shared libraries, @option{-fpic} implies
16805 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
16807 @item -msmall-text
16808 @itemx -mlarge-text
16809 @opindex msmall-text
16810 @opindex mlarge-text
16811 When @option{-msmall-text} is used, the compiler assumes that the
16812 code of the entire program (or shared library) fits in 4MB, and is
16813 thus reachable with a branch instruction.  When @option{-msmall-data}
16814 is used, the compiler can assume that all local symbols share the
16815 same @code{$gp} value, and thus reduce the number of instructions
16816 required for a function call from 4 to 1.
16818 The default is @option{-mlarge-text}.
16820 @item -mcpu=@var{cpu_type}
16821 @opindex mcpu
16822 Set the instruction set and instruction scheduling parameters for
16823 machine type @var{cpu_type}.  You can specify either the @samp{EV}
16824 style name or the corresponding chip number.  GCC supports scheduling
16825 parameters for the EV4, EV5 and EV6 family of processors and
16826 chooses the default values for the instruction set from the processor
16827 you specify.  If you do not specify a processor type, GCC defaults
16828 to the processor on which the compiler was built.
16830 Supported values for @var{cpu_type} are
16832 @table @samp
16833 @item ev4
16834 @itemx ev45
16835 @itemx 21064
16836 Schedules as an EV4 and has no instruction set extensions.
16838 @item ev5
16839 @itemx 21164
16840 Schedules as an EV5 and has no instruction set extensions.
16842 @item ev56
16843 @itemx 21164a
16844 Schedules as an EV5 and supports the BWX extension.
16846 @item pca56
16847 @itemx 21164pc
16848 @itemx 21164PC
16849 Schedules as an EV5 and supports the BWX and MAX extensions.
16851 @item ev6
16852 @itemx 21264
16853 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
16855 @item ev67
16856 @itemx 21264a
16857 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
16858 @end table
16860 Native toolchains also support the value @samp{native},
16861 which selects the best architecture option for the host processor.
16862 @option{-mcpu=native} has no effect if GCC does not recognize
16863 the processor.
16865 @item -mtune=@var{cpu_type}
16866 @opindex mtune
16867 Set only the instruction scheduling parameters for machine type
16868 @var{cpu_type}.  The instruction set is not changed.
16870 Native toolchains also support the value @samp{native},
16871 which selects the best architecture option for the host processor.
16872 @option{-mtune=native} has no effect if GCC does not recognize
16873 the processor.
16875 @item -mmemory-latency=@var{time}
16876 @opindex mmemory-latency
16877 Sets the latency the scheduler should assume for typical memory
16878 references as seen by the application.  This number is highly
16879 dependent on the memory access patterns used by the application
16880 and the size of the external cache on the machine.
16882 Valid options for @var{time} are
16884 @table @samp
16885 @item @var{number}
16886 A decimal number representing clock cycles.
16888 @item L1
16889 @itemx L2
16890 @itemx L3
16891 @itemx main
16892 The compiler contains estimates of the number of clock cycles for
16893 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
16894 (also called Dcache, Scache, and Bcache), as well as to main memory.
16895 Note that L3 is only valid for EV5.
16897 @end table
16898 @end table
16900 @node FR30 Options
16901 @subsection FR30 Options
16902 @cindex FR30 Options
16904 These options are defined specifically for the FR30 port.
16906 @table @gcctabopt
16908 @item -msmall-model
16909 @opindex msmall-model
16910 Use the small address space model.  This can produce smaller code, but
16911 it does assume that all symbolic values and addresses fit into a
16912 20-bit range.
16914 @item -mno-lsim
16915 @opindex mno-lsim
16916 Assume that runtime support has been provided and so there is no need
16917 to include the simulator library (@file{libsim.a}) on the linker
16918 command line.
16920 @end table
16922 @node FT32 Options
16923 @subsection FT32 Options
16924 @cindex FT32 Options
16926 These options are defined specifically for the FT32 port.
16928 @table @gcctabopt
16930 @item -msim
16931 @opindex msim
16932 Specifies that the program will be run on the simulator.  This causes
16933 an alternate runtime startup and library to be linked.
16934 You must not use this option when generating programs that will run on
16935 real hardware; you must provide your own runtime library for whatever
16936 I/O functions are needed.
16938 @item -mlra
16939 @opindex mlra
16940 Enable Local Register Allocation.  This is still experimental for FT32,
16941 so by default the compiler uses standard reload.
16943 @item -mnodiv
16944 @opindex mnodiv
16945 Do not use div and mod instructions.
16947 @end table
16949 @node FRV Options
16950 @subsection FRV Options
16951 @cindex FRV Options
16953 @table @gcctabopt
16954 @item -mgpr-32
16955 @opindex mgpr-32
16957 Only use the first 32 general-purpose registers.
16959 @item -mgpr-64
16960 @opindex mgpr-64
16962 Use all 64 general-purpose registers.
16964 @item -mfpr-32
16965 @opindex mfpr-32
16967 Use only the first 32 floating-point registers.
16969 @item -mfpr-64
16970 @opindex mfpr-64
16972 Use all 64 floating-point registers.
16974 @item -mhard-float
16975 @opindex mhard-float
16977 Use hardware instructions for floating-point operations.
16979 @item -msoft-float
16980 @opindex msoft-float
16982 Use library routines for floating-point operations.
16984 @item -malloc-cc
16985 @opindex malloc-cc
16987 Dynamically allocate condition code registers.
16989 @item -mfixed-cc
16990 @opindex mfixed-cc
16992 Do not try to dynamically allocate condition code registers, only
16993 use @code{icc0} and @code{fcc0}.
16995 @item -mdword
16996 @opindex mdword
16998 Change ABI to use double word insns.
17000 @item -mno-dword
17001 @opindex mno-dword
17003 Do not use double word instructions.
17005 @item -mdouble
17006 @opindex mdouble
17008 Use floating-point double instructions.
17010 @item -mno-double
17011 @opindex mno-double
17013 Do not use floating-point double instructions.
17015 @item -mmedia
17016 @opindex mmedia
17018 Use media instructions.
17020 @item -mno-media
17021 @opindex mno-media
17023 Do not use media instructions.
17025 @item -mmuladd
17026 @opindex mmuladd
17028 Use multiply and add/subtract instructions.
17030 @item -mno-muladd
17031 @opindex mno-muladd
17033 Do not use multiply and add/subtract instructions.
17035 @item -mfdpic
17036 @opindex mfdpic
17038 Select the FDPIC ABI, which uses function descriptors to represent
17039 pointers to functions.  Without any PIC/PIE-related options, it
17040 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17041 assumes GOT entries and small data are within a 12-bit range from the
17042 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17043 are computed with 32 bits.
17044 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17046 @item -minline-plt
17047 @opindex minline-plt
17049 Enable inlining of PLT entries in function calls to functions that are
17050 not known to bind locally.  It has no effect without @option{-mfdpic}.
17051 It's enabled by default if optimizing for speed and compiling for
17052 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17053 optimization option such as @option{-O3} or above is present in the
17054 command line.
17056 @item -mTLS
17057 @opindex mTLS
17059 Assume a large TLS segment when generating thread-local code.
17061 @item -mtls
17062 @opindex mtls
17064 Do not assume a large TLS segment when generating thread-local code.
17066 @item -mgprel-ro
17067 @opindex mgprel-ro
17069 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17070 that is known to be in read-only sections.  It's enabled by default,
17071 except for @option{-fpic} or @option{-fpie}: even though it may help
17072 make the global offset table smaller, it trades 1 instruction for 4.
17073 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17074 one of which may be shared by multiple symbols, and it avoids the need
17075 for a GOT entry for the referenced symbol, so it's more likely to be a
17076 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17078 @item -multilib-library-pic
17079 @opindex multilib-library-pic
17081 Link with the (library, not FD) pic libraries.  It's implied by
17082 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17083 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17084 it explicitly.
17086 @item -mlinked-fp
17087 @opindex mlinked-fp
17089 Follow the EABI requirement of always creating a frame pointer whenever
17090 a stack frame is allocated.  This option is enabled by default and can
17091 be disabled with @option{-mno-linked-fp}.
17093 @item -mlong-calls
17094 @opindex mlong-calls
17096 Use indirect addressing to call functions outside the current
17097 compilation unit.  This allows the functions to be placed anywhere
17098 within the 32-bit address space.
17100 @item -malign-labels
17101 @opindex malign-labels
17103 Try to align labels to an 8-byte boundary by inserting NOPs into the
17104 previous packet.  This option only has an effect when VLIW packing
17105 is enabled.  It doesn't create new packets; it merely adds NOPs to
17106 existing ones.
17108 @item -mlibrary-pic
17109 @opindex mlibrary-pic
17111 Generate position-independent EABI code.
17113 @item -macc-4
17114 @opindex macc-4
17116 Use only the first four media accumulator registers.
17118 @item -macc-8
17119 @opindex macc-8
17121 Use all eight media accumulator registers.
17123 @item -mpack
17124 @opindex mpack
17126 Pack VLIW instructions.
17128 @item -mno-pack
17129 @opindex mno-pack
17131 Do not pack VLIW instructions.
17133 @item -mno-eflags
17134 @opindex mno-eflags
17136 Do not mark ABI switches in e_flags.
17138 @item -mcond-move
17139 @opindex mcond-move
17141 Enable the use of conditional-move instructions (default).
17143 This switch is mainly for debugging the compiler and will likely be removed
17144 in a future version.
17146 @item -mno-cond-move
17147 @opindex mno-cond-move
17149 Disable the use of conditional-move instructions.
17151 This switch is mainly for debugging the compiler and will likely be removed
17152 in a future version.
17154 @item -mscc
17155 @opindex mscc
17157 Enable the use of conditional set instructions (default).
17159 This switch is mainly for debugging the compiler and will likely be removed
17160 in a future version.
17162 @item -mno-scc
17163 @opindex mno-scc
17165 Disable the use of conditional set instructions.
17167 This switch is mainly for debugging the compiler and will likely be removed
17168 in a future version.
17170 @item -mcond-exec
17171 @opindex mcond-exec
17173 Enable the use of conditional execution (default).
17175 This switch is mainly for debugging the compiler and will likely be removed
17176 in a future version.
17178 @item -mno-cond-exec
17179 @opindex mno-cond-exec
17181 Disable the use of conditional execution.
17183 This switch is mainly for debugging the compiler and will likely be removed
17184 in a future version.
17186 @item -mvliw-branch
17187 @opindex mvliw-branch
17189 Run a pass to pack branches into VLIW instructions (default).
17191 This switch is mainly for debugging the compiler and will likely be removed
17192 in a future version.
17194 @item -mno-vliw-branch
17195 @opindex mno-vliw-branch
17197 Do not run a pass to pack branches into VLIW instructions.
17199 This switch is mainly for debugging the compiler and will likely be removed
17200 in a future version.
17202 @item -mmulti-cond-exec
17203 @opindex mmulti-cond-exec
17205 Enable optimization of @code{&&} and @code{||} in conditional execution
17206 (default).
17208 This switch is mainly for debugging the compiler and will likely be removed
17209 in a future version.
17211 @item -mno-multi-cond-exec
17212 @opindex mno-multi-cond-exec
17214 Disable optimization of @code{&&} and @code{||} in conditional execution.
17216 This switch is mainly for debugging the compiler and will likely be removed
17217 in a future version.
17219 @item -mnested-cond-exec
17220 @opindex mnested-cond-exec
17222 Enable nested conditional execution optimizations (default).
17224 This switch is mainly for debugging the compiler and will likely be removed
17225 in a future version.
17227 @item -mno-nested-cond-exec
17228 @opindex mno-nested-cond-exec
17230 Disable nested conditional execution optimizations.
17232 This switch is mainly for debugging the compiler and will likely be removed
17233 in a future version.
17235 @item -moptimize-membar
17236 @opindex moptimize-membar
17238 This switch removes redundant @code{membar} instructions from the
17239 compiler-generated code.  It is enabled by default.
17241 @item -mno-optimize-membar
17242 @opindex mno-optimize-membar
17244 This switch disables the automatic removal of redundant @code{membar}
17245 instructions from the generated code.
17247 @item -mtomcat-stats
17248 @opindex mtomcat-stats
17250 Cause gas to print out tomcat statistics.
17252 @item -mcpu=@var{cpu}
17253 @opindex mcpu
17255 Select the processor type for which to generate code.  Possible values are
17256 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17257 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17259 @end table
17261 @node GNU/Linux Options
17262 @subsection GNU/Linux Options
17264 These @samp{-m} options are defined for GNU/Linux targets:
17266 @table @gcctabopt
17267 @item -mglibc
17268 @opindex mglibc
17269 Use the GNU C library.  This is the default except
17270 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17271 @samp{*-*-linux-*android*} targets.
17273 @item -muclibc
17274 @opindex muclibc
17275 Use uClibc C library.  This is the default on
17276 @samp{*-*-linux-*uclibc*} targets.
17278 @item -mmusl
17279 @opindex mmusl
17280 Use the musl C library.  This is the default on
17281 @samp{*-*-linux-*musl*} targets.
17283 @item -mbionic
17284 @opindex mbionic
17285 Use Bionic C library.  This is the default on
17286 @samp{*-*-linux-*android*} targets.
17288 @item -mandroid
17289 @opindex mandroid
17290 Compile code compatible with Android platform.  This is the default on
17291 @samp{*-*-linux-*android*} targets.
17293 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17294 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17295 this option makes the GCC driver pass Android-specific options to the linker.
17296 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17297 to be defined.
17299 @item -tno-android-cc
17300 @opindex tno-android-cc
17301 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17302 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17303 @option{-fno-rtti} by default.
17305 @item -tno-android-ld
17306 @opindex tno-android-ld
17307 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17308 linking options to the linker.
17310 @end table
17312 @node H8/300 Options
17313 @subsection H8/300 Options
17315 These @samp{-m} options are defined for the H8/300 implementations:
17317 @table @gcctabopt
17318 @item -mrelax
17319 @opindex mrelax
17320 Shorten some address references at link time, when possible; uses the
17321 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17322 ld, Using ld}, for a fuller description.
17324 @item -mh
17325 @opindex mh
17326 Generate code for the H8/300H@.
17328 @item -ms
17329 @opindex ms
17330 Generate code for the H8S@.
17332 @item -mn
17333 @opindex mn
17334 Generate code for the H8S and H8/300H in the normal mode.  This switch
17335 must be used either with @option{-mh} or @option{-ms}.
17337 @item -ms2600
17338 @opindex ms2600
17339 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17341 @item -mexr
17342 @opindex mexr
17343 Extended registers are stored on stack before execution of function
17344 with monitor attribute. Default option is @option{-mexr}.
17345 This option is valid only for H8S targets.
17347 @item -mno-exr
17348 @opindex mno-exr
17349 Extended registers are not stored on stack before execution of function 
17350 with monitor attribute. Default option is @option{-mno-exr}. 
17351 This option is valid only for H8S targets.
17353 @item -mint32
17354 @opindex mint32
17355 Make @code{int} data 32 bits by default.
17357 @item -malign-300
17358 @opindex malign-300
17359 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17360 The default for the H8/300H and H8S is to align longs and floats on
17361 4-byte boundaries.
17362 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17363 This option has no effect on the H8/300.
17364 @end table
17366 @node HPPA Options
17367 @subsection HPPA Options
17368 @cindex HPPA Options
17370 These @samp{-m} options are defined for the HPPA family of computers:
17372 @table @gcctabopt
17373 @item -march=@var{architecture-type}
17374 @opindex march
17375 Generate code for the specified architecture.  The choices for
17376 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17377 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17378 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17379 architecture option for your machine.  Code compiled for lower numbered
17380 architectures runs on higher numbered architectures, but not the
17381 other way around.
17383 @item -mpa-risc-1-0
17384 @itemx -mpa-risc-1-1
17385 @itemx -mpa-risc-2-0
17386 @opindex mpa-risc-1-0
17387 @opindex mpa-risc-1-1
17388 @opindex mpa-risc-2-0
17389 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17391 @item -mcaller-copies
17392 @opindex mcaller-copies
17393 The caller copies function arguments passed by hidden reference.  This
17394 option should be used with care as it is not compatible with the default
17395 32-bit runtime.  However, only aggregates larger than eight bytes are
17396 passed by hidden reference and the option provides better compatibility
17397 with OpenMP.
17399 @item -mjump-in-delay
17400 @opindex mjump-in-delay
17401 This option is ignored and provided for compatibility purposes only.
17403 @item -mdisable-fpregs
17404 @opindex mdisable-fpregs
17405 Prevent floating-point registers from being used in any manner.  This is
17406 necessary for compiling kernels that perform lazy context switching of
17407 floating-point registers.  If you use this option and attempt to perform
17408 floating-point operations, the compiler aborts.
17410 @item -mdisable-indexing
17411 @opindex mdisable-indexing
17412 Prevent the compiler from using indexing address modes.  This avoids some
17413 rather obscure problems when compiling MIG generated code under MACH@.
17415 @item -mno-space-regs
17416 @opindex mno-space-regs
17417 Generate code that assumes the target has no space registers.  This allows
17418 GCC to generate faster indirect calls and use unscaled index address modes.
17420 Such code is suitable for level 0 PA systems and kernels.
17422 @item -mfast-indirect-calls
17423 @opindex mfast-indirect-calls
17424 Generate code that assumes calls never cross space boundaries.  This
17425 allows GCC to emit code that performs faster indirect calls.
17427 This option does not work in the presence of shared libraries or nested
17428 functions.
17430 @item -mfixed-range=@var{register-range}
17431 @opindex mfixed-range
17432 Generate code treating the given register range as fixed registers.
17433 A fixed register is one that the register allocator cannot use.  This is
17434 useful when compiling kernel code.  A register range is specified as
17435 two registers separated by a dash.  Multiple register ranges can be
17436 specified separated by a comma.
17438 @item -mlong-load-store
17439 @opindex mlong-load-store
17440 Generate 3-instruction load and store sequences as sometimes required by
17441 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17442 the HP compilers.
17444 @item -mportable-runtime
17445 @opindex mportable-runtime
17446 Use the portable calling conventions proposed by HP for ELF systems.
17448 @item -mgas
17449 @opindex mgas
17450 Enable the use of assembler directives only GAS understands.
17452 @item -mschedule=@var{cpu-type}
17453 @opindex mschedule
17454 Schedule code according to the constraints for the machine type
17455 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17456 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17457 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17458 proper scheduling option for your machine.  The default scheduling is
17459 @samp{8000}.
17461 @item -mlinker-opt
17462 @opindex mlinker-opt
17463 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17464 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17465 linkers in which they give bogus error messages when linking some programs.
17467 @item -msoft-float
17468 @opindex msoft-float
17469 Generate output containing library calls for floating point.
17470 @strong{Warning:} the requisite libraries are not available for all HPPA
17471 targets.  Normally the facilities of the machine's usual C compiler are
17472 used, but this cannot be done directly in cross-compilation.  You must make
17473 your own arrangements to provide suitable library functions for
17474 cross-compilation.
17476 @option{-msoft-float} changes the calling convention in the output file;
17477 therefore, it is only useful if you compile @emph{all} of a program with
17478 this option.  In particular, you need to compile @file{libgcc.a}, the
17479 library that comes with GCC, with @option{-msoft-float} in order for
17480 this to work.
17482 @item -msio
17483 @opindex msio
17484 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17485 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17486 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17487 options are available under HP-UX and HI-UX@.
17489 @item -mgnu-ld
17490 @opindex mgnu-ld
17491 Use options specific to GNU @command{ld}.
17492 This passes @option{-shared} to @command{ld} when
17493 building a shared library.  It is the default when GCC is configured,
17494 explicitly or implicitly, with the GNU linker.  This option does not
17495 affect which @command{ld} is called; it only changes what parameters
17496 are passed to that @command{ld}.
17497 The @command{ld} that is called is determined by the
17498 @option{--with-ld} configure option, GCC's program search path, and
17499 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17500 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17501 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17503 @item -mhp-ld
17504 @opindex mhp-ld
17505 Use options specific to HP @command{ld}.
17506 This passes @option{-b} to @command{ld} when building
17507 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17508 links.  It is the default when GCC is configured, explicitly or
17509 implicitly, with the HP linker.  This option does not affect
17510 which @command{ld} is called; it only changes what parameters are passed to that
17511 @command{ld}.
17512 The @command{ld} that is called is determined by the @option{--with-ld}
17513 configure option, GCC's program search path, and finally by the user's
17514 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17515 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17516 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17518 @item -mlong-calls
17519 @opindex mno-long-calls
17520 Generate code that uses long call sequences.  This ensures that a call
17521 is always able to reach linker generated stubs.  The default is to generate
17522 long calls only when the distance from the call site to the beginning
17523 of the function or translation unit, as the case may be, exceeds a
17524 predefined limit set by the branch type being used.  The limits for
17525 normal calls are 7,600,000 and 240,000 bytes, respectively for the
17526 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
17527 240,000 bytes.
17529 Distances are measured from the beginning of functions when using the
17530 @option{-ffunction-sections} option, or when using the @option{-mgas}
17531 and @option{-mno-portable-runtime} options together under HP-UX with
17532 the SOM linker.
17534 It is normally not desirable to use this option as it degrades
17535 performance.  However, it may be useful in large applications,
17536 particularly when partial linking is used to build the application.
17538 The types of long calls used depends on the capabilities of the
17539 assembler and linker, and the type of code being generated.  The
17540 impact on systems that support long absolute calls, and long pic
17541 symbol-difference or pc-relative calls should be relatively small.
17542 However, an indirect call is used on 32-bit ELF systems in pic code
17543 and it is quite long.
17545 @item -munix=@var{unix-std}
17546 @opindex march
17547 Generate compiler predefines and select a startfile for the specified
17548 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
17549 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
17550 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
17551 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
17552 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
17553 and later.
17555 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
17556 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
17557 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
17558 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
17559 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
17560 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
17562 It is @emph{important} to note that this option changes the interfaces
17563 for various library routines.  It also affects the operational behavior
17564 of the C library.  Thus, @emph{extreme} care is needed in using this
17565 option.
17567 Library code that is intended to operate with more than one UNIX
17568 standard must test, set and restore the variable @code{__xpg4_extended_mask}
17569 as appropriate.  Most GNU software doesn't provide this capability.
17571 @item -nolibdld
17572 @opindex nolibdld
17573 Suppress the generation of link options to search libdld.sl when the
17574 @option{-static} option is specified on HP-UX 10 and later.
17576 @item -static
17577 @opindex static
17578 The HP-UX implementation of setlocale in libc has a dependency on
17579 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
17580 when the @option{-static} option is specified, special link options
17581 are needed to resolve this dependency.
17583 On HP-UX 10 and later, the GCC driver adds the necessary options to
17584 link with libdld.sl when the @option{-static} option is specified.
17585 This causes the resulting binary to be dynamic.  On the 64-bit port,
17586 the linkers generate dynamic binaries by default in any case.  The
17587 @option{-nolibdld} option can be used to prevent the GCC driver from
17588 adding these link options.
17590 @item -threads
17591 @opindex threads
17592 Add support for multithreading with the @dfn{dce thread} library
17593 under HP-UX@.  This option sets flags for both the preprocessor and
17594 linker.
17595 @end table
17597 @node IA-64 Options
17598 @subsection IA-64 Options
17599 @cindex IA-64 Options
17601 These are the @samp{-m} options defined for the Intel IA-64 architecture.
17603 @table @gcctabopt
17604 @item -mbig-endian
17605 @opindex mbig-endian
17606 Generate code for a big-endian target.  This is the default for HP-UX@.
17608 @item -mlittle-endian
17609 @opindex mlittle-endian
17610 Generate code for a little-endian target.  This is the default for AIX5
17611 and GNU/Linux.
17613 @item -mgnu-as
17614 @itemx -mno-gnu-as
17615 @opindex mgnu-as
17616 @opindex mno-gnu-as
17617 Generate (or don't) code for the GNU assembler.  This is the default.
17618 @c Also, this is the default if the configure option @option{--with-gnu-as}
17619 @c is used.
17621 @item -mgnu-ld
17622 @itemx -mno-gnu-ld
17623 @opindex mgnu-ld
17624 @opindex mno-gnu-ld
17625 Generate (or don't) code for the GNU linker.  This is the default.
17626 @c Also, this is the default if the configure option @option{--with-gnu-ld}
17627 @c is used.
17629 @item -mno-pic
17630 @opindex mno-pic
17631 Generate code that does not use a global pointer register.  The result
17632 is not position independent code, and violates the IA-64 ABI@.
17634 @item -mvolatile-asm-stop
17635 @itemx -mno-volatile-asm-stop
17636 @opindex mvolatile-asm-stop
17637 @opindex mno-volatile-asm-stop
17638 Generate (or don't) a stop bit immediately before and after volatile asm
17639 statements.
17641 @item -mregister-names
17642 @itemx -mno-register-names
17643 @opindex mregister-names
17644 @opindex mno-register-names
17645 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
17646 the stacked registers.  This may make assembler output more readable.
17648 @item -mno-sdata
17649 @itemx -msdata
17650 @opindex mno-sdata
17651 @opindex msdata
17652 Disable (or enable) optimizations that use the small data section.  This may
17653 be useful for working around optimizer bugs.
17655 @item -mconstant-gp
17656 @opindex mconstant-gp
17657 Generate code that uses a single constant global pointer value.  This is
17658 useful when compiling kernel code.
17660 @item -mauto-pic
17661 @opindex mauto-pic
17662 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
17663 This is useful when compiling firmware code.
17665 @item -minline-float-divide-min-latency
17666 @opindex minline-float-divide-min-latency
17667 Generate code for inline divides of floating-point values
17668 using the minimum latency algorithm.
17670 @item -minline-float-divide-max-throughput
17671 @opindex minline-float-divide-max-throughput
17672 Generate code for inline divides of floating-point values
17673 using the maximum throughput algorithm.
17675 @item -mno-inline-float-divide
17676 @opindex mno-inline-float-divide
17677 Do not generate inline code for divides of floating-point values.
17679 @item -minline-int-divide-min-latency
17680 @opindex minline-int-divide-min-latency
17681 Generate code for inline divides of integer values
17682 using the minimum latency algorithm.
17684 @item -minline-int-divide-max-throughput
17685 @opindex minline-int-divide-max-throughput
17686 Generate code for inline divides of integer values
17687 using the maximum throughput algorithm.
17689 @item -mno-inline-int-divide
17690 @opindex mno-inline-int-divide
17691 Do not generate inline code for divides of integer values.
17693 @item -minline-sqrt-min-latency
17694 @opindex minline-sqrt-min-latency
17695 Generate code for inline square roots
17696 using the minimum latency algorithm.
17698 @item -minline-sqrt-max-throughput
17699 @opindex minline-sqrt-max-throughput
17700 Generate code for inline square roots
17701 using the maximum throughput algorithm.
17703 @item -mno-inline-sqrt
17704 @opindex mno-inline-sqrt
17705 Do not generate inline code for @code{sqrt}.
17707 @item -mfused-madd
17708 @itemx -mno-fused-madd
17709 @opindex mfused-madd
17710 @opindex mno-fused-madd
17711 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
17712 instructions.  The default is to use these instructions.
17714 @item -mno-dwarf2-asm
17715 @itemx -mdwarf2-asm
17716 @opindex mno-dwarf2-asm
17717 @opindex mdwarf2-asm
17718 Don't (or do) generate assembler code for the DWARF line number debugging
17719 info.  This may be useful when not using the GNU assembler.
17721 @item -mearly-stop-bits
17722 @itemx -mno-early-stop-bits
17723 @opindex mearly-stop-bits
17724 @opindex mno-early-stop-bits
17725 Allow stop bits to be placed earlier than immediately preceding the
17726 instruction that triggered the stop bit.  This can improve instruction
17727 scheduling, but does not always do so.
17729 @item -mfixed-range=@var{register-range}
17730 @opindex mfixed-range
17731 Generate code treating the given register range as fixed registers.
17732 A fixed register is one that the register allocator cannot use.  This is
17733 useful when compiling kernel code.  A register range is specified as
17734 two registers separated by a dash.  Multiple register ranges can be
17735 specified separated by a comma.
17737 @item -mtls-size=@var{tls-size}
17738 @opindex mtls-size
17739 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
17742 @item -mtune=@var{cpu-type}
17743 @opindex mtune
17744 Tune the instruction scheduling for a particular CPU, Valid values are
17745 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
17746 and @samp{mckinley}.
17748 @item -milp32
17749 @itemx -mlp64
17750 @opindex milp32
17751 @opindex mlp64
17752 Generate code for a 32-bit or 64-bit environment.
17753 The 32-bit environment sets int, long and pointer to 32 bits.
17754 The 64-bit environment sets int to 32 bits and long and pointer
17755 to 64 bits.  These are HP-UX specific flags.
17757 @item -mno-sched-br-data-spec
17758 @itemx -msched-br-data-spec
17759 @opindex mno-sched-br-data-spec
17760 @opindex msched-br-data-spec
17761 (Dis/En)able data speculative scheduling before reload.
17762 This results in generation of @code{ld.a} instructions and
17763 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17764 The default setting is disabled.
17766 @item -msched-ar-data-spec
17767 @itemx -mno-sched-ar-data-spec
17768 @opindex msched-ar-data-spec
17769 @opindex mno-sched-ar-data-spec
17770 (En/Dis)able data speculative scheduling after reload.
17771 This results in generation of @code{ld.a} instructions and
17772 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17773 The default setting is enabled.
17775 @item -mno-sched-control-spec
17776 @itemx -msched-control-spec
17777 @opindex mno-sched-control-spec
17778 @opindex msched-control-spec
17779 (Dis/En)able control speculative scheduling.  This feature is
17780 available only during region scheduling (i.e.@: before reload).
17781 This results in generation of the @code{ld.s} instructions and
17782 the corresponding check instructions @code{chk.s}.
17783 The default setting is disabled.
17785 @item -msched-br-in-data-spec
17786 @itemx -mno-sched-br-in-data-spec
17787 @opindex msched-br-in-data-spec
17788 @opindex mno-sched-br-in-data-spec
17789 (En/Dis)able speculative scheduling of the instructions that
17790 are dependent on the data speculative loads before reload.
17791 This is effective only with @option{-msched-br-data-spec} enabled.
17792 The default setting is enabled.
17794 @item -msched-ar-in-data-spec
17795 @itemx -mno-sched-ar-in-data-spec
17796 @opindex msched-ar-in-data-spec
17797 @opindex mno-sched-ar-in-data-spec
17798 (En/Dis)able speculative scheduling of the instructions that
17799 are dependent on the data speculative loads after reload.
17800 This is effective only with @option{-msched-ar-data-spec} enabled.
17801 The default setting is enabled.
17803 @item -msched-in-control-spec
17804 @itemx -mno-sched-in-control-spec
17805 @opindex msched-in-control-spec
17806 @opindex mno-sched-in-control-spec
17807 (En/Dis)able speculative scheduling of the instructions that
17808 are dependent on the control speculative loads.
17809 This is effective only with @option{-msched-control-spec} enabled.
17810 The default setting is enabled.
17812 @item -mno-sched-prefer-non-data-spec-insns
17813 @itemx -msched-prefer-non-data-spec-insns
17814 @opindex mno-sched-prefer-non-data-spec-insns
17815 @opindex msched-prefer-non-data-spec-insns
17816 If enabled, data-speculative instructions are chosen for schedule
17817 only if there are no other choices at the moment.  This makes
17818 the use of the data speculation much more conservative.
17819 The default setting is disabled.
17821 @item -mno-sched-prefer-non-control-spec-insns
17822 @itemx -msched-prefer-non-control-spec-insns
17823 @opindex mno-sched-prefer-non-control-spec-insns
17824 @opindex msched-prefer-non-control-spec-insns
17825 If enabled, control-speculative instructions are chosen for schedule
17826 only if there are no other choices at the moment.  This makes
17827 the use of the control speculation much more conservative.
17828 The default setting is disabled.
17830 @item -mno-sched-count-spec-in-critical-path
17831 @itemx -msched-count-spec-in-critical-path
17832 @opindex mno-sched-count-spec-in-critical-path
17833 @opindex msched-count-spec-in-critical-path
17834 If enabled, speculative dependencies are considered during
17835 computation of the instructions priorities.  This makes the use of the
17836 speculation a bit more conservative.
17837 The default setting is disabled.
17839 @item -msched-spec-ldc
17840 @opindex msched-spec-ldc
17841 Use a simple data speculation check.  This option is on by default.
17843 @item -msched-control-spec-ldc
17844 @opindex msched-spec-ldc
17845 Use a simple check for control speculation.  This option is on by default.
17847 @item -msched-stop-bits-after-every-cycle
17848 @opindex msched-stop-bits-after-every-cycle
17849 Place a stop bit after every cycle when scheduling.  This option is on
17850 by default.
17852 @item -msched-fp-mem-deps-zero-cost
17853 @opindex msched-fp-mem-deps-zero-cost
17854 Assume that floating-point stores and loads are not likely to cause a conflict
17855 when placed into the same instruction group.  This option is disabled by
17856 default.
17858 @item -msel-sched-dont-check-control-spec
17859 @opindex msel-sched-dont-check-control-spec
17860 Generate checks for control speculation in selective scheduling.
17861 This flag is disabled by default.
17863 @item -msched-max-memory-insns=@var{max-insns}
17864 @opindex msched-max-memory-insns
17865 Limit on the number of memory insns per instruction group, giving lower
17866 priority to subsequent memory insns attempting to schedule in the same
17867 instruction group. Frequently useful to prevent cache bank conflicts.
17868 The default value is 1.
17870 @item -msched-max-memory-insns-hard-limit
17871 @opindex msched-max-memory-insns-hard-limit
17872 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
17873 disallowing more than that number in an instruction group.
17874 Otherwise, the limit is ``soft'', meaning that non-memory operations
17875 are preferred when the limit is reached, but memory operations may still
17876 be scheduled.
17878 @end table
17880 @node LM32 Options
17881 @subsection LM32 Options
17882 @cindex LM32 options
17884 These @option{-m} options are defined for the LatticeMico32 architecture:
17886 @table @gcctabopt
17887 @item -mbarrel-shift-enabled
17888 @opindex mbarrel-shift-enabled
17889 Enable barrel-shift instructions.
17891 @item -mdivide-enabled
17892 @opindex mdivide-enabled
17893 Enable divide and modulus instructions.
17895 @item -mmultiply-enabled
17896 @opindex multiply-enabled
17897 Enable multiply instructions.
17899 @item -msign-extend-enabled
17900 @opindex msign-extend-enabled
17901 Enable sign extend instructions.
17903 @item -muser-enabled
17904 @opindex muser-enabled
17905 Enable user-defined instructions.
17907 @end table
17909 @node M32C Options
17910 @subsection M32C Options
17911 @cindex M32C options
17913 @table @gcctabopt
17914 @item -mcpu=@var{name}
17915 @opindex mcpu=
17916 Select the CPU for which code is generated.  @var{name} may be one of
17917 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
17918 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
17919 the M32C/80 series.
17921 @item -msim
17922 @opindex msim
17923 Specifies that the program will be run on the simulator.  This causes
17924 an alternate runtime library to be linked in which supports, for
17925 example, file I/O@.  You must not use this option when generating
17926 programs that will run on real hardware; you must provide your own
17927 runtime library for whatever I/O functions are needed.
17929 @item -memregs=@var{number}
17930 @opindex memregs=
17931 Specifies the number of memory-based pseudo-registers GCC uses
17932 during code generation.  These pseudo-registers are used like real
17933 registers, so there is a tradeoff between GCC's ability to fit the
17934 code into available registers, and the performance penalty of using
17935 memory instead of registers.  Note that all modules in a program must
17936 be compiled with the same value for this option.  Because of that, you
17937 must not use this option with GCC's default runtime libraries.
17939 @end table
17941 @node M32R/D Options
17942 @subsection M32R/D Options
17943 @cindex M32R/D options
17945 These @option{-m} options are defined for Renesas M32R/D architectures:
17947 @table @gcctabopt
17948 @item -m32r2
17949 @opindex m32r2
17950 Generate code for the M32R/2@.
17952 @item -m32rx
17953 @opindex m32rx
17954 Generate code for the M32R/X@.
17956 @item -m32r
17957 @opindex m32r
17958 Generate code for the M32R@.  This is the default.
17960 @item -mmodel=small
17961 @opindex mmodel=small
17962 Assume all objects live in the lower 16MB of memory (so that their addresses
17963 can be loaded with the @code{ld24} instruction), and assume all subroutines
17964 are reachable with the @code{bl} instruction.
17965 This is the default.
17967 The addressability of a particular object can be set with the
17968 @code{model} attribute.
17970 @item -mmodel=medium
17971 @opindex mmodel=medium
17972 Assume objects may be anywhere in the 32-bit address space (the compiler
17973 generates @code{seth/add3} instructions to load their addresses), and
17974 assume all subroutines are reachable with the @code{bl} instruction.
17976 @item -mmodel=large
17977 @opindex mmodel=large
17978 Assume objects may be anywhere in the 32-bit address space (the compiler
17979 generates @code{seth/add3} instructions to load their addresses), and
17980 assume subroutines may not be reachable with the @code{bl} instruction
17981 (the compiler generates the much slower @code{seth/add3/jl}
17982 instruction sequence).
17984 @item -msdata=none
17985 @opindex msdata=none
17986 Disable use of the small data area.  Variables are put into
17987 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
17988 @code{section} attribute has been specified).
17989 This is the default.
17991 The small data area consists of sections @code{.sdata} and @code{.sbss}.
17992 Objects may be explicitly put in the small data area with the
17993 @code{section} attribute using one of these sections.
17995 @item -msdata=sdata
17996 @opindex msdata=sdata
17997 Put small global and static data in the small data area, but do not
17998 generate special code to reference them.
18000 @item -msdata=use
18001 @opindex msdata=use
18002 Put small global and static data in the small data area, and generate
18003 special instructions to reference them.
18005 @item -G @var{num}
18006 @opindex G
18007 @cindex smaller data references
18008 Put global and static objects less than or equal to @var{num} bytes
18009 into the small data or BSS sections instead of the normal data or BSS
18010 sections.  The default value of @var{num} is 8.
18011 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18012 for this option to have any effect.
18014 All modules should be compiled with the same @option{-G @var{num}} value.
18015 Compiling with different values of @var{num} may or may not work; if it
18016 doesn't the linker gives an error message---incorrect code is not
18017 generated.
18019 @item -mdebug
18020 @opindex mdebug
18021 Makes the M32R-specific code in the compiler display some statistics
18022 that might help in debugging programs.
18024 @item -malign-loops
18025 @opindex malign-loops
18026 Align all loops to a 32-byte boundary.
18028 @item -mno-align-loops
18029 @opindex mno-align-loops
18030 Do not enforce a 32-byte alignment for loops.  This is the default.
18032 @item -missue-rate=@var{number}
18033 @opindex missue-rate=@var{number}
18034 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18035 or 2.
18037 @item -mbranch-cost=@var{number}
18038 @opindex mbranch-cost=@var{number}
18039 @var{number} can only be 1 or 2.  If it is 1 then branches are
18040 preferred over conditional code, if it is 2, then the opposite applies.
18042 @item -mflush-trap=@var{number}
18043 @opindex mflush-trap=@var{number}
18044 Specifies the trap number to use to flush the cache.  The default is
18045 12.  Valid numbers are between 0 and 15 inclusive.
18047 @item -mno-flush-trap
18048 @opindex mno-flush-trap
18049 Specifies that the cache cannot be flushed by using a trap.
18051 @item -mflush-func=@var{name}
18052 @opindex mflush-func=@var{name}
18053 Specifies the name of the operating system function to call to flush
18054 the cache.  The default is @samp{_flush_cache}, but a function call
18055 is only used if a trap is not available.
18057 @item -mno-flush-func
18058 @opindex mno-flush-func
18059 Indicates that there is no OS function for flushing the cache.
18061 @end table
18063 @node M680x0 Options
18064 @subsection M680x0 Options
18065 @cindex M680x0 options
18067 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18068 The default settings depend on which architecture was selected when
18069 the compiler was configured; the defaults for the most common choices
18070 are given below.
18072 @table @gcctabopt
18073 @item -march=@var{arch}
18074 @opindex march
18075 Generate code for a specific M680x0 or ColdFire instruction set
18076 architecture.  Permissible values of @var{arch} for M680x0
18077 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18078 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18079 architectures are selected according to Freescale's ISA classification
18080 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18081 @samp{isab} and @samp{isac}.
18083 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18084 code for a ColdFire target.  The @var{arch} in this macro is one of the
18085 @option{-march} arguments given above.
18087 When used together, @option{-march} and @option{-mtune} select code
18088 that runs on a family of similar processors but that is optimized
18089 for a particular microarchitecture.
18091 @item -mcpu=@var{cpu}
18092 @opindex mcpu
18093 Generate code for a specific M680x0 or ColdFire processor.
18094 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18095 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18096 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18097 below, which also classifies the CPUs into families:
18099 @multitable @columnfractions 0.20 0.80
18100 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18101 @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}
18102 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18103 @item @samp{5206e} @tab @samp{5206e}
18104 @item @samp{5208} @tab @samp{5207} @samp{5208}
18105 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18106 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18107 @item @samp{5216} @tab @samp{5214} @samp{5216}
18108 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18109 @item @samp{5225} @tab @samp{5224} @samp{5225}
18110 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18111 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18112 @item @samp{5249} @tab @samp{5249}
18113 @item @samp{5250} @tab @samp{5250}
18114 @item @samp{5271} @tab @samp{5270} @samp{5271}
18115 @item @samp{5272} @tab @samp{5272}
18116 @item @samp{5275} @tab @samp{5274} @samp{5275}
18117 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18118 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18119 @item @samp{5307} @tab @samp{5307}
18120 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18121 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18122 @item @samp{5407} @tab @samp{5407}
18123 @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}
18124 @end multitable
18126 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18127 @var{arch} is compatible with @var{cpu}.  Other combinations of
18128 @option{-mcpu} and @option{-march} are rejected.
18130 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18131 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18132 where the value of @var{family} is given by the table above.
18134 @item -mtune=@var{tune}
18135 @opindex mtune
18136 Tune the code for a particular microarchitecture within the
18137 constraints set by @option{-march} and @option{-mcpu}.
18138 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18139 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18140 and @samp{cpu32}.  The ColdFire microarchitectures
18141 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18143 You can also use @option{-mtune=68020-40} for code that needs
18144 to run relatively well on 68020, 68030 and 68040 targets.
18145 @option{-mtune=68020-60} is similar but includes 68060 targets
18146 as well.  These two options select the same tuning decisions as
18147 @option{-m68020-40} and @option{-m68020-60} respectively.
18149 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18150 when tuning for 680x0 architecture @var{arch}.  It also defines
18151 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18152 option is used.  If GCC is tuning for a range of architectures,
18153 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18154 it defines the macros for every architecture in the range.
18156 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18157 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18158 of the arguments given above.
18160 @item -m68000
18161 @itemx -mc68000
18162 @opindex m68000
18163 @opindex mc68000
18164 Generate output for a 68000.  This is the default
18165 when the compiler is configured for 68000-based systems.
18166 It is equivalent to @option{-march=68000}.
18168 Use this option for microcontrollers with a 68000 or EC000 core,
18169 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18171 @item -m68010
18172 @opindex m68010
18173 Generate output for a 68010.  This is the default
18174 when the compiler is configured for 68010-based systems.
18175 It is equivalent to @option{-march=68010}.
18177 @item -m68020
18178 @itemx -mc68020
18179 @opindex m68020
18180 @opindex mc68020
18181 Generate output for a 68020.  This is the default
18182 when the compiler is configured for 68020-based systems.
18183 It is equivalent to @option{-march=68020}.
18185 @item -m68030
18186 @opindex m68030
18187 Generate output for a 68030.  This is the default when the compiler is
18188 configured for 68030-based systems.  It is equivalent to
18189 @option{-march=68030}.
18191 @item -m68040
18192 @opindex m68040
18193 Generate output for a 68040.  This is the default when the compiler is
18194 configured for 68040-based systems.  It is equivalent to
18195 @option{-march=68040}.
18197 This option inhibits the use of 68881/68882 instructions that have to be
18198 emulated by software on the 68040.  Use this option if your 68040 does not
18199 have code to emulate those instructions.
18201 @item -m68060
18202 @opindex m68060
18203 Generate output for a 68060.  This is the default when the compiler is
18204 configured for 68060-based systems.  It is equivalent to
18205 @option{-march=68060}.
18207 This option inhibits the use of 68020 and 68881/68882 instructions that
18208 have to be emulated by software on the 68060.  Use this option if your 68060
18209 does not have code to emulate those instructions.
18211 @item -mcpu32
18212 @opindex mcpu32
18213 Generate output for a CPU32.  This is the default
18214 when the compiler is configured for CPU32-based systems.
18215 It is equivalent to @option{-march=cpu32}.
18217 Use this option for microcontrollers with a
18218 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18219 68336, 68340, 68341, 68349 and 68360.
18221 @item -m5200
18222 @opindex m5200
18223 Generate output for a 520X ColdFire CPU@.  This is the default
18224 when the compiler is configured for 520X-based systems.
18225 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18226 in favor of that option.
18228 Use this option for microcontroller with a 5200 core, including
18229 the MCF5202, MCF5203, MCF5204 and MCF5206.
18231 @item -m5206e
18232 @opindex m5206e
18233 Generate output for a 5206e ColdFire CPU@.  The option is now
18234 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18236 @item -m528x
18237 @opindex m528x
18238 Generate output for a member of the ColdFire 528X family.
18239 The option is now deprecated in favor of the equivalent
18240 @option{-mcpu=528x}.
18242 @item -m5307
18243 @opindex m5307
18244 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18245 in favor of the equivalent @option{-mcpu=5307}.
18247 @item -m5407
18248 @opindex m5407
18249 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18250 in favor of the equivalent @option{-mcpu=5407}.
18252 @item -mcfv4e
18253 @opindex mcfv4e
18254 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18255 This includes use of hardware floating-point instructions.
18256 The option is equivalent to @option{-mcpu=547x}, and is now
18257 deprecated in favor of that option.
18259 @item -m68020-40
18260 @opindex m68020-40
18261 Generate output for a 68040, without using any of the new instructions.
18262 This results in code that can run relatively efficiently on either a
18263 68020/68881 or a 68030 or a 68040.  The generated code does use the
18264 68881 instructions that are emulated on the 68040.
18266 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18268 @item -m68020-60
18269 @opindex m68020-60
18270 Generate output for a 68060, without using any of the new instructions.
18271 This results in code that can run relatively efficiently on either a
18272 68020/68881 or a 68030 or a 68040.  The generated code does use the
18273 68881 instructions that are emulated on the 68060.
18275 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18277 @item -mhard-float
18278 @itemx -m68881
18279 @opindex mhard-float
18280 @opindex m68881
18281 Generate floating-point instructions.  This is the default for 68020
18282 and above, and for ColdFire devices that have an FPU@.  It defines the
18283 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18284 on ColdFire targets.
18286 @item -msoft-float
18287 @opindex msoft-float
18288 Do not generate floating-point instructions; use library calls instead.
18289 This is the default for 68000, 68010, and 68832 targets.  It is also
18290 the default for ColdFire devices that have no FPU.
18292 @item -mdiv
18293 @itemx -mno-div
18294 @opindex mdiv
18295 @opindex mno-div
18296 Generate (do not generate) ColdFire hardware divide and remainder
18297 instructions.  If @option{-march} is used without @option{-mcpu},
18298 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18299 architectures.  Otherwise, the default is taken from the target CPU
18300 (either the default CPU, or the one specified by @option{-mcpu}).  For
18301 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18302 @option{-mcpu=5206e}.
18304 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18306 @item -mshort
18307 @opindex mshort
18308 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18309 Additionally, parameters passed on the stack are also aligned to a
18310 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18312 @item -mno-short
18313 @opindex mno-short
18314 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18316 @item -mnobitfield
18317 @itemx -mno-bitfield
18318 @opindex mnobitfield
18319 @opindex mno-bitfield
18320 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18321 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18323 @item -mbitfield
18324 @opindex mbitfield
18325 Do use the bit-field instructions.  The @option{-m68020} option implies
18326 @option{-mbitfield}.  This is the default if you use a configuration
18327 designed for a 68020.
18329 @item -mrtd
18330 @opindex mrtd
18331 Use a different function-calling convention, in which functions
18332 that take a fixed number of arguments return with the @code{rtd}
18333 instruction, which pops their arguments while returning.  This
18334 saves one instruction in the caller since there is no need to pop
18335 the arguments there.
18337 This calling convention is incompatible with the one normally
18338 used on Unix, so you cannot use it if you need to call libraries
18339 compiled with the Unix compiler.
18341 Also, you must provide function prototypes for all functions that
18342 take variable numbers of arguments (including @code{printf});
18343 otherwise incorrect code is generated for calls to those
18344 functions.
18346 In addition, seriously incorrect code results if you call a
18347 function with too many arguments.  (Normally, extra arguments are
18348 harmlessly ignored.)
18350 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18351 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18353 @item -mno-rtd
18354 @opindex mno-rtd
18355 Do not use the calling conventions selected by @option{-mrtd}.
18356 This is the default.
18358 @item -malign-int
18359 @itemx -mno-align-int
18360 @opindex malign-int
18361 @opindex mno-align-int
18362 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18363 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18364 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18365 Aligning variables on 32-bit boundaries produces code that runs somewhat
18366 faster on processors with 32-bit busses at the expense of more memory.
18368 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18369 aligns structures containing the above types differently than
18370 most published application binary interface specifications for the m68k.
18372 @item -mpcrel
18373 @opindex mpcrel
18374 Use the pc-relative addressing mode of the 68000 directly, instead of
18375 using a global offset table.  At present, this option implies @option{-fpic},
18376 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18377 not presently supported with @option{-mpcrel}, though this could be supported for
18378 68020 and higher processors.
18380 @item -mno-strict-align
18381 @itemx -mstrict-align
18382 @opindex mno-strict-align
18383 @opindex mstrict-align
18384 Do not (do) assume that unaligned memory references are handled by
18385 the system.
18387 @item -msep-data
18388 Generate code that allows the data segment to be located in a different
18389 area of memory from the text segment.  This allows for execute-in-place in
18390 an environment without virtual memory management.  This option implies
18391 @option{-fPIC}.
18393 @item -mno-sep-data
18394 Generate code that assumes that the data segment follows the text segment.
18395 This is the default.
18397 @item -mid-shared-library
18398 Generate code that supports shared libraries via the library ID method.
18399 This allows for execute-in-place and shared libraries in an environment
18400 without virtual memory management.  This option implies @option{-fPIC}.
18402 @item -mno-id-shared-library
18403 Generate code that doesn't assume ID-based shared libraries are being used.
18404 This is the default.
18406 @item -mshared-library-id=n
18407 Specifies the identification number of the ID-based shared library being
18408 compiled.  Specifying a value of 0 generates more compact code; specifying
18409 other values forces the allocation of that number to the current
18410 library, but is no more space- or time-efficient than omitting this option.
18412 @item -mxgot
18413 @itemx -mno-xgot
18414 @opindex mxgot
18415 @opindex mno-xgot
18416 When generating position-independent code for ColdFire, generate code
18417 that works if the GOT has more than 8192 entries.  This code is
18418 larger and slower than code generated without this option.  On M680x0
18419 processors, this option is not needed; @option{-fPIC} suffices.
18421 GCC normally uses a single instruction to load values from the GOT@.
18422 While this is relatively efficient, it only works if the GOT
18423 is smaller than about 64k.  Anything larger causes the linker
18424 to report an error such as:
18426 @cindex relocation truncated to fit (ColdFire)
18427 @smallexample
18428 relocation truncated to fit: R_68K_GOT16O foobar
18429 @end smallexample
18431 If this happens, you should recompile your code with @option{-mxgot}.
18432 It should then work with very large GOTs.  However, code generated with
18433 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18434 the value of a global symbol.
18436 Note that some linkers, including newer versions of the GNU linker,
18437 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18438 you should only need to use @option{-mxgot} when compiling a single
18439 object file that accesses more than 8192 GOT entries.  Very few do.
18441 These options have no effect unless GCC is generating
18442 position-independent code.
18444 @item -mlong-jump-table-offsets
18445 @opindex mlong-jump-table-offsets
18446 Use 32-bit offsets in @code{switch} tables.  The default is to use
18447 16-bit offsets.
18449 @end table
18451 @node MCore Options
18452 @subsection MCore Options
18453 @cindex MCore options
18455 These are the @samp{-m} options defined for the Motorola M*Core
18456 processors.
18458 @table @gcctabopt
18460 @item -mhardlit
18461 @itemx -mno-hardlit
18462 @opindex mhardlit
18463 @opindex mno-hardlit
18464 Inline constants into the code stream if it can be done in two
18465 instructions or less.
18467 @item -mdiv
18468 @itemx -mno-div
18469 @opindex mdiv
18470 @opindex mno-div
18471 Use the divide instruction.  (Enabled by default).
18473 @item -mrelax-immediate
18474 @itemx -mno-relax-immediate
18475 @opindex mrelax-immediate
18476 @opindex mno-relax-immediate
18477 Allow arbitrary-sized immediates in bit operations.
18479 @item -mwide-bitfields
18480 @itemx -mno-wide-bitfields
18481 @opindex mwide-bitfields
18482 @opindex mno-wide-bitfields
18483 Always treat bit-fields as @code{int}-sized.
18485 @item -m4byte-functions
18486 @itemx -mno-4byte-functions
18487 @opindex m4byte-functions
18488 @opindex mno-4byte-functions
18489 Force all functions to be aligned to a 4-byte boundary.
18491 @item -mcallgraph-data
18492 @itemx -mno-callgraph-data
18493 @opindex mcallgraph-data
18494 @opindex mno-callgraph-data
18495 Emit callgraph information.
18497 @item -mslow-bytes
18498 @itemx -mno-slow-bytes
18499 @opindex mslow-bytes
18500 @opindex mno-slow-bytes
18501 Prefer word access when reading byte quantities.
18503 @item -mlittle-endian
18504 @itemx -mbig-endian
18505 @opindex mlittle-endian
18506 @opindex mbig-endian
18507 Generate code for a little-endian target.
18509 @item -m210
18510 @itemx -m340
18511 @opindex m210
18512 @opindex m340
18513 Generate code for the 210 processor.
18515 @item -mno-lsim
18516 @opindex mno-lsim
18517 Assume that runtime support has been provided and so omit the
18518 simulator library (@file{libsim.a)} from the linker command line.
18520 @item -mstack-increment=@var{size}
18521 @opindex mstack-increment
18522 Set the maximum amount for a single stack increment operation.  Large
18523 values can increase the speed of programs that contain functions
18524 that need a large amount of stack space, but they can also trigger a
18525 segmentation fault if the stack is extended too much.  The default
18526 value is 0x1000.
18528 @end table
18530 @node MeP Options
18531 @subsection MeP Options
18532 @cindex MeP options
18534 @table @gcctabopt
18536 @item -mabsdiff
18537 @opindex mabsdiff
18538 Enables the @code{abs} instruction, which is the absolute difference
18539 between two registers.
18541 @item -mall-opts
18542 @opindex mall-opts
18543 Enables all the optional instructions---average, multiply, divide, bit
18544 operations, leading zero, absolute difference, min/max, clip, and
18545 saturation.
18548 @item -maverage
18549 @opindex maverage
18550 Enables the @code{ave} instruction, which computes the average of two
18551 registers.
18553 @item -mbased=@var{n}
18554 @opindex mbased=
18555 Variables of size @var{n} bytes or smaller are placed in the
18556 @code{.based} section by default.  Based variables use the @code{$tp}
18557 register as a base register, and there is a 128-byte limit to the
18558 @code{.based} section.
18560 @item -mbitops
18561 @opindex mbitops
18562 Enables the bit operation instructions---bit test (@code{btstm}), set
18563 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
18564 test-and-set (@code{tas}).
18566 @item -mc=@var{name}
18567 @opindex mc=
18568 Selects which section constant data is placed in.  @var{name} may
18569 be @samp{tiny}, @samp{near}, or @samp{far}.
18571 @item -mclip
18572 @opindex mclip
18573 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
18574 useful unless you also provide @option{-mminmax}.
18576 @item -mconfig=@var{name}
18577 @opindex mconfig=
18578 Selects one of the built-in core configurations.  Each MeP chip has
18579 one or more modules in it; each module has a core CPU and a variety of
18580 coprocessors, optional instructions, and peripherals.  The
18581 @code{MeP-Integrator} tool, not part of GCC, provides these
18582 configurations through this option; using this option is the same as
18583 using all the corresponding command-line options.  The default
18584 configuration is @samp{default}.
18586 @item -mcop
18587 @opindex mcop
18588 Enables the coprocessor instructions.  By default, this is a 32-bit
18589 coprocessor.  Note that the coprocessor is normally enabled via the
18590 @option{-mconfig=} option.
18592 @item -mcop32
18593 @opindex mcop32
18594 Enables the 32-bit coprocessor's instructions.
18596 @item -mcop64
18597 @opindex mcop64
18598 Enables the 64-bit coprocessor's instructions.
18600 @item -mivc2
18601 @opindex mivc2
18602 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
18604 @item -mdc
18605 @opindex mdc
18606 Causes constant variables to be placed in the @code{.near} section.
18608 @item -mdiv
18609 @opindex mdiv
18610 Enables the @code{div} and @code{divu} instructions.
18612 @item -meb
18613 @opindex meb
18614 Generate big-endian code.
18616 @item -mel
18617 @opindex mel
18618 Generate little-endian code.
18620 @item -mio-volatile
18621 @opindex mio-volatile
18622 Tells the compiler that any variable marked with the @code{io}
18623 attribute is to be considered volatile.
18625 @item -ml
18626 @opindex ml
18627 Causes variables to be assigned to the @code{.far} section by default.
18629 @item -mleadz
18630 @opindex mleadz
18631 Enables the @code{leadz} (leading zero) instruction.
18633 @item -mm
18634 @opindex mm
18635 Causes variables to be assigned to the @code{.near} section by default.
18637 @item -mminmax
18638 @opindex mminmax
18639 Enables the @code{min} and @code{max} instructions.
18641 @item -mmult
18642 @opindex mmult
18643 Enables the multiplication and multiply-accumulate instructions.
18645 @item -mno-opts
18646 @opindex mno-opts
18647 Disables all the optional instructions enabled by @option{-mall-opts}.
18649 @item -mrepeat
18650 @opindex mrepeat
18651 Enables the @code{repeat} and @code{erepeat} instructions, used for
18652 low-overhead looping.
18654 @item -ms
18655 @opindex ms
18656 Causes all variables to default to the @code{.tiny} section.  Note
18657 that there is a 65536-byte limit to this section.  Accesses to these
18658 variables use the @code{%gp} base register.
18660 @item -msatur
18661 @opindex msatur
18662 Enables the saturation instructions.  Note that the compiler does not
18663 currently generate these itself, but this option is included for
18664 compatibility with other tools, like @code{as}.
18666 @item -msdram
18667 @opindex msdram
18668 Link the SDRAM-based runtime instead of the default ROM-based runtime.
18670 @item -msim
18671 @opindex msim
18672 Link the simulator run-time libraries.
18674 @item -msimnovec
18675 @opindex msimnovec
18676 Link the simulator runtime libraries, excluding built-in support
18677 for reset and exception vectors and tables.
18679 @item -mtf
18680 @opindex mtf
18681 Causes all functions to default to the @code{.far} section.  Without
18682 this option, functions default to the @code{.near} section.
18684 @item -mtiny=@var{n}
18685 @opindex mtiny=
18686 Variables that are @var{n} bytes or smaller are allocated to the
18687 @code{.tiny} section.  These variables use the @code{$gp} base
18688 register.  The default for this option is 4, but note that there's a
18689 65536-byte limit to the @code{.tiny} section.
18691 @end table
18693 @node MicroBlaze Options
18694 @subsection MicroBlaze Options
18695 @cindex MicroBlaze Options
18697 @table @gcctabopt
18699 @item -msoft-float
18700 @opindex msoft-float
18701 Use software emulation for floating point (default).
18703 @item -mhard-float
18704 @opindex mhard-float
18705 Use hardware floating-point instructions.
18707 @item -mmemcpy
18708 @opindex mmemcpy
18709 Do not optimize block moves, use @code{memcpy}.
18711 @item -mno-clearbss
18712 @opindex mno-clearbss
18713 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
18715 @item -mcpu=@var{cpu-type}
18716 @opindex mcpu=
18717 Use features of, and schedule code for, the given CPU.
18718 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
18719 where @var{X} is a major version, @var{YY} is the minor version, and
18720 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
18721 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
18723 @item -mxl-soft-mul
18724 @opindex mxl-soft-mul
18725 Use software multiply emulation (default).
18727 @item -mxl-soft-div
18728 @opindex mxl-soft-div
18729 Use software emulation for divides (default).
18731 @item -mxl-barrel-shift
18732 @opindex mxl-barrel-shift
18733 Use the hardware barrel shifter.
18735 @item -mxl-pattern-compare
18736 @opindex mxl-pattern-compare
18737 Use pattern compare instructions.
18739 @item -msmall-divides
18740 @opindex msmall-divides
18741 Use table lookup optimization for small signed integer divisions.
18743 @item -mxl-stack-check
18744 @opindex mxl-stack-check
18745 This option is deprecated.  Use @option{-fstack-check} instead.
18747 @item -mxl-gp-opt
18748 @opindex mxl-gp-opt
18749 Use GP-relative @code{.sdata}/@code{.sbss} sections.
18751 @item -mxl-multiply-high
18752 @opindex mxl-multiply-high
18753 Use multiply high instructions for high part of 32x32 multiply.
18755 @item -mxl-float-convert
18756 @opindex mxl-float-convert
18757 Use hardware floating-point conversion instructions.
18759 @item -mxl-float-sqrt
18760 @opindex mxl-float-sqrt
18761 Use hardware floating-point square root instruction.
18763 @item -mbig-endian
18764 @opindex mbig-endian
18765 Generate code for a big-endian target.
18767 @item -mlittle-endian
18768 @opindex mlittle-endian
18769 Generate code for a little-endian target.
18771 @item -mxl-reorder
18772 @opindex mxl-reorder
18773 Use reorder instructions (swap and byte reversed load/store).
18775 @item -mxl-mode-@var{app-model}
18776 Select application model @var{app-model}.  Valid models are
18777 @table @samp
18778 @item executable
18779 normal executable (default), uses startup code @file{crt0.o}.
18781 @item xmdstub
18782 for use with Xilinx Microprocessor Debugger (XMD) based
18783 software intrusive debug agent called xmdstub. This uses startup file
18784 @file{crt1.o} and sets the start address of the program to 0x800.
18786 @item bootstrap
18787 for applications that are loaded using a bootloader.
18788 This model uses startup file @file{crt2.o} which does not contain a processor
18789 reset vector handler. This is suitable for transferring control on a
18790 processor reset to the bootloader rather than the application.
18792 @item novectors
18793 for applications that do not require any of the
18794 MicroBlaze vectors. This option may be useful for applications running
18795 within a monitoring application. This model uses @file{crt3.o} as a startup file.
18796 @end table
18798 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
18799 @option{-mxl-mode-@var{app-model}}.
18801 @end table
18803 @node MIPS Options
18804 @subsection MIPS Options
18805 @cindex MIPS options
18807 @table @gcctabopt
18809 @item -EB
18810 @opindex EB
18811 Generate big-endian code.
18813 @item -EL
18814 @opindex EL
18815 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
18816 configurations.
18818 @item -march=@var{arch}
18819 @opindex march
18820 Generate code that runs on @var{arch}, which can be the name of a
18821 generic MIPS ISA, or the name of a particular processor.
18822 The ISA names are:
18823 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
18824 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
18825 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
18826 @samp{mips64r5} and @samp{mips64r6}.
18827 The processor names are:
18828 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
18829 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
18830 @samp{5kc}, @samp{5kf},
18831 @samp{20kc},
18832 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
18833 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
18834 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
18835 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
18836 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
18837 @samp{i6400},
18838 @samp{interaptiv},
18839 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
18840 @samp{m4k},
18841 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
18842 @samp{m5100}, @samp{m5101},
18843 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
18844 @samp{orion},
18845 @samp{p5600},
18846 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
18847 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
18848 @samp{rm7000}, @samp{rm9000},
18849 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
18850 @samp{sb1},
18851 @samp{sr71000},
18852 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
18853 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
18854 @samp{xlr} and @samp{xlp}.
18855 The special value @samp{from-abi} selects the
18856 most compatible architecture for the selected ABI (that is,
18857 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
18859 The native Linux/GNU toolchain also supports the value @samp{native},
18860 which selects the best architecture option for the host processor.
18861 @option{-march=native} has no effect if GCC does not recognize
18862 the processor.
18864 In processor names, a final @samp{000} can be abbreviated as @samp{k}
18865 (for example, @option{-march=r2k}).  Prefixes are optional, and
18866 @samp{vr} may be written @samp{r}.
18868 Names of the form @samp{@var{n}f2_1} refer to processors with
18869 FPUs clocked at half the rate of the core, names of the form
18870 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
18871 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
18872 processors with FPUs clocked a ratio of 3:2 with respect to the core.
18873 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
18874 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
18875 accepted as synonyms for @samp{@var{n}f1_1}.
18877 GCC defines two macros based on the value of this option.  The first
18878 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
18879 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
18880 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
18881 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
18882 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
18884 Note that the @code{_MIPS_ARCH} macro uses the processor names given
18885 above.  In other words, it has the full prefix and does not
18886 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
18887 the macro names the resolved architecture (either @code{"mips1"} or
18888 @code{"mips3"}).  It names the default architecture when no
18889 @option{-march} option is given.
18891 @item -mtune=@var{arch}
18892 @opindex mtune
18893 Optimize for @var{arch}.  Among other things, this option controls
18894 the way instructions are scheduled, and the perceived cost of arithmetic
18895 operations.  The list of @var{arch} values is the same as for
18896 @option{-march}.
18898 When this option is not used, GCC optimizes for the processor
18899 specified by @option{-march}.  By using @option{-march} and
18900 @option{-mtune} together, it is possible to generate code that
18901 runs on a family of processors, but optimize the code for one
18902 particular member of that family.
18904 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
18905 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
18906 @option{-march} ones described above.
18908 @item -mips1
18909 @opindex mips1
18910 Equivalent to @option{-march=mips1}.
18912 @item -mips2
18913 @opindex mips2
18914 Equivalent to @option{-march=mips2}.
18916 @item -mips3
18917 @opindex mips3
18918 Equivalent to @option{-march=mips3}.
18920 @item -mips4
18921 @opindex mips4
18922 Equivalent to @option{-march=mips4}.
18924 @item -mips32
18925 @opindex mips32
18926 Equivalent to @option{-march=mips32}.
18928 @item -mips32r3
18929 @opindex mips32r3
18930 Equivalent to @option{-march=mips32r3}.
18932 @item -mips32r5
18933 @opindex mips32r5
18934 Equivalent to @option{-march=mips32r5}.
18936 @item -mips32r6
18937 @opindex mips32r6
18938 Equivalent to @option{-march=mips32r6}.
18940 @item -mips64
18941 @opindex mips64
18942 Equivalent to @option{-march=mips64}.
18944 @item -mips64r2
18945 @opindex mips64r2
18946 Equivalent to @option{-march=mips64r2}.
18948 @item -mips64r3
18949 @opindex mips64r3
18950 Equivalent to @option{-march=mips64r3}.
18952 @item -mips64r5
18953 @opindex mips64r5
18954 Equivalent to @option{-march=mips64r5}.
18956 @item -mips64r6
18957 @opindex mips64r6
18958 Equivalent to @option{-march=mips64r6}.
18960 @item -mips16
18961 @itemx -mno-mips16
18962 @opindex mips16
18963 @opindex mno-mips16
18964 Generate (do not generate) MIPS16 code.  If GCC is targeting a
18965 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
18967 MIPS16 code generation can also be controlled on a per-function basis
18968 by means of @code{mips16} and @code{nomips16} attributes.
18969 @xref{Function Attributes}, for more information.
18971 @item -mflip-mips16
18972 @opindex mflip-mips16
18973 Generate MIPS16 code on alternating functions.  This option is provided
18974 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
18975 not intended for ordinary use in compiling user code.
18977 @item -minterlink-compressed
18978 @item -mno-interlink-compressed
18979 @opindex minterlink-compressed
18980 @opindex mno-interlink-compressed
18981 Require (do not require) that code using the standard (uncompressed) MIPS ISA
18982 be link-compatible with MIPS16 and microMIPS code, and vice versa.
18984 For example, code using the standard ISA encoding cannot jump directly
18985 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
18986 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
18987 knows that the target of the jump is not compressed.
18989 @item -minterlink-mips16
18990 @itemx -mno-interlink-mips16
18991 @opindex minterlink-mips16
18992 @opindex mno-interlink-mips16
18993 Aliases of @option{-minterlink-compressed} and
18994 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
18995 and are retained for backwards compatibility.
18997 @item -mabi=32
18998 @itemx -mabi=o64
18999 @itemx -mabi=n32
19000 @itemx -mabi=64
19001 @itemx -mabi=eabi
19002 @opindex mabi=32
19003 @opindex mabi=o64
19004 @opindex mabi=n32
19005 @opindex mabi=64
19006 @opindex mabi=eabi
19007 Generate code for the given ABI@.
19009 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19010 generates 64-bit code when you select a 64-bit architecture, but you
19011 can use @option{-mgp32} to get 32-bit code instead.
19013 For information about the O64 ABI, see
19014 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19016 GCC supports a variant of the o32 ABI in which floating-point registers
19017 are 64 rather than 32 bits wide.  You can select this combination with
19018 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19019 and @code{mfhc1} instructions and is therefore only supported for
19020 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19022 The register assignments for arguments and return values remain the
19023 same, but each scalar value is passed in a single 64-bit register
19024 rather than a pair of 32-bit registers.  For example, scalar
19025 floating-point values are returned in @samp{$f0} only, not a
19026 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19027 remains the same in that the even-numbered double-precision registers
19028 are saved.
19030 Two additional variants of the o32 ABI are supported to enable
19031 a transition from 32-bit to 64-bit registers.  These are FPXX
19032 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19033 The FPXX extension mandates that all code must execute correctly
19034 when run using 32-bit or 64-bit registers.  The code can be interlinked
19035 with either FP32 or FP64, but not both.
19036 The FP64A extension is similar to the FP64 extension but forbids the
19037 use of odd-numbered single-precision registers.  This can be used
19038 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19039 processors and allows both FP32 and FP64A code to interlink and
19040 run in the same process without changing FPU modes.
19042 @item -mabicalls
19043 @itemx -mno-abicalls
19044 @opindex mabicalls
19045 @opindex mno-abicalls
19046 Generate (do not generate) code that is suitable for SVR4-style
19047 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19048 systems.
19050 @item -mshared
19051 @itemx -mno-shared
19052 Generate (do not generate) code that is fully position-independent,
19053 and that can therefore be linked into shared libraries.  This option
19054 only affects @option{-mabicalls}.
19056 All @option{-mabicalls} code has traditionally been position-independent,
19057 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19058 as an extension, the GNU toolchain allows executables to use absolute
19059 accesses for locally-binding symbols.  It can also use shorter GP
19060 initialization sequences and generate direct calls to locally-defined
19061 functions.  This mode is selected by @option{-mno-shared}.
19063 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19064 objects that can only be linked by the GNU linker.  However, the option
19065 does not affect the ABI of the final executable; it only affects the ABI
19066 of relocatable objects.  Using @option{-mno-shared} generally makes
19067 executables both smaller and quicker.
19069 @option{-mshared} is the default.
19071 @item -mplt
19072 @itemx -mno-plt
19073 @opindex mplt
19074 @opindex mno-plt
19075 Assume (do not assume) that the static and dynamic linkers
19076 support PLTs and copy relocations.  This option only affects
19077 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19078 has no effect without @option{-msym32}.
19080 You can make @option{-mplt} the default by configuring
19081 GCC with @option{--with-mips-plt}.  The default is
19082 @option{-mno-plt} otherwise.
19084 @item -mxgot
19085 @itemx -mno-xgot
19086 @opindex mxgot
19087 @opindex mno-xgot
19088 Lift (do not lift) the usual restrictions on the size of the global
19089 offset table.
19091 GCC normally uses a single instruction to load values from the GOT@.
19092 While this is relatively efficient, it only works if the GOT
19093 is smaller than about 64k.  Anything larger causes the linker
19094 to report an error such as:
19096 @cindex relocation truncated to fit (MIPS)
19097 @smallexample
19098 relocation truncated to fit: R_MIPS_GOT16 foobar
19099 @end smallexample
19101 If this happens, you should recompile your code with @option{-mxgot}.
19102 This works with very large GOTs, although the code is also
19103 less efficient, since it takes three instructions to fetch the
19104 value of a global symbol.
19106 Note that some linkers can create multiple GOTs.  If you have such a
19107 linker, you should only need to use @option{-mxgot} when a single object
19108 file accesses more than 64k's worth of GOT entries.  Very few do.
19110 These options have no effect unless GCC is generating position
19111 independent code.
19113 @item -mgp32
19114 @opindex mgp32
19115 Assume that general-purpose registers are 32 bits wide.
19117 @item -mgp64
19118 @opindex mgp64
19119 Assume that general-purpose registers are 64 bits wide.
19121 @item -mfp32
19122 @opindex mfp32
19123 Assume that floating-point registers are 32 bits wide.
19125 @item -mfp64
19126 @opindex mfp64
19127 Assume that floating-point registers are 64 bits wide.
19129 @item -mfpxx
19130 @opindex mfpxx
19131 Do not assume the width of floating-point registers.
19133 @item -mhard-float
19134 @opindex mhard-float
19135 Use floating-point coprocessor instructions.
19137 @item -msoft-float
19138 @opindex msoft-float
19139 Do not use floating-point coprocessor instructions.  Implement
19140 floating-point calculations using library calls instead.
19142 @item -mno-float
19143 @opindex mno-float
19144 Equivalent to @option{-msoft-float}, but additionally asserts that the
19145 program being compiled does not perform any floating-point operations.
19146 This option is presently supported only by some bare-metal MIPS
19147 configurations, where it may select a special set of libraries
19148 that lack all floating-point support (including, for example, the
19149 floating-point @code{printf} formats).  
19150 If code compiled with @option{-mno-float} accidentally contains
19151 floating-point operations, it is likely to suffer a link-time
19152 or run-time failure.
19154 @item -msingle-float
19155 @opindex msingle-float
19156 Assume that the floating-point coprocessor only supports single-precision
19157 operations.
19159 @item -mdouble-float
19160 @opindex mdouble-float
19161 Assume that the floating-point coprocessor supports double-precision
19162 operations.  This is the default.
19164 @item -modd-spreg
19165 @itemx -mno-odd-spreg
19166 @opindex modd-spreg
19167 @opindex mno-odd-spreg
19168 Enable the use of odd-numbered single-precision floating-point registers
19169 for the o32 ABI.  This is the default for processors that are known to
19170 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19171 is set by default.
19173 @item -mabs=2008
19174 @itemx -mabs=legacy
19175 @opindex mabs=2008
19176 @opindex mabs=legacy
19177 These options control the treatment of the special not-a-number (NaN)
19178 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19179 @code{neg.@i{fmt}} machine instructions.
19181 By default or when @option{-mabs=legacy} is used the legacy
19182 treatment is selected.  In this case these instructions are considered
19183 arithmetic and avoided where correct operation is required and the
19184 input operand might be a NaN.  A longer sequence of instructions that
19185 manipulate the sign bit of floating-point datum manually is used
19186 instead unless the @option{-ffinite-math-only} option has also been
19187 specified.
19189 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19190 this case these instructions are considered non-arithmetic and therefore
19191 operating correctly in all cases, including in particular where the
19192 input operand is a NaN.  These instructions are therefore always used
19193 for the respective operations.
19195 @item -mnan=2008
19196 @itemx -mnan=legacy
19197 @opindex mnan=2008
19198 @opindex mnan=legacy
19199 These options control the encoding of the special not-a-number (NaN)
19200 IEEE 754 floating-point data.
19202 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19203 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19204 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19205 by the first bit of their trailing significand field being 1.
19207 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19208 this case qNaNs are denoted by the first bit of their trailing
19209 significand field being 1, whereas sNaNs are denoted by the first bit of
19210 their trailing significand field being 0.
19212 The default is @option{-mnan=legacy} unless GCC has been configured with
19213 @option{--with-nan=2008}.
19215 @item -mllsc
19216 @itemx -mno-llsc
19217 @opindex mllsc
19218 @opindex mno-llsc
19219 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19220 implement atomic memory built-in functions.  When neither option is
19221 specified, GCC uses the instructions if the target architecture
19222 supports them.
19224 @option{-mllsc} is useful if the runtime environment can emulate the
19225 instructions and @option{-mno-llsc} can be useful when compiling for
19226 nonstandard ISAs.  You can make either option the default by
19227 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19228 respectively.  @option{--with-llsc} is the default for some
19229 configurations; see the installation documentation for details.
19231 @item -mdsp
19232 @itemx -mno-dsp
19233 @opindex mdsp
19234 @opindex mno-dsp
19235 Use (do not use) revision 1 of the MIPS DSP ASE@.
19236 @xref{MIPS DSP Built-in Functions}.  This option defines the
19237 preprocessor macro @code{__mips_dsp}.  It also defines
19238 @code{__mips_dsp_rev} to 1.
19240 @item -mdspr2
19241 @itemx -mno-dspr2
19242 @opindex mdspr2
19243 @opindex mno-dspr2
19244 Use (do not use) revision 2 of the MIPS DSP ASE@.
19245 @xref{MIPS DSP Built-in Functions}.  This option defines the
19246 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19247 It also defines @code{__mips_dsp_rev} to 2.
19249 @item -msmartmips
19250 @itemx -mno-smartmips
19251 @opindex msmartmips
19252 @opindex mno-smartmips
19253 Use (do not use) the MIPS SmartMIPS ASE.
19255 @item -mpaired-single
19256 @itemx -mno-paired-single
19257 @opindex mpaired-single
19258 @opindex mno-paired-single
19259 Use (do not use) paired-single floating-point instructions.
19260 @xref{MIPS Paired-Single Support}.  This option requires
19261 hardware floating-point support to be enabled.
19263 @item -mdmx
19264 @itemx -mno-mdmx
19265 @opindex mdmx
19266 @opindex mno-mdmx
19267 Use (do not use) MIPS Digital Media Extension instructions.
19268 This option can only be used when generating 64-bit code and requires
19269 hardware floating-point support to be enabled.
19271 @item -mips3d
19272 @itemx -mno-mips3d
19273 @opindex mips3d
19274 @opindex mno-mips3d
19275 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19276 The option @option{-mips3d} implies @option{-mpaired-single}.
19278 @item -mmicromips
19279 @itemx -mno-micromips
19280 @opindex mmicromips
19281 @opindex mno-mmicromips
19282 Generate (do not generate) microMIPS code.
19284 MicroMIPS code generation can also be controlled on a per-function basis
19285 by means of @code{micromips} and @code{nomicromips} attributes.
19286 @xref{Function Attributes}, for more information.
19288 @item -mmt
19289 @itemx -mno-mt
19290 @opindex mmt
19291 @opindex mno-mt
19292 Use (do not use) MT Multithreading instructions.
19294 @item -mmcu
19295 @itemx -mno-mcu
19296 @opindex mmcu
19297 @opindex mno-mcu
19298 Use (do not use) the MIPS MCU ASE instructions.
19300 @item -meva
19301 @itemx -mno-eva
19302 @opindex meva
19303 @opindex mno-eva
19304 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19306 @item -mvirt
19307 @itemx -mno-virt
19308 @opindex mvirt
19309 @opindex mno-virt
19310 Use (do not use) the MIPS Virtualization Application Specific instructions.
19312 @item -mxpa
19313 @itemx -mno-xpa
19314 @opindex mxpa
19315 @opindex mno-xpa
19316 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19318 @item -mlong64
19319 @opindex mlong64
19320 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19321 an explanation of the default and the way that the pointer size is
19322 determined.
19324 @item -mlong32
19325 @opindex mlong32
19326 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19328 The default size of @code{int}s, @code{long}s and pointers depends on
19329 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19330 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19331 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19332 or the same size as integer registers, whichever is smaller.
19334 @item -msym32
19335 @itemx -mno-sym32
19336 @opindex msym32
19337 @opindex mno-sym32
19338 Assume (do not assume) that all symbols have 32-bit values, regardless
19339 of the selected ABI@.  This option is useful in combination with
19340 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19341 to generate shorter and faster references to symbolic addresses.
19343 @item -G @var{num}
19344 @opindex G
19345 Put definitions of externally-visible data in a small data section
19346 if that data is no bigger than @var{num} bytes.  GCC can then generate
19347 more efficient accesses to the data; see @option{-mgpopt} for details.
19349 The default @option{-G} option depends on the configuration.
19351 @item -mlocal-sdata
19352 @itemx -mno-local-sdata
19353 @opindex mlocal-sdata
19354 @opindex mno-local-sdata
19355 Extend (do not extend) the @option{-G} behavior to local data too,
19356 such as to static variables in C@.  @option{-mlocal-sdata} is the
19357 default for all configurations.
19359 If the linker complains that an application is using too much small data,
19360 you might want to try rebuilding the less performance-critical parts with
19361 @option{-mno-local-sdata}.  You might also want to build large
19362 libraries with @option{-mno-local-sdata}, so that the libraries leave
19363 more room for the main program.
19365 @item -mextern-sdata
19366 @itemx -mno-extern-sdata
19367 @opindex mextern-sdata
19368 @opindex mno-extern-sdata
19369 Assume (do not assume) that externally-defined data is in
19370 a small data section if the size of that data is within the @option{-G} limit.
19371 @option{-mextern-sdata} is the default for all configurations.
19373 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19374 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19375 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19376 is placed in a small data section.  If @var{Var} is defined by another
19377 module, you must either compile that module with a high-enough
19378 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19379 definition.  If @var{Var} is common, you must link the application
19380 with a high-enough @option{-G} setting.
19382 The easiest way of satisfying these restrictions is to compile
19383 and link every module with the same @option{-G} option.  However,
19384 you may wish to build a library that supports several different
19385 small data limits.  You can do this by compiling the library with
19386 the highest supported @option{-G} setting and additionally using
19387 @option{-mno-extern-sdata} to stop the library from making assumptions
19388 about externally-defined data.
19390 @item -mgpopt
19391 @itemx -mno-gpopt
19392 @opindex mgpopt
19393 @opindex mno-gpopt
19394 Use (do not use) GP-relative accesses for symbols that are known to be
19395 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19396 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19397 configurations.
19399 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19400 might not hold the value of @code{_gp}.  For example, if the code is
19401 part of a library that might be used in a boot monitor, programs that
19402 call boot monitor routines pass an unknown value in @code{$gp}.
19403 (In such situations, the boot monitor itself is usually compiled
19404 with @option{-G0}.)
19406 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19407 @option{-mno-extern-sdata}.
19409 @item -membedded-data
19410 @itemx -mno-embedded-data
19411 @opindex membedded-data
19412 @opindex mno-embedded-data
19413 Allocate variables to the read-only data section first if possible, then
19414 next in the small data section if possible, otherwise in data.  This gives
19415 slightly slower code than the default, but reduces the amount of RAM required
19416 when executing, and thus may be preferred for some embedded systems.
19418 @item -muninit-const-in-rodata
19419 @itemx -mno-uninit-const-in-rodata
19420 @opindex muninit-const-in-rodata
19421 @opindex mno-uninit-const-in-rodata
19422 Put uninitialized @code{const} variables in the read-only data section.
19423 This option is only meaningful in conjunction with @option{-membedded-data}.
19425 @item -mcode-readable=@var{setting}
19426 @opindex mcode-readable
19427 Specify whether GCC may generate code that reads from executable sections.
19428 There are three possible settings:
19430 @table @gcctabopt
19431 @item -mcode-readable=yes
19432 Instructions may freely access executable sections.  This is the
19433 default setting.
19435 @item -mcode-readable=pcrel
19436 MIPS16 PC-relative load instructions can access executable sections,
19437 but other instructions must not do so.  This option is useful on 4KSc
19438 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19439 It is also useful on processors that can be configured to have a dual
19440 instruction/data SRAM interface and that, like the M4K, automatically
19441 redirect PC-relative loads to the instruction RAM.
19443 @item -mcode-readable=no
19444 Instructions must not access executable sections.  This option can be
19445 useful on targets that are configured to have a dual instruction/data
19446 SRAM interface but that (unlike the M4K) do not automatically redirect
19447 PC-relative loads to the instruction RAM.
19448 @end table
19450 @item -msplit-addresses
19451 @itemx -mno-split-addresses
19452 @opindex msplit-addresses
19453 @opindex mno-split-addresses
19454 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19455 relocation operators.  This option has been superseded by
19456 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19458 @item -mexplicit-relocs
19459 @itemx -mno-explicit-relocs
19460 @opindex mexplicit-relocs
19461 @opindex mno-explicit-relocs
19462 Use (do not use) assembler relocation operators when dealing with symbolic
19463 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19464 is to use assembler macros instead.
19466 @option{-mexplicit-relocs} is the default if GCC was configured
19467 to use an assembler that supports relocation operators.
19469 @item -mcheck-zero-division
19470 @itemx -mno-check-zero-division
19471 @opindex mcheck-zero-division
19472 @opindex mno-check-zero-division
19473 Trap (do not trap) on integer division by zero.
19475 The default is @option{-mcheck-zero-division}.
19477 @item -mdivide-traps
19478 @itemx -mdivide-breaks
19479 @opindex mdivide-traps
19480 @opindex mdivide-breaks
19481 MIPS systems check for division by zero by generating either a
19482 conditional trap or a break instruction.  Using traps results in
19483 smaller code, but is only supported on MIPS II and later.  Also, some
19484 versions of the Linux kernel have a bug that prevents trap from
19485 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19486 allow conditional traps on architectures that support them and
19487 @option{-mdivide-breaks} to force the use of breaks.
19489 The default is usually @option{-mdivide-traps}, but this can be
19490 overridden at configure time using @option{--with-divide=breaks}.
19491 Divide-by-zero checks can be completely disabled using
19492 @option{-mno-check-zero-division}.
19494 @item -mmemcpy
19495 @itemx -mno-memcpy
19496 @opindex mmemcpy
19497 @opindex mno-memcpy
19498 Force (do not force) the use of @code{memcpy} for non-trivial block
19499 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19500 most constant-sized copies.
19502 @item -mlong-calls
19503 @itemx -mno-long-calls
19504 @opindex mlong-calls
19505 @opindex mno-long-calls
19506 Disable (do not disable) use of the @code{jal} instruction.  Calling
19507 functions using @code{jal} is more efficient but requires the caller
19508 and callee to be in the same 256 megabyte segment.
19510 This option has no effect on abicalls code.  The default is
19511 @option{-mno-long-calls}.
19513 @item -mmad
19514 @itemx -mno-mad
19515 @opindex mmad
19516 @opindex mno-mad
19517 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
19518 instructions, as provided by the R4650 ISA@.
19520 @item -mimadd
19521 @itemx -mno-imadd
19522 @opindex mimadd
19523 @opindex mno-imadd
19524 Enable (disable) use of the @code{madd} and @code{msub} integer
19525 instructions.  The default is @option{-mimadd} on architectures
19526 that support @code{madd} and @code{msub} except for the 74k 
19527 architecture where it was found to generate slower code.
19529 @item -mfused-madd
19530 @itemx -mno-fused-madd
19531 @opindex mfused-madd
19532 @opindex mno-fused-madd
19533 Enable (disable) use of the floating-point multiply-accumulate
19534 instructions, when they are available.  The default is
19535 @option{-mfused-madd}.
19537 On the R8000 CPU when multiply-accumulate instructions are used,
19538 the intermediate product is calculated to infinite precision
19539 and is not subject to the FCSR Flush to Zero bit.  This may be
19540 undesirable in some circumstances.  On other processors the result
19541 is numerically identical to the equivalent computation using
19542 separate multiply, add, subtract and negate instructions.
19544 @item -nocpp
19545 @opindex nocpp
19546 Tell the MIPS assembler to not run its preprocessor over user
19547 assembler files (with a @samp{.s} suffix) when assembling them.
19549 @item -mfix-24k
19550 @item -mno-fix-24k
19551 @opindex mfix-24k
19552 @opindex mno-fix-24k
19553 Work around the 24K E48 (lost data on stores during refill) errata.
19554 The workarounds are implemented by the assembler rather than by GCC@.
19556 @item -mfix-r4000
19557 @itemx -mno-fix-r4000
19558 @opindex mfix-r4000
19559 @opindex mno-fix-r4000
19560 Work around certain R4000 CPU errata:
19561 @itemize @minus
19562 @item
19563 A double-word or a variable shift may give an incorrect result if executed
19564 immediately after starting an integer division.
19565 @item
19566 A double-word or a variable shift may give an incorrect result if executed
19567 while an integer multiplication is in progress.
19568 @item
19569 An integer division may give an incorrect result if started in a delay slot
19570 of a taken branch or a jump.
19571 @end itemize
19573 @item -mfix-r4400
19574 @itemx -mno-fix-r4400
19575 @opindex mfix-r4400
19576 @opindex mno-fix-r4400
19577 Work around certain R4400 CPU errata:
19578 @itemize @minus
19579 @item
19580 A double-word or a variable shift may give an incorrect result if executed
19581 immediately after starting an integer division.
19582 @end itemize
19584 @item -mfix-r10000
19585 @itemx -mno-fix-r10000
19586 @opindex mfix-r10000
19587 @opindex mno-fix-r10000
19588 Work around certain R10000 errata:
19589 @itemize @minus
19590 @item
19591 @code{ll}/@code{sc} sequences may not behave atomically on revisions
19592 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
19593 @end itemize
19595 This option can only be used if the target architecture supports
19596 branch-likely instructions.  @option{-mfix-r10000} is the default when
19597 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
19598 otherwise.
19600 @item -mfix-rm7000
19601 @itemx -mno-fix-rm7000
19602 @opindex mfix-rm7000
19603 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
19604 workarounds are implemented by the assembler rather than by GCC@.
19606 @item -mfix-vr4120
19607 @itemx -mno-fix-vr4120
19608 @opindex mfix-vr4120
19609 Work around certain VR4120 errata:
19610 @itemize @minus
19611 @item
19612 @code{dmultu} does not always produce the correct result.
19613 @item
19614 @code{div} and @code{ddiv} do not always produce the correct result if one
19615 of the operands is negative.
19616 @end itemize
19617 The workarounds for the division errata rely on special functions in
19618 @file{libgcc.a}.  At present, these functions are only provided by
19619 the @code{mips64vr*-elf} configurations.
19621 Other VR4120 errata require a NOP to be inserted between certain pairs of
19622 instructions.  These errata are handled by the assembler, not by GCC itself.
19624 @item -mfix-vr4130
19625 @opindex mfix-vr4130
19626 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
19627 workarounds are implemented by the assembler rather than by GCC,
19628 although GCC avoids using @code{mflo} and @code{mfhi} if the
19629 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
19630 instructions are available instead.
19632 @item -mfix-sb1
19633 @itemx -mno-fix-sb1
19634 @opindex mfix-sb1
19635 Work around certain SB-1 CPU core errata.
19636 (This flag currently works around the SB-1 revision 2
19637 ``F1'' and ``F2'' floating-point errata.)
19639 @item -mr10k-cache-barrier=@var{setting}
19640 @opindex mr10k-cache-barrier
19641 Specify whether GCC should insert cache barriers to avoid the
19642 side-effects of speculation on R10K processors.
19644 In common with many processors, the R10K tries to predict the outcome
19645 of a conditional branch and speculatively executes instructions from
19646 the ``taken'' branch.  It later aborts these instructions if the
19647 predicted outcome is wrong.  However, on the R10K, even aborted
19648 instructions can have side effects.
19650 This problem only affects kernel stores and, depending on the system,
19651 kernel loads.  As an example, a speculatively-executed store may load
19652 the target memory into cache and mark the cache line as dirty, even if
19653 the store itself is later aborted.  If a DMA operation writes to the
19654 same area of memory before the ``dirty'' line is flushed, the cached
19655 data overwrites the DMA-ed data.  See the R10K processor manual
19656 for a full description, including other potential problems.
19658 One workaround is to insert cache barrier instructions before every memory
19659 access that might be speculatively executed and that might have side
19660 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
19661 controls GCC's implementation of this workaround.  It assumes that
19662 aborted accesses to any byte in the following regions does not have
19663 side effects:
19665 @enumerate
19666 @item
19667 the memory occupied by the current function's stack frame;
19669 @item
19670 the memory occupied by an incoming stack argument;
19672 @item
19673 the memory occupied by an object with a link-time-constant address.
19674 @end enumerate
19676 It is the kernel's responsibility to ensure that speculative
19677 accesses to these regions are indeed safe.
19679 If the input program contains a function declaration such as:
19681 @smallexample
19682 void foo (void);
19683 @end smallexample
19685 then the implementation of @code{foo} must allow @code{j foo} and
19686 @code{jal foo} to be executed speculatively.  GCC honors this
19687 restriction for functions it compiles itself.  It expects non-GCC
19688 functions (such as hand-written assembly code) to do the same.
19690 The option has three forms:
19692 @table @gcctabopt
19693 @item -mr10k-cache-barrier=load-store
19694 Insert a cache barrier before a load or store that might be
19695 speculatively executed and that might have side effects even
19696 if aborted.
19698 @item -mr10k-cache-barrier=store
19699 Insert a cache barrier before a store that might be speculatively
19700 executed and that might have side effects even if aborted.
19702 @item -mr10k-cache-barrier=none
19703 Disable the insertion of cache barriers.  This is the default setting.
19704 @end table
19706 @item -mflush-func=@var{func}
19707 @itemx -mno-flush-func
19708 @opindex mflush-func
19709 Specifies the function to call to flush the I and D caches, or to not
19710 call any such function.  If called, the function must take the same
19711 arguments as the common @code{_flush_func}, that is, the address of the
19712 memory range for which the cache is being flushed, the size of the
19713 memory range, and the number 3 (to flush both caches).  The default
19714 depends on the target GCC was configured for, but commonly is either
19715 @code{_flush_func} or @code{__cpu_flush}.
19717 @item mbranch-cost=@var{num}
19718 @opindex mbranch-cost
19719 Set the cost of branches to roughly @var{num} ``simple'' instructions.
19720 This cost is only a heuristic and is not guaranteed to produce
19721 consistent results across releases.  A zero cost redundantly selects
19722 the default, which is based on the @option{-mtune} setting.
19724 @item -mbranch-likely
19725 @itemx -mno-branch-likely
19726 @opindex mbranch-likely
19727 @opindex mno-branch-likely
19728 Enable or disable use of Branch Likely instructions, regardless of the
19729 default for the selected architecture.  By default, Branch Likely
19730 instructions may be generated if they are supported by the selected
19731 architecture.  An exception is for the MIPS32 and MIPS64 architectures
19732 and processors that implement those architectures; for those, Branch
19733 Likely instructions are not be generated by default because the MIPS32
19734 and MIPS64 architectures specifically deprecate their use.
19736 @item -mcompact-branches=never
19737 @itemx -mcompact-branches=optimal
19738 @itemx -mcompact-branches=always
19739 @opindex mcompact-branches=never
19740 @opindex mcompact-branches=optimal
19741 @opindex mcompact-branches=always
19742 These options control which form of branches will be generated.  The
19743 default is @option{-mcompact-branches=optimal}.
19745 The @option{-mcompact-branches=never} option ensures that compact branch
19746 instructions will never be generated.
19748 The @option{-mcompact-branches=always} option ensures that a compact
19749 branch instruction will be generated if available.  If a compact branch
19750 instruction is not available, a delay slot form of the branch will be
19751 used instead.
19753 This option is supported from MIPS Release 6 onwards.
19755 The @option{-mcompact-branches=optimal} option will cause a delay slot
19756 branch to be used if one is available in the current ISA and the delay
19757 slot is successfully filled.  If the delay slot is not filled, a compact
19758 branch will be chosen if one is available.
19760 @item -mfp-exceptions
19761 @itemx -mno-fp-exceptions
19762 @opindex mfp-exceptions
19763 Specifies whether FP exceptions are enabled.  This affects how
19764 FP instructions are scheduled for some processors.
19765 The default is that FP exceptions are
19766 enabled.
19768 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
19769 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
19770 FP pipe.
19772 @item -mvr4130-align
19773 @itemx -mno-vr4130-align
19774 @opindex mvr4130-align
19775 The VR4130 pipeline is two-way superscalar, but can only issue two
19776 instructions together if the first one is 8-byte aligned.  When this
19777 option is enabled, GCC aligns pairs of instructions that it
19778 thinks should execute in parallel.
19780 This option only has an effect when optimizing for the VR4130.
19781 It normally makes code faster, but at the expense of making it bigger.
19782 It is enabled by default at optimization level @option{-O3}.
19784 @item -msynci
19785 @itemx -mno-synci
19786 @opindex msynci
19787 Enable (disable) generation of @code{synci} instructions on
19788 architectures that support it.  The @code{synci} instructions (if
19789 enabled) are generated when @code{__builtin___clear_cache} is
19790 compiled.
19792 This option defaults to @option{-mno-synci}, but the default can be
19793 overridden by configuring GCC with @option{--with-synci}.
19795 When compiling code for single processor systems, it is generally safe
19796 to use @code{synci}.  However, on many multi-core (SMP) systems, it
19797 does not invalidate the instruction caches on all cores and may lead
19798 to undefined behavior.
19800 @item -mrelax-pic-calls
19801 @itemx -mno-relax-pic-calls
19802 @opindex mrelax-pic-calls
19803 Try to turn PIC calls that are normally dispatched via register
19804 @code{$25} into direct calls.  This is only possible if the linker can
19805 resolve the destination at link time and if the destination is within
19806 range for a direct call.
19808 @option{-mrelax-pic-calls} is the default if GCC was configured to use
19809 an assembler and a linker that support the @code{.reloc} assembly
19810 directive and @option{-mexplicit-relocs} is in effect.  With
19811 @option{-mno-explicit-relocs}, this optimization can be performed by the
19812 assembler and the linker alone without help from the compiler.
19814 @item -mmcount-ra-address
19815 @itemx -mno-mcount-ra-address
19816 @opindex mmcount-ra-address
19817 @opindex mno-mcount-ra-address
19818 Emit (do not emit) code that allows @code{_mcount} to modify the
19819 calling function's return address.  When enabled, this option extends
19820 the usual @code{_mcount} interface with a new @var{ra-address}
19821 parameter, which has type @code{intptr_t *} and is passed in register
19822 @code{$12}.  @code{_mcount} can then modify the return address by
19823 doing both of the following:
19824 @itemize
19825 @item
19826 Returning the new address in register @code{$31}.
19827 @item
19828 Storing the new address in @code{*@var{ra-address}},
19829 if @var{ra-address} is nonnull.
19830 @end itemize
19832 The default is @option{-mno-mcount-ra-address}.
19834 @item -mframe-header-opt
19835 @itemx -mno-frame-header-opt
19836 @opindex mframe-header-opt
19837 Enable (disable) frame header optimization in the o32 ABI.  When using the
19838 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
19839 function to write out register arguments.  When enabled, this optimization
19840 will suppress the allocation of the frame header if it can be determined that
19841 it is unused.
19843 This optimization is off by default at all optimization levels.
19845 @item -mlxc1-sxc1
19846 @itemx -mno-lxc1-sxc1
19847 @opindex mlxc1-sxc1
19848 When applicable, enable (disable) the generation of @code{lwxc1},
19849 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
19851 @item -mmadd4
19852 @itemx -mno-madd4
19853 @opindex mmadd4
19854 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
19855 @code{madd.d} and related instructions.  Enabled by default.
19857 @end table
19859 @node MMIX Options
19860 @subsection MMIX Options
19861 @cindex MMIX Options
19863 These options are defined for the MMIX:
19865 @table @gcctabopt
19866 @item -mlibfuncs
19867 @itemx -mno-libfuncs
19868 @opindex mlibfuncs
19869 @opindex mno-libfuncs
19870 Specify that intrinsic library functions are being compiled, passing all
19871 values in registers, no matter the size.
19873 @item -mepsilon
19874 @itemx -mno-epsilon
19875 @opindex mepsilon
19876 @opindex mno-epsilon
19877 Generate floating-point comparison instructions that compare with respect
19878 to the @code{rE} epsilon register.
19880 @item -mabi=mmixware
19881 @itemx -mabi=gnu
19882 @opindex mabi=mmixware
19883 @opindex mabi=gnu
19884 Generate code that passes function parameters and return values that (in
19885 the called function) are seen as registers @code{$0} and up, as opposed to
19886 the GNU ABI which uses global registers @code{$231} and up.
19888 @item -mzero-extend
19889 @itemx -mno-zero-extend
19890 @opindex mzero-extend
19891 @opindex mno-zero-extend
19892 When reading data from memory in sizes shorter than 64 bits, use (do not
19893 use) zero-extending load instructions by default, rather than
19894 sign-extending ones.
19896 @item -mknuthdiv
19897 @itemx -mno-knuthdiv
19898 @opindex mknuthdiv
19899 @opindex mno-knuthdiv
19900 Make the result of a division yielding a remainder have the same sign as
19901 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
19902 remainder follows the sign of the dividend.  Both methods are
19903 arithmetically valid, the latter being almost exclusively used.
19905 @item -mtoplevel-symbols
19906 @itemx -mno-toplevel-symbols
19907 @opindex mtoplevel-symbols
19908 @opindex mno-toplevel-symbols
19909 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
19910 code can be used with the @code{PREFIX} assembly directive.
19912 @item -melf
19913 @opindex melf
19914 Generate an executable in the ELF format, rather than the default
19915 @samp{mmo} format used by the @command{mmix} simulator.
19917 @item -mbranch-predict
19918 @itemx -mno-branch-predict
19919 @opindex mbranch-predict
19920 @opindex mno-branch-predict
19921 Use (do not use) the probable-branch instructions, when static branch
19922 prediction indicates a probable branch.
19924 @item -mbase-addresses
19925 @itemx -mno-base-addresses
19926 @opindex mbase-addresses
19927 @opindex mno-base-addresses
19928 Generate (do not generate) code that uses @emph{base addresses}.  Using a
19929 base address automatically generates a request (handled by the assembler
19930 and the linker) for a constant to be set up in a global register.  The
19931 register is used for one or more base address requests within the range 0
19932 to 255 from the value held in the register.  The generally leads to short
19933 and fast code, but the number of different data items that can be
19934 addressed is limited.  This means that a program that uses lots of static
19935 data may require @option{-mno-base-addresses}.
19937 @item -msingle-exit
19938 @itemx -mno-single-exit
19939 @opindex msingle-exit
19940 @opindex mno-single-exit
19941 Force (do not force) generated code to have a single exit point in each
19942 function.
19943 @end table
19945 @node MN10300 Options
19946 @subsection MN10300 Options
19947 @cindex MN10300 options
19949 These @option{-m} options are defined for Matsushita MN10300 architectures:
19951 @table @gcctabopt
19952 @item -mmult-bug
19953 @opindex mmult-bug
19954 Generate code to avoid bugs in the multiply instructions for the MN10300
19955 processors.  This is the default.
19957 @item -mno-mult-bug
19958 @opindex mno-mult-bug
19959 Do not generate code to avoid bugs in the multiply instructions for the
19960 MN10300 processors.
19962 @item -mam33
19963 @opindex mam33
19964 Generate code using features specific to the AM33 processor.
19966 @item -mno-am33
19967 @opindex mno-am33
19968 Do not generate code using features specific to the AM33 processor.  This
19969 is the default.
19971 @item -mam33-2
19972 @opindex mam33-2
19973 Generate code using features specific to the AM33/2.0 processor.
19975 @item -mam34
19976 @opindex mam34
19977 Generate code using features specific to the AM34 processor.
19979 @item -mtune=@var{cpu-type}
19980 @opindex mtune
19981 Use the timing characteristics of the indicated CPU type when
19982 scheduling instructions.  This does not change the targeted processor
19983 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
19984 @samp{am33-2} or @samp{am34}.
19986 @item -mreturn-pointer-on-d0
19987 @opindex mreturn-pointer-on-d0
19988 When generating a function that returns a pointer, return the pointer
19989 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
19990 only in @code{a0}, and attempts to call such functions without a prototype
19991 result in errors.  Note that this option is on by default; use
19992 @option{-mno-return-pointer-on-d0} to disable it.
19994 @item -mno-crt0
19995 @opindex mno-crt0
19996 Do not link in the C run-time initialization object file.
19998 @item -mrelax
19999 @opindex mrelax
20000 Indicate to the linker that it should perform a relaxation optimization pass
20001 to shorten branches, calls and absolute memory addresses.  This option only
20002 has an effect when used on the command line for the final link step.
20004 This option makes symbolic debugging impossible.
20006 @item -mliw
20007 @opindex mliw
20008 Allow the compiler to generate @emph{Long Instruction Word}
20009 instructions if the target is the @samp{AM33} or later.  This is the
20010 default.  This option defines the preprocessor macro @code{__LIW__}.
20012 @item -mnoliw
20013 @opindex mnoliw
20014 Do not allow the compiler to generate @emph{Long Instruction Word}
20015 instructions.  This option defines the preprocessor macro
20016 @code{__NO_LIW__}.
20018 @item -msetlb
20019 @opindex msetlb
20020 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20021 instructions if the target is the @samp{AM33} or later.  This is the
20022 default.  This option defines the preprocessor macro @code{__SETLB__}.
20024 @item -mnosetlb
20025 @opindex mnosetlb
20026 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20027 instructions.  This option defines the preprocessor macro
20028 @code{__NO_SETLB__}.
20030 @end table
20032 @node Moxie Options
20033 @subsection Moxie Options
20034 @cindex Moxie Options
20036 @table @gcctabopt
20038 @item -meb
20039 @opindex meb
20040 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20041 configurations.
20043 @item -mel
20044 @opindex mel
20045 Generate little-endian code.
20047 @item -mmul.x
20048 @opindex mmul.x
20049 Generate mul.x and umul.x instructions.  This is the default for
20050 @samp{moxiebox-*-*} configurations.
20052 @item -mno-crt0
20053 @opindex mno-crt0
20054 Do not link in the C run-time initialization object file.
20056 @end table
20058 @node MSP430 Options
20059 @subsection MSP430 Options
20060 @cindex MSP430 Options
20062 These options are defined for the MSP430:
20064 @table @gcctabopt
20066 @item -masm-hex
20067 @opindex masm-hex
20068 Force assembly output to always use hex constants.  Normally such
20069 constants are signed decimals, but this option is available for
20070 testsuite and/or aesthetic purposes.
20072 @item -mmcu=
20073 @opindex mmcu=
20074 Select the MCU to target.  This is used to create a C preprocessor
20075 symbol based upon the MCU name, converted to upper case and pre- and
20076 post-fixed with @samp{__}.  This in turn is used by the
20077 @file{msp430.h} header file to select an MCU-specific supplementary
20078 header file.
20080 The option also sets the ISA to use.  If the MCU name is one that is
20081 known to only support the 430 ISA then that is selected, otherwise the
20082 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20083 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20084 name selects the 430X ISA.
20086 In addition an MCU-specific linker script is added to the linker
20087 command line.  The script's name is the name of the MCU with
20088 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20089 command line defines the C preprocessor symbol @code{__XXX__} and
20090 cause the linker to search for a script called @file{xxx.ld}.
20092 This option is also passed on to the assembler.
20094 @item -mwarn-mcu
20095 @itemx -mno-warn-mcu
20096 @opindex mwarn-mcu
20097 @opindex mno-warn-mcu
20098 This option enables or disables warnings about conflicts between the
20099 MCU name specified by the @option{-mmcu} option and the ISA set by the
20100 @option{-mcpu} option and/or the hardware multiply support set by the
20101 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20102 MCU names.  This option is on by default.
20104 @item -mcpu=
20105 @opindex mcpu=
20106 Specifies the ISA to use.  Accepted values are @samp{msp430},
20107 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20108 @option{-mmcu=} option should be used to select the ISA.
20110 @item -msim
20111 @opindex msim
20112 Link to the simulator runtime libraries and linker script.  Overrides
20113 any scripts that would be selected by the @option{-mmcu=} option.
20115 @item -mlarge
20116 @opindex mlarge
20117 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20119 @item -msmall
20120 @opindex msmall
20121 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20123 @item -mrelax
20124 @opindex mrelax
20125 This option is passed to the assembler and linker, and allows the
20126 linker to perform certain optimizations that cannot be done until
20127 the final link.
20129 @item mhwmult=
20130 @opindex mhwmult=
20131 Describes the type of hardware multiply supported by the target.
20132 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20133 for the original 16-bit-only multiply supported by early MCUs.
20134 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20135 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20136 A value of @samp{auto} can also be given.  This tells GCC to deduce
20137 the hardware multiply support based upon the MCU name provided by the
20138 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20139 the MCU name is not recognized then no hardware multiply support is
20140 assumed.  @code{auto} is the default setting.
20142 Hardware multiplies are normally performed by calling a library
20143 routine.  This saves space in the generated code.  When compiling at
20144 @option{-O3} or higher however the hardware multiplier is invoked
20145 inline.  This makes for bigger, but faster code.
20147 The hardware multiply routines disable interrupts whilst running and
20148 restore the previous interrupt state when they finish.  This makes
20149 them safe to use inside interrupt handlers as well as in normal code.
20151 @item -minrt
20152 @opindex minrt
20153 Enable the use of a minimum runtime environment - no static
20154 initializers or constructors.  This is intended for memory-constrained
20155 devices.  The compiler includes special symbols in some objects
20156 that tell the linker and runtime which code fragments are required.
20158 @item -mcode-region=
20159 @itemx -mdata-region=
20160 @opindex mcode-region
20161 @opindex mdata-region
20162 These options tell the compiler where to place functions and data that
20163 do not have one of the @code{lower}, @code{upper}, @code{either} or
20164 @code{section} attributes.  Possible values are @code{lower},
20165 @code{upper}, @code{either} or @code{any}.  The first three behave
20166 like the corresponding attribute.  The fourth possible value -
20167 @code{any} - is the default.  It leaves placement entirely up to the
20168 linker script and how it assigns the standard sections
20169 (@code{.text}, @code{.data}, etc) to the memory regions.
20171 @item -msilicon-errata=
20172 @opindex msilicon-errata
20173 This option passes on a request to assembler to enable the fixes for
20174 the named silicon errata.
20176 @item -msilicon-errata-warn=
20177 @opindex msilicon-errata-warn
20178 This option passes on a request to the assembler to enable warning
20179 messages when a silicon errata might need to be applied.
20181 @end table
20183 @node NDS32 Options
20184 @subsection NDS32 Options
20185 @cindex NDS32 Options
20187 These options are defined for NDS32 implementations:
20189 @table @gcctabopt
20191 @item -mbig-endian
20192 @opindex mbig-endian
20193 Generate code in big-endian mode.
20195 @item -mlittle-endian
20196 @opindex mlittle-endian
20197 Generate code in little-endian mode.
20199 @item -mreduced-regs
20200 @opindex mreduced-regs
20201 Use reduced-set registers for register allocation.
20203 @item -mfull-regs
20204 @opindex mfull-regs
20205 Use full-set registers for register allocation.
20207 @item -mcmov
20208 @opindex mcmov
20209 Generate conditional move instructions.
20211 @item -mno-cmov
20212 @opindex mno-cmov
20213 Do not generate conditional move instructions.
20215 @item -mperf-ext
20216 @opindex mperf-ext
20217 Generate performance extension instructions.
20219 @item -mno-perf-ext
20220 @opindex mno-perf-ext
20221 Do not generate performance extension instructions.
20223 @item -mv3push
20224 @opindex mv3push
20225 Generate v3 push25/pop25 instructions.
20227 @item -mno-v3push
20228 @opindex mno-v3push
20229 Do not generate v3 push25/pop25 instructions.
20231 @item -m16-bit
20232 @opindex m16-bit
20233 Generate 16-bit instructions.
20235 @item -mno-16-bit
20236 @opindex mno-16-bit
20237 Do not generate 16-bit instructions.
20239 @item -misr-vector-size=@var{num}
20240 @opindex misr-vector-size
20241 Specify the size of each interrupt vector, which must be 4 or 16.
20243 @item -mcache-block-size=@var{num}
20244 @opindex mcache-block-size
20245 Specify the size of each cache block,
20246 which must be a power of 2 between 4 and 512.
20248 @item -march=@var{arch}
20249 @opindex march
20250 Specify the name of the target architecture.
20252 @item -mcmodel=@var{code-model}
20253 @opindex mcmodel
20254 Set the code model to one of
20255 @table @asis
20256 @item @samp{small}
20257 All the data and read-only data segments must be within 512KB addressing space.
20258 The text segment must be within 16MB addressing space.
20259 @item @samp{medium}
20260 The data segment must be within 512KB while the read-only data segment can be
20261 within 4GB addressing space.  The text segment should be still within 16MB
20262 addressing space.
20263 @item @samp{large}
20264 All the text and data segments can be within 4GB addressing space.
20265 @end table
20267 @item -mctor-dtor
20268 @opindex mctor-dtor
20269 Enable constructor/destructor feature.
20271 @item -mrelax
20272 @opindex mrelax
20273 Guide linker to relax instructions.
20275 @end table
20277 @node Nios II Options
20278 @subsection Nios II Options
20279 @cindex Nios II options
20280 @cindex Altera Nios II options
20282 These are the options defined for the Altera Nios II processor.
20284 @table @gcctabopt
20286 @item -G @var{num}
20287 @opindex G
20288 @cindex smaller data references
20289 Put global and static objects less than or equal to @var{num} bytes
20290 into the small data or BSS sections instead of the normal data or BSS
20291 sections.  The default value of @var{num} is 8.
20293 @item -mgpopt=@var{option}
20294 @item -mgpopt
20295 @itemx -mno-gpopt
20296 @opindex mgpopt
20297 @opindex mno-gpopt
20298 Generate (do not generate) GP-relative accesses.  The following 
20299 @var{option} names are recognized:
20301 @table @samp
20303 @item none
20304 Do not generate GP-relative accesses.
20306 @item local
20307 Generate GP-relative accesses for small data objects that are not 
20308 external, weak, or uninitialized common symbols.  
20309 Also use GP-relative addressing for objects that
20310 have been explicitly placed in a small data section via a @code{section}
20311 attribute.
20313 @item global
20314 As for @samp{local}, but also generate GP-relative accesses for
20315 small data objects that are external, weak, or common.  If you use this option,
20316 you must ensure that all parts of your program (including libraries) are
20317 compiled with the same @option{-G} setting.
20319 @item data
20320 Generate GP-relative accesses for all data objects in the program.  If you
20321 use this option, the entire data and BSS segments
20322 of your program must fit in 64K of memory and you must use an appropriate
20323 linker script to allocate them within the addressable range of the
20324 global pointer.
20326 @item all
20327 Generate GP-relative addresses for function pointers as well as data
20328 pointers.  If you use this option, the entire text, data, and BSS segments
20329 of your program must fit in 64K of memory and you must use an appropriate
20330 linker script to allocate them within the addressable range of the
20331 global pointer.
20333 @end table
20335 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20336 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20338 The default is @option{-mgpopt} except when @option{-fpic} or
20339 @option{-fPIC} is specified to generate position-independent code.
20340 Note that the Nios II ABI does not permit GP-relative accesses from
20341 shared libraries.
20343 You may need to specify @option{-mno-gpopt} explicitly when building
20344 programs that include large amounts of small data, including large
20345 GOT data sections.  In this case, the 16-bit offset for GP-relative
20346 addressing may not be large enough to allow access to the entire 
20347 small data section.
20349 @item -mel
20350 @itemx -meb
20351 @opindex mel
20352 @opindex meb
20353 Generate little-endian (default) or big-endian (experimental) code,
20354 respectively.
20356 @item -march=@var{arch}
20357 @opindex march
20358 This specifies the name of the target Nios II architecture.  GCC uses this
20359 name to determine what kind of instructions it can emit when generating
20360 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20362 The preprocessor macro @code{__nios2_arch__} is available to programs,
20363 with value 1 or 2, indicating the targeted ISA level.
20365 @item -mbypass-cache
20366 @itemx -mno-bypass-cache
20367 @opindex mno-bypass-cache
20368 @opindex mbypass-cache
20369 Force all load and store instructions to always bypass cache by 
20370 using I/O variants of the instructions. The default is not to
20371 bypass the cache.
20373 @item -mno-cache-volatile 
20374 @itemx -mcache-volatile       
20375 @opindex mcache-volatile 
20376 @opindex mno-cache-volatile
20377 Volatile memory access bypass the cache using the I/O variants of 
20378 the load and store instructions. The default is not to bypass the cache.
20380 @item -mno-fast-sw-div
20381 @itemx -mfast-sw-div
20382 @opindex mno-fast-sw-div
20383 @opindex mfast-sw-div
20384 Do not use table-based fast divide for small numbers. The default 
20385 is to use the fast divide at @option{-O3} and above.
20387 @item -mno-hw-mul
20388 @itemx -mhw-mul
20389 @itemx -mno-hw-mulx
20390 @itemx -mhw-mulx
20391 @itemx -mno-hw-div
20392 @itemx -mhw-div
20393 @opindex mno-hw-mul
20394 @opindex mhw-mul
20395 @opindex mno-hw-mulx
20396 @opindex mhw-mulx
20397 @opindex mno-hw-div
20398 @opindex mhw-div
20399 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20400 instructions by the compiler. The default is to emit @code{mul}
20401 and not emit @code{div} and @code{mulx}.
20403 @item -mbmx
20404 @itemx -mno-bmx
20405 @itemx -mcdx
20406 @itemx -mno-cdx
20407 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20408 CDX (code density) instructions.  Enabling these instructions also
20409 requires @option{-march=r2}.  Since these instructions are optional
20410 extensions to the R2 architecture, the default is not to emit them.
20412 @item -mcustom-@var{insn}=@var{N}
20413 @itemx -mno-custom-@var{insn}
20414 @opindex mcustom-@var{insn}
20415 @opindex mno-custom-@var{insn}
20416 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20417 custom instruction with encoding @var{N} when generating code that uses 
20418 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20419 instruction 253 for single-precision floating-point add operations instead
20420 of the default behavior of using a library call.
20422 The following values of @var{insn} are supported.  Except as otherwise
20423 noted, floating-point operations are expected to be implemented with
20424 normal IEEE 754 semantics and correspond directly to the C operators or the
20425 equivalent GCC built-in functions (@pxref{Other Builtins}).
20427 Single-precision floating point:
20428 @table @asis
20430 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20431 Binary arithmetic operations.
20433 @item @samp{fnegs}
20434 Unary negation.
20436 @item @samp{fabss}
20437 Unary absolute value.
20439 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20440 Comparison operations.
20442 @item @samp{fmins}, @samp{fmaxs}
20443 Floating-point minimum and maximum.  These instructions are only
20444 generated if @option{-ffinite-math-only} is specified.
20446 @item @samp{fsqrts}
20447 Unary square root operation.
20449 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20450 Floating-point trigonometric and exponential functions.  These instructions
20451 are only generated if @option{-funsafe-math-optimizations} is also specified.
20453 @end table
20455 Double-precision floating point:
20456 @table @asis
20458 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20459 Binary arithmetic operations.
20461 @item @samp{fnegd}
20462 Unary negation.
20464 @item @samp{fabsd}
20465 Unary absolute value.
20467 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20468 Comparison operations.
20470 @item @samp{fmind}, @samp{fmaxd}
20471 Double-precision minimum and maximum.  These instructions are only
20472 generated if @option{-ffinite-math-only} is specified.
20474 @item @samp{fsqrtd}
20475 Unary square root operation.
20477 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20478 Double-precision trigonometric and exponential functions.  These instructions
20479 are only generated if @option{-funsafe-math-optimizations} is also specified.
20481 @end table
20483 Conversions:
20484 @table @asis
20485 @item @samp{fextsd}
20486 Conversion from single precision to double precision.
20488 @item @samp{ftruncds}
20489 Conversion from double precision to single precision.
20491 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20492 Conversion from floating point to signed or unsigned integer types, with
20493 truncation towards zero.
20495 @item @samp{round}
20496 Conversion from single-precision floating point to signed integer,
20497 rounding to the nearest integer and ties away from zero.
20498 This corresponds to the @code{__builtin_lroundf} function when
20499 @option{-fno-math-errno} is used.
20501 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20502 Conversion from signed or unsigned integer types to floating-point types.
20504 @end table
20506 In addition, all of the following transfer instructions for internal
20507 registers X and Y must be provided to use any of the double-precision
20508 floating-point instructions.  Custom instructions taking two
20509 double-precision source operands expect the first operand in the
20510 64-bit register X.  The other operand (or only operand of a unary
20511 operation) is given to the custom arithmetic instruction with the
20512 least significant half in source register @var{src1} and the most
20513 significant half in @var{src2}.  A custom instruction that returns a
20514 double-precision result returns the most significant 32 bits in the
20515 destination register and the other half in 32-bit register Y.  
20516 GCC automatically generates the necessary code sequences to write
20517 register X and/or read register Y when double-precision floating-point
20518 instructions are used.
20520 @table @asis
20522 @item @samp{fwrx}
20523 Write @var{src1} into the least significant half of X and @var{src2} into
20524 the most significant half of X.
20526 @item @samp{fwry}
20527 Write @var{src1} into Y.
20529 @item @samp{frdxhi}, @samp{frdxlo}
20530 Read the most or least (respectively) significant half of X and store it in
20531 @var{dest}.
20533 @item @samp{frdy}
20534 Read the value of Y and store it into @var{dest}.
20535 @end table
20537 Note that you can gain more local control over generation of Nios II custom
20538 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
20539 and @code{target("no-custom-@var{insn}")} function attributes
20540 (@pxref{Function Attributes})
20541 or pragmas (@pxref{Function Specific Option Pragmas}).
20543 @item -mcustom-fpu-cfg=@var{name}
20544 @opindex mcustom-fpu-cfg
20546 This option enables a predefined, named set of custom instruction encodings
20547 (see @option{-mcustom-@var{insn}} above).  
20548 Currently, the following sets are defined:
20550 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
20551 @gccoptlist{-mcustom-fmuls=252 @gol
20552 -mcustom-fadds=253 @gol
20553 -mcustom-fsubs=254 @gol
20554 -fsingle-precision-constant}
20556 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
20557 @gccoptlist{-mcustom-fmuls=252 @gol
20558 -mcustom-fadds=253 @gol
20559 -mcustom-fsubs=254 @gol
20560 -mcustom-fdivs=255 @gol
20561 -fsingle-precision-constant}
20563 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
20564 @gccoptlist{-mcustom-floatus=243 @gol
20565 -mcustom-fixsi=244 @gol
20566 -mcustom-floatis=245 @gol
20567 -mcustom-fcmpgts=246 @gol
20568 -mcustom-fcmples=249 @gol
20569 -mcustom-fcmpeqs=250 @gol
20570 -mcustom-fcmpnes=251 @gol
20571 -mcustom-fmuls=252 @gol
20572 -mcustom-fadds=253 @gol
20573 -mcustom-fsubs=254 @gol
20574 -mcustom-fdivs=255 @gol
20575 -fsingle-precision-constant}
20577 Custom instruction assignments given by individual
20578 @option{-mcustom-@var{insn}=} options override those given by
20579 @option{-mcustom-fpu-cfg=}, regardless of the
20580 order of the options on the command line.
20582 Note that you can gain more local control over selection of a FPU
20583 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
20584 function attribute (@pxref{Function Attributes})
20585 or pragma (@pxref{Function Specific Option Pragmas}).
20587 @end table
20589 These additional @samp{-m} options are available for the Altera Nios II
20590 ELF (bare-metal) target:
20592 @table @gcctabopt
20594 @item -mhal
20595 @opindex mhal
20596 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
20597 startup and termination code, and is typically used in conjunction with
20598 @option{-msys-crt0=} to specify the location of the alternate startup code
20599 provided by the HAL BSP.
20601 @item -msmallc
20602 @opindex msmallc
20603 Link with a limited version of the C library, @option{-lsmallc}, rather than
20604 Newlib.
20606 @item -msys-crt0=@var{startfile}
20607 @opindex msys-crt0
20608 @var{startfile} is the file name of the startfile (crt0) to use 
20609 when linking.  This option is only useful in conjunction with @option{-mhal}.
20611 @item -msys-lib=@var{systemlib}
20612 @opindex msys-lib
20613 @var{systemlib} is the library name of the library that provides
20614 low-level system calls required by the C library,
20615 e.g. @code{read} and @code{write}.
20616 This option is typically used to link with a library provided by a HAL BSP.
20618 @end table
20620 @node Nvidia PTX Options
20621 @subsection Nvidia PTX Options
20622 @cindex Nvidia PTX options
20623 @cindex nvptx options
20625 These options are defined for Nvidia PTX:
20627 @table @gcctabopt
20629 @item -m32
20630 @itemx -m64
20631 @opindex m32
20632 @opindex m64
20633 Generate code for 32-bit or 64-bit ABI.
20635 @item -mmainkernel
20636 @opindex mmainkernel
20637 Link in code for a __main kernel.  This is for stand-alone instead of
20638 offloading execution.
20640 @item -moptimize
20641 @opindex moptimize
20642 Apply partitioned execution optimizations.  This is the default when any
20643 level of optimization is selected.
20645 @item -msoft-stack
20646 @opindex msoft-stack
20647 Generate code that does not use @code{.local} memory
20648 directly for stack storage. Instead, a per-warp stack pointer is
20649 maintained explicitly. This enables variable-length stack allocation (with
20650 variable-length arrays or @code{alloca}), and when global memory is used for
20651 underlying storage, makes it possible to access automatic variables from other
20652 threads, or with atomic instructions. This code generation variant is used
20653 for OpenMP offloading, but the option is exposed on its own for the purpose
20654 of testing the compiler; to generate code suitable for linking into programs
20655 using OpenMP offloading, use option @option{-mgomp}.
20657 @item -muniform-simt
20658 @opindex muniform-simt
20659 Switch to code generation variant that allows to execute all threads in each
20660 warp, while maintaining memory state and side effects as if only one thread
20661 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
20662 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
20663 current lane index equals the master lane index), and the register being
20664 assigned is copied via a shuffle instruction from the master lane.  Outside of
20665 SIMD regions lane 0 is the master; inside, each thread sees itself as the
20666 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
20667 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
20668 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
20669 with current lane index to compute the master lane index.
20671 @item -mgomp
20672 @opindex mgomp
20673 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
20674 @option{-muniform-simt} options, and selects corresponding multilib variant.
20676 @end table
20678 @node PDP-11 Options
20679 @subsection PDP-11 Options
20680 @cindex PDP-11 Options
20682 These options are defined for the PDP-11:
20684 @table @gcctabopt
20685 @item -mfpu
20686 @opindex mfpu
20687 Use hardware FPP floating point.  This is the default.  (FIS floating
20688 point on the PDP-11/40 is not supported.)
20690 @item -msoft-float
20691 @opindex msoft-float
20692 Do not use hardware floating point.
20694 @item -mac0
20695 @opindex mac0
20696 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
20698 @item -mno-ac0
20699 @opindex mno-ac0
20700 Return floating-point results in memory.  This is the default.
20702 @item -m40
20703 @opindex m40
20704 Generate code for a PDP-11/40.
20706 @item -m45
20707 @opindex m45
20708 Generate code for a PDP-11/45.  This is the default.
20710 @item -m10
20711 @opindex m10
20712 Generate code for a PDP-11/10.
20714 @item -mbcopy-builtin
20715 @opindex mbcopy-builtin
20716 Use inline @code{movmemhi} patterns for copying memory.  This is the
20717 default.
20719 @item -mbcopy
20720 @opindex mbcopy
20721 Do not use inline @code{movmemhi} patterns for copying memory.
20723 @item -mint16
20724 @itemx -mno-int32
20725 @opindex mint16
20726 @opindex mno-int32
20727 Use 16-bit @code{int}.  This is the default.
20729 @item -mint32
20730 @itemx -mno-int16
20731 @opindex mint32
20732 @opindex mno-int16
20733 Use 32-bit @code{int}.
20735 @item -mfloat64
20736 @itemx -mno-float32
20737 @opindex mfloat64
20738 @opindex mno-float32
20739 Use 64-bit @code{float}.  This is the default.
20741 @item -mfloat32
20742 @itemx -mno-float64
20743 @opindex mfloat32
20744 @opindex mno-float64
20745 Use 32-bit @code{float}.
20747 @item -mabshi
20748 @opindex mabshi
20749 Use @code{abshi2} pattern.  This is the default.
20751 @item -mno-abshi
20752 @opindex mno-abshi
20753 Do not use @code{abshi2} pattern.
20755 @item -mbranch-expensive
20756 @opindex mbranch-expensive
20757 Pretend that branches are expensive.  This is for experimenting with
20758 code generation only.
20760 @item -mbranch-cheap
20761 @opindex mbranch-cheap
20762 Do not pretend that branches are expensive.  This is the default.
20764 @item -munix-asm
20765 @opindex munix-asm
20766 Use Unix assembler syntax.  This is the default when configured for
20767 @samp{pdp11-*-bsd}.
20769 @item -mdec-asm
20770 @opindex mdec-asm
20771 Use DEC assembler syntax.  This is the default when configured for any
20772 PDP-11 target other than @samp{pdp11-*-bsd}.
20773 @end table
20775 @node picoChip Options
20776 @subsection picoChip Options
20777 @cindex picoChip options
20779 These @samp{-m} options are defined for picoChip implementations:
20781 @table @gcctabopt
20783 @item -mae=@var{ae_type}
20784 @opindex mcpu
20785 Set the instruction set, register set, and instruction scheduling
20786 parameters for array element type @var{ae_type}.  Supported values
20787 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
20789 @option{-mae=ANY} selects a completely generic AE type.  Code
20790 generated with this option runs on any of the other AE types.  The
20791 code is not as efficient as it would be if compiled for a specific
20792 AE type, and some types of operation (e.g., multiplication) do not
20793 work properly on all types of AE.
20795 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
20796 for compiled code, and is the default.
20798 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
20799 option may suffer from poor performance of byte (char) manipulation,
20800 since the DSP AE does not provide hardware support for byte load/stores.
20802 @item -msymbol-as-address
20803 Enable the compiler to directly use a symbol name as an address in a
20804 load/store instruction, without first loading it into a
20805 register.  Typically, the use of this option generates larger
20806 programs, which run faster than when the option isn't used.  However, the
20807 results vary from program to program, so it is left as a user option,
20808 rather than being permanently enabled.
20810 @item -mno-inefficient-warnings
20811 Disables warnings about the generation of inefficient code.  These
20812 warnings can be generated, for example, when compiling code that
20813 performs byte-level memory operations on the MAC AE type.  The MAC AE has
20814 no hardware support for byte-level memory operations, so all byte
20815 load/stores must be synthesized from word load/store operations.  This is
20816 inefficient and a warning is generated to indicate
20817 that you should rewrite the code to avoid byte operations, or to target
20818 an AE type that has the necessary hardware support.  This option disables
20819 these warnings.
20821 @end table
20823 @node PowerPC Options
20824 @subsection PowerPC Options
20825 @cindex PowerPC options
20827 These are listed under @xref{RS/6000 and PowerPC Options}.
20829 @node RISC-V Options
20830 @subsection RISC-V Options
20831 @cindex RISC-V Options
20833 These command-line options are defined for RISC-V targets:
20835 @table @gcctabopt
20836 @item -mbranch-cost=@var{n}
20837 @opindex mbranch-cost
20838 Set the cost of branches to roughly @var{n} instructions.
20840 @item -mmemcpy
20841 @itemx -mno-memcpy
20842 @opindex mmemcpy
20843 Don't optimize block moves.
20845 @item -mplt
20846 @itemx -mno-plt
20847 @opindex plt
20848 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
20850 @item -mabi=@var{ABI-string}
20851 @opindex mabi
20852 Specify integer and floating-point calling convention.  This defaults to the
20853 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
20854 RV64G.
20856 @item -mfdiv
20857 @itemx -mno-fdiv
20858 @opindex mfdiv
20859 Use hardware floating-point divide and square root instructions.  This requires
20860 the F or D extensions for floating-point registers.
20862 @item -mdiv
20863 @itemx -mno-div
20864 @opindex mdiv
20865 Use hardware instructions for integer division.  This requires the M extension.
20867 @item -march=@var{ISA-string}
20868 @opindex march
20869 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
20870 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
20872 @item -mtune=@var{processor-string}
20873 @opindex mtune
20874 Optimize the output for the given processor, specified by microarchitecture
20875 name.
20877 @item -msmall-data-limit=@var{n}
20878 @opindex msmall-data-limit
20879 Put global and static data smaller than @var{n} bytes into a special section
20880 (on some targets).
20882 @item -msave-restore
20883 @itemx -mno-save-restore
20884 @opindex msave-restore
20885 Use smaller but slower prologue and epilogue code.
20887 @item -mcmodel=@var{code-model}
20888 @opindex mcmodel
20889 Specify the code model.
20891 @end table
20893 @node RL78 Options
20894 @subsection RL78 Options
20895 @cindex RL78 Options
20897 @table @gcctabopt
20899 @item -msim
20900 @opindex msim
20901 Links in additional target libraries to support operation within a
20902 simulator.
20904 @item -mmul=none
20905 @itemx -mmul=g10
20906 @itemx -mmul=g13
20907 @itemx -mmul=g14
20908 @itemx -mmul=rl78
20909 @opindex mmul
20910 Specifies the type of hardware multiplication and division support to
20911 be used.  The simplest is @code{none}, which uses software for both
20912 multiplication and division.  This is the default.  The @code{g13}
20913 value is for the hardware multiply/divide peripheral found on the
20914 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
20915 the multiplication and division instructions supported by the RL78/G14
20916 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
20917 the value @code{mg10} is an alias for @code{none}.
20919 In addition a C preprocessor macro is defined, based upon the setting
20920 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
20921 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
20923 @item -mcpu=g10
20924 @itemx -mcpu=g13
20925 @itemx -mcpu=g14
20926 @itemx -mcpu=rl78
20927 @opindex mcpu
20928 Specifies the RL78 core to target.  The default is the G14 core, also
20929 known as an S3 core or just RL78.  The G13 or S2 core does not have
20930 multiply or divide instructions, instead it uses a hardware peripheral
20931 for these operations.  The G10 or S1 core does not have register
20932 banks, so it uses a different calling convention.
20934 If this option is set it also selects the type of hardware multiply
20935 support to use, unless this is overridden by an explicit
20936 @option{-mmul=none} option on the command line.  Thus specifying
20937 @option{-mcpu=g13} enables the use of the G13 hardware multiply
20938 peripheral and specifying @option{-mcpu=g10} disables the use of
20939 hardware multiplications altogether.
20941 Note, although the RL78/G14 core is the default target, specifying
20942 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
20943 change the behavior of the toolchain since it also enables G14
20944 hardware multiply support.  If these options are not specified on the
20945 command line then software multiplication routines will be used even
20946 though the code targets the RL78 core.  This is for backwards
20947 compatibility with older toolchains which did not have hardware
20948 multiply and divide support.
20950 In addition a C preprocessor macro is defined, based upon the setting
20951 of this option.  Possible values are: @code{__RL78_G10__},
20952 @code{__RL78_G13__} or @code{__RL78_G14__}.
20954 @item -mg10
20955 @itemx -mg13
20956 @itemx -mg14
20957 @itemx -mrl78
20958 @opindex mg10
20959 @opindex mg13
20960 @opindex mg14
20961 @opindex mrl78
20962 These are aliases for the corresponding @option{-mcpu=} option.  They
20963 are provided for backwards compatibility.
20965 @item -mallregs
20966 @opindex mallregs
20967 Allow the compiler to use all of the available registers.  By default
20968 registers @code{r24..r31} are reserved for use in interrupt handlers.
20969 With this option enabled these registers can be used in ordinary
20970 functions as well.
20972 @item -m64bit-doubles
20973 @itemx -m32bit-doubles
20974 @opindex m64bit-doubles
20975 @opindex m32bit-doubles
20976 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20977 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20978 @option{-m32bit-doubles}.
20980 @item -msave-mduc-in-interrupts
20981 @item -mno-save-mduc-in-interrupts
20982 @opindex msave-mduc-in-interrupts
20983 @opindex mno-save-mduc-in-interrupts
20984 Specifies that interrupt handler functions should preserve the
20985 MDUC registers.  This is only necessary if normal code might use
20986 the MDUC registers, for example because it performs multiplication
20987 and division operations.  The default is to ignore the MDUC registers
20988 as this makes the interrupt handlers faster.  The target option -mg13
20989 needs to be passed for this to work as this feature is only available
20990 on the G13 target (S2 core).  The MDUC registers will only be saved
20991 if the interrupt handler performs a multiplication or division
20992 operation or it calls another function.
20994 @end table
20996 @node RS/6000 and PowerPC Options
20997 @subsection IBM RS/6000 and PowerPC Options
20998 @cindex RS/6000 and PowerPC Options
20999 @cindex IBM RS/6000 and PowerPC Options
21001 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21002 @table @gcctabopt
21003 @item -mpowerpc-gpopt
21004 @itemx -mno-powerpc-gpopt
21005 @itemx -mpowerpc-gfxopt
21006 @itemx -mno-powerpc-gfxopt
21007 @need 800
21008 @itemx -mpowerpc64
21009 @itemx -mno-powerpc64
21010 @itemx -mmfcrf
21011 @itemx -mno-mfcrf
21012 @itemx -mpopcntb
21013 @itemx -mno-popcntb
21014 @itemx -mpopcntd
21015 @itemx -mno-popcntd
21016 @itemx -mfprnd
21017 @itemx -mno-fprnd
21018 @need 800
21019 @itemx -mcmpb
21020 @itemx -mno-cmpb
21021 @itemx -mmfpgpr
21022 @itemx -mno-mfpgpr
21023 @itemx -mhard-dfp
21024 @itemx -mno-hard-dfp
21025 @opindex mpowerpc-gpopt
21026 @opindex mno-powerpc-gpopt
21027 @opindex mpowerpc-gfxopt
21028 @opindex mno-powerpc-gfxopt
21029 @opindex mpowerpc64
21030 @opindex mno-powerpc64
21031 @opindex mmfcrf
21032 @opindex mno-mfcrf
21033 @opindex mpopcntb
21034 @opindex mno-popcntb
21035 @opindex mpopcntd
21036 @opindex mno-popcntd
21037 @opindex mfprnd
21038 @opindex mno-fprnd
21039 @opindex mcmpb
21040 @opindex mno-cmpb
21041 @opindex mmfpgpr
21042 @opindex mno-mfpgpr
21043 @opindex mhard-dfp
21044 @opindex mno-hard-dfp
21045 You use these options to specify which instructions are available on the
21046 processor you are using.  The default value of these options is
21047 determined when configuring GCC@.  Specifying the
21048 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21049 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21050 rather than the options listed above.
21052 Specifying @option{-mpowerpc-gpopt} allows
21053 GCC to use the optional PowerPC architecture instructions in the
21054 General Purpose group, including floating-point square root.  Specifying
21055 @option{-mpowerpc-gfxopt} allows GCC to
21056 use the optional PowerPC architecture instructions in the Graphics
21057 group, including floating-point select.
21059 The @option{-mmfcrf} option allows GCC to generate the move from
21060 condition register field instruction implemented on the POWER4
21061 processor and other processors that support the PowerPC V2.01
21062 architecture.
21063 The @option{-mpopcntb} option allows GCC to generate the popcount and
21064 double-precision FP reciprocal estimate instruction implemented on the
21065 POWER5 processor and other processors that support the PowerPC V2.02
21066 architecture.
21067 The @option{-mpopcntd} option allows GCC to generate the popcount
21068 instruction implemented on the POWER7 processor and other processors
21069 that support the PowerPC V2.06 architecture.
21070 The @option{-mfprnd} option allows GCC to generate the FP round to
21071 integer instructions implemented on the POWER5+ processor and other
21072 processors that support the PowerPC V2.03 architecture.
21073 The @option{-mcmpb} option allows GCC to generate the compare bytes
21074 instruction implemented on the POWER6 processor and other processors
21075 that support the PowerPC V2.05 architecture.
21076 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21077 general-purpose register instructions implemented on the POWER6X
21078 processor and other processors that support the extended PowerPC V2.05
21079 architecture.
21080 The @option{-mhard-dfp} option allows GCC to generate the decimal
21081 floating-point instructions implemented on some POWER processors.
21083 The @option{-mpowerpc64} option allows GCC to generate the additional
21084 64-bit instructions that are found in the full PowerPC64 architecture
21085 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21086 @option{-mno-powerpc64}.
21088 @item -mcpu=@var{cpu_type}
21089 @opindex mcpu
21090 Set architecture type, register usage, and
21091 instruction scheduling parameters for machine type @var{cpu_type}.
21092 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21093 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21094 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21095 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21096 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21097 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21098 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21099 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21100 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21101 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21102 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21103 and @samp{rs64}.
21105 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21106 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21107 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21108 architecture machine types, with an appropriate, generic processor
21109 model assumed for scheduling purposes.
21111 The other options specify a specific processor.  Code generated under
21112 those options runs best on that processor, and may not run at all on
21113 others.
21115 The @option{-mcpu} options automatically enable or disable the
21116 following options:
21118 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21119 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21120 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21121 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21122 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21123 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21125 The particular options set for any particular CPU varies between
21126 compiler versions, depending on what setting seems to produce optimal
21127 code for that CPU; it doesn't necessarily reflect the actual hardware's
21128 capabilities.  If you wish to set an individual option to a particular
21129 value, you may specify it after the @option{-mcpu} option, like
21130 @option{-mcpu=970 -mno-altivec}.
21132 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21133 not enabled or disabled by the @option{-mcpu} option at present because
21134 AIX does not have full support for these options.  You may still
21135 enable or disable them individually if you're sure it'll work in your
21136 environment.
21138 @item -mtune=@var{cpu_type}
21139 @opindex mtune
21140 Set the instruction scheduling parameters for machine type
21141 @var{cpu_type}, but do not set the architecture type or register usage,
21142 as @option{-mcpu=@var{cpu_type}} does.  The same
21143 values for @var{cpu_type} are used for @option{-mtune} as for
21144 @option{-mcpu}.  If both are specified, the code generated uses the
21145 architecture and registers set by @option{-mcpu}, but the
21146 scheduling parameters set by @option{-mtune}.
21148 @item -mcmodel=small
21149 @opindex mcmodel=small
21150 Generate PowerPC64 code for the small model: The TOC is limited to
21151 64k.
21153 @item -mcmodel=medium
21154 @opindex mcmodel=medium
21155 Generate PowerPC64 code for the medium model: The TOC and other static
21156 data may be up to a total of 4G in size.
21158 @item -mcmodel=large
21159 @opindex mcmodel=large
21160 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21161 in size.  Other data and code is only limited by the 64-bit address
21162 space.
21164 @item -maltivec
21165 @itemx -mno-altivec
21166 @opindex maltivec
21167 @opindex mno-altivec
21168 Generate code that uses (does not use) AltiVec instructions, and also
21169 enable the use of built-in functions that allow more direct access to
21170 the AltiVec instruction set.  You may also need to set
21171 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21172 enhancements.
21174 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21175 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21176 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21177 match array element order corresponding to the endianness of the
21178 target.  That is, element zero identifies the leftmost element in a
21179 vector register when targeting a big-endian platform, and identifies
21180 the rightmost element in a vector register when targeting a
21181 little-endian platform.
21183 @item -maltivec=be
21184 @opindex maltivec=be
21185 Generate AltiVec instructions using big-endian element order,
21186 regardless of whether the target is big- or little-endian.  This is
21187 the default when targeting a big-endian platform.
21189 The element order is used to interpret element numbers in AltiVec
21190 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21191 @code{vec_insert}.  By default, these match array element order
21192 corresponding to the endianness for the target.
21194 @item -maltivec=le
21195 @opindex maltivec=le
21196 Generate AltiVec instructions using little-endian element order,
21197 regardless of whether the target is big- or little-endian.  This is
21198 the default when targeting a little-endian platform.  This option is
21199 currently ignored when targeting a big-endian platform.
21201 The element order is used to interpret element numbers in AltiVec
21202 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21203 @code{vec_insert}.  By default, these match array element order
21204 corresponding to the endianness for the target.
21206 @item -mvrsave
21207 @itemx -mno-vrsave
21208 @opindex mvrsave
21209 @opindex mno-vrsave
21210 Generate VRSAVE instructions when generating AltiVec code.
21212 @item -mgen-cell-microcode
21213 @opindex mgen-cell-microcode
21214 Generate Cell microcode instructions.
21216 @item -mwarn-cell-microcode
21217 @opindex mwarn-cell-microcode
21218 Warn when a Cell microcode instruction is emitted.  An example
21219 of a Cell microcode instruction is a variable shift.
21221 @item -msecure-plt
21222 @opindex msecure-plt
21223 Generate code that allows @command{ld} and @command{ld.so}
21224 to build executables and shared
21225 libraries with non-executable @code{.plt} and @code{.got} sections.
21226 This is a PowerPC
21227 32-bit SYSV ABI option.
21229 @item -mbss-plt
21230 @opindex mbss-plt
21231 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21232 fills in, and
21233 requires @code{.plt} and @code{.got}
21234 sections that are both writable and executable.
21235 This is a PowerPC 32-bit SYSV ABI option.
21237 @item -misel
21238 @itemx -mno-isel
21239 @opindex misel
21240 @opindex mno-isel
21241 This switch enables or disables the generation of ISEL instructions.
21243 @item -misel=@var{yes/no}
21244 This switch has been deprecated.  Use @option{-misel} and
21245 @option{-mno-isel} instead.
21247 @item -mlra
21248 @opindex mlra
21249 Enable Local Register Allocation. By default the port uses LRA.
21250 (i.e. @option{-mno-lra}).
21252 @item -mspe
21253 @itemx -mno-spe
21254 @opindex mspe
21255 @opindex mno-spe
21256 This switch enables or disables the generation of SPE simd
21257 instructions.
21259 @item -mpaired
21260 @itemx -mno-paired
21261 @opindex mpaired
21262 @opindex mno-paired
21263 This switch enables or disables the generation of PAIRED simd
21264 instructions.
21266 @item -mspe=@var{yes/no}
21267 This option has been deprecated.  Use @option{-mspe} and
21268 @option{-mno-spe} instead.
21270 @item -mvsx
21271 @itemx -mno-vsx
21272 @opindex mvsx
21273 @opindex mno-vsx
21274 Generate code that uses (does not use) vector/scalar (VSX)
21275 instructions, and also enable the use of built-in functions that allow
21276 more direct access to the VSX instruction set.
21278 @item -mcrypto
21279 @itemx -mno-crypto
21280 @opindex mcrypto
21281 @opindex mno-crypto
21282 Enable the use (disable) of the built-in functions that allow direct
21283 access to the cryptographic instructions that were added in version
21284 2.07 of the PowerPC ISA.
21286 @item -mdirect-move
21287 @itemx -mno-direct-move
21288 @opindex mdirect-move
21289 @opindex mno-direct-move
21290 Generate code that uses (does not use) the instructions to move data
21291 between the general purpose registers and the vector/scalar (VSX)
21292 registers that were added in version 2.07 of the PowerPC ISA.
21294 @item -mhtm
21295 @itemx -mno-htm
21296 @opindex mhtm
21297 @opindex mno-htm
21298 Enable (disable) the use of the built-in functions that allow direct
21299 access to the Hardware Transactional Memory (HTM) instructions that
21300 were added in version 2.07 of the PowerPC ISA.
21302 @item -mpower8-fusion
21303 @itemx -mno-power8-fusion
21304 @opindex mpower8-fusion
21305 @opindex mno-power8-fusion
21306 Generate code that keeps (does not keeps) some integer operations
21307 adjacent so that the instructions can be fused together on power8 and
21308 later processors.
21310 @item -mpower8-vector
21311 @itemx -mno-power8-vector
21312 @opindex mpower8-vector
21313 @opindex mno-power8-vector
21314 Generate code that uses (does not use) the vector and scalar
21315 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21316 enable the use of built-in functions that allow more direct access to
21317 the vector instructions.
21319 @item -mquad-memory
21320 @itemx -mno-quad-memory
21321 @opindex mquad-memory
21322 @opindex mno-quad-memory
21323 Generate code that uses (does not use) the non-atomic quad word memory
21324 instructions.  The @option{-mquad-memory} option requires use of
21325 64-bit mode.
21327 @item -mquad-memory-atomic
21328 @itemx -mno-quad-memory-atomic
21329 @opindex mquad-memory-atomic
21330 @opindex mno-quad-memory-atomic
21331 Generate code that uses (does not use) the atomic quad word memory
21332 instructions.  The @option{-mquad-memory-atomic} option requires use of
21333 64-bit mode.
21335 @item -mupper-regs-di
21336 @itemx -mno-upper-regs-di
21337 @opindex mupper-regs-di
21338 @opindex mno-upper-regs-di
21339 Generate code that uses (does not use) the scalar instructions that
21340 target all 64 registers in the vector/scalar floating point register
21341 set that were added in version 2.06 of the PowerPC ISA when processing
21342 integers.  @option{-mupper-regs-di} is turned on by default if you use
21343 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21344 @option{-mcpu=power9}, or @option{-mvsx} options.
21346 @item -mupper-regs-df
21347 @itemx -mno-upper-regs-df
21348 @opindex mupper-regs-df
21349 @opindex mno-upper-regs-df
21350 Generate code that uses (does not use) the scalar double precision
21351 instructions that target all 64 registers in the vector/scalar
21352 floating point register set that were added in version 2.06 of the
21353 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21354 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21355 @option{-mcpu=power9}, or @option{-mvsx} options.
21357 @item -mupper-regs-sf
21358 @itemx -mno-upper-regs-sf
21359 @opindex mupper-regs-sf
21360 @opindex mno-upper-regs-sf
21361 Generate code that uses (does not use) the scalar single precision
21362 instructions that target all 64 registers in the vector/scalar
21363 floating point register set that were added in version 2.07 of the
21364 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21365 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21366 @option{-mcpu=power9} options.
21368 @item -mupper-regs
21369 @itemx -mno-upper-regs
21370 @opindex mupper-regs
21371 @opindex mno-upper-regs
21372 Generate code that uses (does not use) the scalar
21373 instructions that target all 64 registers in the vector/scalar
21374 floating point register set, depending on the model of the machine.
21376 If the @option{-mno-upper-regs} option is used, it turns off both
21377 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21379 @item -mfloat128
21380 @itemx -mno-float128
21381 @opindex mfloat128
21382 @opindex mno-float128
21383 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21384 and use either software emulation for IEEE 128-bit floating point or
21385 hardware instructions.
21387 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21388 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21389 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21390 Linux systems.
21392 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21393 @option{-mfloat128} option will also enable the generation of ISA 3.0
21394 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21395 floating point will be done with software emulation.
21397 @item -mfloat128-hardware
21398 @itemx -mno-float128-hardware
21399 @opindex mfloat128-hardware
21400 @opindex mno-float128-hardware
21401 Enable/disable using ISA 3.0 hardware instructions to support the
21402 @var{__float128} data type.
21404 If you use @option{-mfloat128-hardware}, it will enable the option
21405 @option{-mfloat128} as well.
21407 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21408 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21409 the IEEE 128-bit floating point support will not be enabled.
21411 @item -mfloat-gprs=@var{yes/single/double/no}
21412 @itemx -mfloat-gprs
21413 @opindex mfloat-gprs
21414 This switch enables or disables the generation of floating-point
21415 operations on the general-purpose registers for architectures that
21416 support it.
21418 The argument @samp{yes} or @samp{single} enables the use of
21419 single-precision floating-point operations.
21421 The argument @samp{double} enables the use of single and
21422 double-precision floating-point operations.
21424 The argument @samp{no} disables floating-point operations on the
21425 general-purpose registers.
21427 This option is currently only available on the MPC854x.
21429 @item -m32
21430 @itemx -m64
21431 @opindex m32
21432 @opindex m64
21433 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21434 targets (including GNU/Linux).  The 32-bit environment sets int, long
21435 and pointer to 32 bits and generates code that runs on any PowerPC
21436 variant.  The 64-bit environment sets int to 32 bits and long and
21437 pointer to 64 bits, and generates code for PowerPC64, as for
21438 @option{-mpowerpc64}.
21440 @item -mfull-toc
21441 @itemx -mno-fp-in-toc
21442 @itemx -mno-sum-in-toc
21443 @itemx -mminimal-toc
21444 @opindex mfull-toc
21445 @opindex mno-fp-in-toc
21446 @opindex mno-sum-in-toc
21447 @opindex mminimal-toc
21448 Modify generation of the TOC (Table Of Contents), which is created for
21449 every executable file.  The @option{-mfull-toc} option is selected by
21450 default.  In that case, GCC allocates at least one TOC entry for
21451 each unique non-automatic variable reference in your program.  GCC
21452 also places floating-point constants in the TOC@.  However, only
21453 16,384 entries are available in the TOC@.
21455 If you receive a linker error message that saying you have overflowed
21456 the available TOC space, you can reduce the amount of TOC space used
21457 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21458 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21459 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21460 generate code to calculate the sum of an address and a constant at
21461 run time instead of putting that sum into the TOC@.  You may specify one
21462 or both of these options.  Each causes GCC to produce very slightly
21463 slower and larger code at the expense of conserving TOC space.
21465 If you still run out of space in the TOC even when you specify both of
21466 these options, specify @option{-mminimal-toc} instead.  This option causes
21467 GCC to make only one TOC entry for every file.  When you specify this
21468 option, GCC produces code that is slower and larger but which
21469 uses extremely little TOC space.  You may wish to use this option
21470 only on files that contain less frequently-executed code.
21472 @item -maix64
21473 @itemx -maix32
21474 @opindex maix64
21475 @opindex maix32
21476 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21477 @code{long} type, and the infrastructure needed to support them.
21478 Specifying @option{-maix64} implies @option{-mpowerpc64},
21479 while @option{-maix32} disables the 64-bit ABI and
21480 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21482 @item -mxl-compat
21483 @itemx -mno-xl-compat
21484 @opindex mxl-compat
21485 @opindex mno-xl-compat
21486 Produce code that conforms more closely to IBM XL compiler semantics
21487 when using AIX-compatible ABI@.  Pass floating-point arguments to
21488 prototyped functions beyond the register save area (RSA) on the stack
21489 in addition to argument FPRs.  Do not assume that most significant
21490 double in 128-bit long double value is properly rounded when comparing
21491 values and converting to double.  Use XL symbol names for long double
21492 support routines.
21494 The AIX calling convention was extended but not initially documented to
21495 handle an obscure K&R C case of calling a function that takes the
21496 address of its arguments with fewer arguments than declared.  IBM XL
21497 compilers access floating-point arguments that do not fit in the
21498 RSA from the stack when a subroutine is compiled without
21499 optimization.  Because always storing floating-point arguments on the
21500 stack is inefficient and rarely needed, this option is not enabled by
21501 default and only is necessary when calling subroutines compiled by IBM
21502 XL compilers without optimization.
21504 @item -mpe
21505 @opindex mpe
21506 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21507 application written to use message passing with special startup code to
21508 enable the application to run.  The system must have PE installed in the
21509 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21510 must be overridden with the @option{-specs=} option to specify the
21511 appropriate directory location.  The Parallel Environment does not
21512 support threads, so the @option{-mpe} option and the @option{-pthread}
21513 option are incompatible.
21515 @item -malign-natural
21516 @itemx -malign-power
21517 @opindex malign-natural
21518 @opindex malign-power
21519 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
21520 @option{-malign-natural} overrides the ABI-defined alignment of larger
21521 types, such as floating-point doubles, on their natural size-based boundary.
21522 The option @option{-malign-power} instructs GCC to follow the ABI-specified
21523 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
21525 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
21526 is not supported.
21528 @item -msoft-float
21529 @itemx -mhard-float
21530 @opindex msoft-float
21531 @opindex mhard-float
21532 Generate code that does not use (uses) the floating-point register set.
21533 Software floating-point emulation is provided if you use the
21534 @option{-msoft-float} option, and pass the option to GCC when linking.
21536 @item -msingle-float
21537 @itemx -mdouble-float
21538 @opindex msingle-float
21539 @opindex mdouble-float
21540 Generate code for single- or double-precision floating-point operations.
21541 @option{-mdouble-float} implies @option{-msingle-float}.
21543 @item -msimple-fpu
21544 @opindex msimple-fpu
21545 Do not generate @code{sqrt} and @code{div} instructions for hardware
21546 floating-point unit.
21548 @item -mfpu=@var{name}
21549 @opindex mfpu
21550 Specify type of floating-point unit.  Valid values for @var{name} are
21551 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
21552 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
21553 @samp{sp_full} (equivalent to @option{-msingle-float}),
21554 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
21556 @item -mxilinx-fpu
21557 @opindex mxilinx-fpu
21558 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
21560 @item -mmultiple
21561 @itemx -mno-multiple
21562 @opindex mmultiple
21563 @opindex mno-multiple
21564 Generate code that uses (does not use) the load multiple word
21565 instructions and the store multiple word instructions.  These
21566 instructions are generated by default on POWER systems, and not
21567 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
21568 PowerPC systems, since those instructions do not work when the
21569 processor is in little-endian mode.  The exceptions are PPC740 and
21570 PPC750 which permit these instructions in little-endian mode.
21572 @item -mstring
21573 @itemx -mno-string
21574 @opindex mstring
21575 @opindex mno-string
21576 Generate code that uses (does not use) the load string instructions
21577 and the store string word instructions to save multiple registers and
21578 do small block moves.  These instructions are generated by default on
21579 POWER systems, and not generated on PowerPC systems.  Do not use
21580 @option{-mstring} on little-endian PowerPC systems, since those
21581 instructions do not work when the processor is in little-endian mode.
21582 The exceptions are PPC740 and PPC750 which permit these instructions
21583 in little-endian mode.
21585 @item -mupdate
21586 @itemx -mno-update
21587 @opindex mupdate
21588 @opindex mno-update
21589 Generate code that uses (does not use) the load or store instructions
21590 that update the base register to the address of the calculated memory
21591 location.  These instructions are generated by default.  If you use
21592 @option{-mno-update}, there is a small window between the time that the
21593 stack pointer is updated and the address of the previous frame is
21594 stored, which means code that walks the stack frame across interrupts or
21595 signals may get corrupted data.
21597 @item -mavoid-indexed-addresses
21598 @itemx -mno-avoid-indexed-addresses
21599 @opindex mavoid-indexed-addresses
21600 @opindex mno-avoid-indexed-addresses
21601 Generate code that tries to avoid (not avoid) the use of indexed load
21602 or store instructions. These instructions can incur a performance
21603 penalty on Power6 processors in certain situations, such as when
21604 stepping through large arrays that cross a 16M boundary.  This option
21605 is enabled by default when targeting Power6 and disabled otherwise.
21607 @item -mfused-madd
21608 @itemx -mno-fused-madd
21609 @opindex mfused-madd
21610 @opindex mno-fused-madd
21611 Generate code that uses (does not use) the floating-point multiply and
21612 accumulate instructions.  These instructions are generated by default
21613 if hardware floating point is used.  The machine-dependent
21614 @option{-mfused-madd} option is now mapped to the machine-independent
21615 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21616 mapped to @option{-ffp-contract=off}.
21618 @item -mmulhw
21619 @itemx -mno-mulhw
21620 @opindex mmulhw
21621 @opindex mno-mulhw
21622 Generate code that uses (does not use) the half-word multiply and
21623 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
21624 These instructions are generated by default when targeting those
21625 processors.
21627 @item -mdlmzb
21628 @itemx -mno-dlmzb
21629 @opindex mdlmzb
21630 @opindex mno-dlmzb
21631 Generate code that uses (does not use) the string-search @samp{dlmzb}
21632 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
21633 generated by default when targeting those processors.
21635 @item -mno-bit-align
21636 @itemx -mbit-align
21637 @opindex mno-bit-align
21638 @opindex mbit-align
21639 On System V.4 and embedded PowerPC systems do not (do) force structures
21640 and unions that contain bit-fields to be aligned to the base type of the
21641 bit-field.
21643 For example, by default a structure containing nothing but 8
21644 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
21645 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
21646 the structure is aligned to a 1-byte boundary and is 1 byte in
21647 size.
21649 @item -mno-strict-align
21650 @itemx -mstrict-align
21651 @opindex mno-strict-align
21652 @opindex mstrict-align
21653 On System V.4 and embedded PowerPC systems do not (do) assume that
21654 unaligned memory references are handled by the system.
21656 @item -mrelocatable
21657 @itemx -mno-relocatable
21658 @opindex mrelocatable
21659 @opindex mno-relocatable
21660 Generate code that allows (does not allow) a static executable to be
21661 relocated to a different address at run time.  A simple embedded
21662 PowerPC system loader should relocate the entire contents of
21663 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
21664 a table of 32-bit addresses generated by this option.  For this to
21665 work, all objects linked together must be compiled with
21666 @option{-mrelocatable} or @option{-mrelocatable-lib}.
21667 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
21669 @item -mrelocatable-lib
21670 @itemx -mno-relocatable-lib
21671 @opindex mrelocatable-lib
21672 @opindex mno-relocatable-lib
21673 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
21674 @code{.fixup} section to allow static executables to be relocated at
21675 run time, but @option{-mrelocatable-lib} does not use the smaller stack
21676 alignment of @option{-mrelocatable}.  Objects compiled with
21677 @option{-mrelocatable-lib} may be linked with objects compiled with
21678 any combination of the @option{-mrelocatable} options.
21680 @item -mno-toc
21681 @itemx -mtoc
21682 @opindex mno-toc
21683 @opindex mtoc
21684 On System V.4 and embedded PowerPC systems do not (do) assume that
21685 register 2 contains a pointer to a global area pointing to the addresses
21686 used in the program.
21688 @item -mlittle
21689 @itemx -mlittle-endian
21690 @opindex mlittle
21691 @opindex mlittle-endian
21692 On System V.4 and embedded PowerPC systems compile code for the
21693 processor in little-endian mode.  The @option{-mlittle-endian} option is
21694 the same as @option{-mlittle}.
21696 @item -mbig
21697 @itemx -mbig-endian
21698 @opindex mbig
21699 @opindex mbig-endian
21700 On System V.4 and embedded PowerPC systems compile code for the
21701 processor in big-endian mode.  The @option{-mbig-endian} option is
21702 the same as @option{-mbig}.
21704 @item -mdynamic-no-pic
21705 @opindex mdynamic-no-pic
21706 On Darwin and Mac OS X systems, compile code so that it is not
21707 relocatable, but that its external references are relocatable.  The
21708 resulting code is suitable for applications, but not shared
21709 libraries.
21711 @item -msingle-pic-base
21712 @opindex msingle-pic-base
21713 Treat the register used for PIC addressing as read-only, rather than
21714 loading it in the prologue for each function.  The runtime system is
21715 responsible for initializing this register with an appropriate value
21716 before execution begins.
21718 @item -mprioritize-restricted-insns=@var{priority}
21719 @opindex mprioritize-restricted-insns
21720 This option controls the priority that is assigned to
21721 dispatch-slot restricted instructions during the second scheduling
21722 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
21723 or @samp{2} to assign no, highest, or second-highest (respectively) 
21724 priority to dispatch-slot restricted
21725 instructions.
21727 @item -msched-costly-dep=@var{dependence_type}
21728 @opindex msched-costly-dep
21729 This option controls which dependences are considered costly
21730 by the target during instruction scheduling.  The argument
21731 @var{dependence_type} takes one of the following values:
21733 @table @asis
21734 @item @samp{no}
21735 No dependence is costly.
21737 @item @samp{all}
21738 All dependences are costly.
21740 @item @samp{true_store_to_load}
21741 A true dependence from store to load is costly.
21743 @item @samp{store_to_load}
21744 Any dependence from store to load is costly.
21746 @item @var{number}
21747 Any dependence for which the latency is greater than or equal to 
21748 @var{number} is costly.
21749 @end table
21751 @item -minsert-sched-nops=@var{scheme}
21752 @opindex minsert-sched-nops
21753 This option controls which NOP insertion scheme is used during
21754 the second scheduling pass.  The argument @var{scheme} takes one of the
21755 following values:
21757 @table @asis
21758 @item @samp{no}
21759 Don't insert NOPs.
21761 @item @samp{pad}
21762 Pad with NOPs any dispatch group that has vacant issue slots,
21763 according to the scheduler's grouping.
21765 @item @samp{regroup_exact}
21766 Insert NOPs to force costly dependent insns into
21767 separate groups.  Insert exactly as many NOPs as needed to force an insn
21768 to a new group, according to the estimated processor grouping.
21770 @item @var{number}
21771 Insert NOPs to force costly dependent insns into
21772 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
21773 @end table
21775 @item -mcall-sysv
21776 @opindex mcall-sysv
21777 On System V.4 and embedded PowerPC systems compile code using calling
21778 conventions that adhere to the March 1995 draft of the System V
21779 Application Binary Interface, PowerPC processor supplement.  This is the
21780 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
21782 @item -mcall-sysv-eabi
21783 @itemx -mcall-eabi
21784 @opindex mcall-sysv-eabi
21785 @opindex mcall-eabi
21786 Specify both @option{-mcall-sysv} and @option{-meabi} options.
21788 @item -mcall-sysv-noeabi
21789 @opindex mcall-sysv-noeabi
21790 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
21792 @item -mcall-aixdesc
21793 @opindex m
21794 On System V.4 and embedded PowerPC systems compile code for the AIX
21795 operating system.
21797 @item -mcall-linux
21798 @opindex mcall-linux
21799 On System V.4 and embedded PowerPC systems compile code for the
21800 Linux-based GNU system.
21802 @item -mcall-freebsd
21803 @opindex mcall-freebsd
21804 On System V.4 and embedded PowerPC systems compile code for the
21805 FreeBSD operating system.
21807 @item -mcall-netbsd
21808 @opindex mcall-netbsd
21809 On System V.4 and embedded PowerPC systems compile code for the
21810 NetBSD operating system.
21812 @item -mcall-openbsd
21813 @opindex mcall-netbsd
21814 On System V.4 and embedded PowerPC systems compile code for the
21815 OpenBSD operating system.
21817 @item -maix-struct-return
21818 @opindex maix-struct-return
21819 Return all structures in memory (as specified by the AIX ABI)@.
21821 @item -msvr4-struct-return
21822 @opindex msvr4-struct-return
21823 Return structures smaller than 8 bytes in registers (as specified by the
21824 SVR4 ABI)@.
21826 @item -mabi=@var{abi-type}
21827 @opindex mabi
21828 Extend the current ABI with a particular extension, or remove such extension.
21829 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
21830 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
21831 @samp{elfv1}, @samp{elfv2}@.
21833 @item -mabi=spe
21834 @opindex mabi=spe
21835 Extend the current ABI with SPE ABI extensions.  This does not change
21836 the default ABI, instead it adds the SPE ABI extensions to the current
21837 ABI@.
21839 @item -mabi=no-spe
21840 @opindex mabi=no-spe
21841 Disable Book-E SPE ABI extensions for the current ABI@.
21843 @item -mabi=ibmlongdouble
21844 @opindex mabi=ibmlongdouble
21845 Change the current ABI to use IBM extended-precision long double.
21846 This is a PowerPC 32-bit SYSV ABI option.
21848 @item -mabi=ieeelongdouble
21849 @opindex mabi=ieeelongdouble
21850 Change the current ABI to use IEEE extended-precision long double.
21851 This is a PowerPC 32-bit Linux ABI option.
21853 @item -mabi=elfv1
21854 @opindex mabi=elfv1
21855 Change the current ABI to use the ELFv1 ABI.
21856 This is the default ABI for big-endian PowerPC 64-bit Linux.
21857 Overriding the default ABI requires special system support and is
21858 likely to fail in spectacular ways.
21860 @item -mabi=elfv2
21861 @opindex mabi=elfv2
21862 Change the current ABI to use the ELFv2 ABI.
21863 This is the default ABI for little-endian PowerPC 64-bit Linux.
21864 Overriding the default ABI requires special system support and is
21865 likely to fail in spectacular ways.
21867 @item -mgnu-attribute
21868 @itemx -mno-gnu-attribute
21869 @opindex mgnu-attribute
21870 @opindex mno-gnu-attribute
21871 Emit .gnu_attribute assembly directives to set tag/value pairs in a
21872 .gnu.attributes section that specify ABI variations in function
21873 parameters or return values.
21875 @item -mprototype
21876 @itemx -mno-prototype
21877 @opindex mprototype
21878 @opindex mno-prototype
21879 On System V.4 and embedded PowerPC systems assume that all calls to
21880 variable argument functions are properly prototyped.  Otherwise, the
21881 compiler must insert an instruction before every non-prototyped call to
21882 set or clear bit 6 of the condition code register (@code{CR}) to
21883 indicate whether floating-point values are passed in the floating-point
21884 registers in case the function takes variable arguments.  With
21885 @option{-mprototype}, only calls to prototyped variable argument functions
21886 set or clear the bit.
21888 @item -msim
21889 @opindex msim
21890 On embedded PowerPC systems, assume that the startup module is called
21891 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
21892 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
21893 configurations.
21895 @item -mmvme
21896 @opindex mmvme
21897 On embedded PowerPC systems, assume that the startup module is called
21898 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
21899 @file{libc.a}.
21901 @item -mads
21902 @opindex mads
21903 On embedded PowerPC systems, assume that the startup module is called
21904 @file{crt0.o} and the standard C libraries are @file{libads.a} and
21905 @file{libc.a}.
21907 @item -myellowknife
21908 @opindex myellowknife
21909 On embedded PowerPC systems, assume that the startup module is called
21910 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
21911 @file{libc.a}.
21913 @item -mvxworks
21914 @opindex mvxworks
21915 On System V.4 and embedded PowerPC systems, specify that you are
21916 compiling for a VxWorks system.
21918 @item -memb
21919 @opindex memb
21920 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
21921 header to indicate that @samp{eabi} extended relocations are used.
21923 @item -meabi
21924 @itemx -mno-eabi
21925 @opindex meabi
21926 @opindex mno-eabi
21927 On System V.4 and embedded PowerPC systems do (do not) adhere to the
21928 Embedded Applications Binary Interface (EABI), which is a set of
21929 modifications to the System V.4 specifications.  Selecting @option{-meabi}
21930 means that the stack is aligned to an 8-byte boundary, a function
21931 @code{__eabi} is called from @code{main} to set up the EABI
21932 environment, and the @option{-msdata} option can use both @code{r2} and
21933 @code{r13} to point to two separate small data areas.  Selecting
21934 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
21935 no EABI initialization function is called from @code{main}, and the
21936 @option{-msdata} option only uses @code{r13} to point to a single
21937 small data area.  The @option{-meabi} option is on by default if you
21938 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
21940 @item -msdata=eabi
21941 @opindex msdata=eabi
21942 On System V.4 and embedded PowerPC systems, put small initialized
21943 @code{const} global and static data in the @code{.sdata2} section, which
21944 is pointed to by register @code{r2}.  Put small initialized
21945 non-@code{const} global and static data in the @code{.sdata} section,
21946 which is pointed to by register @code{r13}.  Put small uninitialized
21947 global and static data in the @code{.sbss} section, which is adjacent to
21948 the @code{.sdata} section.  The @option{-msdata=eabi} option is
21949 incompatible with the @option{-mrelocatable} option.  The
21950 @option{-msdata=eabi} option also sets the @option{-memb} option.
21952 @item -msdata=sysv
21953 @opindex msdata=sysv
21954 On System V.4 and embedded PowerPC systems, put small global and static
21955 data in the @code{.sdata} section, which is pointed to by register
21956 @code{r13}.  Put small uninitialized global and static data in the
21957 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
21958 The @option{-msdata=sysv} option is incompatible with the
21959 @option{-mrelocatable} option.
21961 @item -msdata=default
21962 @itemx -msdata
21963 @opindex msdata=default
21964 @opindex msdata
21965 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
21966 compile code the same as @option{-msdata=eabi}, otherwise compile code the
21967 same as @option{-msdata=sysv}.
21969 @item -msdata=data
21970 @opindex msdata=data
21971 On System V.4 and embedded PowerPC systems, put small global
21972 data in the @code{.sdata} section.  Put small uninitialized global
21973 data in the @code{.sbss} section.  Do not use register @code{r13}
21974 to address small data however.  This is the default behavior unless
21975 other @option{-msdata} options are used.
21977 @item -msdata=none
21978 @itemx -mno-sdata
21979 @opindex msdata=none
21980 @opindex mno-sdata
21981 On embedded PowerPC systems, put all initialized global and static data
21982 in the @code{.data} section, and all uninitialized data in the
21983 @code{.bss} section.
21985 @item -mblock-move-inline-limit=@var{num}
21986 @opindex mblock-move-inline-limit
21987 Inline all block moves (such as calls to @code{memcpy} or structure
21988 copies) less than or equal to @var{num} bytes.  The minimum value for
21989 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
21990 targets.  The default value is target-specific.
21992 @item -G @var{num}
21993 @opindex G
21994 @cindex smaller data references (PowerPC)
21995 @cindex .sdata/.sdata2 references (PowerPC)
21996 On embedded PowerPC systems, put global and static items less than or
21997 equal to @var{num} bytes into the small data or BSS sections instead of
21998 the normal data or BSS section.  By default, @var{num} is 8.  The
21999 @option{-G @var{num}} switch is also passed to the linker.
22000 All modules should be compiled with the same @option{-G @var{num}} value.
22002 @item -mregnames
22003 @itemx -mno-regnames
22004 @opindex mregnames
22005 @opindex mno-regnames
22006 On System V.4 and embedded PowerPC systems do (do not) emit register
22007 names in the assembly language output using symbolic forms.
22009 @item -mlongcall
22010 @itemx -mno-longcall
22011 @opindex mlongcall
22012 @opindex mno-longcall
22013 By default assume that all calls are far away so that a longer and more
22014 expensive calling sequence is required.  This is required for calls
22015 farther than 32 megabytes (33,554,432 bytes) from the current location.
22016 A short call is generated if the compiler knows
22017 the call cannot be that far away.  This setting can be overridden by
22018 the @code{shortcall} function attribute, or by @code{#pragma
22019 longcall(0)}.
22021 Some linkers are capable of detecting out-of-range calls and generating
22022 glue code on the fly.  On these systems, long calls are unnecessary and
22023 generate slower code.  As of this writing, the AIX linker can do this,
22024 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22025 to the GNU linker for 32-bit PowerPC systems as well.
22027 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22028 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22029 addresses represent the callee and the branch island.  The
22030 Darwin/PPC linker prefers the first address and generates a @code{bl
22031 callee} if the PPC @code{bl} instruction reaches the callee directly;
22032 otherwise, the linker generates @code{bl L42} to call the branch
22033 island.  The branch island is appended to the body of the
22034 calling function; it computes the full 32-bit address of the callee
22035 and jumps to it.
22037 On Mach-O (Darwin) systems, this option directs the compiler emit to
22038 the glue for every direct call, and the Darwin linker decides whether
22039 to use or discard it.
22041 In the future, GCC may ignore all longcall specifications
22042 when the linker is known to generate glue.
22044 @item -mtls-markers
22045 @itemx -mno-tls-markers
22046 @opindex mtls-markers
22047 @opindex mno-tls-markers
22048 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22049 specifying the function argument.  The relocation allows the linker to
22050 reliably associate function call with argument setup instructions for
22051 TLS optimization, which in turn allows GCC to better schedule the
22052 sequence.
22054 @item -mrecip
22055 @itemx -mno-recip
22056 @opindex mrecip
22057 This option enables use of the reciprocal estimate and
22058 reciprocal square root estimate instructions with additional
22059 Newton-Raphson steps to increase precision instead of doing a divide or
22060 square root and divide for floating-point arguments.  You should use
22061 the @option{-ffast-math} option when using @option{-mrecip} (or at
22062 least @option{-funsafe-math-optimizations},
22063 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22064 @option{-fno-trapping-math}).  Note that while the throughput of the
22065 sequence is generally higher than the throughput of the non-reciprocal
22066 instruction, the precision of the sequence can be decreased by up to 2
22067 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22068 roots.
22070 @item -mrecip=@var{opt}
22071 @opindex mrecip=opt
22072 This option controls which reciprocal estimate instructions
22073 may be used.  @var{opt} is a comma-separated list of options, which may
22074 be preceded by a @code{!} to invert the option:
22076 @table @samp
22078 @item all
22079 Enable all estimate instructions.
22081 @item default 
22082 Enable the default instructions, equivalent to @option{-mrecip}.
22084 @item none 
22085 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22087 @item div 
22088 Enable the reciprocal approximation instructions for both 
22089 single and double precision.
22091 @item divf 
22092 Enable the single-precision reciprocal approximation instructions.
22094 @item divd 
22095 Enable the double-precision reciprocal approximation instructions.
22097 @item rsqrt 
22098 Enable the reciprocal square root approximation instructions for both
22099 single and double precision.
22101 @item rsqrtf 
22102 Enable the single-precision reciprocal square root approximation instructions.
22104 @item rsqrtd 
22105 Enable the double-precision reciprocal square root approximation instructions.
22107 @end table
22109 So, for example, @option{-mrecip=all,!rsqrtd} enables
22110 all of the reciprocal estimate instructions, except for the
22111 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22112 which handle the double-precision reciprocal square root calculations.
22114 @item -mrecip-precision
22115 @itemx -mno-recip-precision
22116 @opindex mrecip-precision
22117 Assume (do not assume) that the reciprocal estimate instructions
22118 provide higher-precision estimates than is mandated by the PowerPC
22119 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22120 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22121 The double-precision square root estimate instructions are not generated by
22122 default on low-precision machines, since they do not provide an
22123 estimate that converges after three steps.
22125 @item -mveclibabi=@var{type}
22126 @opindex mveclibabi
22127 Specifies the ABI type to use for vectorizing intrinsics using an
22128 external library.  The only type supported at present is @samp{mass},
22129 which specifies to use IBM's Mathematical Acceleration Subsystem
22130 (MASS) libraries for vectorizing intrinsics using external libraries.
22131 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22132 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22133 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22134 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22135 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22136 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22137 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22138 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22139 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22140 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22141 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22142 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22143 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22144 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22145 for power7.  Both @option{-ftree-vectorize} and
22146 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22147 libraries must be specified at link time.
22149 @item -mfriz
22150 @itemx -mno-friz
22151 @opindex mfriz
22152 Generate (do not generate) the @code{friz} instruction when the
22153 @option{-funsafe-math-optimizations} option is used to optimize
22154 rounding of floating-point values to 64-bit integer and back to floating
22155 point.  The @code{friz} instruction does not return the same value if
22156 the floating-point number is too large to fit in an integer.
22158 @item -mpointers-to-nested-functions
22159 @itemx -mno-pointers-to-nested-functions
22160 @opindex mpointers-to-nested-functions
22161 Generate (do not generate) code to load up the static chain register
22162 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22163 systems where a function pointer points to a 3-word descriptor giving
22164 the function address, TOC value to be loaded in register @code{r2}, and
22165 static chain value to be loaded in register @code{r11}.  The
22166 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22167 call through pointers to nested functions or pointers
22168 to functions compiled in other languages that use the static chain if
22169 you use @option{-mno-pointers-to-nested-functions}.
22171 @item -msave-toc-indirect
22172 @itemx -mno-save-toc-indirect
22173 @opindex msave-toc-indirect
22174 Generate (do not generate) code to save the TOC value in the reserved
22175 stack location in the function prologue if the function calls through
22176 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22177 saved in the prologue, it is saved just before the call through the
22178 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22180 @item -mcompat-align-parm
22181 @itemx -mno-compat-align-parm
22182 @opindex mcompat-align-parm
22183 Generate (do not generate) code to pass structure parameters with a
22184 maximum alignment of 64 bits, for compatibility with older versions
22185 of GCC.
22187 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22188 structure parameter on a 128-bit boundary when that structure contained
22189 a member requiring 128-bit alignment.  This is corrected in more
22190 recent versions of GCC.  This option may be used to generate code
22191 that is compatible with functions compiled with older versions of
22192 GCC.
22194 The @option{-mno-compat-align-parm} option is the default.
22196 @item -mstack-protector-guard=@var{guard}
22197 @itemx -mstack-protector-guard-reg=@var{reg}
22198 @itemx -mstack-protector-guard-offset=@var{offset}
22199 @opindex mstack-protector-guard
22200 @opindex mstack-protector-guard-reg
22201 @opindex mstack-protector-guard-offset
22202 Generate stack protection code using canary at @var{guard}.  Supported
22203 locations are @samp{global} for global canary or @samp{tls} for per-thread
22204 canary in the TLS block (the default with GNU libc version 2.4 or later).
22206 With the latter choice the options
22207 @option{-mstack-protector-guard-reg=@var{reg}} and
22208 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22209 which register to use as base register for reading the canary, and from what
22210 offset from that base register. The default for those is as specified in the
22211 relevant ABI.
22212 @end table
22214 @node RX Options
22215 @subsection RX Options
22216 @cindex RX Options
22218 These command-line options are defined for RX targets:
22220 @table @gcctabopt
22221 @item -m64bit-doubles
22222 @itemx -m32bit-doubles
22223 @opindex m64bit-doubles
22224 @opindex m32bit-doubles
22225 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22226 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22227 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22228 works on 32-bit values, which is why the default is
22229 @option{-m32bit-doubles}.
22231 @item -fpu
22232 @itemx -nofpu
22233 @opindex fpu
22234 @opindex nofpu
22235 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22236 floating-point hardware.  The default is enabled for the RX600
22237 series and disabled for the RX200 series.
22239 Floating-point instructions are only generated for 32-bit floating-point 
22240 values, however, so the FPU hardware is not used for doubles if the
22241 @option{-m64bit-doubles} option is used.
22243 @emph{Note} If the @option{-fpu} option is enabled then
22244 @option{-funsafe-math-optimizations} is also enabled automatically.
22245 This is because the RX FPU instructions are themselves unsafe.
22247 @item -mcpu=@var{name}
22248 @opindex mcpu
22249 Selects the type of RX CPU to be targeted.  Currently three types are
22250 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22251 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22253 The only difference between @samp{RX600} and @samp{RX610} is that the
22254 @samp{RX610} does not support the @code{MVTIPL} instruction.
22256 The @samp{RX200} series does not have a hardware floating-point unit
22257 and so @option{-nofpu} is enabled by default when this type is
22258 selected.
22260 @item -mbig-endian-data
22261 @itemx -mlittle-endian-data
22262 @opindex mbig-endian-data
22263 @opindex mlittle-endian-data
22264 Store data (but not code) in the big-endian format.  The default is
22265 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22266 format.
22268 @item -msmall-data-limit=@var{N}
22269 @opindex msmall-data-limit
22270 Specifies the maximum size in bytes of global and static variables
22271 which can be placed into the small data area.  Using the small data
22272 area can lead to smaller and faster code, but the size of area is
22273 limited and it is up to the programmer to ensure that the area does
22274 not overflow.  Also when the small data area is used one of the RX's
22275 registers (usually @code{r13}) is reserved for use pointing to this
22276 area, so it is no longer available for use by the compiler.  This
22277 could result in slower and/or larger code if variables are pushed onto
22278 the stack instead of being held in this register.
22280 Note, common variables (variables that have not been initialized) and
22281 constants are not placed into the small data area as they are assigned
22282 to other sections in the output executable.
22284 The default value is zero, which disables this feature.  Note, this
22285 feature is not enabled by default with higher optimization levels
22286 (@option{-O2} etc) because of the potentially detrimental effects of
22287 reserving a register.  It is up to the programmer to experiment and
22288 discover whether this feature is of benefit to their program.  See the
22289 description of the @option{-mpid} option for a description of how the
22290 actual register to hold the small data area pointer is chosen.
22292 @item -msim
22293 @itemx -mno-sim
22294 @opindex msim
22295 @opindex mno-sim
22296 Use the simulator runtime.  The default is to use the libgloss
22297 board-specific runtime.
22299 @item -mas100-syntax
22300 @itemx -mno-as100-syntax
22301 @opindex mas100-syntax
22302 @opindex mno-as100-syntax
22303 When generating assembler output use a syntax that is compatible with
22304 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22305 assembler, but it has some restrictions so it is not generated by default.
22307 @item -mmax-constant-size=@var{N}
22308 @opindex mmax-constant-size
22309 Specifies the maximum size, in bytes, of a constant that can be used as
22310 an operand in a RX instruction.  Although the RX instruction set does
22311 allow constants of up to 4 bytes in length to be used in instructions,
22312 a longer value equates to a longer instruction.  Thus in some
22313 circumstances it can be beneficial to restrict the size of constants
22314 that are used in instructions.  Constants that are too big are instead
22315 placed into a constant pool and referenced via register indirection.
22317 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22318 or 4 means that constants of any size are allowed.
22320 @item -mrelax
22321 @opindex mrelax
22322 Enable linker relaxation.  Linker relaxation is a process whereby the
22323 linker attempts to reduce the size of a program by finding shorter
22324 versions of various instructions.  Disabled by default.
22326 @item -mint-register=@var{N}
22327 @opindex mint-register
22328 Specify the number of registers to reserve for fast interrupt handler
22329 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22330 means that register @code{r13} is reserved for the exclusive use
22331 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22332 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22333 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22334 A value of 0, the default, does not reserve any registers.
22336 @item -msave-acc-in-interrupts
22337 @opindex msave-acc-in-interrupts
22338 Specifies that interrupt handler functions should preserve the
22339 accumulator register.  This is only necessary if normal code might use
22340 the accumulator register, for example because it performs 64-bit
22341 multiplications.  The default is to ignore the accumulator as this
22342 makes the interrupt handlers faster.
22344 @item -mpid
22345 @itemx -mno-pid
22346 @opindex mpid
22347 @opindex mno-pid
22348 Enables the generation of position independent data.  When enabled any
22349 access to constant data is done via an offset from a base address
22350 held in a register.  This allows the location of constant data to be
22351 determined at run time without requiring the executable to be
22352 relocated, which is a benefit to embedded applications with tight
22353 memory constraints.  Data that can be modified is not affected by this
22354 option.
22356 Note, using this feature reserves a register, usually @code{r13}, for
22357 the constant data base address.  This can result in slower and/or
22358 larger code, especially in complicated functions.
22360 The actual register chosen to hold the constant data base address
22361 depends upon whether the @option{-msmall-data-limit} and/or the
22362 @option{-mint-register} command-line options are enabled.  Starting
22363 with register @code{r13} and proceeding downwards, registers are
22364 allocated first to satisfy the requirements of @option{-mint-register},
22365 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22366 is possible for the small data area register to be @code{r8} if both
22367 @option{-mint-register=4} and @option{-mpid} are specified on the
22368 command line.
22370 By default this feature is not enabled.  The default can be restored
22371 via the @option{-mno-pid} command-line option.
22373 @item -mno-warn-multiple-fast-interrupts
22374 @itemx -mwarn-multiple-fast-interrupts
22375 @opindex mno-warn-multiple-fast-interrupts
22376 @opindex mwarn-multiple-fast-interrupts
22377 Prevents GCC from issuing a warning message if it finds more than one
22378 fast interrupt handler when it is compiling a file.  The default is to
22379 issue a warning for each extra fast interrupt handler found, as the RX
22380 only supports one such interrupt.
22382 @item -mallow-string-insns
22383 @itemx -mno-allow-string-insns
22384 @opindex mallow-string-insns
22385 @opindex mno-allow-string-insns
22386 Enables or disables the use of the string manipulation instructions
22387 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22388 @code{SWHILE} and also the @code{RMPA} instruction.  These
22389 instructions may prefetch data, which is not safe to do if accessing
22390 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22391 for more information).
22393 The default is to allow these instructions, but it is not possible for
22394 GCC to reliably detect all circumstances where a string instruction
22395 might be used to access an I/O register, so their use cannot be
22396 disabled automatically.  Instead it is reliant upon the programmer to
22397 use the @option{-mno-allow-string-insns} option if their program
22398 accesses I/O space.
22400 When the instructions are enabled GCC defines the C preprocessor
22401 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22402 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22404 @item -mjsr
22405 @itemx -mno-jsr
22406 @opindex mjsr
22407 @opindex mno-jsr
22408 Use only (or not only) @code{JSR} instructions to access functions.
22409 This option can be used when code size exceeds the range of @code{BSR}
22410 instructions.  Note that @option{-mno-jsr} does not mean to not use
22411 @code{JSR} but instead means that any type of branch may be used.
22412 @end table
22414 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22415 has special significance to the RX port when used with the
22416 @code{interrupt} function attribute.  This attribute indicates a
22417 function intended to process fast interrupts.  GCC ensures
22418 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22419 and/or @code{r13} and only provided that the normal use of the
22420 corresponding registers have been restricted via the
22421 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22422 options.
22424 @node S/390 and zSeries Options
22425 @subsection S/390 and zSeries Options
22426 @cindex S/390 and zSeries Options
22428 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22430 @table @gcctabopt
22431 @item -mhard-float
22432 @itemx -msoft-float
22433 @opindex mhard-float
22434 @opindex msoft-float
22435 Use (do not use) the hardware floating-point instructions and registers
22436 for floating-point operations.  When @option{-msoft-float} is specified,
22437 functions in @file{libgcc.a} are used to perform floating-point
22438 operations.  When @option{-mhard-float} is specified, the compiler
22439 generates IEEE floating-point instructions.  This is the default.
22441 @item -mhard-dfp
22442 @itemx -mno-hard-dfp
22443 @opindex mhard-dfp
22444 @opindex mno-hard-dfp
22445 Use (do not use) the hardware decimal-floating-point instructions for
22446 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22447 specified, functions in @file{libgcc.a} are used to perform
22448 decimal-floating-point operations.  When @option{-mhard-dfp} is
22449 specified, the compiler generates decimal-floating-point hardware
22450 instructions.  This is the default for @option{-march=z9-ec} or higher.
22452 @item -mlong-double-64
22453 @itemx -mlong-double-128
22454 @opindex mlong-double-64
22455 @opindex mlong-double-128
22456 These switches control the size of @code{long double} type. A size
22457 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22458 type. This is the default.
22460 @item -mbackchain
22461 @itemx -mno-backchain
22462 @opindex mbackchain
22463 @opindex mno-backchain
22464 Store (do not store) the address of the caller's frame as backchain pointer
22465 into the callee's stack frame.
22466 A backchain may be needed to allow debugging using tools that do not understand
22467 DWARF call frame information.
22468 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22469 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22470 the backchain is placed into the topmost word of the 96/160 byte register
22471 save area.
22473 In general, code compiled with @option{-mbackchain} is call-compatible with
22474 code compiled with @option{-mmo-backchain}; however, use of the backchain
22475 for debugging purposes usually requires that the whole binary is built with
22476 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22477 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22478 to build a linux kernel use @option{-msoft-float}.
22480 The default is to not maintain the backchain.
22482 @item -mpacked-stack
22483 @itemx -mno-packed-stack
22484 @opindex mpacked-stack
22485 @opindex mno-packed-stack
22486 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22487 specified, the compiler uses the all fields of the 96/160 byte register save
22488 area only for their default purpose; unused fields still take up stack space.
22489 When @option{-mpacked-stack} is specified, register save slots are densely
22490 packed at the top of the register save area; unused space is reused for other
22491 purposes, allowing for more efficient use of the available stack space.
22492 However, when @option{-mbackchain} is also in effect, the topmost word of
22493 the save area is always used to store the backchain, and the return address
22494 register is always saved two words below the backchain.
22496 As long as the stack frame backchain is not used, code generated with
22497 @option{-mpacked-stack} is call-compatible with code generated with
22498 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22499 S/390 or zSeries generated code that uses the stack frame backchain at run
22500 time, not just for debugging purposes.  Such code is not call-compatible
22501 with code compiled with @option{-mpacked-stack}.  Also, note that the
22502 combination of @option{-mbackchain},
22503 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22504 to build a linux kernel use @option{-msoft-float}.
22506 The default is to not use the packed stack layout.
22508 @item -msmall-exec
22509 @itemx -mno-small-exec
22510 @opindex msmall-exec
22511 @opindex mno-small-exec
22512 Generate (or do not generate) code using the @code{bras} instruction
22513 to do subroutine calls.
22514 This only works reliably if the total executable size does not
22515 exceed 64k.  The default is to use the @code{basr} instruction instead,
22516 which does not have this limitation.
22518 @item -m64
22519 @itemx -m31
22520 @opindex m64
22521 @opindex m31
22522 When @option{-m31} is specified, generate code compliant to the
22523 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
22524 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
22525 particular to generate 64-bit instructions.  For the @samp{s390}
22526 targets, the default is @option{-m31}, while the @samp{s390x}
22527 targets default to @option{-m64}.
22529 @item -mzarch
22530 @itemx -mesa
22531 @opindex mzarch
22532 @opindex mesa
22533 When @option{-mzarch} is specified, generate code using the
22534 instructions available on z/Architecture.
22535 When @option{-mesa} is specified, generate code using the
22536 instructions available on ESA/390.  Note that @option{-mesa} is
22537 not possible with @option{-m64}.
22538 When generating code compliant to the GNU/Linux for S/390 ABI,
22539 the default is @option{-mesa}.  When generating code compliant
22540 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
22542 @item -mhtm
22543 @itemx -mno-htm
22544 @opindex mhtm
22545 @opindex mno-htm
22546 The @option{-mhtm} option enables a set of builtins making use of
22547 instructions available with the transactional execution facility
22548 introduced with the IBM zEnterprise EC12 machine generation
22549 @ref{S/390 System z Built-in Functions}.
22550 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
22552 @item -mvx
22553 @itemx -mno-vx
22554 @opindex mvx
22555 @opindex mno-vx
22556 When @option{-mvx} is specified, generate code using the instructions
22557 available with the vector extension facility introduced with the IBM
22558 z13 machine generation.
22559 This option changes the ABI for some vector type values with regard to
22560 alignment and calling conventions.  In case vector type values are
22561 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
22562 command will be added to mark the resulting binary with the ABI used.
22563 @option{-mvx} is enabled by default when using @option{-march=z13}.
22565 @item -mzvector
22566 @itemx -mno-zvector
22567 @opindex mzvector
22568 @opindex mno-zvector
22569 The @option{-mzvector} option enables vector language extensions and
22570 builtins using instructions available with the vector extension
22571 facility introduced with the IBM z13 machine generation.
22572 This option adds support for @samp{vector} to be used as a keyword to
22573 define vector type variables and arguments.  @samp{vector} is only
22574 available when GNU extensions are enabled.  It will not be expanded
22575 when requesting strict standard compliance e.g. with @option{-std=c99}.
22576 In addition to the GCC low-level builtins @option{-mzvector} enables
22577 a set of builtins added for compatibility with AltiVec-style
22578 implementations like Power and Cell.  In order to make use of these
22579 builtins the header file @file{vecintrin.h} needs to be included.
22580 @option{-mzvector} is disabled by default.
22582 @item -mmvcle
22583 @itemx -mno-mvcle
22584 @opindex mmvcle
22585 @opindex mno-mvcle
22586 Generate (or do not generate) code using the @code{mvcle} instruction
22587 to perform block moves.  When @option{-mno-mvcle} is specified,
22588 use a @code{mvc} loop instead.  This is the default unless optimizing for
22589 size.
22591 @item -mdebug
22592 @itemx -mno-debug
22593 @opindex mdebug
22594 @opindex mno-debug
22595 Print (or do not print) additional debug information when compiling.
22596 The default is to not print debug information.
22598 @item -march=@var{cpu-type}
22599 @opindex march
22600 Generate code that runs on @var{cpu-type}, which is the name of a
22601 system representing a certain processor type.  Possible values for
22602 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
22603 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
22604 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
22605 @samp{native}.
22607 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
22608 @samp{g6} are deprecated and will be removed with future releases.
22610 Specifying @samp{native} as cpu type can be used to select the best
22611 architecture option for the host processor.
22612 @option{-march=native} has no effect if GCC does not recognize the
22613 processor.
22615 @item -mtune=@var{cpu-type}
22616 @opindex mtune
22617 Tune to @var{cpu-type} everything applicable about the generated code,
22618 except for the ABI and the set of available instructions.
22619 The list of @var{cpu-type} values is the same as for @option{-march}.
22620 The default is the value used for @option{-march}.
22622 @item -mtpf-trace
22623 @itemx -mno-tpf-trace
22624 @opindex mtpf-trace
22625 @opindex mno-tpf-trace
22626 Generate code that adds (does not add) in TPF OS specific branches to trace
22627 routines in the operating system.  This option is off by default, even
22628 when compiling for the TPF OS@.
22630 @item -mfused-madd
22631 @itemx -mno-fused-madd
22632 @opindex mfused-madd
22633 @opindex mno-fused-madd
22634 Generate code that uses (does not use) the floating-point multiply and
22635 accumulate instructions.  These instructions are generated by default if
22636 hardware floating point is used.
22638 @item -mwarn-framesize=@var{framesize}
22639 @opindex mwarn-framesize
22640 Emit a warning if the current function exceeds the given frame size.  Because
22641 this is a compile-time check it doesn't need to be a real problem when the program
22642 runs.  It is intended to identify functions that most probably cause
22643 a stack overflow.  It is useful to be used in an environment with limited stack
22644 size e.g.@: the linux kernel.
22646 @item -mwarn-dynamicstack
22647 @opindex mwarn-dynamicstack
22648 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
22649 arrays.  This is generally a bad idea with a limited stack size.
22651 @item -mstack-guard=@var{stack-guard}
22652 @itemx -mstack-size=@var{stack-size}
22653 @opindex mstack-guard
22654 @opindex mstack-size
22655 If these options are provided the S/390 back end emits additional instructions in
22656 the function prologue that trigger a trap if the stack size is @var{stack-guard}
22657 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
22658 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
22659 the frame size of the compiled function is chosen.
22660 These options are intended to be used to help debugging stack overflow problems.
22661 The additionally emitted code causes only little overhead and hence can also be
22662 used in production-like systems without greater performance degradation.  The given
22663 values have to be exact powers of 2 and @var{stack-size} has to be greater than
22664 @var{stack-guard} without exceeding 64k.
22665 In order to be efficient the extra code makes the assumption that the stack starts
22666 at an address aligned to the value given by @var{stack-size}.
22667 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
22669 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
22670 @opindex mhotpatch
22671 If the hotpatch option is enabled, a ``hot-patching'' function
22672 prologue is generated for all functions in the compilation unit.
22673 The funtion label is prepended with the given number of two-byte
22674 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
22675 the label, 2 * @var{post-halfwords} bytes are appended, using the
22676 largest NOP like instructions the architecture allows (maximum
22677 1000000).
22679 If both arguments are zero, hotpatching is disabled.
22681 This option can be overridden for individual functions with the
22682 @code{hotpatch} attribute.
22683 @end table
22685 @node Score Options
22686 @subsection Score Options
22687 @cindex Score Options
22689 These options are defined for Score implementations:
22691 @table @gcctabopt
22692 @item -meb
22693 @opindex meb
22694 Compile code for big-endian mode.  This is the default.
22696 @item -mel
22697 @opindex mel
22698 Compile code for little-endian mode.
22700 @item -mnhwloop
22701 @opindex mnhwloop
22702 Disable generation of @code{bcnz} instructions.
22704 @item -muls
22705 @opindex muls
22706 Enable generation of unaligned load and store instructions.
22708 @item -mmac
22709 @opindex mmac
22710 Enable the use of multiply-accumulate instructions. Disabled by default.
22712 @item -mscore5
22713 @opindex mscore5
22714 Specify the SCORE5 as the target architecture.
22716 @item -mscore5u
22717 @opindex mscore5u
22718 Specify the SCORE5U of the target architecture.
22720 @item -mscore7
22721 @opindex mscore7
22722 Specify the SCORE7 as the target architecture. This is the default.
22724 @item -mscore7d
22725 @opindex mscore7d
22726 Specify the SCORE7D as the target architecture.
22727 @end table
22729 @node SH Options
22730 @subsection SH Options
22732 These @samp{-m} options are defined for the SH implementations:
22734 @table @gcctabopt
22735 @item -m1
22736 @opindex m1
22737 Generate code for the SH1.
22739 @item -m2
22740 @opindex m2
22741 Generate code for the SH2.
22743 @item -m2e
22744 Generate code for the SH2e.
22746 @item -m2a-nofpu
22747 @opindex m2a-nofpu
22748 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
22749 that the floating-point unit is not used.
22751 @item -m2a-single-only
22752 @opindex m2a-single-only
22753 Generate code for the SH2a-FPU, in such a way that no double-precision
22754 floating-point operations are used.
22756 @item -m2a-single
22757 @opindex m2a-single
22758 Generate code for the SH2a-FPU assuming the floating-point unit is in
22759 single-precision mode by default.
22761 @item -m2a
22762 @opindex m2a
22763 Generate code for the SH2a-FPU assuming the floating-point unit is in
22764 double-precision mode by default.
22766 @item -m3
22767 @opindex m3
22768 Generate code for the SH3.
22770 @item -m3e
22771 @opindex m3e
22772 Generate code for the SH3e.
22774 @item -m4-nofpu
22775 @opindex m4-nofpu
22776 Generate code for the SH4 without a floating-point unit.
22778 @item -m4-single-only
22779 @opindex m4-single-only
22780 Generate code for the SH4 with a floating-point unit that only
22781 supports single-precision arithmetic.
22783 @item -m4-single
22784 @opindex m4-single
22785 Generate code for the SH4 assuming the floating-point unit is in
22786 single-precision mode by default.
22788 @item -m4
22789 @opindex m4
22790 Generate code for the SH4.
22792 @item -m4-100
22793 @opindex m4-100
22794 Generate code for SH4-100.
22796 @item -m4-100-nofpu
22797 @opindex m4-100-nofpu
22798 Generate code for SH4-100 in such a way that the
22799 floating-point unit is not used.
22801 @item -m4-100-single
22802 @opindex m4-100-single
22803 Generate code for SH4-100 assuming the floating-point unit is in
22804 single-precision mode by default.
22806 @item -m4-100-single-only
22807 @opindex m4-100-single-only
22808 Generate code for SH4-100 in such a way that no double-precision
22809 floating-point operations are used.
22811 @item -m4-200
22812 @opindex m4-200
22813 Generate code for SH4-200.
22815 @item -m4-200-nofpu
22816 @opindex m4-200-nofpu
22817 Generate code for SH4-200 without in such a way that the
22818 floating-point unit is not used.
22820 @item -m4-200-single
22821 @opindex m4-200-single
22822 Generate code for SH4-200 assuming the floating-point unit is in
22823 single-precision mode by default.
22825 @item -m4-200-single-only
22826 @opindex m4-200-single-only
22827 Generate code for SH4-200 in such a way that no double-precision
22828 floating-point operations are used.
22830 @item -m4-300
22831 @opindex m4-300
22832 Generate code for SH4-300.
22834 @item -m4-300-nofpu
22835 @opindex m4-300-nofpu
22836 Generate code for SH4-300 without in such a way that the
22837 floating-point unit is not used.
22839 @item -m4-300-single
22840 @opindex m4-300-single
22841 Generate code for SH4-300 in such a way that no double-precision
22842 floating-point operations are used.
22844 @item -m4-300-single-only
22845 @opindex m4-300-single-only
22846 Generate code for SH4-300 in such a way that no double-precision
22847 floating-point operations are used.
22849 @item -m4-340
22850 @opindex m4-340
22851 Generate code for SH4-340 (no MMU, no FPU).
22853 @item -m4-500
22854 @opindex m4-500
22855 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
22856 assembler.
22858 @item -m4a-nofpu
22859 @opindex m4a-nofpu
22860 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
22861 floating-point unit is not used.
22863 @item -m4a-single-only
22864 @opindex m4a-single-only
22865 Generate code for the SH4a, in such a way that no double-precision
22866 floating-point operations are used.
22868 @item -m4a-single
22869 @opindex m4a-single
22870 Generate code for the SH4a assuming the floating-point unit is in
22871 single-precision mode by default.
22873 @item -m4a
22874 @opindex m4a
22875 Generate code for the SH4a.
22877 @item -m4al
22878 @opindex m4al
22879 Same as @option{-m4a-nofpu}, except that it implicitly passes
22880 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
22881 instructions at the moment.
22883 @item -mb
22884 @opindex mb
22885 Compile code for the processor in big-endian mode.
22887 @item -ml
22888 @opindex ml
22889 Compile code for the processor in little-endian mode.
22891 @item -mdalign
22892 @opindex mdalign
22893 Align doubles at 64-bit boundaries.  Note that this changes the calling
22894 conventions, and thus some functions from the standard C library do
22895 not work unless you recompile it first with @option{-mdalign}.
22897 @item -mrelax
22898 @opindex mrelax
22899 Shorten some address references at link time, when possible; uses the
22900 linker option @option{-relax}.
22902 @item -mbigtable
22903 @opindex mbigtable
22904 Use 32-bit offsets in @code{switch} tables.  The default is to use
22905 16-bit offsets.
22907 @item -mbitops
22908 @opindex mbitops
22909 Enable the use of bit manipulation instructions on SH2A.
22911 @item -mfmovd
22912 @opindex mfmovd
22913 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
22914 alignment constraints.
22916 @item -mrenesas
22917 @opindex mrenesas
22918 Comply with the calling conventions defined by Renesas.
22920 @item -mno-renesas
22921 @opindex mno-renesas
22922 Comply with the calling conventions defined for GCC before the Renesas
22923 conventions were available.  This option is the default for all
22924 targets of the SH toolchain.
22926 @item -mnomacsave
22927 @opindex mnomacsave
22928 Mark the @code{MAC} register as call-clobbered, even if
22929 @option{-mrenesas} is given.
22931 @item -mieee
22932 @itemx -mno-ieee
22933 @opindex mieee
22934 @opindex mno-ieee
22935 Control the IEEE compliance of floating-point comparisons, which affects the
22936 handling of cases where the result of a comparison is unordered.  By default
22937 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
22938 enabled @option{-mno-ieee} is implicitly set, which results in faster
22939 floating-point greater-equal and less-equal comparisons.  The implicit settings
22940 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
22942 @item -minline-ic_invalidate
22943 @opindex minline-ic_invalidate
22944 Inline code to invalidate instruction cache entries after setting up
22945 nested function trampolines.
22946 This option has no effect if @option{-musermode} is in effect and the selected
22947 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
22948 instruction.
22949 If the selected code generation option does not allow the use of the @code{icbi}
22950 instruction, and @option{-musermode} is not in effect, the inlined code
22951 manipulates the instruction cache address array directly with an associative
22952 write.  This not only requires privileged mode at run time, but it also
22953 fails if the cache line had been mapped via the TLB and has become unmapped.
22955 @item -misize
22956 @opindex misize
22957 Dump instruction size and location in the assembly code.
22959 @item -mpadstruct
22960 @opindex mpadstruct
22961 This option is deprecated.  It pads structures to multiple of 4 bytes,
22962 which is incompatible with the SH ABI@.
22964 @item -matomic-model=@var{model}
22965 @opindex matomic-model=@var{model}
22966 Sets the model of atomic operations and additional parameters as a comma
22967 separated list.  For details on the atomic built-in functions see
22968 @ref{__atomic Builtins}.  The following models and parameters are supported:
22970 @table @samp
22972 @item none
22973 Disable compiler generated atomic sequences and emit library calls for atomic
22974 operations.  This is the default if the target is not @code{sh*-*-linux*}.
22976 @item soft-gusa
22977 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
22978 built-in functions.  The generated atomic sequences require additional support
22979 from the interrupt/exception handling code of the system and are only suitable
22980 for SH3* and SH4* single-core systems.  This option is enabled by default when
22981 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
22982 this option also partially utilizes the hardware atomic instructions
22983 @code{movli.l} and @code{movco.l} to create more efficient code, unless
22984 @samp{strict} is specified.  
22986 @item soft-tcb
22987 Generate software atomic sequences that use a variable in the thread control
22988 block.  This is a variation of the gUSA sequences which can also be used on
22989 SH1* and SH2* targets.  The generated atomic sequences require additional
22990 support from the interrupt/exception handling code of the system and are only
22991 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
22992 parameter has to be specified as well.
22994 @item soft-imask
22995 Generate software atomic sequences that temporarily disable interrupts by
22996 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
22997 in privileged mode and is only suitable for single-core systems.  Additional
22998 support from the interrupt/exception handling code of the system is not
22999 required.  This model is enabled by default when the target is
23000 @code{sh*-*-linux*} and SH1* or SH2*.
23002 @item hard-llcs
23003 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23004 instructions only.  This is only available on SH4A and is suitable for
23005 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23006 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23007 Code compiled with this option is also compatible with other software
23008 atomic model interrupt/exception handling systems if executed on an SH4A
23009 system.  Additional support from the interrupt/exception handling code of the
23010 system is not required for this model.
23012 @item gbr-offset=
23013 This parameter specifies the offset in bytes of the variable in the thread
23014 control block structure that should be used by the generated atomic sequences
23015 when the @samp{soft-tcb} model has been selected.  For other models this
23016 parameter is ignored.  The specified value must be an integer multiple of four
23017 and in the range 0-1020.
23019 @item strict
23020 This parameter prevents mixed usage of multiple atomic models, even if they
23021 are compatible, and makes the compiler generate atomic sequences of the
23022 specified model only.
23024 @end table
23026 @item -mtas
23027 @opindex mtas
23028 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23029 Notice that depending on the particular hardware and software configuration
23030 this can degrade overall performance due to the operand cache line flushes
23031 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23032 processors the @code{tas.b} instruction must be used with caution since it
23033 can result in data corruption for certain cache configurations.
23035 @item -mprefergot
23036 @opindex mprefergot
23037 When generating position-independent code, emit function calls using
23038 the Global Offset Table instead of the Procedure Linkage Table.
23040 @item -musermode
23041 @itemx -mno-usermode
23042 @opindex musermode
23043 @opindex mno-usermode
23044 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23045 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23046 inlined code would not work in user mode.  @option{-musermode} is the default
23047 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23048 @option{-musermode} has no effect, since there is no user mode.
23050 @item -multcost=@var{number}
23051 @opindex multcost=@var{number}
23052 Set the cost to assume for a multiply insn.
23054 @item -mdiv=@var{strategy}
23055 @opindex mdiv=@var{strategy}
23056 Set the division strategy to be used for integer division operations.
23057 @var{strategy} can be one of: 
23059 @table @samp
23061 @item call-div1
23062 Calls a library function that uses the single-step division instruction
23063 @code{div1} to perform the operation.  Division by zero calculates an
23064 unspecified result and does not trap.  This is the default except for SH4,
23065 SH2A and SHcompact.
23067 @item call-fp
23068 Calls a library function that performs the operation in double precision
23069 floating point.  Division by zero causes a floating-point exception.  This is
23070 the default for SHcompact with FPU.  Specifying this for targets that do not
23071 have a double precision FPU defaults to @code{call-div1}.
23073 @item call-table
23074 Calls a library function that uses a lookup table for small divisors and
23075 the @code{div1} instruction with case distinction for larger divisors.  Division
23076 by zero calculates an unspecified result and does not trap.  This is the default
23077 for SH4.  Specifying this for targets that do not have dynamic shift
23078 instructions defaults to @code{call-div1}.
23080 @end table
23082 When a division strategy has not been specified the default strategy is
23083 selected based on the current target.  For SH2A the default strategy is to
23084 use the @code{divs} and @code{divu} instructions instead of library function
23085 calls.
23087 @item -maccumulate-outgoing-args
23088 @opindex maccumulate-outgoing-args
23089 Reserve space once for outgoing arguments in the function prologue rather
23090 than around each call.  Generally beneficial for performance and size.  Also
23091 needed for unwinding to avoid changing the stack frame around conditional code.
23093 @item -mdivsi3_libfunc=@var{name}
23094 @opindex mdivsi3_libfunc=@var{name}
23095 Set the name of the library function used for 32-bit signed division to
23096 @var{name}.
23097 This only affects the name used in the @samp{call} division strategies, and
23098 the compiler still expects the same sets of input/output/clobbered registers as
23099 if this option were not present.
23101 @item -mfixed-range=@var{register-range}
23102 @opindex mfixed-range
23103 Generate code treating the given register range as fixed registers.
23104 A fixed register is one that the register allocator can not use.  This is
23105 useful when compiling kernel code.  A register range is specified as
23106 two registers separated by a dash.  Multiple register ranges can be
23107 specified separated by a comma.
23109 @item -mbranch-cost=@var{num}
23110 @opindex mbranch-cost=@var{num}
23111 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23112 make the compiler try to generate more branch-free code if possible.  
23113 If not specified the value is selected depending on the processor type that
23114 is being compiled for.
23116 @item -mzdcbranch
23117 @itemx -mno-zdcbranch
23118 @opindex mzdcbranch
23119 @opindex mno-zdcbranch
23120 Assume (do not assume) that zero displacement conditional branch instructions
23121 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23122 compiler prefers zero displacement branch code sequences.  This is
23123 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23124 disabled by specifying @option{-mno-zdcbranch}.
23126 @item -mcbranch-force-delay-slot
23127 @opindex mcbranch-force-delay-slot
23128 Force the usage of delay slots for conditional branches, which stuffs the delay
23129 slot with a @code{nop} if a suitable instruction can't be found.  By default
23130 this option is disabled.  It can be enabled to work around hardware bugs as
23131 found in the original SH7055.
23133 @item -mfused-madd
23134 @itemx -mno-fused-madd
23135 @opindex mfused-madd
23136 @opindex mno-fused-madd
23137 Generate code that uses (does not use) the floating-point multiply and
23138 accumulate instructions.  These instructions are generated by default
23139 if hardware floating point is used.  The machine-dependent
23140 @option{-mfused-madd} option is now mapped to the machine-independent
23141 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23142 mapped to @option{-ffp-contract=off}.
23144 @item -mfsca
23145 @itemx -mno-fsca
23146 @opindex mfsca
23147 @opindex mno-fsca
23148 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23149 and cosine approximations.  The option @option{-mfsca} must be used in
23150 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23151 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23152 approximations even if @option{-funsafe-math-optimizations} is in effect.
23154 @item -mfsrra
23155 @itemx -mno-fsrra
23156 @opindex mfsrra
23157 @opindex mno-fsrra
23158 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23159 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23160 in combination with @option{-funsafe-math-optimizations} and
23161 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23162 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23163 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23164 in effect.
23166 @item -mpretend-cmove
23167 @opindex mpretend-cmove
23168 Prefer zero-displacement conditional branches for conditional move instruction
23169 patterns.  This can result in faster code on the SH4 processor.
23171 @item -mfdpic
23172 @opindex fdpic
23173 Generate code using the FDPIC ABI.
23175 @end table
23177 @node Solaris 2 Options
23178 @subsection Solaris 2 Options
23179 @cindex Solaris 2 options
23181 These @samp{-m} options are supported on Solaris 2:
23183 @table @gcctabopt
23184 @item -mclear-hwcap
23185 @opindex mclear-hwcap
23186 @option{-mclear-hwcap} tells the compiler to remove the hardware
23187 capabilities generated by the Solaris assembler.  This is only necessary
23188 when object files use ISA extensions not supported by the current
23189 machine, but check at runtime whether or not to use them.
23191 @item -mimpure-text
23192 @opindex mimpure-text
23193 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23194 the compiler to not pass @option{-z text} to the linker when linking a
23195 shared object.  Using this option, you can link position-dependent
23196 code into a shared object.
23198 @option{-mimpure-text} suppresses the ``relocations remain against
23199 allocatable but non-writable sections'' linker error message.
23200 However, the necessary relocations trigger copy-on-write, and the
23201 shared object is not actually shared across processes.  Instead of
23202 using @option{-mimpure-text}, you should compile all source code with
23203 @option{-fpic} or @option{-fPIC}.
23205 @end table
23207 These switches are supported in addition to the above on Solaris 2:
23209 @table @gcctabopt
23210 @item -pthreads
23211 @opindex pthreads
23212 This is a synonym for @option{-pthread}.
23213 @end table
23215 @node SPARC Options
23216 @subsection SPARC Options
23217 @cindex SPARC options
23219 These @samp{-m} options are supported on the SPARC:
23221 @table @gcctabopt
23222 @item -mno-app-regs
23223 @itemx -mapp-regs
23224 @opindex mno-app-regs
23225 @opindex mapp-regs
23226 Specify @option{-mapp-regs} to generate output using the global registers
23227 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23228 global register 1, each global register 2 through 4 is then treated as an
23229 allocable register that is clobbered by function calls.  This is the default.
23231 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23232 specify @option{-mno-app-regs}.  You should compile libraries and system
23233 software with this option.
23235 @item -mflat
23236 @itemx -mno-flat
23237 @opindex mflat
23238 @opindex mno-flat
23239 With @option{-mflat}, the compiler does not generate save/restore instructions
23240 and uses a ``flat'' or single register window model.  This model is compatible
23241 with the regular register window model.  The local registers and the input
23242 registers (0--5) are still treated as ``call-saved'' registers and are
23243 saved on the stack as needed.
23245 With @option{-mno-flat} (the default), the compiler generates save/restore
23246 instructions (except for leaf functions).  This is the normal operating mode.
23248 @item -mfpu
23249 @itemx -mhard-float
23250 @opindex mfpu
23251 @opindex mhard-float
23252 Generate output containing floating-point instructions.  This is the
23253 default.
23255 @item -mno-fpu
23256 @itemx -msoft-float
23257 @opindex mno-fpu
23258 @opindex msoft-float
23259 Generate output containing library calls for floating point.
23260 @strong{Warning:} the requisite libraries are not available for all SPARC
23261 targets.  Normally the facilities of the machine's usual C compiler are
23262 used, but this cannot be done directly in cross-compilation.  You must make
23263 your own arrangements to provide suitable library functions for
23264 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23265 @samp{sparclite-*-*} do provide software floating-point support.
23267 @option{-msoft-float} changes the calling convention in the output file;
23268 therefore, it is only useful if you compile @emph{all} of a program with
23269 this option.  In particular, you need to compile @file{libgcc.a}, the
23270 library that comes with GCC, with @option{-msoft-float} in order for
23271 this to work.
23273 @item -mhard-quad-float
23274 @opindex mhard-quad-float
23275 Generate output containing quad-word (long double) floating-point
23276 instructions.
23278 @item -msoft-quad-float
23279 @opindex msoft-quad-float
23280 Generate output containing library calls for quad-word (long double)
23281 floating-point instructions.  The functions called are those specified
23282 in the SPARC ABI@.  This is the default.
23284 As of this writing, there are no SPARC implementations that have hardware
23285 support for the quad-word floating-point instructions.  They all invoke
23286 a trap handler for one of these instructions, and then the trap handler
23287 emulates the effect of the instruction.  Because of the trap handler overhead,
23288 this is much slower than calling the ABI library routines.  Thus the
23289 @option{-msoft-quad-float} option is the default.
23291 @item -mno-unaligned-doubles
23292 @itemx -munaligned-doubles
23293 @opindex mno-unaligned-doubles
23294 @opindex munaligned-doubles
23295 Assume that doubles have 8-byte alignment.  This is the default.
23297 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23298 alignment only if they are contained in another type, or if they have an
23299 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23300 Specifying this option avoids some rare compatibility problems with code
23301 generated by other compilers.  It is not the default because it results
23302 in a performance loss, especially for floating-point code.
23304 @item -muser-mode
23305 @itemx -mno-user-mode
23306 @opindex muser-mode
23307 @opindex mno-user-mode
23308 Do not generate code that can only run in supervisor mode.  This is relevant
23309 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23310 is the default.
23312 @item -mfaster-structs
23313 @itemx -mno-faster-structs
23314 @opindex mfaster-structs
23315 @opindex mno-faster-structs
23316 With @option{-mfaster-structs}, the compiler assumes that structures
23317 should have 8-byte alignment.  This enables the use of pairs of
23318 @code{ldd} and @code{std} instructions for copies in structure
23319 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23320 However, the use of this changed alignment directly violates the SPARC
23321 ABI@.  Thus, it's intended only for use on targets where the developer
23322 acknowledges that their resulting code is not directly in line with
23323 the rules of the ABI@.
23325 @item -mstd-struct-return
23326 @itemx -mno-std-struct-return
23327 @opindex mstd-struct-return
23328 @opindex mno-std-struct-return
23329 With @option{-mstd-struct-return}, the compiler generates checking code
23330 in functions returning structures or unions to detect size mismatches
23331 between the two sides of function calls, as per the 32-bit ABI@.
23333 The default is @option{-mno-std-struct-return}.  This option has no effect
23334 in 64-bit mode.
23336 @item -mlra
23337 @itemx -mno-lra
23338 @opindex mlra
23339 @opindex mno-lra
23340 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23341 so @option{-mno-lra} needs to be passed to get old Reload.
23343 @item -mcpu=@var{cpu_type}
23344 @opindex mcpu
23345 Set the instruction set, register set, and instruction scheduling parameters
23346 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23347 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23348 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23349 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23350 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23351 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23353 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23354 which selects the best architecture option for the host processor.
23355 @option{-mcpu=native} has no effect if GCC does not recognize
23356 the processor.
23358 Default instruction scheduling parameters are used for values that select
23359 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23360 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23362 Here is a list of each supported architecture and their supported
23363 implementations.
23365 @table @asis
23366 @item v7
23367 cypress, leon3v7
23369 @item v8
23370 supersparc, hypersparc, leon, leon3
23372 @item sparclite
23373 f930, f934, sparclite86x
23375 @item sparclet
23376 tsc701
23378 @item v9
23379 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23380 @end table
23382 By default (unless configured otherwise), GCC generates code for the V7
23383 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23384 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23385 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23386 SPARCStation 1, 2, IPX etc.
23388 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23389 architecture.  The only difference from V7 code is that the compiler emits
23390 the integer multiply and integer divide instructions which exist in SPARC-V8
23391 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23392 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23393 2000 series.
23395 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23396 the SPARC architecture.  This adds the integer multiply, integer divide step
23397 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23398 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23399 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23400 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23401 MB86934 chip, which is the more recent SPARClite with FPU@.
23403 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23404 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23405 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23406 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23407 optimizes it for the TEMIC SPARClet chip.
23409 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23410 architecture.  This adds 64-bit integer and floating-point move instructions,
23411 3 additional floating-point condition code registers and conditional move
23412 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23413 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23414 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23415 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23416 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23417 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23418 additionally optimizes it for Sun UltraSPARC T2 chips. With
23419 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23420 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23421 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23422 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23423 Oracle SPARC M7 chips.
23425 @item -mtune=@var{cpu_type}
23426 @opindex mtune
23427 Set the instruction scheduling parameters for machine type
23428 @var{cpu_type}, but do not set the instruction set or register set that the
23429 option @option{-mcpu=@var{cpu_type}} does.
23431 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23432 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23433 that select a particular CPU implementation.  Those are
23434 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23435 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23436 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23437 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23438 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23439 GNU/Linux toolchains, @samp{native} can also be used.
23441 @item -mv8plus
23442 @itemx -mno-v8plus
23443 @opindex mv8plus
23444 @opindex mno-v8plus
23445 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23446 difference from the V8 ABI is that the global and out registers are
23447 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23448 mode for all SPARC-V9 processors.
23450 @item -mvis
23451 @itemx -mno-vis
23452 @opindex mvis
23453 @opindex mno-vis
23454 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23455 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23457 @item -mvis2
23458 @itemx -mno-vis2
23459 @opindex mvis2
23460 @opindex mno-vis2
23461 With @option{-mvis2}, GCC generates code that takes advantage of
23462 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23463 default is @option{-mvis2} when targeting a cpu that supports such
23464 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23465 also sets @option{-mvis}.
23467 @item -mvis3
23468 @itemx -mno-vis3
23469 @opindex mvis3
23470 @opindex mno-vis3
23471 With @option{-mvis3}, GCC generates code that takes advantage of
23472 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23473 default is @option{-mvis3} when targeting a cpu that supports such
23474 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23475 also sets @option{-mvis2} and @option{-mvis}.
23477 @item -mvis4
23478 @itemx -mno-vis4
23479 @opindex mvis4
23480 @opindex mno-vis4
23481 With @option{-mvis4}, GCC generates code that takes advantage of
23482 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23483 default is @option{-mvis4} when targeting a cpu that supports such
23484 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23485 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23487 @item -mcbcond
23488 @itemx -mno-cbcond
23489 @opindex mcbcond
23490 @opindex mno-cbcond
23491 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23492 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23493 when targeting a CPU that supports such instructions, such as Niagara-4 and
23494 later.
23496 @item -mfmaf
23497 @itemx -mno-fmaf
23498 @opindex mfmaf
23499 @opindex mno-fmaf
23500 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23501 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23502 when targeting a CPU that supports such instructions, such as Niagara-3 and
23503 later.
23505 @item -mpopc
23506 @itemx -mno-popc
23507 @opindex mpopc
23508 @opindex mno-popc
23509 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23510 Population Count instruction.  The default is @option{-mpopc}
23511 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23512 later.
23514 @item -msubxc
23515 @itemx -mno-subxc
23516 @opindex msubxc
23517 @opindex mno-subxc
23518 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
23519 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
23520 when targeting a CPU that supports such an instruction, such as Niagara-7 and
23521 later.
23523 @item -mfix-at697f
23524 @opindex mfix-at697f
23525 Enable the documented workaround for the single erratum of the Atmel AT697F
23526 processor (which corresponds to erratum #13 of the AT697E processor).
23528 @item -mfix-ut699
23529 @opindex mfix-ut699
23530 Enable the documented workarounds for the floating-point errata and the data
23531 cache nullify errata of the UT699 processor.
23532 @end table
23534 These @samp{-m} options are supported in addition to the above
23535 on SPARC-V9 processors in 64-bit environments:
23537 @table @gcctabopt
23538 @item -m32
23539 @itemx -m64
23540 @opindex m32
23541 @opindex m64
23542 Generate code for a 32-bit or 64-bit environment.
23543 The 32-bit environment sets int, long and pointer to 32 bits.
23544 The 64-bit environment sets int to 32 bits and long and pointer
23545 to 64 bits.
23547 @item -mcmodel=@var{which}
23548 @opindex mcmodel
23549 Set the code model to one of
23551 @table @samp
23552 @item medlow
23553 The Medium/Low code model: 64-bit addresses, programs
23554 must be linked in the low 32 bits of memory.  Programs can be statically
23555 or dynamically linked.
23557 @item medmid
23558 The Medium/Middle code model: 64-bit addresses, programs
23559 must be linked in the low 44 bits of memory, the text and data segments must
23560 be less than 2GB in size and the data segment must be located within 2GB of
23561 the text segment.
23563 @item medany
23564 The Medium/Anywhere code model: 64-bit addresses, programs
23565 may be linked anywhere in memory, the text and data segments must be less
23566 than 2GB in size and the data segment must be located within 2GB of the
23567 text segment.
23569 @item embmedany
23570 The Medium/Anywhere code model for embedded systems:
23571 64-bit addresses, the text and data segments must be less than 2GB in
23572 size, both starting anywhere in memory (determined at link time).  The
23573 global register %g4 points to the base of the data segment.  Programs
23574 are statically linked and PIC is not supported.
23575 @end table
23577 @item -mmemory-model=@var{mem-model}
23578 @opindex mmemory-model
23579 Set the memory model in force on the processor to one of
23581 @table @samp
23582 @item default
23583 The default memory model for the processor and operating system.
23585 @item rmo
23586 Relaxed Memory Order
23588 @item pso
23589 Partial Store Order
23591 @item tso
23592 Total Store Order
23594 @item sc
23595 Sequential Consistency
23596 @end table
23598 These memory models are formally defined in Appendix D of the SPARC-V9
23599 architecture manual, as set in the processor's @code{PSTATE.MM} field.
23601 @item -mstack-bias
23602 @itemx -mno-stack-bias
23603 @opindex mstack-bias
23604 @opindex mno-stack-bias
23605 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
23606 frame pointer if present, are offset by @minus{}2047 which must be added back
23607 when making stack frame references.  This is the default in 64-bit mode.
23608 Otherwise, assume no such offset is present.
23609 @end table
23611 @node SPU Options
23612 @subsection SPU Options
23613 @cindex SPU options
23615 These @samp{-m} options are supported on the SPU:
23617 @table @gcctabopt
23618 @item -mwarn-reloc
23619 @itemx -merror-reloc
23620 @opindex mwarn-reloc
23621 @opindex merror-reloc
23623 The loader for SPU does not handle dynamic relocations.  By default, GCC
23624 gives an error when it generates code that requires a dynamic
23625 relocation.  @option{-mno-error-reloc} disables the error,
23626 @option{-mwarn-reloc} generates a warning instead.
23628 @item -msafe-dma
23629 @itemx -munsafe-dma
23630 @opindex msafe-dma
23631 @opindex munsafe-dma
23633 Instructions that initiate or test completion of DMA must not be
23634 reordered with respect to loads and stores of the memory that is being
23635 accessed.
23636 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
23637 memory accesses, but that can lead to inefficient code in places where the
23638 memory is known to not change.  Rather than mark the memory as volatile,
23639 you can use @option{-msafe-dma} to tell the compiler to treat
23640 the DMA instructions as potentially affecting all memory.  
23642 @item -mbranch-hints
23643 @opindex mbranch-hints
23645 By default, GCC generates a branch hint instruction to avoid
23646 pipeline stalls for always-taken or probably-taken branches.  A hint
23647 is not generated closer than 8 instructions away from its branch.
23648 There is little reason to disable them, except for debugging purposes,
23649 or to make an object a little bit smaller.
23651 @item -msmall-mem
23652 @itemx -mlarge-mem
23653 @opindex msmall-mem
23654 @opindex mlarge-mem
23656 By default, GCC generates code assuming that addresses are never larger
23657 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
23658 a full 32-bit address.
23660 @item -mstdmain
23661 @opindex mstdmain
23663 By default, GCC links against startup code that assumes the SPU-style
23664 main function interface (which has an unconventional parameter list).
23665 With @option{-mstdmain}, GCC links your program against startup
23666 code that assumes a C99-style interface to @code{main}, including a
23667 local copy of @code{argv} strings.
23669 @item -mfixed-range=@var{register-range}
23670 @opindex mfixed-range
23671 Generate code treating the given register range as fixed registers.
23672 A fixed register is one that the register allocator cannot use.  This is
23673 useful when compiling kernel code.  A register range is specified as
23674 two registers separated by a dash.  Multiple register ranges can be
23675 specified separated by a comma.
23677 @item -mea32
23678 @itemx -mea64
23679 @opindex mea32
23680 @opindex mea64
23681 Compile code assuming that pointers to the PPU address space accessed
23682 via the @code{__ea} named address space qualifier are either 32 or 64
23683 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
23684 all object code in an executable must be compiled with the same setting.
23686 @item -maddress-space-conversion
23687 @itemx -mno-address-space-conversion
23688 @opindex maddress-space-conversion
23689 @opindex mno-address-space-conversion
23690 Allow/disallow treating the @code{__ea} address space as superset
23691 of the generic address space.  This enables explicit type casts
23692 between @code{__ea} and generic pointer as well as implicit
23693 conversions of generic pointers to @code{__ea} pointers.  The
23694 default is to allow address space pointer conversions.
23696 @item -mcache-size=@var{cache-size}
23697 @opindex mcache-size
23698 This option controls the version of libgcc that the compiler links to an
23699 executable and selects a software-managed cache for accessing variables
23700 in the @code{__ea} address space with a particular cache size.  Possible
23701 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
23702 and @samp{128}.  The default cache size is 64KB.
23704 @item -matomic-updates
23705 @itemx -mno-atomic-updates
23706 @opindex matomic-updates
23707 @opindex mno-atomic-updates
23708 This option controls the version of libgcc that the compiler links to an
23709 executable and selects whether atomic updates to the software-managed
23710 cache of PPU-side variables are used.  If you use atomic updates, changes
23711 to a PPU variable from SPU code using the @code{__ea} named address space
23712 qualifier do not interfere with changes to other PPU variables residing
23713 in the same cache line from PPU code.  If you do not use atomic updates,
23714 such interference may occur; however, writing back cache lines is
23715 more efficient.  The default behavior is to use atomic updates.
23717 @item -mdual-nops
23718 @itemx -mdual-nops=@var{n}
23719 @opindex mdual-nops
23720 By default, GCC inserts NOPs to increase dual issue when it expects
23721 it to increase performance.  @var{n} can be a value from 0 to 10.  A
23722 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
23723 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
23725 @item -mhint-max-nops=@var{n}
23726 @opindex mhint-max-nops
23727 Maximum number of NOPs to insert for a branch hint.  A branch hint must
23728 be at least 8 instructions away from the branch it is affecting.  GCC
23729 inserts up to @var{n} NOPs to enforce this, otherwise it does not
23730 generate the branch hint.
23732 @item -mhint-max-distance=@var{n}
23733 @opindex mhint-max-distance
23734 The encoding of the branch hint instruction limits the hint to be within
23735 256 instructions of the branch it is affecting.  By default, GCC makes
23736 sure it is within 125.
23738 @item -msafe-hints
23739 @opindex msafe-hints
23740 Work around a hardware bug that causes the SPU to stall indefinitely.
23741 By default, GCC inserts the @code{hbrp} instruction to make sure
23742 this stall won't happen.
23744 @end table
23746 @node System V Options
23747 @subsection Options for System V
23749 These additional options are available on System V Release 4 for
23750 compatibility with other compilers on those systems:
23752 @table @gcctabopt
23753 @item -G
23754 @opindex G
23755 Create a shared object.
23756 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
23758 @item -Qy
23759 @opindex Qy
23760 Identify the versions of each tool used by the compiler, in a
23761 @code{.ident} assembler directive in the output.
23763 @item -Qn
23764 @opindex Qn
23765 Refrain from adding @code{.ident} directives to the output file (this is
23766 the default).
23768 @item -YP,@var{dirs}
23769 @opindex YP
23770 Search the directories @var{dirs}, and no others, for libraries
23771 specified with @option{-l}.
23773 @item -Ym,@var{dir}
23774 @opindex Ym
23775 Look in the directory @var{dir} to find the M4 preprocessor.
23776 The assembler uses this option.
23777 @c This is supposed to go with a -Yd for predefined M4 macro files, but
23778 @c the generic assembler that comes with Solaris takes just -Ym.
23779 @end table
23781 @node TILE-Gx Options
23782 @subsection TILE-Gx Options
23783 @cindex TILE-Gx options
23785 These @samp{-m} options are supported on the TILE-Gx:
23787 @table @gcctabopt
23788 @item -mcmodel=small
23789 @opindex mcmodel=small
23790 Generate code for the small model.  The distance for direct calls is
23791 limited to 500M in either direction.  PC-relative addresses are 32
23792 bits.  Absolute addresses support the full address range.
23794 @item -mcmodel=large
23795 @opindex mcmodel=large
23796 Generate code for the large model.  There is no limitation on call
23797 distance, pc-relative addresses, or absolute addresses.
23799 @item -mcpu=@var{name}
23800 @opindex mcpu
23801 Selects the type of CPU to be targeted.  Currently the only supported
23802 type is @samp{tilegx}.
23804 @item -m32
23805 @itemx -m64
23806 @opindex m32
23807 @opindex m64
23808 Generate code for a 32-bit or 64-bit environment.  The 32-bit
23809 environment sets int, long, and pointer to 32 bits.  The 64-bit
23810 environment sets int to 32 bits and long and pointer to 64 bits.
23812 @item -mbig-endian
23813 @itemx -mlittle-endian
23814 @opindex mbig-endian
23815 @opindex mlittle-endian
23816 Generate code in big/little endian mode, respectively.
23817 @end table
23819 @node TILEPro Options
23820 @subsection TILEPro Options
23821 @cindex TILEPro options
23823 These @samp{-m} options are supported on the TILEPro:
23825 @table @gcctabopt
23826 @item -mcpu=@var{name}
23827 @opindex mcpu
23828 Selects the type of CPU to be targeted.  Currently the only supported
23829 type is @samp{tilepro}.
23831 @item -m32
23832 @opindex m32
23833 Generate code for a 32-bit environment, which sets int, long, and
23834 pointer to 32 bits.  This is the only supported behavior so the flag
23835 is essentially ignored.
23836 @end table
23838 @node V850 Options
23839 @subsection V850 Options
23840 @cindex V850 Options
23842 These @samp{-m} options are defined for V850 implementations:
23844 @table @gcctabopt
23845 @item -mlong-calls
23846 @itemx -mno-long-calls
23847 @opindex mlong-calls
23848 @opindex mno-long-calls
23849 Treat all calls as being far away (near).  If calls are assumed to be
23850 far away, the compiler always loads the function's address into a
23851 register, and calls indirect through the pointer.
23853 @item -mno-ep
23854 @itemx -mep
23855 @opindex mno-ep
23856 @opindex mep
23857 Do not optimize (do optimize) basic blocks that use the same index
23858 pointer 4 or more times to copy pointer into the @code{ep} register, and
23859 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
23860 option is on by default if you optimize.
23862 @item -mno-prolog-function
23863 @itemx -mprolog-function
23864 @opindex mno-prolog-function
23865 @opindex mprolog-function
23866 Do not use (do use) external functions to save and restore registers
23867 at the prologue and epilogue of a function.  The external functions
23868 are slower, but use less code space if more than one function saves
23869 the same number of registers.  The @option{-mprolog-function} option
23870 is on by default if you optimize.
23872 @item -mspace
23873 @opindex mspace
23874 Try to make the code as small as possible.  At present, this just turns
23875 on the @option{-mep} and @option{-mprolog-function} options.
23877 @item -mtda=@var{n}
23878 @opindex mtda
23879 Put static or global variables whose size is @var{n} bytes or less into
23880 the tiny data area that register @code{ep} points to.  The tiny data
23881 area can hold up to 256 bytes in total (128 bytes for byte references).
23883 @item -msda=@var{n}
23884 @opindex msda
23885 Put static or global variables whose size is @var{n} bytes or less into
23886 the small data area that register @code{gp} points to.  The small data
23887 area can hold up to 64 kilobytes.
23889 @item -mzda=@var{n}
23890 @opindex mzda
23891 Put static or global variables whose size is @var{n} bytes or less into
23892 the first 32 kilobytes of memory.
23894 @item -mv850
23895 @opindex mv850
23896 Specify that the target processor is the V850.
23898 @item -mv850e3v5
23899 @opindex mv850e3v5
23900 Specify that the target processor is the V850E3V5.  The preprocessor
23901 constant @code{__v850e3v5__} is defined if this option is used.
23903 @item -mv850e2v4
23904 @opindex mv850e2v4
23905 Specify that the target processor is the V850E3V5.  This is an alias for
23906 the @option{-mv850e3v5} option.
23908 @item -mv850e2v3
23909 @opindex mv850e2v3
23910 Specify that the target processor is the V850E2V3.  The preprocessor
23911 constant @code{__v850e2v3__} is defined if this option is used.
23913 @item -mv850e2
23914 @opindex mv850e2
23915 Specify that the target processor is the V850E2.  The preprocessor
23916 constant @code{__v850e2__} is defined if this option is used.
23918 @item -mv850e1
23919 @opindex mv850e1
23920 Specify that the target processor is the V850E1.  The preprocessor
23921 constants @code{__v850e1__} and @code{__v850e__} are defined if
23922 this option is used.
23924 @item -mv850es
23925 @opindex mv850es
23926 Specify that the target processor is the V850ES.  This is an alias for
23927 the @option{-mv850e1} option.
23929 @item -mv850e
23930 @opindex mv850e
23931 Specify that the target processor is the V850E@.  The preprocessor
23932 constant @code{__v850e__} is defined if this option is used.
23934 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
23935 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
23936 are defined then a default target processor is chosen and the
23937 relevant @samp{__v850*__} preprocessor constant is defined.
23939 The preprocessor constants @code{__v850} and @code{__v851__} are always
23940 defined, regardless of which processor variant is the target.
23942 @item -mdisable-callt
23943 @itemx -mno-disable-callt
23944 @opindex mdisable-callt
23945 @opindex mno-disable-callt
23946 This option suppresses generation of the @code{CALLT} instruction for the
23947 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
23948 architecture.
23950 This option is enabled by default when the RH850 ABI is
23951 in use (see @option{-mrh850-abi}), and disabled by default when the
23952 GCC ABI is in use.  If @code{CALLT} instructions are being generated
23953 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
23955 @item -mrelax
23956 @itemx -mno-relax
23957 @opindex mrelax
23958 @opindex mno-relax
23959 Pass on (or do not pass on) the @option{-mrelax} command-line option
23960 to the assembler.
23962 @item -mlong-jumps
23963 @itemx -mno-long-jumps
23964 @opindex mlong-jumps
23965 @opindex mno-long-jumps
23966 Disable (or re-enable) the generation of PC-relative jump instructions.
23968 @item -msoft-float
23969 @itemx -mhard-float
23970 @opindex msoft-float
23971 @opindex mhard-float
23972 Disable (or re-enable) the generation of hardware floating point
23973 instructions.  This option is only significant when the target
23974 architecture is @samp{V850E2V3} or higher.  If hardware floating point
23975 instructions are being generated then the C preprocessor symbol
23976 @code{__FPU_OK__} is defined, otherwise the symbol
23977 @code{__NO_FPU__} is defined.
23979 @item -mloop
23980 @opindex mloop
23981 Enables the use of the e3v5 LOOP instruction.  The use of this
23982 instruction is not enabled by default when the e3v5 architecture is
23983 selected because its use is still experimental.
23985 @item -mrh850-abi
23986 @itemx -mghs
23987 @opindex mrh850-abi
23988 @opindex mghs
23989 Enables support for the RH850 version of the V850 ABI.  This is the
23990 default.  With this version of the ABI the following rules apply:
23992 @itemize
23993 @item
23994 Integer sized structures and unions are returned via a memory pointer
23995 rather than a register.
23997 @item
23998 Large structures and unions (more than 8 bytes in size) are passed by
23999 value.
24001 @item
24002 Functions are aligned to 16-bit boundaries.
24004 @item
24005 The @option{-m8byte-align} command-line option is supported.
24007 @item
24008 The @option{-mdisable-callt} command-line option is enabled by
24009 default.  The @option{-mno-disable-callt} command-line option is not
24010 supported.
24011 @end itemize
24013 When this version of the ABI is enabled the C preprocessor symbol
24014 @code{__V850_RH850_ABI__} is defined.
24016 @item -mgcc-abi
24017 @opindex mgcc-abi
24018 Enables support for the old GCC version of the V850 ABI.  With this
24019 version of the ABI the following rules apply:
24021 @itemize
24022 @item
24023 Integer sized structures and unions are returned in register @code{r10}.
24025 @item
24026 Large structures and unions (more than 8 bytes in size) are passed by
24027 reference.
24029 @item
24030 Functions are aligned to 32-bit boundaries, unless optimizing for
24031 size.
24033 @item
24034 The @option{-m8byte-align} command-line option is not supported.
24036 @item
24037 The @option{-mdisable-callt} command-line option is supported but not
24038 enabled by default.
24039 @end itemize
24041 When this version of the ABI is enabled the C preprocessor symbol
24042 @code{__V850_GCC_ABI__} is defined.
24044 @item -m8byte-align
24045 @itemx -mno-8byte-align
24046 @opindex m8byte-align
24047 @opindex mno-8byte-align
24048 Enables support for @code{double} and @code{long long} types to be
24049 aligned on 8-byte boundaries.  The default is to restrict the
24050 alignment of all objects to at most 4-bytes.  When
24051 @option{-m8byte-align} is in effect the C preprocessor symbol
24052 @code{__V850_8BYTE_ALIGN__} is defined.
24054 @item -mbig-switch
24055 @opindex mbig-switch
24056 Generate code suitable for big switch tables.  Use this option only if
24057 the assembler/linker complain about out of range branches within a switch
24058 table.
24060 @item -mapp-regs
24061 @opindex mapp-regs
24062 This option causes r2 and r5 to be used in the code generated by
24063 the compiler.  This setting is the default.
24065 @item -mno-app-regs
24066 @opindex mno-app-regs
24067 This option causes r2 and r5 to be treated as fixed registers.
24069 @end table
24071 @node VAX Options
24072 @subsection VAX Options
24073 @cindex VAX options
24075 These @samp{-m} options are defined for the VAX:
24077 @table @gcctabopt
24078 @item -munix
24079 @opindex munix
24080 Do not output certain jump instructions (@code{aobleq} and so on)
24081 that the Unix assembler for the VAX cannot handle across long
24082 ranges.
24084 @item -mgnu
24085 @opindex mgnu
24086 Do output those jump instructions, on the assumption that the
24087 GNU assembler is being used.
24089 @item -mg
24090 @opindex mg
24091 Output code for G-format floating-point numbers instead of D-format.
24092 @end table
24094 @node Visium Options
24095 @subsection Visium Options
24096 @cindex Visium options
24098 @table @gcctabopt
24100 @item -mdebug
24101 @opindex mdebug
24102 A program which performs file I/O and is destined to run on an MCM target
24103 should be linked with this option.  It causes the libraries libc.a and
24104 libdebug.a to be linked.  The program should be run on the target under
24105 the control of the GDB remote debugging stub.
24107 @item -msim
24108 @opindex msim
24109 A program which performs file I/O and is destined to run on the simulator
24110 should be linked with option.  This causes libraries libc.a and libsim.a to
24111 be linked.
24113 @item -mfpu
24114 @itemx -mhard-float
24115 @opindex mfpu
24116 @opindex mhard-float
24117 Generate code containing floating-point instructions.  This is the
24118 default.
24120 @item -mno-fpu
24121 @itemx -msoft-float
24122 @opindex mno-fpu
24123 @opindex msoft-float
24124 Generate code containing library calls for floating-point.
24126 @option{-msoft-float} changes the calling convention in the output file;
24127 therefore, it is only useful if you compile @emph{all} of a program with
24128 this option.  In particular, you need to compile @file{libgcc.a}, the
24129 library that comes with GCC, with @option{-msoft-float} in order for
24130 this to work.
24132 @item -mcpu=@var{cpu_type}
24133 @opindex mcpu
24134 Set the instruction set, register set, and instruction scheduling parameters
24135 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24136 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24138 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24140 By default (unless configured otherwise), GCC generates code for the GR5
24141 variant of the Visium architecture.  
24143 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24144 architecture.  The only difference from GR5 code is that the compiler will
24145 generate block move instructions.
24147 @item -mtune=@var{cpu_type}
24148 @opindex mtune
24149 Set the instruction scheduling parameters for machine type @var{cpu_type},
24150 but do not set the instruction set or register set that the option
24151 @option{-mcpu=@var{cpu_type}} would.
24153 @item -msv-mode
24154 @opindex msv-mode
24155 Generate code for the supervisor mode, where there are no restrictions on
24156 the access to general registers.  This is the default.
24158 @item -muser-mode
24159 @opindex muser-mode
24160 Generate code for the user mode, where the access to some general registers
24161 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24162 mode; on the GR6, only registers r29 to r31 are affected.
24163 @end table
24165 @node VMS Options
24166 @subsection VMS Options
24168 These @samp{-m} options are defined for the VMS implementations:
24170 @table @gcctabopt
24171 @item -mvms-return-codes
24172 @opindex mvms-return-codes
24173 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24174 condition (e.g.@ error) codes.
24176 @item -mdebug-main=@var{prefix}
24177 @opindex mdebug-main=@var{prefix}
24178 Flag the first routine whose name starts with @var{prefix} as the main
24179 routine for the debugger.
24181 @item -mmalloc64
24182 @opindex mmalloc64
24183 Default to 64-bit memory allocation routines.
24185 @item -mpointer-size=@var{size}
24186 @opindex mpointer-size=@var{size}
24187 Set the default size of pointers. Possible options for @var{size} are
24188 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24189 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24190 The later option disables @code{pragma pointer_size}.
24191 @end table
24193 @node VxWorks Options
24194 @subsection VxWorks Options
24195 @cindex VxWorks Options
24197 The options in this section are defined for all VxWorks targets.
24198 Options specific to the target hardware are listed with the other
24199 options for that target.
24201 @table @gcctabopt
24202 @item -mrtp
24203 @opindex mrtp
24204 GCC can generate code for both VxWorks kernels and real time processes
24205 (RTPs).  This option switches from the former to the latter.  It also
24206 defines the preprocessor macro @code{__RTP__}.
24208 @item -non-static
24209 @opindex non-static
24210 Link an RTP executable against shared libraries rather than static
24211 libraries.  The options @option{-static} and @option{-shared} can
24212 also be used for RTPs (@pxref{Link Options}); @option{-static}
24213 is the default.
24215 @item -Bstatic
24216 @itemx -Bdynamic
24217 @opindex Bstatic
24218 @opindex Bdynamic
24219 These options are passed down to the linker.  They are defined for
24220 compatibility with Diab.
24222 @item -Xbind-lazy
24223 @opindex Xbind-lazy
24224 Enable lazy binding of function calls.  This option is equivalent to
24225 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24227 @item -Xbind-now
24228 @opindex Xbind-now
24229 Disable lazy binding of function calls.  This option is the default and
24230 is defined for compatibility with Diab.
24231 @end table
24233 @node x86 Options
24234 @subsection x86 Options
24235 @cindex x86 Options
24237 These @samp{-m} options are defined for the x86 family of computers.
24239 @table @gcctabopt
24241 @item -march=@var{cpu-type}
24242 @opindex march
24243 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24244 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24245 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24246 to generate code that may not run at all on processors other than the one
24247 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24248 @option{-mtune=@var{cpu-type}}.
24250 The choices for @var{cpu-type} are:
24252 @table @samp
24253 @item native
24254 This selects the CPU to generate code for at compilation time by determining
24255 the processor type of the compiling machine.  Using @option{-march=native}
24256 enables all instruction subsets supported by the local machine (hence
24257 the result might not run on different machines).  Using @option{-mtune=native}
24258 produces code optimized for the local machine under the constraints
24259 of the selected instruction set.  
24261 @item i386
24262 Original Intel i386 CPU@.
24264 @item i486
24265 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24267 @item i586
24268 @itemx pentium
24269 Intel Pentium CPU with no MMX support.
24271 @item lakemont
24272 Intel Lakemont MCU, based on Intel Pentium CPU.
24274 @item pentium-mmx
24275 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24277 @item pentiumpro
24278 Intel Pentium Pro CPU@.
24280 @item i686
24281 When used with @option{-march}, the Pentium Pro
24282 instruction set is used, so the code runs on all i686 family chips.
24283 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24285 @item pentium2
24286 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24287 support.
24289 @item pentium3
24290 @itemx pentium3m
24291 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24292 set support.
24294 @item pentium-m
24295 Intel Pentium M; low-power version of Intel Pentium III CPU
24296 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24298 @item pentium4
24299 @itemx pentium4m
24300 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24302 @item prescott
24303 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24304 set support.
24306 @item nocona
24307 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24308 SSE2 and SSE3 instruction set support.
24310 @item core2
24311 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24312 instruction set support.
24314 @item nehalem
24315 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24316 SSE4.1, SSE4.2 and POPCNT instruction set support.
24318 @item westmere
24319 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24320 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24322 @item sandybridge
24323 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24324 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24326 @item ivybridge
24327 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24328 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24329 instruction set support.
24331 @item haswell
24332 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24333 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24334 BMI, BMI2 and F16C instruction set support.
24336 @item broadwell
24337 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24338 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24339 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24341 @item skylake
24342 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24343 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24344 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24345 XSAVES instruction set support.
24347 @item bonnell
24348 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24349 instruction set support.
24351 @item silvermont
24352 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24353 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24355 @item knl
24356 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24357 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24358 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24359 AVX512CD instruction set support.
24361 @item skylake-avx512
24362 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24363 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24364 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24365 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24367 @item k6
24368 AMD K6 CPU with MMX instruction set support.
24370 @item k6-2
24371 @itemx k6-3
24372 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24374 @item athlon
24375 @itemx athlon-tbird
24376 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24377 support.
24379 @item athlon-4
24380 @itemx athlon-xp
24381 @itemx athlon-mp
24382 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24383 instruction set support.
24385 @item k8
24386 @itemx opteron
24387 @itemx athlon64
24388 @itemx athlon-fx
24389 Processors based on the AMD K8 core with x86-64 instruction set support,
24390 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24391 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24392 instruction set extensions.)
24394 @item k8-sse3
24395 @itemx opteron-sse3
24396 @itemx athlon64-sse3
24397 Improved versions of AMD K8 cores with SSE3 instruction set support.
24399 @item amdfam10
24400 @itemx barcelona
24401 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24402 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24403 instruction set extensions.)
24405 @item bdver1
24406 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24407 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24408 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24409 @item bdver2
24410 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24411 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24412 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24413 extensions.)
24414 @item bdver3
24415 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24416 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24417 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24418 64-bit instruction set extensions.
24419 @item bdver4
24420 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24421 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24422 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24423 SSE4.2, ABM and 64-bit instruction set extensions.
24425 @item znver1
24426 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24427 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24428 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24429 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24430 instruction set extensions.
24432 @item btver1
24433 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24434 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24435 instruction set extensions.)
24437 @item btver2
24438 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24439 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24440 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24442 @item winchip-c6
24443 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24444 set support.
24446 @item winchip2
24447 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24448 instruction set support.
24450 @item c3
24451 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24452 (No scheduling is implemented for this chip.)
24454 @item c3-2
24455 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24456 (No scheduling is implemented for this chip.)
24458 @item c7
24459 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24460 (No scheduling is implemented for this chip.)
24462 @item samuel-2
24463 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24464 (No scheduling is implemented for this chip.)
24466 @item nehemiah
24467 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24468 (No scheduling is implemented for this chip.)
24470 @item esther
24471 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24472 (No scheduling is implemented for this chip.)
24474 @item eden-x2
24475 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24476 (No scheduling is implemented for this chip.)
24478 @item eden-x4
24479 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24480 AVX and AVX2 instruction set support.
24481 (No scheduling is implemented for this chip.)
24483 @item nano
24484 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24485 instruction set support.
24486 (No scheduling is implemented for this chip.)
24488 @item nano-1000
24489 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24490 instruction set support.
24491 (No scheduling is implemented for this chip.)
24493 @item nano-2000
24494 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24495 instruction set support.
24496 (No scheduling is implemented for this chip.)
24498 @item nano-3000
24499 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24500 instruction set support.
24501 (No scheduling is implemented for this chip.)
24503 @item nano-x2
24504 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24505 instruction set support.
24506 (No scheduling is implemented for this chip.)
24508 @item nano-x4
24509 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24510 instruction set support.
24511 (No scheduling is implemented for this chip.)
24513 @item geode
24514 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
24515 @end table
24517 @item -mtune=@var{cpu-type}
24518 @opindex mtune
24519 Tune to @var{cpu-type} everything applicable about the generated code, except
24520 for the ABI and the set of available instructions.  
24521 While picking a specific @var{cpu-type} schedules things appropriately
24522 for that particular chip, the compiler does not generate any code that
24523 cannot run on the default machine type unless you use a
24524 @option{-march=@var{cpu-type}} option.
24525 For example, if GCC is configured for i686-pc-linux-gnu
24526 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
24527 but still runs on i686 machines.
24529 The choices for @var{cpu-type} are the same as for @option{-march}.
24530 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
24532 @table @samp
24533 @item generic
24534 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
24535 If you know the CPU on which your code will run, then you should use
24536 the corresponding @option{-mtune} or @option{-march} option instead of
24537 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
24538 of your application will have, then you should use this option.
24540 As new processors are deployed in the marketplace, the behavior of this
24541 option will change.  Therefore, if you upgrade to a newer version of
24542 GCC, code generation controlled by this option will change to reflect
24543 the processors
24544 that are most common at the time that version of GCC is released.
24546 There is no @option{-march=generic} option because @option{-march}
24547 indicates the instruction set the compiler can use, and there is no
24548 generic instruction set applicable to all processors.  In contrast,
24549 @option{-mtune} indicates the processor (or, in this case, collection of
24550 processors) for which the code is optimized.
24552 @item intel
24553 Produce code optimized for the most current Intel processors, which are
24554 Haswell and Silvermont for this version of GCC.  If you know the CPU
24555 on which your code will run, then you should use the corresponding
24556 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
24557 But, if you want your application performs better on both Haswell and
24558 Silvermont, then you should use this option.
24560 As new Intel processors are deployed in the marketplace, the behavior of
24561 this option will change.  Therefore, if you upgrade to a newer version of
24562 GCC, code generation controlled by this option will change to reflect
24563 the most current Intel processors at the time that version of GCC is
24564 released.
24566 There is no @option{-march=intel} option because @option{-march} indicates
24567 the instruction set the compiler can use, and there is no common
24568 instruction set applicable to all processors.  In contrast,
24569 @option{-mtune} indicates the processor (or, in this case, collection of
24570 processors) for which the code is optimized.
24571 @end table
24573 @item -mcpu=@var{cpu-type}
24574 @opindex mcpu
24575 A deprecated synonym for @option{-mtune}.
24577 @item -mfpmath=@var{unit}
24578 @opindex mfpmath
24579 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
24580 for @var{unit} are:
24582 @table @samp
24583 @item 387
24584 Use the standard 387 floating-point coprocessor present on the majority of chips and
24585 emulated otherwise.  Code compiled with this option runs almost everywhere.
24586 The temporary results are computed in 80-bit precision instead of the precision
24587 specified by the type, resulting in slightly different results compared to most
24588 of other chips.  See @option{-ffloat-store} for more detailed description.
24590 This is the default choice for x86-32 targets.
24592 @item sse
24593 Use scalar floating-point instructions present in the SSE instruction set.
24594 This instruction set is supported by Pentium III and newer chips,
24595 and in the AMD line
24596 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
24597 instruction set supports only single-precision arithmetic, thus the double and
24598 extended-precision arithmetic are still done using 387.  A later version, present
24599 only in Pentium 4 and AMD x86-64 chips, supports double-precision
24600 arithmetic too.
24602 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
24603 or @option{-msse2} switches to enable SSE extensions and make this option
24604 effective.  For the x86-64 compiler, these extensions are enabled by default.
24606 The resulting code should be considerably faster in the majority of cases and avoid
24607 the numerical instability problems of 387 code, but may break some existing
24608 code that expects temporaries to be 80 bits.
24610 This is the default choice for the x86-64 compiler.
24612 @item sse,387
24613 @itemx sse+387
24614 @itemx both
24615 Attempt to utilize both instruction sets at once.  This effectively doubles the
24616 amount of available registers, and on chips with separate execution units for
24617 387 and SSE the execution resources too.  Use this option with care, as it is
24618 still experimental, because the GCC register allocator does not model separate
24619 functional units well, resulting in unstable performance.
24620 @end table
24622 @item -masm=@var{dialect}
24623 @opindex masm=@var{dialect}
24624 Output assembly instructions using selected @var{dialect}.  Also affects
24625 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
24626 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
24627 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
24628 not support @samp{intel}.
24630 @item -mieee-fp
24631 @itemx -mno-ieee-fp
24632 @opindex mieee-fp
24633 @opindex mno-ieee-fp
24634 Control whether or not the compiler uses IEEE floating-point
24635 comparisons.  These correctly handle the case where the result of a
24636 comparison is unordered.
24638 @item -m80387
24639 @item -mhard-float
24640 @opindex 80387
24641 @opindex mhard-float
24642 Generate output containing 80387 instructions for floating point.
24644 @item -mno-80387
24645 @item -msoft-float
24646 @opindex no-80387
24647 @opindex msoft-float
24648 Generate output containing library calls for floating point.
24650 @strong{Warning:} the requisite libraries are not part of GCC@.
24651 Normally the facilities of the machine's usual C compiler are used, but
24652 this can't be done directly in cross-compilation.  You must make your
24653 own arrangements to provide suitable library functions for
24654 cross-compilation.
24656 On machines where a function returns floating-point results in the 80387
24657 register stack, some floating-point opcodes may be emitted even if
24658 @option{-msoft-float} is used.
24660 @item -mno-fp-ret-in-387
24661 @opindex mno-fp-ret-in-387
24662 Do not use the FPU registers for return values of functions.
24664 The usual calling convention has functions return values of types
24665 @code{float} and @code{double} in an FPU register, even if there
24666 is no FPU@.  The idea is that the operating system should emulate
24667 an FPU@.
24669 The option @option{-mno-fp-ret-in-387} causes such values to be returned
24670 in ordinary CPU registers instead.
24672 @item -mno-fancy-math-387
24673 @opindex mno-fancy-math-387
24674 Some 387 emulators do not support the @code{sin}, @code{cos} and
24675 @code{sqrt} instructions for the 387.  Specify this option to avoid
24676 generating those instructions.  This option is the default on
24677 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
24678 indicates that the target CPU always has an FPU and so the
24679 instruction does not need emulation.  These
24680 instructions are not generated unless you also use the
24681 @option{-funsafe-math-optimizations} switch.
24683 @item -malign-double
24684 @itemx -mno-align-double
24685 @opindex malign-double
24686 @opindex mno-align-double
24687 Control whether GCC aligns @code{double}, @code{long double}, and
24688 @code{long long} variables on a two-word boundary or a one-word
24689 boundary.  Aligning @code{double} variables on a two-word boundary
24690 produces code that runs somewhat faster on a Pentium at the
24691 expense of more memory.
24693 On x86-64, @option{-malign-double} is enabled by default.
24695 @strong{Warning:} if you use the @option{-malign-double} switch,
24696 structures containing the above types are aligned differently than
24697 the published application binary interface specifications for the x86-32
24698 and are not binary compatible with structures in code compiled
24699 without that switch.
24701 @item -m96bit-long-double
24702 @itemx -m128bit-long-double
24703 @opindex m96bit-long-double
24704 @opindex m128bit-long-double
24705 These switches control the size of @code{long double} type.  The x86-32
24706 application binary interface specifies the size to be 96 bits,
24707 so @option{-m96bit-long-double} is the default in 32-bit mode.
24709 Modern architectures (Pentium and newer) prefer @code{long double}
24710 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
24711 conforming to the ABI, this is not possible.  So specifying
24712 @option{-m128bit-long-double} aligns @code{long double}
24713 to a 16-byte boundary by padding the @code{long double} with an additional
24714 32-bit zero.
24716 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
24717 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
24719 Notice that neither of these options enable any extra precision over the x87
24720 standard of 80 bits for a @code{long double}.
24722 @strong{Warning:} if you override the default value for your target ABI, this
24723 changes the size of 
24724 structures and arrays containing @code{long double} variables,
24725 as well as modifying the function calling convention for functions taking
24726 @code{long double}.  Hence they are not binary-compatible
24727 with code compiled without that switch.
24729 @item -mlong-double-64
24730 @itemx -mlong-double-80
24731 @itemx -mlong-double-128
24732 @opindex mlong-double-64
24733 @opindex mlong-double-80
24734 @opindex mlong-double-128
24735 These switches control the size of @code{long double} type. A size
24736 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24737 type. This is the default for 32-bit Bionic C library.  A size
24738 of 128 bits makes the @code{long double} type equivalent to the
24739 @code{__float128} type. This is the default for 64-bit Bionic C library.
24741 @strong{Warning:} if you override the default value for your target ABI, this
24742 changes the size of
24743 structures and arrays containing @code{long double} variables,
24744 as well as modifying the function calling convention for functions taking
24745 @code{long double}.  Hence they are not binary-compatible
24746 with code compiled without that switch.
24748 @item -malign-data=@var{type}
24749 @opindex malign-data
24750 Control how GCC aligns variables.  Supported values for @var{type} are
24751 @samp{compat} uses increased alignment value compatible uses GCC 4.8
24752 and earlier, @samp{abi} uses alignment value as specified by the
24753 psABI, and @samp{cacheline} uses increased alignment value to match
24754 the cache line size.  @samp{compat} is the default.
24756 @item -mlarge-data-threshold=@var{threshold}
24757 @opindex mlarge-data-threshold
24758 When @option{-mcmodel=medium} is specified, data objects larger than
24759 @var{threshold} are placed in the large data section.  This value must be the
24760 same across all objects linked into the binary, and defaults to 65535.
24762 @item -mrtd
24763 @opindex mrtd
24764 Use a different function-calling convention, in which functions that
24765 take a fixed number of arguments return with the @code{ret @var{num}}
24766 instruction, which pops their arguments while returning.  This saves one
24767 instruction in the caller since there is no need to pop the arguments
24768 there.
24770 You can specify that an individual function is called with this calling
24771 sequence with the function attribute @code{stdcall}.  You can also
24772 override the @option{-mrtd} option by using the function attribute
24773 @code{cdecl}.  @xref{Function Attributes}.
24775 @strong{Warning:} this calling convention is incompatible with the one
24776 normally used on Unix, so you cannot use it if you need to call
24777 libraries compiled with the Unix compiler.
24779 Also, you must provide function prototypes for all functions that
24780 take variable numbers of arguments (including @code{printf});
24781 otherwise incorrect code is generated for calls to those
24782 functions.
24784 In addition, seriously incorrect code results if you call a
24785 function with too many arguments.  (Normally, extra arguments are
24786 harmlessly ignored.)
24788 @item -mregparm=@var{num}
24789 @opindex mregparm
24790 Control how many registers are used to pass integer arguments.  By
24791 default, no registers are used to pass arguments, and at most 3
24792 registers can be used.  You can control this behavior for a specific
24793 function by using the function attribute @code{regparm}.
24794 @xref{Function Attributes}.
24796 @strong{Warning:} if you use this switch, and
24797 @var{num} is nonzero, then you must build all modules with the same
24798 value, including any libraries.  This includes the system libraries and
24799 startup modules.
24801 @item -msseregparm
24802 @opindex msseregparm
24803 Use SSE register passing conventions for float and double arguments
24804 and return values.  You can control this behavior for a specific
24805 function by using the function attribute @code{sseregparm}.
24806 @xref{Function Attributes}.
24808 @strong{Warning:} if you use this switch then you must build all
24809 modules with the same value, including any libraries.  This includes
24810 the system libraries and startup modules.
24812 @item -mvect8-ret-in-mem
24813 @opindex mvect8-ret-in-mem
24814 Return 8-byte vectors in memory instead of MMX registers.  This is the
24815 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
24816 Studio compilers until version 12.  Later compiler versions (starting
24817 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
24818 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
24819 you need to remain compatible with existing code produced by those
24820 previous compiler versions or older versions of GCC@.
24822 @item -mpc32
24823 @itemx -mpc64
24824 @itemx -mpc80
24825 @opindex mpc32
24826 @opindex mpc64
24827 @opindex mpc80
24829 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
24830 is specified, the significands of results of floating-point operations are
24831 rounded to 24 bits (single precision); @option{-mpc64} rounds the
24832 significands of results of floating-point operations to 53 bits (double
24833 precision) and @option{-mpc80} rounds the significands of results of
24834 floating-point operations to 64 bits (extended double precision), which is
24835 the default.  When this option is used, floating-point operations in higher
24836 precisions are not available to the programmer without setting the FPU
24837 control word explicitly.
24839 Setting the rounding of floating-point operations to less than the default
24840 80 bits can speed some programs by 2% or more.  Note that some mathematical
24841 libraries assume that extended-precision (80-bit) floating-point operations
24842 are enabled by default; routines in such libraries could suffer significant
24843 loss of accuracy, typically through so-called ``catastrophic cancellation'',
24844 when this option is used to set the precision to less than extended precision.
24846 @item -mstackrealign
24847 @opindex mstackrealign
24848 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
24849 option generates an alternate prologue and epilogue that realigns the
24850 run-time stack if necessary.  This supports mixing legacy codes that keep
24851 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
24852 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
24853 applicable to individual functions.
24855 @item -mpreferred-stack-boundary=@var{num}
24856 @opindex mpreferred-stack-boundary
24857 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
24858 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
24859 the default is 4 (16 bytes or 128 bits).
24861 @strong{Warning:} When generating code for the x86-64 architecture with
24862 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
24863 used to keep the stack boundary aligned to 8 byte boundary.  Since
24864 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
24865 intended to be used in controlled environment where stack space is
24866 important limitation.  This option leads to wrong code when functions
24867 compiled with 16 byte stack alignment (such as functions from a standard
24868 library) are called with misaligned stack.  In this case, SSE
24869 instructions may lead to misaligned memory access traps.  In addition,
24870 variable arguments are handled incorrectly for 16 byte aligned
24871 objects (including x87 long double and __int128), leading to wrong
24872 results.  You must build all modules with
24873 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
24874 includes the system libraries and startup modules.
24876 @item -mincoming-stack-boundary=@var{num}
24877 @opindex mincoming-stack-boundary
24878 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
24879 boundary.  If @option{-mincoming-stack-boundary} is not specified,
24880 the one specified by @option{-mpreferred-stack-boundary} is used.
24882 On Pentium and Pentium Pro, @code{double} and @code{long double} values
24883 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
24884 suffer significant run time performance penalties.  On Pentium III, the
24885 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
24886 properly if it is not 16-byte aligned.
24888 To ensure proper alignment of this values on the stack, the stack boundary
24889 must be as aligned as that required by any value stored on the stack.
24890 Further, every function must be generated such that it keeps the stack
24891 aligned.  Thus calling a function compiled with a higher preferred
24892 stack boundary from a function compiled with a lower preferred stack
24893 boundary most likely misaligns the stack.  It is recommended that
24894 libraries that use callbacks always use the default setting.
24896 This extra alignment does consume extra stack space, and generally
24897 increases code size.  Code that is sensitive to stack space usage, such
24898 as embedded systems and operating system kernels, may want to reduce the
24899 preferred alignment to @option{-mpreferred-stack-boundary=2}.
24901 @need 200
24902 @item -mmmx
24903 @opindex mmmx
24904 @need 200
24905 @itemx -msse
24906 @opindex msse
24907 @need 200
24908 @itemx -msse2
24909 @opindex msse2
24910 @need 200
24911 @itemx -msse3
24912 @opindex msse3
24913 @need 200
24914 @itemx -mssse3
24915 @opindex mssse3
24916 @need 200
24917 @itemx -msse4
24918 @opindex msse4
24919 @need 200
24920 @itemx -msse4a
24921 @opindex msse4a
24922 @need 200
24923 @itemx -msse4.1
24924 @opindex msse4.1
24925 @need 200
24926 @itemx -msse4.2
24927 @opindex msse4.2
24928 @need 200
24929 @itemx -mavx
24930 @opindex mavx
24931 @need 200
24932 @itemx -mavx2
24933 @opindex mavx2
24934 @need 200
24935 @itemx -mavx512f
24936 @opindex mavx512f
24937 @need 200
24938 @itemx -mavx512pf
24939 @opindex mavx512pf
24940 @need 200
24941 @itemx -mavx512er
24942 @opindex mavx512er
24943 @need 200
24944 @itemx -mavx512cd
24945 @opindex mavx512cd
24946 @need 200
24947 @itemx -mavx512vl
24948 @opindex mavx512vl
24949 @need 200
24950 @itemx -mavx512bw
24951 @opindex mavx512bw
24952 @need 200
24953 @itemx -mavx512dq
24954 @opindex mavx512dq
24955 @need 200
24956 @itemx -mavx512ifma
24957 @opindex mavx512ifma
24958 @need 200
24959 @itemx -mavx512vbmi
24960 @opindex mavx512vbmi
24961 @need 200
24962 @itemx -msha
24963 @opindex msha
24964 @need 200
24965 @itemx -maes
24966 @opindex maes
24967 @need 200
24968 @itemx -mpclmul
24969 @opindex mpclmul
24970 @need 200
24971 @itemx -mclfushopt
24972 @opindex mclfushopt
24973 @need 200
24974 @itemx -mfsgsbase
24975 @opindex mfsgsbase
24976 @need 200
24977 @itemx -mrdrnd
24978 @opindex mrdrnd
24979 @need 200
24980 @itemx -mf16c
24981 @opindex mf16c
24982 @need 200
24983 @itemx -mfma
24984 @opindex mfma
24985 @need 200
24986 @itemx -mfma4
24987 @opindex mfma4
24988 @need 200
24989 @itemx -mprefetchwt1
24990 @opindex mprefetchwt1
24991 @need 200
24992 @itemx -mxop
24993 @opindex mxop
24994 @need 200
24995 @itemx -mlwp
24996 @opindex mlwp
24997 @need 200
24998 @itemx -m3dnow
24999 @opindex m3dnow
25000 @need 200
25001 @itemx -m3dnowa
25002 @opindex m3dnowa
25003 @need 200
25004 @itemx -mpopcnt
25005 @opindex mpopcnt
25006 @need 200
25007 @itemx -mabm
25008 @opindex mabm
25009 @need 200
25010 @itemx -mbmi
25011 @opindex mbmi
25012 @need 200
25013 @itemx -mbmi2
25014 @need 200
25015 @itemx -mlzcnt
25016 @opindex mlzcnt
25017 @need 200
25018 @itemx -mfxsr
25019 @opindex mfxsr
25020 @need 200
25021 @itemx -mxsave
25022 @opindex mxsave
25023 @need 200
25024 @itemx -mxsaveopt
25025 @opindex mxsaveopt
25026 @need 200
25027 @itemx -mxsavec
25028 @opindex mxsavec
25029 @need 200
25030 @itemx -mxsaves
25031 @opindex mxsaves
25032 @need 200
25033 @itemx -mrtm
25034 @opindex mrtm
25035 @need 200
25036 @itemx -mtbm
25037 @opindex mtbm
25038 @need 200
25039 @itemx -mmpx
25040 @opindex mmpx
25041 @need 200
25042 @itemx -mmwaitx
25043 @opindex mmwaitx
25044 @need 200
25045 @itemx -mclzero
25046 @opindex mclzero
25047 @itemx -mpku
25048 @opindex mpku
25049 These switches enable the use of instructions in the MMX, SSE,
25050 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25051 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25052 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25053 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25054 extended instruction sets.  Each has a corresponding @option{-mno-} option
25055 to disable use of these instructions.
25057 These extensions are also available as built-in functions: see
25058 @ref{x86 Built-in Functions}, for details of the functions enabled and
25059 disabled by these switches.
25061 To generate SSE/SSE2 instructions automatically from floating-point
25062 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25064 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25065 generates new AVX instructions or AVX equivalence for all SSEx instructions
25066 when needed.
25068 These options enable GCC to use these extended instructions in
25069 generated code, even without @option{-mfpmath=sse}.  Applications that
25070 perform run-time CPU detection must compile separate files for each
25071 supported architecture, using the appropriate flags.  In particular,
25072 the file containing the CPU detection code should be compiled without
25073 these options.
25075 @item -mdump-tune-features
25076 @opindex mdump-tune-features
25077 This option instructs GCC to dump the names of the x86 performance 
25078 tuning features and default settings. The names can be used in 
25079 @option{-mtune-ctrl=@var{feature-list}}.
25081 @item -mtune-ctrl=@var{feature-list}
25082 @opindex mtune-ctrl=@var{feature-list}
25083 This option is used to do fine grain control of x86 code generation features.
25084 @var{feature-list} is a comma separated list of @var{feature} names. See also
25085 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25086 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25087 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25088 developers. Using it may lead to code paths not covered by testing and can
25089 potentially result in compiler ICEs or runtime errors.
25091 @item -mno-default
25092 @opindex mno-default
25093 This option instructs GCC to turn off all tunable features. See also 
25094 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25096 @item -mcld
25097 @opindex mcld
25098 This option instructs GCC to emit a @code{cld} instruction in the prologue
25099 of functions that use string instructions.  String instructions depend on
25100 the DF flag to select between autoincrement or autodecrement mode.  While the
25101 ABI specifies the DF flag to be cleared on function entry, some operating
25102 systems violate this specification by not clearing the DF flag in their
25103 exception dispatchers.  The exception handler can be invoked with the DF flag
25104 set, which leads to wrong direction mode when string instructions are used.
25105 This option can be enabled by default on 32-bit x86 targets by configuring
25106 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25107 instructions can be suppressed with the @option{-mno-cld} compiler option
25108 in this case.
25110 @item -mvzeroupper
25111 @opindex mvzeroupper
25112 This option instructs GCC to emit a @code{vzeroupper} instruction
25113 before a transfer of control flow out of the function to minimize
25114 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25115 intrinsics.
25117 @item -mprefer-avx128
25118 @opindex mprefer-avx128
25119 This option instructs GCC to use 128-bit AVX instructions instead of
25120 256-bit AVX instructions in the auto-vectorizer.
25122 @item -mcx16
25123 @opindex mcx16
25124 This option enables GCC to generate @code{CMPXCHG16B} instructions.
25125 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
25126 (or oword) data types.  
25127 This is useful for high-resolution counters that can be updated
25128 by multiple processors (or cores).  This instruction is generated as part of
25129 atomic built-in functions: see @ref{__sync Builtins} or
25130 @ref{__atomic Builtins} for details.
25132 @item -msahf
25133 @opindex msahf
25134 This option enables generation of @code{SAHF} instructions in 64-bit code.
25135 Early Intel Pentium 4 CPUs with Intel 64 support,
25136 prior to the introduction of Pentium 4 G1 step in December 2005,
25137 lacked the @code{LAHF} and @code{SAHF} instructions
25138 which are supported by AMD64.
25139 These are load and store instructions, respectively, for certain status flags.
25140 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25141 @code{drem}, and @code{remainder} built-in functions;
25142 see @ref{Other Builtins} for details.
25144 @item -mmovbe
25145 @opindex mmovbe
25146 This option enables use of the @code{movbe} instruction to implement
25147 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25149 @item -mcrc32
25150 @opindex mcrc32
25151 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25152 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25153 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25155 @item -mrecip
25156 @opindex mrecip
25157 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25158 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25159 with an additional Newton-Raphson step
25160 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25161 (and their vectorized
25162 variants) for single-precision floating-point arguments.  These instructions
25163 are generated only when @option{-funsafe-math-optimizations} is enabled
25164 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25165 Note that while the throughput of the sequence is higher than the throughput
25166 of the non-reciprocal instruction, the precision of the sequence can be
25167 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25169 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25170 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25171 combination), and doesn't need @option{-mrecip}.
25173 Also note that GCC emits the above sequence with additional Newton-Raphson step
25174 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25175 already with @option{-ffast-math} (or the above option combination), and
25176 doesn't need @option{-mrecip}.
25178 @item -mrecip=@var{opt}
25179 @opindex mrecip=opt
25180 This option controls which reciprocal estimate instructions
25181 may be used.  @var{opt} is a comma-separated list of options, which may
25182 be preceded by a @samp{!} to invert the option:
25184 @table @samp
25185 @item all
25186 Enable all estimate instructions.
25188 @item default
25189 Enable the default instructions, equivalent to @option{-mrecip}.
25191 @item none
25192 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25194 @item div
25195 Enable the approximation for scalar division.
25197 @item vec-div
25198 Enable the approximation for vectorized division.
25200 @item sqrt
25201 Enable the approximation for scalar square root.
25203 @item vec-sqrt
25204 Enable the approximation for vectorized square root.
25205 @end table
25207 So, for example, @option{-mrecip=all,!sqrt} enables
25208 all of the reciprocal approximations, except for square root.
25210 @item -mveclibabi=@var{type}
25211 @opindex mveclibabi
25212 Specifies the ABI type to use for vectorizing intrinsics using an
25213 external library.  Supported values for @var{type} are @samp{svml} 
25214 for the Intel short
25215 vector math library and @samp{acml} for the AMD math core library.
25216 To use this option, both @option{-ftree-vectorize} and
25217 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25218 ABI-compatible library must be specified at link time.
25220 GCC currently emits calls to @code{vmldExp2},
25221 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25222 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25223 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25224 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25225 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25226 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25227 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25228 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25229 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25230 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25231 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25232 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25233 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25234 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25235 when @option{-mveclibabi=acml} is used.  
25237 @item -mabi=@var{name}
25238 @opindex mabi
25239 Generate code for the specified calling convention.  Permissible values
25240 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25241 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25242 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25243 You can control this behavior for specific functions by
25244 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25245 @xref{Function Attributes}.
25247 @item -mtls-dialect=@var{type}
25248 @opindex mtls-dialect
25249 Generate code to access thread-local storage using the @samp{gnu} or
25250 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25251 @samp{gnu2} is more efficient, but it may add compile- and run-time
25252 requirements that cannot be satisfied on all systems.
25254 @item -mpush-args
25255 @itemx -mno-push-args
25256 @opindex mpush-args
25257 @opindex mno-push-args
25258 Use PUSH operations to store outgoing parameters.  This method is shorter
25259 and usually equally fast as method using SUB/MOV operations and is enabled
25260 by default.  In some cases disabling it may improve performance because of
25261 improved scheduling and reduced dependencies.
25263 @item -maccumulate-outgoing-args
25264 @opindex maccumulate-outgoing-args
25265 If enabled, the maximum amount of space required for outgoing arguments is
25266 computed in the function prologue.  This is faster on most modern CPUs
25267 because of reduced dependencies, improved scheduling and reduced stack usage
25268 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25269 increase in code size.  This switch implies @option{-mno-push-args}.
25271 @item -mthreads
25272 @opindex mthreads
25273 Support thread-safe exception handling on MinGW.  Programs that rely
25274 on thread-safe exception handling must compile and link all code with the
25275 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25276 @option{-D_MT}; when linking, it links in a special thread helper library
25277 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25279 @item -mms-bitfields
25280 @itemx -mno-ms-bitfields
25281 @opindex mms-bitfields
25282 @opindex mno-ms-bitfields
25284 Enable/disable bit-field layout compatible with the native Microsoft
25285 Windows compiler.  
25287 If @code{packed} is used on a structure, or if bit-fields are used,
25288 it may be that the Microsoft ABI lays out the structure differently
25289 than the way GCC normally does.  Particularly when moving packed
25290 data between functions compiled with GCC and the native Microsoft compiler
25291 (either via function call or as data in a file), it may be necessary to access
25292 either format.
25294 This option is enabled by default for Microsoft Windows
25295 targets.  This behavior can also be controlled locally by use of variable
25296 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25297 and @ref{x86 Type Attributes}.
25299 The Microsoft structure layout algorithm is fairly simple with the exception
25300 of the bit-field packing.  
25301 The padding and alignment of members of structures and whether a bit-field 
25302 can straddle a storage-unit boundary are determine by these rules:
25304 @enumerate
25305 @item Structure members are stored sequentially in the order in which they are
25306 declared: the first member has the lowest memory address and the last member
25307 the highest.
25309 @item Every data object has an alignment requirement.  The alignment requirement
25310 for all data except structures, unions, and arrays is either the size of the
25311 object or the current packing size (specified with either the
25312 @code{aligned} attribute or the @code{pack} pragma),
25313 whichever is less.  For structures, unions, and arrays,
25314 the alignment requirement is the largest alignment requirement of its members.
25315 Every object is allocated an offset so that:
25317 @smallexample
25318 offset % alignment_requirement == 0
25319 @end smallexample
25321 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25322 unit if the integral types are the same size and if the next bit-field fits
25323 into the current allocation unit without crossing the boundary imposed by the
25324 common alignment requirements of the bit-fields.
25325 @end enumerate
25327 MSVC interprets zero-length bit-fields in the following ways:
25329 @enumerate
25330 @item If a zero-length bit-field is inserted between two bit-fields that
25331 are normally coalesced, the bit-fields are not coalesced.
25333 For example:
25335 @smallexample
25336 struct
25337  @{
25338    unsigned long bf_1 : 12;
25339    unsigned long : 0;
25340    unsigned long bf_2 : 12;
25341  @} t1;
25342 @end smallexample
25344 @noindent
25345 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25346 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25348 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25349 alignment of the zero-length bit-field is greater than the member that follows it,
25350 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25352 For example:
25354 @smallexample
25355 struct
25356  @{
25357    char foo : 4;
25358    short : 0;
25359    char bar;
25360  @} t2;
25362 struct
25363  @{
25364    char foo : 4;
25365    short : 0;
25366    double bar;
25367  @} t3;
25368 @end smallexample
25370 @noindent
25371 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25372 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25373 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25374 of the structure.
25376 Taking this into account, it is important to note the following:
25378 @enumerate
25379 @item If a zero-length bit-field follows a normal bit-field, the type of the
25380 zero-length bit-field may affect the alignment of the structure as whole. For
25381 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25382 normal bit-field, and is of type short.
25384 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25385 still affect the alignment of the structure:
25387 @smallexample
25388 struct
25389  @{
25390    char foo : 6;
25391    long : 0;
25392  @} t4;
25393 @end smallexample
25395 @noindent
25396 Here, @code{t4} takes up 4 bytes.
25397 @end enumerate
25399 @item Zero-length bit-fields following non-bit-field members are ignored:
25401 @smallexample
25402 struct
25403  @{
25404    char foo;
25405    long : 0;
25406    char bar;
25407  @} t5;
25408 @end smallexample
25410 @noindent
25411 Here, @code{t5} takes up 2 bytes.
25412 @end enumerate
25415 @item -mno-align-stringops
25416 @opindex mno-align-stringops
25417 Do not align the destination of inlined string operations.  This switch reduces
25418 code size and improves performance in case the destination is already aligned,
25419 but GCC doesn't know about it.
25421 @item -minline-all-stringops
25422 @opindex minline-all-stringops
25423 By default GCC inlines string operations only when the destination is 
25424 known to be aligned to least a 4-byte boundary.  
25425 This enables more inlining and increases code
25426 size, but may improve performance of code that depends on fast
25427 @code{memcpy}, @code{strlen},
25428 and @code{memset} for short lengths.
25430 @item -minline-stringops-dynamically
25431 @opindex minline-stringops-dynamically
25432 For string operations of unknown size, use run-time checks with
25433 inline code for small blocks and a library call for large blocks.
25435 @item -mstringop-strategy=@var{alg}
25436 @opindex mstringop-strategy=@var{alg}
25437 Override the internal decision heuristic for the particular algorithm to use
25438 for inlining string operations.  The allowed values for @var{alg} are:
25440 @table @samp
25441 @item rep_byte
25442 @itemx rep_4byte
25443 @itemx rep_8byte
25444 Expand using i386 @code{rep} prefix of the specified size.
25446 @item byte_loop
25447 @itemx loop
25448 @itemx unrolled_loop
25449 Expand into an inline loop.
25451 @item libcall
25452 Always use a library call.
25453 @end table
25455 @item -mmemcpy-strategy=@var{strategy}
25456 @opindex mmemcpy-strategy=@var{strategy}
25457 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25458 should be inlined and what inline algorithm to use when the expected size
25459 of the copy operation is known. @var{strategy} 
25460 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25461 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25462 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25463 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25464 in the list must be specified in increasing order.  The minimal byte size for 
25465 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25466 preceding range.
25468 @item -mmemset-strategy=@var{strategy}
25469 @opindex mmemset-strategy=@var{strategy}
25470 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25471 @code{__builtin_memset} expansion.
25473 @item -momit-leaf-frame-pointer
25474 @opindex momit-leaf-frame-pointer
25475 Don't keep the frame pointer in a register for leaf functions.  This
25476 avoids the instructions to save, set up, and restore frame pointers and
25477 makes an extra register available in leaf functions.  The option
25478 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25479 which might make debugging harder.
25481 @item -mtls-direct-seg-refs
25482 @itemx -mno-tls-direct-seg-refs
25483 @opindex mtls-direct-seg-refs
25484 Controls whether TLS variables may be accessed with offsets from the
25485 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25486 or whether the thread base pointer must be added.  Whether or not this
25487 is valid depends on the operating system, and whether it maps the
25488 segment to cover the entire TLS area.
25490 For systems that use the GNU C Library, the default is on.
25492 @item -msse2avx
25493 @itemx -mno-sse2avx
25494 @opindex msse2avx
25495 Specify that the assembler should encode SSE instructions with VEX
25496 prefix.  The option @option{-mavx} turns this on by default.
25498 @item -mfentry
25499 @itemx -mno-fentry
25500 @opindex mfentry
25501 If profiling is active (@option{-pg}), put the profiling
25502 counter call before the prologue.
25503 Note: On x86 architectures the attribute @code{ms_hook_prologue}
25504 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
25506 @item -mrecord-mcount
25507 @itemx -mno-record-mcount
25508 @opindex mrecord-mcount
25509 If profiling is active (@option{-pg}), generate a __mcount_loc section
25510 that contains pointers to each profiling call. This is useful for
25511 automatically patching and out calls.
25513 @item -mnop-mcount
25514 @itemx -mno-nop-mcount
25515 @opindex mnop-mcount
25516 If profiling is active (@option{-pg}), generate the calls to
25517 the profiling functions as NOPs. This is useful when they
25518 should be patched in later dynamically. This is likely only
25519 useful together with @option{-mrecord-mcount}.
25521 @item -mskip-rax-setup
25522 @itemx -mno-skip-rax-setup
25523 @opindex mskip-rax-setup
25524 When generating code for the x86-64 architecture with SSE extensions
25525 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
25526 register when there are no variable arguments passed in vector registers.
25528 @strong{Warning:} Since RAX register is used to avoid unnecessarily
25529 saving vector registers on stack when passing variable arguments, the
25530 impacts of this option are callees may waste some stack space,
25531 misbehave or jump to a random location.  GCC 4.4 or newer don't have
25532 those issues, regardless the RAX register value.
25534 @item -m8bit-idiv
25535 @itemx -mno-8bit-idiv
25536 @opindex m8bit-idiv
25537 On some processors, like Intel Atom, 8-bit unsigned integer divide is
25538 much faster than 32-bit/64-bit integer divide.  This option generates a
25539 run-time check.  If both dividend and divisor are within range of 0
25540 to 255, 8-bit unsigned integer divide is used instead of
25541 32-bit/64-bit integer divide.
25543 @item -mavx256-split-unaligned-load
25544 @itemx -mavx256-split-unaligned-store
25545 @opindex mavx256-split-unaligned-load
25546 @opindex mavx256-split-unaligned-store
25547 Split 32-byte AVX unaligned load and store.
25549 @item -mstack-protector-guard=@var{guard}
25550 @opindex mstack-protector-guard=@var{guard}
25551 Generate stack protection code using canary at @var{guard}.  Supported
25552 locations are @samp{global} for global canary or @samp{tls} for per-thread
25553 canary in the TLS block (the default).  This option has effect only when
25554 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
25556 @item -mmitigate-rop
25557 @opindex mmitigate-rop
25558 Try to avoid generating code sequences that contain unintended return
25559 opcodes, to mitigate against certain forms of attack. At the moment,
25560 this option is limited in what it can do and should not be relied
25561 on to provide serious protection.
25563 @item -mgeneral-regs-only
25564 @opindex mgeneral-regs-only
25565 Generate code that uses only the general-purpose registers.  This
25566 prevents the compiler from using floating-point, vector, mask and bound
25567 registers.
25569 @end table
25571 These @samp{-m} switches are supported in addition to the above
25572 on x86-64 processors in 64-bit environments.
25574 @table @gcctabopt
25575 @item -m32
25576 @itemx -m64
25577 @itemx -mx32
25578 @itemx -m16
25579 @itemx -miamcu
25580 @opindex m32
25581 @opindex m64
25582 @opindex mx32
25583 @opindex m16
25584 @opindex miamcu
25585 Generate code for a 16-bit, 32-bit or 64-bit environment.
25586 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
25587 to 32 bits, and
25588 generates code that runs on any i386 system.
25590 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
25591 types to 64 bits, and generates code for the x86-64 architecture.
25592 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
25593 and @option{-mdynamic-no-pic} options.
25595 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
25596 to 32 bits, and
25597 generates code for the x86-64 architecture.
25599 The @option{-m16} option is the same as @option{-m32}, except for that
25600 it outputs the @code{.code16gcc} assembly directive at the beginning of
25601 the assembly output so that the binary can run in 16-bit mode.
25603 The @option{-miamcu} option generates code which conforms to Intel MCU
25604 psABI.  It requires the @option{-m32} option to be turned on.
25606 @item -mno-red-zone
25607 @opindex mno-red-zone
25608 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
25609 by the x86-64 ABI; it is a 128-byte area beyond the location of the
25610 stack pointer that is not modified by signal or interrupt handlers
25611 and therefore can be used for temporary data without adjusting the stack
25612 pointer.  The flag @option{-mno-red-zone} disables this red zone.
25614 @item -mcmodel=small
25615 @opindex mcmodel=small
25616 Generate code for the small code model: the program and its symbols must
25617 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
25618 Programs can be statically or dynamically linked.  This is the default
25619 code model.
25621 @item -mcmodel=kernel
25622 @opindex mcmodel=kernel
25623 Generate code for the kernel code model.  The kernel runs in the
25624 negative 2 GB of the address space.
25625 This model has to be used for Linux kernel code.
25627 @item -mcmodel=medium
25628 @opindex mcmodel=medium
25629 Generate code for the medium model: the program is linked in the lower 2
25630 GB of the address space.  Small symbols are also placed there.  Symbols
25631 with sizes larger than @option{-mlarge-data-threshold} are put into
25632 large data or BSS sections and can be located above 2GB.  Programs can
25633 be statically or dynamically linked.
25635 @item -mcmodel=large
25636 @opindex mcmodel=large
25637 Generate code for the large model.  This model makes no assumptions
25638 about addresses and sizes of sections.
25640 @item -maddress-mode=long
25641 @opindex maddress-mode=long
25642 Generate code for long address mode.  This is only supported for 64-bit
25643 and x32 environments.  It is the default address mode for 64-bit
25644 environments.
25646 @item -maddress-mode=short
25647 @opindex maddress-mode=short
25648 Generate code for short address mode.  This is only supported for 32-bit
25649 and x32 environments.  It is the default address mode for 32-bit and
25650 x32 environments.
25651 @end table
25653 @node x86 Windows Options
25654 @subsection x86 Windows Options
25655 @cindex x86 Windows Options
25656 @cindex Windows Options for x86
25658 These additional options are available for Microsoft Windows targets:
25660 @table @gcctabopt
25661 @item -mconsole
25662 @opindex mconsole
25663 This option
25664 specifies that a console application is to be generated, by
25665 instructing the linker to set the PE header subsystem type
25666 required for console applications.
25667 This option is available for Cygwin and MinGW targets and is
25668 enabled by default on those targets.
25670 @item -mdll
25671 @opindex mdll
25672 This option is available for Cygwin and MinGW targets.  It
25673 specifies that a DLL---a dynamic link library---is to be
25674 generated, enabling the selection of the required runtime
25675 startup object and entry point.
25677 @item -mnop-fun-dllimport
25678 @opindex mnop-fun-dllimport
25679 This option is available for Cygwin and MinGW targets.  It
25680 specifies that the @code{dllimport} attribute should be ignored.
25682 @item -mthread
25683 @opindex mthread
25684 This option is available for MinGW targets. It specifies
25685 that MinGW-specific thread support is to be used.
25687 @item -municode
25688 @opindex municode
25689 This option is available for MinGW-w64 targets.  It causes
25690 the @code{UNICODE} preprocessor macro to be predefined, and
25691 chooses Unicode-capable runtime startup code.
25693 @item -mwin32
25694 @opindex mwin32
25695 This option is available for Cygwin and MinGW targets.  It
25696 specifies that the typical Microsoft Windows predefined macros are to
25697 be set in the pre-processor, but does not influence the choice
25698 of runtime library/startup code.
25700 @item -mwindows
25701 @opindex mwindows
25702 This option is available for Cygwin and MinGW targets.  It
25703 specifies that a GUI application is to be generated by
25704 instructing the linker to set the PE header subsystem type
25705 appropriately.
25707 @item -fno-set-stack-executable
25708 @opindex fno-set-stack-executable
25709 This option is available for MinGW targets. It specifies that
25710 the executable flag for the stack used by nested functions isn't
25711 set. This is necessary for binaries running in kernel mode of
25712 Microsoft Windows, as there the User32 API, which is used to set executable
25713 privileges, isn't available.
25715 @item -fwritable-relocated-rdata
25716 @opindex fno-writable-relocated-rdata
25717 This option is available for MinGW and Cygwin targets.  It specifies
25718 that relocated-data in read-only section is put into the @code{.data}
25719 section.  This is a necessary for older runtimes not supporting
25720 modification of @code{.rdata} sections for pseudo-relocation.
25722 @item -mpe-aligned-commons
25723 @opindex mpe-aligned-commons
25724 This option is available for Cygwin and MinGW targets.  It
25725 specifies that the GNU extension to the PE file format that
25726 permits the correct alignment of COMMON variables should be
25727 used when generating code.  It is enabled by default if
25728 GCC detects that the target assembler found during configuration
25729 supports the feature.
25730 @end table
25732 See also under @ref{x86 Options} for standard options.
25734 @node Xstormy16 Options
25735 @subsection Xstormy16 Options
25736 @cindex Xstormy16 Options
25738 These options are defined for Xstormy16:
25740 @table @gcctabopt
25741 @item -msim
25742 @opindex msim
25743 Choose startup files and linker script suitable for the simulator.
25744 @end table
25746 @node Xtensa Options
25747 @subsection Xtensa Options
25748 @cindex Xtensa Options
25750 These options are supported for Xtensa targets:
25752 @table @gcctabopt
25753 @item -mconst16
25754 @itemx -mno-const16
25755 @opindex mconst16
25756 @opindex mno-const16
25757 Enable or disable use of @code{CONST16} instructions for loading
25758 constant values.  The @code{CONST16} instruction is currently not a
25759 standard option from Tensilica.  When enabled, @code{CONST16}
25760 instructions are always used in place of the standard @code{L32R}
25761 instructions.  The use of @code{CONST16} is enabled by default only if
25762 the @code{L32R} instruction is not available.
25764 @item -mfused-madd
25765 @itemx -mno-fused-madd
25766 @opindex mfused-madd
25767 @opindex mno-fused-madd
25768 Enable or disable use of fused multiply/add and multiply/subtract
25769 instructions in the floating-point option.  This has no effect if the
25770 floating-point option is not also enabled.  Disabling fused multiply/add
25771 and multiply/subtract instructions forces the compiler to use separate
25772 instructions for the multiply and add/subtract operations.  This may be
25773 desirable in some cases where strict IEEE 754-compliant results are
25774 required: the fused multiply add/subtract instructions do not round the
25775 intermediate result, thereby producing results with @emph{more} bits of
25776 precision than specified by the IEEE standard.  Disabling fused multiply
25777 add/subtract instructions also ensures that the program output is not
25778 sensitive to the compiler's ability to combine multiply and add/subtract
25779 operations.
25781 @item -mserialize-volatile
25782 @itemx -mno-serialize-volatile
25783 @opindex mserialize-volatile
25784 @opindex mno-serialize-volatile
25785 When this option is enabled, GCC inserts @code{MEMW} instructions before
25786 @code{volatile} memory references to guarantee sequential consistency.
25787 The default is @option{-mserialize-volatile}.  Use
25788 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
25790 @item -mforce-no-pic
25791 @opindex mforce-no-pic
25792 For targets, like GNU/Linux, where all user-mode Xtensa code must be
25793 position-independent code (PIC), this option disables PIC for compiling
25794 kernel code.
25796 @item -mtext-section-literals
25797 @itemx -mno-text-section-literals
25798 @opindex mtext-section-literals
25799 @opindex mno-text-section-literals
25800 These options control the treatment of literal pools.  The default is
25801 @option{-mno-text-section-literals}, which places literals in a separate
25802 section in the output file.  This allows the literal pool to be placed
25803 in a data RAM/ROM, and it also allows the linker to combine literal
25804 pools from separate object files to remove redundant literals and
25805 improve code size.  With @option{-mtext-section-literals}, the literals
25806 are interspersed in the text section in order to keep them as close as
25807 possible to their references.  This may be necessary for large assembly
25808 files.  Literals for each function are placed right before that function.
25810 @item -mauto-litpools
25811 @itemx -mno-auto-litpools
25812 @opindex mauto-litpools
25813 @opindex mno-auto-litpools
25814 These options control the treatment of literal pools.  The default is
25815 @option{-mno-auto-litpools}, which places literals in a separate
25816 section in the output file unless @option{-mtext-section-literals} is
25817 used.  With @option{-mauto-litpools} the literals are interspersed in
25818 the text section by the assembler.  Compiler does not produce explicit
25819 @code{.literal} directives and loads literals into registers with
25820 @code{MOVI} instructions instead of @code{L32R} to let the assembler
25821 do relaxation and place literals as necessary.  This option allows
25822 assembler to create several literal pools per function and assemble
25823 very big functions, which may not be possible with
25824 @option{-mtext-section-literals}.
25826 @item -mtarget-align
25827 @itemx -mno-target-align
25828 @opindex mtarget-align
25829 @opindex mno-target-align
25830 When this option is enabled, GCC instructs the assembler to
25831 automatically align instructions to reduce branch penalties at the
25832 expense of some code density.  The assembler attempts to widen density
25833 instructions to align branch targets and the instructions following call
25834 instructions.  If there are not enough preceding safe density
25835 instructions to align a target, no widening is performed.  The
25836 default is @option{-mtarget-align}.  These options do not affect the
25837 treatment of auto-aligned instructions like @code{LOOP}, which the
25838 assembler always aligns, either by widening density instructions or
25839 by inserting NOP instructions.
25841 @item -mlongcalls
25842 @itemx -mno-longcalls
25843 @opindex mlongcalls
25844 @opindex mno-longcalls
25845 When this option is enabled, GCC instructs the assembler to translate
25846 direct calls to indirect calls unless it can determine that the target
25847 of a direct call is in the range allowed by the call instruction.  This
25848 translation typically occurs for calls to functions in other source
25849 files.  Specifically, the assembler translates a direct @code{CALL}
25850 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
25851 The default is @option{-mno-longcalls}.  This option should be used in
25852 programs where the call target can potentially be out of range.  This
25853 option is implemented in the assembler, not the compiler, so the
25854 assembly code generated by GCC still shows direct call
25855 instructions---look at the disassembled object code to see the actual
25856 instructions.  Note that the assembler uses an indirect call for
25857 every cross-file call, not just those that really are out of range.
25858 @end table
25860 @node zSeries Options
25861 @subsection zSeries Options
25862 @cindex zSeries options
25864 These are listed under @xref{S/390 and zSeries Options}.
25867 @c man end
25869 @node Spec Files
25870 @section Specifying Subprocesses and the Switches to Pass to Them
25871 @cindex Spec Files
25873 @command{gcc} is a driver program.  It performs its job by invoking a
25874 sequence of other programs to do the work of compiling, assembling and
25875 linking.  GCC interprets its command-line parameters and uses these to
25876 deduce which programs it should invoke, and which command-line options
25877 it ought to place on their command lines.  This behavior is controlled
25878 by @dfn{spec strings}.  In most cases there is one spec string for each
25879 program that GCC can invoke, but a few programs have multiple spec
25880 strings to control their behavior.  The spec strings built into GCC can
25881 be overridden by using the @option{-specs=} command-line switch to specify
25882 a spec file.
25884 @dfn{Spec files} are plain-text files that are used to construct spec
25885 strings.  They consist of a sequence of directives separated by blank
25886 lines.  The type of directive is determined by the first non-whitespace
25887 character on the line, which can be one of the following:
25889 @table @code
25890 @item %@var{command}
25891 Issues a @var{command} to the spec file processor.  The commands that can
25892 appear here are:
25894 @table @code
25895 @item %include <@var{file}>
25896 @cindex @code{%include}
25897 Search for @var{file} and insert its text at the current point in the
25898 specs file.
25900 @item %include_noerr <@var{file}>
25901 @cindex @code{%include_noerr}
25902 Just like @samp{%include}, but do not generate an error message if the include
25903 file cannot be found.
25905 @item %rename @var{old_name} @var{new_name}
25906 @cindex @code{%rename}
25907 Rename the spec string @var{old_name} to @var{new_name}.
25909 @end table
25911 @item *[@var{spec_name}]:
25912 This tells the compiler to create, override or delete the named spec
25913 string.  All lines after this directive up to the next directive or
25914 blank line are considered to be the text for the spec string.  If this
25915 results in an empty string then the spec is deleted.  (Or, if the
25916 spec did not exist, then nothing happens.)  Otherwise, if the spec
25917 does not currently exist a new spec is created.  If the spec does
25918 exist then its contents are overridden by the text of this
25919 directive, unless the first character of that text is the @samp{+}
25920 character, in which case the text is appended to the spec.
25922 @item [@var{suffix}]:
25923 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
25924 and up to the next directive or blank line are considered to make up the
25925 spec string for the indicated suffix.  When the compiler encounters an
25926 input file with the named suffix, it processes the spec string in
25927 order to work out how to compile that file.  For example:
25929 @smallexample
25930 .ZZ:
25931 z-compile -input %i
25932 @end smallexample
25934 This says that any input file whose name ends in @samp{.ZZ} should be
25935 passed to the program @samp{z-compile}, which should be invoked with the
25936 command-line switch @option{-input} and with the result of performing the
25937 @samp{%i} substitution.  (See below.)
25939 As an alternative to providing a spec string, the text following a
25940 suffix directive can be one of the following:
25942 @table @code
25943 @item @@@var{language}
25944 This says that the suffix is an alias for a known @var{language}.  This is
25945 similar to using the @option{-x} command-line switch to GCC to specify a
25946 language explicitly.  For example:
25948 @smallexample
25949 .ZZ:
25950 @@c++
25951 @end smallexample
25953 Says that .ZZ files are, in fact, C++ source files.
25955 @item #@var{name}
25956 This causes an error messages saying:
25958 @smallexample
25959 @var{name} compiler not installed on this system.
25960 @end smallexample
25961 @end table
25963 GCC already has an extensive list of suffixes built into it.
25964 This directive adds an entry to the end of the list of suffixes, but
25965 since the list is searched from the end backwards, it is effectively
25966 possible to override earlier entries using this technique.
25968 @end table
25970 GCC has the following spec strings built into it.  Spec files can
25971 override these strings or create their own.  Note that individual
25972 targets can also add their own spec strings to this list.
25974 @smallexample
25975 asm          Options to pass to the assembler
25976 asm_final    Options to pass to the assembler post-processor
25977 cpp          Options to pass to the C preprocessor
25978 cc1          Options to pass to the C compiler
25979 cc1plus      Options to pass to the C++ compiler
25980 endfile      Object files to include at the end of the link
25981 link         Options to pass to the linker
25982 lib          Libraries to include on the command line to the linker
25983 libgcc       Decides which GCC support library to pass to the linker
25984 linker       Sets the name of the linker
25985 predefines   Defines to be passed to the C preprocessor
25986 signed_char  Defines to pass to CPP to say whether @code{char} is signed
25987              by default
25988 startfile    Object files to include at the start of the link
25989 @end smallexample
25991 Here is a small example of a spec file:
25993 @smallexample
25994 %rename lib                 old_lib
25996 *lib:
25997 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
25998 @end smallexample
26000 This example renames the spec called @samp{lib} to @samp{old_lib} and
26001 then overrides the previous definition of @samp{lib} with a new one.
26002 The new definition adds in some extra command-line options before
26003 including the text of the old definition.
26005 @dfn{Spec strings} are a list of command-line options to be passed to their
26006 corresponding program.  In addition, the spec strings can contain
26007 @samp{%}-prefixed sequences to substitute variable text or to
26008 conditionally insert text into the command line.  Using these constructs
26009 it is possible to generate quite complex command lines.
26011 Here is a table of all defined @samp{%}-sequences for spec
26012 strings.  Note that spaces are not generated automatically around the
26013 results of expanding these sequences.  Therefore you can concatenate them
26014 together or combine them with constant text in a single argument.
26016 @table @code
26017 @item %%
26018 Substitute one @samp{%} into the program name or argument.
26020 @item %i
26021 Substitute the name of the input file being processed.
26023 @item %b
26024 Substitute the basename of the input file being processed.
26025 This is the substring up to (and not including) the last period
26026 and not including the directory.
26028 @item %B
26029 This is the same as @samp{%b}, but include the file suffix (text after
26030 the last period).
26032 @item %d
26033 Marks the argument containing or following the @samp{%d} as a
26034 temporary file name, so that that file is deleted if GCC exits
26035 successfully.  Unlike @samp{%g}, this contributes no text to the
26036 argument.
26038 @item %g@var{suffix}
26039 Substitute a file name that has suffix @var{suffix} and is chosen
26040 once per compilation, and mark the argument in the same way as
26041 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26042 name is now chosen in a way that is hard to predict even when previously
26043 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26044 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26045 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26046 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26047 was simply substituted with a file name chosen once per compilation,
26048 without regard to any appended suffix (which was therefore treated
26049 just like ordinary text), making such attacks more likely to succeed.
26051 @item %u@var{suffix}
26052 Like @samp{%g}, but generates a new temporary file name
26053 each time it appears instead of once per compilation.
26055 @item %U@var{suffix}
26056 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26057 new one if there is no such last file name.  In the absence of any
26058 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26059 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26060 involves the generation of two distinct file names, one
26061 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26062 simply substituted with a file name chosen for the previous @samp{%u},
26063 without regard to any appended suffix.
26065 @item %j@var{suffix}
26066 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26067 writable, and if @option{-save-temps} is not used; 
26068 otherwise, substitute the name
26069 of a temporary file, just like @samp{%u}.  This temporary file is not
26070 meant for communication between processes, but rather as a junk
26071 disposal mechanism.
26073 @item %|@var{suffix}
26074 @itemx %m@var{suffix}
26075 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26076 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26077 all.  These are the two most common ways to instruct a program that it
26078 should read from standard input or write to standard output.  If you
26079 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26080 construct: see for example @file{f/lang-specs.h}.
26082 @item %.@var{SUFFIX}
26083 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26084 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26085 terminated by the next space or %.
26087 @item %w
26088 Marks the argument containing or following the @samp{%w} as the
26089 designated output file of this compilation.  This puts the argument
26090 into the sequence of arguments that @samp{%o} substitutes.
26092 @item %o
26093 Substitutes the names of all the output files, with spaces
26094 automatically placed around them.  You should write spaces
26095 around the @samp{%o} as well or the results are undefined.
26096 @samp{%o} is for use in the specs for running the linker.
26097 Input files whose names have no recognized suffix are not compiled
26098 at all, but they are included among the output files, so they are
26099 linked.
26101 @item %O
26102 Substitutes the suffix for object files.  Note that this is
26103 handled specially when it immediately follows @samp{%g, %u, or %U},
26104 because of the need for those to form complete file names.  The
26105 handling is such that @samp{%O} is treated exactly as if it had already
26106 been substituted, except that @samp{%g, %u, and %U} do not currently
26107 support additional @var{suffix} characters following @samp{%O} as they do
26108 following, for example, @samp{.o}.
26110 @item %p
26111 Substitutes the standard macro predefinitions for the
26112 current target machine.  Use this when running @command{cpp}.
26114 @item %P
26115 Like @samp{%p}, but puts @samp{__} before and after the name of each
26116 predefined macro, except for macros that start with @samp{__} or with
26117 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26120 @item %I
26121 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26122 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26123 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26124 and @option{-imultilib} as necessary.
26126 @item %s
26127 Current argument is the name of a library or startup file of some sort.
26128 Search for that file in a standard list of directories and substitute
26129 the full name found.  The current working directory is included in the
26130 list of directories scanned.
26132 @item %T
26133 Current argument is the name of a linker script.  Search for that file
26134 in the current list of directories to scan for libraries. If the file
26135 is located insert a @option{--script} option into the command line
26136 followed by the full path name found.  If the file is not found then
26137 generate an error message.  Note: the current working directory is not
26138 searched.
26140 @item %e@var{str}
26141 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26142 Use this when inconsistent options are detected.
26144 @item %(@var{name})
26145 Substitute the contents of spec string @var{name} at this point.
26147 @item %x@{@var{option}@}
26148 Accumulate an option for @samp{%X}.
26150 @item %X
26151 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26152 spec string.
26154 @item %Y
26155 Output the accumulated assembler options specified by @option{-Wa}.
26157 @item %Z
26158 Output the accumulated preprocessor options specified by @option{-Wp}.
26160 @item %a
26161 Process the @code{asm} spec.  This is used to compute the
26162 switches to be passed to the assembler.
26164 @item %A
26165 Process the @code{asm_final} spec.  This is a spec string for
26166 passing switches to an assembler post-processor, if such a program is
26167 needed.
26169 @item %l
26170 Process the @code{link} spec.  This is the spec for computing the
26171 command line passed to the linker.  Typically it makes use of the
26172 @samp{%L %G %S %D and %E} sequences.
26174 @item %D
26175 Dump out a @option{-L} option for each directory that GCC believes might
26176 contain startup files.  If the target supports multilibs then the
26177 current multilib directory is prepended to each of these paths.
26179 @item %L
26180 Process the @code{lib} spec.  This is a spec string for deciding which
26181 libraries are included on the command line to the linker.
26183 @item %G
26184 Process the @code{libgcc} spec.  This is a spec string for deciding
26185 which GCC support library is included on the command line to the linker.
26187 @item %S
26188 Process the @code{startfile} spec.  This is a spec for deciding which
26189 object files are the first ones passed to the linker.  Typically
26190 this might be a file named @file{crt0.o}.
26192 @item %E
26193 Process the @code{endfile} spec.  This is a spec string that specifies
26194 the last object files that are passed to the linker.
26196 @item %C
26197 Process the @code{cpp} spec.  This is used to construct the arguments
26198 to be passed to the C preprocessor.
26200 @item %1
26201 Process the @code{cc1} spec.  This is used to construct the options to be
26202 passed to the actual C compiler (@command{cc1}).
26204 @item %2
26205 Process the @code{cc1plus} spec.  This is used to construct the options to be
26206 passed to the actual C++ compiler (@command{cc1plus}).
26208 @item %*
26209 Substitute the variable part of a matched option.  See below.
26210 Note that each comma in the substituted string is replaced by
26211 a single space.
26213 @item %<@code{S}
26214 Remove all occurrences of @code{-S} from the command line.  Note---this
26215 command is position dependent.  @samp{%} commands in the spec string
26216 before this one see @code{-S}, @samp{%} commands in the spec string
26217 after this one do not.
26219 @item %:@var{function}(@var{args})
26220 Call the named function @var{function}, passing it @var{args}.
26221 @var{args} is first processed as a nested spec string, then split
26222 into an argument vector in the usual fashion.  The function returns
26223 a string which is processed as if it had appeared literally as part
26224 of the current spec.
26226 The following built-in spec functions are provided:
26228 @table @code
26229 @item @code{getenv}
26230 The @code{getenv} spec function takes two arguments: an environment
26231 variable name and a string.  If the environment variable is not
26232 defined, a fatal error is issued.  Otherwise, the return value is the
26233 value of the environment variable concatenated with the string.  For
26234 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26236 @smallexample
26237 %:getenv(TOPDIR /include)
26238 @end smallexample
26240 expands to @file{/path/to/top/include}.
26242 @item @code{if-exists}
26243 The @code{if-exists} spec function takes one argument, an absolute
26244 pathname to a file.  If the file exists, @code{if-exists} returns the
26245 pathname.  Here is a small example of its usage:
26247 @smallexample
26248 *startfile:
26249 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26250 @end smallexample
26252 @item @code{if-exists-else}
26253 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26254 spec function, except that it takes two arguments.  The first argument is
26255 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26256 returns the pathname.  If it does not exist, it returns the second argument.
26257 This way, @code{if-exists-else} can be used to select one file or another,
26258 based on the existence of the first.  Here is a small example of its usage:
26260 @smallexample
26261 *startfile:
26262 crt0%O%s %:if-exists(crti%O%s) \
26263 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26264 @end smallexample
26266 @item @code{replace-outfile}
26267 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26268 first argument in the outfiles array and replaces it with the second argument.  Here
26269 is a small example of its usage:
26271 @smallexample
26272 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26273 @end smallexample
26275 @item @code{remove-outfile}
26276 The @code{remove-outfile} spec function takes one argument.  It looks for the
26277 first argument in the outfiles array and removes it.  Here is a small example
26278 its usage:
26280 @smallexample
26281 %:remove-outfile(-lm)
26282 @end smallexample
26284 @item @code{pass-through-libs}
26285 The @code{pass-through-libs} spec function takes any number of arguments.  It
26286 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26287 assumes are the names of linker input library archive files) and returns a
26288 result containing all the found arguments each prepended by
26289 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26290 intended to be passed to the LTO linker plugin.
26292 @smallexample
26293 %:pass-through-libs(%G %L %G)
26294 @end smallexample
26296 @item @code{print-asm-header}
26297 The @code{print-asm-header} function takes no arguments and simply
26298 prints a banner like:
26300 @smallexample
26301 Assembler options
26302 =================
26304 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26305 @end smallexample
26307 It is used to separate compiler options from assembler options
26308 in the @option{--target-help} output.
26309 @end table
26311 @item %@{@code{S}@}
26312 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26313 If that switch is not specified, this substitutes nothing.  Note that
26314 the leading dash is omitted when specifying this option, and it is
26315 automatically inserted if the substitution is performed.  Thus the spec
26316 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26317 and outputs the command-line option @option{-foo}.
26319 @item %W@{@code{S}@}
26320 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26321 deleted on failure.
26323 @item %@{@code{S}*@}
26324 Substitutes all the switches specified to GCC whose names start
26325 with @code{-S}, but which also take an argument.  This is used for
26326 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26327 GCC considers @option{-o foo} as being
26328 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26329 text, including the space.  Thus two arguments are generated.
26331 @item %@{@code{S}*&@code{T}*@}
26332 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26333 (the order of @code{S} and @code{T} in the spec is not significant).
26334 There can be any number of ampersand-separated variables; for each the
26335 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26337 @item %@{@code{S}:@code{X}@}
26338 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26340 @item %@{!@code{S}:@code{X}@}
26341 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26343 @item %@{@code{S}*:@code{X}@}
26344 Substitutes @code{X} if one or more switches whose names start with
26345 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26346 once, no matter how many such switches appeared.  However, if @code{%*}
26347 appears somewhere in @code{X}, then @code{X} is substituted once
26348 for each matching switch, with the @code{%*} replaced by the part of
26349 that switch matching the @code{*}.
26351 If @code{%*} appears as the last part of a spec sequence then a space
26352 is added after the end of the last substitution.  If there is more
26353 text in the sequence, however, then a space is not generated.  This
26354 allows the @code{%*} substitution to be used as part of a larger
26355 string.  For example, a spec string like this:
26357 @smallexample
26358 %@{mcu=*:--script=%*/memory.ld@}
26359 @end smallexample
26361 @noindent
26362 when matching an option like @option{-mcu=newchip} produces:
26364 @smallexample
26365 --script=newchip/memory.ld
26366 @end smallexample
26368 @item %@{.@code{S}:@code{X}@}
26369 Substitutes @code{X}, if processing a file with suffix @code{S}.
26371 @item %@{!.@code{S}:@code{X}@}
26372 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26374 @item %@{,@code{S}:@code{X}@}
26375 Substitutes @code{X}, if processing a file for language @code{S}.
26377 @item %@{!,@code{S}:@code{X}@}
26378 Substitutes @code{X}, if not processing a file for language @code{S}.
26380 @item %@{@code{S}|@code{P}:@code{X}@}
26381 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26382 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26383 @code{*} sequences as well, although they have a stronger binding than
26384 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26385 alternatives must be starred, and only the first matching alternative
26386 is substituted.
26388 For example, a spec string like this:
26390 @smallexample
26391 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26392 @end smallexample
26394 @noindent
26395 outputs the following command-line options from the following input
26396 command-line options:
26398 @smallexample
26399 fred.c        -foo -baz
26400 jim.d         -bar -boggle
26401 -d fred.c     -foo -baz -boggle
26402 -d jim.d      -bar -baz -boggle
26403 @end smallexample
26405 @item %@{S:X; T:Y; :D@}
26407 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26408 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26409 be as many clauses as you need.  This may be combined with @code{.},
26410 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26413 @end table
26415 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
26416 construct may contain other nested @samp{%} constructs or spaces, or
26417 even newlines.  They are processed as usual, as described above.
26418 Trailing white space in @code{X} is ignored.  White space may also
26419 appear anywhere on the left side of the colon in these constructs,
26420 except between @code{.} or @code{*} and the corresponding word.
26422 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26423 handled specifically in these constructs.  If another value of
26424 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26425 @option{-W} switch is found later in the command line, the earlier
26426 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26427 just one letter, which passes all matching options.
26429 The character @samp{|} at the beginning of the predicate text is used to
26430 indicate that a command should be piped to the following command, but
26431 only if @option{-pipe} is specified.
26433 It is built into GCC which switches take arguments and which do not.
26434 (You might think it would be useful to generalize this to allow each
26435 compiler's spec to say which switches take arguments.  But this cannot
26436 be done in a consistent fashion.  GCC cannot even decide which input
26437 files have been specified without knowing which switches take arguments,
26438 and it must know which input files to compile in order to tell which
26439 compilers to run).
26441 GCC also knows implicitly that arguments starting in @option{-l} are to be
26442 treated as compiler output files, and passed to the linker in their
26443 proper position among the other output files.
26445 @node Environment Variables
26446 @section Environment Variables Affecting GCC
26447 @cindex environment variables
26449 @c man begin ENVIRONMENT
26450 This section describes several environment variables that affect how GCC
26451 operates.  Some of them work by specifying directories or prefixes to use
26452 when searching for various kinds of files.  Some are used to specify other
26453 aspects of the compilation environment.
26455 Note that you can also specify places to search using options such as
26456 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26457 take precedence over places specified using environment variables, which
26458 in turn take precedence over those specified by the configuration of GCC@.
26459 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26460 GNU Compiler Collection (GCC) Internals}.
26462 @table @env
26463 @item LANG
26464 @itemx LC_CTYPE
26465 @c @itemx LC_COLLATE
26466 @itemx LC_MESSAGES
26467 @c @itemx LC_MONETARY
26468 @c @itemx LC_NUMERIC
26469 @c @itemx LC_TIME
26470 @itemx LC_ALL
26471 @findex LANG
26472 @findex LC_CTYPE
26473 @c @findex LC_COLLATE
26474 @findex LC_MESSAGES
26475 @c @findex LC_MONETARY
26476 @c @findex LC_NUMERIC
26477 @c @findex LC_TIME
26478 @findex LC_ALL
26479 @cindex locale
26480 These environment variables control the way that GCC uses
26481 localization information which allows GCC to work with different
26482 national conventions.  GCC inspects the locale categories
26483 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26484 so.  These locale categories can be set to any value supported by your
26485 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26486 Kingdom encoded in UTF-8.
26488 The @env{LC_CTYPE} environment variable specifies character
26489 classification.  GCC uses it to determine the character boundaries in
26490 a string; this is needed for some multibyte encodings that contain quote
26491 and escape characters that are otherwise interpreted as a string
26492 end or escape.
26494 The @env{LC_MESSAGES} environment variable specifies the language to
26495 use in diagnostic messages.
26497 If the @env{LC_ALL} environment variable is set, it overrides the value
26498 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
26499 and @env{LC_MESSAGES} default to the value of the @env{LANG}
26500 environment variable.  If none of these variables are set, GCC
26501 defaults to traditional C English behavior.
26503 @item TMPDIR
26504 @findex TMPDIR
26505 If @env{TMPDIR} is set, it specifies the directory to use for temporary
26506 files.  GCC uses temporary files to hold the output of one stage of
26507 compilation which is to be used as input to the next stage: for example,
26508 the output of the preprocessor, which is the input to the compiler
26509 proper.
26511 @item GCC_COMPARE_DEBUG
26512 @findex GCC_COMPARE_DEBUG
26513 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
26514 @option{-fcompare-debug} to the compiler driver.  See the documentation
26515 of this option for more details.
26517 @item GCC_EXEC_PREFIX
26518 @findex GCC_EXEC_PREFIX
26519 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
26520 names of the subprograms executed by the compiler.  No slash is added
26521 when this prefix is combined with the name of a subprogram, but you can
26522 specify a prefix that ends with a slash if you wish.
26524 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
26525 an appropriate prefix to use based on the pathname it is invoked with.
26527 If GCC cannot find the subprogram using the specified prefix, it
26528 tries looking in the usual places for the subprogram.
26530 The default value of @env{GCC_EXEC_PREFIX} is
26531 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
26532 the installed compiler. In many cases @var{prefix} is the value
26533 of @code{prefix} when you ran the @file{configure} script.
26535 Other prefixes specified with @option{-B} take precedence over this prefix.
26537 This prefix is also used for finding files such as @file{crt0.o} that are
26538 used for linking.
26540 In addition, the prefix is used in an unusual way in finding the
26541 directories to search for header files.  For each of the standard
26542 directories whose name normally begins with @samp{/usr/local/lib/gcc}
26543 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
26544 replacing that beginning with the specified prefix to produce an
26545 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
26546 @file{foo/bar} just before it searches the standard directory 
26547 @file{/usr/local/lib/bar}.
26548 If a standard directory begins with the configured
26549 @var{prefix} then the value of @var{prefix} is replaced by
26550 @env{GCC_EXEC_PREFIX} when looking for header files.
26552 @item COMPILER_PATH
26553 @findex COMPILER_PATH
26554 The value of @env{COMPILER_PATH} is a colon-separated list of
26555 directories, much like @env{PATH}.  GCC tries the directories thus
26556 specified when searching for subprograms, if it can't find the
26557 subprograms using @env{GCC_EXEC_PREFIX}.
26559 @item LIBRARY_PATH
26560 @findex LIBRARY_PATH
26561 The value of @env{LIBRARY_PATH} is a colon-separated list of
26562 directories, much like @env{PATH}.  When configured as a native compiler,
26563 GCC tries the directories thus specified when searching for special
26564 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
26565 using GCC also uses these directories when searching for ordinary
26566 libraries for the @option{-l} option (but directories specified with
26567 @option{-L} come first).
26569 @item LANG
26570 @findex LANG
26571 @cindex locale definition
26572 This variable is used to pass locale information to the compiler.  One way in
26573 which this information is used is to determine the character set to be used
26574 when character literals, string literals and comments are parsed in C and C++.
26575 When the compiler is configured to allow multibyte characters,
26576 the following values for @env{LANG} are recognized:
26578 @table @samp
26579 @item C-JIS
26580 Recognize JIS characters.
26581 @item C-SJIS
26582 Recognize SJIS characters.
26583 @item C-EUCJP
26584 Recognize EUCJP characters.
26585 @end table
26587 If @env{LANG} is not defined, or if it has some other value, then the
26588 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
26589 recognize and translate multibyte characters.
26590 @end table
26592 @noindent
26593 Some additional environment variables affect the behavior of the
26594 preprocessor.
26596 @include cppenv.texi
26598 @c man end
26600 @node Precompiled Headers
26601 @section Using Precompiled Headers
26602 @cindex precompiled headers
26603 @cindex speed of compilation
26605 Often large projects have many header files that are included in every
26606 source file.  The time the compiler takes to process these header files
26607 over and over again can account for nearly all of the time required to
26608 build the project.  To make builds faster, GCC allows you to
26609 @dfn{precompile} a header file.
26611 To create a precompiled header file, simply compile it as you would any
26612 other file, if necessary using the @option{-x} option to make the driver
26613 treat it as a C or C++ header file.  You may want to use a
26614 tool like @command{make} to keep the precompiled header up-to-date when
26615 the headers it contains change.
26617 A precompiled header file is searched for when @code{#include} is
26618 seen in the compilation.  As it searches for the included file
26619 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
26620 compiler looks for a precompiled header in each directory just before it
26621 looks for the include file in that directory.  The name searched for is
26622 the name specified in the @code{#include} with @samp{.gch} appended.  If
26623 the precompiled header file can't be used, it is ignored.
26625 For instance, if you have @code{#include "all.h"}, and you have
26626 @file{all.h.gch} in the same directory as @file{all.h}, then the
26627 precompiled header file is used if possible, and the original
26628 header is used otherwise.
26630 Alternatively, you might decide to put the precompiled header file in a
26631 directory and use @option{-I} to ensure that directory is searched
26632 before (or instead of) the directory containing the original header.
26633 Then, if you want to check that the precompiled header file is always
26634 used, you can put a file of the same name as the original header in this
26635 directory containing an @code{#error} command.
26637 This also works with @option{-include}.  So yet another way to use
26638 precompiled headers, good for projects not designed with precompiled
26639 header files in mind, is to simply take most of the header files used by
26640 a project, include them from another header file, precompile that header
26641 file, and @option{-include} the precompiled header.  If the header files
26642 have guards against multiple inclusion, they are skipped because
26643 they've already been included (in the precompiled header).
26645 If you need to precompile the same header file for different
26646 languages, targets, or compiler options, you can instead make a
26647 @emph{directory} named like @file{all.h.gch}, and put each precompiled
26648 header in the directory, perhaps using @option{-o}.  It doesn't matter
26649 what you call the files in the directory; every precompiled header in
26650 the directory is considered.  The first precompiled header
26651 encountered in the directory that is valid for this compilation is
26652 used; they're searched in no particular order.
26654 There are many other possibilities, limited only by your imagination,
26655 good sense, and the constraints of your build system.
26657 A precompiled header file can be used only when these conditions apply:
26659 @itemize
26660 @item
26661 Only one precompiled header can be used in a particular compilation.
26663 @item
26664 A precompiled header can't be used once the first C token is seen.  You
26665 can have preprocessor directives before a precompiled header; you cannot
26666 include a precompiled header from inside another header.
26668 @item
26669 The precompiled header file must be produced for the same language as
26670 the current compilation.  You can't use a C precompiled header for a C++
26671 compilation.
26673 @item
26674 The precompiled header file must have been produced by the same compiler
26675 binary as the current compilation is using.
26677 @item
26678 Any macros defined before the precompiled header is included must
26679 either be defined in the same way as when the precompiled header was
26680 generated, or must not affect the precompiled header, which usually
26681 means that they don't appear in the precompiled header at all.
26683 The @option{-D} option is one way to define a macro before a
26684 precompiled header is included; using a @code{#define} can also do it.
26685 There are also some options that define macros implicitly, like
26686 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
26687 defined this way.
26689 @item If debugging information is output when using the precompiled
26690 header, using @option{-g} or similar, the same kind of debugging information
26691 must have been output when building the precompiled header.  However,
26692 a precompiled header built using @option{-g} can be used in a compilation
26693 when no debugging information is being output.
26695 @item The same @option{-m} options must generally be used when building
26696 and using the precompiled header.  @xref{Submodel Options},
26697 for any cases where this rule is relaxed.
26699 @item Each of the following options must be the same when building and using
26700 the precompiled header:
26702 @gccoptlist{-fexceptions}
26704 @item
26705 Some other command-line options starting with @option{-f},
26706 @option{-p}, or @option{-O} must be defined in the same way as when
26707 the precompiled header was generated.  At present, it's not clear
26708 which options are safe to change and which are not; the safest choice
26709 is to use exactly the same options when generating and using the
26710 precompiled header.  The following are known to be safe:
26712 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
26713 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
26714 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
26715 -pedantic-errors}
26717 @end itemize
26719 For all of these except the last, the compiler automatically
26720 ignores the precompiled header if the conditions aren't met.  If you
26721 find an option combination that doesn't work and doesn't cause the
26722 precompiled header to be ignored, please consider filing a bug report,
26723 see @ref{Bugs}.
26725 If you do use differing options when generating and using the
26726 precompiled header, the actual behavior is a mixture of the
26727 behavior for the options.  For instance, if you use @option{-g} to
26728 generate the precompiled header but not when using it, you may or may
26729 not get debugging information for routines in the precompiled header.