* tree-loop-distribution.c (params.h): Include header file.
[official-gcc.git] / gcc / doc / invoke.texi
blob3e5cee8649ef9452e2a7e5a8603318ce11e2baff
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  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wcast-align  -Wcast-qual  @gol
270 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
271 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
272 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
273 -Wdelete-incomplete @gol
274 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
275 -Wdisabled-optimization @gol
276 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
277 -Wno-div-by-zero  -Wdouble-promotion @gol
278 -Wduplicated-branches  -Wduplicated-cond @gol
279 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
280 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
281 -Wfloat-equal  -Wformat  -Wformat=2 @gol
282 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
283 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
284 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
285 -Wformat-y2k  -Wframe-address @gol
286 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
287 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
288 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
289 -Wimplicit-function-declaration  -Wimplicit-int @gol
290 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
291 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
292 -Winvalid-pch  -Wlarger-than=@var{len} @gol
293 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
294 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
295 -Wmisleading-indentation  -Wmissing-braces @gol
296 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
297 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
298 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
299 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
300 -Woverride-init-side-effects  -Woverlength-strings @gol
301 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
302 -Wparentheses  -Wno-pedantic-ms-format @gol
303 -Wplacement-new  -Wplacement-new=@var{n} @gol
304 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
305 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
306 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
307 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
308 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
309 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
310 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
311 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
312 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
313 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
314 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
315 -Wstringop-overflow=@var{n} @gol
316 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
317 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
318 -Wmissing-format-attribute  -Wsubobject-linkage @gol
319 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
320 -Wswitch-unreachable  -Wsync-nand @gol
321 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
322 -Wtype-limits  -Wundef @gol
323 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
324 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
325 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
326 -Wunused-parameter  -Wno-unused-result @gol
327 -Wunused-value  -Wunused-variable @gol
328 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
329 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
330 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
331 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
332 -Wzero-as-null-pointer-constant  -Whsa}
334 @item C and Objective-C-only Warning Options
335 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
336 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
337 -Wold-style-declaration  -Wold-style-definition @gol
338 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
339 -Wdeclaration-after-statement  -Wpointer-sign}
341 @item Debugging Options
342 @xref{Debugging Options,,Options for Debugging Your Program}.
343 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
344 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
345 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
346 -gcolumn-info  -gno-column-info @gol
347 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
348 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
349 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
350 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
351 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
352 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
353 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
354 -fvar-tracking  -fvar-tracking-assignments}
356 @item Optimization Options
357 @xref{Optimize Options,,Options that Control Optimization}.
358 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
359 -falign-jumps[=@var{n}] @gol
360 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
361 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
362 -fauto-inc-dec  -fbranch-probabilities @gol
363 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
364 -fbtr-bb-exclusive  -fcaller-saves @gol
365 -fcombine-stack-adjustments  -fconserve-stack @gol
366 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
367 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
368 -fcx-limited-range @gol
369 -fdata-sections  -fdce  -fdelayed-branch @gol
370 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
371 -fdevirtualize-at-ltrans  -fdse @gol
372 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
373 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
374 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
375 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
376 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
377 -fif-conversion2  -findirect-inlining @gol
378 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
379 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
380 -fipa-bit-cp -fipa-vrp @gol
381 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
382 -fira-algorithm=@var{algorithm} @gol
383 -fira-region=@var{region}  -fira-hoist-pressure @gol
384 -fira-loop-pressure  -fno-ira-share-save-slots @gol
385 -fno-ira-share-spill-slots @gol
386 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
387 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
388 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
389 -floop-block  -floop-interchange  -floop-strip-mine @gol
390 -floop-unroll-and-jam  -floop-nest-optimize @gol
391 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
392 -flto-partition=@var{alg}  -fmerge-all-constants @gol
393 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
394 -fmove-loop-invariants  -fno-branch-count-reg @gol
395 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
396 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
397 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
398 -fno-sched-spec  -fno-signed-zeros @gol
399 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
400 -fomit-frame-pointer  -foptimize-sibling-calls @gol
401 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
402 -fprefetch-loop-arrays @gol
403 -fprofile-correction @gol
404 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
405 -fprofile-reorder-functions @gol
406 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
407 -freorder-blocks-algorithm=@var{algorithm} @gol
408 -freorder-blocks-and-partition  -freorder-functions @gol
409 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
410 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
411 -fsched-spec-load  -fsched-spec-load-dangerous @gol
412 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
413 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
414 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
415 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
416 -fschedule-fusion @gol
417 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
418 -fselective-scheduling  -fselective-scheduling2 @gol
419 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
420 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
421 -fsignaling-nans @gol
422 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
423 -fsplit-paths @gol
424 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
425 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
426 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
427 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
428 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
429 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
430 -ftree-loop-if-convert  -ftree-loop-im @gol
431 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
432 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
433 -ftree-loop-vectorize @gol
434 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
435 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
436 -ftree-switch-conversion  -ftree-tail-merge @gol
437 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
438 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
439 -funsafe-math-optimizations  -funswitch-loops @gol
440 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
441 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
442 --param @var{name}=@var{value}
443 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
445 @item Program Instrumentation Options
446 @xref{Instrumentation Options,,Program Instrumentation Options}.
447 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
448 -fprofile-abs-path @gol
449 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
450 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
451 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
452 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
453 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
454 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
455 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
456 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
457 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
458 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
459 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
460 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
461 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
462 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
463 -fstack-protector-explicit  -fstack-check @gol
464 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
465 -fno-stack-limit  -fsplit-stack @gol
466 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
467 -fvtv-counts  -fvtv-debug @gol
468 -finstrument-functions @gol
469 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
470 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
472 @item Preprocessor Options
473 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
474 @gccoptlist{-A@var{question}=@var{answer} @gol
475 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
476 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
477 -dD  -dI  -dM  -dN  -dU @gol
478 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
479 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
480 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
481 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
482 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
483 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
484 -H  -imacros @var{file}  -include @var{file} @gol
485 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
486 -no-integrated-cpp  -P  -pthread  -remap @gol
487 -traditional  -traditional-cpp  -trigraphs @gol
488 -U@var{macro}  -undef  @gol
489 -Wp,@var{option}  -Xpreprocessor @var{option}}
491 @item Assembler Options
492 @xref{Assembler Options,,Passing Options to the Assembler}.
493 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
495 @item Linker Options
496 @xref{Link Options,,Options for Linking}.
497 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
498 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
499 -s  -static  -static-libgcc  -static-libstdc++ @gol
500 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
501 -static-libmpx  -static-libmpxwrappers @gol
502 -shared  -shared-libgcc  -symbolic @gol
503 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
504 -u @var{symbol}  -z @var{keyword}}
506 @item Directory Options
507 @xref{Directory Options,,Options for Directory Search}.
508 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
509 -idirafter @var{dir} @gol
510 -imacros @var{file}  -imultilib @var{dir} @gol
511 -iplugindir=@var{dir}  -iprefix @var{file} @gol
512 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
513 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
514 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
515 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
517 @item Code Generation Options
518 @xref{Code Gen Options,,Options for Code Generation Conventions}.
519 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
520 -ffixed-@var{reg}  -fexceptions @gol
521 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
522 -fasynchronous-unwind-tables @gol
523 -fno-gnu-unique @gol
524 -finhibit-size-directive  -fno-common  -fno-ident @gol
525 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
526 -fno-jump-tables @gol
527 -frecord-gcc-switches @gol
528 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
529 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
530 -fleading-underscore  -ftls-model=@var{model} @gol
531 -fstack-reuse=@var{reuse_level} @gol
532 -ftrampolines  -ftrapv  -fwrapv @gol
533 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
534 -fstrict-volatile-bitfields  -fsync-libcalls}
536 @item Developer Options
537 @xref{Developer Options,,GCC Developer Options}.
538 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
539 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
540 -fdbg-cnt=@var{counter-value-list} @gol
541 -fdisable-ipa-@var{pass_name} @gol
542 -fdisable-rtl-@var{pass_name} @gol
543 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
544 -fdisable-tree-@var{pass_name} @gol
545 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
546 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
547 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
548 -fdump-final-insns@r{[}=@var{file}@r{]}
549 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
550 -fdump-lang-all @gol
551 -fdump-lang-@var{switch} @gol
552 -fdump-lang-@var{switch}-@var{options} @gol
553 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
554 -fdump-passes @gol
555 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
556 -fdump-statistics @gol
557 -fdump-tree-all @gol
558 -fdump-tree-@var{switch} @gol
559 -fdump-tree-@var{switch}-@var{options} @gol
560 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
561 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
562 -fenable-@var{kind}-@var{pass} @gol
563 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
564 -fira-verbose=@var{n} @gol
565 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
566 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
567 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
568 -fprofile-report @gol
569 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
570 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
571 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
572 -fvar-tracking-assignments-toggle  -gtoggle @gol
573 -print-file-name=@var{library}  -print-libgcc-file-name @gol
574 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
575 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
576 -print-sysroot  -print-sysroot-headers-suffix @gol
577 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
579 @item Machine-Dependent Options
580 @xref{Submodel Options,,Machine-Dependent Options}.
581 @c This list is ordered alphanumerically by subsection name.
582 @c Try and put the significant identifier (CPU or system) first,
583 @c so users have a clue at guessing where the ones they want will be.
585 @emph{AArch64 Options}
586 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
587 -mgeneral-regs-only @gol
588 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
589 -mstrict-align @gol
590 -momit-leaf-frame-pointer @gol
591 -mtls-dialect=desc  -mtls-dialect=traditional @gol
592 -mtls-size=@var{size} @gol
593 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
594 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
595 -mpc-relative-literal-loads @gol
596 -msign-return-address=@var{scope} @gol
597 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
599 @emph{Adapteva Epiphany Options}
600 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
601 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
602 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
603 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
604 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
605 -msplit-vecmove-early  -m1reg-@var{reg}}
607 @emph{ARC Options}
608 @gccoptlist{-mbarrel-shifter @gol
609 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
610 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
611 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
612 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
613 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
614 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
615 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
616 -mrgf-banked-regs @gol
617 -mvolatile-cache  -mtp-regno=@var{regno} @gol
618 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
619 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
620 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
621 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
622 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
623 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
624 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
625 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
627 @emph{ARM Options}
628 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
629 -mabi=@var{name} @gol
630 -mapcs-stack-check  -mno-apcs-stack-check @gol
631 -mapcs-reentrant  -mno-apcs-reentrant @gol
632 -msched-prolog  -mno-sched-prolog @gol
633 -mlittle-endian  -mbig-endian @gol
634 -mbe8 -mbe32 @gol
635 -mfloat-abi=@var{name} @gol
636 -mfp16-format=@var{name}
637 -mthumb-interwork  -mno-thumb-interwork @gol
638 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
639 -mtune=@var{name}  -mprint-tune-info @gol
640 -mstructure-size-boundary=@var{n} @gol
641 -mabort-on-noreturn @gol
642 -mlong-calls  -mno-long-calls @gol
643 -msingle-pic-base  -mno-single-pic-base @gol
644 -mpic-register=@var{reg} @gol
645 -mnop-fun-dllimport @gol
646 -mpoke-function-name @gol
647 -mthumb  -marm @gol
648 -mtpcs-frame  -mtpcs-leaf-frame @gol
649 -mcaller-super-interworking  -mcallee-super-interworking @gol
650 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
651 -mword-relocations @gol
652 -mfix-cortex-m3-ldrd @gol
653 -munaligned-access @gol
654 -mneon-for-64bits @gol
655 -mslow-flash-data @gol
656 -masm-syntax-unified @gol
657 -mrestrict-it @gol
658 -mpure-code @gol
659 -mcmse}
661 @emph{AVR Options}
662 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
663 -mbranch-cost=@var{cost} @gol
664 -mcall-prologues  -mint8  -mn_flash=@var{size}  -mno-interrupts @gol
665 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
666 -mshort-calls  -nodevicelib @gol
667 -Waddr-space-convert  -Wmisspelled-isr}
669 @emph{Blackfin Options}
670 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
671 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
672 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
673 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
674 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
675 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
676 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
677 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
678 -micplb}
680 @emph{C6X Options}
681 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
682 -msim  -msdata=@var{sdata-type}}
684 @emph{CRIS Options}
685 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
686 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
687 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
688 -mstack-align  -mdata-align  -mconst-align @gol
689 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
690 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
691 -mmul-bug-workaround  -mno-mul-bug-workaround}
693 @emph{CR16 Options}
694 @gccoptlist{-mmac @gol
695 -mcr16cplus  -mcr16c @gol
696 -msim  -mint32  -mbit-ops
697 -mdata-model=@var{model}}
699 @emph{Darwin Options}
700 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
701 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
702 -client_name  -compatibility_version  -current_version @gol
703 -dead_strip @gol
704 -dependency-file  -dylib_file  -dylinker_install_name @gol
705 -dynamic  -dynamiclib  -exported_symbols_list @gol
706 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
707 -force_flat_namespace  -headerpad_max_install_names @gol
708 -iframework @gol
709 -image_base  -init  -install_name  -keep_private_externs @gol
710 -multi_module  -multiply_defined  -multiply_defined_unused @gol
711 -noall_load   -no_dead_strip_inits_and_terms @gol
712 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
713 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
714 -private_bundle  -read_only_relocs  -sectalign @gol
715 -sectobjectsymbols  -whyload  -seg1addr @gol
716 -sectcreate  -sectobjectsymbols  -sectorder @gol
717 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
718 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
719 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
720 -single_module  -static  -sub_library  -sub_umbrella @gol
721 -twolevel_namespace  -umbrella  -undefined @gol
722 -unexported_symbols_list  -weak_reference_mismatches @gol
723 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
724 -mkernel  -mone-byte-bool}
726 @emph{DEC Alpha Options}
727 @gccoptlist{-mno-fp-regs  -msoft-float @gol
728 -mieee  -mieee-with-inexact  -mieee-conformant @gol
729 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
730 -mtrap-precision=@var{mode}  -mbuild-constants @gol
731 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
732 -mbwx  -mmax  -mfix  -mcix @gol
733 -mfloat-vax  -mfloat-ieee @gol
734 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
735 -msmall-text  -mlarge-text @gol
736 -mmemory-latency=@var{time}}
738 @emph{FR30 Options}
739 @gccoptlist{-msmall-model  -mno-lsim}
741 @emph{FT32 Options}
742 @gccoptlist{-msim  -mlra  -mnodiv}
744 @emph{FRV Options}
745 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
746 -mhard-float  -msoft-float @gol
747 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
748 -mdouble  -mno-double @gol
749 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
750 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
751 -mlinked-fp  -mlong-calls  -malign-labels @gol
752 -mlibrary-pic  -macc-4  -macc-8 @gol
753 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
754 -moptimize-membar  -mno-optimize-membar @gol
755 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
756 -mvliw-branch  -mno-vliw-branch @gol
757 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
758 -mno-nested-cond-exec  -mtomcat-stats @gol
759 -mTLS  -mtls @gol
760 -mcpu=@var{cpu}}
762 @emph{GNU/Linux Options}
763 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
764 -tno-android-cc  -tno-android-ld}
766 @emph{H8/300 Options}
767 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
769 @emph{HPPA Options}
770 @gccoptlist{-march=@var{architecture-type} @gol
771 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
772 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
773 -mfixed-range=@var{register-range} @gol
774 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
775 -mlong-load-store  -mno-disable-fpregs @gol
776 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
777 -mno-jump-in-delay  -mno-long-load-store @gol
778 -mno-portable-runtime  -mno-soft-float @gol
779 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
780 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
781 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
782 -munix=@var{unix-std}  -nolibdld  -static  -threads}
784 @emph{IA-64 Options}
785 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
786 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
787 -mconstant-gp  -mauto-pic  -mfused-madd @gol
788 -minline-float-divide-min-latency @gol
789 -minline-float-divide-max-throughput @gol
790 -mno-inline-float-divide @gol
791 -minline-int-divide-min-latency @gol
792 -minline-int-divide-max-throughput  @gol
793 -mno-inline-int-divide @gol
794 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
795 -mno-inline-sqrt @gol
796 -mdwarf2-asm  -mearly-stop-bits @gol
797 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
798 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
799 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
800 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
801 -msched-spec-ldc  -msched-spec-control-ldc @gol
802 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
803 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
804 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
805 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
807 @emph{LM32 Options}
808 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
809 -msign-extend-enabled  -muser-enabled}
811 @emph{M32R/D Options}
812 @gccoptlist{-m32r2  -m32rx  -m32r @gol
813 -mdebug @gol
814 -malign-loops  -mno-align-loops @gol
815 -missue-rate=@var{number} @gol
816 -mbranch-cost=@var{number} @gol
817 -mmodel=@var{code-size-model-type} @gol
818 -msdata=@var{sdata-type} @gol
819 -mno-flush-func  -mflush-func=@var{name} @gol
820 -mno-flush-trap  -mflush-trap=@var{number} @gol
821 -G @var{num}}
823 @emph{M32C Options}
824 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
826 @emph{M680x0 Options}
827 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
828 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
829 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
830 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
831 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
832 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
833 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
834 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
835 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
837 @emph{MCore Options}
838 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
839 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
840 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
841 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
842 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
844 @emph{MeP Options}
845 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
846 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
847 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
848 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
849 -mtiny=@var{n}}
851 @emph{MicroBlaze Options}
852 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
853 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
854 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
855 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
856 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
858 @emph{MIPS Options}
859 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
860 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
861 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
862 -mips16  -mno-mips16  -mflip-mips16 @gol
863 -minterlink-compressed  -mno-interlink-compressed @gol
864 -minterlink-mips16  -mno-interlink-mips16 @gol
865 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
866 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
867 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
868 -mno-float  -msingle-float  -mdouble-float @gol
869 -modd-spreg  -mno-odd-spreg @gol
870 -mabs=@var{mode}  -mnan=@var{encoding} @gol
871 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
872 -mmcu  -mmno-mcu @gol
873 -meva  -mno-eva @gol
874 -mvirt  -mno-virt @gol
875 -mxpa  -mno-xpa @gol
876 -mmicromips  -mno-micromips @gol
877 -mmsa  -mno-msa @gol
878 -mfpu=@var{fpu-type} @gol
879 -msmartmips  -mno-smartmips @gol
880 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
881 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
882 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
883 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
884 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
885 -membedded-data  -mno-embedded-data @gol
886 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
887 -mcode-readable=@var{setting} @gol
888 -msplit-addresses  -mno-split-addresses @gol
889 -mexplicit-relocs  -mno-explicit-relocs @gol
890 -mcheck-zero-division  -mno-check-zero-division @gol
891 -mdivide-traps  -mdivide-breaks @gol
892 -mload-store-pairs  -mno-load-store-pairs @gol
893 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
894 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
895 -mfix-24k  -mno-fix-24k @gol
896 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
897 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
898 -mfix-vr4120  -mno-fix-vr4120 @gol
899 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
900 -mflush-func=@var{func}  -mno-flush-func @gol
901 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
902 -mcompact-branches=@var{policy} @gol
903 -mfp-exceptions  -mno-fp-exceptions @gol
904 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
905 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
906 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
907 -mframe-header-opt  -mno-frame-header-opt}
909 @emph{MMIX Options}
910 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
911 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
912 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
913 -mno-base-addresses  -msingle-exit  -mno-single-exit}
915 @emph{MN10300 Options}
916 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
917 -mno-am33  -mam33  -mam33-2  -mam34 @gol
918 -mtune=@var{cpu-type} @gol
919 -mreturn-pointer-on-d0 @gol
920 -mno-crt0  -mrelax  -mliw  -msetlb}
922 @emph{Moxie Options}
923 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
925 @emph{MSP430 Options}
926 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
927 -mwarn-mcu @gol
928 -mcode-region=  -mdata-region= @gol
929 -msilicon-errata=  -msilicon-errata-warn= @gol
930 -mhwmult=  -minrt}
932 @emph{NDS32 Options}
933 @gccoptlist{-mbig-endian  -mlittle-endian @gol
934 -mreduced-regs  -mfull-regs @gol
935 -mcmov  -mno-cmov @gol
936 -mperf-ext  -mno-perf-ext @gol
937 -mv3push  -mno-v3push @gol
938 -m16bit  -mno-16bit @gol
939 -misr-vector-size=@var{num} @gol
940 -mcache-block-size=@var{num} @gol
941 -march=@var{arch} @gol
942 -mcmodel=@var{code-model} @gol
943 -mctor-dtor  -mrelax}
945 @emph{Nios II Options}
946 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
947 -mel  -meb @gol
948 -mno-bypass-cache  -mbypass-cache @gol
949 -mno-cache-volatile  -mcache-volatile @gol
950 -mno-fast-sw-div  -mfast-sw-div @gol
951 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
952 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
953 -mcustom-fpu-cfg=@var{name} @gol
954 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
955 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
957 @emph{Nvidia PTX Options}
958 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
960 @emph{PDP-11 Options}
961 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
962 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
963 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
964 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
965 -mbranch-expensive  -mbranch-cheap @gol
966 -munix-asm  -mdec-asm}
968 @emph{picoChip Options}
969 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
970 -msymbol-as-address  -mno-inefficient-warnings}
972 @emph{PowerPC Options}
973 See RS/6000 and PowerPC Options.
975 @emph{RISC-V Options}
976 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
977 -mmemcpy  -mno-memcpy @gol
978 -mplt  -mno-plt @gol
979 -mabi=@var{ABI-string} @gol
980 -mfdiv  -mno-fdiv @gol
981 -mdiv  -mno-div @gol
982 -march=@var{ISA-string} @gol
983 -mtune=@var{processor-string} @gol
984 -msmall-data-limit=@var{N-bytes} @gol
985 -msave-restore  -mno-save-restore @gol
986 -mstrict-align -mno-strict-align @gol
987 -mcmodel=@var{code-model} @gol
988 -mexplicit-relocs  -mno-explicit-relocs @gol}
990 @emph{RL78 Options}
991 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
992 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
993 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
995 @emph{RS/6000 and PowerPC Options}
996 @gccoptlist{-mcpu=@var{cpu-type} @gol
997 -mtune=@var{cpu-type} @gol
998 -mcmodel=@var{code-model} @gol
999 -mpowerpc64 @gol
1000 -maltivec  -mno-altivec @gol
1001 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1002 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1003 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1004 -mfprnd  -mno-fprnd @gol
1005 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1006 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1007 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1008 -malign-power  -malign-natural @gol
1009 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1010 -msingle-float  -mdouble-float  -msimple-fpu @gol
1011 -mstring  -mno-string  -mupdate  -mno-update @gol
1012 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1013 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1014 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1015 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1016 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1017 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1018 -mprioritize-restricted-insns=@var{priority} @gol
1019 -msched-costly-dep=@var{dependence_type} @gol
1020 -minsert-sched-nops=@var{scheme} @gol
1021 -mcall-sysv  -mcall-netbsd @gol
1022 -maix-struct-return  -msvr4-struct-return @gol
1023 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1024 -mblock-move-inline-limit=@var{num} @gol
1025 -misel  -mno-isel @gol
1026 -misel=yes  -misel=no @gol
1027 -mspe  -mno-spe @gol
1028 -mspe=yes  -mspe=no @gol
1029 -mpaired @gol
1030 -mvrsave  -mno-vrsave @gol
1031 -mmulhw  -mno-mulhw @gol
1032 -mdlmzb  -mno-dlmzb @gol
1033 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1034 -mprototype  -mno-prototype @gol
1035 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1036 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1037 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1038 -mno-recip-precision @gol
1039 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1040 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1041 -msave-toc-indirect  -mno-save-toc-indirect @gol
1042 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1043 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1044 -mquad-memory  -mno-quad-memory @gol
1045 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1046 -mcompat-align-parm  -mno-compat-align-parm @gol
1047 -mupper-regs-df  -mno-upper-regs-df  -mupper-regs-sf  -mno-upper-regs-sf @gol
1048 -mupper-regs-di  -mno-upper-regs-di @gol
1049 -mupper-regs  -mno-upper-regs @gol
1050 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1051 -mgnu-attribute  -mno-gnu-attribute @gol
1052 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1053 -mstack-protector-guard-offset=@var{offset} @gol
1054 -mlra  -mno-lra}
1056 @emph{RX Options}
1057 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1058 -mcpu=@gol
1059 -mbig-endian-data  -mlittle-endian-data @gol
1060 -msmall-data @gol
1061 -msim  -mno-sim@gol
1062 -mas100-syntax  -mno-as100-syntax@gol
1063 -mrelax@gol
1064 -mmax-constant-size=@gol
1065 -mint-register=@gol
1066 -mpid@gol
1067 -mallow-string-insns  -mno-allow-string-insns@gol
1068 -mjsr@gol
1069 -mno-warn-multiple-fast-interrupts@gol
1070 -msave-acc-in-interrupts}
1072 @emph{S/390 and zSeries Options}
1073 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1074 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1075 -mlong-double-64  -mlong-double-128 @gol
1076 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1077 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1078 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1079 -mhtm  -mvx  -mzvector @gol
1080 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1081 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1082 -mhotpatch=@var{halfwords},@var{halfwords}}
1084 @emph{Score Options}
1085 @gccoptlist{-meb  -mel @gol
1086 -mnhwloop @gol
1087 -muls @gol
1088 -mmac @gol
1089 -mscore5  -mscore5u  -mscore7  -mscore7d}
1091 @emph{SH Options}
1092 @gccoptlist{-m1  -m2  -m2e @gol
1093 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1094 -m3  -m3e @gol
1095 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1096 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1097 -mb  -ml  -mdalign  -mrelax @gol
1098 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1099 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1100 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1101 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1102 -maccumulate-outgoing-args @gol
1103 -matomic-model=@var{atomic-model} @gol
1104 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1105 -mcbranch-force-delay-slot @gol
1106 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1107 -mpretend-cmove  -mtas}
1109 @emph{Solaris 2 Options}
1110 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1111 -pthreads}
1113 @emph{SPARC Options}
1114 @gccoptlist{-mcpu=@var{cpu-type} @gol
1115 -mtune=@var{cpu-type} @gol
1116 -mcmodel=@var{code-model} @gol
1117 -mmemory-model=@var{mem-model} @gol
1118 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1119 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1120 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1121 -mhard-quad-float  -msoft-quad-float @gol
1122 -mstack-bias  -mno-stack-bias @gol
1123 -mstd-struct-return  -mno-std-struct-return @gol
1124 -munaligned-doubles  -mno-unaligned-doubles @gol
1125 -muser-mode  -mno-user-mode @gol
1126 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1127 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1128 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1129 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1130 -mfix-at697f  -mfix-ut699 @gol
1131 -mlra  -mno-lra}
1133 @emph{SPU Options}
1134 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1135 -msafe-dma  -munsafe-dma @gol
1136 -mbranch-hints @gol
1137 -msmall-mem  -mlarge-mem  -mstdmain @gol
1138 -mfixed-range=@var{register-range} @gol
1139 -mea32  -mea64 @gol
1140 -maddress-space-conversion  -mno-address-space-conversion @gol
1141 -mcache-size=@var{cache-size} @gol
1142 -matomic-updates  -mno-atomic-updates}
1144 @emph{System V Options}
1145 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1147 @emph{TILE-Gx Options}
1148 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1149 -mcmodel=@var{code-model}}
1151 @emph{TILEPro Options}
1152 @gccoptlist{-mcpu=@var{cpu}  -m32}
1154 @emph{V850 Options}
1155 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1156 -mprolog-function  -mno-prolog-function  -mspace @gol
1157 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1158 -mapp-regs  -mno-app-regs @gol
1159 -mdisable-callt  -mno-disable-callt @gol
1160 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1161 -mv850e  -mv850  -mv850e3v5 @gol
1162 -mloop @gol
1163 -mrelax @gol
1164 -mlong-jumps @gol
1165 -msoft-float @gol
1166 -mhard-float @gol
1167 -mgcc-abi @gol
1168 -mrh850-abi @gol
1169 -mbig-switch}
1171 @emph{VAX Options}
1172 @gccoptlist{-mg  -mgnu  -munix}
1174 @emph{Visium Options}
1175 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1176 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1178 @emph{VMS Options}
1179 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1180 -mpointer-size=@var{size}}
1182 @emph{VxWorks Options}
1183 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1184 -Xbind-lazy  -Xbind-now}
1186 @emph{x86 Options}
1187 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1188 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1189 -mfpmath=@var{unit} @gol
1190 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1191 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1192 -mno-wide-multiply  -mrtd  -malign-double @gol
1193 -mpreferred-stack-boundary=@var{num} @gol
1194 -mincoming-stack-boundary=@var{num} @gol
1195 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1196 -mrecip  -mrecip=@var{opt} @gol
1197 -mvzeroupper  -mprefer-avx128 @gol
1198 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1199 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1200 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1201 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1202 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1203 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1204 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1205 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1206 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1207 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1208 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1209 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1210 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1211 -mregparm=@var{num}  -msseregparm @gol
1212 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1213 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1214 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1215 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1216 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1217 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1218 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1219 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1220 -mmitigate-rop  -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1222 @emph{x86 Windows Options}
1223 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1224 -mnop-fun-dllimport  -mthread @gol
1225 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1227 @emph{Xstormy16 Options}
1228 @gccoptlist{-msim}
1230 @emph{Xtensa Options}
1231 @gccoptlist{-mconst16  -mno-const16 @gol
1232 -mfused-madd  -mno-fused-madd @gol
1233 -mforce-no-pic @gol
1234 -mserialize-volatile  -mno-serialize-volatile @gol
1235 -mtext-section-literals  -mno-text-section-literals @gol
1236 -mauto-litpools  -mno-auto-litpools @gol
1237 -mtarget-align  -mno-target-align @gol
1238 -mlongcalls  -mno-longcalls}
1240 @emph{zSeries Options}
1241 See S/390 and zSeries Options.
1242 @end table
1245 @node Overall Options
1246 @section Options Controlling the Kind of Output
1248 Compilation can involve up to four stages: preprocessing, compilation
1249 proper, assembly and linking, always in that order.  GCC is capable of
1250 preprocessing and compiling several files either into several
1251 assembler input files, or into one assembler input file; then each
1252 assembler input file produces an object file, and linking combines all
1253 the object files (those newly compiled, and those specified as input)
1254 into an executable file.
1256 @cindex file name suffix
1257 For any given input file, the file name suffix determines what kind of
1258 compilation is done:
1260 @table @gcctabopt
1261 @item @var{file}.c
1262 C source code that must be preprocessed.
1264 @item @var{file}.i
1265 C source code that should not be preprocessed.
1267 @item @var{file}.ii
1268 C++ source code that should not be preprocessed.
1270 @item @var{file}.m
1271 Objective-C source code.  Note that you must link with the @file{libobjc}
1272 library to make an Objective-C program work.
1274 @item @var{file}.mi
1275 Objective-C source code that should not be preprocessed.
1277 @item @var{file}.mm
1278 @itemx @var{file}.M
1279 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1280 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1281 to a literal capital M@.
1283 @item @var{file}.mii
1284 Objective-C++ source code that should not be preprocessed.
1286 @item @var{file}.h
1287 C, C++, Objective-C or Objective-C++ header file to be turned into a
1288 precompiled header (default), or C, C++ header file to be turned into an
1289 Ada spec (via the @option{-fdump-ada-spec} switch).
1291 @item @var{file}.cc
1292 @itemx @var{file}.cp
1293 @itemx @var{file}.cxx
1294 @itemx @var{file}.cpp
1295 @itemx @var{file}.CPP
1296 @itemx @var{file}.c++
1297 @itemx @var{file}.C
1298 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1299 the last two letters must both be literally @samp{x}.  Likewise,
1300 @samp{.C} refers to a literal capital C@.
1302 @item @var{file}.mm
1303 @itemx @var{file}.M
1304 Objective-C++ source code that must be preprocessed.
1306 @item @var{file}.mii
1307 Objective-C++ source code that should not be preprocessed.
1309 @item @var{file}.hh
1310 @itemx @var{file}.H
1311 @itemx @var{file}.hp
1312 @itemx @var{file}.hxx
1313 @itemx @var{file}.hpp
1314 @itemx @var{file}.HPP
1315 @itemx @var{file}.h++
1316 @itemx @var{file}.tcc
1317 C++ header file to be turned into a precompiled header or Ada spec.
1319 @item @var{file}.f
1320 @itemx @var{file}.for
1321 @itemx @var{file}.ftn
1322 Fixed form Fortran source code that should not be preprocessed.
1324 @item @var{file}.F
1325 @itemx @var{file}.FOR
1326 @itemx @var{file}.fpp
1327 @itemx @var{file}.FPP
1328 @itemx @var{file}.FTN
1329 Fixed form Fortran source code that must be preprocessed (with the traditional
1330 preprocessor).
1332 @item @var{file}.f90
1333 @itemx @var{file}.f95
1334 @itemx @var{file}.f03
1335 @itemx @var{file}.f08
1336 Free form Fortran source code that should not be preprocessed.
1338 @item @var{file}.F90
1339 @itemx @var{file}.F95
1340 @itemx @var{file}.F03
1341 @itemx @var{file}.F08
1342 Free form Fortran source code that must be preprocessed (with the
1343 traditional preprocessor).
1345 @item @var{file}.go
1346 Go source code.
1348 @item @var{file}.brig
1349 BRIG files (binary representation of HSAIL).
1351 @item @var{file}.ads
1352 Ada source code file that contains a library unit declaration (a
1353 declaration of a package, subprogram, or generic, or a generic
1354 instantiation), or a library unit renaming declaration (a package,
1355 generic, or subprogram renaming declaration).  Such files are also
1356 called @dfn{specs}.
1358 @item @var{file}.adb
1359 Ada source code file containing a library unit body (a subprogram or
1360 package body).  Such files are also called @dfn{bodies}.
1362 @c GCC also knows about some suffixes for languages not yet included:
1363 @c Pascal:
1364 @c @var{file}.p
1365 @c @var{file}.pas
1366 @c Ratfor:
1367 @c @var{file}.r
1369 @item @var{file}.s
1370 Assembler code.
1372 @item @var{file}.S
1373 @itemx @var{file}.sx
1374 Assembler code that must be preprocessed.
1376 @item @var{other}
1377 An object file to be fed straight into linking.
1378 Any file name with no recognized suffix is treated this way.
1379 @end table
1381 @opindex x
1382 You can specify the input language explicitly with the @option{-x} option:
1384 @table @gcctabopt
1385 @item -x @var{language}
1386 Specify explicitly the @var{language} for the following input files
1387 (rather than letting the compiler choose a default based on the file
1388 name suffix).  This option applies to all following input files until
1389 the next @option{-x} option.  Possible values for @var{language} are:
1390 @smallexample
1391 c  c-header  cpp-output
1392 c++  c++-header  c++-cpp-output
1393 objective-c  objective-c-header  objective-c-cpp-output
1394 objective-c++ objective-c++-header objective-c++-cpp-output
1395 assembler  assembler-with-cpp
1397 f77  f77-cpp-input f95  f95-cpp-input
1399 brig
1400 @end smallexample
1402 @item -x none
1403 Turn off any specification of a language, so that subsequent files are
1404 handled according to their file name suffixes (as they are if @option{-x}
1405 has not been used at all).
1406 @end table
1408 If you only want some of the stages of compilation, you can use
1409 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1410 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1411 @command{gcc} is to stop.  Note that some combinations (for example,
1412 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1414 @table @gcctabopt
1415 @item -c
1416 @opindex c
1417 Compile or assemble the source files, but do not link.  The linking
1418 stage simply is not done.  The ultimate output is in the form of an
1419 object file for each source file.
1421 By default, the object file name for a source file is made by replacing
1422 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1424 Unrecognized input files, not requiring compilation or assembly, are
1425 ignored.
1427 @item -S
1428 @opindex S
1429 Stop after the stage of compilation proper; do not assemble.  The output
1430 is in the form of an assembler code file for each non-assembler input
1431 file specified.
1433 By default, the assembler file name for a source file is made by
1434 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1436 Input files that don't require compilation are ignored.
1438 @item -E
1439 @opindex E
1440 Stop after the preprocessing stage; do not run the compiler proper.  The
1441 output is in the form of preprocessed source code, which is sent to the
1442 standard output.
1444 Input files that don't require preprocessing are ignored.
1446 @cindex output file option
1447 @item -o @var{file}
1448 @opindex o
1449 Place output in file @var{file}.  This applies to whatever
1450 sort of output is being produced, whether it be an executable file,
1451 an object file, an assembler file or preprocessed C code.
1453 If @option{-o} is not specified, the default is to put an executable
1454 file in @file{a.out}, the object file for
1455 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1456 assembler file in @file{@var{source}.s}, a precompiled header file in
1457 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1458 standard output.
1460 @item -v
1461 @opindex v
1462 Print (on standard error output) the commands executed to run the stages
1463 of compilation.  Also print the version number of the compiler driver
1464 program and of the preprocessor and the compiler proper.
1466 @item -###
1467 @opindex ###
1468 Like @option{-v} except the commands are not executed and arguments
1469 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1470 This is useful for shell scripts to capture the driver-generated command lines.
1472 @item --help
1473 @opindex help
1474 Print (on the standard output) a description of the command-line options
1475 understood by @command{gcc}.  If the @option{-v} option is also specified
1476 then @option{--help} is also passed on to the various processes
1477 invoked by @command{gcc}, so that they can display the command-line options
1478 they accept.  If the @option{-Wextra} option has also been specified
1479 (prior to the @option{--help} option), then command-line options that
1480 have no documentation associated with them are also displayed.
1482 @item --target-help
1483 @opindex target-help
1484 Print (on the standard output) a description of target-specific command-line
1485 options for each tool.  For some targets extra target-specific
1486 information may also be printed.
1488 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1489 Print (on the standard output) a description of the command-line
1490 options understood by the compiler that fit into all specified classes
1491 and qualifiers.  These are the supported classes:
1493 @table @asis
1494 @item @samp{optimizers}
1495 Display all of the optimization options supported by the
1496 compiler.
1498 @item @samp{warnings}
1499 Display all of the options controlling warning messages
1500 produced by the compiler.
1502 @item @samp{target}
1503 Display target-specific options.  Unlike the
1504 @option{--target-help} option however, target-specific options of the
1505 linker and assembler are not displayed.  This is because those
1506 tools do not currently support the extended @option{--help=} syntax.
1508 @item @samp{params}
1509 Display the values recognized by the @option{--param}
1510 option.
1512 @item @var{language}
1513 Display the options supported for @var{language}, where
1514 @var{language} is the name of one of the languages supported in this
1515 version of GCC@.
1517 @item @samp{common}
1518 Display the options that are common to all languages.
1519 @end table
1521 These are the supported qualifiers:
1523 @table @asis
1524 @item @samp{undocumented}
1525 Display only those options that are undocumented.
1527 @item @samp{joined}
1528 Display options taking an argument that appears after an equal
1529 sign in the same continuous piece of text, such as:
1530 @samp{--help=target}.
1532 @item @samp{separate}
1533 Display options taking an argument that appears as a separate word
1534 following the original option, such as: @samp{-o output-file}.
1535 @end table
1537 Thus for example to display all the undocumented target-specific
1538 switches supported by the compiler, use:
1540 @smallexample
1541 --help=target,undocumented
1542 @end smallexample
1544 The sense of a qualifier can be inverted by prefixing it with the
1545 @samp{^} character, so for example to display all binary warning
1546 options (i.e., ones that are either on or off and that do not take an
1547 argument) that have a description, use:
1549 @smallexample
1550 --help=warnings,^joined,^undocumented
1551 @end smallexample
1553 The argument to @option{--help=} should not consist solely of inverted
1554 qualifiers.
1556 Combining several classes is possible, although this usually
1557 restricts the output so much that there is nothing to display.  One
1558 case where it does work, however, is when one of the classes is
1559 @var{target}.  For example, to display all the target-specific
1560 optimization options, use:
1562 @smallexample
1563 --help=target,optimizers
1564 @end smallexample
1566 The @option{--help=} option can be repeated on the command line.  Each
1567 successive use displays its requested class of options, skipping
1568 those that have already been displayed.
1570 If the @option{-Q} option appears on the command line before the
1571 @option{--help=} option, then the descriptive text displayed by
1572 @option{--help=} is changed.  Instead of describing the displayed
1573 options, an indication is given as to whether the option is enabled,
1574 disabled or set to a specific value (assuming that the compiler
1575 knows this at the point where the @option{--help=} option is used).
1577 Here is a truncated example from the ARM port of @command{gcc}:
1579 @smallexample
1580   % gcc -Q -mabi=2 --help=target -c
1581   The following options are target specific:
1582   -mabi=                                2
1583   -mabort-on-noreturn                   [disabled]
1584   -mapcs                                [disabled]
1585 @end smallexample
1587 The output is sensitive to the effects of previous command-line
1588 options, so for example it is possible to find out which optimizations
1589 are enabled at @option{-O2} by using:
1591 @smallexample
1592 -Q -O2 --help=optimizers
1593 @end smallexample
1595 Alternatively you can discover which binary optimizations are enabled
1596 by @option{-O3} by using:
1598 @smallexample
1599 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1600 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1601 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1602 @end smallexample
1604 @item --version
1605 @opindex version
1606 Display the version number and copyrights of the invoked GCC@.
1608 @item -pass-exit-codes
1609 @opindex pass-exit-codes
1610 Normally the @command{gcc} program exits with the code of 1 if any
1611 phase of the compiler returns a non-success return code.  If you specify
1612 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1613 the numerically highest error produced by any phase returning an error
1614 indication.  The C, C++, and Fortran front ends return 4 if an internal
1615 compiler error is encountered.
1617 @item -pipe
1618 @opindex pipe
1619 Use pipes rather than temporary files for communication between the
1620 various stages of compilation.  This fails to work on some systems where
1621 the assembler is unable to read from a pipe; but the GNU assembler has
1622 no trouble.
1624 @item -specs=@var{file}
1625 @opindex specs
1626 Process @var{file} after the compiler reads in the standard @file{specs}
1627 file, in order to override the defaults which the @command{gcc} driver
1628 program uses when determining what switches to pass to @command{cc1},
1629 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1630 @option{-specs=@var{file}} can be specified on the command line, and they
1631 are processed in order, from left to right.  @xref{Spec Files}, for
1632 information about the format of the @var{file}.
1634 @item -wrapper
1635 @opindex wrapper
1636 Invoke all subcommands under a wrapper program.  The name of the
1637 wrapper program and its parameters are passed as a comma separated
1638 list.
1640 @smallexample
1641 gcc -c t.c -wrapper gdb,--args
1642 @end smallexample
1644 @noindent
1645 This invokes all subprograms of @command{gcc} under
1646 @samp{gdb --args}, thus the invocation of @command{cc1} is
1647 @samp{gdb --args cc1 @dots{}}.
1649 @item -fplugin=@var{name}.so
1650 @opindex fplugin
1651 Load the plugin code in file @var{name}.so, assumed to be a
1652 shared object to be dlopen'd by the compiler.  The base name of
1653 the shared object file is used to identify the plugin for the
1654 purposes of argument parsing (See
1655 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1656 Each plugin should define the callback functions specified in the
1657 Plugins API.
1659 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1660 @opindex fplugin-arg
1661 Define an argument called @var{key} with a value of @var{value}
1662 for the plugin called @var{name}.
1664 @item -fdump-ada-spec@r{[}-slim@r{]}
1665 @opindex fdump-ada-spec
1666 For C and C++ source and include files, generate corresponding Ada specs.
1667 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1668 GNAT User's Guide}, which provides detailed documentation on this feature.
1670 @item -fada-spec-parent=@var{unit}
1671 @opindex fada-spec-parent
1672 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1673 Ada specs as child units of parent @var{unit}.
1675 @item -fdump-go-spec=@var{file}
1676 @opindex fdump-go-spec
1677 For input files in any language, generate corresponding Go
1678 declarations in @var{file}.  This generates Go @code{const},
1679 @code{type}, @code{var}, and @code{func} declarations which may be a
1680 useful way to start writing a Go interface to code written in some
1681 other language.
1683 @include @value{srcdir}/../libiberty/at-file.texi
1684 @end table
1686 @node Invoking G++
1687 @section Compiling C++ Programs
1689 @cindex suffixes for C++ source
1690 @cindex C++ source file suffixes
1691 C++ source files conventionally use one of the suffixes @samp{.C},
1692 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1693 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1694 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1695 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1696 files with these names and compiles them as C++ programs even if you
1697 call the compiler the same way as for compiling C programs (usually
1698 with the name @command{gcc}).
1700 @findex g++
1701 @findex c++
1702 However, the use of @command{gcc} does not add the C++ library.
1703 @command{g++} is a program that calls GCC and automatically specifies linking
1704 against the C++ library.  It treats @samp{.c},
1705 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1706 files unless @option{-x} is used.  This program is also useful when
1707 precompiling a C header file with a @samp{.h} extension for use in C++
1708 compilations.  On many systems, @command{g++} is also installed with
1709 the name @command{c++}.
1711 @cindex invoking @command{g++}
1712 When you compile C++ programs, you may specify many of the same
1713 command-line options that you use for compiling programs in any
1714 language; or command-line options meaningful for C and related
1715 languages; or options that are meaningful only for C++ programs.
1716 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1717 explanations of options for languages related to C@.
1718 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1719 explanations of options that are meaningful only for C++ programs.
1721 @node C Dialect Options
1722 @section Options Controlling C Dialect
1723 @cindex dialect options
1724 @cindex language dialect options
1725 @cindex options, dialect
1727 The following options control the dialect of C (or languages derived
1728 from C, such as C++, Objective-C and Objective-C++) that the compiler
1729 accepts:
1731 @table @gcctabopt
1732 @cindex ANSI support
1733 @cindex ISO support
1734 @item -ansi
1735 @opindex ansi
1736 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1737 equivalent to @option{-std=c++98}.
1739 This turns off certain features of GCC that are incompatible with ISO
1740 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1741 such as the @code{asm} and @code{typeof} keywords, and
1742 predefined macros such as @code{unix} and @code{vax} that identify the
1743 type of system you are using.  It also enables the undesirable and
1744 rarely used ISO trigraph feature.  For the C compiler,
1745 it disables recognition of C++ style @samp{//} comments as well as
1746 the @code{inline} keyword.
1748 The alternate keywords @code{__asm__}, @code{__extension__},
1749 @code{__inline__} and @code{__typeof__} continue to work despite
1750 @option{-ansi}.  You would not want to use them in an ISO C program, of
1751 course, but it is useful to put them in header files that might be included
1752 in compilations done with @option{-ansi}.  Alternate predefined macros
1753 such as @code{__unix__} and @code{__vax__} are also available, with or
1754 without @option{-ansi}.
1756 The @option{-ansi} option does not cause non-ISO programs to be
1757 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1758 addition to @option{-ansi}.  @xref{Warning Options}.
1760 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1761 option is used.  Some header files may notice this macro and refrain
1762 from declaring certain functions or defining certain macros that the
1763 ISO standard doesn't call for; this is to avoid interfering with any
1764 programs that might use these names for other things.
1766 Functions that are normally built in but do not have semantics
1767 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1768 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1769 built-in functions provided by GCC}, for details of the functions
1770 affected.
1772 @item -std=
1773 @opindex std
1774 Determine the language standard. @xref{Standards,,Language Standards
1775 Supported by GCC}, for details of these standard versions.  This option
1776 is currently only supported when compiling C or C++.
1778 The compiler can accept several base standards, such as @samp{c90} or
1779 @samp{c++98}, and GNU dialects of those standards, such as
1780 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1781 compiler accepts all programs following that standard plus those
1782 using GNU extensions that do not contradict it.  For example,
1783 @option{-std=c90} turns off certain features of GCC that are
1784 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1785 keywords, but not other GNU extensions that do not have a meaning in
1786 ISO C90, such as omitting the middle term of a @code{?:}
1787 expression. On the other hand, when a GNU dialect of a standard is
1788 specified, all features supported by the compiler are enabled, even when
1789 those features change the meaning of the base standard.  As a result, some
1790 strict-conforming programs may be rejected.  The particular standard
1791 is used by @option{-Wpedantic} to identify which features are GNU
1792 extensions given that version of the standard. For example
1793 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1794 comments, while @option{-std=gnu99 -Wpedantic} does not.
1796 A value for this option must be provided; possible values are
1798 @table @samp
1799 @item c90
1800 @itemx c89
1801 @itemx iso9899:1990
1802 Support all ISO C90 programs (certain GNU extensions that conflict
1803 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1805 @item iso9899:199409
1806 ISO C90 as modified in amendment 1.
1808 @item c99
1809 @itemx c9x
1810 @itemx iso9899:1999
1811 @itemx iso9899:199x
1812 ISO C99.  This standard is substantially completely supported, modulo
1813 bugs and floating-point issues
1814 (mainly but not entirely relating to optional C99 features from
1815 Annexes F and G).  See
1816 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1817 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1819 @item c11
1820 @itemx c1x
1821 @itemx iso9899:2011
1822 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1823 substantially completely supported, modulo bugs, floating-point issues
1824 (mainly but not entirely relating to optional C11 features from
1825 Annexes F and G) and the optional Annexes K (Bounds-checking
1826 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1828 @item gnu90
1829 @itemx gnu89
1830 GNU dialect of ISO C90 (including some C99 features).
1832 @item gnu99
1833 @itemx gnu9x
1834 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1836 @item gnu11
1837 @itemx gnu1x
1838 GNU dialect of ISO C11.  This is the default for C code.
1839 The name @samp{gnu1x} is deprecated.
1841 @item c++98
1842 @itemx c++03
1843 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1844 additional defect reports. Same as @option{-ansi} for C++ code.
1846 @item gnu++98
1847 @itemx gnu++03
1848 GNU dialect of @option{-std=c++98}.
1850 @item c++11
1851 @itemx c++0x
1852 The 2011 ISO C++ standard plus amendments.
1853 The name @samp{c++0x} is deprecated.
1855 @item gnu++11
1856 @itemx gnu++0x
1857 GNU dialect of @option{-std=c++11}.
1858 The name @samp{gnu++0x} is deprecated.
1860 @item c++14
1861 @itemx c++1y
1862 The 2014 ISO C++ standard plus amendments.
1863 The name @samp{c++1y} is deprecated.
1865 @item gnu++14
1866 @itemx gnu++1y
1867 GNU dialect of @option{-std=c++14}.
1868 This is the default for C++ code.
1869 The name @samp{gnu++1y} is deprecated.
1871 @item c++1z
1872 The next revision of the ISO C++ standard, tentatively planned for
1873 2017.  Support is highly experimental, and will almost certainly
1874 change in incompatible ways in future releases.
1876 @item gnu++1z
1877 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1878 and will almost certainly change in incompatible ways in future
1879 releases.
1880 @end table
1882 @item -fgnu89-inline
1883 @opindex fgnu89-inline
1884 The option @option{-fgnu89-inline} tells GCC to use the traditional
1885 GNU semantics for @code{inline} functions when in C99 mode.
1886 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1887 Using this option is roughly equivalent to adding the
1888 @code{gnu_inline} function attribute to all inline functions
1889 (@pxref{Function Attributes}).
1891 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1892 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1893 specifies the default behavior).
1894 This option is not supported in @option{-std=c90} or
1895 @option{-std=gnu90} mode.
1897 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1898 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1899 in effect for @code{inline} functions.  @xref{Common Predefined
1900 Macros,,,cpp,The C Preprocessor}.
1902 @item -fpermitted-flt-eval-methods=@var{style}
1903 @opindex fpermitted-flt-eval-methods
1904 @opindex fpermitted-flt-eval-methods=c11
1905 @opindex fpermitted-flt-eval-methods=ts-18661-3
1906 ISO/IEC TS 18661-3 defines new permissible values for
1907 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1908 a semantic type that is an interchange or extended format should be
1909 evaluated to the precision and range of that type.  These new values are
1910 a superset of those permitted under C99/C11, which does not specify the
1911 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1912 conforming to C11 may not have been written expecting the possibility of
1913 the new values.
1915 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1916 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1917 or the extended set of values specified in ISO/IEC TS 18661-3.
1919 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1921 The default when in a standards compliant mode (@option{-std=c11} or similar)
1922 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1923 dialect (@option{-std=gnu11} or similar) is
1924 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1926 @item -aux-info @var{filename}
1927 @opindex aux-info
1928 Output to the given filename prototyped declarations for all functions
1929 declared and/or defined in a translation unit, including those in header
1930 files.  This option is silently ignored in any language other than C@.
1932 Besides declarations, the file indicates, in comments, the origin of
1933 each declaration (source file and line), whether the declaration was
1934 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1935 @samp{O} for old, respectively, in the first character after the line
1936 number and the colon), and whether it came from a declaration or a
1937 definition (@samp{C} or @samp{F}, respectively, in the following
1938 character).  In the case of function definitions, a K&R-style list of
1939 arguments followed by their declarations is also provided, inside
1940 comments, after the declaration.
1942 @item -fallow-parameterless-variadic-functions
1943 @opindex fallow-parameterless-variadic-functions
1944 Accept variadic functions without named parameters.
1946 Although it is possible to define such a function, this is not very
1947 useful as it is not possible to read the arguments.  This is only
1948 supported for C as this construct is allowed by C++.
1950 @item -fno-asm
1951 @opindex fno-asm
1952 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1953 keyword, so that code can use these words as identifiers.  You can use
1954 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1955 instead.  @option{-ansi} implies @option{-fno-asm}.
1957 In C++, this switch only affects the @code{typeof} keyword, since
1958 @code{asm} and @code{inline} are standard keywords.  You may want to
1959 use the @option{-fno-gnu-keywords} flag instead, which has the same
1960 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1961 switch only affects the @code{asm} and @code{typeof} keywords, since
1962 @code{inline} is a standard keyword in ISO C99.
1964 @item -fno-builtin
1965 @itemx -fno-builtin-@var{function}
1966 @opindex fno-builtin
1967 @cindex built-in functions
1968 Don't recognize built-in functions that do not begin with
1969 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1970 functions provided by GCC}, for details of the functions affected,
1971 including those which are not built-in functions when @option{-ansi} or
1972 @option{-std} options for strict ISO C conformance are used because they
1973 do not have an ISO standard meaning.
1975 GCC normally generates special code to handle certain built-in functions
1976 more efficiently; for instance, calls to @code{alloca} may become single
1977 instructions which adjust the stack directly, and calls to @code{memcpy}
1978 may become inline copy loops.  The resulting code is often both smaller
1979 and faster, but since the function calls no longer appear as such, you
1980 cannot set a breakpoint on those calls, nor can you change the behavior
1981 of the functions by linking with a different library.  In addition,
1982 when a function is recognized as a built-in function, GCC may use
1983 information about that function to warn about problems with calls to
1984 that function, or to generate more efficient code, even if the
1985 resulting code still contains calls to that function.  For example,
1986 warnings are given with @option{-Wformat} for bad calls to
1987 @code{printf} when @code{printf} is built in and @code{strlen} is
1988 known not to modify global memory.
1990 With the @option{-fno-builtin-@var{function}} option
1991 only the built-in function @var{function} is
1992 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1993 function is named that is not built-in in this version of GCC, this
1994 option is ignored.  There is no corresponding
1995 @option{-fbuiltin-@var{function}} option; if you wish to enable
1996 built-in functions selectively when using @option{-fno-builtin} or
1997 @option{-ffreestanding}, you may define macros such as:
1999 @smallexample
2000 #define abs(n)          __builtin_abs ((n))
2001 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2002 @end smallexample
2004 @item -fgimple
2005 @opindex fgimple
2007 Enable parsing of function definitions marked with @code{__GIMPLE}.
2008 This is an experimental feature that allows unit testing of GIMPLE
2009 passes.
2011 @item -fhosted
2012 @opindex fhosted
2013 @cindex hosted environment
2015 Assert that compilation targets a hosted environment.  This implies
2016 @option{-fbuiltin}.  A hosted environment is one in which the
2017 entire standard library is available, and in which @code{main} has a return
2018 type of @code{int}.  Examples are nearly everything except a kernel.
2019 This is equivalent to @option{-fno-freestanding}.
2021 @item -ffreestanding
2022 @opindex ffreestanding
2023 @cindex hosted environment
2025 Assert that compilation targets a freestanding environment.  This
2026 implies @option{-fno-builtin}.  A freestanding environment
2027 is one in which the standard library may not exist, and program startup may
2028 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2029 This is equivalent to @option{-fno-hosted}.
2031 @xref{Standards,,Language Standards Supported by GCC}, for details of
2032 freestanding and hosted environments.
2034 @item -fopenacc
2035 @opindex fopenacc
2036 @cindex OpenACC accelerator programming
2037 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2038 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2039 compiler generates accelerated code according to the OpenACC Application
2040 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2041 implies @option{-pthread}, and thus is only supported on targets that
2042 have support for @option{-pthread}.
2044 @item -fopenacc-dim=@var{geom}
2045 @opindex fopenacc-dim
2046 @cindex OpenACC accelerator programming
2047 Specify default compute dimensions for parallel offload regions that do
2048 not explicitly specify.  The @var{geom} value is a triple of
2049 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2050 can be omitted, to use a target-specific default value.
2052 @item -fopenmp
2053 @opindex fopenmp
2054 @cindex OpenMP parallel
2055 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2056 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2057 compiler generates parallel code according to the OpenMP Application
2058 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2059 implies @option{-pthread}, and thus is only supported on targets that
2060 have support for @option{-pthread}. @option{-fopenmp} implies
2061 @option{-fopenmp-simd}.
2063 @item -fopenmp-simd
2064 @opindex fopenmp-simd
2065 @cindex OpenMP SIMD
2066 @cindex SIMD
2067 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2068 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2069 are ignored.
2071 @item -fcilkplus
2072 @opindex fcilkplus
2073 @cindex Enable Cilk Plus
2074 Enable the usage of Cilk Plus language extension features for C/C++.
2075 When the option @option{-fcilkplus} is specified, enable the usage of
2076 the Cilk Plus Language extension features for C/C++.  The present
2077 implementation follows ABI version 1.2.  This is an experimental
2078 feature that is only partially complete, and whose interface may
2079 change in future versions of GCC as the official specification
2080 changes.  Currently, all features but @code{_Cilk_for} have been
2081 implemented.
2083 @item -fgnu-tm
2084 @opindex fgnu-tm
2085 When the option @option{-fgnu-tm} is specified, the compiler
2086 generates code for the Linux variant of Intel's current Transactional
2087 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2088 an experimental feature whose interface may change in future versions
2089 of GCC, as the official specification changes.  Please note that not
2090 all architectures are supported for this feature.
2092 For more information on GCC's support for transactional memory,
2093 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2094 Transactional Memory Library}.
2096 Note that the transactional memory feature is not supported with
2097 non-call exceptions (@option{-fnon-call-exceptions}).
2099 @item -fms-extensions
2100 @opindex fms-extensions
2101 Accept some non-standard constructs used in Microsoft header files.
2103 In C++ code, this allows member names in structures to be similar
2104 to previous types declarations.
2106 @smallexample
2107 typedef int UOW;
2108 struct ABC @{
2109   UOW UOW;
2111 @end smallexample
2113 Some cases of unnamed fields in structures and unions are only
2114 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2115 fields within structs/unions}, for details.
2117 Note that this option is off for all targets but x86 
2118 targets using ms-abi.
2120 @item -fplan9-extensions
2121 @opindex fplan9-extensions
2122 Accept some non-standard constructs used in Plan 9 code.
2124 This enables @option{-fms-extensions}, permits passing pointers to
2125 structures with anonymous fields to functions that expect pointers to
2126 elements of the type of the field, and permits referring to anonymous
2127 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2128 struct/union fields within structs/unions}, for details.  This is only
2129 supported for C, not C++.
2131 @item -fcond-mismatch
2132 @opindex fcond-mismatch
2133 Allow conditional expressions with mismatched types in the second and
2134 third arguments.  The value of such an expression is void.  This option
2135 is not supported for C++.
2137 @item -flax-vector-conversions
2138 @opindex flax-vector-conversions
2139 Allow implicit conversions between vectors with differing numbers of
2140 elements and/or incompatible element types.  This option should not be
2141 used for new code.
2143 @item -funsigned-char
2144 @opindex funsigned-char
2145 Let the type @code{char} be unsigned, like @code{unsigned char}.
2147 Each kind of machine has a default for what @code{char} should
2148 be.  It is either like @code{unsigned char} by default or like
2149 @code{signed char} by default.
2151 Ideally, a portable program should always use @code{signed char} or
2152 @code{unsigned char} when it depends on the signedness of an object.
2153 But many programs have been written to use plain @code{char} and
2154 expect it to be signed, or expect it to be unsigned, depending on the
2155 machines they were written for.  This option, and its inverse, let you
2156 make such a program work with the opposite default.
2158 The type @code{char} is always a distinct type from each of
2159 @code{signed char} or @code{unsigned char}, even though its behavior
2160 is always just like one of those two.
2162 @item -fsigned-char
2163 @opindex fsigned-char
2164 Let the type @code{char} be signed, like @code{signed char}.
2166 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2167 the negative form of @option{-funsigned-char}.  Likewise, the option
2168 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2170 @item -fsigned-bitfields
2171 @itemx -funsigned-bitfields
2172 @itemx -fno-signed-bitfields
2173 @itemx -fno-unsigned-bitfields
2174 @opindex fsigned-bitfields
2175 @opindex funsigned-bitfields
2176 @opindex fno-signed-bitfields
2177 @opindex fno-unsigned-bitfields
2178 These options control whether a bit-field is signed or unsigned, when the
2179 declaration does not use either @code{signed} or @code{unsigned}.  By
2180 default, such a bit-field is signed, because this is consistent: the
2181 basic integer types such as @code{int} are signed types.
2183 @item -fsso-struct=@var{endianness}
2184 @opindex fsso-struct
2185 Set the default scalar storage order of structures and unions to the
2186 specified endianness.  The accepted values are @samp{big-endian},
2187 @samp{little-endian} and @samp{native} for the native endianness of
2188 the target (the default).  This option is not supported for C++.
2190 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2191 code that is not binary compatible with code generated without it if the
2192 specified endianness is not the native endianness of the target.
2193 @end table
2195 @node C++ Dialect Options
2196 @section Options Controlling C++ Dialect
2198 @cindex compiler options, C++
2199 @cindex C++ options, command-line
2200 @cindex options, C++
2201 This section describes the command-line options that are only meaningful
2202 for C++ programs.  You can also use most of the GNU compiler options
2203 regardless of what language your program is in.  For example, you
2204 might compile a file @file{firstClass.C} like this:
2206 @smallexample
2207 g++ -g -fstrict-enums -O -c firstClass.C
2208 @end smallexample
2210 @noindent
2211 In this example, only @option{-fstrict-enums} is an option meant
2212 only for C++ programs; you can use the other options with any
2213 language supported by GCC@.
2215 Some options for compiling C programs, such as @option{-std}, are also
2216 relevant for C++ programs.
2217 @xref{C Dialect Options,,Options Controlling C Dialect}.
2219 Here is a list of options that are @emph{only} for compiling C++ programs:
2221 @table @gcctabopt
2223 @item -fabi-version=@var{n}
2224 @opindex fabi-version
2225 Use version @var{n} of the C++ ABI@.  The default is version 0.
2227 Version 0 refers to the version conforming most closely to
2228 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2229 will change in different versions of G++ as ABI bugs are fixed.
2231 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2233 Version 2 is the version of the C++ ABI that first appeared in G++
2234 3.4, and was the default through G++ 4.9.
2236 Version 3 corrects an error in mangling a constant address as a
2237 template argument.
2239 Version 4, which first appeared in G++ 4.5, implements a standard
2240 mangling for vector types.
2242 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2243 attribute const/volatile on function pointer types, decltype of a
2244 plain decl, and use of a function parameter in the declaration of
2245 another parameter.
2247 Version 6, which first appeared in G++ 4.7, corrects the promotion
2248 behavior of C++11 scoped enums and the mangling of template argument
2249 packs, const/static_cast, prefix ++ and --, and a class scope function
2250 used as a template argument.
2252 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2253 builtin type and corrects the mangling of lambdas in default argument
2254 scope.
2256 Version 8, which first appeared in G++ 4.9, corrects the substitution
2257 behavior of function types with function-cv-qualifiers.
2259 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2260 @code{nullptr_t}.
2262 Version 10, which first appeared in G++ 6.1, adds mangling of
2263 attributes that affect type identity, such as ia32 calling convention
2264 attributes (e.g. @samp{stdcall}).
2266 Version 11, which first appeared in G++ 7, corrects the mangling of
2267 sizeof... expressions and operator names.  For multiple entities with
2268 the same name within a function, that are declared in different scopes,
2269 the mangling now changes starting with the twelfth occurrence.  It also
2270 implies @option{-fnew-inheriting-ctors}.
2272 See also @option{-Wabi}.
2274 @item -fabi-compat-version=@var{n}
2275 @opindex fabi-compat-version
2276 On targets that support strong aliases, G++
2277 works around mangling changes by creating an alias with the correct
2278 mangled name when defining a symbol with an incorrect mangled name.
2279 This switch specifies which ABI version to use for the alias.
2281 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2282 compatibility).  If another ABI version is explicitly selected, this
2283 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2284 use @option{-fabi-compat-version=2}.
2286 If this option is not provided but @option{-Wabi=@var{n}} is, that
2287 version is used for compatibility aliases.  If this option is provided
2288 along with @option{-Wabi} (without the version), the version from this
2289 option is used for the warning.
2291 @item -fno-access-control
2292 @opindex fno-access-control
2293 Turn off all access checking.  This switch is mainly useful for working
2294 around bugs in the access control code.
2296 @item -faligned-new
2297 @opindex faligned-new
2298 Enable support for C++17 @code{new} of types that require more
2299 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2300 numeric argument such as @code{-faligned-new=32} can be used to
2301 specify how much alignment (in bytes) is provided by that function,
2302 but few users will need to override the default of
2303 @code{alignof(std::max_align_t)}.
2305 This flag is enabled by default for @option{-std=c++1z}.
2307 @item -fcheck-new
2308 @opindex fcheck-new
2309 Check that the pointer returned by @code{operator new} is non-null
2310 before attempting to modify the storage allocated.  This check is
2311 normally unnecessary because the C++ standard specifies that
2312 @code{operator new} only returns @code{0} if it is declared
2313 @code{throw()}, in which case the compiler always checks the
2314 return value even without this option.  In all other cases, when
2315 @code{operator new} has a non-empty exception specification, memory
2316 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2317 @samp{new (nothrow)}.
2319 @item -fconcepts
2320 @opindex fconcepts
2321 Enable support for the C++ Extensions for Concepts Technical
2322 Specification, ISO 19217 (2015), which allows code like
2324 @smallexample
2325 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2326 template <Addable T> T add (T a, T b) @{ return a + b; @}
2327 @end smallexample
2329 @item -fconstexpr-depth=@var{n}
2330 @opindex fconstexpr-depth
2331 Set the maximum nested evaluation depth for C++11 constexpr functions
2332 to @var{n}.  A limit is needed to detect endless recursion during
2333 constant expression evaluation.  The minimum specified by the standard
2334 is 512.
2336 @item -fconstexpr-loop-limit=@var{n}
2337 @opindex fconstexpr-loop-limit
2338 Set the maximum number of iterations for a loop in C++14 constexpr functions
2339 to @var{n}.  A limit is needed to detect infinite loops during
2340 constant expression evaluation.  The default is 262144 (1<<18).
2342 @item -fdeduce-init-list
2343 @opindex fdeduce-init-list
2344 Enable deduction of a template type parameter as
2345 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2347 @smallexample
2348 template <class T> auto forward(T t) -> decltype (realfn (t))
2350   return realfn (t);
2353 void f()
2355   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2357 @end smallexample
2359 This deduction was implemented as a possible extension to the
2360 originally proposed semantics for the C++11 standard, but was not part
2361 of the final standard, so it is disabled by default.  This option is
2362 deprecated, and may be removed in a future version of G++.
2364 @item -ffriend-injection
2365 @opindex ffriend-injection
2366 Inject friend functions into the enclosing namespace, so that they are
2367 visible outside the scope of the class in which they are declared.
2368 Friend functions were documented to work this way in the old Annotated
2369 C++ Reference Manual.  
2370 However, in ISO C++ a friend function that is not declared
2371 in an enclosing scope can only be found using argument dependent
2372 lookup.  GCC defaults to the standard behavior.
2374 This option is for compatibility, and may be removed in a future
2375 release of G++.
2377 @item -fno-elide-constructors
2378 @opindex fno-elide-constructors
2379 The C++ standard allows an implementation to omit creating a temporary
2380 that is only used to initialize another object of the same type.
2381 Specifying this option disables that optimization, and forces G++ to
2382 call the copy constructor in all cases.  This option also causes G++
2383 to call trivial member functions which otherwise would be expanded inline.
2385 In C++17, the compiler is required to omit these temporaries, but this
2386 option still affects trivial member functions.
2388 @item -fno-enforce-eh-specs
2389 @opindex fno-enforce-eh-specs
2390 Don't generate code to check for violation of exception specifications
2391 at run time.  This option violates the C++ standard, but may be useful
2392 for reducing code size in production builds, much like defining
2393 @code{NDEBUG}.  This does not give user code permission to throw
2394 exceptions in violation of the exception specifications; the compiler
2395 still optimizes based on the specifications, so throwing an
2396 unexpected exception results in undefined behavior at run time.
2398 @item -fextern-tls-init
2399 @itemx -fno-extern-tls-init
2400 @opindex fextern-tls-init
2401 @opindex fno-extern-tls-init
2402 The C++11 and OpenMP standards allow @code{thread_local} and
2403 @code{threadprivate} variables to have dynamic (runtime)
2404 initialization.  To support this, any use of such a variable goes
2405 through a wrapper function that performs any necessary initialization.
2406 When the use and definition of the variable are in the same
2407 translation unit, this overhead can be optimized away, but when the
2408 use is in a different translation unit there is significant overhead
2409 even if the variable doesn't actually need dynamic initialization.  If
2410 the programmer can be sure that no use of the variable in a
2411 non-defining TU needs to trigger dynamic initialization (either
2412 because the variable is statically initialized, or a use of the
2413 variable in the defining TU will be executed before any uses in
2414 another TU), they can avoid this overhead with the
2415 @option{-fno-extern-tls-init} option.
2417 On targets that support symbol aliases, the default is
2418 @option{-fextern-tls-init}.  On targets that do not support symbol
2419 aliases, the default is @option{-fno-extern-tls-init}.
2421 @item -ffor-scope
2422 @itemx -fno-for-scope
2423 @opindex ffor-scope
2424 @opindex fno-for-scope
2425 If @option{-ffor-scope} is specified, the scope of variables declared in
2426 a @i{for-init-statement} is limited to the @code{for} loop itself,
2427 as specified by the C++ standard.
2428 If @option{-fno-for-scope} is specified, the scope of variables declared in
2429 a @i{for-init-statement} extends to the end of the enclosing scope,
2430 as was the case in old versions of G++, and other (traditional)
2431 implementations of C++.
2433 If neither flag is given, the default is to follow the standard,
2434 but to allow and give a warning for old-style code that would
2435 otherwise be invalid, or have different behavior.
2437 @item -fno-gnu-keywords
2438 @opindex fno-gnu-keywords
2439 Do not recognize @code{typeof} as a keyword, so that code can use this
2440 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2441 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2442 @option{-std=c++98}, @option{-std=c++11}, etc.
2444 @item -fno-implicit-templates
2445 @opindex fno-implicit-templates
2446 Never emit code for non-inline templates that are instantiated
2447 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2448 @xref{Template Instantiation}, for more information.
2450 @item -fno-implicit-inline-templates
2451 @opindex fno-implicit-inline-templates
2452 Don't emit code for implicit instantiations of inline templates, either.
2453 The default is to handle inlines differently so that compiles with and
2454 without optimization need the same set of explicit instantiations.
2456 @item -fno-implement-inlines
2457 @opindex fno-implement-inlines
2458 To save space, do not emit out-of-line copies of inline functions
2459 controlled by @code{#pragma implementation}.  This causes linker
2460 errors if these functions are not inlined everywhere they are called.
2462 @item -fms-extensions
2463 @opindex fms-extensions
2464 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2465 int and getting a pointer to member function via non-standard syntax.
2467 @item -fnew-inheriting-ctors
2468 @opindex fnew-inheriting-ctors
2469 Enable the P0136 adjustment to the semantics of C++11 constructor
2470 inheritance.  This is part of C++17 but also considered to be a Defect
2471 Report against C++11 and C++14.  This flag is enabled by default
2472 unless @option{-fabi-version=10} or lower is specified.
2474 @item -fnew-ttp-matching
2475 @opindex fnew-ttp-matching
2476 Enable the P0522 resolution to Core issue 150, template template
2477 parameters and default arguments: this allows a template with default
2478 template arguments as an argument for a template template parameter
2479 with fewer template parameters.  This flag is enabled by default for
2480 @option{-std=c++1z}.
2482 @item -fno-nonansi-builtins
2483 @opindex fno-nonansi-builtins
2484 Disable built-in declarations of functions that are not mandated by
2485 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2486 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2488 @item -fnothrow-opt
2489 @opindex fnothrow-opt
2490 Treat a @code{throw()} exception specification as if it were a
2491 @code{noexcept} specification to reduce or eliminate the text size
2492 overhead relative to a function with no exception specification.  If
2493 the function has local variables of types with non-trivial
2494 destructors, the exception specification actually makes the
2495 function smaller because the EH cleanups for those variables can be
2496 optimized away.  The semantic effect is that an exception thrown out of
2497 a function with such an exception specification results in a call
2498 to @code{terminate} rather than @code{unexpected}.
2500 @item -fno-operator-names
2501 @opindex fno-operator-names
2502 Do not treat the operator name keywords @code{and}, @code{bitand},
2503 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2504 synonyms as keywords.
2506 @item -fno-optional-diags
2507 @opindex fno-optional-diags
2508 Disable diagnostics that the standard says a compiler does not need to
2509 issue.  Currently, the only such diagnostic issued by G++ is the one for
2510 a name having multiple meanings within a class.
2512 @item -fpermissive
2513 @opindex fpermissive
2514 Downgrade some diagnostics about nonconformant code from errors to
2515 warnings.  Thus, using @option{-fpermissive} allows some
2516 nonconforming code to compile.
2518 @item -fno-pretty-templates
2519 @opindex fno-pretty-templates
2520 When an error message refers to a specialization of a function
2521 template, the compiler normally prints the signature of the
2522 template followed by the template arguments and any typedefs or
2523 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2524 rather than @code{void f(int)}) so that it's clear which template is
2525 involved.  When an error message refers to a specialization of a class
2526 template, the compiler omits any template arguments that match
2527 the default template arguments for that template.  If either of these
2528 behaviors make it harder to understand the error message rather than
2529 easier, you can use @option{-fno-pretty-templates} to disable them.
2531 @item -frepo
2532 @opindex frepo
2533 Enable automatic template instantiation at link time.  This option also
2534 implies @option{-fno-implicit-templates}.  @xref{Template
2535 Instantiation}, for more information.
2537 @item -fno-rtti
2538 @opindex fno-rtti
2539 Disable generation of information about every class with virtual
2540 functions for use by the C++ run-time type identification features
2541 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2542 of the language, you can save some space by using this flag.  Note that
2543 exception handling uses the same information, but G++ generates it as
2544 needed. The @code{dynamic_cast} operator can still be used for casts that
2545 do not require run-time type information, i.e.@: casts to @code{void *} or to
2546 unambiguous base classes.
2548 @item -fsized-deallocation
2549 @opindex fsized-deallocation
2550 Enable the built-in global declarations
2551 @smallexample
2552 void operator delete (void *, std::size_t) noexcept;
2553 void operator delete[] (void *, std::size_t) noexcept;
2554 @end smallexample
2555 as introduced in C++14.  This is useful for user-defined replacement
2556 deallocation functions that, for example, use the size of the object
2557 to make deallocation faster.  Enabled by default under
2558 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2559 warns about places that might want to add a definition.
2561 @item -fstrict-enums
2562 @opindex fstrict-enums
2563 Allow the compiler to optimize using the assumption that a value of
2564 enumerated type can only be one of the values of the enumeration (as
2565 defined in the C++ standard; basically, a value that can be
2566 represented in the minimum number of bits needed to represent all the
2567 enumerators).  This assumption may not be valid if the program uses a
2568 cast to convert an arbitrary integer value to the enumerated type.
2570 @item -fstrong-eval-order
2571 @opindex fstrong-eval-order
2572 Evaluate member access, array subscripting, and shift expressions in
2573 left-to-right order, and evaluate assignment in right-to-left order,
2574 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2575 @option{-fstrong-eval-order=some} enables just the ordering of member
2576 access and shift expressions, and is the default without
2577 @option{-std=c++1z}.
2579 @item -ftemplate-backtrace-limit=@var{n}
2580 @opindex ftemplate-backtrace-limit
2581 Set the maximum number of template instantiation notes for a single
2582 warning or error to @var{n}.  The default value is 10.
2584 @item -ftemplate-depth=@var{n}
2585 @opindex ftemplate-depth
2586 Set the maximum instantiation depth for template classes to @var{n}.
2587 A limit on the template instantiation depth is needed to detect
2588 endless recursions during template class instantiation.  ANSI/ISO C++
2589 conforming programs must not rely on a maximum depth greater than 17
2590 (changed to 1024 in C++11).  The default value is 900, as the compiler
2591 can run out of stack space before hitting 1024 in some situations.
2593 @item -fno-threadsafe-statics
2594 @opindex fno-threadsafe-statics
2595 Do not emit the extra code to use the routines specified in the C++
2596 ABI for thread-safe initialization of local statics.  You can use this
2597 option to reduce code size slightly in code that doesn't need to be
2598 thread-safe.
2600 @item -fuse-cxa-atexit
2601 @opindex fuse-cxa-atexit
2602 Register destructors for objects with static storage duration with the
2603 @code{__cxa_atexit} function rather than the @code{atexit} function.
2604 This option is required for fully standards-compliant handling of static
2605 destructors, but only works if your C library supports
2606 @code{__cxa_atexit}.
2608 @item -fno-use-cxa-get-exception-ptr
2609 @opindex fno-use-cxa-get-exception-ptr
2610 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2611 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2612 if the runtime routine is not available.
2614 @item -fvisibility-inlines-hidden
2615 @opindex fvisibility-inlines-hidden
2616 This switch declares that the user does not attempt to compare
2617 pointers to inline functions or methods where the addresses of the two functions
2618 are taken in different shared objects.
2620 The effect of this is that GCC may, effectively, mark inline methods with
2621 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2622 appear in the export table of a DSO and do not require a PLT indirection
2623 when used within the DSO@.  Enabling this option can have a dramatic effect
2624 on load and link times of a DSO as it massively reduces the size of the
2625 dynamic export table when the library makes heavy use of templates.
2627 The behavior of this switch is not quite the same as marking the
2628 methods as hidden directly, because it does not affect static variables
2629 local to the function or cause the compiler to deduce that
2630 the function is defined in only one shared object.
2632 You may mark a method as having a visibility explicitly to negate the
2633 effect of the switch for that method.  For example, if you do want to
2634 compare pointers to a particular inline method, you might mark it as
2635 having default visibility.  Marking the enclosing class with explicit
2636 visibility has no effect.
2638 Explicitly instantiated inline methods are unaffected by this option
2639 as their linkage might otherwise cross a shared library boundary.
2640 @xref{Template Instantiation}.
2642 @item -fvisibility-ms-compat
2643 @opindex fvisibility-ms-compat
2644 This flag attempts to use visibility settings to make GCC's C++
2645 linkage model compatible with that of Microsoft Visual Studio.
2647 The flag makes these changes to GCC's linkage model:
2649 @enumerate
2650 @item
2651 It sets the default visibility to @code{hidden}, like
2652 @option{-fvisibility=hidden}.
2654 @item
2655 Types, but not their members, are not hidden by default.
2657 @item
2658 The One Definition Rule is relaxed for types without explicit
2659 visibility specifications that are defined in more than one
2660 shared object: those declarations are permitted if they are
2661 permitted when this option is not used.
2662 @end enumerate
2664 In new code it is better to use @option{-fvisibility=hidden} and
2665 export those classes that are intended to be externally visible.
2666 Unfortunately it is possible for code to rely, perhaps accidentally,
2667 on the Visual Studio behavior.
2669 Among the consequences of these changes are that static data members
2670 of the same type with the same name but defined in different shared
2671 objects are different, so changing one does not change the other;
2672 and that pointers to function members defined in different shared
2673 objects may not compare equal.  When this flag is given, it is a
2674 violation of the ODR to define types with the same name differently.
2676 @item -fno-weak
2677 @opindex fno-weak
2678 Do not use weak symbol support, even if it is provided by the linker.
2679 By default, G++ uses weak symbols if they are available.  This
2680 option exists only for testing, and should not be used by end-users;
2681 it results in inferior code and has no benefits.  This option may
2682 be removed in a future release of G++.
2684 @item -nostdinc++
2685 @opindex nostdinc++
2686 Do not search for header files in the standard directories specific to
2687 C++, but do still search the other standard directories.  (This option
2688 is used when building the C++ library.)
2689 @end table
2691 In addition, these optimization, warning, and code generation options
2692 have meanings only for C++ programs:
2694 @table @gcctabopt
2695 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2696 @opindex Wabi
2697 @opindex Wno-abi
2698 Warn when G++ it generates code that is probably not compatible with
2699 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2700 ABI with each major release, normally @option{-Wabi} will warn only if
2701 there is a check added later in a release series for an ABI issue
2702 discovered since the initial release.  @option{-Wabi} will warn about
2703 more things if an older ABI version is selected (with
2704 @option{-fabi-version=@var{n}}).
2706 @option{-Wabi} can also be used with an explicit version number to
2707 warn about compatibility with a particular @option{-fabi-version}
2708 level, e.g. @option{-Wabi=2} to warn about changes relative to
2709 @option{-fabi-version=2}.
2711 If an explicit version number is provided and
2712 @option{-fabi-compat-version} is not specified, the version number
2713 from this option is used for compatibility aliases.  If no explicit
2714 version number is provided with this option, but
2715 @option{-fabi-compat-version} is specified, that version number is
2716 used for ABI warnings.
2718 Although an effort has been made to warn about
2719 all such cases, there are probably some cases that are not warned about,
2720 even though G++ is generating incompatible code.  There may also be
2721 cases where warnings are emitted even though the code that is generated
2722 is compatible.
2724 You should rewrite your code to avoid these warnings if you are
2725 concerned about the fact that code generated by G++ may not be binary
2726 compatible with code generated by other compilers.
2728 Known incompatibilities in @option{-fabi-version=2} (which was the
2729 default from GCC 3.4 to 4.9) include:
2731 @itemize @bullet
2733 @item
2734 A template with a non-type template parameter of reference type was
2735 mangled incorrectly:
2736 @smallexample
2737 extern int N;
2738 template <int &> struct S @{@};
2739 void n (S<N>) @{2@}
2740 @end smallexample
2742 This was fixed in @option{-fabi-version=3}.
2744 @item
2745 SIMD vector types declared using @code{__attribute ((vector_size))} were
2746 mangled in a non-standard way that does not allow for overloading of
2747 functions taking vectors of different sizes.
2749 The mangling was changed in @option{-fabi-version=4}.
2751 @item
2752 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2753 qualifiers, and @code{decltype} of a plain declaration was folded away.
2755 These mangling issues were fixed in @option{-fabi-version=5}.
2757 @item
2758 Scoped enumerators passed as arguments to a variadic function are
2759 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2760 On most targets this does not actually affect the parameter passing
2761 ABI, as there is no way to pass an argument smaller than @code{int}.
2763 Also, the ABI changed the mangling of template argument packs,
2764 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2765 a class scope function used as a template argument.
2767 These issues were corrected in @option{-fabi-version=6}.
2769 @item
2770 Lambdas in default argument scope were mangled incorrectly, and the
2771 ABI changed the mangling of @code{nullptr_t}.
2773 These issues were corrected in @option{-fabi-version=7}.
2775 @item
2776 When mangling a function type with function-cv-qualifiers, the
2777 un-qualified function type was incorrectly treated as a substitution
2778 candidate.
2780 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2782 @item
2783 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2784 unaligned accesses.  Note that this did not affect the ABI of a
2785 function with a @code{nullptr_t} parameter, as parameters have a
2786 minimum alignment.
2788 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2790 @item
2791 Target-specific attributes that affect the identity of a type, such as
2792 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2793 did not affect the mangled name, leading to name collisions when
2794 function pointers were used as template arguments.
2796 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2798 @end itemize
2800 It also warns about psABI-related changes.  The known psABI changes at this
2801 point include:
2803 @itemize @bullet
2805 @item
2806 For SysV/x86-64, unions with @code{long double} members are 
2807 passed in memory as specified in psABI.  For example:
2809 @smallexample
2810 union U @{
2811   long double ld;
2812   int i;
2814 @end smallexample
2816 @noindent
2817 @code{union U} is always passed in memory.
2819 @end itemize
2821 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2822 @opindex Wabi-tag
2823 @opindex -Wabi-tag
2824 Warn when a type with an ABI tag is used in a context that does not
2825 have that ABI tag.  See @ref{C++ Attributes} for more information
2826 about ABI tags.
2828 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2829 @opindex Wctor-dtor-privacy
2830 @opindex Wno-ctor-dtor-privacy
2831 Warn when a class seems unusable because all the constructors or
2832 destructors in that class are private, and it has neither friends nor
2833 public static member functions.  Also warn if there are no non-private
2834 methods, and there's at least one private member function that isn't
2835 a constructor or destructor.
2837 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2838 @opindex Wdelete-non-virtual-dtor
2839 @opindex Wno-delete-non-virtual-dtor
2840 Warn when @code{delete} is used to destroy an instance of a class that
2841 has virtual functions and non-virtual destructor. It is unsafe to delete
2842 an instance of a derived class through a pointer to a base class if the
2843 base class does not have a virtual destructor.  This warning is enabled
2844 by @option{-Wall}.
2846 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2847 @opindex Wliteral-suffix
2848 @opindex Wno-literal-suffix
2849 Warn when a string or character literal is followed by a ud-suffix which does
2850 not begin with an underscore.  As a conforming extension, GCC treats such
2851 suffixes as separate preprocessing tokens in order to maintain backwards
2852 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2853 For example:
2855 @smallexample
2856 #define __STDC_FORMAT_MACROS
2857 #include <inttypes.h>
2858 #include <stdio.h>
2860 int main() @{
2861   int64_t i64 = 123;
2862   printf("My int64: %" PRId64"\n", i64);
2864 @end smallexample
2866 In this case, @code{PRId64} is treated as a separate preprocessing token.
2868 Additionally, warn when a user-defined literal operator is declared with
2869 a literal suffix identifier that doesn't begin with an underscore. Literal
2870 suffix identifiers that don't begin with an underscore are reserved for
2871 future standardization.
2873 This warning is enabled by default.
2875 @item -Wlto-type-mismatch
2876 @opindex Wlto-type-mismatch
2877 @opindex Wno-lto-type-mismatch
2879 During the link-time optimization warn about type mismatches in
2880 global declarations from different compilation units.
2881 Requires @option{-flto} to be enabled.  Enabled by default.
2883 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2884 @opindex Wnarrowing
2885 @opindex Wno-narrowing
2886 For C++11 and later standards, narrowing conversions are diagnosed by default,
2887 as required by the standard.  A narrowing conversion from a constant produces
2888 an error, and a narrowing conversion from a non-constant produces a warning,
2889 but @option{-Wno-narrowing} suppresses the diagnostic.
2890 Note that this does not affect the meaning of well-formed code;
2891 narrowing conversions are still considered ill-formed in SFINAE contexts.
2893 With @option{-Wnarrowing} in C++98, warn when a narrowing
2894 conversion prohibited by C++11 occurs within
2895 @samp{@{ @}}, e.g.
2897 @smallexample
2898 int i = @{ 2.2 @}; // error: narrowing from double to int
2899 @end smallexample
2901 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2903 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2904 @opindex Wnoexcept
2905 @opindex Wno-noexcept
2906 Warn when a noexcept-expression evaluates to false because of a call
2907 to a function that does not have a non-throwing exception
2908 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2909 the compiler to never throw an exception.
2911 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2912 @opindex Wnoexcept-type
2913 @opindex Wno-noexcept-type
2914 Warn if the C++1z feature making @code{noexcept} part of a function
2915 type changes the mangled name of a symbol relative to C++14.  Enabled
2916 by @option{-Wabi} and @option{-Wc++1z-compat}.
2918 @smallexample
2919 template <class T> void f(T t) @{ t(); @};
2920 void g() noexcept;
2921 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++1z calls f<void(*)()noexcept>
2922 @end smallexample
2924 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2925 @opindex Wclass-memaccess
2926 Warn when the destination of a call to a raw memory function such as
2927 @code{memset} or @code{memcpy} is an object of class type writing into which
2928 might bypass the class non-trivial or deleted constructor or copy assignment,
2929 violate const-correctness or encapsulation, or corrupt the virtual table.
2930 Modifying the representation of such objects may violate invariants maintained
2931 by member functions of the class.  For example, the call to @code{memset}
2932 below is undefined becase it modifies a non-trivial class object and is,
2933 therefore, diagnosed.  The safe way to either initialize or clear the storage
2934 of objects of such types is by using the appropriate constructor or assignment
2935 operator, if one is available.
2936 @smallexample
2937 std::string str = "abc";
2938 memset (&str, 0, 3);
2939 @end smallexample
2940 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2942 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2943 @opindex Wnon-virtual-dtor
2944 @opindex Wno-non-virtual-dtor
2945 Warn when a class has virtual functions and an accessible non-virtual
2946 destructor itself or in an accessible polymorphic base class, in which
2947 case it is possible but unsafe to delete an instance of a derived
2948 class through a pointer to the class itself or base class.  This
2949 warning is automatically enabled if @option{-Weffc++} is specified.
2951 @item -Wregister @r{(C++ and Objective-C++ only)}
2952 @opindex Wregister
2953 @opindex Wno-register
2954 Warn on uses of the @code{register} storage class specifier, except
2955 when it is part of the GNU @ref{Explicit Register Variables} extension.
2956 The use of the @code{register} keyword as storage class specifier has
2957 been deprecated in C++11 and removed in C++17.
2958 Enabled by default with @option{-std=c++1z}.
2960 @item -Wreorder @r{(C++ and Objective-C++ only)}
2961 @opindex Wreorder
2962 @opindex Wno-reorder
2963 @cindex reordering, warning
2964 @cindex warning for reordering of member initializers
2965 Warn when the order of member initializers given in the code does not
2966 match the order in which they must be executed.  For instance:
2968 @smallexample
2969 struct A @{
2970   int i;
2971   int j;
2972   A(): j (0), i (1) @{ @}
2974 @end smallexample
2976 @noindent
2977 The compiler rearranges the member initializers for @code{i}
2978 and @code{j} to match the declaration order of the members, emitting
2979 a warning to that effect.  This warning is enabled by @option{-Wall}.
2981 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2982 @opindex fext-numeric-literals
2983 @opindex fno-ext-numeric-literals
2984 Accept imaginary, fixed-point, or machine-defined
2985 literal number suffixes as GNU extensions.
2986 When this option is turned off these suffixes are treated
2987 as C++11 user-defined literal numeric suffixes.
2988 This is on by default for all pre-C++11 dialects and all GNU dialects:
2989 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2990 @option{-std=gnu++14}.
2991 This option is off by default
2992 for ISO C++11 onwards (@option{-std=c++11}, ...).
2993 @end table
2995 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2997 @table @gcctabopt
2998 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2999 @opindex Weffc++
3000 @opindex Wno-effc++
3001 Warn about violations of the following style guidelines from Scott Meyers'
3002 @cite{Effective C++} series of books:
3004 @itemize @bullet
3005 @item
3006 Define a copy constructor and an assignment operator for classes
3007 with dynamically-allocated memory.
3009 @item
3010 Prefer initialization to assignment in constructors.
3012 @item
3013 Have @code{operator=} return a reference to @code{*this}.
3015 @item
3016 Don't try to return a reference when you must return an object.
3018 @item
3019 Distinguish between prefix and postfix forms of increment and
3020 decrement operators.
3022 @item
3023 Never overload @code{&&}, @code{||}, or @code{,}.
3025 @end itemize
3027 This option also enables @option{-Wnon-virtual-dtor}, which is also
3028 one of the effective C++ recommendations.  However, the check is
3029 extended to warn about the lack of virtual destructor in accessible
3030 non-polymorphic bases classes too.
3032 When selecting this option, be aware that the standard library
3033 headers do not obey all of these guidelines; use @samp{grep -v}
3034 to filter out those warnings.
3036 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3037 @opindex Wstrict-null-sentinel
3038 @opindex Wno-strict-null-sentinel
3039 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3040 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3041 to @code{__null}.  Although it is a null pointer constant rather than a
3042 null pointer, it is guaranteed to be of the same size as a pointer.
3043 But this use is not portable across different compilers.
3045 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3046 @opindex Wno-non-template-friend
3047 @opindex Wnon-template-friend
3048 Disable warnings when non-template friend functions are declared
3049 within a template.  In very old versions of GCC that predate implementation
3050 of the ISO standard, declarations such as 
3051 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3052 could be interpreted as a particular specialization of a template
3053 function; the warning exists to diagnose compatibility problems, 
3054 and is enabled by default.
3056 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3057 @opindex Wold-style-cast
3058 @opindex Wno-old-style-cast
3059 Warn if an old-style (C-style) cast to a non-void type is used within
3060 a C++ program.  The new-style casts (@code{dynamic_cast},
3061 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3062 less vulnerable to unintended effects and much easier to search for.
3064 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3065 @opindex Woverloaded-virtual
3066 @opindex Wno-overloaded-virtual
3067 @cindex overloaded virtual function, warning
3068 @cindex warning for overloaded virtual function
3069 Warn when a function declaration hides virtual functions from a
3070 base class.  For example, in:
3072 @smallexample
3073 struct A @{
3074   virtual void f();
3077 struct B: public A @{
3078   void f(int);
3080 @end smallexample
3082 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3083 like:
3085 @smallexample
3086 B* b;
3087 b->f();
3088 @end smallexample
3090 @noindent
3091 fails to compile.
3093 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3094 @opindex Wno-pmf-conversions
3095 @opindex Wpmf-conversions
3096 Disable the diagnostic for converting a bound pointer to member function
3097 to a plain pointer.
3099 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3100 @opindex Wsign-promo
3101 @opindex Wno-sign-promo
3102 Warn when overload resolution chooses a promotion from unsigned or
3103 enumerated type to a signed type, over a conversion to an unsigned type of
3104 the same size.  Previous versions of G++ tried to preserve
3105 unsignedness, but the standard mandates the current behavior.
3107 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3108 @opindex Wtemplates
3109 Warn when a primary template declaration is encountered.  Some coding
3110 rules disallow templates, and this may be used to enforce that rule.
3111 The warning is inactive inside a system header file, such as the STL, so
3112 one can still use the STL.  One may also instantiate or specialize
3113 templates.
3115 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3116 @opindex Wmultiple-inheritance
3117 Warn when a class is defined with multiple direct base classes.  Some
3118 coding rules disallow multiple inheritance, and this may be used to
3119 enforce that rule.  The warning is inactive inside a system header file,
3120 such as the STL, so one can still use the STL.  One may also define
3121 classes that indirectly use multiple inheritance.
3123 @item -Wvirtual-inheritance
3124 @opindex Wvirtual-inheritance
3125 Warn when a class is defined with a virtual direct base class.  Some
3126 coding rules disallow multiple inheritance, and this may be used to
3127 enforce that rule.  The warning is inactive inside a system header file,
3128 such as the STL, so one can still use the STL.  One may also define
3129 classes that indirectly use virtual inheritance.
3131 @item -Wnamespaces
3132 @opindex Wnamespaces
3133 Warn when a namespace definition is opened.  Some coding rules disallow
3134 namespaces, and this may be used to enforce that rule.  The warning is
3135 inactive inside a system header file, such as the STL, so one can still
3136 use the STL.  One may also use using directives and qualified names.
3138 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3139 @opindex Wterminate
3140 @opindex Wno-terminate
3141 Disable the warning about a throw-expression that will immediately
3142 result in a call to @code{terminate}.
3143 @end table
3145 @node Objective-C and Objective-C++ Dialect Options
3146 @section Options Controlling Objective-C and Objective-C++ Dialects
3148 @cindex compiler options, Objective-C and Objective-C++
3149 @cindex Objective-C and Objective-C++ options, command-line
3150 @cindex options, Objective-C and Objective-C++
3151 (NOTE: This manual does not describe the Objective-C and Objective-C++
3152 languages themselves.  @xref{Standards,,Language Standards
3153 Supported by GCC}, for references.)
3155 This section describes the command-line options that are only meaningful
3156 for Objective-C and Objective-C++ programs.  You can also use most of
3157 the language-independent GNU compiler options.
3158 For example, you might compile a file @file{some_class.m} like this:
3160 @smallexample
3161 gcc -g -fgnu-runtime -O -c some_class.m
3162 @end smallexample
3164 @noindent
3165 In this example, @option{-fgnu-runtime} is an option meant only for
3166 Objective-C and Objective-C++ programs; you can use the other options with
3167 any language supported by GCC@.
3169 Note that since Objective-C is an extension of the C language, Objective-C
3170 compilations may also use options specific to the C front-end (e.g.,
3171 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3172 C++-specific options (e.g., @option{-Wabi}).
3174 Here is a list of options that are @emph{only} for compiling Objective-C
3175 and Objective-C++ programs:
3177 @table @gcctabopt
3178 @item -fconstant-string-class=@var{class-name}
3179 @opindex fconstant-string-class
3180 Use @var{class-name} as the name of the class to instantiate for each
3181 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3182 class name is @code{NXConstantString} if the GNU runtime is being used, and
3183 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3184 @option{-fconstant-cfstrings} option, if also present, overrides the
3185 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3186 to be laid out as constant CoreFoundation strings.
3188 @item -fgnu-runtime
3189 @opindex fgnu-runtime
3190 Generate object code compatible with the standard GNU Objective-C
3191 runtime.  This is the default for most types of systems.
3193 @item -fnext-runtime
3194 @opindex fnext-runtime
3195 Generate output compatible with the NeXT runtime.  This is the default
3196 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3197 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3198 used.
3200 @item -fno-nil-receivers
3201 @opindex fno-nil-receivers
3202 Assume that all Objective-C message dispatches (@code{[receiver
3203 message:arg]}) in this translation unit ensure that the receiver is
3204 not @code{nil}.  This allows for more efficient entry points in the
3205 runtime to be used.  This option is only available in conjunction with
3206 the NeXT runtime and ABI version 0 or 1.
3208 @item -fobjc-abi-version=@var{n}
3209 @opindex fobjc-abi-version
3210 Use version @var{n} of the Objective-C ABI for the selected runtime.
3211 This option is currently supported only for the NeXT runtime.  In that
3212 case, Version 0 is the traditional (32-bit) ABI without support for
3213 properties and other Objective-C 2.0 additions.  Version 1 is the
3214 traditional (32-bit) ABI with support for properties and other
3215 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3216 nothing is specified, the default is Version 0 on 32-bit target
3217 machines, and Version 2 on 64-bit target machines.
3219 @item -fobjc-call-cxx-cdtors
3220 @opindex fobjc-call-cxx-cdtors
3221 For each Objective-C class, check if any of its instance variables is a
3222 C++ object with a non-trivial default constructor.  If so, synthesize a
3223 special @code{- (id) .cxx_construct} instance method which runs
3224 non-trivial default constructors on any such instance variables, in order,
3225 and then return @code{self}.  Similarly, check if any instance variable
3226 is a C++ object with a non-trivial destructor, and if so, synthesize a
3227 special @code{- (void) .cxx_destruct} method which runs
3228 all such default destructors, in reverse order.
3230 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3231 methods thusly generated only operate on instance variables
3232 declared in the current Objective-C class, and not those inherited
3233 from superclasses.  It is the responsibility of the Objective-C
3234 runtime to invoke all such methods in an object's inheritance
3235 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3236 by the runtime immediately after a new object instance is allocated;
3237 the @code{- (void) .cxx_destruct} methods are invoked immediately
3238 before the runtime deallocates an object instance.
3240 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3241 support for invoking the @code{- (id) .cxx_construct} and
3242 @code{- (void) .cxx_destruct} methods.
3244 @item -fobjc-direct-dispatch
3245 @opindex fobjc-direct-dispatch
3246 Allow fast jumps to the message dispatcher.  On Darwin this is
3247 accomplished via the comm page.
3249 @item -fobjc-exceptions
3250 @opindex fobjc-exceptions
3251 Enable syntactic support for structured exception handling in
3252 Objective-C, similar to what is offered by C++.  This option
3253 is required to use the Objective-C keywords @code{@@try},
3254 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3255 @code{@@synchronized}.  This option is available with both the GNU
3256 runtime and the NeXT runtime (but not available in conjunction with
3257 the NeXT runtime on Mac OS X 10.2 and earlier).
3259 @item -fobjc-gc
3260 @opindex fobjc-gc
3261 Enable garbage collection (GC) in Objective-C and Objective-C++
3262 programs.  This option is only available with the NeXT runtime; the
3263 GNU runtime has a different garbage collection implementation that
3264 does not require special compiler flags.
3266 @item -fobjc-nilcheck
3267 @opindex fobjc-nilcheck
3268 For the NeXT runtime with version 2 of the ABI, check for a nil
3269 receiver in method invocations before doing the actual method call.
3270 This is the default and can be disabled using
3271 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3272 checked for nil in this way no matter what this flag is set to.
3273 Currently this flag does nothing when the GNU runtime, or an older
3274 version of the NeXT runtime ABI, is used.
3276 @item -fobjc-std=objc1
3277 @opindex fobjc-std
3278 Conform to the language syntax of Objective-C 1.0, the language
3279 recognized by GCC 4.0.  This only affects the Objective-C additions to
3280 the C/C++ language; it does not affect conformance to C/C++ standards,
3281 which is controlled by the separate C/C++ dialect option flags.  When
3282 this option is used with the Objective-C or Objective-C++ compiler,
3283 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3284 This is useful if you need to make sure that your Objective-C code can
3285 be compiled with older versions of GCC@.
3287 @item -freplace-objc-classes
3288 @opindex freplace-objc-classes
3289 Emit a special marker instructing @command{ld(1)} not to statically link in
3290 the resulting object file, and allow @command{dyld(1)} to load it in at
3291 run time instead.  This is used in conjunction with the Fix-and-Continue
3292 debugging mode, where the object file in question may be recompiled and
3293 dynamically reloaded in the course of program execution, without the need
3294 to restart the program itself.  Currently, Fix-and-Continue functionality
3295 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3296 and later.
3298 @item -fzero-link
3299 @opindex fzero-link
3300 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3301 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3302 compile time) with static class references that get initialized at load time,
3303 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3304 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3305 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3306 for individual class implementations to be modified during program execution.
3307 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3308 regardless of command-line options.
3310 @item -fno-local-ivars
3311 @opindex fno-local-ivars
3312 @opindex flocal-ivars
3313 By default instance variables in Objective-C can be accessed as if
3314 they were local variables from within the methods of the class they're
3315 declared in.  This can lead to shadowing between instance variables
3316 and other variables declared either locally inside a class method or
3317 globally with the same name.  Specifying the @option{-fno-local-ivars}
3318 flag disables this behavior thus avoiding variable shadowing issues.
3320 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3321 @opindex fivar-visibility
3322 Set the default instance variable visibility to the specified option
3323 so that instance variables declared outside the scope of any access
3324 modifier directives default to the specified visibility.
3326 @item -gen-decls
3327 @opindex gen-decls
3328 Dump interface declarations for all classes seen in the source file to a
3329 file named @file{@var{sourcename}.decl}.
3331 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3332 @opindex Wassign-intercept
3333 @opindex Wno-assign-intercept
3334 Warn whenever an Objective-C assignment is being intercepted by the
3335 garbage collector.
3337 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3338 @opindex Wno-protocol
3339 @opindex Wprotocol
3340 If a class is declared to implement a protocol, a warning is issued for
3341 every method in the protocol that is not implemented by the class.  The
3342 default behavior is to issue a warning for every method not explicitly
3343 implemented in the class, even if a method implementation is inherited
3344 from the superclass.  If you use the @option{-Wno-protocol} option, then
3345 methods inherited from the superclass are considered to be implemented,
3346 and no warning is issued for them.
3348 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3349 @opindex Wselector
3350 @opindex Wno-selector
3351 Warn if multiple methods of different types for the same selector are
3352 found during compilation.  The check is performed on the list of methods
3353 in the final stage of compilation.  Additionally, a check is performed
3354 for each selector appearing in a @code{@@selector(@dots{})}
3355 expression, and a corresponding method for that selector has been found
3356 during compilation.  Because these checks scan the method table only at
3357 the end of compilation, these warnings are not produced if the final
3358 stage of compilation is not reached, for example because an error is
3359 found during compilation, or because the @option{-fsyntax-only} option is
3360 being used.
3362 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3363 @opindex Wstrict-selector-match
3364 @opindex Wno-strict-selector-match
3365 Warn if multiple methods with differing argument and/or return types are
3366 found for a given selector when attempting to send a message using this
3367 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3368 is off (which is the default behavior), the compiler omits such warnings
3369 if any differences found are confined to types that share the same size
3370 and alignment.
3372 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3373 @opindex Wundeclared-selector
3374 @opindex Wno-undeclared-selector
3375 Warn if a @code{@@selector(@dots{})} expression referring to an
3376 undeclared selector is found.  A selector is considered undeclared if no
3377 method with that name has been declared before the
3378 @code{@@selector(@dots{})} expression, either explicitly in an
3379 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3380 an @code{@@implementation} section.  This option always performs its
3381 checks as soon as a @code{@@selector(@dots{})} expression is found,
3382 while @option{-Wselector} only performs its checks in the final stage of
3383 compilation.  This also enforces the coding style convention
3384 that methods and selectors must be declared before being used.
3386 @item -print-objc-runtime-info
3387 @opindex print-objc-runtime-info
3388 Generate C header describing the largest structure that is passed by
3389 value, if any.
3391 @end table
3393 @node Diagnostic Message Formatting Options
3394 @section Options to Control Diagnostic Messages Formatting
3395 @cindex options to control diagnostics formatting
3396 @cindex diagnostic messages
3397 @cindex message formatting
3399 Traditionally, diagnostic messages have been formatted irrespective of
3400 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3401 options described below
3402 to control the formatting algorithm for diagnostic messages, 
3403 e.g.@: how many characters per line, how often source location
3404 information should be reported.  Note that some language front ends may not
3405 honor these options.
3407 @table @gcctabopt
3408 @item -fmessage-length=@var{n}
3409 @opindex fmessage-length
3410 Try to format error messages so that they fit on lines of about
3411 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3412 done; each error message appears on a single line.  This is the
3413 default for all front ends.
3415 @item -fdiagnostics-show-location=once
3416 @opindex fdiagnostics-show-location
3417 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3418 reporter to emit source location information @emph{once}; that is, in
3419 case the message is too long to fit on a single physical line and has to
3420 be wrapped, the source location won't be emitted (as prefix) again,
3421 over and over, in subsequent continuation lines.  This is the default
3422 behavior.
3424 @item -fdiagnostics-show-location=every-line
3425 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3426 messages reporter to emit the same source location information (as
3427 prefix) for physical lines that result from the process of breaking
3428 a message which is too long to fit on a single line.
3430 @item -fdiagnostics-color[=@var{WHEN}]
3431 @itemx -fno-diagnostics-color
3432 @opindex fdiagnostics-color
3433 @cindex highlight, color
3434 @vindex GCC_COLORS @r{environment variable}
3435 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3436 or @samp{auto}.  The default depends on how the compiler has been configured,
3437 it can be any of the above @var{WHEN} options or also @samp{never}
3438 if @env{GCC_COLORS} environment variable isn't present in the environment,
3439 and @samp{auto} otherwise.
3440 @samp{auto} means to use color only when the standard error is a terminal.
3441 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3442 aliases for @option{-fdiagnostics-color=always} and
3443 @option{-fdiagnostics-color=never}, respectively.
3445 The colors are defined by the environment variable @env{GCC_COLORS}.
3446 Its value is a colon-separated list of capabilities and Select Graphic
3447 Rendition (SGR) substrings. SGR commands are interpreted by the
3448 terminal or terminal emulator.  (See the section in the documentation
3449 of your text terminal for permitted values and their meanings as
3450 character attributes.)  These substring values are integers in decimal
3451 representation and can be concatenated with semicolons.
3452 Common values to concatenate include
3453 @samp{1} for bold,
3454 @samp{4} for underline,
3455 @samp{5} for blink,
3456 @samp{7} for inverse,
3457 @samp{39} for default foreground color,
3458 @samp{30} to @samp{37} for foreground colors,
3459 @samp{90} to @samp{97} for 16-color mode foreground colors,
3460 @samp{38;5;0} to @samp{38;5;255}
3461 for 88-color and 256-color modes foreground colors,
3462 @samp{49} for default background color,
3463 @samp{40} to @samp{47} for background colors,
3464 @samp{100} to @samp{107} for 16-color mode background colors,
3465 and @samp{48;5;0} to @samp{48;5;255}
3466 for 88-color and 256-color modes background colors.
3468 The default @env{GCC_COLORS} is
3469 @smallexample
3470 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3471 quote=01:fixit-insert=32:fixit-delete=31:\
3472 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3473 type-diff=01;32
3474 @end smallexample
3475 @noindent
3476 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3477 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3478 @samp{01} is bold, and @samp{31} is red.
3479 Setting @env{GCC_COLORS} to the empty string disables colors.
3480 Supported capabilities are as follows.
3482 @table @code
3483 @item error=
3484 @vindex error GCC_COLORS @r{capability}
3485 SGR substring for error: markers.
3487 @item warning=
3488 @vindex warning GCC_COLORS @r{capability}
3489 SGR substring for warning: markers.
3491 @item note=
3492 @vindex note GCC_COLORS @r{capability}
3493 SGR substring for note: markers.
3495 @item range1=
3496 @vindex range1 GCC_COLORS @r{capability}
3497 SGR substring for first additional range.
3499 @item range2=
3500 @vindex range2 GCC_COLORS @r{capability}
3501 SGR substring for second additional range.
3503 @item locus=
3504 @vindex locus GCC_COLORS @r{capability}
3505 SGR substring for location information, @samp{file:line} or
3506 @samp{file:line:column} etc.
3508 @item quote=
3509 @vindex quote GCC_COLORS @r{capability}
3510 SGR substring for information printed within quotes.
3512 @item fixit-insert=
3513 @vindex fixit-insert GCC_COLORS @r{capability}
3514 SGR substring for fix-it hints suggesting text to
3515 be inserted or replaced.
3517 @item fixit-delete=
3518 @vindex fixit-delete GCC_COLORS @r{capability}
3519 SGR substring for fix-it hints suggesting text to
3520 be deleted.
3522 @item diff-filename=
3523 @vindex diff-filename GCC_COLORS @r{capability}
3524 SGR substring for filename headers within generated patches.
3526 @item diff-hunk=
3527 @vindex diff-hunk GCC_COLORS @r{capability}
3528 SGR substring for the starts of hunks within generated patches.
3530 @item diff-delete=
3531 @vindex diff-delete GCC_COLORS @r{capability}
3532 SGR substring for deleted lines within generated patches.
3534 @item diff-insert=
3535 @vindex diff-insert GCC_COLORS @r{capability}
3536 SGR substring for inserted lines within generated patches.
3538 @item type-diff=
3539 @vindex type-diff GCC_COLORS @r{capability}
3540 SGR substring for highlighting mismatching types within template
3541 arguments in the C++ frontend.
3542 @end table
3544 @item -fno-diagnostics-show-option
3545 @opindex fno-diagnostics-show-option
3546 @opindex fdiagnostics-show-option
3547 By default, each diagnostic emitted includes text indicating the
3548 command-line option that directly controls the diagnostic (if such an
3549 option is known to the diagnostic machinery).  Specifying the
3550 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3552 @item -fno-diagnostics-show-caret
3553 @opindex fno-diagnostics-show-caret
3554 @opindex fdiagnostics-show-caret
3555 By default, each diagnostic emitted includes the original source line
3556 and a caret @samp{^} indicating the column.  This option suppresses this
3557 information.  The source line is truncated to @var{n} characters, if
3558 the @option{-fmessage-length=n} option is given.  When the output is done
3559 to the terminal, the width is limited to the width given by the
3560 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3562 @item -fdiagnostics-parseable-fixits
3563 @opindex fdiagnostics-parseable-fixits
3564 Emit fix-it hints in a machine-parseable format, suitable for consumption
3565 by IDEs.  For each fix-it, a line will be printed after the relevant
3566 diagnostic, starting with the string ``fix-it:''.  For example:
3568 @smallexample
3569 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3570 @end smallexample
3572 The location is expressed as a half-open range, expressed as a count of
3573 bytes, starting at byte 1 for the initial column.  In the above example,
3574 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3575 given string:
3577 @smallexample
3578 00000000011111111112222222222
3579 12345678901234567890123456789
3580   gtk_widget_showall (dlg);
3581   ^^^^^^^^^^^^^^^^^^
3582   gtk_widget_show_all
3583 @end smallexample
3585 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3586 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3587 (e.g. vertical tab as ``\013'').
3589 An empty replacement string indicates that the given range is to be removed.
3590 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3591 be inserted at the given position.
3593 @item -fdiagnostics-generate-patch
3594 @opindex fdiagnostics-generate-patch
3595 Print fix-it hints to stderr in unified diff format, after any diagnostics
3596 are printed.  For example:
3598 @smallexample
3599 --- test.c
3600 +++ test.c
3601 @@ -42,5 +42,5 @@
3603  void show_cb(GtkDialog *dlg)
3604  @{
3605 -  gtk_widget_showall(dlg);
3606 +  gtk_widget_show_all(dlg);
3607  @}
3609 @end smallexample
3611 The diff may or may not be colorized, following the same rules
3612 as for diagnostics (see @option{-fdiagnostics-color}).
3614 @item -fdiagnostics-show-template-tree
3615 @opindex fdiagnostics-show-template-tree
3617 In the C++ frontend, when printing diagnostics showing mismatching
3618 template types, such as:
3620 @smallexample
3621   could not convert 'std::map<int, std::vector<double> >()'
3622     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3623 @end smallexample
3625 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3626 tree-like structure showing the common and differing parts of the types,
3627 such as:
3629 @smallexample
3630   map<
3631     [...],
3632     vector<
3633       [double != float]>>
3634 @end smallexample
3636 The parts that differ are highlighted with color (``double'' and
3637 ``float'' in this case).
3639 @item -fno-elide-type
3640 @opindex fno-elide-type
3641 @opindex felide-type
3642 By default when the C++ frontend prints diagnostics showing mismatching
3643 template types, common parts of the types are printed as ``[...]'' to
3644 simplify the error message.  For example:
3646 @smallexample
3647   could not convert 'std::map<int, std::vector<double> >()'
3648     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3649 @end smallexample
3651 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3652 This flag also affects the output of the
3653 @option{-fdiagnostics-show-template-tree} flag.
3655 @item -fno-show-column
3656 @opindex fno-show-column
3657 Do not print column numbers in diagnostics.  This may be necessary if
3658 diagnostics are being scanned by a program that does not understand the
3659 column numbers, such as @command{dejagnu}.
3661 @end table
3663 @node Warning Options
3664 @section Options to Request or Suppress Warnings
3665 @cindex options to control warnings
3666 @cindex warning messages
3667 @cindex messages, warning
3668 @cindex suppressing warnings
3670 Warnings are diagnostic messages that report constructions that
3671 are not inherently erroneous but that are risky or suggest there
3672 may have been an error.
3674 The following language-independent options do not enable specific
3675 warnings but control the kinds of diagnostics produced by GCC@.
3677 @table @gcctabopt
3678 @cindex syntax checking
3679 @item -fsyntax-only
3680 @opindex fsyntax-only
3681 Check the code for syntax errors, but don't do anything beyond that.
3683 @item -fmax-errors=@var{n}
3684 @opindex fmax-errors
3685 Limits the maximum number of error messages to @var{n}, at which point
3686 GCC bails out rather than attempting to continue processing the source
3687 code.  If @var{n} is 0 (the default), there is no limit on the number
3688 of error messages produced.  If @option{-Wfatal-errors} is also
3689 specified, then @option{-Wfatal-errors} takes precedence over this
3690 option.
3692 @item -w
3693 @opindex w
3694 Inhibit all warning messages.
3696 @item -Werror
3697 @opindex Werror
3698 @opindex Wno-error
3699 Make all warnings into errors.
3701 @item -Werror=
3702 @opindex Werror=
3703 @opindex Wno-error=
3704 Make the specified warning into an error.  The specifier for a warning
3705 is appended; for example @option{-Werror=switch} turns the warnings
3706 controlled by @option{-Wswitch} into errors.  This switch takes a
3707 negative form, to be used to negate @option{-Werror} for specific
3708 warnings; for example @option{-Wno-error=switch} makes
3709 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3710 is in effect.
3712 The warning message for each controllable warning includes the
3713 option that controls the warning.  That option can then be used with
3714 @option{-Werror=} and @option{-Wno-error=} as described above.
3715 (Printing of the option in the warning message can be disabled using the
3716 @option{-fno-diagnostics-show-option} flag.)
3718 Note that specifying @option{-Werror=}@var{foo} automatically implies
3719 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3720 imply anything.
3722 @item -Wfatal-errors
3723 @opindex Wfatal-errors
3724 @opindex Wno-fatal-errors
3725 This option causes the compiler to abort compilation on the first error
3726 occurred rather than trying to keep going and printing further error
3727 messages.
3729 @end table
3731 You can request many specific warnings with options beginning with
3732 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3733 implicit declarations.  Each of these specific warning options also
3734 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3735 example, @option{-Wno-implicit}.  This manual lists only one of the
3736 two forms, whichever is not the default.  For further
3737 language-specific options also refer to @ref{C++ Dialect Options} and
3738 @ref{Objective-C and Objective-C++ Dialect Options}.
3740 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3741 options, such as @option{-Wunused}, which may turn on further options,
3742 such as @option{-Wunused-value}. The combined effect of positive and
3743 negative forms is that more specific options have priority over less
3744 specific ones, independently of their position in the command-line. For
3745 options of the same specificity, the last one takes effect. Options
3746 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3747 as if they appeared at the end of the command-line.
3749 When an unrecognized warning option is requested (e.g.,
3750 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3751 that the option is not recognized.  However, if the @option{-Wno-} form
3752 is used, the behavior is slightly different: no diagnostic is
3753 produced for @option{-Wno-unknown-warning} unless other diagnostics
3754 are being produced.  This allows the use of new @option{-Wno-} options
3755 with old compilers, but if something goes wrong, the compiler
3756 warns that an unrecognized option is present.
3758 @table @gcctabopt
3759 @item -Wpedantic
3760 @itemx -pedantic
3761 @opindex pedantic
3762 @opindex Wpedantic
3763 Issue all the warnings demanded by strict ISO C and ISO C++;
3764 reject all programs that use forbidden extensions, and some other
3765 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3766 version of the ISO C standard specified by any @option{-std} option used.
3768 Valid ISO C and ISO C++ programs should compile properly with or without
3769 this option (though a rare few require @option{-ansi} or a
3770 @option{-std} option specifying the required version of ISO C)@.  However,
3771 without this option, certain GNU extensions and traditional C and C++
3772 features are supported as well.  With this option, they are rejected.
3774 @option{-Wpedantic} does not cause warning messages for use of the
3775 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3776 warnings are also disabled in the expression that follows
3777 @code{__extension__}.  However, only system header files should use
3778 these escape routes; application programs should avoid them.
3779 @xref{Alternate Keywords}.
3781 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3782 C conformance.  They soon find that it does not do quite what they want:
3783 it finds some non-ISO practices, but not all---only those for which
3784 ISO C @emph{requires} a diagnostic, and some others for which
3785 diagnostics have been added.
3787 A feature to report any failure to conform to ISO C might be useful in
3788 some instances, but would require considerable additional work and would
3789 be quite different from @option{-Wpedantic}.  We don't have plans to
3790 support such a feature in the near future.
3792 Where the standard specified with @option{-std} represents a GNU
3793 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3794 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3795 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3796 where they are required by the base standard.  (It does not make sense
3797 for such warnings to be given only for features not in the specified GNU
3798 C dialect, since by definition the GNU dialects of C include all
3799 features the compiler supports with the given option, and there would be
3800 nothing to warn about.)
3802 @item -pedantic-errors
3803 @opindex pedantic-errors
3804 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3805 requires a diagnostic, in some cases where there is undefined behavior
3806 at compile-time and in some other cases that do not prevent compilation
3807 of programs that are valid according to the standard. This is not
3808 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3809 by this option and not enabled by the latter and vice versa.
3811 @item -Wall
3812 @opindex Wall
3813 @opindex Wno-all
3814 This enables all the warnings about constructions that some users
3815 consider questionable, and that are easy to avoid (or modify to
3816 prevent the warning), even in conjunction with macros.  This also
3817 enables some language-specific warnings described in @ref{C++ Dialect
3818 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3820 @option{-Wall} turns on the following warning flags:
3822 @gccoptlist{-Waddress   @gol
3823 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3824 -Wbool-compare  @gol
3825 -Wbool-operation  @gol
3826 -Wc++11-compat  -Wc++14-compat  @gol
3827 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3828 -Wchar-subscripts  @gol
3829 -Wcomment  @gol
3830 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3831 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3832 -Wformat   @gol
3833 -Wint-in-bool-context  @gol
3834 -Wimplicit @r{(C and Objective-C only)} @gol
3835 -Wimplicit-int @r{(C and Objective-C only)} @gol
3836 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3837 -Winit-self @r{(only for C++)} @gol
3838 -Wlogical-not-parentheses @gol
3839 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3840 -Wmaybe-uninitialized @gol
3841 -Wmemset-elt-size @gol
3842 -Wmemset-transposed-args @gol
3843 -Wmisleading-indentation @r{(only for C/C++)} @gol
3844 -Wmissing-braces @r{(only for C/ObjC)} @gol
3845 -Wmultistatement-macros  @gol
3846 -Wnarrowing @r{(only for C++)}  @gol
3847 -Wnonnull  @gol
3848 -Wnonnull-compare  @gol
3849 -Wopenmp-simd @gol
3850 -Wparentheses  @gol
3851 -Wpointer-sign  @gol
3852 -Wreorder   @gol
3853 -Wreturn-type  @gol
3854 -Wsequence-point  @gol
3855 -Wsign-compare @r{(only in C++)}  @gol
3856 -Wsizeof-pointer-div @gol
3857 -Wsizeof-pointer-memaccess @gol
3858 -Wstrict-aliasing  @gol
3859 -Wstrict-overflow=1  @gol
3860 -Wswitch  @gol
3861 -Wtautological-compare  @gol
3862 -Wtrigraphs  @gol
3863 -Wuninitialized  @gol
3864 -Wunknown-pragmas  @gol
3865 -Wunused-function  @gol
3866 -Wunused-label     @gol
3867 -Wunused-value     @gol
3868 -Wunused-variable  @gol
3869 -Wvolatile-register-var @gol
3872 Note that some warning flags are not implied by @option{-Wall}.  Some of
3873 them warn about constructions that users generally do not consider
3874 questionable, but which occasionally you might wish to check for;
3875 others warn about constructions that are necessary or hard to avoid in
3876 some cases, and there is no simple way to modify the code to suppress
3877 the warning. Some of them are enabled by @option{-Wextra} but many of
3878 them must be enabled individually.
3880 @item -Wextra
3881 @opindex W
3882 @opindex Wextra
3883 @opindex Wno-extra
3884 This enables some extra warning flags that are not enabled by
3885 @option{-Wall}. (This option used to be called @option{-W}.  The older
3886 name is still supported, but the newer name is more descriptive.)
3888 @gccoptlist{-Wclobbered  @gol
3889 -Wempty-body  @gol
3890 -Wignored-qualifiers @gol
3891 -Wimplicit-fallthrough=3 @gol
3892 -Wmissing-field-initializers  @gol
3893 -Wmissing-parameter-type @r{(C only)}  @gol
3894 -Wold-style-declaration @r{(C only)}  @gol
3895 -Woverride-init  @gol
3896 -Wsign-compare @r{(C only)} @gol
3897 -Wtype-limits  @gol
3898 -Wuninitialized  @gol
3899 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3900 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3901 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3904 The option @option{-Wextra} also prints warning messages for the
3905 following cases:
3907 @itemize @bullet
3909 @item
3910 A pointer is compared against integer zero with @code{<}, @code{<=},
3911 @code{>}, or @code{>=}.
3913 @item
3914 (C++ only) An enumerator and a non-enumerator both appear in a
3915 conditional expression.
3917 @item
3918 (C++ only) Ambiguous virtual bases.
3920 @item
3921 (C++ only) Subscripting an array that has been declared @code{register}.
3923 @item
3924 (C++ only) Taking the address of a variable that has been declared
3925 @code{register}.
3927 @item
3928 (C++ only) A base class is not initialized in the copy constructor
3929 of a derived class.
3931 @end itemize
3933 @item -Wchar-subscripts
3934 @opindex Wchar-subscripts
3935 @opindex Wno-char-subscripts
3936 Warn if an array subscript has type @code{char}.  This is a common cause
3937 of error, as programmers often forget that this type is signed on some
3938 machines.
3939 This warning is enabled by @option{-Wall}.
3941 @item -Wchkp
3942 @opindex Wchkp
3943 Warn about an invalid memory access that is found by Pointer Bounds Checker
3944 (@option{-fcheck-pointer-bounds}).
3946 @item -Wno-coverage-mismatch
3947 @opindex Wno-coverage-mismatch
3948 Warn if feedback profiles do not match when using the
3949 @option{-fprofile-use} option.
3950 If a source file is changed between compiling with @option{-fprofile-gen} and
3951 with @option{-fprofile-use}, the files with the profile feedback can fail
3952 to match the source file and GCC cannot use the profile feedback
3953 information.  By default, this warning is enabled and is treated as an
3954 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3955 warning or @option{-Wno-error=coverage-mismatch} can be used to
3956 disable the error.  Disabling the error for this warning can result in
3957 poorly optimized code and is useful only in the
3958 case of very minor changes such as bug fixes to an existing code-base.
3959 Completely disabling the warning is not recommended.
3961 @item -Wno-cpp
3962 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3964 Suppress warning messages emitted by @code{#warning} directives.
3966 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3967 @opindex Wdouble-promotion
3968 @opindex Wno-double-promotion
3969 Give a warning when a value of type @code{float} is implicitly
3970 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3971 floating-point unit implement @code{float} in hardware, but emulate
3972 @code{double} in software.  On such a machine, doing computations
3973 using @code{double} values is much more expensive because of the
3974 overhead required for software emulation.
3976 It is easy to accidentally do computations with @code{double} because
3977 floating-point literals are implicitly of type @code{double}.  For
3978 example, in:
3979 @smallexample
3980 @group
3981 float area(float radius)
3983    return 3.14159 * radius * radius;
3985 @end group
3986 @end smallexample
3987 the compiler performs the entire computation with @code{double}
3988 because the floating-point literal is a @code{double}.
3990 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3991 @opindex Wduplicate-decl-specifier
3992 @opindex Wno-duplicate-decl-specifier
3993 Warn if a declaration has duplicate @code{const}, @code{volatile},
3994 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3995 @option{-Wall}.
3997 @item -Wformat
3998 @itemx -Wformat=@var{n}
3999 @opindex Wformat
4000 @opindex Wno-format
4001 @opindex ffreestanding
4002 @opindex fno-builtin
4003 @opindex Wformat=
4004 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4005 the arguments supplied have types appropriate to the format string
4006 specified, and that the conversions specified in the format string make
4007 sense.  This includes standard functions, and others specified by format
4008 attributes (@pxref{Function Attributes}), in the @code{printf},
4009 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4010 not in the C standard) families (or other target-specific families).
4011 Which functions are checked without format attributes having been
4012 specified depends on the standard version selected, and such checks of
4013 functions without the attribute specified are disabled by
4014 @option{-ffreestanding} or @option{-fno-builtin}.
4016 The formats are checked against the format features supported by GNU
4017 libc version 2.2.  These include all ISO C90 and C99 features, as well
4018 as features from the Single Unix Specification and some BSD and GNU
4019 extensions.  Other library implementations may not support all these
4020 features; GCC does not support warning about features that go beyond a
4021 particular library's limitations.  However, if @option{-Wpedantic} is used
4022 with @option{-Wformat}, warnings are given about format features not
4023 in the selected standard version (but not for @code{strfmon} formats,
4024 since those are not in any version of the C standard).  @xref{C Dialect
4025 Options,,Options Controlling C Dialect}.
4027 @table @gcctabopt
4028 @item -Wformat=1
4029 @itemx -Wformat
4030 @opindex Wformat
4031 @opindex Wformat=1
4032 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4033 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4034 @option{-Wformat} also checks for null format arguments for several
4035 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4036 aspects of this level of format checking can be disabled by the
4037 options: @option{-Wno-format-contains-nul},
4038 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4039 @option{-Wformat} is enabled by @option{-Wall}.
4041 @item -Wno-format-contains-nul
4042 @opindex Wno-format-contains-nul
4043 @opindex Wformat-contains-nul
4044 If @option{-Wformat} is specified, do not warn about format strings that
4045 contain NUL bytes.
4047 @item -Wno-format-extra-args
4048 @opindex Wno-format-extra-args
4049 @opindex Wformat-extra-args
4050 If @option{-Wformat} is specified, do not warn about excess arguments to a
4051 @code{printf} or @code{scanf} format function.  The C standard specifies
4052 that such arguments are ignored.
4054 Where the unused arguments lie between used arguments that are
4055 specified with @samp{$} operand number specifications, normally
4056 warnings are still given, since the implementation could not know what
4057 type to pass to @code{va_arg} to skip the unused arguments.  However,
4058 in the case of @code{scanf} formats, this option suppresses the
4059 warning if the unused arguments are all pointers, since the Single
4060 Unix Specification says that such unused arguments are allowed.
4062 @item -Wformat-overflow
4063 @itemx -Wformat-overflow=@var{level}
4064 @opindex Wformat-overflow
4065 @opindex Wno-format-overflow
4066 Warn about calls to formatted input/output functions such as @code{sprintf}
4067 and @code{vsprintf} that might overflow the destination buffer.  When the
4068 exact number of bytes written by a format directive cannot be determined
4069 at compile-time it is estimated based on heuristics that depend on the
4070 @var{level} argument and on optimization.  While enabling optimization
4071 will in most cases improve the accuracy of the warning, it may also
4072 result in false positives.
4074 @table @gcctabopt
4075 @item -Wformat-overflow
4076 @item -Wformat-overflow=1
4077 @opindex Wformat-overflow
4078 @opindex Wno-format-overflow
4079 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4080 employs a conservative approach that warns only about calls that most
4081 likely overflow the buffer.  At this level, numeric arguments to format
4082 directives with unknown values are assumed to have the value of one, and
4083 strings of unknown length to be empty.  Numeric arguments that are known
4084 to be bounded to a subrange of their type, or string arguments whose output
4085 is bounded either by their directive's precision or by a finite set of
4086 string literals, are assumed to take on the value within the range that
4087 results in the most bytes on output.  For example, the call to @code{sprintf}
4088 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4089 the terminating NUL character (@code{'\0'}) appended by the function
4090 to the destination buffer will be written past its end.  Increasing
4091 the size of the buffer by a single byte is sufficient to avoid the
4092 warning, though it may not be sufficient to avoid the overflow.
4094 @smallexample
4095 void f (int a, int b)
4097   char buf [12];
4098   sprintf (buf, "a = %i, b = %i\n", a, b);
4100 @end smallexample
4102 @item -Wformat-overflow=2
4103 Level @var{2} warns also about calls that might overflow the destination
4104 buffer given an argument of sufficient length or magnitude.  At level
4105 @var{2}, unknown numeric arguments are assumed to have the minimum
4106 representable value for signed types with a precision greater than 1, and
4107 the maximum representable value otherwise.  Unknown string arguments whose
4108 length cannot be assumed to be bounded either by the directive's precision,
4109 or by a finite set of string literals they may evaluate to, or the character
4110 array they may point to, are assumed to be 1 character long.
4112 At level @var{2}, the call in the example above is again diagnosed, but
4113 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4114 @code{%i} directive will write some of its digits beyond the end of
4115 the destination buffer.  To make the call safe regardless of the values
4116 of the two variables, the size of the destination buffer must be increased
4117 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4118 an informational note following the warning.
4120 An alternative to increasing the size of the destination buffer is to
4121 constrain the range of formatted values.  The maximum length of string
4122 arguments can be bounded by specifying the precision in the format
4123 directive.  When numeric arguments of format directives can be assumed
4124 to be bounded by less than the precision of their type, choosing
4125 an appropriate length modifier to the format specifier will reduce
4126 the required buffer size.  For example, if @var{a} and @var{b} in the
4127 example above can be assumed to be within the precision of
4128 the @code{short int} type then using either the @code{%hi} format
4129 directive or casting the argument to @code{short} reduces the maximum
4130 required size of the buffer to 24 bytes.
4132 @smallexample
4133 void f (int a, int b)
4135   char buf [23];
4136   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4138 @end smallexample
4139 @end table
4141 @item -Wno-format-zero-length
4142 @opindex Wno-format-zero-length
4143 @opindex Wformat-zero-length
4144 If @option{-Wformat} is specified, do not warn about zero-length formats.
4145 The C standard specifies that zero-length formats are allowed.
4148 @item -Wformat=2
4149 @opindex Wformat=2
4150 Enable @option{-Wformat} plus additional format checks.  Currently
4151 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4152 -Wformat-y2k}.
4154 @item -Wformat-nonliteral
4155 @opindex Wformat-nonliteral
4156 @opindex Wno-format-nonliteral
4157 If @option{-Wformat} is specified, also warn if the format string is not a
4158 string literal and so cannot be checked, unless the format function
4159 takes its format arguments as a @code{va_list}.
4161 @item -Wformat-security
4162 @opindex Wformat-security
4163 @opindex Wno-format-security
4164 If @option{-Wformat} is specified, also warn about uses of format
4165 functions that represent possible security problems.  At present, this
4166 warns about calls to @code{printf} and @code{scanf} functions where the
4167 format string is not a string literal and there are no format arguments,
4168 as in @code{printf (foo);}.  This may be a security hole if the format
4169 string came from untrusted input and contains @samp{%n}.  (This is
4170 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4171 in future warnings may be added to @option{-Wformat-security} that are not
4172 included in @option{-Wformat-nonliteral}.)
4174 @item -Wformat-signedness
4175 @opindex Wformat-signedness
4176 @opindex Wno-format-signedness
4177 If @option{-Wformat} is specified, also warn if the format string
4178 requires an unsigned argument and the argument is signed and vice versa.
4180 @item -Wformat-truncation
4181 @itemx -Wformat-truncation=@var{level}
4182 @opindex Wformat-truncation
4183 @opindex Wno-format-truncation
4184 Warn about calls to formatted input/output functions such as @code{snprintf}
4185 and @code{vsnprintf} that might result in output truncation.  When the exact
4186 number of bytes written by a format directive cannot be determined at
4187 compile-time it is estimated based on heuristics that depend on
4188 the @var{level} argument and on optimization.  While enabling optimization
4189 will in most cases improve the accuracy of the warning, it may also result
4190 in false positives.  Except as noted otherwise, the option uses the same
4191 logic @option{-Wformat-overflow}.
4193 @table @gcctabopt
4194 @item -Wformat-truncation
4195 @item -Wformat-truncation=1
4196 @opindex Wformat-truncation
4197 @opindex Wno-format-overflow
4198 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4199 employs a conservative approach that warns only about calls to bounded
4200 functions whose return value is unused and that will most likely result
4201 in output truncation.
4203 @item -Wformat-truncation=2
4204 Level @var{2} warns also about calls to bounded functions whose return
4205 value is used and that might result in truncation given an argument of
4206 sufficient length or magnitude.
4207 @end table
4209 @item -Wformat-y2k
4210 @opindex Wformat-y2k
4211 @opindex Wno-format-y2k
4212 If @option{-Wformat} is specified, also warn about @code{strftime}
4213 formats that may yield only a two-digit year.
4214 @end table
4216 @item -Wnonnull
4217 @opindex Wnonnull
4218 @opindex Wno-nonnull
4219 Warn about passing a null pointer for arguments marked as
4220 requiring a non-null value by the @code{nonnull} function attribute.
4222 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4223 can be disabled with the @option{-Wno-nonnull} option.
4225 @item -Wnonnull-compare
4226 @opindex Wnonnull-compare
4227 @opindex Wno-nonnull-compare
4228 Warn when comparing an argument marked with the @code{nonnull}
4229 function attribute against null inside the function.
4231 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4232 can be disabled with the @option{-Wno-nonnull-compare} option.
4234 @item -Wnull-dereference
4235 @opindex Wnull-dereference
4236 @opindex Wno-null-dereference
4237 Warn if the compiler detects paths that trigger erroneous or
4238 undefined behavior due to dereferencing a null pointer.  This option
4239 is only active when @option{-fdelete-null-pointer-checks} is active,
4240 which is enabled by optimizations in most targets.  The precision of
4241 the warnings depends on the optimization options used.
4243 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4244 @opindex Winit-self
4245 @opindex Wno-init-self
4246 Warn about uninitialized variables that are initialized with themselves.
4247 Note this option can only be used with the @option{-Wuninitialized} option.
4249 For example, GCC warns about @code{i} being uninitialized in the
4250 following snippet only when @option{-Winit-self} has been specified:
4251 @smallexample
4252 @group
4253 int f()
4255   int i = i;
4256   return i;
4258 @end group
4259 @end smallexample
4261 This warning is enabled by @option{-Wall} in C++.
4263 @item -Wimplicit-int @r{(C and Objective-C only)}
4264 @opindex Wimplicit-int
4265 @opindex Wno-implicit-int
4266 Warn when a declaration does not specify a type.
4267 This warning is enabled by @option{-Wall}.
4269 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4270 @opindex Wimplicit-function-declaration
4271 @opindex Wno-implicit-function-declaration
4272 Give a warning whenever a function is used before being declared. In
4273 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4274 enabled by default and it is made into an error by
4275 @option{-pedantic-errors}. This warning is also enabled by
4276 @option{-Wall}.
4278 @item -Wimplicit @r{(C and Objective-C only)}
4279 @opindex Wimplicit
4280 @opindex Wno-implicit
4281 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4282 This warning is enabled by @option{-Wall}.
4284 @item -Wimplicit-fallthrough
4285 @opindex Wimplicit-fallthrough
4286 @opindex Wno-implicit-fallthrough
4287 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4288 and @option{-Wno-implicit-fallthrough} is the same as
4289 @option{-Wimplicit-fallthrough=0}.
4291 @item -Wimplicit-fallthrough=@var{n}
4292 @opindex Wimplicit-fallthrough=
4293 Warn when a switch case falls through.  For example:
4295 @smallexample
4296 @group
4297 switch (cond)
4298   @{
4299   case 1:
4300     a = 1;
4301     break;
4302   case 2:
4303     a = 2;
4304   case 3:
4305     a = 3;
4306     break;
4307   @}
4308 @end group
4309 @end smallexample
4311 This warning does not warn when the last statement of a case cannot
4312 fall through, e.g. when there is a return statement or a call to function
4313 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4314 also takes into account control flow statements, such as ifs, and only
4315 warns when appropriate.  E.g.@:
4317 @smallexample
4318 @group
4319 switch (cond)
4320   @{
4321   case 1:
4322     if (i > 3) @{
4323       bar (5);
4324       break;
4325     @} else if (i < 1) @{
4326       bar (0);
4327     @} else
4328       return;
4329   default:
4330     @dots{}
4331   @}
4332 @end group
4333 @end smallexample
4335 Since there are occasions where a switch case fall through is desirable,
4336 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4337 to be used along with a null statement to suppress this warning that
4338 would normally occur:
4340 @smallexample
4341 @group
4342 switch (cond)
4343   @{
4344   case 1:
4345     bar (0);
4346     __attribute__ ((fallthrough));
4347   default:
4348     @dots{}
4349   @}
4350 @end group
4351 @end smallexample
4353 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4354 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4355 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4356 Instead of these attributes, it is also possible to add a fallthrough comment
4357 to silence the warning.  The whole body of the C or C++ style comment should
4358 match the given regular expressions listed below.  The option argument @var{n}
4359 specifies what kind of comments are accepted:
4361 @itemize @bullet
4363 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4365 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4366 expression, any comment is used as fallthrough comment.
4368 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4369 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4371 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4372 following regular expressions:
4374 @itemize @bullet
4376 @item @code{-fallthrough}
4378 @item @code{@@fallthrough@@}
4380 @item @code{lint -fallthrough[ \t]*}
4382 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4384 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4386 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4388 @end itemize
4390 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4391 following regular expressions:
4393 @itemize @bullet
4395 @item @code{-fallthrough}
4397 @item @code{@@fallthrough@@}
4399 @item @code{lint -fallthrough[ \t]*}
4401 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4403 @end itemize
4405 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4406 fallthrough comments, only attributes disable the warning.
4408 @end itemize
4410 The comment needs to be followed after optional whitespace and other comments
4411 by @code{case} or @code{default} keywords or by a user label that precedes some
4412 @code{case} or @code{default} label.
4414 @smallexample
4415 @group
4416 switch (cond)
4417   @{
4418   case 1:
4419     bar (0);
4420     /* FALLTHRU */
4421   default:
4422     @dots{}
4423   @}
4424 @end group
4425 @end smallexample
4427 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4429 @item -Wignored-qualifiers @r{(C and C++ only)}
4430 @opindex Wignored-qualifiers
4431 @opindex Wno-ignored-qualifiers
4432 Warn if the return type of a function has a type qualifier
4433 such as @code{const}.  For ISO C such a type qualifier has no effect,
4434 since the value returned by a function is not an lvalue.
4435 For C++, the warning is only emitted for scalar types or @code{void}.
4436 ISO C prohibits qualified @code{void} return types on function
4437 definitions, so such return types always receive a warning
4438 even without this option.
4440 This warning is also enabled by @option{-Wextra}.
4442 @item -Wignored-attributes @r{(C and C++ only)}
4443 @opindex Wignored-attributes
4444 @opindex Wno-ignored-attributes
4445 Warn when an attribute is ignored.  This is different from the
4446 @option{-Wattributes} option in that it warns whenever the compiler decides
4447 to drop an attribute, not that the attribute is either unknown, used in a
4448 wrong place, etc.  This warning is enabled by default.
4450 @item -Wmain
4451 @opindex Wmain
4452 @opindex Wno-main
4453 Warn if the type of @code{main} is suspicious.  @code{main} should be
4454 a function with external linkage, returning int, taking either zero
4455 arguments, two, or three arguments of appropriate types.  This warning
4456 is enabled by default in C++ and is enabled by either @option{-Wall}
4457 or @option{-Wpedantic}.
4459 @item -Wmisleading-indentation @r{(C and C++ only)}
4460 @opindex Wmisleading-indentation
4461 @opindex Wno-misleading-indentation
4462 Warn when the indentation of the code does not reflect the block structure.
4463 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4464 @code{for} clauses with a guarded statement that does not use braces,
4465 followed by an unguarded statement with the same indentation.
4467 In the following example, the call to ``bar'' is misleadingly indented as
4468 if it were guarded by the ``if'' conditional.
4470 @smallexample
4471   if (some_condition ())
4472     foo ();
4473     bar ();  /* Gotcha: this is not guarded by the "if".  */
4474 @end smallexample
4476 In the case of mixed tabs and spaces, the warning uses the
4477 @option{-ftabstop=} option to determine if the statements line up
4478 (defaulting to 8).
4480 The warning is not issued for code involving multiline preprocessor logic
4481 such as the following example.
4483 @smallexample
4484   if (flagA)
4485     foo (0);
4486 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4487   if (flagB)
4488 #endif
4489     foo (1);
4490 @end smallexample
4492 The warning is not issued after a @code{#line} directive, since this
4493 typically indicates autogenerated code, and no assumptions can be made
4494 about the layout of the file that the directive references.
4496 This warning is enabled by @option{-Wall} in C and C++.
4498 @item -Wmissing-braces
4499 @opindex Wmissing-braces
4500 @opindex Wno-missing-braces
4501 Warn if an aggregate or union initializer is not fully bracketed.  In
4502 the following example, the initializer for @code{a} is not fully
4503 bracketed, but that for @code{b} is fully bracketed.  This warning is
4504 enabled by @option{-Wall} in C.
4506 @smallexample
4507 int a[2][2] = @{ 0, 1, 2, 3 @};
4508 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4509 @end smallexample
4511 This warning is enabled by @option{-Wall}.
4513 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4514 @opindex Wmissing-include-dirs
4515 @opindex Wno-missing-include-dirs
4516 Warn if a user-supplied include directory does not exist.
4518 @item -Wmultistatement-macros
4519 @opindex Wmultistatement-macros
4520 @opindex Wno-multistatement-macros
4521 Warn about unsafe multiple statement macros that appear to be guarded
4522 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4523 @code{while}, in which only the first statement is actually guarded after
4524 the macro is expanded.
4526 For example:
4528 @smallexample
4529 #define DOIT x++; y++
4530 if (c)
4531   DOIT;
4532 @end smallexample
4534 will increment @code{y} unconditionally, not just when @code{c} holds.
4535 The can usually be fixed by wrapping the macro in a do-while loop:
4536 @smallexample
4537 #define DOIT do @{ x++; y++; @} while (0)
4538 if (c)
4539   DOIT;
4540 @end smallexample
4542 This warning is enabled by @option{-Wall} in C and C++.
4544 @item -Wparentheses
4545 @opindex Wparentheses
4546 @opindex Wno-parentheses
4547 Warn if parentheses are omitted in certain contexts, such
4548 as when there is an assignment in a context where a truth value
4549 is expected, or when operators are nested whose precedence people
4550 often get confused about.
4552 Also warn if a comparison like @code{x<=y<=z} appears; this is
4553 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4554 interpretation from that of ordinary mathematical notation.
4556 Also warn for dangerous uses of the GNU extension to
4557 @code{?:} with omitted middle operand. When the condition
4558 in the @code{?}: operator is a boolean expression, the omitted value is
4559 always 1.  Often programmers expect it to be a value computed
4560 inside the conditional expression instead.
4562 This warning is enabled by @option{-Wall}.
4564 @item -Wsequence-point
4565 @opindex Wsequence-point
4566 @opindex Wno-sequence-point
4567 Warn about code that may have undefined semantics because of violations
4568 of sequence point rules in the C and C++ standards.
4570 The C and C++ standards define the order in which expressions in a C/C++
4571 program are evaluated in terms of @dfn{sequence points}, which represent
4572 a partial ordering between the execution of parts of the program: those
4573 executed before the sequence point, and those executed after it.  These
4574 occur after the evaluation of a full expression (one which is not part
4575 of a larger expression), after the evaluation of the first operand of a
4576 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4577 function is called (but after the evaluation of its arguments and the
4578 expression denoting the called function), and in certain other places.
4579 Other than as expressed by the sequence point rules, the order of
4580 evaluation of subexpressions of an expression is not specified.  All
4581 these rules describe only a partial order rather than a total order,
4582 since, for example, if two functions are called within one expression
4583 with no sequence point between them, the order in which the functions
4584 are called is not specified.  However, the standards committee have
4585 ruled that function calls do not overlap.
4587 It is not specified when between sequence points modifications to the
4588 values of objects take effect.  Programs whose behavior depends on this
4589 have undefined behavior; the C and C++ standards specify that ``Between
4590 the previous and next sequence point an object shall have its stored
4591 value modified at most once by the evaluation of an expression.
4592 Furthermore, the prior value shall be read only to determine the value
4593 to be stored.''.  If a program breaks these rules, the results on any
4594 particular implementation are entirely unpredictable.
4596 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4597 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4598 diagnosed by this option, and it may give an occasional false positive
4599 result, but in general it has been found fairly effective at detecting
4600 this sort of problem in programs.
4602 The C++17 standard will define the order of evaluation of operands in
4603 more cases: in particular it requires that the right-hand side of an
4604 assignment be evaluated before the left-hand side, so the above
4605 examples are no longer undefined.  But this warning will still warn
4606 about them, to help people avoid writing code that is undefined in C
4607 and earlier revisions of C++.
4609 The standard is worded confusingly, therefore there is some debate
4610 over the precise meaning of the sequence point rules in subtle cases.
4611 Links to discussions of the problem, including proposed formal
4612 definitions, may be found on the GCC readings page, at
4613 @uref{http://gcc.gnu.org/@/readings.html}.
4615 This warning is enabled by @option{-Wall} for C and C++.
4617 @item -Wno-return-local-addr
4618 @opindex Wno-return-local-addr
4619 @opindex Wreturn-local-addr
4620 Do not warn about returning a pointer (or in C++, a reference) to a
4621 variable that goes out of scope after the function returns.
4623 @item -Wreturn-type
4624 @opindex Wreturn-type
4625 @opindex Wno-return-type
4626 Warn whenever a function is defined with a return type that defaults
4627 to @code{int}.  Also warn about any @code{return} statement with no
4628 return value in a function whose return type is not @code{void}
4629 (falling off the end of the function body is considered returning
4630 without a value).
4632 For C only, warn about a @code{return} statement with an expression in a
4633 function whose return type is @code{void}, unless the expression type is
4634 also @code{void}.  As a GNU extension, the latter case is accepted
4635 without a warning unless @option{-Wpedantic} is used.
4637 For C++, a function without return type always produces a diagnostic
4638 message, even when @option{-Wno-return-type} is specified.  The only
4639 exceptions are @code{main} and functions defined in system headers.
4641 This warning is enabled by @option{-Wall}.
4643 @item -Wshift-count-negative
4644 @opindex Wshift-count-negative
4645 @opindex Wno-shift-count-negative
4646 Warn if shift count is negative. This warning is enabled by default.
4648 @item -Wshift-count-overflow
4649 @opindex Wshift-count-overflow
4650 @opindex Wno-shift-count-overflow
4651 Warn if shift count >= width of type. This warning is enabled by default.
4653 @item -Wshift-negative-value
4654 @opindex Wshift-negative-value
4655 @opindex Wno-shift-negative-value
4656 Warn if left shifting a negative value.  This warning is enabled by
4657 @option{-Wextra} in C99 and C++11 modes (and newer).
4659 @item -Wshift-overflow
4660 @itemx -Wshift-overflow=@var{n}
4661 @opindex Wshift-overflow
4662 @opindex Wno-shift-overflow
4663 Warn about left shift overflows.  This warning is enabled by
4664 default in C99 and C++11 modes (and newer).
4666 @table @gcctabopt
4667 @item -Wshift-overflow=1
4668 This is the warning level of @option{-Wshift-overflow} and is enabled
4669 by default in C99 and C++11 modes (and newer).  This warning level does
4670 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4671 an overflow is still rejected in contexts where an integer constant expression
4672 is required.)
4674 @item -Wshift-overflow=2
4675 This warning level also warns about left-shifting 1 into the sign bit,
4676 unless C++14 mode is active.
4677 @end table
4679 @item -Wswitch
4680 @opindex Wswitch
4681 @opindex Wno-switch
4682 Warn whenever a @code{switch} statement has an index of enumerated type
4683 and lacks a @code{case} for one or more of the named codes of that
4684 enumeration.  (The presence of a @code{default} label prevents this
4685 warning.)  @code{case} labels outside the enumeration range also
4686 provoke warnings when this option is used (even if there is a
4687 @code{default} label).
4688 This warning is enabled by @option{-Wall}.
4690 @item -Wswitch-default
4691 @opindex Wswitch-default
4692 @opindex Wno-switch-default
4693 Warn whenever a @code{switch} statement does not have a @code{default}
4694 case.
4696 @item -Wswitch-enum
4697 @opindex Wswitch-enum
4698 @opindex Wno-switch-enum
4699 Warn whenever a @code{switch} statement has an index of enumerated type
4700 and lacks a @code{case} for one or more of the named codes of that
4701 enumeration.  @code{case} labels outside the enumeration range also
4702 provoke warnings when this option is used.  The only difference
4703 between @option{-Wswitch} and this option is that this option gives a
4704 warning about an omitted enumeration code even if there is a
4705 @code{default} label.
4707 @item -Wswitch-bool
4708 @opindex Wswitch-bool
4709 @opindex Wno-switch-bool
4710 Warn whenever a @code{switch} statement has an index of boolean type
4711 and the case values are outside the range of a boolean type.
4712 It is possible to suppress this warning by casting the controlling
4713 expression to a type other than @code{bool}.  For example:
4714 @smallexample
4715 @group
4716 switch ((int) (a == 4))
4717   @{
4718   @dots{}
4719   @}
4720 @end group
4721 @end smallexample
4722 This warning is enabled by default for C and C++ programs.
4724 @item -Wswitch-unreachable
4725 @opindex Wswitch-unreachable
4726 @opindex Wno-switch-unreachable
4727 Warn whenever a @code{switch} statement contains statements between the
4728 controlling expression and the first case label, which will never be
4729 executed.  For example:
4730 @smallexample
4731 @group
4732 switch (cond)
4733   @{
4734    i = 15;
4735   @dots{}
4736    case 5:
4737   @dots{}
4738   @}
4739 @end group
4740 @end smallexample
4741 @option{-Wswitch-unreachable} does not warn if the statement between the
4742 controlling expression and the first case label is just a declaration:
4743 @smallexample
4744 @group
4745 switch (cond)
4746   @{
4747    int i;
4748   @dots{}
4749    case 5:
4750    i = 5;
4751   @dots{}
4752   @}
4753 @end group
4754 @end smallexample
4755 This warning is enabled by default for C and C++ programs.
4757 @item -Wsync-nand @r{(C and C++ only)}
4758 @opindex Wsync-nand
4759 @opindex Wno-sync-nand
4760 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4761 built-in functions are used.  These functions changed semantics in GCC 4.4.
4763 @item -Wunused-but-set-parameter
4764 @opindex Wunused-but-set-parameter
4765 @opindex Wno-unused-but-set-parameter
4766 Warn whenever a function parameter is assigned to, but otherwise unused
4767 (aside from its declaration).
4769 To suppress this warning use the @code{unused} attribute
4770 (@pxref{Variable Attributes}).
4772 This warning is also enabled by @option{-Wunused} together with
4773 @option{-Wextra}.
4775 @item -Wunused-but-set-variable
4776 @opindex Wunused-but-set-variable
4777 @opindex Wno-unused-but-set-variable
4778 Warn whenever a local variable is assigned to, but otherwise unused
4779 (aside from its declaration).
4780 This warning is enabled by @option{-Wall}.
4782 To suppress this warning use the @code{unused} attribute
4783 (@pxref{Variable Attributes}).
4785 This warning is also enabled by @option{-Wunused}, which is enabled
4786 by @option{-Wall}.
4788 @item -Wunused-function
4789 @opindex Wunused-function
4790 @opindex Wno-unused-function
4791 Warn whenever a static function is declared but not defined or a
4792 non-inline static function is unused.
4793 This warning is enabled by @option{-Wall}.
4795 @item -Wunused-label
4796 @opindex Wunused-label
4797 @opindex Wno-unused-label
4798 Warn whenever a label is declared but not used.
4799 This warning is enabled by @option{-Wall}.
4801 To suppress this warning use the @code{unused} attribute
4802 (@pxref{Variable Attributes}).
4804 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4805 @opindex Wunused-local-typedefs
4806 Warn when a typedef locally defined in a function is not used.
4807 This warning is enabled by @option{-Wall}.
4809 @item -Wunused-parameter
4810 @opindex Wunused-parameter
4811 @opindex Wno-unused-parameter
4812 Warn whenever a function parameter is unused aside from its declaration.
4814 To suppress this warning use the @code{unused} attribute
4815 (@pxref{Variable Attributes}).
4817 @item -Wno-unused-result
4818 @opindex Wunused-result
4819 @opindex Wno-unused-result
4820 Do not warn if a caller of a function marked with attribute
4821 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4822 its return value. The default is @option{-Wunused-result}.
4824 @item -Wunused-variable
4825 @opindex Wunused-variable
4826 @opindex Wno-unused-variable
4827 Warn whenever a local or static variable is unused aside from its
4828 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4829 but not for C++. This warning is enabled by @option{-Wall}.
4831 To suppress this warning use the @code{unused} attribute
4832 (@pxref{Variable Attributes}).
4834 @item -Wunused-const-variable
4835 @itemx -Wunused-const-variable=@var{n}
4836 @opindex Wunused-const-variable
4837 @opindex Wno-unused-const-variable
4838 Warn whenever a constant static variable is unused aside from its declaration.
4839 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4840 for C, but not for C++. In C this declares variable storage, but in C++ this
4841 is not an error since const variables take the place of @code{#define}s.
4843 To suppress this warning use the @code{unused} attribute
4844 (@pxref{Variable Attributes}).
4846 @table @gcctabopt
4847 @item -Wunused-const-variable=1
4848 This is the warning level that is enabled by @option{-Wunused-variable} for
4849 C.  It warns only about unused static const variables defined in the main
4850 compilation unit, but not about static const variables declared in any
4851 header included.
4853 @item -Wunused-const-variable=2
4854 This warning level also warns for unused constant static variables in
4855 headers (excluding system headers).  This is the warning level of
4856 @option{-Wunused-const-variable} and must be explicitly requested since
4857 in C++ this isn't an error and in C it might be harder to clean up all
4858 headers included.
4859 @end table
4861 @item -Wunused-value
4862 @opindex Wunused-value
4863 @opindex Wno-unused-value
4864 Warn whenever a statement computes a result that is explicitly not
4865 used. To suppress this warning cast the unused expression to
4866 @code{void}. This includes an expression-statement or the left-hand
4867 side of a comma expression that contains no side effects. For example,
4868 an expression such as @code{x[i,j]} causes a warning, while
4869 @code{x[(void)i,j]} does not.
4871 This warning is enabled by @option{-Wall}.
4873 @item -Wunused
4874 @opindex Wunused
4875 @opindex Wno-unused
4876 All the above @option{-Wunused} options combined.
4878 In order to get a warning about an unused function parameter, you must
4879 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4880 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4882 @item -Wuninitialized
4883 @opindex Wuninitialized
4884 @opindex Wno-uninitialized
4885 Warn if an automatic variable is used without first being initialized
4886 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4887 warn if a non-static reference or non-static @code{const} member
4888 appears in a class without constructors.
4890 If you want to warn about code that uses the uninitialized value of the
4891 variable in its own initializer, use the @option{-Winit-self} option.
4893 These warnings occur for individual uninitialized or clobbered
4894 elements of structure, union or array variables as well as for
4895 variables that are uninitialized or clobbered as a whole.  They do
4896 not occur for variables or elements declared @code{volatile}.  Because
4897 these warnings depend on optimization, the exact variables or elements
4898 for which there are warnings depends on the precise optimization
4899 options and version of GCC used.
4901 Note that there may be no warning about a variable that is used only
4902 to compute a value that itself is never used, because such
4903 computations may be deleted by data flow analysis before the warnings
4904 are printed.
4906 @item -Winvalid-memory-model
4907 @opindex Winvalid-memory-model
4908 @opindex Wno-invalid-memory-model
4909 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4910 and the C11 atomic generic functions with a memory consistency argument
4911 that is either invalid for the operation or outside the range of values
4912 of the @code{memory_order} enumeration.  For example, since the
4913 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4914 defined for the relaxed, release, and sequentially consistent memory
4915 orders the following code is diagnosed:
4917 @smallexample
4918 void store (int *i)
4920   __atomic_store_n (i, 0, memory_order_consume);
4922 @end smallexample
4924 @option{-Winvalid-memory-model} is enabled by default.
4926 @item -Wmaybe-uninitialized
4927 @opindex Wmaybe-uninitialized
4928 @opindex Wno-maybe-uninitialized
4929 For an automatic variable, if there exists a path from the function
4930 entry to a use of the variable that is initialized, but there exist
4931 some other paths for which the variable is not initialized, the compiler
4932 emits a warning if it cannot prove the uninitialized paths are not
4933 executed at run time. These warnings are made optional because GCC is
4934 not smart enough to see all the reasons why the code might be correct
4935 in spite of appearing to have an error.  Here is one example of how
4936 this can happen:
4938 @smallexample
4939 @group
4941   int x;
4942   switch (y)
4943     @{
4944     case 1: x = 1;
4945       break;
4946     case 2: x = 4;
4947       break;
4948     case 3: x = 5;
4949     @}
4950   foo (x);
4952 @end group
4953 @end smallexample
4955 @noindent
4956 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4957 always initialized, but GCC doesn't know this. To suppress the
4958 warning, you need to provide a default case with assert(0) or
4959 similar code.
4961 @cindex @code{longjmp} warnings
4962 This option also warns when a non-volatile automatic variable might be
4963 changed by a call to @code{longjmp}.  These warnings as well are possible
4964 only in optimizing compilation.
4966 The compiler sees only the calls to @code{setjmp}.  It cannot know
4967 where @code{longjmp} will be called; in fact, a signal handler could
4968 call it at any point in the code.  As a result, you may get a warning
4969 even when there is in fact no problem because @code{longjmp} cannot
4970 in fact be called at the place that would cause a problem.
4972 Some spurious warnings can be avoided if you declare all the functions
4973 you use that never return as @code{noreturn}.  @xref{Function
4974 Attributes}.
4976 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4978 @item -Wunknown-pragmas
4979 @opindex Wunknown-pragmas
4980 @opindex Wno-unknown-pragmas
4981 @cindex warning for unknown pragmas
4982 @cindex unknown pragmas, warning
4983 @cindex pragmas, warning of unknown
4984 Warn when a @code{#pragma} directive is encountered that is not understood by 
4985 GCC@.  If this command-line option is used, warnings are even issued
4986 for unknown pragmas in system header files.  This is not the case if
4987 the warnings are only enabled by the @option{-Wall} command-line option.
4989 @item -Wno-pragmas
4990 @opindex Wno-pragmas
4991 @opindex Wpragmas
4992 Do not warn about misuses of pragmas, such as incorrect parameters,
4993 invalid syntax, or conflicts between pragmas.  See also
4994 @option{-Wunknown-pragmas}.
4996 @item -Wstrict-aliasing
4997 @opindex Wstrict-aliasing
4998 @opindex Wno-strict-aliasing
4999 This option is only active when @option{-fstrict-aliasing} is active.
5000 It warns about code that might break the strict aliasing rules that the
5001 compiler is using for optimization.  The warning does not catch all
5002 cases, but does attempt to catch the more common pitfalls.  It is
5003 included in @option{-Wall}.
5004 It is equivalent to @option{-Wstrict-aliasing=3}
5006 @item -Wstrict-aliasing=n
5007 @opindex Wstrict-aliasing=n
5008 This option is only active when @option{-fstrict-aliasing} is active.
5009 It warns about code that might break the strict aliasing rules that the
5010 compiler is using for optimization.
5011 Higher levels correspond to higher accuracy (fewer false positives).
5012 Higher levels also correspond to more effort, similar to the way @option{-O} 
5013 works.
5014 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5016 Level 1: Most aggressive, quick, least accurate.
5017 Possibly useful when higher levels
5018 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5019 false negatives.  However, it has many false positives.
5020 Warns for all pointer conversions between possibly incompatible types,
5021 even if never dereferenced.  Runs in the front end only.
5023 Level 2: Aggressive, quick, not too precise.
5024 May still have many false positives (not as many as level 1 though),
5025 and few false negatives (but possibly more than level 1).
5026 Unlike level 1, it only warns when an address is taken.  Warns about
5027 incomplete types.  Runs in the front end only.
5029 Level 3 (default for @option{-Wstrict-aliasing}):
5030 Should have very few false positives and few false
5031 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5032 Takes care of the common pun+dereference pattern in the front end:
5033 @code{*(int*)&some_float}.
5034 If optimization is enabled, it also runs in the back end, where it deals
5035 with multiple statement cases using flow-sensitive points-to information.
5036 Only warns when the converted pointer is dereferenced.
5037 Does not warn about incomplete types.
5039 @item -Wstrict-overflow
5040 @itemx -Wstrict-overflow=@var{n}
5041 @opindex Wstrict-overflow
5042 @opindex Wno-strict-overflow
5043 This option is only active when signed overflow is undefined.
5044 It warns about cases where the compiler optimizes based on the
5045 assumption that signed overflow does not occur.  Note that it does not
5046 warn about all cases where the code might overflow: it only warns
5047 about cases where the compiler implements some optimization.  Thus
5048 this warning depends on the optimization level.
5050 An optimization that assumes that signed overflow does not occur is
5051 perfectly safe if the values of the variables involved are such that
5052 overflow never does, in fact, occur.  Therefore this warning can
5053 easily give a false positive: a warning about code that is not
5054 actually a problem.  To help focus on important issues, several
5055 warning levels are defined.  No warnings are issued for the use of
5056 undefined signed overflow when estimating how many iterations a loop
5057 requires, in particular when determining whether a loop will be
5058 executed at all.
5060 @table @gcctabopt
5061 @item -Wstrict-overflow=1
5062 Warn about cases that are both questionable and easy to avoid.  For
5063 example the compiler simplifies
5064 @code{x + 1 > x} to @code{1}.  This level of
5065 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5066 are not, and must be explicitly requested.
5068 @item -Wstrict-overflow=2
5069 Also warn about other cases where a comparison is simplified to a
5070 constant.  For example: @code{abs (x) >= 0}.  This can only be
5071 simplified when signed integer overflow is undefined, because
5072 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5073 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5074 @option{-Wstrict-overflow=2}.
5076 @item -Wstrict-overflow=3
5077 Also warn about other cases where a comparison is simplified.  For
5078 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5080 @item -Wstrict-overflow=4
5081 Also warn about other simplifications not covered by the above cases.
5082 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5084 @item -Wstrict-overflow=5
5085 Also warn about cases where the compiler reduces the magnitude of a
5086 constant involved in a comparison.  For example: @code{x + 2 > y} is
5087 simplified to @code{x + 1 >= y}.  This is reported only at the
5088 highest warning level because this simplification applies to many
5089 comparisons, so this warning level gives a very large number of
5090 false positives.
5091 @end table
5093 @item -Wstringop-overflow
5094 @itemx -Wstringop-overflow=@var{type}
5095 @opindex Wstringop-overflow
5096 @opindex Wno-stringop-overflow
5097 Warn for calls to string manipulation functions such as @code{memcpy} and
5098 @code{strcpy} that are determined to overflow the destination buffer.  The
5099 optional argument is one greater than the type of Object Size Checking to
5100 perform to determine the size of the destination.  @xref{Object Size Checking}.
5101 The argument is meaningful only for functions that operate on character arrays
5102 but not for raw memory functions like @code{memcpy} which always make use
5103 of Object Size type-0.  The option also warns for calls that specify a size
5104 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5105 The option produces the best results with optimization enabled but can detect
5106 a small subset of simple buffer overflows even without optimization in
5107 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5108 correspond to the standard functions.  In any case, the option warns about
5109 just a subset of buffer overflows detected by the corresponding overflow
5110 checking built-ins.  For example, the option will issue a warning for
5111 the @code{strcpy} call below because it copies at least 5 characters
5112 (the string @code{"blue"} including the terminating NUL) into the buffer
5113 of size 4.
5115 @smallexample
5116 enum Color @{ blue, purple, yellow @};
5117 const char* f (enum Color clr)
5119   static char buf [4];
5120   const char *str;
5121   switch (clr)
5122     @{
5123       case blue: str = "blue"; break;
5124       case purple: str = "purple"; break;
5125       case yellow: str = "yellow"; break;
5126     @}
5128   return strcpy (buf, str);   // warning here
5130 @end smallexample
5132 Option @option{-Wstringop-overflow=2} is enabled by default.
5134 @table @gcctabopt
5135 @item -Wstringop-overflow
5136 @item -Wstringop-overflow=1
5137 @opindex Wstringop-overflow
5138 @opindex Wno-stringop-overflow
5139 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5140 to determine the sizes of destination objects.  This is the default setting
5141 of the option.  At this setting the option will not warn for writes past
5142 the end of subobjects of larger objects accessed by pointers unless the
5143 size of the largest surrounding object is known.  When the destination may
5144 be one of several objects it is assumed to be the largest one of them.  On
5145 Linux systems, when optimization is enabled at this setting the option warns
5146 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5147 a non-zero value.
5149 @item -Wstringop-overflow=2
5150 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5151 to determine the sizes of destination objects.  At this setting the option
5152 will warn about overflows when writing to members of the largest complete
5153 objects whose exact size is known.  It will, however, not warn for excessive
5154 writes to the same members of unknown objects referenced by pointers since
5155 they may point to arrays containing unknown numbers of elements.
5157 @item -Wstringop-overflow=3
5158 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5159 to determine the sizes of destination objects.  At this setting the option
5160 warns about overflowing the smallest object or data member.  This is the
5161 most restrictive setting of the option that may result in warnings for safe
5162 code.
5164 @item -Wstringop-overflow=4
5165 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5166 to determine the sizes of destination objects.  At this setting the option
5167 will warn about overflowing any data members, and when the destination is
5168 one of several objects it uses the size of the largest of them to decide
5169 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5170 setting of the option may result in warnings for benign code.
5171 @end table
5173 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5174 @opindex Wsuggest-attribute=
5175 @opindex Wno-suggest-attribute=
5176 Warn for cases where adding an attribute may be beneficial. The
5177 attributes currently supported are listed below.
5179 @table @gcctabopt
5180 @item -Wsuggest-attribute=pure
5181 @itemx -Wsuggest-attribute=const
5182 @itemx -Wsuggest-attribute=noreturn
5183 @opindex Wsuggest-attribute=pure
5184 @opindex Wno-suggest-attribute=pure
5185 @opindex Wsuggest-attribute=const
5186 @opindex Wno-suggest-attribute=const
5187 @opindex Wsuggest-attribute=noreturn
5188 @opindex Wno-suggest-attribute=noreturn
5190 Warn about functions that might be candidates for attributes
5191 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5192 functions visible in other compilation units or (in the case of @code{pure} and
5193 @code{const}) if it cannot prove that the function returns normally. A function
5194 returns normally if it doesn't contain an infinite loop or return abnormally
5195 by throwing, calling @code{abort} or trapping.  This analysis requires option
5196 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5197 higher.  Higher optimization levels improve the accuracy of the analysis.
5199 @item -Wsuggest-attribute=format
5200 @itemx -Wmissing-format-attribute
5201 @opindex Wsuggest-attribute=format
5202 @opindex Wmissing-format-attribute
5203 @opindex Wno-suggest-attribute=format
5204 @opindex Wno-missing-format-attribute
5205 @opindex Wformat
5206 @opindex Wno-format
5208 Warn about function pointers that might be candidates for @code{format}
5209 attributes.  Note these are only possible candidates, not absolute ones.
5210 GCC guesses that function pointers with @code{format} attributes that
5211 are used in assignment, initialization, parameter passing or return
5212 statements should have a corresponding @code{format} attribute in the
5213 resulting type.  I.e.@: the left-hand side of the assignment or
5214 initialization, the type of the parameter variable, or the return type
5215 of the containing function respectively should also have a @code{format}
5216 attribute to avoid the warning.
5218 GCC also warns about function definitions that might be
5219 candidates for @code{format} attributes.  Again, these are only
5220 possible candidates.  GCC guesses that @code{format} attributes
5221 might be appropriate for any function that calls a function like
5222 @code{vprintf} or @code{vscanf}, but this might not always be the
5223 case, and some functions for which @code{format} attributes are
5224 appropriate may not be detected.
5225 @end table
5227 @item -Wsuggest-final-types
5228 @opindex Wno-suggest-final-types
5229 @opindex Wsuggest-final-types
5230 Warn about types with virtual methods where code quality would be improved
5231 if the type were declared with the C++11 @code{final} specifier, 
5232 or, if possible,
5233 declared in an anonymous namespace. This allows GCC to more aggressively
5234 devirtualize the polymorphic calls. This warning is more effective with link
5235 time optimization, where the information about the class hierarchy graph is
5236 more complete.
5238 @item -Wsuggest-final-methods
5239 @opindex Wno-suggest-final-methods
5240 @opindex Wsuggest-final-methods
5241 Warn about virtual methods where code quality would be improved if the method
5242 were declared with the C++11 @code{final} specifier, 
5243 or, if possible, its type were
5244 declared in an anonymous namespace or with the @code{final} specifier.
5245 This warning is
5246 more effective with link-time optimization, where the information about the
5247 class hierarchy graph is more complete. It is recommended to first consider
5248 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5249 annotations.
5251 @item -Wsuggest-override
5252 Warn about overriding virtual functions that are not marked with the override
5253 keyword.
5255 @item -Walloc-zero
5256 @opindex Wno-alloc-zero
5257 @opindex Walloc-zero
5258 Warn about calls to allocation functions decorated with attribute
5259 @code{alloc_size} that specify zero bytes, including those to the built-in
5260 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5261 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5262 when called with a zero size differs among implementations (and in the case
5263 of @code{realloc} has been deprecated) relying on it may result in subtle
5264 portability bugs and should be avoided.
5266 @item -Walloc-size-larger-than=@var{n}
5267 Warn about calls to functions decorated with attribute @code{alloc_size}
5268 that attempt to allocate objects larger than the specified number of bytes,
5269 or where the result of the size computation in an integer type with infinite
5270 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5271 may end in one of the standard suffixes designating a multiple of bytes
5272 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5273 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5274 @xref{Function Attributes}.
5276 @item -Walloca
5277 @opindex Wno-alloca
5278 @opindex Walloca
5279 This option warns on all uses of @code{alloca} in the source.
5281 @item -Walloca-larger-than=@var{n}
5282 This option warns on calls to @code{alloca} that are not bounded by a
5283 controlling predicate limiting its argument of integer type to at most
5284 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5285 Arguments of non-integer types are considered unbounded even if they
5286 appear to be constrained to the expected range.
5288 For example, a bounded case of @code{alloca} could be:
5290 @smallexample
5291 void func (size_t n)
5293   void *p;
5294   if (n <= 1000)
5295     p = alloca (n);
5296   else
5297     p = malloc (n);
5298   f (p);
5300 @end smallexample
5302 In the above example, passing @code{-Walloca-larger-than=1000} would not
5303 issue a warning because the call to @code{alloca} is known to be at most
5304 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5305 the compiler would emit a warning.
5307 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5308 controlling predicate constraining its integer argument.  For example:
5310 @smallexample
5311 void func ()
5313   void *p = alloca (n);
5314   f (p);
5316 @end smallexample
5318 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5319 a warning, but this time because of the lack of bounds checking.
5321 Note, that even seemingly correct code involving signed integers could
5322 cause a warning:
5324 @smallexample
5325 void func (signed int n)
5327   if (n < 500)
5328     @{
5329       p = alloca (n);
5330       f (p);
5331     @}
5333 @end smallexample
5335 In the above example, @var{n} could be negative, causing a larger than
5336 expected argument to be implicitly cast into the @code{alloca} call.
5338 This option also warns when @code{alloca} is used in a loop.
5340 This warning is not enabled by @option{-Wall}, and is only active when
5341 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5343 See also @option{-Wvla-larger-than=@var{n}}.
5345 @item -Warray-bounds
5346 @itemx -Warray-bounds=@var{n}
5347 @opindex Wno-array-bounds
5348 @opindex Warray-bounds
5349 This option is only active when @option{-ftree-vrp} is active
5350 (default for @option{-O2} and above). It warns about subscripts to arrays
5351 that are always out of bounds. This warning is enabled by @option{-Wall}.
5353 @table @gcctabopt
5354 @item -Warray-bounds=1
5355 This is the warning level of @option{-Warray-bounds} and is enabled
5356 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5358 @item -Warray-bounds=2
5359 This warning level also warns about out of bounds access for
5360 arrays at the end of a struct and for arrays accessed through
5361 pointers. This warning level may give a larger number of
5362 false positives and is deactivated by default.
5363 @end table
5365 @item -Wbool-compare
5366 @opindex Wno-bool-compare
5367 @opindex Wbool-compare
5368 Warn about boolean expression compared with an integer value different from
5369 @code{true}/@code{false}.  For instance, the following comparison is
5370 always false:
5371 @smallexample
5372 int n = 5;
5373 @dots{}
5374 if ((n > 1) == 2) @{ @dots{} @}
5375 @end smallexample
5376 This warning is enabled by @option{-Wall}.
5378 @item -Wbool-operation
5379 @opindex Wno-bool-operation
5380 @opindex Wbool-operation
5381 Warn about suspicious operations on expressions of a boolean type.  For
5382 instance, bitwise negation of a boolean is very likely a bug in the program.
5383 For C, this warning also warns about incrementing or decrementing a boolean,
5384 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5385 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5387 This warning is enabled by @option{-Wall}.
5389 @item -Wduplicated-branches
5390 @opindex Wno-duplicated-branches
5391 @opindex Wduplicated-branches
5392 Warn when an if-else has identical branches.  This warning detects cases like
5393 @smallexample
5394 if (p != NULL)
5395   return 0;
5396 else
5397   return 0;
5398 @end smallexample
5399 It doesn't warn when both branches contain just a null statement.  This warning
5400 also warn for conditional operators:
5401 @smallexample
5402   int i = x ? *p : *p;
5403 @end smallexample
5405 @item -Wduplicated-cond
5406 @opindex Wno-duplicated-cond
5407 @opindex Wduplicated-cond
5408 Warn about duplicated conditions in an if-else-if chain.  For instance,
5409 warn for the following code:
5410 @smallexample
5411 if (p->q != NULL) @{ @dots{} @}
5412 else if (p->q != NULL) @{ @dots{} @}
5413 @end smallexample
5415 @item -Wframe-address
5416 @opindex Wno-frame-address
5417 @opindex Wframe-address
5418 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5419 is called with an argument greater than 0.  Such calls may return indeterminate
5420 values or crash the program.  The warning is included in @option{-Wall}.
5422 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5423 @opindex Wno-discarded-qualifiers
5424 @opindex Wdiscarded-qualifiers
5425 Do not warn if type qualifiers on pointers are being discarded.
5426 Typically, the compiler warns if a @code{const char *} variable is
5427 passed to a function that takes a @code{char *} parameter.  This option
5428 can be used to suppress such a warning.
5430 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5431 @opindex Wno-discarded-array-qualifiers
5432 @opindex Wdiscarded-array-qualifiers
5433 Do not warn if type qualifiers on arrays which are pointer targets
5434 are being discarded. Typically, the compiler warns if a
5435 @code{const int (*)[]} variable is passed to a function that
5436 takes a @code{int (*)[]} parameter.  This option can be used to
5437 suppress such a warning.
5439 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5440 @opindex Wno-incompatible-pointer-types
5441 @opindex Wincompatible-pointer-types
5442 Do not warn when there is a conversion between pointers that have incompatible
5443 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5444 which warns for pointer argument passing or assignment with different
5445 signedness.
5447 @item -Wno-int-conversion @r{(C and Objective-C only)}
5448 @opindex Wno-int-conversion
5449 @opindex Wint-conversion
5450 Do not warn about incompatible integer to pointer and pointer to integer
5451 conversions.  This warning is about implicit conversions; for explicit
5452 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5453 @option{-Wno-pointer-to-int-cast} may be used.
5455 @item -Wno-div-by-zero
5456 @opindex Wno-div-by-zero
5457 @opindex Wdiv-by-zero
5458 Do not warn about compile-time integer division by zero.  Floating-point
5459 division by zero is not warned about, as it can be a legitimate way of
5460 obtaining infinities and NaNs.
5462 @item -Wsystem-headers
5463 @opindex Wsystem-headers
5464 @opindex Wno-system-headers
5465 @cindex warnings from system headers
5466 @cindex system headers, warnings from
5467 Print warning messages for constructs found in system header files.
5468 Warnings from system headers are normally suppressed, on the assumption
5469 that they usually do not indicate real problems and would only make the
5470 compiler output harder to read.  Using this command-line option tells
5471 GCC to emit warnings from system headers as if they occurred in user
5472 code.  However, note that using @option{-Wall} in conjunction with this
5473 option does @emph{not} warn about unknown pragmas in system
5474 headers---for that, @option{-Wunknown-pragmas} must also be used.
5476 @item -Wtautological-compare
5477 @opindex Wtautological-compare
5478 @opindex Wno-tautological-compare
5479 Warn if a self-comparison always evaluates to true or false.  This
5480 warning detects various mistakes such as:
5481 @smallexample
5482 int i = 1;
5483 @dots{}
5484 if (i > i) @{ @dots{} @}
5485 @end smallexample
5486 This warning is enabled by @option{-Wall}.
5488 @item -Wtrampolines
5489 @opindex Wtrampolines
5490 @opindex Wno-trampolines
5491 Warn about trampolines generated for pointers to nested functions.
5492 A trampoline is a small piece of data or code that is created at run
5493 time on the stack when the address of a nested function is taken, and is
5494 used to call the nested function indirectly.  For some targets, it is
5495 made up of data only and thus requires no special treatment.  But, for
5496 most targets, it is made up of code and thus requires the stack to be
5497 made executable in order for the program to work properly.
5499 @item -Wfloat-equal
5500 @opindex Wfloat-equal
5501 @opindex Wno-float-equal
5502 Warn if floating-point values are used in equality comparisons.
5504 The idea behind this is that sometimes it is convenient (for the
5505 programmer) to consider floating-point values as approximations to
5506 infinitely precise real numbers.  If you are doing this, then you need
5507 to compute (by analyzing the code, or in some other way) the maximum or
5508 likely maximum error that the computation introduces, and allow for it
5509 when performing comparisons (and when producing output, but that's a
5510 different problem).  In particular, instead of testing for equality, you
5511 should check to see whether the two values have ranges that overlap; and
5512 this is done with the relational operators, so equality comparisons are
5513 probably mistaken.
5515 @item -Wtraditional @r{(C and Objective-C only)}
5516 @opindex Wtraditional
5517 @opindex Wno-traditional
5518 Warn about certain constructs that behave differently in traditional and
5519 ISO C@.  Also warn about ISO C constructs that have no traditional C
5520 equivalent, and/or problematic constructs that should be avoided.
5522 @itemize @bullet
5523 @item
5524 Macro parameters that appear within string literals in the macro body.
5525 In traditional C macro replacement takes place within string literals,
5526 but in ISO C it does not.
5528 @item
5529 In traditional C, some preprocessor directives did not exist.
5530 Traditional preprocessors only considered a line to be a directive
5531 if the @samp{#} appeared in column 1 on the line.  Therefore
5532 @option{-Wtraditional} warns about directives that traditional C
5533 understands but ignores because the @samp{#} does not appear as the
5534 first character on the line.  It also suggests you hide directives like
5535 @code{#pragma} not understood by traditional C by indenting them.  Some
5536 traditional implementations do not recognize @code{#elif}, so this option
5537 suggests avoiding it altogether.
5539 @item
5540 A function-like macro that appears without arguments.
5542 @item
5543 The unary plus operator.
5545 @item
5546 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5547 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5548 constants.)  Note, these suffixes appear in macros defined in the system
5549 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5550 Use of these macros in user code might normally lead to spurious
5551 warnings, however GCC's integrated preprocessor has enough context to
5552 avoid warning in these cases.
5554 @item
5555 A function declared external in one block and then used after the end of
5556 the block.
5558 @item
5559 A @code{switch} statement has an operand of type @code{long}.
5561 @item
5562 A non-@code{static} function declaration follows a @code{static} one.
5563 This construct is not accepted by some traditional C compilers.
5565 @item
5566 The ISO type of an integer constant has a different width or
5567 signedness from its traditional type.  This warning is only issued if
5568 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5569 typically represent bit patterns, are not warned about.
5571 @item
5572 Usage of ISO string concatenation is detected.
5574 @item
5575 Initialization of automatic aggregates.
5577 @item
5578 Identifier conflicts with labels.  Traditional C lacks a separate
5579 namespace for labels.
5581 @item
5582 Initialization of unions.  If the initializer is zero, the warning is
5583 omitted.  This is done under the assumption that the zero initializer in
5584 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5585 initializer warnings and relies on default initialization to zero in the
5586 traditional C case.
5588 @item
5589 Conversions by prototypes between fixed/floating-point values and vice
5590 versa.  The absence of these prototypes when compiling with traditional
5591 C causes serious problems.  This is a subset of the possible
5592 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5594 @item
5595 Use of ISO C style function definitions.  This warning intentionally is
5596 @emph{not} issued for prototype declarations or variadic functions
5597 because these ISO C features appear in your code when using
5598 libiberty's traditional C compatibility macros, @code{PARAMS} and
5599 @code{VPARAMS}.  This warning is also bypassed for nested functions
5600 because that feature is already a GCC extension and thus not relevant to
5601 traditional C compatibility.
5602 @end itemize
5604 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5605 @opindex Wtraditional-conversion
5606 @opindex Wno-traditional-conversion
5607 Warn if a prototype causes a type conversion that is different from what
5608 would happen to the same argument in the absence of a prototype.  This
5609 includes conversions of fixed point to floating and vice versa, and
5610 conversions changing the width or signedness of a fixed-point argument
5611 except when the same as the default promotion.
5613 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5614 @opindex Wdeclaration-after-statement
5615 @opindex Wno-declaration-after-statement
5616 Warn when a declaration is found after a statement in a block.  This
5617 construct, known from C++, was introduced with ISO C99 and is by default
5618 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5620 @item -Wshadow
5621 @opindex Wshadow
5622 @opindex Wno-shadow
5623 Warn whenever a local variable or type declaration shadows another
5624 variable, parameter, type, class member (in C++), or instance variable
5625 (in Objective-C) or whenever a built-in function is shadowed. Note
5626 that in C++, the compiler warns if a local variable shadows an
5627 explicit typedef, but not if it shadows a struct/class/enum.
5628 Same as @option{-Wshadow=global}.
5630 @item -Wno-shadow-ivar @r{(Objective-C only)}
5631 @opindex Wno-shadow-ivar
5632 @opindex Wshadow-ivar
5633 Do not warn whenever a local variable shadows an instance variable in an
5634 Objective-C method.
5636 @item -Wshadow=global
5637 @opindex Wshadow=local
5638 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5640 @item -Wshadow=local
5641 @opindex Wshadow=local
5642 Warn when a local variable shadows another local variable or parameter.
5643 This warning is enabled by @option{-Wshadow=global}.
5645 @item -Wshadow=compatible-local
5646 @opindex Wshadow=compatible-local
5647 Warn when a local variable shadows another local variable or parameter
5648 whose type is compatible with that of the shadowing variable. In C++,
5649 type compatibility here means the type of the shadowing variable can be
5650 converted to that of the shadowed variable. The creation of this flag
5651 (in addition to @option{-Wshadow=local}) is based on the idea that when
5652 a local variable shadows another one of incompatible type, it is most
5653 likely intentional, not a bug or typo, as shown in the following example:
5655 @smallexample
5656 @group
5657 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5659   for (int i = 0; i < N; ++i)
5660   @{
5661     ...
5662   @}
5663   ...
5665 @end group
5666 @end smallexample
5668 Since the two variable @code{i} in the example above have incompatible types,
5669 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5670 Because their types are incompatible, if a programmer accidentally uses one
5671 in place of the other, type checking will catch that and emit an error or
5672 warning. So not warning (about shadowing) in this case will not lead to
5673 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5674 possibly reduce the number of warnings triggered by intentional shadowing.
5676 This warning is enabled by @option{-Wshadow=local}.
5678 @item -Wlarger-than=@var{len}
5679 @opindex Wlarger-than=@var{len}
5680 @opindex Wlarger-than-@var{len}
5681 Warn whenever an object of larger than @var{len} bytes is defined.
5683 @item -Wframe-larger-than=@var{len}
5684 @opindex Wframe-larger-than
5685 Warn if the size of a function frame is larger than @var{len} bytes.
5686 The computation done to determine the stack frame size is approximate
5687 and not conservative.
5688 The actual requirements may be somewhat greater than @var{len}
5689 even if you do not get a warning.  In addition, any space allocated
5690 via @code{alloca}, variable-length arrays, or related constructs
5691 is not included by the compiler when determining
5692 whether or not to issue a warning.
5694 @item -Wno-free-nonheap-object
5695 @opindex Wno-free-nonheap-object
5696 @opindex Wfree-nonheap-object
5697 Do not warn when attempting to free an object that was not allocated
5698 on the heap.
5700 @item -Wstack-usage=@var{len}
5701 @opindex Wstack-usage
5702 Warn if the stack usage of a function might be larger than @var{len} bytes.
5703 The computation done to determine the stack usage is conservative.
5704 Any space allocated via @code{alloca}, variable-length arrays, or related
5705 constructs is included by the compiler when determining whether or not to
5706 issue a warning.
5708 The message is in keeping with the output of @option{-fstack-usage}.
5710 @itemize
5711 @item
5712 If the stack usage is fully static but exceeds the specified amount, it's:
5714 @smallexample
5715   warning: stack usage is 1120 bytes
5716 @end smallexample
5717 @item
5718 If the stack usage is (partly) dynamic but bounded, it's:
5720 @smallexample
5721   warning: stack usage might be 1648 bytes
5722 @end smallexample
5723 @item
5724 If the stack usage is (partly) dynamic and not bounded, it's:
5726 @smallexample
5727   warning: stack usage might be unbounded
5728 @end smallexample
5729 @end itemize
5731 @item -Wunsafe-loop-optimizations
5732 @opindex Wunsafe-loop-optimizations
5733 @opindex Wno-unsafe-loop-optimizations
5734 Warn if the loop cannot be optimized because the compiler cannot
5735 assume anything on the bounds of the loop indices.  With
5736 @option{-funsafe-loop-optimizations} warn if the compiler makes
5737 such assumptions.
5739 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5740 @opindex Wno-pedantic-ms-format
5741 @opindex Wpedantic-ms-format
5742 When used in combination with @option{-Wformat}
5743 and @option{-pedantic} without GNU extensions, this option
5744 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5745 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5746 which depend on the MS runtime.
5748 @item -Waligned-new
5749 @opindex Waligned-new
5750 @opindex Wno-aligned-new
5751 Warn about a new-expression of a type that requires greater alignment
5752 than the @code{alignof(std::max_align_t)} but uses an allocation
5753 function without an explicit alignment parameter. This option is
5754 enabled by @option{-Wall}.
5756 Normally this only warns about global allocation functions, but
5757 @option{-Waligned-new=all} also warns about class member allocation
5758 functions.
5760 @item -Wplacement-new
5761 @itemx -Wplacement-new=@var{n}
5762 @opindex Wplacement-new
5763 @opindex Wno-placement-new
5764 Warn about placement new expressions with undefined behavior, such as
5765 constructing an object in a buffer that is smaller than the type of
5766 the object.  For example, the placement new expression below is diagnosed
5767 because it attempts to construct an array of 64 integers in a buffer only
5768 64 bytes large.
5769 @smallexample
5770 char buf [64];
5771 new (buf) int[64];
5772 @end smallexample
5773 This warning is enabled by default.
5775 @table @gcctabopt
5776 @item -Wplacement-new=1
5777 This is the default warning level of @option{-Wplacement-new}.  At this
5778 level the warning is not issued for some strictly undefined constructs that
5779 GCC allows as extensions for compatibility with legacy code.  For example,
5780 the following @code{new} expression is not diagnosed at this level even
5781 though it has undefined behavior according to the C++ standard because
5782 it writes past the end of the one-element array.
5783 @smallexample
5784 struct S @{ int n, a[1]; @};
5785 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5786 new (s->a)int [32]();
5787 @end smallexample
5789 @item -Wplacement-new=2
5790 At this level, in addition to diagnosing all the same constructs as at level
5791 1, a diagnostic is also issued for placement new expressions that construct
5792 an object in the last member of structure whose type is an array of a single
5793 element and whose size is less than the size of the object being constructed.
5794 While the previous example would be diagnosed, the following construct makes
5795 use of the flexible member array extension to avoid the warning at level 2.
5796 @smallexample
5797 struct S @{ int n, a[]; @};
5798 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5799 new (s->a)int [32]();
5800 @end smallexample
5802 @end table
5804 @item -Wpointer-arith
5805 @opindex Wpointer-arith
5806 @opindex Wno-pointer-arith
5807 Warn about anything that depends on the ``size of'' a function type or
5808 of @code{void}.  GNU C assigns these types a size of 1, for
5809 convenience in calculations with @code{void *} pointers and pointers
5810 to functions.  In C++, warn also when an arithmetic operation involves
5811 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5813 @item -Wpointer-compare
5814 @opindex Wpointer-compare
5815 @opindex Wno-pointer-compare
5816 Warn if a pointer is compared with a zero character constant.  This usually
5817 means that the pointer was meant to be dereferenced.  For example:
5819 @smallexample
5820 const char *p = foo ();
5821 if (p == '\0')
5822   return 42;
5823 @end smallexample
5825 Note that the code above is invalid in C++11.
5827 This warning is enabled by default.
5829 @item -Wtype-limits
5830 @opindex Wtype-limits
5831 @opindex Wno-type-limits
5832 Warn if a comparison is always true or always false due to the limited
5833 range of the data type, but do not warn for constant expressions.  For
5834 example, warn if an unsigned variable is compared against zero with
5835 @code{<} or @code{>=}.  This warning is also enabled by
5836 @option{-Wextra}.
5838 @include cppwarnopts.texi
5840 @item -Wbad-function-cast @r{(C and Objective-C only)}
5841 @opindex Wbad-function-cast
5842 @opindex Wno-bad-function-cast
5843 Warn when a function call is cast to a non-matching type.
5844 For example, warn if a call to a function returning an integer type 
5845 is cast to a pointer type.
5847 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5848 @opindex Wc90-c99-compat
5849 @opindex Wno-c90-c99-compat
5850 Warn about features not present in ISO C90, but present in ISO C99.
5851 For instance, warn about use of variable length arrays, @code{long long}
5852 type, @code{bool} type, compound literals, designated initializers, and so
5853 on.  This option is independent of the standards mode.  Warnings are disabled
5854 in the expression that follows @code{__extension__}.
5856 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5857 @opindex Wc99-c11-compat
5858 @opindex Wno-c99-c11-compat
5859 Warn about features not present in ISO C99, but present in ISO C11.
5860 For instance, warn about use of anonymous structures and unions,
5861 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5862 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5863 and so on.  This option is independent of the standards mode.  Warnings are
5864 disabled in the expression that follows @code{__extension__}.
5866 @item -Wc++-compat @r{(C and Objective-C only)}
5867 @opindex Wc++-compat
5868 Warn about ISO C constructs that are outside of the common subset of
5869 ISO C and ISO C++, e.g.@: request for implicit conversion from
5870 @code{void *} to a pointer to non-@code{void} type.
5872 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5873 @opindex Wc++11-compat
5874 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5875 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5876 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5877 enabled by @option{-Wall}.
5879 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5880 @opindex Wc++14-compat
5881 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5882 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5884 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5885 @opindex Wc++1z-compat
5886 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5887 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5889 @item -Wcast-qual
5890 @opindex Wcast-qual
5891 @opindex Wno-cast-qual
5892 Warn whenever a pointer is cast so as to remove a type qualifier from
5893 the target type.  For example, warn if a @code{const char *} is cast
5894 to an ordinary @code{char *}.
5896 Also warn when making a cast that introduces a type qualifier in an
5897 unsafe way.  For example, casting @code{char **} to @code{const char **}
5898 is unsafe, as in this example:
5900 @smallexample
5901   /* p is char ** value.  */
5902   const char **q = (const char **) p;
5903   /* Assignment of readonly string to const char * is OK.  */
5904   *q = "string";
5905   /* Now char** pointer points to read-only memory.  */
5906   **p = 'b';
5907 @end smallexample
5909 @item -Wcast-align
5910 @opindex Wcast-align
5911 @opindex Wno-cast-align
5912 Warn whenever a pointer is cast such that the required alignment of the
5913 target is increased.  For example, warn if a @code{char *} is cast to
5914 an @code{int *} on machines where integers can only be accessed at
5915 two- or four-byte boundaries.
5917 @item -Wwrite-strings
5918 @opindex Wwrite-strings
5919 @opindex Wno-write-strings
5920 When compiling C, give string constants the type @code{const
5921 char[@var{length}]} so that copying the address of one into a
5922 non-@code{const} @code{char *} pointer produces a warning.  These
5923 warnings help you find at compile time code that can try to write
5924 into a string constant, but only if you have been very careful about
5925 using @code{const} in declarations and prototypes.  Otherwise, it is
5926 just a nuisance. This is why we did not make @option{-Wall} request
5927 these warnings.
5929 When compiling C++, warn about the deprecated conversion from string
5930 literals to @code{char *}.  This warning is enabled by default for C++
5931 programs.
5933 @item -Wcatch-value
5934 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5935 @opindex Wcatch-value
5936 @opindex Wno-catch-value
5937 Warn about catch handlers that do not catch via reference.
5938 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5939 warn about polymorphic class types that are caught by value.
5940 With @option{-Wcatch-value=2} warn about all class types that are caught
5941 by value. With @option{-Wcatch-value=3} warn about all types that are
5942 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
5944 @item -Wclobbered
5945 @opindex Wclobbered
5946 @opindex Wno-clobbered
5947 Warn for variables that might be changed by @code{longjmp} or
5948 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5950 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5951 @opindex Wconditionally-supported
5952 @opindex Wno-conditionally-supported
5953 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5955 @item -Wconversion
5956 @opindex Wconversion
5957 @opindex Wno-conversion
5958 Warn for implicit conversions that may alter a value. This includes
5959 conversions between real and integer, like @code{abs (x)} when
5960 @code{x} is @code{double}; conversions between signed and unsigned,
5961 like @code{unsigned ui = -1}; and conversions to smaller types, like
5962 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5963 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5964 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5965 conversions between signed and unsigned integers can be disabled by
5966 using @option{-Wno-sign-conversion}.
5968 For C++, also warn for confusing overload resolution for user-defined
5969 conversions; and conversions that never use a type conversion
5970 operator: conversions to @code{void}, the same type, a base class or a
5971 reference to them. Warnings about conversions between signed and
5972 unsigned integers are disabled by default in C++ unless
5973 @option{-Wsign-conversion} is explicitly enabled.
5975 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5976 @opindex Wconversion-null
5977 @opindex Wno-conversion-null
5978 Do not warn for conversions between @code{NULL} and non-pointer
5979 types. @option{-Wconversion-null} is enabled by default.
5981 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5982 @opindex Wzero-as-null-pointer-constant
5983 @opindex Wno-zero-as-null-pointer-constant
5984 Warn when a literal @samp{0} is used as null pointer constant.  This can
5985 be useful to facilitate the conversion to @code{nullptr} in C++11.
5987 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5988 @opindex Wsubobject-linkage
5989 @opindex Wno-subobject-linkage
5990 Warn if a class type has a base or a field whose type uses the anonymous
5991 namespace or depends on a type with no linkage.  If a type A depends on
5992 a type B with no or internal linkage, defining it in multiple
5993 translation units would be an ODR violation because the meaning of B
5994 is different in each translation unit.  If A only appears in a single
5995 translation unit, the best way to silence the warning is to give it
5996 internal linkage by putting it in an anonymous namespace as well.  The
5997 compiler doesn't give this warning for types defined in the main .C
5998 file, as those are unlikely to have multiple definitions.
5999 @option{-Wsubobject-linkage} is enabled by default.
6001 @item -Wdangling-else
6002 @opindex Wdangling-else
6003 @opindex Wno-dangling-else
6004 Warn about constructions where there may be confusion to which
6005 @code{if} statement an @code{else} branch belongs.  Here is an example of
6006 such a case:
6008 @smallexample
6009 @group
6011   if (a)
6012     if (b)
6013       foo ();
6014   else
6015     bar ();
6017 @end group
6018 @end smallexample
6020 In C/C++, every @code{else} branch belongs to the innermost possible
6021 @code{if} statement, which in this example is @code{if (b)}.  This is
6022 often not what the programmer expected, as illustrated in the above
6023 example by indentation the programmer chose.  When there is the
6024 potential for this confusion, GCC issues a warning when this flag
6025 is specified.  To eliminate the warning, add explicit braces around
6026 the innermost @code{if} statement so there is no way the @code{else}
6027 can belong to the enclosing @code{if}.  The resulting code
6028 looks like this:
6030 @smallexample
6031 @group
6033   if (a)
6034     @{
6035       if (b)
6036         foo ();
6037       else
6038         bar ();
6039     @}
6041 @end group
6042 @end smallexample
6044 This warning is enabled by @option{-Wparentheses}.
6046 @item -Wdate-time
6047 @opindex Wdate-time
6048 @opindex Wno-date-time
6049 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6050 are encountered as they might prevent bit-wise-identical reproducible
6051 compilations.
6053 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6054 @opindex Wdelete-incomplete
6055 @opindex Wno-delete-incomplete
6056 Warn when deleting a pointer to incomplete type, which may cause
6057 undefined behavior at runtime.  This warning is enabled by default.
6059 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6060 @opindex Wuseless-cast
6061 @opindex Wno-useless-cast
6062 Warn when an expression is casted to its own type.
6064 @item -Wempty-body
6065 @opindex Wempty-body
6066 @opindex Wno-empty-body
6067 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6068 while} statement.  This warning is also enabled by @option{-Wextra}.
6070 @item -Wenum-compare
6071 @opindex Wenum-compare
6072 @opindex Wno-enum-compare
6073 Warn about a comparison between values of different enumerated types.
6074 In C++ enumerated type mismatches in conditional expressions are also
6075 diagnosed and the warning is enabled by default.  In C this warning is 
6076 enabled by @option{-Wall}.
6078 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6079 @opindex Wextra-semi
6080 @opindex Wno-extra-semi
6081 Warn about redundant semicolon after in-class function definition.
6083 @item -Wjump-misses-init @r{(C, Objective-C only)}
6084 @opindex Wjump-misses-init
6085 @opindex Wno-jump-misses-init
6086 Warn if a @code{goto} statement or a @code{switch} statement jumps
6087 forward across the initialization of a variable, or jumps backward to a
6088 label after the variable has been initialized.  This only warns about
6089 variables that are initialized when they are declared.  This warning is
6090 only supported for C and Objective-C; in C++ this sort of branch is an
6091 error in any case.
6093 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6094 can be disabled with the @option{-Wno-jump-misses-init} option.
6096 @item -Wsign-compare
6097 @opindex Wsign-compare
6098 @opindex Wno-sign-compare
6099 @cindex warning for comparison of signed and unsigned values
6100 @cindex comparison of signed and unsigned values, warning
6101 @cindex signed and unsigned values, comparison warning
6102 Warn when a comparison between signed and unsigned values could produce
6103 an incorrect result when the signed value is converted to unsigned.
6104 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6105 also enabled by @option{-Wextra}.
6107 @item -Wsign-conversion
6108 @opindex Wsign-conversion
6109 @opindex Wno-sign-conversion
6110 Warn for implicit conversions that may change the sign of an integer
6111 value, like assigning a signed integer expression to an unsigned
6112 integer variable. An explicit cast silences the warning. In C, this
6113 option is enabled also by @option{-Wconversion}.
6115 @item -Wfloat-conversion
6116 @opindex Wfloat-conversion
6117 @opindex Wno-float-conversion
6118 Warn for implicit conversions that reduce the precision of a real value.
6119 This includes conversions from real to integer, and from higher precision
6120 real to lower precision real values.  This option is also enabled by
6121 @option{-Wconversion}.
6123 @item -Wno-scalar-storage-order
6124 @opindex -Wno-scalar-storage-order
6125 @opindex -Wscalar-storage-order
6126 Do not warn on suspicious constructs involving reverse scalar storage order.
6128 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6129 @opindex Wsized-deallocation
6130 @opindex Wno-sized-deallocation
6131 Warn about a definition of an unsized deallocation function
6132 @smallexample
6133 void operator delete (void *) noexcept;
6134 void operator delete[] (void *) noexcept;
6135 @end smallexample
6136 without a definition of the corresponding sized deallocation function
6137 @smallexample
6138 void operator delete (void *, std::size_t) noexcept;
6139 void operator delete[] (void *, std::size_t) noexcept;
6140 @end smallexample
6141 or vice versa.  Enabled by @option{-Wextra} along with
6142 @option{-fsized-deallocation}.
6144 @item -Wsizeof-pointer-div
6145 @opindex Wsizeof-pointer-div
6146 @opindex Wno-sizeof-pointer-div
6147 Warn for suspicious divisions of two sizeof expressions that divide
6148 the pointer size by the element size, which is the usual way to compute
6149 the array size but won't work out correctly with pointers.  This warning
6150 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6151 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6153 @item -Wsizeof-pointer-memaccess
6154 @opindex Wsizeof-pointer-memaccess
6155 @opindex Wno-sizeof-pointer-memaccess
6156 Warn for suspicious length parameters to certain string and memory built-in
6157 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6158 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6159 but a pointer, and suggests a possible fix, or about
6160 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6161 @option{-Wall}.
6163 @item -Wsizeof-array-argument
6164 @opindex Wsizeof-array-argument
6165 @opindex Wno-sizeof-array-argument
6166 Warn when the @code{sizeof} operator is applied to a parameter that is
6167 declared as an array in a function definition.  This warning is enabled by
6168 default for C and C++ programs.
6170 @item -Wmemset-elt-size
6171 @opindex Wmemset-elt-size
6172 @opindex Wno-memset-elt-size
6173 Warn for suspicious calls to the @code{memset} built-in function, if the
6174 first argument references an array, and the third argument is a number
6175 equal to the number of elements, but not equal to the size of the array
6176 in memory.  This indicates that the user has omitted a multiplication by
6177 the element size.  This warning is enabled by @option{-Wall}.
6179 @item -Wmemset-transposed-args
6180 @opindex Wmemset-transposed-args
6181 @opindex Wno-memset-transposed-args
6182 Warn for suspicious calls to the @code{memset} built-in function, if the
6183 second argument is not zero and the third argument is zero.  This warns e.g.@
6184 about @code{memset (buf, sizeof buf, 0)} where most probably
6185 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6186 is only emitted if the third argument is literal zero.  If it is some
6187 expression that is folded to zero, a cast of zero to some type, etc., 
6188 it is far less likely that the user has mistakenly exchanged the arguments 
6189 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6191 @item -Waddress
6192 @opindex Waddress
6193 @opindex Wno-address
6194 Warn about suspicious uses of memory addresses. These include using
6195 the address of a function in a conditional expression, such as
6196 @code{void func(void); if (func)}, and comparisons against the memory
6197 address of a string literal, such as @code{if (x == "abc")}.  Such
6198 uses typically indicate a programmer error: the address of a function
6199 always evaluates to true, so their use in a conditional usually
6200 indicate that the programmer forgot the parentheses in a function
6201 call; and comparisons against string literals result in unspecified
6202 behavior and are not portable in C, so they usually indicate that the
6203 programmer intended to use @code{strcmp}.  This warning is enabled by
6204 @option{-Wall}.
6206 @item -Wlogical-op
6207 @opindex Wlogical-op
6208 @opindex Wno-logical-op
6209 Warn about suspicious uses of logical operators in expressions.
6210 This includes using logical operators in contexts where a
6211 bit-wise operator is likely to be expected.  Also warns when
6212 the operands of a logical operator are the same:
6213 @smallexample
6214 extern int a;
6215 if (a < 0 && a < 0) @{ @dots{} @}
6216 @end smallexample
6218 @item -Wlogical-not-parentheses
6219 @opindex Wlogical-not-parentheses
6220 @opindex Wno-logical-not-parentheses
6221 Warn about logical not used on the left hand side operand of a comparison.
6222 This option does not warn if the right operand is considered to be a boolean
6223 expression.  Its purpose is to detect suspicious code like the following:
6224 @smallexample
6225 int a;
6226 @dots{}
6227 if (!a > 1) @{ @dots{} @}
6228 @end smallexample
6230 It is possible to suppress the warning by wrapping the LHS into
6231 parentheses:
6232 @smallexample
6233 if ((!a) > 1) @{ @dots{} @}
6234 @end smallexample
6236 This warning is enabled by @option{-Wall}.
6238 @item -Waggregate-return
6239 @opindex Waggregate-return
6240 @opindex Wno-aggregate-return
6241 Warn if any functions that return structures or unions are defined or
6242 called.  (In languages where you can return an array, this also elicits
6243 a warning.)
6245 @item -Wno-aggressive-loop-optimizations
6246 @opindex Wno-aggressive-loop-optimizations
6247 @opindex Waggressive-loop-optimizations
6248 Warn if in a loop with constant number of iterations the compiler detects
6249 undefined behavior in some statement during one or more of the iterations.
6251 @item -Wno-attributes
6252 @opindex Wno-attributes
6253 @opindex Wattributes
6254 Do not warn if an unexpected @code{__attribute__} is used, such as
6255 unrecognized attributes, function attributes applied to variables,
6256 etc.  This does not stop errors for incorrect use of supported
6257 attributes.
6259 @item -Wno-builtin-declaration-mismatch
6260 @opindex Wno-builtin-declaration-mismatch
6261 @opindex Wbuiltin-declaration-mismatch
6262 Warn if a built-in function is declared with the wrong signature.
6263 This warning is enabled by default.
6265 @item -Wno-builtin-macro-redefined
6266 @opindex Wno-builtin-macro-redefined
6267 @opindex Wbuiltin-macro-redefined
6268 Do not warn if certain built-in macros are redefined.  This suppresses
6269 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6270 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6272 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6273 @opindex Wstrict-prototypes
6274 @opindex Wno-strict-prototypes
6275 Warn if a function is declared or defined without specifying the
6276 argument types.  (An old-style function definition is permitted without
6277 a warning if preceded by a declaration that specifies the argument
6278 types.)
6280 @item -Wold-style-declaration @r{(C and Objective-C only)}
6281 @opindex Wold-style-declaration
6282 @opindex Wno-old-style-declaration
6283 Warn for obsolescent usages, according to the C Standard, in a
6284 declaration. For example, warn if storage-class specifiers like
6285 @code{static} are not the first things in a declaration.  This warning
6286 is also enabled by @option{-Wextra}.
6288 @item -Wold-style-definition @r{(C and Objective-C only)}
6289 @opindex Wold-style-definition
6290 @opindex Wno-old-style-definition
6291 Warn if an old-style function definition is used.  A warning is given
6292 even if there is a previous prototype.
6294 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6295 @opindex Wmissing-parameter-type
6296 @opindex Wno-missing-parameter-type
6297 A function parameter is declared without a type specifier in K&R-style
6298 functions:
6300 @smallexample
6301 void foo(bar) @{ @}
6302 @end smallexample
6304 This warning is also enabled by @option{-Wextra}.
6306 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6307 @opindex Wmissing-prototypes
6308 @opindex Wno-missing-prototypes
6309 Warn if a global function is defined without a previous prototype
6310 declaration.  This warning is issued even if the definition itself
6311 provides a prototype.  Use this option to detect global functions
6312 that do not have a matching prototype declaration in a header file.
6313 This option is not valid for C++ because all function declarations
6314 provide prototypes and a non-matching declaration declares an
6315 overload rather than conflict with an earlier declaration.
6316 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6318 @item -Wmissing-declarations
6319 @opindex Wmissing-declarations
6320 @opindex Wno-missing-declarations
6321 Warn if a global function is defined without a previous declaration.
6322 Do so even if the definition itself provides a prototype.
6323 Use this option to detect global functions that are not declared in
6324 header files.  In C, no warnings are issued for functions with previous
6325 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6326 missing prototypes.  In C++, no warnings are issued for function templates,
6327 or for inline functions, or for functions in anonymous namespaces.
6329 @item -Wmissing-field-initializers
6330 @opindex Wmissing-field-initializers
6331 @opindex Wno-missing-field-initializers
6332 @opindex W
6333 @opindex Wextra
6334 @opindex Wno-extra
6335 Warn if a structure's initializer has some fields missing.  For
6336 example, the following code causes such a warning, because
6337 @code{x.h} is implicitly zero:
6339 @smallexample
6340 struct s @{ int f, g, h; @};
6341 struct s x = @{ 3, 4 @};
6342 @end smallexample
6344 This option does not warn about designated initializers, so the following
6345 modification does not trigger a warning:
6347 @smallexample
6348 struct s @{ int f, g, h; @};
6349 struct s x = @{ .f = 3, .g = 4 @};
6350 @end smallexample
6352 In C this option does not warn about the universal zero initializer
6353 @samp{@{ 0 @}}:
6355 @smallexample
6356 struct s @{ int f, g, h; @};
6357 struct s x = @{ 0 @};
6358 @end smallexample
6360 Likewise, in C++ this option does not warn about the empty @{ @}
6361 initializer, for example:
6363 @smallexample
6364 struct s @{ int f, g, h; @};
6365 s x = @{ @};
6366 @end smallexample
6368 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6369 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6371 @item -Wno-multichar
6372 @opindex Wno-multichar
6373 @opindex Wmultichar
6374 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6375 Usually they indicate a typo in the user's code, as they have
6376 implementation-defined values, and should not be used in portable code.
6378 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6379 @opindex Wnormalized=
6380 @opindex Wnormalized
6381 @opindex Wno-normalized
6382 @cindex NFC
6383 @cindex NFKC
6384 @cindex character set, input normalization
6385 In ISO C and ISO C++, two identifiers are different if they are
6386 different sequences of characters.  However, sometimes when characters
6387 outside the basic ASCII character set are used, you can have two
6388 different character sequences that look the same.  To avoid confusion,
6389 the ISO 10646 standard sets out some @dfn{normalization rules} which
6390 when applied ensure that two sequences that look the same are turned into
6391 the same sequence.  GCC can warn you if you are using identifiers that
6392 have not been normalized; this option controls that warning.
6394 There are four levels of warning supported by GCC@.  The default is
6395 @option{-Wnormalized=nfc}, which warns about any identifier that is
6396 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6397 recommended form for most uses.  It is equivalent to
6398 @option{-Wnormalized}.
6400 Unfortunately, there are some characters allowed in identifiers by
6401 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6402 identifiers.  That is, there's no way to use these symbols in portable
6403 ISO C or C++ and have all your identifiers in NFC@.
6404 @option{-Wnormalized=id} suppresses the warning for these characters.
6405 It is hoped that future versions of the standards involved will correct
6406 this, which is why this option is not the default.
6408 You can switch the warning off for all characters by writing
6409 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6410 only do this if you are using some other normalization scheme (like
6411 ``D''), because otherwise you can easily create bugs that are
6412 literally impossible to see.
6414 Some characters in ISO 10646 have distinct meanings but look identical
6415 in some fonts or display methodologies, especially once formatting has
6416 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6417 LETTER N'', displays just like a regular @code{n} that has been
6418 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6419 normalization scheme to convert all these into a standard form as
6420 well, and GCC warns if your code is not in NFKC if you use
6421 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6422 about every identifier that contains the letter O because it might be
6423 confused with the digit 0, and so is not the default, but may be
6424 useful as a local coding convention if the programming environment 
6425 cannot be fixed to display these characters distinctly.
6427 @item -Wno-deprecated
6428 @opindex Wno-deprecated
6429 @opindex Wdeprecated
6430 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6432 @item -Wno-deprecated-declarations
6433 @opindex Wno-deprecated-declarations
6434 @opindex Wdeprecated-declarations
6435 Do not warn about uses of functions (@pxref{Function Attributes}),
6436 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6437 Attributes}) marked as deprecated by using the @code{deprecated}
6438 attribute.
6440 @item -Wno-overflow
6441 @opindex Wno-overflow
6442 @opindex Woverflow
6443 Do not warn about compile-time overflow in constant expressions.
6445 @item -Wno-odr
6446 @opindex Wno-odr
6447 @opindex Wodr
6448 Warn about One Definition Rule violations during link-time optimization.
6449 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6451 @item -Wopenmp-simd
6452 @opindex Wopenm-simd
6453 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6454 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6455 option can be used to relax the cost model.
6457 @item -Woverride-init @r{(C and Objective-C only)}
6458 @opindex Woverride-init
6459 @opindex Wno-override-init
6460 @opindex W
6461 @opindex Wextra
6462 @opindex Wno-extra
6463 Warn if an initialized field without side effects is overridden when
6464 using designated initializers (@pxref{Designated Inits, , Designated
6465 Initializers}).
6467 This warning is included in @option{-Wextra}.  To get other
6468 @option{-Wextra} warnings without this one, use @option{-Wextra
6469 -Wno-override-init}.
6471 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6472 @opindex Woverride-init-side-effects
6473 @opindex Wno-override-init-side-effects
6474 Warn if an initialized field with side effects is overridden when
6475 using designated initializers (@pxref{Designated Inits, , Designated
6476 Initializers}).  This warning is enabled by default.
6478 @item -Wpacked
6479 @opindex Wpacked
6480 @opindex Wno-packed
6481 Warn if a structure is given the packed attribute, but the packed
6482 attribute has no effect on the layout or size of the structure.
6483 Such structures may be mis-aligned for little benefit.  For
6484 instance, in this code, the variable @code{f.x} in @code{struct bar}
6485 is misaligned even though @code{struct bar} does not itself
6486 have the packed attribute:
6488 @smallexample
6489 @group
6490 struct foo @{
6491   int x;
6492   char a, b, c, d;
6493 @} __attribute__((packed));
6494 struct bar @{
6495   char z;
6496   struct foo f;
6498 @end group
6499 @end smallexample
6501 @item -Wpacked-bitfield-compat
6502 @opindex Wpacked-bitfield-compat
6503 @opindex Wno-packed-bitfield-compat
6504 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6505 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6506 the change can lead to differences in the structure layout.  GCC
6507 informs you when the offset of such a field has changed in GCC 4.4.
6508 For example there is no longer a 4-bit padding between field @code{a}
6509 and @code{b} in this structure:
6511 @smallexample
6512 struct foo
6514   char a:4;
6515   char b:8;
6516 @} __attribute__ ((packed));
6517 @end smallexample
6519 This warning is enabled by default.  Use
6520 @option{-Wno-packed-bitfield-compat} to disable this warning.
6522 @item -Wpadded
6523 @opindex Wpadded
6524 @opindex Wno-padded
6525 Warn if padding is included in a structure, either to align an element
6526 of the structure or to align the whole structure.  Sometimes when this
6527 happens it is possible to rearrange the fields of the structure to
6528 reduce the padding and so make the structure smaller.
6530 @item -Wredundant-decls
6531 @opindex Wredundant-decls
6532 @opindex Wno-redundant-decls
6533 Warn if anything is declared more than once in the same scope, even in
6534 cases where multiple declaration is valid and changes nothing.
6536 @item -Wrestrict
6537 @opindex Wrestrict
6538 @opindex Wno-restrict
6539 Warn when an argument passed to a restrict-qualified parameter
6540 aliases with another argument.
6542 @item -Wnested-externs @r{(C and Objective-C only)}
6543 @opindex Wnested-externs
6544 @opindex Wno-nested-externs
6545 Warn if an @code{extern} declaration is encountered within a function.
6547 @item -Wno-inherited-variadic-ctor
6548 @opindex Winherited-variadic-ctor
6549 @opindex Wno-inherited-variadic-ctor
6550 Suppress warnings about use of C++11 inheriting constructors when the
6551 base class inherited from has a C variadic constructor; the warning is
6552 on by default because the ellipsis is not inherited.
6554 @item -Winline
6555 @opindex Winline
6556 @opindex Wno-inline
6557 Warn if a function that is declared as inline cannot be inlined.
6558 Even with this option, the compiler does not warn about failures to
6559 inline functions declared in system headers.
6561 The compiler uses a variety of heuristics to determine whether or not
6562 to inline a function.  For example, the compiler takes into account
6563 the size of the function being inlined and the amount of inlining
6564 that has already been done in the current function.  Therefore,
6565 seemingly insignificant changes in the source program can cause the
6566 warnings produced by @option{-Winline} to appear or disappear.
6568 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6569 @opindex Wno-invalid-offsetof
6570 @opindex Winvalid-offsetof
6571 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6572 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6573 to a non-standard-layout type is undefined.  In existing C++ implementations,
6574 however, @code{offsetof} typically gives meaningful results.
6575 This flag is for users who are aware that they are
6576 writing nonportable code and who have deliberately chosen to ignore the
6577 warning about it.
6579 The restrictions on @code{offsetof} may be relaxed in a future version
6580 of the C++ standard.
6582 @item -Wint-in-bool-context
6583 @opindex Wint-in-bool-context
6584 @opindex Wno-int-in-bool-context
6585 Warn for suspicious use of integer values where boolean values are expected,
6586 such as conditional expressions (?:) using non-boolean integer constants in
6587 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6588 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6589 for all kinds of multiplications regardless of the data type.
6590 This warning is enabled by @option{-Wall}.
6592 @item -Wno-int-to-pointer-cast
6593 @opindex Wno-int-to-pointer-cast
6594 @opindex Wint-to-pointer-cast
6595 Suppress warnings from casts to pointer type of an integer of a
6596 different size. In C++, casting to a pointer type of smaller size is
6597 an error. @option{Wint-to-pointer-cast} is enabled by default.
6600 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6601 @opindex Wno-pointer-to-int-cast
6602 @opindex Wpointer-to-int-cast
6603 Suppress warnings from casts from a pointer to an integer type of a
6604 different size.
6606 @item -Winvalid-pch
6607 @opindex Winvalid-pch
6608 @opindex Wno-invalid-pch
6609 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6610 the search path but cannot be used.
6612 @item -Wlong-long
6613 @opindex Wlong-long
6614 @opindex Wno-long-long
6615 Warn if @code{long long} type is used.  This is enabled by either
6616 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6617 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6619 @item -Wvariadic-macros
6620 @opindex Wvariadic-macros
6621 @opindex Wno-variadic-macros
6622 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6623 alternate syntax is used in ISO C99 mode.  This is enabled by either
6624 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6625 messages, use @option{-Wno-variadic-macros}.
6627 @item -Wvarargs
6628 @opindex Wvarargs
6629 @opindex Wno-varargs
6630 Warn upon questionable usage of the macros used to handle variable
6631 arguments like @code{va_start}.  This is default.  To inhibit the
6632 warning messages, use @option{-Wno-varargs}.
6634 @item -Wvector-operation-performance
6635 @opindex Wvector-operation-performance
6636 @opindex Wno-vector-operation-performance
6637 Warn if vector operation is not implemented via SIMD capabilities of the
6638 architecture.  Mainly useful for the performance tuning.
6639 Vector operation can be implemented @code{piecewise}, which means that the
6640 scalar operation is performed on every vector element; 
6641 @code{in parallel}, which means that the vector operation is implemented
6642 using scalars of wider type, which normally is more performance efficient;
6643 and @code{as a single scalar}, which means that vector fits into a
6644 scalar type.
6646 @item -Wno-virtual-move-assign
6647 @opindex Wvirtual-move-assign
6648 @opindex Wno-virtual-move-assign
6649 Suppress warnings about inheriting from a virtual base with a
6650 non-trivial C++11 move assignment operator.  This is dangerous because
6651 if the virtual base is reachable along more than one path, it is
6652 moved multiple times, which can mean both objects end up in the
6653 moved-from state.  If the move assignment operator is written to avoid
6654 moving from a moved-from object, this warning can be disabled.
6656 @item -Wvla
6657 @opindex Wvla
6658 @opindex Wno-vla
6659 Warn if a variable-length array is used in the code.
6660 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6661 the variable-length array.
6663 @item -Wvla-larger-than=@var{n}
6664 If this option is used, the compiler will warn on uses of
6665 variable-length arrays where the size is either unbounded, or bounded
6666 by an argument that can be larger than @var{n} bytes.  This is similar
6667 to how @option{-Walloca-larger-than=@var{n}} works, but with
6668 variable-length arrays.
6670 Note that GCC may optimize small variable-length arrays of a known
6671 value into plain arrays, so this warning may not get triggered for
6672 such arrays.
6674 This warning is not enabled by @option{-Wall}, and is only active when
6675 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6677 See also @option{-Walloca-larger-than=@var{n}}.
6679 @item -Wvolatile-register-var
6680 @opindex Wvolatile-register-var
6681 @opindex Wno-volatile-register-var
6682 Warn if a register variable is declared volatile.  The volatile
6683 modifier does not inhibit all optimizations that may eliminate reads
6684 and/or writes to register variables.  This warning is enabled by
6685 @option{-Wall}.
6687 @item -Wdisabled-optimization
6688 @opindex Wdisabled-optimization
6689 @opindex Wno-disabled-optimization
6690 Warn if a requested optimization pass is disabled.  This warning does
6691 not generally indicate that there is anything wrong with your code; it
6692 merely indicates that GCC's optimizers are unable to handle the code
6693 effectively.  Often, the problem is that your code is too big or too
6694 complex; GCC refuses to optimize programs when the optimization
6695 itself is likely to take inordinate amounts of time.
6697 @item -Wpointer-sign @r{(C and Objective-C only)}
6698 @opindex Wpointer-sign
6699 @opindex Wno-pointer-sign
6700 Warn for pointer argument passing or assignment with different signedness.
6701 This option is only supported for C and Objective-C@.  It is implied by
6702 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6703 @option{-Wno-pointer-sign}.
6705 @item -Wstack-protector
6706 @opindex Wstack-protector
6707 @opindex Wno-stack-protector
6708 This option is only active when @option{-fstack-protector} is active.  It
6709 warns about functions that are not protected against stack smashing.
6711 @item -Woverlength-strings
6712 @opindex Woverlength-strings
6713 @opindex Wno-overlength-strings
6714 Warn about string constants that are longer than the ``minimum
6715 maximum'' length specified in the C standard.  Modern compilers
6716 generally allow string constants that are much longer than the
6717 standard's minimum limit, but very portable programs should avoid
6718 using longer strings.
6720 The limit applies @emph{after} string constant concatenation, and does
6721 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6722 C99, it was raised to 4095.  C++98 does not specify a normative
6723 minimum maximum, so we do not diagnose overlength strings in C++@.
6725 This option is implied by @option{-Wpedantic}, and can be disabled with
6726 @option{-Wno-overlength-strings}.
6728 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6729 @opindex Wunsuffixed-float-constants
6731 Issue a warning for any floating constant that does not have
6732 a suffix.  When used together with @option{-Wsystem-headers} it
6733 warns about such constants in system header files.  This can be useful
6734 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6735 from the decimal floating-point extension to C99.
6737 @item -Wno-designated-init @r{(C and Objective-C only)}
6738 Suppress warnings when a positional initializer is used to initialize
6739 a structure that has been marked with the @code{designated_init}
6740 attribute.
6742 @item -Whsa
6743 Issue a warning when HSAIL cannot be emitted for the compiled function or
6744 OpenMP construct.
6746 @end table
6748 @node Debugging Options
6749 @section Options for Debugging Your Program
6750 @cindex options, debugging
6751 @cindex debugging information options
6753 To tell GCC to emit extra information for use by a debugger, in almost 
6754 all cases you need only to add @option{-g} to your other options.
6756 GCC allows you to use @option{-g} with
6757 @option{-O}.  The shortcuts taken by optimized code may occasionally
6758 be surprising: some variables you declared may not exist
6759 at all; flow of control may briefly move where you did not expect it;
6760 some statements may not be executed because they compute constant
6761 results or their values are already at hand; some statements may
6762 execute in different places because they have been moved out of loops.
6763 Nevertheless it is possible to debug optimized output.  This makes
6764 it reasonable to use the optimizer for programs that might have bugs.
6766 If you are not using some other optimization option, consider
6767 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6768 With no @option{-O} option at all, some compiler passes that collect
6769 information useful for debugging do not run at all, so that
6770 @option{-Og} may result in a better debugging experience.
6772 @table @gcctabopt
6773 @item -g
6774 @opindex g
6775 Produce debugging information in the operating system's native format
6776 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6777 information.
6779 On most systems that use stabs format, @option{-g} enables use of extra
6780 debugging information that only GDB can use; this extra information
6781 makes debugging work better in GDB but probably makes other debuggers
6782 crash or
6783 refuse to read the program.  If you want to control for certain whether
6784 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6785 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6787 @item -ggdb
6788 @opindex ggdb
6789 Produce debugging information for use by GDB@.  This means to use the
6790 most expressive format available (DWARF, stabs, or the native format
6791 if neither of those are supported), including GDB extensions if at all
6792 possible.
6794 @item -gdwarf
6795 @itemx -gdwarf-@var{version}
6796 @opindex gdwarf
6797 Produce debugging information in DWARF format (if that is supported).
6798 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6799 for most targets is 4.  DWARF Version 5 is only experimental.
6801 Note that with DWARF Version 2, some ports require and always
6802 use some non-conflicting DWARF 3 extensions in the unwind tables.
6804 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6805 for maximum benefit.
6807 GCC no longer supports DWARF Version 1, which is substantially
6808 different than Version 2 and later.  For historical reasons, some
6809 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6810 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6811 in their names, but apply to all currently-supported versions of DWARF.
6813 @item -gstabs
6814 @opindex gstabs
6815 Produce debugging information in stabs format (if that is supported),
6816 without GDB extensions.  This is the format used by DBX on most BSD
6817 systems.  On MIPS, Alpha and System V Release 4 systems this option
6818 produces stabs debugging output that is not understood by DBX or SDB@.
6819 On System V Release 4 systems this option requires the GNU assembler.
6821 @item -gstabs+
6822 @opindex gstabs+
6823 Produce debugging information in stabs format (if that is supported),
6824 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6825 use of these extensions is likely to make other debuggers crash or
6826 refuse to read the program.
6828 @item -gcoff
6829 @opindex gcoff
6830 Produce debugging information in COFF format (if that is supported).
6831 This is the format used by SDB on most System V systems prior to
6832 System V Release 4.
6834 @item -gxcoff
6835 @opindex gxcoff
6836 Produce debugging information in XCOFF format (if that is supported).
6837 This is the format used by the DBX debugger on IBM RS/6000 systems.
6839 @item -gxcoff+
6840 @opindex gxcoff+
6841 Produce debugging information in XCOFF format (if that is supported),
6842 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6843 use of these extensions is likely to make other debuggers crash or
6844 refuse to read the program, and may cause assemblers other than the GNU
6845 assembler (GAS) to fail with an error.
6847 @item -gvms
6848 @opindex gvms
6849 Produce debugging information in Alpha/VMS debug format (if that is
6850 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6852 @item -g@var{level}
6853 @itemx -ggdb@var{level}
6854 @itemx -gstabs@var{level}
6855 @itemx -gcoff@var{level}
6856 @itemx -gxcoff@var{level}
6857 @itemx -gvms@var{level}
6858 Request debugging information and also use @var{level} to specify how
6859 much information.  The default level is 2.
6861 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6862 @option{-g}.
6864 Level 1 produces minimal information, enough for making backtraces in
6865 parts of the program that you don't plan to debug.  This includes
6866 descriptions of functions and external variables, and line number
6867 tables, but no information about local variables.
6869 Level 3 includes extra information, such as all the macro definitions
6870 present in the program.  Some debuggers support macro expansion when
6871 you use @option{-g3}.
6873 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6874 confusion with @option{-gdwarf-@var{level}}.
6875 Instead use an additional @option{-g@var{level}} option to change the
6876 debug level for DWARF.
6878 @item -feliminate-unused-debug-symbols
6879 @opindex feliminate-unused-debug-symbols
6880 Produce debugging information in stabs format (if that is supported),
6881 for only symbols that are actually used.
6883 @item -femit-class-debug-always
6884 @opindex femit-class-debug-always
6885 Instead of emitting debugging information for a C++ class in only one
6886 object file, emit it in all object files using the class.  This option
6887 should be used only with debuggers that are unable to handle the way GCC
6888 normally emits debugging information for classes because using this
6889 option increases the size of debugging information by as much as a
6890 factor of two.
6892 @item -fno-merge-debug-strings
6893 @opindex fmerge-debug-strings
6894 @opindex fno-merge-debug-strings
6895 Direct the linker to not merge together strings in the debugging
6896 information that are identical in different object files.  Merging is
6897 not supported by all assemblers or linkers.  Merging decreases the size
6898 of the debug information in the output file at the cost of increasing
6899 link processing time.  Merging is enabled by default.
6901 @item -fdebug-prefix-map=@var{old}=@var{new}
6902 @opindex fdebug-prefix-map
6903 When compiling files in directory @file{@var{old}}, record debugging
6904 information describing them as in @file{@var{new}} instead.
6906 @item -fvar-tracking
6907 @opindex fvar-tracking
6908 Run variable tracking pass.  It computes where variables are stored at each
6909 position in code.  Better debugging information is then generated
6910 (if the debugging information format supports this information).
6912 It is enabled by default when compiling with optimization (@option{-Os},
6913 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6914 the debug info format supports it.
6916 @item -fvar-tracking-assignments
6917 @opindex fvar-tracking-assignments
6918 @opindex fno-var-tracking-assignments
6919 Annotate assignments to user variables early in the compilation and
6920 attempt to carry the annotations over throughout the compilation all the
6921 way to the end, in an attempt to improve debug information while
6922 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6924 It can be enabled even if var-tracking is disabled, in which case
6925 annotations are created and maintained, but discarded at the end.
6926 By default, this flag is enabled together with @option{-fvar-tracking},
6927 except when selective scheduling is enabled.
6929 @item -gsplit-dwarf
6930 @opindex gsplit-dwarf
6931 Separate as much DWARF debugging information as possible into a
6932 separate output file with the extension @file{.dwo}.  This option allows
6933 the build system to avoid linking files with debug information.  To
6934 be useful, this option requires a debugger capable of reading @file{.dwo}
6935 files.
6937 @item -gpubnames
6938 @opindex gpubnames
6939 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6941 @item -ggnu-pubnames
6942 @opindex ggnu-pubnames
6943 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6944 suitable for conversion into a GDB@ index.  This option is only useful
6945 with a linker that can produce GDB@ index version 7.
6947 @item -fdebug-types-section
6948 @opindex fdebug-types-section
6949 @opindex fno-debug-types-section
6950 When using DWARF Version 4 or higher, type DIEs can be put into
6951 their own @code{.debug_types} section instead of making them part of the
6952 @code{.debug_info} section.  It is more efficient to put them in a separate
6953 comdat sections since the linker can then remove duplicates.
6954 But not all DWARF consumers support @code{.debug_types} sections yet
6955 and on some objects @code{.debug_types} produces larger instead of smaller
6956 debugging information.
6958 @item -grecord-gcc-switches
6959 @item -gno-record-gcc-switches
6960 @opindex grecord-gcc-switches
6961 @opindex gno-record-gcc-switches
6962 This switch causes the command-line options used to invoke the
6963 compiler that may affect code generation to be appended to the
6964 DW_AT_producer attribute in DWARF debugging information.  The options
6965 are concatenated with spaces separating them from each other and from
6966 the compiler version.  
6967 It is enabled by default.
6968 See also @option{-frecord-gcc-switches} for another
6969 way of storing compiler options into the object file.  
6971 @item -gstrict-dwarf
6972 @opindex gstrict-dwarf
6973 Disallow using extensions of later DWARF standard version than selected
6974 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6975 DWARF extensions from later standard versions is allowed.
6977 @item -gno-strict-dwarf
6978 @opindex gno-strict-dwarf
6979 Allow using extensions of later DWARF standard version than selected with
6980 @option{-gdwarf-@var{version}}.
6982 @item -gcolumn-info
6983 @item -gno-column-info
6984 @opindex gcolumn-info
6985 @opindex gno-column-info
6986 Emit location column information into DWARF debugging information, rather
6987 than just file and line.
6988 This option is disabled by default.
6990 @item -gz@r{[}=@var{type}@r{]}
6991 @opindex gz
6992 Produce compressed debug sections in DWARF format, if that is supported.
6993 If @var{type} is not given, the default type depends on the capabilities
6994 of the assembler and linker used.  @var{type} may be one of
6995 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6996 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6997 compression in traditional GNU format).  If the linker doesn't support
6998 writing compressed debug sections, the option is rejected.  Otherwise,
6999 if the assembler does not support them, @option{-gz} is silently ignored
7000 when producing object files.
7002 @item -feliminate-dwarf2-dups
7003 @opindex feliminate-dwarf2-dups
7004 Compress DWARF debugging information by eliminating duplicated
7005 information about each symbol.  This option only makes sense when
7006 generating DWARF debugging information.
7008 @item -femit-struct-debug-baseonly
7009 @opindex femit-struct-debug-baseonly
7010 Emit debug information for struct-like types
7011 only when the base name of the compilation source file
7012 matches the base name of file in which the struct is defined.
7014 This option substantially reduces the size of debugging information,
7015 but at significant potential loss in type information to the debugger.
7016 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7017 See @option{-femit-struct-debug-detailed} for more detailed control.
7019 This option works only with DWARF debug output.
7021 @item -femit-struct-debug-reduced
7022 @opindex femit-struct-debug-reduced
7023 Emit debug information for struct-like types
7024 only when the base name of the compilation source file
7025 matches the base name of file in which the type is defined,
7026 unless the struct is a template or defined in a system header.
7028 This option significantly reduces the size of debugging information,
7029 with some potential loss in type information to the debugger.
7030 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7031 See @option{-femit-struct-debug-detailed} for more detailed control.
7033 This option works only with DWARF debug output.
7035 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7036 @opindex femit-struct-debug-detailed
7037 Specify the struct-like types
7038 for which the compiler generates debug information.
7039 The intent is to reduce duplicate struct debug information
7040 between different object files within the same program.
7042 This option is a detailed version of
7043 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7044 which serves for most needs.
7046 A specification has the syntax@*
7047 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7049 The optional first word limits the specification to
7050 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7051 A struct type is used directly when it is the type of a variable, member.
7052 Indirect uses arise through pointers to structs.
7053 That is, when use of an incomplete struct is valid, the use is indirect.
7054 An example is
7055 @samp{struct one direct; struct two * indirect;}.
7057 The optional second word limits the specification to
7058 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7059 Generic structs are a bit complicated to explain.
7060 For C++, these are non-explicit specializations of template classes,
7061 or non-template classes within the above.
7062 Other programming languages have generics,
7063 but @option{-femit-struct-debug-detailed} does not yet implement them.
7065 The third word specifies the source files for those
7066 structs for which the compiler should emit debug information.
7067 The values @samp{none} and @samp{any} have the normal meaning.
7068 The value @samp{base} means that
7069 the base of name of the file in which the type declaration appears
7070 must match the base of the name of the main compilation file.
7071 In practice, this means that when compiling @file{foo.c}, debug information
7072 is generated for types declared in that file and @file{foo.h},
7073 but not other header files.
7074 The value @samp{sys} means those types satisfying @samp{base}
7075 or declared in system or compiler headers.
7077 You may need to experiment to determine the best settings for your application.
7079 The default is @option{-femit-struct-debug-detailed=all}.
7081 This option works only with DWARF debug output.
7083 @item -fno-dwarf2-cfi-asm
7084 @opindex fdwarf2-cfi-asm
7085 @opindex fno-dwarf2-cfi-asm
7086 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7087 instead of using GAS @code{.cfi_*} directives.
7089 @item -fno-eliminate-unused-debug-types
7090 @opindex feliminate-unused-debug-types
7091 @opindex fno-eliminate-unused-debug-types
7092 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7093 output for types that are nowhere used in the source file being compiled.
7094 Sometimes it is useful to have GCC emit debugging
7095 information for all types declared in a compilation
7096 unit, regardless of whether or not they are actually used
7097 in that compilation unit, for example 
7098 if, in the debugger, you want to cast a value to a type that is
7099 not actually used in your program (but is declared).  More often,
7100 however, this results in a significant amount of wasted space.
7101 @end table
7103 @node Optimize Options
7104 @section Options That Control Optimization
7105 @cindex optimize options
7106 @cindex options, optimization
7108 These options control various sorts of optimizations.
7110 Without any optimization option, the compiler's goal is to reduce the
7111 cost of compilation and to make debugging produce the expected
7112 results.  Statements are independent: if you stop the program with a
7113 breakpoint between statements, you can then assign a new value to any
7114 variable or change the program counter to any other statement in the
7115 function and get exactly the results you expect from the source
7116 code.
7118 Turning on optimization flags makes the compiler attempt to improve
7119 the performance and/or code size at the expense of compilation time
7120 and possibly the ability to debug the program.
7122 The compiler performs optimization based on the knowledge it has of the
7123 program.  Compiling multiple files at once to a single output file mode allows
7124 the compiler to use information gained from all of the files when compiling
7125 each of them.
7127 Not all optimizations are controlled directly by a flag.  Only
7128 optimizations that have a flag are listed in this section.
7130 Most optimizations are only enabled if an @option{-O} level is set on
7131 the command line.  Otherwise they are disabled, even if individual
7132 optimization flags are specified.
7134 Depending on the target and how GCC was configured, a slightly different
7135 set of optimizations may be enabled at each @option{-O} level than
7136 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7137 to find out the exact set of optimizations that are enabled at each level.
7138 @xref{Overall Options}, for examples.
7140 @table @gcctabopt
7141 @item -O
7142 @itemx -O1
7143 @opindex O
7144 @opindex O1
7145 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7146 more memory for a large function.
7148 With @option{-O}, the compiler tries to reduce code size and execution
7149 time, without performing any optimizations that take a great deal of
7150 compilation time.
7152 @option{-O} turns on the following optimization flags:
7153 @gccoptlist{
7154 -fauto-inc-dec @gol
7155 -fbranch-count-reg @gol
7156 -fcombine-stack-adjustments @gol
7157 -fcompare-elim @gol
7158 -fcprop-registers @gol
7159 -fdce @gol
7160 -fdefer-pop @gol
7161 -fdelayed-branch @gol
7162 -fdse @gol
7163 -fforward-propagate @gol
7164 -fguess-branch-probability @gol
7165 -fif-conversion2 @gol
7166 -fif-conversion @gol
7167 -finline-functions-called-once @gol
7168 -fipa-pure-const @gol
7169 -fipa-profile @gol
7170 -fipa-reference @gol
7171 -fmerge-constants @gol
7172 -fmove-loop-invariants @gol
7173 -freorder-blocks @gol
7174 -fshrink-wrap @gol
7175 -fshrink-wrap-separate @gol
7176 -fsplit-wide-types @gol
7177 -fssa-backprop @gol
7178 -fssa-phiopt @gol
7179 -ftree-bit-ccp @gol
7180 -ftree-ccp @gol
7181 -ftree-ch @gol
7182 -ftree-coalesce-vars @gol
7183 -ftree-copy-prop @gol
7184 -ftree-dce @gol
7185 -ftree-dominator-opts @gol
7186 -ftree-dse @gol
7187 -ftree-forwprop @gol
7188 -ftree-fre @gol
7189 -ftree-phiprop @gol
7190 -ftree-sink @gol
7191 -ftree-slsr @gol
7192 -ftree-sra @gol
7193 -ftree-pta @gol
7194 -ftree-ter @gol
7195 -funit-at-a-time}
7197 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7198 where doing so does not interfere with debugging.
7200 @item -O2
7201 @opindex O2
7202 Optimize even more.  GCC performs nearly all supported optimizations
7203 that do not involve a space-speed tradeoff.
7204 As compared to @option{-O}, this option increases both compilation time
7205 and the performance of the generated code.
7207 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7208 also turns on the following optimization flags:
7209 @gccoptlist{-fthread-jumps @gol
7210 -falign-functions  -falign-jumps @gol
7211 -falign-loops  -falign-labels @gol
7212 -fcaller-saves @gol
7213 -fcrossjumping @gol
7214 -fcse-follow-jumps  -fcse-skip-blocks @gol
7215 -fdelete-null-pointer-checks @gol
7216 -fdevirtualize -fdevirtualize-speculatively @gol
7217 -fexpensive-optimizations @gol
7218 -fgcse  -fgcse-lm  @gol
7219 -fhoist-adjacent-loads @gol
7220 -finline-small-functions @gol
7221 -findirect-inlining @gol
7222 -fipa-cp @gol
7223 -fipa-bit-cp @gol
7224 -fipa-vrp @gol
7225 -fipa-sra @gol
7226 -fipa-icf @gol
7227 -fisolate-erroneous-paths-dereference @gol
7228 -flra-remat @gol
7229 -foptimize-sibling-calls @gol
7230 -foptimize-strlen @gol
7231 -fpartial-inlining @gol
7232 -fpeephole2 @gol
7233 -freorder-blocks-algorithm=stc @gol
7234 -freorder-blocks-and-partition -freorder-functions @gol
7235 -frerun-cse-after-loop  @gol
7236 -fsched-interblock  -fsched-spec @gol
7237 -fschedule-insns  -fschedule-insns2 @gol
7238 -fstore-merging @gol
7239 -fstrict-aliasing @gol
7240 -ftree-builtin-call-dce @gol
7241 -ftree-switch-conversion -ftree-tail-merge @gol
7242 -fcode-hoisting @gol
7243 -ftree-pre @gol
7244 -ftree-vrp @gol
7245 -fipa-ra}
7247 Please note the warning under @option{-fgcse} about
7248 invoking @option{-O2} on programs that use computed gotos.
7250 @item -O3
7251 @opindex O3
7252 Optimize yet more.  @option{-O3} turns on all optimizations specified
7253 by @option{-O2} and also turns on the @option{-finline-functions},
7254 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7255 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7256 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7257 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7258 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7259 and @option{-fipa-cp-clone} options.
7261 @item -O0
7262 @opindex O0
7263 Reduce compilation time and make debugging produce the expected
7264 results.  This is the default.
7266 @item -Os
7267 @opindex Os
7268 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7269 do not typically increase code size.  It also performs further
7270 optimizations designed to reduce code size.
7272 @option{-Os} disables the following optimization flags:
7273 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7274 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7275 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7277 @item -Ofast
7278 @opindex Ofast
7279 Disregard strict standards compliance.  @option{-Ofast} enables all
7280 @option{-O3} optimizations.  It also enables optimizations that are not
7281 valid for all standard-compliant programs.
7282 It turns on @option{-ffast-math} and the Fortran-specific
7283 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7285 @item -Og
7286 @opindex Og
7287 Optimize debugging experience.  @option{-Og} enables optimizations
7288 that do not interfere with debugging. It should be the optimization
7289 level of choice for the standard edit-compile-debug cycle, offering
7290 a reasonable level of optimization while maintaining fast compilation
7291 and a good debugging experience.
7292 @end table
7294 If you use multiple @option{-O} options, with or without level numbers,
7295 the last such option is the one that is effective.
7297 Options of the form @option{-f@var{flag}} specify machine-independent
7298 flags.  Most flags have both positive and negative forms; the negative
7299 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7300 below, only one of the forms is listed---the one you typically 
7301 use.  You can figure out the other form by either removing @samp{no-}
7302 or adding it.
7304 The following options control specific optimizations.  They are either
7305 activated by @option{-O} options or are related to ones that are.  You
7306 can use the following flags in the rare cases when ``fine-tuning'' of
7307 optimizations to be performed is desired.
7309 @table @gcctabopt
7310 @item -fno-defer-pop
7311 @opindex fno-defer-pop
7312 Always pop the arguments to each function call as soon as that function
7313 returns.  For machines that must pop arguments after a function call,
7314 the compiler normally lets arguments accumulate on the stack for several
7315 function calls and pops them all at once.
7317 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7319 @item -fforward-propagate
7320 @opindex fforward-propagate
7321 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7322 instructions and checks if the result can be simplified.  If loop unrolling
7323 is active, two passes are performed and the second is scheduled after
7324 loop unrolling.
7326 This option is enabled by default at optimization levels @option{-O},
7327 @option{-O2}, @option{-O3}, @option{-Os}.
7329 @item -ffp-contract=@var{style}
7330 @opindex ffp-contract
7331 @option{-ffp-contract=off} disables floating-point expression contraction.
7332 @option{-ffp-contract=fast} enables floating-point expression contraction
7333 such as forming of fused multiply-add operations if the target has
7334 native support for them.
7335 @option{-ffp-contract=on} enables floating-point expression contraction
7336 if allowed by the language standard.  This is currently not implemented
7337 and treated equal to @option{-ffp-contract=off}.
7339 The default is @option{-ffp-contract=fast}.
7341 @item -fomit-frame-pointer
7342 @opindex fomit-frame-pointer
7343 Don't keep the frame pointer in a register for functions that
7344 don't need one.  This avoids the instructions to save, set up and
7345 restore frame pointers; it also makes an extra register available
7346 in many functions.  @strong{It also makes debugging impossible on
7347 some machines.}
7349 On some machines, such as the VAX, this flag has no effect, because
7350 the standard calling sequence automatically handles the frame pointer
7351 and nothing is saved by pretending it doesn't exist.  The
7352 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7353 whether a target machine supports this flag.  @xref{Registers,,Register
7354 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7356 The default setting (when not optimizing for
7357 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7358 @option{-fomit-frame-pointer}.  You can configure GCC with the
7359 @option{--enable-frame-pointer} configure option to change the default.
7361 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7363 @item -foptimize-sibling-calls
7364 @opindex foptimize-sibling-calls
7365 Optimize sibling and tail recursive calls.
7367 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7369 @item -foptimize-strlen
7370 @opindex foptimize-strlen
7371 Optimize various standard C string functions (e.g. @code{strlen},
7372 @code{strchr} or @code{strcpy}) and
7373 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7375 Enabled at levels @option{-O2}, @option{-O3}.
7377 @item -fno-inline
7378 @opindex fno-inline
7379 Do not expand any functions inline apart from those marked with
7380 the @code{always_inline} attribute.  This is the default when not
7381 optimizing.
7383 Single functions can be exempted from inlining by marking them
7384 with the @code{noinline} attribute.
7386 @item -finline-small-functions
7387 @opindex finline-small-functions
7388 Integrate functions into their callers when their body is smaller than expected
7389 function call code (so overall size of program gets smaller).  The compiler
7390 heuristically decides which functions are simple enough to be worth integrating
7391 in this way.  This inlining applies to all functions, even those not declared
7392 inline.
7394 Enabled at level @option{-O2}.
7396 @item -findirect-inlining
7397 @opindex findirect-inlining
7398 Inline also indirect calls that are discovered to be known at compile
7399 time thanks to previous inlining.  This option has any effect only
7400 when inlining itself is turned on by the @option{-finline-functions}
7401 or @option{-finline-small-functions} options.
7403 Enabled at level @option{-O2}.
7405 @item -finline-functions
7406 @opindex finline-functions
7407 Consider all functions for inlining, even if they are not declared inline.
7408 The compiler heuristically decides which functions are worth integrating
7409 in this way.
7411 If all calls to a given function are integrated, and the function is
7412 declared @code{static}, then the function is normally not output as
7413 assembler code in its own right.
7415 Enabled at level @option{-O3}.
7417 @item -finline-functions-called-once
7418 @opindex finline-functions-called-once
7419 Consider all @code{static} functions called once for inlining into their
7420 caller even if they are not marked @code{inline}.  If a call to a given
7421 function is integrated, then the function is not output as assembler code
7422 in its own right.
7424 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7426 @item -fearly-inlining
7427 @opindex fearly-inlining
7428 Inline functions marked by @code{always_inline} and functions whose body seems
7429 smaller than the function call overhead early before doing
7430 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7431 makes profiling significantly cheaper and usually inlining faster on programs
7432 having large chains of nested wrapper functions.
7434 Enabled by default.
7436 @item -fipa-sra
7437 @opindex fipa-sra
7438 Perform interprocedural scalar replacement of aggregates, removal of
7439 unused parameters and replacement of parameters passed by reference
7440 by parameters passed by value.
7442 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7444 @item -finline-limit=@var{n}
7445 @opindex finline-limit
7446 By default, GCC limits the size of functions that can be inlined.  This flag
7447 allows coarse control of this limit.  @var{n} is the size of functions that
7448 can be inlined in number of pseudo instructions.
7450 Inlining is actually controlled by a number of parameters, which may be
7451 specified individually by using @option{--param @var{name}=@var{value}}.
7452 The @option{-finline-limit=@var{n}} option sets some of these parameters
7453 as follows:
7455 @table @gcctabopt
7456 @item max-inline-insns-single
7457 is set to @var{n}/2.
7458 @item max-inline-insns-auto
7459 is set to @var{n}/2.
7460 @end table
7462 See below for a documentation of the individual
7463 parameters controlling inlining and for the defaults of these parameters.
7465 @emph{Note:} there may be no value to @option{-finline-limit} that results
7466 in default behavior.
7468 @emph{Note:} pseudo instruction represents, in this particular context, an
7469 abstract measurement of function's size.  In no way does it represent a count
7470 of assembly instructions and as such its exact meaning might change from one
7471 release to an another.
7473 @item -fno-keep-inline-dllexport
7474 @opindex fno-keep-inline-dllexport
7475 This is a more fine-grained version of @option{-fkeep-inline-functions},
7476 which applies only to functions that are declared using the @code{dllexport}
7477 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7478 Functions}.
7480 @item -fkeep-inline-functions
7481 @opindex fkeep-inline-functions
7482 In C, emit @code{static} functions that are declared @code{inline}
7483 into the object file, even if the function has been inlined into all
7484 of its callers.  This switch does not affect functions using the
7485 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7486 inline functions into the object file.
7488 @item -fkeep-static-functions
7489 @opindex fkeep-static-functions
7490 Emit @code{static} functions into the object file, even if the function
7491 is never used.
7493 @item -fkeep-static-consts
7494 @opindex fkeep-static-consts
7495 Emit variables declared @code{static const} when optimization isn't turned
7496 on, even if the variables aren't referenced.
7498 GCC enables this option by default.  If you want to force the compiler to
7499 check if a variable is referenced, regardless of whether or not
7500 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7502 @item -fmerge-constants
7503 @opindex fmerge-constants
7504 Attempt to merge identical constants (string constants and floating-point
7505 constants) across compilation units.
7507 This option is the default for optimized compilation if the assembler and
7508 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7509 behavior.
7511 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7513 @item -fmerge-all-constants
7514 @opindex fmerge-all-constants
7515 Attempt to merge identical constants and identical variables.
7517 This option implies @option{-fmerge-constants}.  In addition to
7518 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7519 arrays or initialized constant variables with integral or floating-point
7520 types.  Languages like C or C++ require each variable, including multiple
7521 instances of the same variable in recursive calls, to have distinct locations,
7522 so using this option results in non-conforming
7523 behavior.
7525 @item -fmodulo-sched
7526 @opindex fmodulo-sched
7527 Perform swing modulo scheduling immediately before the first scheduling
7528 pass.  This pass looks at innermost loops and reorders their
7529 instructions by overlapping different iterations.
7531 @item -fmodulo-sched-allow-regmoves
7532 @opindex fmodulo-sched-allow-regmoves
7533 Perform more aggressive SMS-based modulo scheduling with register moves
7534 allowed.  By setting this flag certain anti-dependences edges are
7535 deleted, which triggers the generation of reg-moves based on the
7536 life-range analysis.  This option is effective only with
7537 @option{-fmodulo-sched} enabled.
7539 @item -fno-branch-count-reg
7540 @opindex fno-branch-count-reg
7541 Avoid running a pass scanning for opportunities to use ``decrement and
7542 branch'' instructions on a count register instead of generating sequences
7543 of instructions that decrement a register, compare it against zero, and
7544 then branch based upon the result.  This option is only meaningful on
7545 architectures that support such instructions, which include x86, PowerPC,
7546 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7547 doesn't remove the decrement and branch instructions from the generated
7548 instruction stream introduced by other optimization passes.
7550 Enabled by default at @option{-O1} and higher.
7552 The default is @option{-fbranch-count-reg}.
7554 @item -fno-function-cse
7555 @opindex fno-function-cse
7556 Do not put function addresses in registers; make each instruction that
7557 calls a constant function contain the function's address explicitly.
7559 This option results in less efficient code, but some strange hacks
7560 that alter the assembler output may be confused by the optimizations
7561 performed when this option is not used.
7563 The default is @option{-ffunction-cse}
7565 @item -fno-zero-initialized-in-bss
7566 @opindex fno-zero-initialized-in-bss
7567 If the target supports a BSS section, GCC by default puts variables that
7568 are initialized to zero into BSS@.  This can save space in the resulting
7569 code.
7571 This option turns off this behavior because some programs explicitly
7572 rely on variables going to the data section---e.g., so that the
7573 resulting executable can find the beginning of that section and/or make
7574 assumptions based on that.
7576 The default is @option{-fzero-initialized-in-bss}.
7578 @item -fthread-jumps
7579 @opindex fthread-jumps
7580 Perform optimizations that check to see if a jump branches to a
7581 location where another comparison subsumed by the first is found.  If
7582 so, the first branch is redirected to either the destination of the
7583 second branch or a point immediately following it, depending on whether
7584 the condition is known to be true or false.
7586 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7588 @item -fsplit-wide-types
7589 @opindex fsplit-wide-types
7590 When using a type that occupies multiple registers, such as @code{long
7591 long} on a 32-bit system, split the registers apart and allocate them
7592 independently.  This normally generates better code for those types,
7593 but may make debugging more difficult.
7595 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7596 @option{-Os}.
7598 @item -fcse-follow-jumps
7599 @opindex fcse-follow-jumps
7600 In common subexpression elimination (CSE), scan through jump instructions
7601 when the target of the jump is not reached by any other path.  For
7602 example, when CSE encounters an @code{if} statement with an
7603 @code{else} clause, CSE follows the jump when the condition
7604 tested is false.
7606 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7608 @item -fcse-skip-blocks
7609 @opindex fcse-skip-blocks
7610 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7611 follow jumps that conditionally skip over blocks.  When CSE
7612 encounters a simple @code{if} statement with no else clause,
7613 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7614 body of the @code{if}.
7616 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7618 @item -frerun-cse-after-loop
7619 @opindex frerun-cse-after-loop
7620 Re-run common subexpression elimination after loop optimizations are
7621 performed.
7623 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7625 @item -fgcse
7626 @opindex fgcse
7627 Perform a global common subexpression elimination pass.
7628 This pass also performs global constant and copy propagation.
7630 @emph{Note:} When compiling a program using computed gotos, a GCC
7631 extension, you may get better run-time performance if you disable
7632 the global common subexpression elimination pass by adding
7633 @option{-fno-gcse} to the command line.
7635 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7637 @item -fgcse-lm
7638 @opindex fgcse-lm
7639 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7640 attempts to move loads that are only killed by stores into themselves.  This
7641 allows a loop containing a load/store sequence to be changed to a load outside
7642 the loop, and a copy/store within the loop.
7644 Enabled by default when @option{-fgcse} is enabled.
7646 @item -fgcse-sm
7647 @opindex fgcse-sm
7648 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7649 global common subexpression elimination.  This pass attempts to move
7650 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7651 loops containing a load/store sequence can be changed to a load before
7652 the loop and a store after the loop.
7654 Not enabled at any optimization level.
7656 @item -fgcse-las
7657 @opindex fgcse-las
7658 When @option{-fgcse-las} is enabled, the global common subexpression
7659 elimination pass eliminates redundant loads that come after stores to the
7660 same memory location (both partial and full redundancies).
7662 Not enabled at any optimization level.
7664 @item -fgcse-after-reload
7665 @opindex fgcse-after-reload
7666 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7667 pass is performed after reload.  The purpose of this pass is to clean up
7668 redundant spilling.
7670 @item -faggressive-loop-optimizations
7671 @opindex faggressive-loop-optimizations
7672 This option tells the loop optimizer to use language constraints to
7673 derive bounds for the number of iterations of a loop.  This assumes that
7674 loop code does not invoke undefined behavior by for example causing signed
7675 integer overflows or out-of-bound array accesses.  The bounds for the
7676 number of iterations of a loop are used to guide loop unrolling and peeling
7677 and loop exit test optimizations.
7678 This option is enabled by default.
7680 @item -funconstrained-commons
7681 @opindex funconstrained-commons
7682 This option tells the compiler that variables declared in common blocks
7683 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7684 prevents certain optimizations that depend on knowing the array bounds.
7686 @item -fcrossjumping
7687 @opindex fcrossjumping
7688 Perform cross-jumping transformation.
7689 This transformation unifies equivalent code and saves code size.  The
7690 resulting code may or may not perform better than without cross-jumping.
7692 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7694 @item -fauto-inc-dec
7695 @opindex fauto-inc-dec
7696 Combine increments or decrements of addresses with memory accesses.
7697 This pass is always skipped on architectures that do not have
7698 instructions to support this.  Enabled by default at @option{-O} and
7699 higher on architectures that support this.
7701 @item -fdce
7702 @opindex fdce
7703 Perform dead code elimination (DCE) on RTL@.
7704 Enabled by default at @option{-O} and higher.
7706 @item -fdse
7707 @opindex fdse
7708 Perform dead store elimination (DSE) on RTL@.
7709 Enabled by default at @option{-O} and higher.
7711 @item -fif-conversion
7712 @opindex fif-conversion
7713 Attempt to transform conditional jumps into branch-less equivalents.  This
7714 includes use of conditional moves, min, max, set flags and abs instructions, and
7715 some tricks doable by standard arithmetics.  The use of conditional execution
7716 on chips where it is available is controlled by @option{-fif-conversion2}.
7718 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7720 @item -fif-conversion2
7721 @opindex fif-conversion2
7722 Use conditional execution (where available) to transform conditional jumps into
7723 branch-less equivalents.
7725 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7727 @item -fdeclone-ctor-dtor
7728 @opindex fdeclone-ctor-dtor
7729 The C++ ABI requires multiple entry points for constructors and
7730 destructors: one for a base subobject, one for a complete object, and
7731 one for a virtual destructor that calls operator delete afterwards.
7732 For a hierarchy with virtual bases, the base and complete variants are
7733 clones, which means two copies of the function.  With this option, the
7734 base and complete variants are changed to be thunks that call a common
7735 implementation.
7737 Enabled by @option{-Os}.
7739 @item -fdelete-null-pointer-checks
7740 @opindex fdelete-null-pointer-checks
7741 Assume that programs cannot safely dereference null pointers, and that
7742 no code or data element resides at address zero.
7743 This option enables simple constant
7744 folding optimizations at all optimization levels.  In addition, other
7745 optimization passes in GCC use this flag to control global dataflow
7746 analyses that eliminate useless checks for null pointers; these assume
7747 that a memory access to address zero always results in a trap, so
7748 that if a pointer is checked after it has already been dereferenced,
7749 it cannot be null.
7751 Note however that in some environments this assumption is not true.
7752 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7753 for programs that depend on that behavior.
7755 This option is enabled by default on most targets.  On Nios II ELF, it
7756 defaults to off.  On AVR and CR16, this option is completely disabled.  
7758 Passes that use the dataflow information
7759 are enabled independently at different optimization levels.
7761 @item -fdevirtualize
7762 @opindex fdevirtualize
7763 Attempt to convert calls to virtual functions to direct calls.  This
7764 is done both within a procedure and interprocedurally as part of
7765 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7766 propagation (@option{-fipa-cp}).
7767 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7769 @item -fdevirtualize-speculatively
7770 @opindex fdevirtualize-speculatively
7771 Attempt to convert calls to virtual functions to speculative direct calls.
7772 Based on the analysis of the type inheritance graph, determine for a given call
7773 the set of likely targets. If the set is small, preferably of size 1, change
7774 the call into a conditional deciding between direct and indirect calls.  The
7775 speculative calls enable more optimizations, such as inlining.  When they seem
7776 useless after further optimization, they are converted back into original form.
7778 @item -fdevirtualize-at-ltrans
7779 @opindex fdevirtualize-at-ltrans
7780 Stream extra information needed for aggressive devirtualization when running
7781 the link-time optimizer in local transformation mode.  
7782 This option enables more devirtualization but
7783 significantly increases the size of streamed data. For this reason it is
7784 disabled by default.
7786 @item -fexpensive-optimizations
7787 @opindex fexpensive-optimizations
7788 Perform a number of minor optimizations that are relatively expensive.
7790 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7792 @item -free
7793 @opindex free
7794 Attempt to remove redundant extension instructions.  This is especially
7795 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7796 registers after writing to their lower 32-bit half.
7798 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7799 @option{-O3}, @option{-Os}.
7801 @item -fno-lifetime-dse
7802 @opindex fno-lifetime-dse
7803 In C++ the value of an object is only affected by changes within its
7804 lifetime: when the constructor begins, the object has an indeterminate
7805 value, and any changes during the lifetime of the object are dead when
7806 the object is destroyed.  Normally dead store elimination will take
7807 advantage of this; if your code relies on the value of the object
7808 storage persisting beyond the lifetime of the object, you can use this
7809 flag to disable this optimization.  To preserve stores before the
7810 constructor starts (e.g. because your operator new clears the object
7811 storage) but still treat the object as dead after the destructor you,
7812 can use @option{-flifetime-dse=1}.  The default behavior can be
7813 explicitly selected with @option{-flifetime-dse=2}.
7814 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7816 @item -flive-range-shrinkage
7817 @opindex flive-range-shrinkage
7818 Attempt to decrease register pressure through register live range
7819 shrinkage.  This is helpful for fast processors with small or moderate
7820 size register sets.
7822 @item -fira-algorithm=@var{algorithm}
7823 @opindex fira-algorithm
7824 Use the specified coloring algorithm for the integrated register
7825 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7826 specifies Chow's priority coloring, or @samp{CB}, which specifies
7827 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7828 for all architectures, but for those targets that do support it, it is
7829 the default because it generates better code.
7831 @item -fira-region=@var{region}
7832 @opindex fira-region
7833 Use specified regions for the integrated register allocator.  The
7834 @var{region} argument should be one of the following:
7836 @table @samp
7838 @item all
7839 Use all loops as register allocation regions.
7840 This can give the best results for machines with a small and/or
7841 irregular register set.
7843 @item mixed
7844 Use all loops except for loops with small register pressure 
7845 as the regions.  This value usually gives
7846 the best results in most cases and for most architectures,
7847 and is enabled by default when compiling with optimization for speed
7848 (@option{-O}, @option{-O2}, @dots{}).
7850 @item one
7851 Use all functions as a single region.  
7852 This typically results in the smallest code size, and is enabled by default for
7853 @option{-Os} or @option{-O0}.
7855 @end table
7857 @item -fira-hoist-pressure
7858 @opindex fira-hoist-pressure
7859 Use IRA to evaluate register pressure in the code hoisting pass for
7860 decisions to hoist expressions.  This option usually results in smaller
7861 code, but it can slow the compiler down.
7863 This option is enabled at level @option{-Os} for all targets.
7865 @item -fira-loop-pressure
7866 @opindex fira-loop-pressure
7867 Use IRA to evaluate register pressure in loops for decisions to move
7868 loop invariants.  This option usually results in generation
7869 of faster and smaller code on machines with large register files (>= 32
7870 registers), but it can slow the compiler down.
7872 This option is enabled at level @option{-O3} for some targets.
7874 @item -fno-ira-share-save-slots
7875 @opindex fno-ira-share-save-slots
7876 Disable sharing of stack slots used for saving call-used hard
7877 registers living through a call.  Each hard register gets a
7878 separate stack slot, and as a result function stack frames are
7879 larger.
7881 @item -fno-ira-share-spill-slots
7882 @opindex fno-ira-share-spill-slots
7883 Disable sharing of stack slots allocated for pseudo-registers.  Each
7884 pseudo-register that does not get a hard register gets a separate
7885 stack slot, and as a result function stack frames are larger.
7887 @item -flra-remat
7888 @opindex flra-remat
7889 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7890 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7891 values if it is profitable.
7893 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7895 @item -fdelayed-branch
7896 @opindex fdelayed-branch
7897 If supported for the target machine, attempt to reorder instructions
7898 to exploit instruction slots available after delayed branch
7899 instructions.
7901 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7903 @item -fschedule-insns
7904 @opindex fschedule-insns
7905 If supported for the target machine, attempt to reorder instructions to
7906 eliminate execution stalls due to required data being unavailable.  This
7907 helps machines that have slow floating point or memory load instructions
7908 by allowing other instructions to be issued until the result of the load
7909 or floating-point instruction is required.
7911 Enabled at levels @option{-O2}, @option{-O3}.
7913 @item -fschedule-insns2
7914 @opindex fschedule-insns2
7915 Similar to @option{-fschedule-insns}, but requests an additional pass of
7916 instruction scheduling after register allocation has been done.  This is
7917 especially useful on machines with a relatively small number of
7918 registers and where memory load instructions take more than one cycle.
7920 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7922 @item -fno-sched-interblock
7923 @opindex fno-sched-interblock
7924 Don't schedule instructions across basic blocks.  This is normally
7925 enabled by default when scheduling before register allocation, i.e.@:
7926 with @option{-fschedule-insns} or at @option{-O2} or higher.
7928 @item -fno-sched-spec
7929 @opindex fno-sched-spec
7930 Don't allow speculative motion of non-load instructions.  This is normally
7931 enabled by default when scheduling before register allocation, i.e.@:
7932 with @option{-fschedule-insns} or at @option{-O2} or higher.
7934 @item -fsched-pressure
7935 @opindex fsched-pressure
7936 Enable register pressure sensitive insn scheduling before register
7937 allocation.  This only makes sense when scheduling before register
7938 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7939 @option{-O2} or higher.  Usage of this option can improve the
7940 generated code and decrease its size by preventing register pressure
7941 increase above the number of available hard registers and subsequent
7942 spills in register allocation.
7944 @item -fsched-spec-load
7945 @opindex fsched-spec-load
7946 Allow speculative motion of some load instructions.  This only makes
7947 sense when scheduling before register allocation, i.e.@: with
7948 @option{-fschedule-insns} or at @option{-O2} or higher.
7950 @item -fsched-spec-load-dangerous
7951 @opindex fsched-spec-load-dangerous
7952 Allow speculative motion of more load instructions.  This only makes
7953 sense when scheduling before register allocation, i.e.@: with
7954 @option{-fschedule-insns} or at @option{-O2} or higher.
7956 @item -fsched-stalled-insns
7957 @itemx -fsched-stalled-insns=@var{n}
7958 @opindex fsched-stalled-insns
7959 Define how many insns (if any) can be moved prematurely from the queue
7960 of stalled insns into the ready list during the second scheduling pass.
7961 @option{-fno-sched-stalled-insns} means that no insns are moved
7962 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7963 on how many queued insns can be moved prematurely.
7964 @option{-fsched-stalled-insns} without a value is equivalent to
7965 @option{-fsched-stalled-insns=1}.
7967 @item -fsched-stalled-insns-dep
7968 @itemx -fsched-stalled-insns-dep=@var{n}
7969 @opindex fsched-stalled-insns-dep
7970 Define how many insn groups (cycles) are examined for a dependency
7971 on a stalled insn that is a candidate for premature removal from the queue
7972 of stalled insns.  This has an effect only during the second scheduling pass,
7973 and only if @option{-fsched-stalled-insns} is used.
7974 @option{-fno-sched-stalled-insns-dep} is equivalent to
7975 @option{-fsched-stalled-insns-dep=0}.
7976 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7977 @option{-fsched-stalled-insns-dep=1}.
7979 @item -fsched2-use-superblocks
7980 @opindex fsched2-use-superblocks
7981 When scheduling after register allocation, use superblock scheduling.
7982 This allows motion across basic block boundaries,
7983 resulting in faster schedules.  This option is experimental, as not all machine
7984 descriptions used by GCC model the CPU closely enough to avoid unreliable
7985 results from the algorithm.
7987 This only makes sense when scheduling after register allocation, i.e.@: with
7988 @option{-fschedule-insns2} or at @option{-O2} or higher.
7990 @item -fsched-group-heuristic
7991 @opindex fsched-group-heuristic
7992 Enable the group heuristic in the scheduler.  This heuristic favors
7993 the instruction that belongs to a schedule group.  This is enabled
7994 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7995 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7997 @item -fsched-critical-path-heuristic
7998 @opindex fsched-critical-path-heuristic
7999 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8000 instructions on the critical path.  This is enabled by default when
8001 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8002 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8004 @item -fsched-spec-insn-heuristic
8005 @opindex fsched-spec-insn-heuristic
8006 Enable the speculative instruction heuristic in the scheduler.  This
8007 heuristic favors speculative instructions with greater dependency weakness.
8008 This is enabled by default when scheduling is enabled, i.e.@:
8009 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8010 or at @option{-O2} or higher.
8012 @item -fsched-rank-heuristic
8013 @opindex fsched-rank-heuristic
8014 Enable the rank heuristic in the scheduler.  This heuristic favors
8015 the instruction belonging to a basic block with greater size or frequency.
8016 This is enabled by default when scheduling is enabled, i.e.@:
8017 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8018 at @option{-O2} or higher.
8020 @item -fsched-last-insn-heuristic
8021 @opindex fsched-last-insn-heuristic
8022 Enable the last-instruction heuristic in the scheduler.  This heuristic
8023 favors the instruction that is less dependent on the last instruction
8024 scheduled.  This is enabled by default when scheduling is enabled,
8025 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8026 at @option{-O2} or higher.
8028 @item -fsched-dep-count-heuristic
8029 @opindex fsched-dep-count-heuristic
8030 Enable the dependent-count heuristic in the scheduler.  This heuristic
8031 favors the instruction that has more instructions depending on it.
8032 This is enabled by default when scheduling is enabled, i.e.@:
8033 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8034 at @option{-O2} or higher.
8036 @item -freschedule-modulo-scheduled-loops
8037 @opindex freschedule-modulo-scheduled-loops
8038 Modulo scheduling is performed before traditional scheduling.  If a loop
8039 is modulo scheduled, later scheduling passes may change its schedule.  
8040 Use this option to control that behavior.
8042 @item -fselective-scheduling
8043 @opindex fselective-scheduling
8044 Schedule instructions using selective scheduling algorithm.  Selective
8045 scheduling runs instead of the first scheduler pass.
8047 @item -fselective-scheduling2
8048 @opindex fselective-scheduling2
8049 Schedule instructions using selective scheduling algorithm.  Selective
8050 scheduling runs instead of the second scheduler pass.
8052 @item -fsel-sched-pipelining
8053 @opindex fsel-sched-pipelining
8054 Enable software pipelining of innermost loops during selective scheduling.
8055 This option has no effect unless one of @option{-fselective-scheduling} or
8056 @option{-fselective-scheduling2} is turned on.
8058 @item -fsel-sched-pipelining-outer-loops
8059 @opindex fsel-sched-pipelining-outer-loops
8060 When pipelining loops during selective scheduling, also pipeline outer loops.
8061 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8063 @item -fsemantic-interposition
8064 @opindex fsemantic-interposition
8065 Some object formats, like ELF, allow interposing of symbols by the 
8066 dynamic linker.
8067 This means that for symbols exported from the DSO, the compiler cannot perform
8068 interprocedural propagation, inlining and other optimizations in anticipation
8069 that the function or variable in question may change. While this feature is
8070 useful, for example, to rewrite memory allocation functions by a debugging
8071 implementation, it is expensive in the terms of code quality.
8072 With @option{-fno-semantic-interposition} the compiler assumes that 
8073 if interposition happens for functions the overwriting function will have 
8074 precisely the same semantics (and side effects). 
8075 Similarly if interposition happens
8076 for variables, the constructor of the variable will be the same. The flag
8077 has no effect for functions explicitly declared inline 
8078 (where it is never allowed for interposition to change semantics) 
8079 and for symbols explicitly declared weak.
8081 @item -fshrink-wrap
8082 @opindex fshrink-wrap
8083 Emit function prologues only before parts of the function that need it,
8084 rather than at the top of the function.  This flag is enabled by default at
8085 @option{-O} and higher.
8087 @item -fshrink-wrap-separate
8088 @opindex fshrink-wrap-separate
8089 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8090 those parts are only executed when needed.
8091 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8092 is also turned on and the target supports this.
8094 @item -fcaller-saves
8095 @opindex fcaller-saves
8096 Enable allocation of values to registers that are clobbered by
8097 function calls, by emitting extra instructions to save and restore the
8098 registers around such calls.  Such allocation is done only when it
8099 seems to result in better code.
8101 This option is always enabled by default on certain machines, usually
8102 those which have no call-preserved registers to use instead.
8104 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8106 @item -fcombine-stack-adjustments
8107 @opindex fcombine-stack-adjustments
8108 Tracks stack adjustments (pushes and pops) and stack memory references
8109 and then tries to find ways to combine them.
8111 Enabled by default at @option{-O1} and higher.
8113 @item -fipa-ra
8114 @opindex fipa-ra
8115 Use caller save registers for allocation if those registers are not used by
8116 any called function.  In that case it is not necessary to save and restore
8117 them around calls.  This is only possible if called functions are part of
8118 same compilation unit as current function and they are compiled before it.
8120 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8121 is disabled if generated code will be instrumented for profiling
8122 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8123 exactly (this happens on targets that do not expose prologues
8124 and epilogues in RTL).
8126 @item -fconserve-stack
8127 @opindex fconserve-stack
8128 Attempt to minimize stack usage.  The compiler attempts to use less
8129 stack space, even if that makes the program slower.  This option
8130 implies setting the @option{large-stack-frame} parameter to 100
8131 and the @option{large-stack-frame-growth} parameter to 400.
8133 @item -ftree-reassoc
8134 @opindex ftree-reassoc
8135 Perform reassociation on trees.  This flag is enabled by default
8136 at @option{-O} and higher.
8138 @item -fcode-hoisting
8139 @opindex fcode-hoisting
8140 Perform code hoisting.  Code hoisting tries to move the
8141 evaluation of expressions executed on all paths to the function exit
8142 as early as possible.  This is especially useful as a code size
8143 optimization, but it often helps for code speed as well.
8144 This flag is enabled by default at @option{-O2} and higher.
8146 @item -ftree-pre
8147 @opindex ftree-pre
8148 Perform partial redundancy elimination (PRE) on trees.  This flag is
8149 enabled by default at @option{-O2} and @option{-O3}.
8151 @item -ftree-partial-pre
8152 @opindex ftree-partial-pre
8153 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8154 enabled by default at @option{-O3}.
8156 @item -ftree-forwprop
8157 @opindex ftree-forwprop
8158 Perform forward propagation on trees.  This flag is enabled by default
8159 at @option{-O} and higher.
8161 @item -ftree-fre
8162 @opindex ftree-fre
8163 Perform full redundancy elimination (FRE) on trees.  The difference
8164 between FRE and PRE is that FRE only considers expressions
8165 that are computed on all paths leading to the redundant computation.
8166 This analysis is faster than PRE, though it exposes fewer redundancies.
8167 This flag is enabled by default at @option{-O} and higher.
8169 @item -ftree-phiprop
8170 @opindex ftree-phiprop
8171 Perform hoisting of loads from conditional pointers on trees.  This
8172 pass is enabled by default at @option{-O} and higher.
8174 @item -fhoist-adjacent-loads
8175 @opindex fhoist-adjacent-loads
8176 Speculatively hoist loads from both branches of an if-then-else if the
8177 loads are from adjacent locations in the same structure and the target
8178 architecture has a conditional move instruction.  This flag is enabled
8179 by default at @option{-O2} and higher.
8181 @item -ftree-copy-prop
8182 @opindex ftree-copy-prop
8183 Perform copy propagation on trees.  This pass eliminates unnecessary
8184 copy operations.  This flag is enabled by default at @option{-O} and
8185 higher.
8187 @item -fipa-pure-const
8188 @opindex fipa-pure-const
8189 Discover which functions are pure or constant.
8190 Enabled by default at @option{-O} and higher.
8192 @item -fipa-reference
8193 @opindex fipa-reference
8194 Discover which static variables do not escape the
8195 compilation unit.
8196 Enabled by default at @option{-O} and higher.
8198 @item -fipa-pta
8199 @opindex fipa-pta
8200 Perform interprocedural pointer analysis and interprocedural modification
8201 and reference analysis.  This option can cause excessive memory and
8202 compile-time usage on large compilation units.  It is not enabled by
8203 default at any optimization level.
8205 @item -fipa-profile
8206 @opindex fipa-profile
8207 Perform interprocedural profile propagation.  The functions called only from
8208 cold functions are marked as cold. Also functions executed once (such as
8209 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8210 functions and loop less parts of functions executed once are then optimized for
8211 size.
8212 Enabled by default at @option{-O} and higher.
8214 @item -fipa-cp
8215 @opindex fipa-cp
8216 Perform interprocedural constant propagation.
8217 This optimization analyzes the program to determine when values passed
8218 to functions are constants and then optimizes accordingly.
8219 This optimization can substantially increase performance
8220 if the application has constants passed to functions.
8221 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8223 @item -fipa-cp-clone
8224 @opindex fipa-cp-clone
8225 Perform function cloning to make interprocedural constant propagation stronger.
8226 When enabled, interprocedural constant propagation performs function cloning
8227 when externally visible function can be called with constant arguments.
8228 Because this optimization can create multiple copies of functions,
8229 it may significantly increase code size
8230 (see @option{--param ipcp-unit-growth=@var{value}}).
8231 This flag is enabled by default at @option{-O3}.
8233 @item -fipa-bit-cp
8234 @opindex -fipa-bit-cp
8235 When enabled, perform interprocedural bitwise constant
8236 propagation. This flag is enabled by default at @option{-O2}. It
8237 requires that @option{-fipa-cp} is enabled.
8239 @item -fipa-vrp
8240 @opindex -fipa-vrp
8241 When enabled, perform interprocedural propagation of value
8242 ranges. This flag is enabled by default at @option{-O2}. It requires
8243 that @option{-fipa-cp} is enabled.
8245 @item -fipa-icf
8246 @opindex fipa-icf
8247 Perform Identical Code Folding for functions and read-only variables.
8248 The optimization reduces code size and may disturb unwind stacks by replacing
8249 a function by equivalent one with a different name. The optimization works
8250 more effectively with link-time optimization enabled.
8252 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8253 works on different levels and thus the optimizations are not same - there are
8254 equivalences that are found only by GCC and equivalences found only by Gold.
8256 This flag is enabled by default at @option{-O2} and @option{-Os}.
8258 @item -fisolate-erroneous-paths-dereference
8259 @opindex fisolate-erroneous-paths-dereference
8260 Detect paths that trigger erroneous or undefined behavior due to
8261 dereferencing a null pointer.  Isolate those paths from the main control
8262 flow and turn the statement with erroneous or undefined behavior into a trap.
8263 This flag is enabled by default at @option{-O2} and higher and depends on
8264 @option{-fdelete-null-pointer-checks} also being enabled.
8266 @item -fisolate-erroneous-paths-attribute
8267 @opindex fisolate-erroneous-paths-attribute
8268 Detect paths that trigger erroneous or undefined behavior due a null value
8269 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8270 attribute.  Isolate those paths from the main control flow and turn the
8271 statement with erroneous or undefined behavior into a trap.  This is not
8272 currently enabled, but may be enabled by @option{-O2} in the future.
8274 @item -ftree-sink
8275 @opindex ftree-sink
8276 Perform forward store motion on trees.  This flag is
8277 enabled by default at @option{-O} and higher.
8279 @item -ftree-bit-ccp
8280 @opindex ftree-bit-ccp
8281 Perform sparse conditional bit constant propagation on trees and propagate
8282 pointer alignment information.
8283 This pass only operates on local scalar variables and is enabled by default
8284 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8286 @item -ftree-ccp
8287 @opindex ftree-ccp
8288 Perform sparse conditional constant propagation (CCP) on trees.  This
8289 pass only operates on local scalar variables and is enabled by default
8290 at @option{-O} and higher.
8292 @item -fssa-backprop
8293 @opindex fssa-backprop
8294 Propagate information about uses of a value up the definition chain
8295 in order to simplify the definitions.  For example, this pass strips
8296 sign operations if the sign of a value never matters.  The flag is
8297 enabled by default at @option{-O} and higher.
8299 @item -fssa-phiopt
8300 @opindex fssa-phiopt
8301 Perform pattern matching on SSA PHI nodes to optimize conditional
8302 code.  This pass is enabled by default at @option{-O} and higher.
8304 @item -ftree-switch-conversion
8305 @opindex ftree-switch-conversion
8306 Perform conversion of simple initializations in a switch to
8307 initializations from a scalar array.  This flag is enabled by default
8308 at @option{-O2} and higher.
8310 @item -ftree-tail-merge
8311 @opindex ftree-tail-merge
8312 Look for identical code sequences.  When found, replace one with a jump to the
8313 other.  This optimization is known as tail merging or cross jumping.  This flag
8314 is enabled by default at @option{-O2} and higher.  The compilation time
8315 in this pass can
8316 be limited using @option{max-tail-merge-comparisons} parameter and
8317 @option{max-tail-merge-iterations} parameter.
8319 @item -ftree-dce
8320 @opindex ftree-dce
8321 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8322 default at @option{-O} and higher.
8324 @item -ftree-builtin-call-dce
8325 @opindex ftree-builtin-call-dce
8326 Perform conditional dead code elimination (DCE) for calls to built-in functions
8327 that may set @code{errno} but are otherwise side-effect free.  This flag is
8328 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8329 specified.
8331 @item -ftree-dominator-opts
8332 @opindex ftree-dominator-opts
8333 Perform a variety of simple scalar cleanups (constant/copy
8334 propagation, redundancy elimination, range propagation and expression
8335 simplification) based on a dominator tree traversal.  This also
8336 performs jump threading (to reduce jumps to jumps). This flag is
8337 enabled by default at @option{-O} and higher.
8339 @item -ftree-dse
8340 @opindex ftree-dse
8341 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8342 a memory location that is later overwritten by another store without
8343 any intervening loads.  In this case the earlier store can be deleted.  This
8344 flag is enabled by default at @option{-O} and higher.
8346 @item -ftree-ch
8347 @opindex ftree-ch
8348 Perform loop header copying on trees.  This is beneficial since it increases
8349 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8350 is enabled by default at @option{-O} and higher.  It is not enabled
8351 for @option{-Os}, since it usually increases code size.
8353 @item -ftree-loop-optimize
8354 @opindex ftree-loop-optimize
8355 Perform loop optimizations on trees.  This flag is enabled by default
8356 at @option{-O} and higher.
8358 @item -ftree-loop-linear
8359 @itemx -floop-interchange
8360 @itemx -floop-strip-mine
8361 @itemx -floop-block
8362 @itemx -floop-unroll-and-jam
8363 @opindex ftree-loop-linear
8364 @opindex floop-interchange
8365 @opindex floop-strip-mine
8366 @opindex floop-block
8367 @opindex floop-unroll-and-jam
8368 Perform loop nest optimizations.  Same as
8369 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8370 to be configured with @option{--with-isl} to enable the Graphite loop
8371 transformation infrastructure.
8373 @item -fgraphite-identity
8374 @opindex fgraphite-identity
8375 Enable the identity transformation for graphite.  For every SCoP we generate
8376 the polyhedral representation and transform it back to gimple.  Using
8377 @option{-fgraphite-identity} we can check the costs or benefits of the
8378 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8379 are also performed by the code generator isl, like index splitting and
8380 dead code elimination in loops.
8382 @item -floop-nest-optimize
8383 @opindex floop-nest-optimize
8384 Enable the isl based loop nest optimizer.  This is a generic loop nest
8385 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8386 structure optimized for data-locality and parallelism.  This option
8387 is experimental.
8389 @item -floop-parallelize-all
8390 @opindex floop-parallelize-all
8391 Use the Graphite data dependence analysis to identify loops that can
8392 be parallelized.  Parallelize all the loops that can be analyzed to
8393 not contain loop carried dependences without checking that it is
8394 profitable to parallelize the loops.
8396 @item -ftree-coalesce-vars
8397 @opindex ftree-coalesce-vars
8398 While transforming the program out of the SSA representation, attempt to
8399 reduce copying by coalescing versions of different user-defined
8400 variables, instead of just compiler temporaries.  This may severely
8401 limit the ability to debug an optimized program compiled with
8402 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8403 prevents SSA coalescing of user variables.  This option is enabled by
8404 default if optimization is enabled, and it does very little otherwise.
8406 @item -ftree-loop-if-convert
8407 @opindex ftree-loop-if-convert
8408 Attempt to transform conditional jumps in the innermost loops to
8409 branch-less equivalents.  The intent is to remove control-flow from
8410 the innermost loops in order to improve the ability of the
8411 vectorization pass to handle these loops.  This is enabled by default
8412 if vectorization is enabled.
8414 @item -ftree-loop-distribution
8415 @opindex ftree-loop-distribution
8416 Perform loop distribution.  This flag can improve cache performance on
8417 big loop bodies and allow further loop optimizations, like
8418 parallelization or vectorization, to take place.  For example, the loop
8419 @smallexample
8420 DO I = 1, N
8421   A(I) = B(I) + C
8422   D(I) = E(I) * F
8423 ENDDO
8424 @end smallexample
8425 is transformed to
8426 @smallexample
8427 DO I = 1, N
8428    A(I) = B(I) + C
8429 ENDDO
8430 DO I = 1, N
8431    D(I) = E(I) * F
8432 ENDDO
8433 @end smallexample
8435 @item -ftree-loop-distribute-patterns
8436 @opindex ftree-loop-distribute-patterns
8437 Perform loop distribution of patterns that can be code generated with
8438 calls to a library.  This flag is enabled by default at @option{-O3}.
8440 This pass distributes the initialization loops and generates a call to
8441 memset zero.  For example, the loop
8442 @smallexample
8443 DO I = 1, N
8444   A(I) = 0
8445   B(I) = A(I) + I
8446 ENDDO
8447 @end smallexample
8448 is transformed to
8449 @smallexample
8450 DO I = 1, N
8451    A(I) = 0
8452 ENDDO
8453 DO I = 1, N
8454    B(I) = A(I) + I
8455 ENDDO
8456 @end smallexample
8457 and the initialization loop is transformed into a call to memset zero.
8459 @item -ftree-loop-im
8460 @opindex ftree-loop-im
8461 Perform loop invariant motion on trees.  This pass moves only invariants that
8462 are hard to handle at RTL level (function calls, operations that expand to
8463 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8464 operands of conditions that are invariant out of the loop, so that we can use
8465 just trivial invariantness analysis in loop unswitching.  The pass also includes
8466 store motion.
8468 @item -ftree-loop-ivcanon
8469 @opindex ftree-loop-ivcanon
8470 Create a canonical counter for number of iterations in loops for which
8471 determining number of iterations requires complicated analysis.  Later
8472 optimizations then may determine the number easily.  Useful especially
8473 in connection with unrolling.
8475 @item -fivopts
8476 @opindex fivopts
8477 Perform induction variable optimizations (strength reduction, induction
8478 variable merging and induction variable elimination) on trees.
8480 @item -ftree-parallelize-loops=n
8481 @opindex ftree-parallelize-loops
8482 Parallelize loops, i.e., split their iteration space to run in n threads.
8483 This is only possible for loops whose iterations are independent
8484 and can be arbitrarily reordered.  The optimization is only
8485 profitable on multiprocessor machines, for loops that are CPU-intensive,
8486 rather than constrained e.g.@: by memory bandwidth.  This option
8487 implies @option{-pthread}, and thus is only supported on targets
8488 that have support for @option{-pthread}.
8490 @item -ftree-pta
8491 @opindex ftree-pta
8492 Perform function-local points-to analysis on trees.  This flag is
8493 enabled by default at @option{-O} and higher.
8495 @item -ftree-sra
8496 @opindex ftree-sra
8497 Perform scalar replacement of aggregates.  This pass replaces structure
8498 references with scalars to prevent committing structures to memory too
8499 early.  This flag is enabled by default at @option{-O} and higher.
8501 @item -fstore-merging
8502 @opindex fstore-merging
8503 Perform merging of narrow stores to consecutive memory addresses.  This pass
8504 merges contiguous stores of immediate values narrower than a word into fewer
8505 wider stores to reduce the number of instructions.  This is enabled by default
8506 at @option{-O2} and higher as well as @option{-Os}.
8508 @item -ftree-ter
8509 @opindex ftree-ter
8510 Perform temporary expression replacement during the SSA->normal phase.  Single
8511 use/single def temporaries are replaced at their use location with their
8512 defining expression.  This results in non-GIMPLE code, but gives the expanders
8513 much more complex trees to work on resulting in better RTL generation.  This is
8514 enabled by default at @option{-O} and higher.
8516 @item -ftree-slsr
8517 @opindex ftree-slsr
8518 Perform straight-line strength reduction on trees.  This recognizes related
8519 expressions involving multiplications and replaces them by less expensive
8520 calculations when possible.  This is enabled by default at @option{-O} and
8521 higher.
8523 @item -ftree-vectorize
8524 @opindex ftree-vectorize
8525 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8526 and @option{-ftree-slp-vectorize} if not explicitly specified.
8528 @item -ftree-loop-vectorize
8529 @opindex ftree-loop-vectorize
8530 Perform loop vectorization on trees. This flag is enabled by default at
8531 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8533 @item -ftree-slp-vectorize
8534 @opindex ftree-slp-vectorize
8535 Perform basic block vectorization on trees. This flag is enabled by default at
8536 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8538 @item -fvect-cost-model=@var{model}
8539 @opindex fvect-cost-model
8540 Alter the cost model used for vectorization.  The @var{model} argument
8541 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8542 With the @samp{unlimited} model the vectorized code-path is assumed
8543 to be profitable while with the @samp{dynamic} model a runtime check
8544 guards the vectorized code-path to enable it only for iteration
8545 counts that will likely execute faster than when executing the original
8546 scalar loop.  The @samp{cheap} model disables vectorization of
8547 loops where doing so would be cost prohibitive for example due to
8548 required runtime checks for data dependence or alignment but otherwise
8549 is equal to the @samp{dynamic} model.
8550 The default cost model depends on other optimization flags and is
8551 either @samp{dynamic} or @samp{cheap}.
8553 @item -fsimd-cost-model=@var{model}
8554 @opindex fsimd-cost-model
8555 Alter the cost model used for vectorization of loops marked with the OpenMP
8556 or Cilk Plus simd directive.  The @var{model} argument should be one of
8557 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8558 have the same meaning as described in @option{-fvect-cost-model} and by
8559 default a cost model defined with @option{-fvect-cost-model} is used.
8561 @item -ftree-vrp
8562 @opindex ftree-vrp
8563 Perform Value Range Propagation on trees.  This is similar to the
8564 constant propagation pass, but instead of values, ranges of values are
8565 propagated.  This allows the optimizers to remove unnecessary range
8566 checks like array bound checks and null pointer checks.  This is
8567 enabled by default at @option{-O2} and higher.  Null pointer check
8568 elimination is only done if @option{-fdelete-null-pointer-checks} is
8569 enabled.
8571 @item -fsplit-paths
8572 @opindex fsplit-paths
8573 Split paths leading to loop backedges.  This can improve dead code
8574 elimination and common subexpression elimination.  This is enabled by
8575 default at @option{-O2} and above.
8577 @item -fsplit-ivs-in-unroller
8578 @opindex fsplit-ivs-in-unroller
8579 Enables expression of values of induction variables in later iterations
8580 of the unrolled loop using the value in the first iteration.  This breaks
8581 long dependency chains, thus improving efficiency of the scheduling passes.
8583 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8584 same effect.  However, that is not reliable in cases where the loop body
8585 is more complicated than a single basic block.  It also does not work at all
8586 on some architectures due to restrictions in the CSE pass.
8588 This optimization is enabled by default.
8590 @item -fvariable-expansion-in-unroller
8591 @opindex fvariable-expansion-in-unroller
8592 With this option, the compiler creates multiple copies of some
8593 local variables when unrolling a loop, which can result in superior code.
8595 @item -fpartial-inlining
8596 @opindex fpartial-inlining
8597 Inline parts of functions.  This option has any effect only
8598 when inlining itself is turned on by the @option{-finline-functions}
8599 or @option{-finline-small-functions} options.
8601 Enabled at level @option{-O2}.
8603 @item -fpredictive-commoning
8604 @opindex fpredictive-commoning
8605 Perform predictive commoning optimization, i.e., reusing computations
8606 (especially memory loads and stores) performed in previous
8607 iterations of loops.
8609 This option is enabled at level @option{-O3}.
8611 @item -fprefetch-loop-arrays
8612 @opindex fprefetch-loop-arrays
8613 If supported by the target machine, generate instructions to prefetch
8614 memory to improve the performance of loops that access large arrays.
8616 This option may generate better or worse code; results are highly
8617 dependent on the structure of loops within the source code.
8619 Disabled at level @option{-Os}.
8621 @item -fno-printf-return-value
8622 @opindex fno-printf-return-value
8623 Do not substitute constants for known return value of formatted output
8624 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8625 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8626 transformation allows GCC to optimize or even eliminate branches based
8627 on the known return value of these functions called with arguments that
8628 are either constant, or whose values are known to be in a range that
8629 makes determining the exact return value possible.  For example, when
8630 @option{-fprintf-return-value} is in effect, both the branch and the
8631 body of the @code{if} statement (but not the call to @code{snprint})
8632 can be optimized away when @code{i} is a 32-bit or smaller integer
8633 because the return value is guaranteed to be at most 8.
8635 @smallexample
8636 char buf[9];
8637 if (snprintf (buf, "%08x", i) >= sizeof buf)
8638   @dots{}
8639 @end smallexample
8641 The @option{-fprintf-return-value} option relies on other optimizations
8642 and yields best results with @option{-O2}.  It works in tandem with the
8643 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8644 The @option{-fprintf-return-value} option is enabled by default.
8646 @item -fno-peephole
8647 @itemx -fno-peephole2
8648 @opindex fno-peephole
8649 @opindex fno-peephole2
8650 Disable any machine-specific peephole optimizations.  The difference
8651 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8652 are implemented in the compiler; some targets use one, some use the
8653 other, a few use both.
8655 @option{-fpeephole} is enabled by default.
8656 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8658 @item -fno-guess-branch-probability
8659 @opindex fno-guess-branch-probability
8660 Do not guess branch probabilities using heuristics.
8662 GCC uses heuristics to guess branch probabilities if they are
8663 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8664 heuristics are based on the control flow graph.  If some branch probabilities
8665 are specified by @code{__builtin_expect}, then the heuristics are
8666 used to guess branch probabilities for the rest of the control flow graph,
8667 taking the @code{__builtin_expect} info into account.  The interactions
8668 between the heuristics and @code{__builtin_expect} can be complex, and in
8669 some cases, it may be useful to disable the heuristics so that the effects
8670 of @code{__builtin_expect} are easier to understand.
8672 The default is @option{-fguess-branch-probability} at levels
8673 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8675 @item -freorder-blocks
8676 @opindex freorder-blocks
8677 Reorder basic blocks in the compiled function in order to reduce number of
8678 taken branches and improve code locality.
8680 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8682 @item -freorder-blocks-algorithm=@var{algorithm}
8683 @opindex freorder-blocks-algorithm
8684 Use the specified algorithm for basic block reordering.  The
8685 @var{algorithm} argument can be @samp{simple}, which does not increase
8686 code size (except sometimes due to secondary effects like alignment),
8687 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8688 put all often executed code together, minimizing the number of branches
8689 executed by making extra copies of code.
8691 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8692 @samp{stc} at levels @option{-O2}, @option{-O3}.
8694 @item -freorder-blocks-and-partition
8695 @opindex freorder-blocks-and-partition
8696 In addition to reordering basic blocks in the compiled function, in order
8697 to reduce number of taken branches, partitions hot and cold basic blocks
8698 into separate sections of the assembly and @file{.o} files, to improve
8699 paging and cache locality performance.
8701 This optimization is automatically turned off in the presence of
8702 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8703 section attribute and on any architecture that does not support named
8704 sections.  When @option{-fsplit-stack} is used this option is not
8705 enabled by default (to avoid linker errors), but may be enabled
8706 explicitly (if using a working linker).
8708 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8710 @item -freorder-functions
8711 @opindex freorder-functions
8712 Reorder functions in the object file in order to
8713 improve code locality.  This is implemented by using special
8714 subsections @code{.text.hot} for most frequently executed functions and
8715 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8716 the linker so object file format must support named sections and linker must
8717 place them in a reasonable way.
8719 Also profile feedback must be available to make this option effective.  See
8720 @option{-fprofile-arcs} for details.
8722 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8724 @item -fstrict-aliasing
8725 @opindex fstrict-aliasing
8726 Allow the compiler to assume the strictest aliasing rules applicable to
8727 the language being compiled.  For C (and C++), this activates
8728 optimizations based on the type of expressions.  In particular, an
8729 object of one type is assumed never to reside at the same address as an
8730 object of a different type, unless the types are almost the same.  For
8731 example, an @code{unsigned int} can alias an @code{int}, but not a
8732 @code{void*} or a @code{double}.  A character type may alias any other
8733 type.
8735 @anchor{Type-punning}Pay special attention to code like this:
8736 @smallexample
8737 union a_union @{
8738   int i;
8739   double d;
8742 int f() @{
8743   union a_union t;
8744   t.d = 3.0;
8745   return t.i;
8747 @end smallexample
8748 The practice of reading from a different union member than the one most
8749 recently written to (called ``type-punning'') is common.  Even with
8750 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8751 is accessed through the union type.  So, the code above works as
8752 expected.  @xref{Structures unions enumerations and bit-fields
8753 implementation}.  However, this code might not:
8754 @smallexample
8755 int f() @{
8756   union a_union t;
8757   int* ip;
8758   t.d = 3.0;
8759   ip = &t.i;
8760   return *ip;
8762 @end smallexample
8764 Similarly, access by taking the address, casting the resulting pointer
8765 and dereferencing the result has undefined behavior, even if the cast
8766 uses a union type, e.g.:
8767 @smallexample
8768 int f() @{
8769   double d = 3.0;
8770   return ((union a_union *) &d)->i;
8772 @end smallexample
8774 The @option{-fstrict-aliasing} option is enabled at levels
8775 @option{-O2}, @option{-O3}, @option{-Os}.
8777 @item -falign-functions
8778 @itemx -falign-functions=@var{n}
8779 @opindex falign-functions
8780 Align the start of functions to the next power-of-two greater than
8781 @var{n}, skipping up to @var{n} bytes.  For instance,
8782 @option{-falign-functions=32} aligns functions to the next 32-byte
8783 boundary, but @option{-falign-functions=24} aligns to the next
8784 32-byte boundary only if this can be done by skipping 23 bytes or less.
8786 @option{-fno-align-functions} and @option{-falign-functions=1} are
8787 equivalent and mean that functions are not aligned.
8789 Some assemblers only support this flag when @var{n} is a power of two;
8790 in that case, it is rounded up.
8792 If @var{n} is not specified or is zero, use a machine-dependent default.
8794 Enabled at levels @option{-O2}, @option{-O3}.
8796 @item -flimit-function-alignment
8797 If this option is enabled, the compiler tries to avoid unnecessarily
8798 overaligning functions. It attempts to instruct the assembler to align
8799 by the amount specified by @option{-falign-functions}, but not to
8800 skip more bytes than the size of the function.
8802 @item -falign-labels
8803 @itemx -falign-labels=@var{n}
8804 @opindex falign-labels
8805 Align all branch targets to a power-of-two boundary, skipping up to
8806 @var{n} bytes like @option{-falign-functions}.  This option can easily
8807 make code slower, because it must insert dummy operations for when the
8808 branch target is reached in the usual flow of the code.
8810 @option{-fno-align-labels} and @option{-falign-labels=1} are
8811 equivalent and mean that labels are not aligned.
8813 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8814 are greater than this value, then their values are used instead.
8816 If @var{n} is not specified or is zero, use a machine-dependent default
8817 which is very likely to be @samp{1}, meaning no alignment.
8819 Enabled at levels @option{-O2}, @option{-O3}.
8821 @item -falign-loops
8822 @itemx -falign-loops=@var{n}
8823 @opindex falign-loops
8824 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8825 like @option{-falign-functions}.  If the loops are
8826 executed many times, this makes up for any execution of the dummy
8827 operations.
8829 @option{-fno-align-loops} and @option{-falign-loops=1} are
8830 equivalent and mean that loops are not aligned.
8832 If @var{n} is not specified or is zero, use a machine-dependent default.
8834 Enabled at levels @option{-O2}, @option{-O3}.
8836 @item -falign-jumps
8837 @itemx -falign-jumps=@var{n}
8838 @opindex falign-jumps
8839 Align branch targets to a power-of-two boundary, for branch targets
8840 where the targets can only be reached by jumping, skipping up to @var{n}
8841 bytes like @option{-falign-functions}.  In this case, no dummy operations
8842 need be executed.
8844 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8845 equivalent and mean that loops are not aligned.
8847 If @var{n} is not specified or is zero, use a machine-dependent default.
8849 Enabled at levels @option{-O2}, @option{-O3}.
8851 @item -funit-at-a-time
8852 @opindex funit-at-a-time
8853 This option is left for compatibility reasons. @option{-funit-at-a-time}
8854 has no effect, while @option{-fno-unit-at-a-time} implies
8855 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8857 Enabled by default.
8859 @item -fno-toplevel-reorder
8860 @opindex fno-toplevel-reorder
8861 Do not reorder top-level functions, variables, and @code{asm}
8862 statements.  Output them in the same order that they appear in the
8863 input file.  When this option is used, unreferenced static variables
8864 are not removed.  This option is intended to support existing code
8865 that relies on a particular ordering.  For new code, it is better to
8866 use attributes when possible.
8868 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8869 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8870 targets.
8872 @item -fweb
8873 @opindex fweb
8874 Constructs webs as commonly used for register allocation purposes and assign
8875 each web individual pseudo register.  This allows the register allocation pass
8876 to operate on pseudos directly, but also strengthens several other optimization
8877 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8878 however, make debugging impossible, since variables no longer stay in a
8879 ``home register''.
8881 Enabled by default with @option{-funroll-loops}.
8883 @item -fwhole-program
8884 @opindex fwhole-program
8885 Assume that the current compilation unit represents the whole program being
8886 compiled.  All public functions and variables with the exception of @code{main}
8887 and those merged by attribute @code{externally_visible} become static functions
8888 and in effect are optimized more aggressively by interprocedural optimizers.
8890 This option should not be used in combination with @option{-flto}.
8891 Instead relying on a linker plugin should provide safer and more precise
8892 information.
8894 @item -flto[=@var{n}]
8895 @opindex flto
8896 This option runs the standard link-time optimizer.  When invoked
8897 with source code, it generates GIMPLE (one of GCC's internal
8898 representations) and writes it to special ELF sections in the object
8899 file.  When the object files are linked together, all the function
8900 bodies are read from these ELF sections and instantiated as if they
8901 had been part of the same translation unit.
8903 To use the link-time optimizer, @option{-flto} and optimization
8904 options should be specified at compile time and during the final link.
8905 It is recommended that you compile all the files participating in the
8906 same link with the same options and also specify those options at
8907 link time.  
8908 For example:
8910 @smallexample
8911 gcc -c -O2 -flto foo.c
8912 gcc -c -O2 -flto bar.c
8913 gcc -o myprog -flto -O2 foo.o bar.o
8914 @end smallexample
8916 The first two invocations to GCC save a bytecode representation
8917 of GIMPLE into special ELF sections inside @file{foo.o} and
8918 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8919 @file{foo.o} and @file{bar.o}, merges the two files into a single
8920 internal image, and compiles the result as usual.  Since both
8921 @file{foo.o} and @file{bar.o} are merged into a single image, this
8922 causes all the interprocedural analyses and optimizations in GCC to
8923 work across the two files as if they were a single one.  This means,
8924 for example, that the inliner is able to inline functions in
8925 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8927 Another (simpler) way to enable link-time optimization is:
8929 @smallexample
8930 gcc -o myprog -flto -O2 foo.c bar.c
8931 @end smallexample
8933 The above generates bytecode for @file{foo.c} and @file{bar.c},
8934 merges them together into a single GIMPLE representation and optimizes
8935 them as usual to produce @file{myprog}.
8937 The only important thing to keep in mind is that to enable link-time
8938 optimizations you need to use the GCC driver to perform the link step.
8939 GCC then automatically performs link-time optimization if any of the
8940 objects involved were compiled with the @option{-flto} command-line option.  
8941 You generally
8942 should specify the optimization options to be used for link-time
8943 optimization though GCC tries to be clever at guessing an
8944 optimization level to use from the options used at compile time
8945 if you fail to specify one at link time.  You can always override
8946 the automatic decision to do link-time optimization
8947 by passing @option{-fno-lto} to the link command.
8949 To make whole program optimization effective, it is necessary to make
8950 certain whole program assumptions.  The compiler needs to know
8951 what functions and variables can be accessed by libraries and runtime
8952 outside of the link-time optimized unit.  When supported by the linker,
8953 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8954 to the compiler about used and externally visible symbols.  When
8955 the linker plugin is not available, @option{-fwhole-program} should be
8956 used to allow the compiler to make these assumptions, which leads
8957 to more aggressive optimization decisions.
8959 When @option{-fuse-linker-plugin} is not enabled, when a file is
8960 compiled with @option{-flto}, the generated object file is larger than
8961 a regular object file because it contains GIMPLE bytecodes and the usual
8962 final code (see @option{-ffat-lto-objects}.  This means that
8963 object files with LTO information can be linked as normal object
8964 files; if @option{-fno-lto} is passed to the linker, no
8965 interprocedural optimizations are applied.  Note that when
8966 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8967 but you cannot perform a regular, non-LTO link on them.
8969 Additionally, the optimization flags used to compile individual files
8970 are not necessarily related to those used at link time.  For instance,
8972 @smallexample
8973 gcc -c -O0 -ffat-lto-objects -flto foo.c
8974 gcc -c -O0 -ffat-lto-objects -flto bar.c
8975 gcc -o myprog -O3 foo.o bar.o
8976 @end smallexample
8978 This produces individual object files with unoptimized assembler
8979 code, but the resulting binary @file{myprog} is optimized at
8980 @option{-O3}.  If, instead, the final binary is generated with
8981 @option{-fno-lto}, then @file{myprog} is not optimized.
8983 When producing the final binary, GCC only
8984 applies link-time optimizations to those files that contain bytecode.
8985 Therefore, you can mix and match object files and libraries with
8986 GIMPLE bytecodes and final object code.  GCC automatically selects
8987 which files to optimize in LTO mode and which files to link without
8988 further processing.
8990 There are some code generation flags preserved by GCC when
8991 generating bytecodes, as they need to be used during the final link
8992 stage.  Generally options specified at link time override those
8993 specified at compile time.
8995 If you do not specify an optimization level option @option{-O} at
8996 link time, then GCC uses the highest optimization level 
8997 used when compiling the object files.
8999 Currently, the following options and their settings are taken from
9000 the first object file that explicitly specifies them: 
9001 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9002 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9003 and all the @option{-m} target flags.
9005 Certain ABI-changing flags are required to match in all compilation units,
9006 and trying to override this at link time with a conflicting value
9007 is ignored.  This includes options such as @option{-freg-struct-return}
9008 and @option{-fpcc-struct-return}. 
9010 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9011 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9012 are passed through to the link stage and merged conservatively for
9013 conflicting translation units.  Specifically
9014 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9015 precedence; and for example @option{-ffp-contract=off} takes precedence
9016 over @option{-ffp-contract=fast}.  You can override them at link time.
9018 If LTO encounters objects with C linkage declared with incompatible
9019 types in separate translation units to be linked together (undefined
9020 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9021 issued.  The behavior is still undefined at run time.  Similar
9022 diagnostics may be raised for other languages.
9024 Another feature of LTO is that it is possible to apply interprocedural
9025 optimizations on files written in different languages:
9027 @smallexample
9028 gcc -c -flto foo.c
9029 g++ -c -flto bar.cc
9030 gfortran -c -flto baz.f90
9031 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9032 @end smallexample
9034 Notice that the final link is done with @command{g++} to get the C++
9035 runtime libraries and @option{-lgfortran} is added to get the Fortran
9036 runtime libraries.  In general, when mixing languages in LTO mode, you
9037 should use the same link command options as when mixing languages in a
9038 regular (non-LTO) compilation.
9040 If object files containing GIMPLE bytecode are stored in a library archive, say
9041 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9042 are using a linker with plugin support.  To create static libraries suitable
9043 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9044 and @command{ranlib}; 
9045 to show the symbols of object files with GIMPLE bytecode, use
9046 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9047 and @command{nm} have been compiled with plugin support.  At link time, use the the
9048 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9049 the LTO optimization process:
9051 @smallexample
9052 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9053 @end smallexample
9055 With the linker plugin enabled, the linker extracts the needed
9056 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9057 to make them part of the aggregated GIMPLE image to be optimized.
9059 If you are not using a linker with plugin support and/or do not
9060 enable the linker plugin, then the objects inside @file{libfoo.a}
9061 are extracted and linked as usual, but they do not participate
9062 in the LTO optimization process.  In order to make a static library suitable
9063 for both LTO optimization and usual linkage, compile its object files with
9064 @option{-flto} @option{-ffat-lto-objects}.
9066 Link-time optimizations do not require the presence of the whole program to
9067 operate.  If the program does not require any symbols to be exported, it is
9068 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9069 the interprocedural optimizers to use more aggressive assumptions which may
9070 lead to improved optimization opportunities.
9071 Use of @option{-fwhole-program} is not needed when linker plugin is
9072 active (see @option{-fuse-linker-plugin}).
9074 The current implementation of LTO makes no
9075 attempt to generate bytecode that is portable between different
9076 types of hosts.  The bytecode files are versioned and there is a
9077 strict version check, so bytecode files generated in one version of
9078 GCC do not work with an older or newer version of GCC.
9080 Link-time optimization does not work well with generation of debugging
9081 information.  Combining @option{-flto} with
9082 @option{-g} is currently experimental and expected to produce unexpected
9083 results.
9085 If you specify the optional @var{n}, the optimization and code
9086 generation done at link time is executed in parallel using @var{n}
9087 parallel jobs by utilizing an installed @command{make} program.  The
9088 environment variable @env{MAKE} may be used to override the program
9089 used.  The default value for @var{n} is 1.
9091 You can also specify @option{-flto=jobserver} to use GNU make's
9092 job server mode to determine the number of parallel jobs. This
9093 is useful when the Makefile calling GCC is already executing in parallel.
9094 You must prepend a @samp{+} to the command recipe in the parent Makefile
9095 for this to work.  This option likely only works if @env{MAKE} is
9096 GNU make.
9098 @item -flto-partition=@var{alg}
9099 @opindex flto-partition
9100 Specify the partitioning algorithm used by the link-time optimizer.
9101 The value is either @samp{1to1} to specify a partitioning mirroring
9102 the original source files or @samp{balanced} to specify partitioning
9103 into equally sized chunks (whenever possible) or @samp{max} to create
9104 new partition for every symbol where possible.  Specifying @samp{none}
9105 as an algorithm disables partitioning and streaming completely. 
9106 The default value is @samp{balanced}. While @samp{1to1} can be used
9107 as an workaround for various code ordering issues, the @samp{max}
9108 partitioning is intended for internal testing only.
9109 The value @samp{one} specifies that exactly one partition should be
9110 used while the value @samp{none} bypasses partitioning and executes
9111 the link-time optimization step directly from the WPA phase.
9113 @item -flto-odr-type-merging
9114 @opindex flto-odr-type-merging
9115 Enable streaming of mangled types names of C++ types and their unification
9116 at link time.  This increases size of LTO object files, but enables
9117 diagnostics about One Definition Rule violations.
9119 @item -flto-compression-level=@var{n}
9120 @opindex flto-compression-level
9121 This option specifies the level of compression used for intermediate
9122 language written to LTO object files, and is only meaningful in
9123 conjunction with LTO mode (@option{-flto}).  Valid
9124 values are 0 (no compression) to 9 (maximum compression).  Values
9125 outside this range are clamped to either 0 or 9.  If the option is not
9126 given, a default balanced compression setting is used.
9128 @item -fuse-linker-plugin
9129 @opindex fuse-linker-plugin
9130 Enables the use of a linker plugin during link-time optimization.  This
9131 option relies on plugin support in the linker, which is available in gold
9132 or in GNU ld 2.21 or newer.
9134 This option enables the extraction of object files with GIMPLE bytecode out
9135 of library archives. This improves the quality of optimization by exposing
9136 more code to the link-time optimizer.  This information specifies what
9137 symbols can be accessed externally (by non-LTO object or during dynamic
9138 linking).  Resulting code quality improvements on binaries (and shared
9139 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9140 See @option{-flto} for a description of the effect of this flag and how to
9141 use it.
9143 This option is enabled by default when LTO support in GCC is enabled
9144 and GCC was configured for use with
9145 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9147 @item -ffat-lto-objects
9148 @opindex ffat-lto-objects
9149 Fat LTO objects are object files that contain both the intermediate language
9150 and the object code. This makes them usable for both LTO linking and normal
9151 linking. This option is effective only when compiling with @option{-flto}
9152 and is ignored at link time.
9154 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9155 requires the complete toolchain to be aware of LTO. It requires a linker with
9156 linker plugin support for basic functionality.  Additionally,
9157 @command{nm}, @command{ar} and @command{ranlib}
9158 need to support linker plugins to allow a full-featured build environment
9159 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9160 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9161 to these tools. With non fat LTO makefiles need to be modified to use them.
9163 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9164 support.
9166 @item -fcompare-elim
9167 @opindex fcompare-elim
9168 After register allocation and post-register allocation instruction splitting,
9169 identify arithmetic instructions that compute processor flags similar to a
9170 comparison operation based on that arithmetic.  If possible, eliminate the
9171 explicit comparison operation.
9173 This pass only applies to certain targets that cannot explicitly represent
9174 the comparison operation before register allocation is complete.
9176 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9178 @item -fcprop-registers
9179 @opindex fcprop-registers
9180 After register allocation and post-register allocation instruction splitting,
9181 perform a copy-propagation pass to try to reduce scheduling dependencies
9182 and occasionally eliminate the copy.
9184 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9186 @item -fprofile-correction
9187 @opindex fprofile-correction
9188 Profiles collected using an instrumented binary for multi-threaded programs may
9189 be inconsistent due to missed counter updates. When this option is specified,
9190 GCC uses heuristics to correct or smooth out such inconsistencies. By
9191 default, GCC emits an error message when an inconsistent profile is detected.
9193 @item -fprofile-use
9194 @itemx -fprofile-use=@var{path}
9195 @opindex fprofile-use
9196 Enable profile feedback-directed optimizations, 
9197 and the following optimizations
9198 which are generally profitable only with profile feedback available:
9199 @option{-fbranch-probabilities}, @option{-fvpt},
9200 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9201 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9203 Before you can use this option, you must first generate profiling information.
9204 @xref{Instrumentation Options}, for information about the
9205 @option{-fprofile-generate} option.
9207 By default, GCC emits an error message if the feedback profiles do not
9208 match the source code.  This error can be turned into a warning by using
9209 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9210 code.
9212 If @var{path} is specified, GCC looks at the @var{path} to find
9213 the profile feedback data files. See @option{-fprofile-dir}.
9215 @item -fauto-profile
9216 @itemx -fauto-profile=@var{path}
9217 @opindex fauto-profile
9218 Enable sampling-based feedback-directed optimizations, 
9219 and the following optimizations
9220 which are generally profitable only with profile feedback available:
9221 @option{-fbranch-probabilities}, @option{-fvpt},
9222 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9223 @option{-ftree-vectorize},
9224 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9225 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9226 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9228 @var{path} is the name of a file containing AutoFDO profile information.
9229 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9231 Producing an AutoFDO profile data file requires running your program
9232 with the @command{perf} utility on a supported GNU/Linux target system.
9233 For more information, see @uref{https://perf.wiki.kernel.org/}.
9235 E.g.
9236 @smallexample
9237 perf record -e br_inst_retired:near_taken -b -o perf.data \
9238     -- your_program
9239 @end smallexample
9241 Then use the @command{create_gcov} tool to convert the raw profile data
9242 to a format that can be used by GCC.@  You must also supply the 
9243 unstripped binary for your program to this tool.  
9244 See @uref{https://github.com/google/autofdo}.
9246 E.g.
9247 @smallexample
9248 create_gcov --binary=your_program.unstripped --profile=perf.data \
9249     --gcov=profile.afdo
9250 @end smallexample
9251 @end table
9253 The following options control compiler behavior regarding floating-point 
9254 arithmetic.  These options trade off between speed and
9255 correctness.  All must be specifically enabled.
9257 @table @gcctabopt
9258 @item -ffloat-store
9259 @opindex ffloat-store
9260 Do not store floating-point variables in registers, and inhibit other
9261 options that might change whether a floating-point value is taken from a
9262 register or memory.
9264 @cindex floating-point precision
9265 This option prevents undesirable excess precision on machines such as
9266 the 68000 where the floating registers (of the 68881) keep more
9267 precision than a @code{double} is supposed to have.  Similarly for the
9268 x86 architecture.  For most programs, the excess precision does only
9269 good, but a few programs rely on the precise definition of IEEE floating
9270 point.  Use @option{-ffloat-store} for such programs, after modifying
9271 them to store all pertinent intermediate computations into variables.
9273 @item -fexcess-precision=@var{style}
9274 @opindex fexcess-precision
9275 This option allows further control over excess precision on machines
9276 where floating-point operations occur in a format with more precision or
9277 range than the IEEE standard and interchange floating-point types.  By
9278 default, @option{-fexcess-precision=fast} is in effect; this means that
9279 operations may be carried out in a wider precision than the types specified
9280 in the source if that would result in faster code, and it is unpredictable
9281 when rounding to the types specified in the source code takes place.
9282 When compiling C, if @option{-fexcess-precision=standard} is specified then
9283 excess precision follows the rules specified in ISO C99; in particular,
9284 both casts and assignments cause values to be rounded to their
9285 semantic types (whereas @option{-ffloat-store} only affects
9286 assignments).  This option is enabled by default for C if a strict
9287 conformance option such as @option{-std=c99} is used.
9288 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9289 regardless of whether a strict conformance option is used.
9291 @opindex mfpmath
9292 @option{-fexcess-precision=standard} is not implemented for languages
9293 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9294 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9295 semantics apply without excess precision, and in the latter, rounding
9296 is unpredictable.
9298 @item -ffast-math
9299 @opindex ffast-math
9300 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9301 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9302 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9303 @option{-fexcess-precision=fast}.
9305 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9307 This option is not turned on by any @option{-O} option besides
9308 @option{-Ofast} since it can result in incorrect output for programs
9309 that depend on an exact implementation of IEEE or ISO rules/specifications
9310 for math functions. It may, however, yield faster code for programs
9311 that do not require the guarantees of these specifications.
9313 @item -fno-math-errno
9314 @opindex fno-math-errno
9315 Do not set @code{errno} after calling math functions that are executed
9316 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9317 IEEE exceptions for math error handling may want to use this flag
9318 for speed while maintaining IEEE arithmetic compatibility.
9320 This option is not turned on by any @option{-O} option since
9321 it can result in incorrect output for programs that depend on
9322 an exact implementation of IEEE or ISO rules/specifications for
9323 math functions. It may, however, yield faster code for programs
9324 that do not require the guarantees of these specifications.
9326 The default is @option{-fmath-errno}.
9328 On Darwin systems, the math library never sets @code{errno}.  There is
9329 therefore no reason for the compiler to consider the possibility that
9330 it might, and @option{-fno-math-errno} is the default.
9332 @item -funsafe-math-optimizations
9333 @opindex funsafe-math-optimizations
9335 Allow optimizations for floating-point arithmetic that (a) assume
9336 that arguments and results are valid and (b) may violate IEEE or
9337 ANSI standards.  When used at link time, it may include libraries
9338 or startup files that change the default FPU control word or other
9339 similar optimizations.
9341 This option is not turned on by any @option{-O} option since
9342 it can result in incorrect output for programs that depend on
9343 an exact implementation of IEEE or ISO rules/specifications for
9344 math functions. It may, however, yield faster code for programs
9345 that do not require the guarantees of these specifications.
9346 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9347 @option{-fassociative-math} and @option{-freciprocal-math}.
9349 The default is @option{-fno-unsafe-math-optimizations}.
9351 @item -fassociative-math
9352 @opindex fassociative-math
9354 Allow re-association of operands in series of floating-point operations.
9355 This violates the ISO C and C++ language standard by possibly changing
9356 computation result.  NOTE: re-ordering may change the sign of zero as
9357 well as ignore NaNs and inhibit or create underflow or overflow (and
9358 thus cannot be used on code that relies on rounding behavior like
9359 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9360 and thus may not be used when ordered comparisons are required.
9361 This option requires that both @option{-fno-signed-zeros} and
9362 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9363 much sense with @option{-frounding-math}. For Fortran the option
9364 is automatically enabled when both @option{-fno-signed-zeros} and
9365 @option{-fno-trapping-math} are in effect.
9367 The default is @option{-fno-associative-math}.
9369 @item -freciprocal-math
9370 @opindex freciprocal-math
9372 Allow the reciprocal of a value to be used instead of dividing by
9373 the value if this enables optimizations.  For example @code{x / y}
9374 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9375 is subject to common subexpression elimination.  Note that this loses
9376 precision and increases the number of flops operating on the value.
9378 The default is @option{-fno-reciprocal-math}.
9380 @item -ffinite-math-only
9381 @opindex ffinite-math-only
9382 Allow optimizations for floating-point arithmetic that assume
9383 that arguments and results are not NaNs or +-Infs.
9385 This option is not turned on by any @option{-O} option since
9386 it can result in incorrect output for programs that depend on
9387 an exact implementation of IEEE or ISO rules/specifications for
9388 math functions. It may, however, yield faster code for programs
9389 that do not require the guarantees of these specifications.
9391 The default is @option{-fno-finite-math-only}.
9393 @item -fno-signed-zeros
9394 @opindex fno-signed-zeros
9395 Allow optimizations for floating-point arithmetic that ignore the
9396 signedness of zero.  IEEE arithmetic specifies the behavior of
9397 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9398 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9399 This option implies that the sign of a zero result isn't significant.
9401 The default is @option{-fsigned-zeros}.
9403 @item -fno-trapping-math
9404 @opindex fno-trapping-math
9405 Compile code assuming that floating-point operations cannot generate
9406 user-visible traps.  These traps include division by zero, overflow,
9407 underflow, inexact result and invalid operation.  This option requires
9408 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9409 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9411 This option should never be turned on by any @option{-O} option since
9412 it can result in incorrect output for programs that depend on
9413 an exact implementation of IEEE or ISO rules/specifications for
9414 math functions.
9416 The default is @option{-ftrapping-math}.
9418 @item -frounding-math
9419 @opindex frounding-math
9420 Disable transformations and optimizations that assume default floating-point
9421 rounding behavior.  This is round-to-zero for all floating point
9422 to integer conversions, and round-to-nearest for all other arithmetic
9423 truncations.  This option should be specified for programs that change
9424 the FP rounding mode dynamically, or that may be executed with a
9425 non-default rounding mode.  This option disables constant folding of
9426 floating-point expressions at compile time (which may be affected by
9427 rounding mode) and arithmetic transformations that are unsafe in the
9428 presence of sign-dependent rounding modes.
9430 The default is @option{-fno-rounding-math}.
9432 This option is experimental and does not currently guarantee to
9433 disable all GCC optimizations that are affected by rounding mode.
9434 Future versions of GCC may provide finer control of this setting
9435 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9436 will be used to specify the default state for @code{FENV_ACCESS}.
9438 @item -fsignaling-nans
9439 @opindex fsignaling-nans
9440 Compile code assuming that IEEE signaling NaNs may generate user-visible
9441 traps during floating-point operations.  Setting this option disables
9442 optimizations that may change the number of exceptions visible with
9443 signaling NaNs.  This option implies @option{-ftrapping-math}.
9445 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9446 be defined.
9448 The default is @option{-fno-signaling-nans}.
9450 This option is experimental and does not currently guarantee to
9451 disable all GCC optimizations that affect signaling NaN behavior.
9453 @item -fno-fp-int-builtin-inexact
9454 @opindex fno-fp-int-builtin-inexact
9455 Do not allow the built-in functions @code{ceil}, @code{floor},
9456 @code{round} and @code{trunc}, and their @code{float} and @code{long
9457 double} variants, to generate code that raises the ``inexact''
9458 floating-point exception for noninteger arguments.  ISO C99 and C11
9459 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9460 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9461 functions to do so.
9463 The default is @option{-ffp-int-builtin-inexact}, allowing the
9464 exception to be raised.  This option does nothing unless
9465 @option{-ftrapping-math} is in effect.
9467 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9468 generate a call to a library function then the ``inexact'' exception
9469 may be raised if the library implementation does not follow TS 18661.
9471 @item -fsingle-precision-constant
9472 @opindex fsingle-precision-constant
9473 Treat floating-point constants as single precision instead of
9474 implicitly converting them to double-precision constants.
9476 @item -fcx-limited-range
9477 @opindex fcx-limited-range
9478 When enabled, this option states that a range reduction step is not
9479 needed when performing complex division.  Also, there is no checking
9480 whether the result of a complex multiplication or division is @code{NaN
9481 + I*NaN}, with an attempt to rescue the situation in that case.  The
9482 default is @option{-fno-cx-limited-range}, but is enabled by
9483 @option{-ffast-math}.
9485 This option controls the default setting of the ISO C99
9486 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9487 all languages.
9489 @item -fcx-fortran-rules
9490 @opindex fcx-fortran-rules
9491 Complex multiplication and division follow Fortran rules.  Range
9492 reduction is done as part of complex division, but there is no checking
9493 whether the result of a complex multiplication or division is @code{NaN
9494 + I*NaN}, with an attempt to rescue the situation in that case.
9496 The default is @option{-fno-cx-fortran-rules}.
9498 @end table
9500 The following options control optimizations that may improve
9501 performance, but are not enabled by any @option{-O} options.  This
9502 section includes experimental options that may produce broken code.
9504 @table @gcctabopt
9505 @item -fbranch-probabilities
9506 @opindex fbranch-probabilities
9507 After running a program compiled with @option{-fprofile-arcs}
9508 (@pxref{Instrumentation Options}),
9509 you can compile it a second time using
9510 @option{-fbranch-probabilities}, to improve optimizations based on
9511 the number of times each branch was taken.  When a program
9512 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9513 counts to a file called @file{@var{sourcename}.gcda} for each source
9514 file.  The information in this data file is very dependent on the
9515 structure of the generated code, so you must use the same source code
9516 and the same optimization options for both compilations.
9518 With @option{-fbranch-probabilities}, GCC puts a
9519 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9520 These can be used to improve optimization.  Currently, they are only
9521 used in one place: in @file{reorg.c}, instead of guessing which path a
9522 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9523 exactly determine which path is taken more often.
9525 @item -fprofile-values
9526 @opindex fprofile-values
9527 If combined with @option{-fprofile-arcs}, it adds code so that some
9528 data about values of expressions in the program is gathered.
9530 With @option{-fbranch-probabilities}, it reads back the data gathered
9531 from profiling values of expressions for usage in optimizations.
9533 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9535 @item -fprofile-reorder-functions
9536 @opindex fprofile-reorder-functions
9537 Function reordering based on profile instrumentation collects
9538 first time of execution of a function and orders these functions
9539 in ascending order.
9541 Enabled with @option{-fprofile-use}.
9543 @item -fvpt
9544 @opindex fvpt
9545 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9546 to add code to gather information about values of expressions.
9548 With @option{-fbranch-probabilities}, it reads back the data gathered
9549 and actually performs the optimizations based on them.
9550 Currently the optimizations include specialization of division operations
9551 using the knowledge about the value of the denominator.
9553 @item -frename-registers
9554 @opindex frename-registers
9555 Attempt to avoid false dependencies in scheduled code by making use
9556 of registers left over after register allocation.  This optimization
9557 most benefits processors with lots of registers.  Depending on the
9558 debug information format adopted by the target, however, it can
9559 make debugging impossible, since variables no longer stay in
9560 a ``home register''.
9562 Enabled by default with @option{-funroll-loops}.
9564 @item -fschedule-fusion
9565 @opindex fschedule-fusion
9566 Performs a target dependent pass over the instruction stream to schedule
9567 instructions of same type together because target machine can execute them
9568 more efficiently if they are adjacent to each other in the instruction flow.
9570 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9572 @item -ftracer
9573 @opindex ftracer
9574 Perform tail duplication to enlarge superblock size.  This transformation
9575 simplifies the control flow of the function allowing other optimizations to do
9576 a better job.
9578 Enabled with @option{-fprofile-use}.
9580 @item -funroll-loops
9581 @opindex funroll-loops
9582 Unroll loops whose number of iterations can be determined at compile time or
9583 upon entry to the loop.  @option{-funroll-loops} implies
9584 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9585 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9586 a small constant number of iterations).  This option makes code larger, and may
9587 or may not make it run faster.
9589 Enabled with @option{-fprofile-use}.
9591 @item -funroll-all-loops
9592 @opindex funroll-all-loops
9593 Unroll all loops, even if their number of iterations is uncertain when
9594 the loop is entered.  This usually makes programs run more slowly.
9595 @option{-funroll-all-loops} implies the same options as
9596 @option{-funroll-loops}.
9598 @item -fpeel-loops
9599 @opindex fpeel-loops
9600 Peels loops for which there is enough information that they do not
9601 roll much (from profile feedback or static analysis).  It also turns on
9602 complete loop peeling (i.e.@: complete removal of loops with small constant
9603 number of iterations).
9605 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9607 @item -fmove-loop-invariants
9608 @opindex fmove-loop-invariants
9609 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9610 at level @option{-O1}
9612 @item -fsplit-loops
9613 @opindex fsplit-loops
9614 Split a loop into two if it contains a condition that's always true
9615 for one side of the iteration space and false for the other.
9617 @item -funswitch-loops
9618 @opindex funswitch-loops
9619 Move branches with loop invariant conditions out of the loop, with duplicates
9620 of the loop on both branches (modified according to result of the condition).
9622 @item -ffunction-sections
9623 @itemx -fdata-sections
9624 @opindex ffunction-sections
9625 @opindex fdata-sections
9626 Place each function or data item into its own section in the output
9627 file if the target supports arbitrary sections.  The name of the
9628 function or the name of the data item determines the section's name
9629 in the output file.
9631 Use these options on systems where the linker can perform optimizations
9632 to improve locality of reference in the instruction space.  Most systems
9633 using the ELF object format and SPARC processors running Solaris 2 have
9634 linkers with such optimizations.  AIX may have these optimizations in
9635 the future.
9637 Only use these options when there are significant benefits from doing
9638 so.  When you specify these options, the assembler and linker
9639 create larger object and executable files and are also slower.
9640 You cannot use @command{gprof} on all systems if you
9641 specify this option, and you may have problems with debugging if
9642 you specify both this option and @option{-g}.
9644 @item -fbranch-target-load-optimize
9645 @opindex fbranch-target-load-optimize
9646 Perform branch target register load optimization before prologue / epilogue
9647 threading.
9648 The use of target registers can typically be exposed only during reload,
9649 thus hoisting loads out of loops and doing inter-block scheduling needs
9650 a separate optimization pass.
9652 @item -fbranch-target-load-optimize2
9653 @opindex fbranch-target-load-optimize2
9654 Perform branch target register load optimization after prologue / epilogue
9655 threading.
9657 @item -fbtr-bb-exclusive
9658 @opindex fbtr-bb-exclusive
9659 When performing branch target register load optimization, don't reuse
9660 branch target registers within any basic block.
9662 @item -fstdarg-opt
9663 @opindex fstdarg-opt
9664 Optimize the prologue of variadic argument functions with respect to usage of
9665 those arguments.
9667 @item -fsection-anchors
9668 @opindex fsection-anchors
9669 Try to reduce the number of symbolic address calculations by using
9670 shared ``anchor'' symbols to address nearby objects.  This transformation
9671 can help to reduce the number of GOT entries and GOT accesses on some
9672 targets.
9674 For example, the implementation of the following function @code{foo}:
9676 @smallexample
9677 static int a, b, c;
9678 int foo (void) @{ return a + b + c; @}
9679 @end smallexample
9681 @noindent
9682 usually calculates the addresses of all three variables, but if you
9683 compile it with @option{-fsection-anchors}, it accesses the variables
9684 from a common anchor point instead.  The effect is similar to the
9685 following pseudocode (which isn't valid C):
9687 @smallexample
9688 int foo (void)
9690   register int *xr = &x;
9691   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9693 @end smallexample
9695 Not all targets support this option.
9697 @item --param @var{name}=@var{value}
9698 @opindex param
9699 In some places, GCC uses various constants to control the amount of
9700 optimization that is done.  For example, GCC does not inline functions
9701 that contain more than a certain number of instructions.  You can
9702 control some of these constants on the command line using the
9703 @option{--param} option.
9705 The names of specific parameters, and the meaning of the values, are
9706 tied to the internals of the compiler, and are subject to change
9707 without notice in future releases.
9709 In each case, the @var{value} is an integer.  The allowable choices for
9710 @var{name} are:
9712 @table @gcctabopt
9713 @item predictable-branch-outcome
9714 When branch is predicted to be taken with probability lower than this threshold
9715 (in percent), then it is considered well predictable. The default is 10.
9717 @item max-rtl-if-conversion-insns
9718 RTL if-conversion tries to remove conditional branches around a block and
9719 replace them with conditionally executed instructions.  This parameter
9720 gives the maximum number of instructions in a block which should be
9721 considered for if-conversion.  The default is 10, though the compiler will
9722 also use other heuristics to decide whether if-conversion is likely to be
9723 profitable.
9725 @item max-rtl-if-conversion-predictable-cost
9726 @item max-rtl-if-conversion-unpredictable-cost
9727 RTL if-conversion will try to remove conditional branches around a block
9728 and replace them with conditionally executed instructions.  These parameters
9729 give the maximum permissible cost for the sequence that would be generated
9730 by if-conversion depending on whether the branch is statically determined
9731 to be predictable or not.  The units for this parameter are the same as
9732 those for the GCC internal seq_cost metric.  The compiler will try to
9733 provide a reasonable default for this parameter using the BRANCH_COST
9734 target macro.
9736 @item max-crossjump-edges
9737 The maximum number of incoming edges to consider for cross-jumping.
9738 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9739 the number of edges incoming to each block.  Increasing values mean
9740 more aggressive optimization, making the compilation time increase with
9741 probably small improvement in executable size.
9743 @item min-crossjump-insns
9744 The minimum number of instructions that must be matched at the end
9745 of two blocks before cross-jumping is performed on them.  This
9746 value is ignored in the case where all instructions in the block being
9747 cross-jumped from are matched.  The default value is 5.
9749 @item max-grow-copy-bb-insns
9750 The maximum code size expansion factor when copying basic blocks
9751 instead of jumping.  The expansion is relative to a jump instruction.
9752 The default value is 8.
9754 @item max-goto-duplication-insns
9755 The maximum number of instructions to duplicate to a block that jumps
9756 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9757 passes, GCC factors computed gotos early in the compilation process,
9758 and unfactors them as late as possible.  Only computed jumps at the
9759 end of a basic blocks with no more than max-goto-duplication-insns are
9760 unfactored.  The default value is 8.
9762 @item max-delay-slot-insn-search
9763 The maximum number of instructions to consider when looking for an
9764 instruction to fill a delay slot.  If more than this arbitrary number of
9765 instructions are searched, the time savings from filling the delay slot
9766 are minimal, so stop searching.  Increasing values mean more
9767 aggressive optimization, making the compilation time increase with probably
9768 small improvement in execution time.
9770 @item max-delay-slot-live-search
9771 When trying to fill delay slots, the maximum number of instructions to
9772 consider when searching for a block with valid live register
9773 information.  Increasing this arbitrarily chosen value means more
9774 aggressive optimization, increasing the compilation time.  This parameter
9775 should be removed when the delay slot code is rewritten to maintain the
9776 control-flow graph.
9778 @item max-gcse-memory
9779 The approximate maximum amount of memory that can be allocated in
9780 order to perform the global common subexpression elimination
9781 optimization.  If more memory than specified is required, the
9782 optimization is not done.
9784 @item max-gcse-insertion-ratio
9785 If the ratio of expression insertions to deletions is larger than this value
9786 for any expression, then RTL PRE inserts or removes the expression and thus
9787 leaves partially redundant computations in the instruction stream.  The default value is 20.
9789 @item max-pending-list-length
9790 The maximum number of pending dependencies scheduling allows
9791 before flushing the current state and starting over.  Large functions
9792 with few branches or calls can create excessively large lists which
9793 needlessly consume memory and resources.
9795 @item max-modulo-backtrack-attempts
9796 The maximum number of backtrack attempts the scheduler should make
9797 when modulo scheduling a loop.  Larger values can exponentially increase
9798 compilation time.
9800 @item max-inline-insns-single
9801 Several parameters control the tree inliner used in GCC@.
9802 This number sets the maximum number of instructions (counted in GCC's
9803 internal representation) in a single function that the tree inliner
9804 considers for inlining.  This only affects functions declared
9805 inline and methods implemented in a class declaration (C++).
9806 The default value is 400.
9808 @item max-inline-insns-auto
9809 When you use @option{-finline-functions} (included in @option{-O3}),
9810 a lot of functions that would otherwise not be considered for inlining
9811 by the compiler are investigated.  To those functions, a different
9812 (more restrictive) limit compared to functions declared inline can
9813 be applied.
9814 The default value is 40.
9816 @item inline-min-speedup
9817 When estimated performance improvement of caller + callee runtime exceeds this
9818 threshold (in percent), the function can be inlined regardless of the limit on
9819 @option{--param max-inline-insns-single} and @option{--param
9820 max-inline-insns-auto}.
9822 @item large-function-insns
9823 The limit specifying really large functions.  For functions larger than this
9824 limit after inlining, inlining is constrained by
9825 @option{--param large-function-growth}.  This parameter is useful primarily
9826 to avoid extreme compilation time caused by non-linear algorithms used by the
9827 back end.
9828 The default value is 2700.
9830 @item large-function-growth
9831 Specifies maximal growth of large function caused by inlining in percents.
9832 The default value is 100 which limits large function growth to 2.0 times
9833 the original size.
9835 @item large-unit-insns
9836 The limit specifying large translation unit.  Growth caused by inlining of
9837 units larger than this limit is limited by @option{--param inline-unit-growth}.
9838 For small units this might be too tight.
9839 For example, consider a unit consisting of function A
9840 that is inline and B that just calls A three times.  If B is small relative to
9841 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9842 large units consisting of small inlineable functions, however, the overall unit
9843 growth limit is needed to avoid exponential explosion of code size.  Thus for
9844 smaller units, the size is increased to @option{--param large-unit-insns}
9845 before applying @option{--param inline-unit-growth}.  The default is 10000.
9847 @item inline-unit-growth
9848 Specifies maximal overall growth of the compilation unit caused by inlining.
9849 The default value is 20 which limits unit growth to 1.2 times the original
9850 size. Cold functions (either marked cold via an attribute or by profile
9851 feedback) are not accounted into the unit size.
9853 @item ipcp-unit-growth
9854 Specifies maximal overall growth of the compilation unit caused by
9855 interprocedural constant propagation.  The default value is 10 which limits
9856 unit growth to 1.1 times the original size.
9858 @item large-stack-frame
9859 The limit specifying large stack frames.  While inlining the algorithm is trying
9860 to not grow past this limit too much.  The default value is 256 bytes.
9862 @item large-stack-frame-growth
9863 Specifies maximal growth of large stack frames caused by inlining in percents.
9864 The default value is 1000 which limits large stack frame growth to 11 times
9865 the original size.
9867 @item max-inline-insns-recursive
9868 @itemx max-inline-insns-recursive-auto
9869 Specifies the maximum number of instructions an out-of-line copy of a
9870 self-recursive inline
9871 function can grow into by performing recursive inlining.
9873 @option{--param max-inline-insns-recursive} applies to functions
9874 declared inline.
9875 For functions not declared inline, recursive inlining
9876 happens only when @option{-finline-functions} (included in @option{-O3}) is
9877 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9878 default value is 450.
9880 @item max-inline-recursive-depth
9881 @itemx max-inline-recursive-depth-auto
9882 Specifies the maximum recursion depth used for recursive inlining.
9884 @option{--param max-inline-recursive-depth} applies to functions
9885 declared inline.  For functions not declared inline, recursive inlining
9886 happens only when @option{-finline-functions} (included in @option{-O3}) is
9887 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9888 default value is 8.
9890 @item min-inline-recursive-probability
9891 Recursive inlining is profitable only for function having deep recursion
9892 in average and can hurt for function having little recursion depth by
9893 increasing the prologue size or complexity of function body to other
9894 optimizers.
9896 When profile feedback is available (see @option{-fprofile-generate}) the actual
9897 recursion depth can be guessed from the probability that function recurses
9898 via a given call expression.  This parameter limits inlining only to call
9899 expressions whose probability exceeds the given threshold (in percents).
9900 The default value is 10.
9902 @item early-inlining-insns
9903 Specify growth that the early inliner can make.  In effect it increases
9904 the amount of inlining for code having a large abstraction penalty.
9905 The default value is 14.
9907 @item max-early-inliner-iterations
9908 Limit of iterations of the early inliner.  This basically bounds
9909 the number of nested indirect calls the early inliner can resolve.
9910 Deeper chains are still handled by late inlining.
9912 @item comdat-sharing-probability
9913 Probability (in percent) that C++ inline function with comdat visibility
9914 are shared across multiple compilation units.  The default value is 20.
9916 @item profile-func-internal-id
9917 A parameter to control whether to use function internal id in profile
9918 database lookup. If the value is 0, the compiler uses an id that
9919 is based on function assembler name and filename, which makes old profile
9920 data more tolerant to source changes such as function reordering etc.
9921 The default value is 0.
9923 @item min-vect-loop-bound
9924 The minimum number of iterations under which loops are not vectorized
9925 when @option{-ftree-vectorize} is used.  The number of iterations after
9926 vectorization needs to be greater than the value specified by this option
9927 to allow vectorization.  The default value is 0.
9929 @item gcse-cost-distance-ratio
9930 Scaling factor in calculation of maximum distance an expression
9931 can be moved by GCSE optimizations.  This is currently supported only in the
9932 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9933 is with simple expressions, i.e., the expressions that have cost
9934 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9935 hoisting of simple expressions.  The default value is 10.
9937 @item gcse-unrestricted-cost
9938 Cost, roughly measured as the cost of a single typical machine
9939 instruction, at which GCSE optimizations do not constrain
9940 the distance an expression can travel.  This is currently
9941 supported only in the code hoisting pass.  The lesser the cost,
9942 the more aggressive code hoisting is.  Specifying 0 
9943 allows all expressions to travel unrestricted distances.
9944 The default value is 3.
9946 @item max-hoist-depth
9947 The depth of search in the dominator tree for expressions to hoist.
9948 This is used to avoid quadratic behavior in hoisting algorithm.
9949 The value of 0 does not limit on the search, but may slow down compilation
9950 of huge functions.  The default value is 30.
9952 @item max-tail-merge-comparisons
9953 The maximum amount of similar bbs to compare a bb with.  This is used to
9954 avoid quadratic behavior in tree tail merging.  The default value is 10.
9956 @item max-tail-merge-iterations
9957 The maximum amount of iterations of the pass over the function.  This is used to
9958 limit compilation time in tree tail merging.  The default value is 2.
9960 @item store-merging-allow-unaligned
9961 Allow the store merging pass to introduce unaligned stores if it is legal to
9962 do so.  The default value is 1.
9964 @item max-stores-to-merge
9965 The maximum number of stores to attempt to merge into wider stores in the store
9966 merging pass.  The minimum value is 2 and the default is 64.
9968 @item max-unrolled-insns
9969 The maximum number of instructions that a loop may have to be unrolled.
9970 If a loop is unrolled, this parameter also determines how many times
9971 the loop code is unrolled.
9973 @item max-average-unrolled-insns
9974 The maximum number of instructions biased by probabilities of their execution
9975 that a loop may have to be unrolled.  If a loop is unrolled,
9976 this parameter also determines how many times the loop code is unrolled.
9978 @item max-unroll-times
9979 The maximum number of unrollings of a single loop.
9981 @item max-peeled-insns
9982 The maximum number of instructions that a loop may have to be peeled.
9983 If a loop is peeled, this parameter also determines how many times
9984 the loop code is peeled.
9986 @item max-peel-times
9987 The maximum number of peelings of a single loop.
9989 @item max-peel-branches
9990 The maximum number of branches on the hot path through the peeled sequence.
9992 @item max-completely-peeled-insns
9993 The maximum number of insns of a completely peeled loop.
9995 @item max-completely-peel-times
9996 The maximum number of iterations of a loop to be suitable for complete peeling.
9998 @item max-completely-peel-loop-nest-depth
9999 The maximum depth of a loop nest suitable for complete peeling.
10001 @item max-unswitch-insns
10002 The maximum number of insns of an unswitched loop.
10004 @item max-unswitch-level
10005 The maximum number of branches unswitched in a single loop.
10007 @item max-loop-headers-insns
10008 The maximum number of insns in loop header duplicated by the copy loop headers
10009 pass.
10011 @item lim-expensive
10012 The minimum cost of an expensive expression in the loop invariant motion.
10014 @item iv-consider-all-candidates-bound
10015 Bound on number of candidates for induction variables, below which
10016 all candidates are considered for each use in induction variable
10017 optimizations.  If there are more candidates than this,
10018 only the most relevant ones are considered to avoid quadratic time complexity.
10020 @item iv-max-considered-uses
10021 The induction variable optimizations give up on loops that contain more
10022 induction variable uses.
10024 @item iv-always-prune-cand-set-bound
10025 If the number of candidates in the set is smaller than this value,
10026 always try to remove unnecessary ivs from the set
10027 when adding a new one.
10029 @item avg-loop-niter
10030 Average number of iterations of a loop.
10032 @item dse-max-object-size
10033 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10034 Larger values may result in larger compilation times.
10036 @item scev-max-expr-size
10037 Bound on size of expressions used in the scalar evolutions analyzer.
10038 Large expressions slow the analyzer.
10040 @item scev-max-expr-complexity
10041 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10042 Complex expressions slow the analyzer.
10044 @item max-tree-if-conversion-phi-args
10045 Maximum number of arguments in a PHI supported by TREE if conversion
10046 unless the loop is marked with simd pragma.
10048 @item vect-max-version-for-alignment-checks
10049 The maximum number of run-time checks that can be performed when
10050 doing loop versioning for alignment in the vectorizer.
10052 @item vect-max-version-for-alias-checks
10053 The maximum number of run-time checks that can be performed when
10054 doing loop versioning for alias in the vectorizer.
10056 @item vect-max-peeling-for-alignment
10057 The maximum number of loop peels to enhance access alignment
10058 for vectorizer. Value -1 means no limit.
10060 @item max-iterations-to-track
10061 The maximum number of iterations of a loop the brute-force algorithm
10062 for analysis of the number of iterations of the loop tries to evaluate.
10064 @item hot-bb-count-ws-permille
10065 A basic block profile count is considered hot if it contributes to 
10066 the given permillage (i.e. 0...1000) of the entire profiled execution.
10068 @item hot-bb-frequency-fraction
10069 Select fraction of the entry block frequency of executions of basic block in
10070 function given basic block needs to have to be considered hot.
10072 @item max-predicted-iterations
10073 The maximum number of loop iterations we predict statically.  This is useful
10074 in cases where a function contains a single loop with known bound and
10075 another loop with unknown bound.
10076 The known number of iterations is predicted correctly, while
10077 the unknown number of iterations average to roughly 10.  This means that the
10078 loop without bounds appears artificially cold relative to the other one.
10080 @item builtin-expect-probability
10081 Control the probability of the expression having the specified value. This
10082 parameter takes a percentage (i.e. 0 ... 100) as input.
10083 The default probability of 90 is obtained empirically.
10085 @item align-threshold
10087 Select fraction of the maximal frequency of executions of a basic block in
10088 a function to align the basic block.
10090 @item align-loop-iterations
10092 A loop expected to iterate at least the selected number of iterations is
10093 aligned.
10095 @item tracer-dynamic-coverage
10096 @itemx tracer-dynamic-coverage-feedback
10098 This value is used to limit superblock formation once the given percentage of
10099 executed instructions is covered.  This limits unnecessary code size
10100 expansion.
10102 The @option{tracer-dynamic-coverage-feedback} parameter
10103 is used only when profile
10104 feedback is available.  The real profiles (as opposed to statically estimated
10105 ones) are much less balanced allowing the threshold to be larger value.
10107 @item tracer-max-code-growth
10108 Stop tail duplication once code growth has reached given percentage.  This is
10109 a rather artificial limit, as most of the duplicates are eliminated later in
10110 cross jumping, so it may be set to much higher values than is the desired code
10111 growth.
10113 @item tracer-min-branch-ratio
10115 Stop reverse growth when the reverse probability of best edge is less than this
10116 threshold (in percent).
10118 @item tracer-min-branch-probability
10119 @itemx tracer-min-branch-probability-feedback
10121 Stop forward growth if the best edge has probability lower than this
10122 threshold.
10124 Similarly to @option{tracer-dynamic-coverage} two parameters are
10125 provided.  @option{tracer-min-branch-probability-feedback} is used for
10126 compilation with profile feedback and @option{tracer-min-branch-probability}
10127 compilation without.  The value for compilation with profile feedback
10128 needs to be more conservative (higher) in order to make tracer
10129 effective.
10131 @item max-cse-path-length
10133 The maximum number of basic blocks on path that CSE considers.
10134 The default is 10.
10136 @item max-cse-insns
10137 The maximum number of instructions CSE processes before flushing.
10138 The default is 1000.
10140 @item ggc-min-expand
10142 GCC uses a garbage collector to manage its own memory allocation.  This
10143 parameter specifies the minimum percentage by which the garbage
10144 collector's heap should be allowed to expand between collections.
10145 Tuning this may improve compilation speed; it has no effect on code
10146 generation.
10148 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10149 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10150 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10151 GCC is not able to calculate RAM on a particular platform, the lower
10152 bound of 30% is used.  Setting this parameter and
10153 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10154 every opportunity.  This is extremely slow, but can be useful for
10155 debugging.
10157 @item ggc-min-heapsize
10159 Minimum size of the garbage collector's heap before it begins bothering
10160 to collect garbage.  The first collection occurs after the heap expands
10161 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10162 tuning this may improve compilation speed, and has no effect on code
10163 generation.
10165 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10166 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10167 with a lower bound of 4096 (four megabytes) and an upper bound of
10168 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10169 particular platform, the lower bound is used.  Setting this parameter
10170 very large effectively disables garbage collection.  Setting this
10171 parameter and @option{ggc-min-expand} to zero causes a full collection
10172 to occur at every opportunity.
10174 @item max-reload-search-insns
10175 The maximum number of instruction reload should look backward for equivalent
10176 register.  Increasing values mean more aggressive optimization, making the
10177 compilation time increase with probably slightly better performance.
10178 The default value is 100.
10180 @item max-cselib-memory-locations
10181 The maximum number of memory locations cselib should take into account.
10182 Increasing values mean more aggressive optimization, making the compilation time
10183 increase with probably slightly better performance.  The default value is 500.
10185 @item max-sched-ready-insns
10186 The maximum number of instructions ready to be issued the scheduler should
10187 consider at any given time during the first scheduling pass.  Increasing
10188 values mean more thorough searches, making the compilation time increase
10189 with probably little benefit.  The default value is 100.
10191 @item max-sched-region-blocks
10192 The maximum number of blocks in a region to be considered for
10193 interblock scheduling.  The default value is 10.
10195 @item max-pipeline-region-blocks
10196 The maximum number of blocks in a region to be considered for
10197 pipelining in the selective scheduler.  The default value is 15.
10199 @item max-sched-region-insns
10200 The maximum number of insns in a region to be considered for
10201 interblock scheduling.  The default value is 100.
10203 @item max-pipeline-region-insns
10204 The maximum number of insns in a region to be considered for
10205 pipelining in the selective scheduler.  The default value is 200.
10207 @item min-spec-prob
10208 The minimum probability (in percents) of reaching a source block
10209 for interblock speculative scheduling.  The default value is 40.
10211 @item max-sched-extend-regions-iters
10212 The maximum number of iterations through CFG to extend regions.
10213 A value of 0 (the default) disables region extensions.
10215 @item max-sched-insn-conflict-delay
10216 The maximum conflict delay for an insn to be considered for speculative motion.
10217 The default value is 3.
10219 @item sched-spec-prob-cutoff
10220 The minimal probability of speculation success (in percents), so that
10221 speculative insns are scheduled.
10222 The default value is 40.
10224 @item sched-state-edge-prob-cutoff
10225 The minimum probability an edge must have for the scheduler to save its
10226 state across it.
10227 The default value is 10.
10229 @item sched-mem-true-dep-cost
10230 Minimal distance (in CPU cycles) between store and load targeting same
10231 memory locations.  The default value is 1.
10233 @item selsched-max-lookahead
10234 The maximum size of the lookahead window of selective scheduling.  It is a
10235 depth of search for available instructions.
10236 The default value is 50.
10238 @item selsched-max-sched-times
10239 The maximum number of times that an instruction is scheduled during
10240 selective scheduling.  This is the limit on the number of iterations
10241 through which the instruction may be pipelined.  The default value is 2.
10243 @item selsched-insns-to-rename
10244 The maximum number of best instructions in the ready list that are considered
10245 for renaming in the selective scheduler.  The default value is 2.
10247 @item sms-min-sc
10248 The minimum value of stage count that swing modulo scheduler
10249 generates.  The default value is 2.
10251 @item max-last-value-rtl
10252 The maximum size measured as number of RTLs that can be recorded in an expression
10253 in combiner for a pseudo register as last known value of that register.  The default
10254 is 10000.
10256 @item max-combine-insns
10257 The maximum number of instructions the RTL combiner tries to combine.
10258 The default value is 2 at @option{-Og} and 4 otherwise.
10260 @item integer-share-limit
10261 Small integer constants can use a shared data structure, reducing the
10262 compiler's memory usage and increasing its speed.  This sets the maximum
10263 value of a shared integer constant.  The default value is 256.
10265 @item ssp-buffer-size
10266 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10267 protection when @option{-fstack-protection} is used.
10269 @item min-size-for-stack-sharing
10270 The minimum size of variables taking part in stack slot sharing when not
10271 optimizing. The default value is 32.
10273 @item max-jump-thread-duplication-stmts
10274 Maximum number of statements allowed in a block that needs to be
10275 duplicated when threading jumps.
10277 @item max-fields-for-field-sensitive
10278 Maximum number of fields in a structure treated in
10279 a field sensitive manner during pointer analysis.  The default is zero
10280 for @option{-O0} and @option{-O1},
10281 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10283 @item prefetch-latency
10284 Estimate on average number of instructions that are executed before
10285 prefetch finishes.  The distance prefetched ahead is proportional
10286 to this constant.  Increasing this number may also lead to less
10287 streams being prefetched (see @option{simultaneous-prefetches}).
10289 @item simultaneous-prefetches
10290 Maximum number of prefetches that can run at the same time.
10292 @item l1-cache-line-size
10293 The size of cache line in L1 cache, in bytes.
10295 @item l1-cache-size
10296 The size of L1 cache, in kilobytes.
10298 @item l2-cache-size
10299 The size of L2 cache, in kilobytes.
10301 @item min-insn-to-prefetch-ratio
10302 The minimum ratio between the number of instructions and the
10303 number of prefetches to enable prefetching in a loop.
10305 @item prefetch-min-insn-to-mem-ratio
10306 The minimum ratio between the number of instructions and the
10307 number of memory references to enable prefetching in a loop.
10309 @item use-canonical-types
10310 Whether the compiler should use the ``canonical'' type system.  By
10311 default, this should always be 1, which uses a more efficient internal
10312 mechanism for comparing types in C++ and Objective-C++.  However, if
10313 bugs in the canonical type system are causing compilation failures,
10314 set this value to 0 to disable canonical types.
10316 @item switch-conversion-max-branch-ratio
10317 Switch initialization conversion refuses to create arrays that are
10318 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10319 branches in the switch.
10321 @item max-partial-antic-length
10322 Maximum length of the partial antic set computed during the tree
10323 partial redundancy elimination optimization (@option{-ftree-pre}) when
10324 optimizing at @option{-O3} and above.  For some sorts of source code
10325 the enhanced partial redundancy elimination optimization can run away,
10326 consuming all of the memory available on the host machine.  This
10327 parameter sets a limit on the length of the sets that are computed,
10328 which prevents the runaway behavior.  Setting a value of 0 for
10329 this parameter allows an unlimited set length.
10331 @item sccvn-max-scc-size
10332 Maximum size of a strongly connected component (SCC) during SCCVN
10333 processing.  If this limit is hit, SCCVN processing for the whole
10334 function is not done and optimizations depending on it are
10335 disabled.  The default maximum SCC size is 10000.
10337 @item sccvn-max-alias-queries-per-access
10338 Maximum number of alias-oracle queries we perform when looking for
10339 redundancies for loads and stores.  If this limit is hit the search
10340 is aborted and the load or store is not considered redundant.  The
10341 number of queries is algorithmically limited to the number of
10342 stores on all paths from the load to the function entry.
10343 The default maximum number of queries is 1000.
10345 @item ira-max-loops-num
10346 IRA uses regional register allocation by default.  If a function
10347 contains more loops than the number given by this parameter, only at most
10348 the given number of the most frequently-executed loops form regions
10349 for regional register allocation.  The default value of the
10350 parameter is 100.
10352 @item ira-max-conflict-table-size 
10353 Although IRA uses a sophisticated algorithm to compress the conflict
10354 table, the table can still require excessive amounts of memory for
10355 huge functions.  If the conflict table for a function could be more
10356 than the size in MB given by this parameter, the register allocator
10357 instead uses a faster, simpler, and lower-quality
10358 algorithm that does not require building a pseudo-register conflict table.  
10359 The default value of the parameter is 2000.
10361 @item ira-loop-reserved-regs
10362 IRA can be used to evaluate more accurate register pressure in loops
10363 for decisions to move loop invariants (see @option{-O3}).  The number
10364 of available registers reserved for some other purposes is given
10365 by this parameter.  The default value of the parameter is 2, which is
10366 the minimal number of registers needed by typical instructions.
10367 This value is the best found from numerous experiments.
10369 @item lra-inheritance-ebb-probability-cutoff
10370 LRA tries to reuse values reloaded in registers in subsequent insns.
10371 This optimization is called inheritance.  EBB is used as a region to
10372 do this optimization.  The parameter defines a minimal fall-through
10373 edge probability in percentage used to add BB to inheritance EBB in
10374 LRA.  The default value of the parameter is 40.  The value was chosen
10375 from numerous runs of SPEC2000 on x86-64.
10377 @item loop-invariant-max-bbs-in-loop
10378 Loop invariant motion can be very expensive, both in compilation time and
10379 in amount of needed compile-time memory, with very large loops.  Loops
10380 with more basic blocks than this parameter won't have loop invariant
10381 motion optimization performed on them.  The default value of the
10382 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10384 @item loop-max-datarefs-for-datadeps
10385 Building data dependencies is expensive for very large loops.  This
10386 parameter limits the number of data references in loops that are
10387 considered for data dependence analysis.  These large loops are no
10388 handled by the optimizations using loop data dependencies.
10389 The default value is 1000.
10391 @item max-vartrack-size
10392 Sets a maximum number of hash table slots to use during variable
10393 tracking dataflow analysis of any function.  If this limit is exceeded
10394 with variable tracking at assignments enabled, analysis for that
10395 function is retried without it, after removing all debug insns from
10396 the function.  If the limit is exceeded even without debug insns, var
10397 tracking analysis is completely disabled for the function.  Setting
10398 the parameter to zero makes it unlimited.
10400 @item max-vartrack-expr-depth
10401 Sets a maximum number of recursion levels when attempting to map
10402 variable names or debug temporaries to value expressions.  This trades
10403 compilation time for more complete debug information.  If this is set too
10404 low, value expressions that are available and could be represented in
10405 debug information may end up not being used; setting this higher may
10406 enable the compiler to find more complex debug expressions, but compile
10407 time and memory use may grow.  The default is 12.
10409 @item min-nondebug-insn-uid
10410 Use uids starting at this parameter for nondebug insns.  The range below
10411 the parameter is reserved exclusively for debug insns created by
10412 @option{-fvar-tracking-assignments}, but debug insns may get
10413 (non-overlapping) uids above it if the reserved range is exhausted.
10415 @item ipa-sra-ptr-growth-factor
10416 IPA-SRA replaces a pointer to an aggregate with one or more new
10417 parameters only when their cumulative size is less or equal to
10418 @option{ipa-sra-ptr-growth-factor} times the size of the original
10419 pointer parameter.
10421 @item sra-max-scalarization-size-Ospeed
10422 @item sra-max-scalarization-size-Osize
10423 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10424 replace scalar parts of aggregates with uses of independent scalar
10425 variables.  These parameters control the maximum size, in storage units,
10426 of aggregate which is considered for replacement when compiling for
10427 speed
10428 (@option{sra-max-scalarization-size-Ospeed}) or size
10429 (@option{sra-max-scalarization-size-Osize}) respectively.
10431 @item tm-max-aggregate-size
10432 When making copies of thread-local variables in a transaction, this
10433 parameter specifies the size in bytes after which variables are
10434 saved with the logging functions as opposed to save/restore code
10435 sequence pairs.  This option only applies when using
10436 @option{-fgnu-tm}.
10438 @item graphite-max-nb-scop-params
10439 To avoid exponential effects in the Graphite loop transforms, the
10440 number of parameters in a Static Control Part (SCoP) is bounded.  The
10441 default value is 10 parameters.  A variable whose value is unknown at
10442 compilation time and defined outside a SCoP is a parameter of the SCoP.
10444 @item graphite-max-bbs-per-function
10445 To avoid exponential effects in the detection of SCoPs, the size of
10446 the functions analyzed by Graphite is bounded.  The default value is
10447 100 basic blocks.
10449 @item loop-block-tile-size
10450 Loop blocking or strip mining transforms, enabled with
10451 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10452 loop in the loop nest by a given number of iterations.  The strip
10453 length can be changed using the @option{loop-block-tile-size}
10454 parameter.  The default value is 51 iterations.
10456 @item loop-unroll-jam-size
10457 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10458 default value is 4.
10460 @item loop-unroll-jam-depth
10461 Specify the dimension to be unrolled (counting from the most inner loop)
10462 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10464 @item ipa-cp-value-list-size
10465 IPA-CP attempts to track all possible values and types passed to a function's
10466 parameter in order to propagate them and perform devirtualization.
10467 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10468 stores per one formal parameter of a function.
10470 @item ipa-cp-eval-threshold
10471 IPA-CP calculates its own score of cloning profitability heuristics
10472 and performs those cloning opportunities with scores that exceed
10473 @option{ipa-cp-eval-threshold}.
10475 @item ipa-cp-recursion-penalty
10476 Percentage penalty the recursive functions will receive when they
10477 are evaluated for cloning.
10479 @item ipa-cp-single-call-penalty
10480 Percentage penalty functions containing a single call to another
10481 function will receive when they are evaluated for cloning.
10484 @item ipa-max-agg-items
10485 IPA-CP is also capable to propagate a number of scalar values passed
10486 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10487 number of such values per one parameter.
10489 @item ipa-cp-loop-hint-bonus
10490 When IPA-CP determines that a cloning candidate would make the number
10491 of iterations of a loop known, it adds a bonus of
10492 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10493 the candidate.
10495 @item ipa-cp-array-index-hint-bonus
10496 When IPA-CP determines that a cloning candidate would make the index of
10497 an array access known, it adds a bonus of
10498 @option{ipa-cp-array-index-hint-bonus} to the profitability
10499 score of the candidate.
10501 @item ipa-max-aa-steps
10502 During its analysis of function bodies, IPA-CP employs alias analysis
10503 in order to track values pointed to by function parameters.  In order
10504 not spend too much time analyzing huge functions, it gives up and
10505 consider all memory clobbered after examining
10506 @option{ipa-max-aa-steps} statements modifying memory.
10508 @item lto-partitions
10509 Specify desired number of partitions produced during WHOPR compilation.
10510 The number of partitions should exceed the number of CPUs used for compilation.
10511 The default value is 32.
10513 @item lto-min-partition
10514 Size of minimal partition for WHOPR (in estimated instructions).
10515 This prevents expenses of splitting very small programs into too many
10516 partitions.
10518 @item lto-max-partition
10519 Size of max partition for WHOPR (in estimated instructions).
10520 to provide an upper bound for individual size of partition.
10521 Meant to be used only with balanced partitioning.
10523 @item cxx-max-namespaces-for-diagnostic-help
10524 The maximum number of namespaces to consult for suggestions when C++
10525 name lookup fails for an identifier.  The default is 1000.
10527 @item sink-frequency-threshold
10528 The maximum relative execution frequency (in percents) of the target block
10529 relative to a statement's original block to allow statement sinking of a
10530 statement.  Larger numbers result in more aggressive statement sinking.
10531 The default value is 75.  A small positive adjustment is applied for
10532 statements with memory operands as those are even more profitable so sink.
10534 @item max-stores-to-sink
10535 The maximum number of conditional store pairs that can be sunk.  Set to 0
10536 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10537 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10539 @item allow-store-data-races
10540 Allow optimizers to introduce new data races on stores.
10541 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10542 at optimization level @option{-Ofast}.
10544 @item case-values-threshold
10545 The smallest number of different values for which it is best to use a
10546 jump-table instead of a tree of conditional branches.  If the value is
10547 0, use the default for the machine.  The default is 0.
10549 @item tree-reassoc-width
10550 Set the maximum number of instructions executed in parallel in
10551 reassociated tree. This parameter overrides target dependent
10552 heuristics used by default if has non zero value.
10554 @item sched-pressure-algorithm
10555 Choose between the two available implementations of
10556 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10557 and is the more likely to prevent instructions from being reordered.
10558 Algorithm 2 was designed to be a compromise between the relatively
10559 conservative approach taken by algorithm 1 and the rather aggressive
10560 approach taken by the default scheduler.  It relies more heavily on
10561 having a regular register file and accurate register pressure classes.
10562 See @file{haifa-sched.c} in the GCC sources for more details.
10564 The default choice depends on the target.
10566 @item max-slsr-cand-scan
10567 Set the maximum number of existing candidates that are considered when
10568 seeking a basis for a new straight-line strength reduction candidate.
10570 @item asan-globals
10571 Enable buffer overflow detection for global objects.  This kind
10572 of protection is enabled by default if you are using
10573 @option{-fsanitize=address} option.
10574 To disable global objects protection use @option{--param asan-globals=0}.
10576 @item asan-stack
10577 Enable buffer overflow detection for stack objects.  This kind of
10578 protection is enabled by default when using @option{-fsanitize=address}.
10579 To disable stack protection use @option{--param asan-stack=0} option.
10581 @item asan-instrument-reads
10582 Enable buffer overflow detection for memory reads.  This kind of
10583 protection is enabled by default when using @option{-fsanitize=address}.
10584 To disable memory reads protection use
10585 @option{--param asan-instrument-reads=0}.
10587 @item asan-instrument-writes
10588 Enable buffer overflow detection for memory writes.  This kind of
10589 protection is enabled by default when using @option{-fsanitize=address}.
10590 To disable memory writes protection use
10591 @option{--param asan-instrument-writes=0} option.
10593 @item asan-memintrin
10594 Enable detection for built-in functions.  This kind of protection
10595 is enabled by default when using @option{-fsanitize=address}.
10596 To disable built-in functions protection use
10597 @option{--param asan-memintrin=0}.
10599 @item asan-use-after-return
10600 Enable detection of use-after-return.  This kind of protection
10601 is enabled by default when using the @option{-fsanitize=address} option.
10602 To disable it use @option{--param asan-use-after-return=0}.
10604 Note: By default the check is disabled at run time.  To enable it,
10605 add @code{detect_stack_use_after_return=1} to the environment variable
10606 @env{ASAN_OPTIONS}.
10608 @item asan-instrumentation-with-call-threshold
10609 If number of memory accesses in function being instrumented
10610 is greater or equal to this number, use callbacks instead of inline checks.
10611 E.g. to disable inline code use
10612 @option{--param asan-instrumentation-with-call-threshold=0}.
10614 @item use-after-scope-direct-emission-threshold
10615 If the size of a local variable in bytes is smaller or equal to this
10616 number, directly poison (or unpoison) shadow memory instead of using
10617 run-time callbacks.  The default value is 256.
10619 @item chkp-max-ctor-size
10620 Static constructors generated by Pointer Bounds Checker may become very
10621 large and significantly increase compile time at optimization level
10622 @option{-O1} and higher.  This parameter is a maximum number of statements
10623 in a single generated constructor.  Default value is 5000.
10625 @item max-fsm-thread-path-insns
10626 Maximum number of instructions to copy when duplicating blocks on a
10627 finite state automaton jump thread path.  The default is 100.
10629 @item max-fsm-thread-length
10630 Maximum number of basic blocks on a finite state automaton jump thread
10631 path.  The default is 10.
10633 @item max-fsm-thread-paths
10634 Maximum number of new jump thread paths to create for a finite state
10635 automaton.  The default is 50.
10637 @item parloops-chunk-size
10638 Chunk size of omp schedule for loops parallelized by parloops.  The default
10639 is 0.
10641 @item parloops-schedule
10642 Schedule type of omp schedule for loops parallelized by parloops (static,
10643 dynamic, guided, auto, runtime).  The default is static.
10645 @item max-ssa-name-query-depth
10646 Maximum depth of recursion when querying properties of SSA names in things
10647 like fold routines.  One level of recursion corresponds to following a
10648 use-def chain.
10650 @item hsa-gen-debug-stores
10651 Enable emission of special debug stores within HSA kernels which are
10652 then read and reported by libgomp plugin.  Generation of these stores
10653 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10654 enable it.
10656 @item max-speculative-devirt-maydefs
10657 The maximum number of may-defs we analyze when looking for a must-def
10658 specifying the dynamic type of an object that invokes a virtual call
10659 we may be able to devirtualize speculatively.
10661 @item max-vrp-switch-assertions
10662 The maximum number of assertions to add along the default edge of a switch
10663 statement during VRP.  The default is 10.
10664 @end table
10665 @end table
10667 @node Instrumentation Options
10668 @section Program Instrumentation Options
10669 @cindex instrumentation options
10670 @cindex program instrumentation options
10671 @cindex run-time error checking options
10672 @cindex profiling options
10673 @cindex options, program instrumentation
10674 @cindex options, run-time error checking
10675 @cindex options, profiling
10677 GCC supports a number of command-line options that control adding
10678 run-time instrumentation to the code it normally generates.  
10679 For example, one purpose of instrumentation is collect profiling
10680 statistics for use in finding program hot spots, code coverage
10681 analysis, or profile-guided optimizations.
10682 Another class of program instrumentation is adding run-time checking 
10683 to detect programming errors like invalid pointer
10684 dereferences or out-of-bounds array accesses, as well as deliberately
10685 hostile attacks such as stack smashing or C++ vtable hijacking.
10686 There is also a general hook which can be used to implement other
10687 forms of tracing or function-level instrumentation for debug or
10688 program analysis purposes.
10690 @table @gcctabopt
10691 @cindex @command{prof}
10692 @item -p
10693 @opindex p
10694 Generate extra code to write profile information suitable for the
10695 analysis program @command{prof}.  You must use this option when compiling
10696 the source files you want data about, and you must also use it when
10697 linking.
10699 @cindex @command{gprof}
10700 @item -pg
10701 @opindex pg
10702 Generate extra code to write profile information suitable for the
10703 analysis program @command{gprof}.  You must use this option when compiling
10704 the source files you want data about, and you must also use it when
10705 linking.
10707 @item -fprofile-arcs
10708 @opindex fprofile-arcs
10709 Add code so that program flow @dfn{arcs} are instrumented.  During
10710 execution the program records how many times each branch and call is
10711 executed and how many times it is taken or returns.  On targets that support
10712 constructors with priority support, profiling properly handles constructors,
10713 destructors and C++ constructors (and destructors) of classes which are used
10714 as a type of a global variable.
10716 When the compiled
10717 program exits it saves this data to a file called
10718 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10719 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10720 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10721 @var{auxname} is generated from the name of the output file, if
10722 explicitly specified and it is not the final executable, otherwise it is
10723 the basename of the source file.  In both cases any suffix is removed
10724 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10725 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10726 @xref{Cross-profiling}.
10728 @cindex @command{gcov}
10729 @item --coverage
10730 @opindex coverage
10732 This option is used to compile and link code instrumented for coverage
10733 analysis.  The option is a synonym for @option{-fprofile-arcs}
10734 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10735 linking).  See the documentation for those options for more details.
10737 @itemize
10739 @item
10740 Compile the source files with @option{-fprofile-arcs} plus optimization
10741 and code generation options.  For test coverage analysis, use the
10742 additional @option{-ftest-coverage} option.  You do not need to profile
10743 every source file in a program.
10745 @item
10746 Compile the source files additionally with @option{-fprofile-abs-path}
10747 to create absolute path names in the @file{.gcno} files.  This allows
10748 @command{gcov} to find the correct sources in projects where compilations
10749 occur with different working directories.
10751 @item
10752 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10753 (the latter implies the former).
10755 @item
10756 Run the program on a representative workload to generate the arc profile
10757 information.  This may be repeated any number of times.  You can run
10758 concurrent instances of your program, and provided that the file system
10759 supports locking, the data files will be correctly updated.  Also
10760 @code{fork} calls are detected and correctly handled (double counting
10761 will not happen).
10763 @item
10764 For profile-directed optimizations, compile the source files again with
10765 the same optimization and code generation options plus
10766 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10767 Control Optimization}).
10769 @item
10770 For test coverage analysis, use @command{gcov} to produce human readable
10771 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10772 @command{gcov} documentation for further information.
10774 @end itemize
10776 With @option{-fprofile-arcs}, for each function of your program GCC
10777 creates a program flow graph, then finds a spanning tree for the graph.
10778 Only arcs that are not on the spanning tree have to be instrumented: the
10779 compiler adds code to count the number of times that these arcs are
10780 executed.  When an arc is the only exit or only entrance to a block, the
10781 instrumentation code can be added to the block; otherwise, a new basic
10782 block must be created to hold the instrumentation code.
10784 @need 2000
10785 @item -ftest-coverage
10786 @opindex ftest-coverage
10787 Produce a notes file that the @command{gcov} code-coverage utility
10788 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10789 show program coverage.  Each source file's note file is called
10790 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10791 above for a description of @var{auxname} and instructions on how to
10792 generate test coverage data.  Coverage data matches the source files
10793 more closely if you do not optimize.
10795 @item -fprofile-abs-path
10796 @opindex fprofile-abs-path
10797 Automatically convert relative source file names to absolute path names
10798 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10799 sources in projects where compilations occur with different working
10800 directories.
10802 @item -fprofile-dir=@var{path}
10803 @opindex fprofile-dir
10805 Set the directory to search for the profile data files in to @var{path}.
10806 This option affects only the profile data generated by
10807 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10808 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10809 and its related options.  Both absolute and relative paths can be used.
10810 By default, GCC uses the current directory as @var{path}, thus the
10811 profile data file appears in the same directory as the object file.
10813 @item -fprofile-generate
10814 @itemx -fprofile-generate=@var{path}
10815 @opindex fprofile-generate
10817 Enable options usually used for instrumenting application to produce
10818 profile useful for later recompilation with profile feedback based
10819 optimization.  You must use @option{-fprofile-generate} both when
10820 compiling and when linking your program.
10822 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10824 If @var{path} is specified, GCC looks at the @var{path} to find
10825 the profile feedback data files. See @option{-fprofile-dir}.
10827 To optimize the program based on the collected profile information, use
10828 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10830 @item -fprofile-update=@var{method}
10831 @opindex fprofile-update
10833 Alter the update method for an application instrumented for profile
10834 feedback based optimization.  The @var{method} argument should be one of
10835 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10836 The first one is useful for single-threaded applications,
10837 while the second one prevents profile corruption by emitting thread-safe code.
10839 @strong{Warning:} When an application does not properly join all threads
10840 (or creates an detached thread), a profile file can be still corrupted.
10842 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10843 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10844 automatically selects @samp{prefer-atomic} when @option{-pthread}
10845 is present in the command line.
10847 @item -fsanitize=address
10848 @opindex fsanitize=address
10849 Enable AddressSanitizer, a fast memory error detector.
10850 Memory access instructions are instrumented to detect
10851 out-of-bounds and use-after-free bugs.
10852 The option enables @option{-fsanitize-address-use-after-scope}.
10853 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10854 more details.  The run-time behavior can be influenced using the
10855 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10856 the available options are shown at startup of the instrumented program.  See
10857 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10858 for a list of supported options.
10859 The option cannot be combined with @option{-fsanitize=thread}
10860 and/or @option{-fcheck-pointer-bounds}.
10862 @item -fsanitize=kernel-address
10863 @opindex fsanitize=kernel-address
10864 Enable AddressSanitizer for Linux kernel.
10865 See @uref{https://github.com/google/kasan/wiki} for more details.
10866 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10868 @item -fsanitize=thread
10869 @opindex fsanitize=thread
10870 Enable ThreadSanitizer, a fast data race detector.
10871 Memory access instructions are instrumented to detect
10872 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10873 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10874 environment variable; see
10875 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10876 supported options.
10877 The option cannot be combined with @option{-fsanitize=address},
10878 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10880 Note that sanitized atomic builtins cannot throw exceptions when
10881 operating on invalid memory addresses with non-call exceptions
10882 (@option{-fnon-call-exceptions}).
10884 @item -fsanitize=leak
10885 @opindex fsanitize=leak
10886 Enable LeakSanitizer, a memory leak detector.
10887 This option only matters for linking of executables and
10888 the executable is linked against a library that overrides @code{malloc}
10889 and other allocator functions.  See
10890 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10891 details.  The run-time behavior can be influenced using the
10892 @env{LSAN_OPTIONS} environment variable.
10893 The option cannot be combined with @option{-fsanitize=thread}.
10895 @item -fsanitize=undefined
10896 @opindex fsanitize=undefined
10897 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10898 Various computations are instrumented to detect undefined behavior
10899 at runtime.  Current suboptions are:
10901 @table @gcctabopt
10903 @item -fsanitize=shift
10904 @opindex fsanitize=shift
10905 This option enables checking that the result of a shift operation is
10906 not undefined.  Note that what exactly is considered undefined differs
10907 slightly between C and C++, as well as between ISO C90 and C99, etc.
10908 This option has two suboptions, @option{-fsanitize=shift-base} and
10909 @option{-fsanitize=shift-exponent}.
10911 @item -fsanitize=shift-exponent
10912 @opindex fsanitize=shift-exponent
10913 This option enables checking that the second argument of a shift operation
10914 is not negative and is smaller than the precision of the promoted first
10915 argument.
10917 @item -fsanitize=shift-base
10918 @opindex fsanitize=shift-base
10919 If the second argument of a shift operation is within range, check that the
10920 result of a shift operation is not undefined.  Note that what exactly is
10921 considered undefined differs slightly between C and C++, as well as between
10922 ISO C90 and C99, etc.
10924 @item -fsanitize=integer-divide-by-zero
10925 @opindex fsanitize=integer-divide-by-zero
10926 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10928 @item -fsanitize=unreachable
10929 @opindex fsanitize=unreachable
10930 With this option, the compiler turns the @code{__builtin_unreachable}
10931 call into a diagnostics message call instead.  When reaching the
10932 @code{__builtin_unreachable} call, the behavior is undefined.
10934 @item -fsanitize=vla-bound
10935 @opindex fsanitize=vla-bound
10936 This option instructs the compiler to check that the size of a variable
10937 length array is positive.
10939 @item -fsanitize=null
10940 @opindex fsanitize=null
10941 This option enables pointer checking.  Particularly, the application
10942 built with this option turned on will issue an error message when it
10943 tries to dereference a NULL pointer, or if a reference (possibly an
10944 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10945 on an object pointed by a NULL pointer.
10947 @item -fsanitize=return
10948 @opindex fsanitize=return
10949 This option enables return statement checking.  Programs
10950 built with this option turned on will issue an error message
10951 when the end of a non-void function is reached without actually
10952 returning a value.  This option works in C++ only.
10954 @item -fsanitize=signed-integer-overflow
10955 @opindex fsanitize=signed-integer-overflow
10956 This option enables signed integer overflow checking.  We check that
10957 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10958 does not overflow in the signed arithmetics.  Note, integer promotion
10959 rules must be taken into account.  That is, the following is not an
10960 overflow:
10961 @smallexample
10962 signed char a = SCHAR_MAX;
10963 a++;
10964 @end smallexample
10966 @item -fsanitize=bounds
10967 @opindex fsanitize=bounds
10968 This option enables instrumentation of array bounds.  Various out of bounds
10969 accesses are detected.  Flexible array members, flexible array member-like
10970 arrays, and initializers of variables with static storage are not instrumented.
10971 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10973 @item -fsanitize=bounds-strict
10974 @opindex fsanitize=bounds-strict
10975 This option enables strict instrumentation of array bounds.  Most out of bounds
10976 accesses are detected, including flexible array members and flexible array
10977 member-like arrays.  Initializers of variables with static storage are not
10978 instrumented.  The option cannot be combined
10979 with @option{-fcheck-pointer-bounds}.
10981 @item -fsanitize=alignment
10982 @opindex fsanitize=alignment
10984 This option enables checking of alignment of pointers when they are
10985 dereferenced, or when a reference is bound to insufficiently aligned target,
10986 or when a method or constructor is invoked on insufficiently aligned object.
10988 @item -fsanitize=object-size
10989 @opindex fsanitize=object-size
10990 This option enables instrumentation of memory references using the
10991 @code{__builtin_object_size} function.  Various out of bounds pointer
10992 accesses are detected.
10994 @item -fsanitize=float-divide-by-zero
10995 @opindex fsanitize=float-divide-by-zero
10996 Detect floating-point division by zero.  Unlike other similar options,
10997 @option{-fsanitize=float-divide-by-zero} is not enabled by
10998 @option{-fsanitize=undefined}, since floating-point division by zero can
10999 be a legitimate way of obtaining infinities and NaNs.
11001 @item -fsanitize=float-cast-overflow
11002 @opindex fsanitize=float-cast-overflow
11003 This option enables floating-point type to integer conversion checking.
11004 We check that the result of the conversion does not overflow.
11005 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11006 not enabled by @option{-fsanitize=undefined}.
11007 This option does not work well with @code{FE_INVALID} exceptions enabled.
11009 @item -fsanitize=nonnull-attribute
11010 @opindex fsanitize=nonnull-attribute
11012 This option enables instrumentation of calls, checking whether null values
11013 are not passed to arguments marked as requiring a non-null value by the
11014 @code{nonnull} function attribute.
11016 @item -fsanitize=returns-nonnull-attribute
11017 @opindex fsanitize=returns-nonnull-attribute
11019 This option enables instrumentation of return statements in functions
11020 marked with @code{returns_nonnull} function attribute, to detect returning
11021 of null values from such functions.
11023 @item -fsanitize=bool
11024 @opindex fsanitize=bool
11026 This option enables instrumentation of loads from bool.  If a value other
11027 than 0/1 is loaded, a run-time error is issued.
11029 @item -fsanitize=enum
11030 @opindex fsanitize=enum
11032 This option enables instrumentation of loads from an enum type.  If
11033 a value outside the range of values for the enum type is loaded,
11034 a run-time error is issued.
11036 @item -fsanitize=vptr
11037 @opindex fsanitize=vptr
11039 This option enables instrumentation of C++ member function calls, member
11040 accesses and some conversions between pointers to base and derived classes,
11041 to verify the referenced object has the correct dynamic type.
11043 @end table
11045 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11046 @option{-fsanitize=undefined} gives a diagnostic message.
11047 This currently works only for the C family of languages.
11049 @item -fno-sanitize=all
11050 @opindex fno-sanitize=all
11052 This option disables all previously enabled sanitizers.
11053 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11054 together.
11056 @item -fasan-shadow-offset=@var{number}
11057 @opindex fasan-shadow-offset
11058 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11059 It is useful for experimenting with different shadow memory layouts in
11060 Kernel AddressSanitizer.
11062 @item -fsanitize-sections=@var{s1},@var{s2},...
11063 @opindex fsanitize-sections
11064 Sanitize global variables in selected user-defined sections.  @var{si} may
11065 contain wildcards.
11067 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11068 @opindex fsanitize-recover
11069 @opindex fno-sanitize-recover
11070 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11071 mentioned in comma-separated list of @var{opts}.  Enabling this option
11072 for a sanitizer component causes it to attempt to continue
11073 running the program as if no error happened.  This means multiple
11074 runtime errors can be reported in a single program run, and the exit
11075 code of the program may indicate success even when errors
11076 have been reported.  The @option{-fno-sanitize-recover=} option
11077 can be used to alter
11078 this behavior: only the first detected error is reported
11079 and program then exits with a non-zero exit code.
11081 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11082 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11083 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11084 @option{-fsanitize=bounds-strict},
11085 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11086 For these sanitizers error recovery is turned on by default,
11087 except @option{-fsanitize=address}, for which this feature is experimental.
11088 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11089 accepted, the former enables recovery for all sanitizers that support it,
11090 the latter disables recovery for all sanitizers that support it.
11092 Even if a recovery mode is turned on the compiler side, it needs to be also
11093 enabled on the runtime library side, otherwise the failures are still fatal.
11094 The runtime library defaults to @code{halt_on_error=0} for
11095 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11096 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11097 setting the @code{halt_on_error} flag in the corresponding environment variable.
11099 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11100 equivalent to specifying an @var{opts} list of:
11102 @smallexample
11103 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11104 @end smallexample
11106 @item -fsanitize-address-use-after-scope
11107 @opindex fsanitize-address-use-after-scope
11108 Enable sanitization of local variables to detect use-after-scope bugs.
11109 The option sets @option{-fstack-reuse} to @samp{none}.
11111 @item -fsanitize-undefined-trap-on-error
11112 @opindex fsanitize-undefined-trap-on-error
11113 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11114 report undefined behavior using @code{__builtin_trap} rather than
11115 a @code{libubsan} library routine.  The advantage of this is that the
11116 @code{libubsan} library is not needed and is not linked in, so this
11117 is usable even in freestanding environments.
11119 @item -fsanitize-coverage=trace-pc
11120 @opindex fsanitize-coverage=trace-pc
11121 Enable coverage-guided fuzzing code instrumentation.
11122 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11124 @item -fbounds-check
11125 @opindex fbounds-check
11126 For front ends that support it, generate additional code to check that
11127 indices used to access arrays are within the declared range.  This is
11128 currently only supported by the Fortran front end, where this option
11129 defaults to false.
11131 @item -fcheck-pointer-bounds
11132 @opindex fcheck-pointer-bounds
11133 @opindex fno-check-pointer-bounds
11134 @cindex Pointer Bounds Checker options
11135 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11136 is instrumented with checks of the pointer used for memory access against
11137 bounds associated with that pointer.  
11139 Currently there
11140 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11141 and @option{-mmpx} are required to enable this feature.  
11142 MPX-based instrumentation requires
11143 a runtime library to enable MPX in hardware and handle bounds
11144 violation signals.  By default when @option{-fcheck-pointer-bounds}
11145 and @option{-mmpx} options are used to link a program, the GCC driver
11146 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11147 Bounds checking on calls to dynamic libraries requires a linker
11148 with @option{-z bndplt} support; if GCC was configured with a linker
11149 without support for this option (including the Gold linker and older
11150 versions of ld), a warning is given if you link with @option{-mmpx}
11151 without also specifying @option{-static}, since the overall effectiveness
11152 of the bounds checking protection is reduced.
11153 See also @option{-static-libmpxwrappers}.
11155 MPX-based instrumentation
11156 may be used for debugging and also may be included in production code
11157 to increase program security.  Depending on usage, you may
11158 have different requirements for the runtime library.  The current version
11159 of the MPX runtime library is more oriented for use as a debugging
11160 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11161 also @option{-static-libmpx}.  The runtime library  behavior can be
11162 influenced using various @env{CHKP_RT_*} environment variables.  See
11163 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11164 for more details.
11166 Generated instrumentation may be controlled by various
11167 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11168 structure field attribute (@pxref{Type Attributes}) and
11169 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11170 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11171 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11172 Bounds Checker builtins}, for more information.
11174 @item -fchkp-check-incomplete-type
11175 @opindex fchkp-check-incomplete-type
11176 @opindex fno-chkp-check-incomplete-type
11177 Generate pointer bounds checks for variables with incomplete type.
11178 Enabled by default.
11180 @item -fchkp-narrow-bounds
11181 @opindex fchkp-narrow-bounds
11182 @opindex fno-chkp-narrow-bounds
11183 Controls bounds used by Pointer Bounds Checker for pointers to object
11184 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11185 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11186 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11188 @item -fchkp-first-field-has-own-bounds
11189 @opindex fchkp-first-field-has-own-bounds
11190 @opindex fno-chkp-first-field-has-own-bounds
11191 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11192 first field in the structure.  By default a pointer to the first field has
11193 the same bounds as a pointer to the whole structure.
11195 @item -fchkp-flexible-struct-trailing-arrays
11196 @opindex fchkp-flexible-struct-trailing-arrays
11197 @opindex fno-chkp-flexible-struct-trailing-arrays
11198 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11199 possibly flexible.  By default only array fields with zero length or that are
11200 marked with attribute bnd_variable_size are treated as flexible.
11202 @item -fchkp-narrow-to-innermost-array
11203 @opindex fchkp-narrow-to-innermost-array
11204 @opindex fno-chkp-narrow-to-innermost-array
11205 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11206 case of nested static array access.  By default this option is disabled and
11207 bounds of the outermost array are used.
11209 @item -fchkp-optimize
11210 @opindex fchkp-optimize
11211 @opindex fno-chkp-optimize
11212 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11213 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11215 @item -fchkp-use-fast-string-functions
11216 @opindex fchkp-use-fast-string-functions
11217 @opindex fno-chkp-use-fast-string-functions
11218 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11219 by Pointer Bounds Checker.  Disabled by default.
11221 @item -fchkp-use-nochk-string-functions
11222 @opindex fchkp-use-nochk-string-functions
11223 @opindex fno-chkp-use-nochk-string-functions
11224 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11225 by Pointer Bounds Checker.  Disabled by default.
11227 @item -fchkp-use-static-bounds
11228 @opindex fchkp-use-static-bounds
11229 @opindex fno-chkp-use-static-bounds
11230 Allow Pointer Bounds Checker to generate static bounds holding
11231 bounds of static variables.  Enabled by default.
11233 @item -fchkp-use-static-const-bounds
11234 @opindex fchkp-use-static-const-bounds
11235 @opindex fno-chkp-use-static-const-bounds
11236 Use statically-initialized bounds for constant bounds instead of
11237 generating them each time they are required.  By default enabled when
11238 @option{-fchkp-use-static-bounds} is enabled.
11240 @item -fchkp-treat-zero-dynamic-size-as-infinite
11241 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11242 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11243 With this option, objects with incomplete type whose
11244 dynamically-obtained size is zero are treated as having infinite size
11245 instead by Pointer Bounds
11246 Checker.  This option may be helpful if a program is linked with a library
11247 missing size information for some symbols.  Disabled by default.
11249 @item -fchkp-check-read
11250 @opindex fchkp-check-read
11251 @opindex fno-chkp-check-read
11252 Instructs Pointer Bounds Checker to generate checks for all read
11253 accesses to memory.  Enabled by default.
11255 @item -fchkp-check-write
11256 @opindex fchkp-check-write
11257 @opindex fno-chkp-check-write
11258 Instructs Pointer Bounds Checker to generate checks for all write
11259 accesses to memory.  Enabled by default.
11261 @item -fchkp-store-bounds
11262 @opindex fchkp-store-bounds
11263 @opindex fno-chkp-store-bounds
11264 Instructs Pointer Bounds Checker to generate bounds stores for
11265 pointer writes.  Enabled by default.
11267 @item -fchkp-instrument-calls
11268 @opindex fchkp-instrument-calls
11269 @opindex fno-chkp-instrument-calls
11270 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11271 Enabled by default.
11273 @item -fchkp-instrument-marked-only
11274 @opindex fchkp-instrument-marked-only
11275 @opindex fno-chkp-instrument-marked-only
11276 Instructs Pointer Bounds Checker to instrument only functions
11277 marked with the @code{bnd_instrument} attribute
11278 (@pxref{Function Attributes}).  Disabled by default.
11280 @item -fchkp-use-wrappers
11281 @opindex fchkp-use-wrappers
11282 @opindex fno-chkp-use-wrappers
11283 Allows Pointer Bounds Checker to replace calls to built-in functions
11284 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11285 is used to link a program, the GCC driver automatically links
11286 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11287 Enabled by default.
11289 @item -fstack-protector
11290 @opindex fstack-protector
11291 Emit extra code to check for buffer overflows, such as stack smashing
11292 attacks.  This is done by adding a guard variable to functions with
11293 vulnerable objects.  This includes functions that call @code{alloca}, and
11294 functions with buffers larger than 8 bytes.  The guards are initialized
11295 when a function is entered and then checked when the function exits.
11296 If a guard check fails, an error message is printed and the program exits.
11298 @item -fstack-protector-all
11299 @opindex fstack-protector-all
11300 Like @option{-fstack-protector} except that all functions are protected.
11302 @item -fstack-protector-strong
11303 @opindex fstack-protector-strong
11304 Like @option{-fstack-protector} but includes additional functions to
11305 be protected --- those that have local array definitions, or have
11306 references to local frame addresses.
11308 @item -fstack-protector-explicit
11309 @opindex fstack-protector-explicit
11310 Like @option{-fstack-protector} but only protects those functions which
11311 have the @code{stack_protect} attribute.
11313 @item -fstack-check
11314 @opindex fstack-check
11315 Generate code to verify that you do not go beyond the boundary of the
11316 stack.  You should specify this flag if you are running in an
11317 environment with multiple threads, but you only rarely need to specify it in
11318 a single-threaded environment since stack overflow is automatically
11319 detected on nearly all systems if there is only one stack.
11321 Note that this switch does not actually cause checking to be done; the
11322 operating system or the language runtime must do that.  The switch causes
11323 generation of code to ensure that they see the stack being extended.
11325 You can additionally specify a string parameter: @samp{no} means no
11326 checking, @samp{generic} means force the use of old-style checking,
11327 @samp{specific} means use the best checking method and is equivalent
11328 to bare @option{-fstack-check}.
11330 Old-style checking is a generic mechanism that requires no specific
11331 target support in the compiler but comes with the following drawbacks:
11333 @enumerate
11334 @item
11335 Modified allocation strategy for large objects: they are always
11336 allocated dynamically if their size exceeds a fixed threshold.
11338 @item
11339 Fixed limit on the size of the static frame of functions: when it is
11340 topped by a particular function, stack checking is not reliable and
11341 a warning is issued by the compiler.
11343 @item
11344 Inefficiency: because of both the modified allocation strategy and the
11345 generic implementation, code performance is hampered.
11346 @end enumerate
11348 Note that old-style stack checking is also the fallback method for
11349 @samp{specific} if no target support has been added in the compiler.
11351 @item -fstack-limit-register=@var{reg}
11352 @itemx -fstack-limit-symbol=@var{sym}
11353 @itemx -fno-stack-limit
11354 @opindex fstack-limit-register
11355 @opindex fstack-limit-symbol
11356 @opindex fno-stack-limit
11357 Generate code to ensure that the stack does not grow beyond a certain value,
11358 either the value of a register or the address of a symbol.  If a larger
11359 stack is required, a signal is raised at run time.  For most targets,
11360 the signal is raised before the stack overruns the boundary, so
11361 it is possible to catch the signal without taking special precautions.
11363 For instance, if the stack starts at absolute address @samp{0x80000000}
11364 and grows downwards, you can use the flags
11365 @option{-fstack-limit-symbol=__stack_limit} and
11366 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11367 of 128KB@.  Note that this may only work with the GNU linker.
11369 You can locally override stack limit checking by using the
11370 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11372 @item -fsplit-stack
11373 @opindex fsplit-stack
11374 Generate code to automatically split the stack before it overflows.
11375 The resulting program has a discontiguous stack which can only
11376 overflow if the program is unable to allocate any more memory.  This
11377 is most useful when running threaded programs, as it is no longer
11378 necessary to calculate a good stack size to use for each thread.  This
11379 is currently only implemented for the x86 targets running
11380 GNU/Linux.
11382 When code compiled with @option{-fsplit-stack} calls code compiled
11383 without @option{-fsplit-stack}, there may not be much stack space
11384 available for the latter code to run.  If compiling all code,
11385 including library code, with @option{-fsplit-stack} is not an option,
11386 then the linker can fix up these calls so that the code compiled
11387 without @option{-fsplit-stack} always has a large stack.  Support for
11388 this is implemented in the gold linker in GNU binutils release 2.21
11389 and later.
11391 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11392 @opindex fvtable-verify
11393 This option is only available when compiling C++ code.
11394 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11395 feature that verifies at run time, for every virtual call, that
11396 the vtable pointer through which the call is made is valid for the type of
11397 the object, and has not been corrupted or overwritten.  If an invalid vtable
11398 pointer is detected at run time, an error is reported and execution of the
11399 program is immediately halted.
11401 This option causes run-time data structures to be built at program startup,
11402 which are used for verifying the vtable pointers.  
11403 The options @samp{std} and @samp{preinit}
11404 control the timing of when these data structures are built.  In both cases the
11405 data structures are built before execution reaches @code{main}.  Using
11406 @option{-fvtable-verify=std} causes the data structures to be built after
11407 shared libraries have been loaded and initialized.
11408 @option{-fvtable-verify=preinit} causes them to be built before shared
11409 libraries have been loaded and initialized.
11411 If this option appears multiple times in the command line with different
11412 values specified, @samp{none} takes highest priority over both @samp{std} and
11413 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11415 @item -fvtv-debug
11416 @opindex fvtv-debug
11417 When used in conjunction with @option{-fvtable-verify=std} or 
11418 @option{-fvtable-verify=preinit}, causes debug versions of the 
11419 runtime functions for the vtable verification feature to be called.  
11420 This flag also causes the compiler to log information about which 
11421 vtable pointers it finds for each class.
11422 This information is written to a file named @file{vtv_set_ptr_data.log} 
11423 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11424 if that is defined or the current working directory otherwise.
11426 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11427 file, be sure to delete any existing one.
11429 @item -fvtv-counts
11430 @opindex fvtv-counts
11431 This is a debugging flag.  When used in conjunction with
11432 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11433 causes the compiler to keep track of the total number of virtual calls
11434 it encounters and the number of verifications it inserts.  It also
11435 counts the number of calls to certain run-time library functions
11436 that it inserts and logs this information for each compilation unit.
11437 The compiler writes this information to a file named
11438 @file{vtv_count_data.log} in the directory named by the environment
11439 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11440 directory otherwise.  It also counts the size of the vtable pointer sets
11441 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11442 in the same directory.
11444 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11445 files, be sure to delete any existing ones.
11447 @item -finstrument-functions
11448 @opindex finstrument-functions
11449 Generate instrumentation calls for entry and exit to functions.  Just
11450 after function entry and just before function exit, the following
11451 profiling functions are called with the address of the current
11452 function and its call site.  (On some platforms,
11453 @code{__builtin_return_address} does not work beyond the current
11454 function, so the call site information may not be available to the
11455 profiling functions otherwise.)
11457 @smallexample
11458 void __cyg_profile_func_enter (void *this_fn,
11459                                void *call_site);
11460 void __cyg_profile_func_exit  (void *this_fn,
11461                                void *call_site);
11462 @end smallexample
11464 The first argument is the address of the start of the current function,
11465 which may be looked up exactly in the symbol table.
11467 This instrumentation is also done for functions expanded inline in other
11468 functions.  The profiling calls indicate where, conceptually, the
11469 inline function is entered and exited.  This means that addressable
11470 versions of such functions must be available.  If all your uses of a
11471 function are expanded inline, this may mean an additional expansion of
11472 code size.  If you use @code{extern inline} in your C code, an
11473 addressable version of such functions must be provided.  (This is
11474 normally the case anyway, but if you get lucky and the optimizer always
11475 expands the functions inline, you might have gotten away without
11476 providing static copies.)
11478 A function may be given the attribute @code{no_instrument_function}, in
11479 which case this instrumentation is not done.  This can be used, for
11480 example, for the profiling functions listed above, high-priority
11481 interrupt routines, and any functions from which the profiling functions
11482 cannot safely be called (perhaps signal handlers, if the profiling
11483 routines generate output or allocate memory).
11485 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11486 @opindex finstrument-functions-exclude-file-list
11488 Set the list of functions that are excluded from instrumentation (see
11489 the description of @option{-finstrument-functions}).  If the file that
11490 contains a function definition matches with one of @var{file}, then
11491 that function is not instrumented.  The match is done on substrings:
11492 if the @var{file} parameter is a substring of the file name, it is
11493 considered to be a match.
11495 For example:
11497 @smallexample
11498 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11499 @end smallexample
11501 @noindent
11502 excludes any inline function defined in files whose pathnames
11503 contain @file{/bits/stl} or @file{include/sys}.
11505 If, for some reason, you want to include letter @samp{,} in one of
11506 @var{sym}, write @samp{\,}. For example,
11507 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11508 (note the single quote surrounding the option).
11510 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11511 @opindex finstrument-functions-exclude-function-list
11513 This is similar to @option{-finstrument-functions-exclude-file-list},
11514 but this option sets the list of function names to be excluded from
11515 instrumentation.  The function name to be matched is its user-visible
11516 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11517 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11518 match is done on substrings: if the @var{sym} parameter is a substring
11519 of the function name, it is considered to be a match.  For C99 and C++
11520 extended identifiers, the function name must be given in UTF-8, not
11521 using universal character names.
11523 @end table
11526 @node Preprocessor Options
11527 @section Options Controlling the Preprocessor
11528 @cindex preprocessor options
11529 @cindex options, preprocessor
11531 These options control the C preprocessor, which is run on each C source
11532 file before actual compilation.
11534 If you use the @option{-E} option, nothing is done except preprocessing.
11535 Some of these options make sense only together with @option{-E} because
11536 they cause the preprocessor output to be unsuitable for actual
11537 compilation.
11539 In addition to the options listed here, there are a number of options 
11540 to control search paths for include files documented in 
11541 @ref{Directory Options}.  
11542 Options to control preprocessor diagnostics are listed in 
11543 @ref{Warning Options}.
11545 @table @gcctabopt
11546 @include cppopts.texi
11548 @item -Wp,@var{option}
11549 @opindex Wp
11550 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11551 and pass @var{option} directly through to the preprocessor.  If
11552 @var{option} contains commas, it is split into multiple options at the
11553 commas.  However, many options are modified, translated or interpreted
11554 by the compiler driver before being passed to the preprocessor, and
11555 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11556 interface is undocumented and subject to change, so whenever possible
11557 you should avoid using @option{-Wp} and let the driver handle the
11558 options instead.
11560 @item -Xpreprocessor @var{option}
11561 @opindex Xpreprocessor
11562 Pass @var{option} as an option to the preprocessor.  You can use this to
11563 supply system-specific preprocessor options that GCC does not 
11564 recognize.
11566 If you want to pass an option that takes an argument, you must use
11567 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11569 @item -no-integrated-cpp
11570 @opindex no-integrated-cpp
11571 Perform preprocessing as a separate pass before compilation.
11572 By default, GCC performs preprocessing as an integrated part of
11573 input tokenization and parsing.
11574 If this option is provided, the appropriate language front end
11575 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11576 and Objective-C, respectively) is instead invoked twice,
11577 once for preprocessing only and once for actual compilation
11578 of the preprocessed input.
11579 This option may be useful in conjunction with the @option{-B} or
11580 @option{-wrapper} options to specify an alternate preprocessor or
11581 perform additional processing of the program source between
11582 normal preprocessing and compilation.
11584 @end table
11586 @node Assembler Options
11587 @section Passing Options to the Assembler
11589 @c prevent bad page break with this line
11590 You can pass options to the assembler.
11592 @table @gcctabopt
11593 @item -Wa,@var{option}
11594 @opindex Wa
11595 Pass @var{option} as an option to the assembler.  If @var{option}
11596 contains commas, it is split into multiple options at the commas.
11598 @item -Xassembler @var{option}
11599 @opindex Xassembler
11600 Pass @var{option} as an option to the assembler.  You can use this to
11601 supply system-specific assembler options that GCC does not
11602 recognize.
11604 If you want to pass an option that takes an argument, you must use
11605 @option{-Xassembler} twice, once for the option and once for the argument.
11607 @end table
11609 @node Link Options
11610 @section Options for Linking
11611 @cindex link options
11612 @cindex options, linking
11614 These options come into play when the compiler links object files into
11615 an executable output file.  They are meaningless if the compiler is
11616 not doing a link step.
11618 @table @gcctabopt
11619 @cindex file names
11620 @item @var{object-file-name}
11621 A file name that does not end in a special recognized suffix is
11622 considered to name an object file or library.  (Object files are
11623 distinguished from libraries by the linker according to the file
11624 contents.)  If linking is done, these object files are used as input
11625 to the linker.
11627 @item -c
11628 @itemx -S
11629 @itemx -E
11630 @opindex c
11631 @opindex S
11632 @opindex E
11633 If any of these options is used, then the linker is not run, and
11634 object file names should not be used as arguments.  @xref{Overall
11635 Options}.
11637 @item -fuse-ld=bfd
11638 @opindex fuse-ld=bfd
11639 Use the @command{bfd} linker instead of the default linker.
11641 @item -fuse-ld=gold
11642 @opindex fuse-ld=gold
11643 Use the @command{gold} linker instead of the default linker.
11645 @cindex Libraries
11646 @item -l@var{library}
11647 @itemx -l @var{library}
11648 @opindex l
11649 Search the library named @var{library} when linking.  (The second
11650 alternative with the library as a separate argument is only for
11651 POSIX compliance and is not recommended.)
11653 It makes a difference where in the command you write this option; the
11654 linker searches and processes libraries and object files in the order they
11655 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11656 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11657 to functions in @samp{z}, those functions may not be loaded.
11659 The linker searches a standard list of directories for the library,
11660 which is actually a file named @file{lib@var{library}.a}.  The linker
11661 then uses this file as if it had been specified precisely by name.
11663 The directories searched include several standard system directories
11664 plus any that you specify with @option{-L}.
11666 Normally the files found this way are library files---archive files
11667 whose members are object files.  The linker handles an archive file by
11668 scanning through it for members which define symbols that have so far
11669 been referenced but not defined.  But if the file that is found is an
11670 ordinary object file, it is linked in the usual fashion.  The only
11671 difference between using an @option{-l} option and specifying a file name
11672 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11673 and searches several directories.
11675 @item -lobjc
11676 @opindex lobjc
11677 You need this special case of the @option{-l} option in order to
11678 link an Objective-C or Objective-C++ program.
11680 @item -nostartfiles
11681 @opindex nostartfiles
11682 Do not use the standard system startup files when linking.
11683 The standard system libraries are used normally, unless @option{-nostdlib}
11684 or @option{-nodefaultlibs} is used.
11686 @item -nodefaultlibs
11687 @opindex nodefaultlibs
11688 Do not use the standard system libraries when linking.
11689 Only the libraries you specify are passed to the linker, and options
11690 specifying linkage of the system libraries, such as @option{-static-libgcc}
11691 or @option{-shared-libgcc}, are ignored.  
11692 The standard startup files are used normally, unless @option{-nostartfiles}
11693 is used.  
11695 The compiler may generate calls to @code{memcmp},
11696 @code{memset}, @code{memcpy} and @code{memmove}.
11697 These entries are usually resolved by entries in
11698 libc.  These entry points should be supplied through some other
11699 mechanism when this option is specified.
11701 @item -nostdlib
11702 @opindex nostdlib
11703 Do not use the standard system startup files or libraries when linking.
11704 No startup files and only the libraries you specify are passed to
11705 the linker, and options specifying linkage of the system libraries, such as
11706 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11708 The compiler may generate calls to @code{memcmp}, @code{memset},
11709 @code{memcpy} and @code{memmove}.
11710 These entries are usually resolved by entries in
11711 libc.  These entry points should be supplied through some other
11712 mechanism when this option is specified.
11714 @cindex @option{-lgcc}, use with @option{-nostdlib}
11715 @cindex @option{-nostdlib} and unresolved references
11716 @cindex unresolved references and @option{-nostdlib}
11717 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11718 @cindex @option{-nodefaultlibs} and unresolved references
11719 @cindex unresolved references and @option{-nodefaultlibs}
11720 One of the standard libraries bypassed by @option{-nostdlib} and
11721 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11722 which GCC uses to overcome shortcomings of particular machines, or special
11723 needs for some languages.
11724 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11725 Collection (GCC) Internals},
11726 for more discussion of @file{libgcc.a}.)
11727 In most cases, you need @file{libgcc.a} even when you want to avoid
11728 other standard libraries.  In other words, when you specify @option{-nostdlib}
11729 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11730 This ensures that you have no unresolved references to internal GCC
11731 library subroutines.
11732 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11733 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11734 GNU Compiler Collection (GCC) Internals}.)
11736 @item -pie
11737 @opindex pie
11738 Produce a position independent executable on targets that support it.
11739 For predictable results, you must also specify the same set of options
11740 used for compilation (@option{-fpie}, @option{-fPIE},
11741 or model suboptions) when you specify this linker option.
11743 @item -no-pie
11744 @opindex no-pie
11745 Don't produce a position independent executable.
11747 @item -pthread
11748 @opindex pthread
11749 Link with the POSIX threads library.  This option is supported on 
11750 GNU/Linux targets, most other Unix derivatives, and also on 
11751 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11752 flags for the preprocessor, so it should be used consistently for both
11753 compilation and linking.
11755 @item -rdynamic
11756 @opindex rdynamic
11757 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11758 that support it. This instructs the linker to add all symbols, not
11759 only used ones, to the dynamic symbol table. This option is needed
11760 for some uses of @code{dlopen} or to allow obtaining backtraces
11761 from within a program.
11763 @item -s
11764 @opindex s
11765 Remove all symbol table and relocation information from the executable.
11767 @item -static
11768 @opindex static
11769 On systems that support dynamic linking, this prevents linking with the shared
11770 libraries.  On other systems, this option has no effect.
11772 @item -shared
11773 @opindex shared
11774 Produce a shared object which can then be linked with other objects to
11775 form an executable.  Not all systems support this option.  For predictable
11776 results, you must also specify the same set of options used for compilation
11777 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11778 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11779 needs to build supplementary stub code for constructors to work.  On
11780 multi-libbed systems, @samp{gcc -shared} must select the correct support
11781 libraries to link against.  Failing to supply the correct flags may lead
11782 to subtle defects.  Supplying them in cases where they are not necessary
11783 is innocuous.}
11785 @item -shared-libgcc
11786 @itemx -static-libgcc
11787 @opindex shared-libgcc
11788 @opindex static-libgcc
11789 On systems that provide @file{libgcc} as a shared library, these options
11790 force the use of either the shared or static version, respectively.
11791 If no shared version of @file{libgcc} was built when the compiler was
11792 configured, these options have no effect.
11794 There are several situations in which an application should use the
11795 shared @file{libgcc} instead of the static version.  The most common
11796 of these is when the application wishes to throw and catch exceptions
11797 across different shared libraries.  In that case, each of the libraries
11798 as well as the application itself should use the shared @file{libgcc}.
11800 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11801  whenever you build a shared library or a main executable, because C++
11802  programs typically use exceptions, so this is the right thing to do.
11804 If, instead, you use the GCC driver to create shared libraries, you may
11805 find that they are not always linked with the shared @file{libgcc}.
11806 If GCC finds, at its configuration time, that you have a non-GNU linker
11807 or a GNU linker that does not support option @option{--eh-frame-hdr},
11808 it links the shared version of @file{libgcc} into shared libraries
11809 by default.  Otherwise, it takes advantage of the linker and optimizes
11810 away the linking with the shared version of @file{libgcc}, linking with
11811 the static version of libgcc by default.  This allows exceptions to
11812 propagate through such shared libraries, without incurring relocation
11813 costs at library load time.
11815 However, if a library or main executable is supposed to throw or catch
11816 exceptions, you must link it using the G++ driver, as appropriate
11817 for the languages used in the program, or using the option
11818 @option{-shared-libgcc}, such that it is linked with the shared
11819 @file{libgcc}.
11821 @item -static-libasan
11822 @opindex static-libasan
11823 When the @option{-fsanitize=address} option is used to link a program,
11824 the GCC driver automatically links against @option{libasan}.  If
11825 @file{libasan} is available as a shared library, and the @option{-static}
11826 option is not used, then this links against the shared version of
11827 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11828 driver to link @file{libasan} statically, without necessarily linking
11829 other libraries statically.
11831 @item -static-libtsan
11832 @opindex static-libtsan
11833 When the @option{-fsanitize=thread} option is used to link a program,
11834 the GCC driver automatically links against @option{libtsan}.  If
11835 @file{libtsan} is available as a shared library, and the @option{-static}
11836 option is not used, then this links against the shared version of
11837 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11838 driver to link @file{libtsan} statically, without necessarily linking
11839 other libraries statically.
11841 @item -static-liblsan
11842 @opindex static-liblsan
11843 When the @option{-fsanitize=leak} option is used to link a program,
11844 the GCC driver automatically links against @option{liblsan}.  If
11845 @file{liblsan} is available as a shared library, and the @option{-static}
11846 option is not used, then this links against the shared version of
11847 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11848 driver to link @file{liblsan} statically, without necessarily linking
11849 other libraries statically.
11851 @item -static-libubsan
11852 @opindex static-libubsan
11853 When the @option{-fsanitize=undefined} option is used to link a program,
11854 the GCC driver automatically links against @option{libubsan}.  If
11855 @file{libubsan} is available as a shared library, and the @option{-static}
11856 option is not used, then this links against the shared version of
11857 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11858 driver to link @file{libubsan} statically, without necessarily linking
11859 other libraries statically.
11861 @item -static-libmpx
11862 @opindex static-libmpx
11863 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11864 used to link a program, the GCC driver automatically links against
11865 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11866 and the @option{-static} option is not used, then this links against
11867 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11868 option directs the GCC driver to link @file{libmpx} statically,
11869 without necessarily linking other libraries statically.
11871 @item -static-libmpxwrappers
11872 @opindex static-libmpxwrappers
11873 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11874 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11875 GCC driver automatically links against @file{libmpxwrappers}.  If
11876 @file{libmpxwrappers} is available as a shared library, and the
11877 @option{-static} option is not used, then this links against the shared
11878 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11879 option directs the GCC driver to link @file{libmpxwrappers} statically,
11880 without necessarily linking other libraries statically.
11882 @item -static-libstdc++
11883 @opindex static-libstdc++
11884 When the @command{g++} program is used to link a C++ program, it
11885 normally automatically links against @option{libstdc++}.  If
11886 @file{libstdc++} is available as a shared library, and the
11887 @option{-static} option is not used, then this links against the
11888 shared version of @file{libstdc++}.  That is normally fine.  However, it
11889 is sometimes useful to freeze the version of @file{libstdc++} used by
11890 the program without going all the way to a fully static link.  The
11891 @option{-static-libstdc++} option directs the @command{g++} driver to
11892 link @file{libstdc++} statically, without necessarily linking other
11893 libraries statically.
11895 @item -symbolic
11896 @opindex symbolic
11897 Bind references to global symbols when building a shared object.  Warn
11898 about any unresolved references (unless overridden by the link editor
11899 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11900 this option.
11902 @item -T @var{script}
11903 @opindex T
11904 @cindex linker script
11905 Use @var{script} as the linker script.  This option is supported by most
11906 systems using the GNU linker.  On some targets, such as bare-board
11907 targets without an operating system, the @option{-T} option may be required
11908 when linking to avoid references to undefined symbols.
11910 @item -Xlinker @var{option}
11911 @opindex Xlinker
11912 Pass @var{option} as an option to the linker.  You can use this to
11913 supply system-specific linker options that GCC does not recognize.
11915 If you want to pass an option that takes a separate argument, you must use
11916 @option{-Xlinker} twice, once for the option and once for the argument.
11917 For example, to pass @option{-assert definitions}, you must write
11918 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11919 @option{-Xlinker "-assert definitions"}, because this passes the entire
11920 string as a single argument, which is not what the linker expects.
11922 When using the GNU linker, it is usually more convenient to pass
11923 arguments to linker options using the @option{@var{option}=@var{value}}
11924 syntax than as separate arguments.  For example, you can specify
11925 @option{-Xlinker -Map=output.map} rather than
11926 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11927 this syntax for command-line options.
11929 @item -Wl,@var{option}
11930 @opindex Wl
11931 Pass @var{option} as an option to the linker.  If @var{option} contains
11932 commas, it is split into multiple options at the commas.  You can use this
11933 syntax to pass an argument to the option.
11934 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11935 linker.  When using the GNU linker, you can also get the same effect with
11936 @option{-Wl,-Map=output.map}.
11938 @item -u @var{symbol}
11939 @opindex u
11940 Pretend the symbol @var{symbol} is undefined, to force linking of
11941 library modules to define it.  You can use @option{-u} multiple times with
11942 different symbols to force loading of additional library modules.
11944 @item -z @var{keyword}
11945 @opindex z
11946 @option{-z} is passed directly on to the linker along with the keyword
11947 @var{keyword}. See the section in the documentation of your linker for
11948 permitted values and their meanings.
11949 @end table
11951 @node Directory Options
11952 @section Options for Directory Search
11953 @cindex directory options
11954 @cindex options, directory search
11955 @cindex search path
11957 These options specify directories to search for header files, for
11958 libraries and for parts of the compiler:
11960 @table @gcctabopt
11961 @include cppdiropts.texi
11963 @item -iplugindir=@var{dir}
11964 @opindex iplugindir=
11965 Set the directory to search for plugins that are passed
11966 by @option{-fplugin=@var{name}} instead of
11967 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11968 to be used by the user, but only passed by the driver.
11970 @item -L@var{dir}
11971 @opindex L
11972 Add directory @var{dir} to the list of directories to be searched
11973 for @option{-l}.
11975 @item -B@var{prefix}
11976 @opindex B
11977 This option specifies where to find the executables, libraries,
11978 include files, and data files of the compiler itself.
11980 The compiler driver program runs one or more of the subprograms
11981 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11982 @var{prefix} as a prefix for each program it tries to run, both with and
11983 without @samp{@var{machine}/@var{version}/} for the corresponding target
11984 machine and compiler version.
11986 For each subprogram to be run, the compiler driver first tries the
11987 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11988 is not specified, the driver tries two standard prefixes, 
11989 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11990 those results in a file name that is found, the unmodified program
11991 name is searched for using the directories specified in your
11992 @env{PATH} environment variable.
11994 The compiler checks to see if the path provided by @option{-B}
11995 refers to a directory, and if necessary it adds a directory
11996 separator character at the end of the path.
11998 @option{-B} prefixes that effectively specify directory names also apply
11999 to libraries in the linker, because the compiler translates these
12000 options into @option{-L} options for the linker.  They also apply to
12001 include files in the preprocessor, because the compiler translates these
12002 options into @option{-isystem} options for the preprocessor.  In this case,
12003 the compiler appends @samp{include} to the prefix.
12005 The runtime support file @file{libgcc.a} can also be searched for using
12006 the @option{-B} prefix, if needed.  If it is not found there, the two
12007 standard prefixes above are tried, and that is all.  The file is left
12008 out of the link if it is not found by those means.
12010 Another way to specify a prefix much like the @option{-B} prefix is to use
12011 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12012 Variables}.
12014 As a special kludge, if the path provided by @option{-B} is
12015 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12016 9, then it is replaced by @file{[dir/]include}.  This is to help
12017 with boot-strapping the compiler.
12019 @item -no-canonical-prefixes
12020 @opindex no-canonical-prefixes
12021 Do not expand any symbolic links, resolve references to @samp{/../}
12022 or @samp{/./}, or make the path absolute when generating a relative
12023 prefix.
12025 @item --sysroot=@var{dir}
12026 @opindex sysroot
12027 Use @var{dir} as the logical root directory for headers and libraries.
12028 For example, if the compiler normally searches for headers in
12029 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12030 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12032 If you use both this option and the @option{-isysroot} option, then
12033 the @option{--sysroot} option applies to libraries, but the
12034 @option{-isysroot} option applies to header files.
12036 The GNU linker (beginning with version 2.16) has the necessary support
12037 for this option.  If your linker does not support this option, the
12038 header file aspect of @option{--sysroot} still works, but the
12039 library aspect does not.
12041 @item --no-sysroot-suffix
12042 @opindex no-sysroot-suffix
12043 For some targets, a suffix is added to the root directory specified
12044 with @option{--sysroot}, depending on the other options used, so that
12045 headers may for example be found in
12046 @file{@var{dir}/@var{suffix}/usr/include} instead of
12047 @file{@var{dir}/usr/include}.  This option disables the addition of
12048 such a suffix.
12050 @end table
12052 @node Code Gen Options
12053 @section Options for Code Generation Conventions
12054 @cindex code generation conventions
12055 @cindex options, code generation
12056 @cindex run-time options
12058 These machine-independent options control the interface conventions
12059 used in code generation.
12061 Most of them have both positive and negative forms; the negative form
12062 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12063 one of the forms is listed---the one that is not the default.  You
12064 can figure out the other form by either removing @samp{no-} or adding
12067 @table @gcctabopt
12068 @item -fstack-reuse=@var{reuse-level}
12069 @opindex fstack_reuse
12070 This option controls stack space reuse for user declared local/auto variables
12071 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12072 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12073 local variables and temporaries, @samp{named_vars} enables the reuse only for
12074 user defined local variables with names, and @samp{none} disables stack reuse
12075 completely. The default value is @samp{all}. The option is needed when the
12076 program extends the lifetime of a scoped local variable or a compiler generated
12077 temporary beyond the end point defined by the language.  When a lifetime of
12078 a variable ends, and if the variable lives in memory, the optimizing compiler
12079 has the freedom to reuse its stack space with other temporaries or scoped
12080 local variables whose live range does not overlap with it. Legacy code extending
12081 local lifetime is likely to break with the stack reuse optimization.
12083 For example,
12085 @smallexample
12086    int *p;
12087    @{
12088      int local1;
12090      p = &local1;
12091      local1 = 10;
12092      ....
12093    @}
12094    @{
12095       int local2;
12096       local2 = 20;
12097       ...
12098    @}
12100    if (*p == 10)  // out of scope use of local1
12101      @{
12103      @}
12104 @end smallexample
12106 Another example:
12107 @smallexample
12109    struct A
12110    @{
12111        A(int k) : i(k), j(k) @{ @}
12112        int i;
12113        int j;
12114    @};
12116    A *ap;
12118    void foo(const A& ar)
12119    @{
12120       ap = &ar;
12121    @}
12123    void bar()
12124    @{
12125       foo(A(10)); // temp object's lifetime ends when foo returns
12127       @{
12128         A a(20);
12129         ....
12130       @}
12131       ap->i+= 10;  // ap references out of scope temp whose space
12132                    // is reused with a. What is the value of ap->i?
12133    @}
12135 @end smallexample
12137 The lifetime of a compiler generated temporary is well defined by the C++
12138 standard. When a lifetime of a temporary ends, and if the temporary lives
12139 in memory, the optimizing compiler has the freedom to reuse its stack
12140 space with other temporaries or scoped local variables whose live range
12141 does not overlap with it. However some of the legacy code relies on
12142 the behavior of older compilers in which temporaries' stack space is
12143 not reused, the aggressive stack reuse can lead to runtime errors. This
12144 option is used to control the temporary stack reuse optimization.
12146 @item -ftrapv
12147 @opindex ftrapv
12148 This option generates traps for signed overflow on addition, subtraction,
12149 multiplication operations.
12150 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12151 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12152 @option{-fwrapv} being effective.  Note that only active options override, so
12153 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12154 results in @option{-ftrapv} being effective.
12156 @item -fwrapv
12157 @opindex fwrapv
12158 This option instructs the compiler to assume that signed arithmetic
12159 overflow of addition, subtraction and multiplication wraps around
12160 using twos-complement representation.  This flag enables some optimizations
12161 and disables others.
12162 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12163 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12164 @option{-fwrapv} being effective.  Note that only active options override, so
12165 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12166 results in @option{-ftrapv} being effective.
12168 @item -fexceptions
12169 @opindex fexceptions
12170 Enable exception handling.  Generates extra code needed to propagate
12171 exceptions.  For some targets, this implies GCC generates frame
12172 unwind information for all functions, which can produce significant data
12173 size overhead, although it does not affect execution.  If you do not
12174 specify this option, GCC enables it by default for languages like
12175 C++ that normally require exception handling, and disables it for
12176 languages like C that do not normally require it.  However, you may need
12177 to enable this option when compiling C code that needs to interoperate
12178 properly with exception handlers written in C++.  You may also wish to
12179 disable this option if you are compiling older C++ programs that don't
12180 use exception handling.
12182 @item -fnon-call-exceptions
12183 @opindex fnon-call-exceptions
12184 Generate code that allows trapping instructions to throw exceptions.
12185 Note that this requires platform-specific runtime support that does
12186 not exist everywhere.  Moreover, it only allows @emph{trapping}
12187 instructions to throw exceptions, i.e.@: memory references or floating-point
12188 instructions.  It does not allow exceptions to be thrown from
12189 arbitrary signal handlers such as @code{SIGALRM}.
12191 @item -fdelete-dead-exceptions
12192 @opindex fdelete-dead-exceptions
12193 Consider that instructions that may throw exceptions but don't otherwise
12194 contribute to the execution of the program can be optimized away.
12195 This option is enabled by default for the Ada front end, as permitted by
12196 the Ada language specification.
12197 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12199 @item -funwind-tables
12200 @opindex funwind-tables
12201 Similar to @option{-fexceptions}, except that it just generates any needed
12202 static data, but does not affect the generated code in any other way.
12203 You normally do not need to enable this option; instead, a language processor
12204 that needs this handling enables it on your behalf.
12206 @item -fasynchronous-unwind-tables
12207 @opindex fasynchronous-unwind-tables
12208 Generate unwind table in DWARF format, if supported by target machine.  The
12209 table is exact at each instruction boundary, so it can be used for stack
12210 unwinding from asynchronous events (such as debugger or garbage collector).
12212 @item -fno-gnu-unique
12213 @opindex fno-gnu-unique
12214 On systems with recent GNU assembler and C library, the C++ compiler
12215 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12216 of template static data members and static local variables in inline
12217 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12218 is necessary to avoid problems with a library used by two different
12219 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12220 therefore disagreeing with the other one about the binding of the
12221 symbol.  But this causes @code{dlclose} to be ignored for affected
12222 DSOs; if your program relies on reinitialization of a DSO via
12223 @code{dlclose} and @code{dlopen}, you can use
12224 @option{-fno-gnu-unique}.
12226 @item -fpcc-struct-return
12227 @opindex fpcc-struct-return
12228 Return ``short'' @code{struct} and @code{union} values in memory like
12229 longer ones, rather than in registers.  This convention is less
12230 efficient, but it has the advantage of allowing intercallability between
12231 GCC-compiled files and files compiled with other compilers, particularly
12232 the Portable C Compiler (pcc).
12234 The precise convention for returning structures in memory depends
12235 on the target configuration macros.
12237 Short structures and unions are those whose size and alignment match
12238 that of some integer type.
12240 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12241 switch is not binary compatible with code compiled with the
12242 @option{-freg-struct-return} switch.
12243 Use it to conform to a non-default application binary interface.
12245 @item -freg-struct-return
12246 @opindex freg-struct-return
12247 Return @code{struct} and @code{union} values in registers when possible.
12248 This is more efficient for small structures than
12249 @option{-fpcc-struct-return}.
12251 If you specify neither @option{-fpcc-struct-return} nor
12252 @option{-freg-struct-return}, GCC defaults to whichever convention is
12253 standard for the target.  If there is no standard convention, GCC
12254 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12255 the principal compiler.  In those cases, we can choose the standard, and
12256 we chose the more efficient register return alternative.
12258 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12259 switch is not binary compatible with code compiled with the
12260 @option{-fpcc-struct-return} switch.
12261 Use it to conform to a non-default application binary interface.
12263 @item -fshort-enums
12264 @opindex fshort-enums
12265 Allocate to an @code{enum} type only as many bytes as it needs for the
12266 declared range of possible values.  Specifically, the @code{enum} type
12267 is equivalent to the smallest integer type that has enough room.
12269 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12270 code that is not binary compatible with code generated without that switch.
12271 Use it to conform to a non-default application binary interface.
12273 @item -fshort-wchar
12274 @opindex fshort-wchar
12275 Override the underlying type for @code{wchar_t} to be @code{short
12276 unsigned int} instead of the default for the target.  This option is
12277 useful for building programs to run under WINE@.
12279 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12280 code that is not binary compatible with code generated without that switch.
12281 Use it to conform to a non-default application binary interface.
12283 @item -fno-common
12284 @opindex fno-common
12285 @cindex tentative definitions
12286 In C code, this option controls the placement of global variables 
12287 defined without an initializer, known as @dfn{tentative definitions} 
12288 in the C standard.  Tentative definitions are distinct from declarations 
12289 of a variable with the @code{extern} keyword, which do not allocate storage.
12291 Unix C compilers have traditionally allocated storage for
12292 uninitialized global variables in a common block.  This allows the
12293 linker to resolve all tentative definitions of the same variable
12294 in different compilation units to the same object, or to a non-tentative
12295 definition.  
12296 This is the behavior specified by @option{-fcommon}, and is the default for 
12297 GCC on most targets.  
12298 On the other hand, this behavior is not required by ISO
12299 C, and on some targets may carry a speed or code size penalty on
12300 variable references.
12302 The @option{-fno-common} option specifies that the compiler should instead
12303 place uninitialized global variables in the data section of the object file.
12304 This inhibits the merging of tentative definitions by the linker so
12305 you get a multiple-definition error if the same 
12306 variable is defined in more than one compilation unit.
12307 Compiling with @option{-fno-common} is useful on targets for which
12308 it provides better performance, or if you wish to verify that the
12309 program will work on other systems that always treat uninitialized
12310 variable definitions this way.
12312 @item -fno-ident
12313 @opindex fno-ident
12314 Ignore the @code{#ident} directive.
12316 @item -finhibit-size-directive
12317 @opindex finhibit-size-directive
12318 Don't output a @code{.size} assembler directive, or anything else that
12319 would cause trouble if the function is split in the middle, and the
12320 two halves are placed at locations far apart in memory.  This option is
12321 used when compiling @file{crtstuff.c}; you should not need to use it
12322 for anything else.
12324 @item -fverbose-asm
12325 @opindex fverbose-asm
12326 Put extra commentary information in the generated assembly code to
12327 make it more readable.  This option is generally only of use to those
12328 who actually need to read the generated assembly code (perhaps while
12329 debugging the compiler itself).
12331 @option{-fno-verbose-asm}, the default, causes the
12332 extra information to be omitted and is useful when comparing two assembler
12333 files.
12335 The added comments include:
12337 @itemize @bullet
12339 @item
12340 information on the compiler version and command-line options,
12342 @item
12343 the source code lines associated with the assembly instructions,
12344 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12346 @item
12347 hints on which high-level expressions correspond to
12348 the various assembly instruction operands.
12350 @end itemize
12352 For example, given this C source file:
12354 @smallexample
12355 int test (int n)
12357   int i;
12358   int total = 0;
12360   for (i = 0; i < n; i++)
12361     total += i * i;
12363   return total;
12365 @end smallexample
12367 compiling to (x86_64) assembly via @option{-S} and emitting the result
12368 direct to stdout via @option{-o} @option{-}
12370 @smallexample
12371 gcc -S test.c -fverbose-asm -Os -o -
12372 @end smallexample
12374 gives output similar to this:
12376 @smallexample
12377         .file   "test.c"
12378 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12379   [...snip...]
12380 # options passed:
12381   [...snip...]
12383         .text
12384         .globl  test
12385         .type   test, @@function
12386 test:
12387 .LFB0:
12388         .cfi_startproc
12389 # test.c:4:   int total = 0;
12390         xorl    %eax, %eax      # <retval>
12391 # test.c:6:   for (i = 0; i < n; i++)
12392         xorl    %edx, %edx      # i
12393 .L2:
12394 # test.c:6:   for (i = 0; i < n; i++)
12395         cmpl    %edi, %edx      # n, i
12396         jge     .L5     #,
12397 # test.c:7:     total += i * i;
12398         movl    %edx, %ecx      # i, tmp92
12399         imull   %edx, %ecx      # i, tmp92
12400 # test.c:6:   for (i = 0; i < n; i++)
12401         incl    %edx    # i
12402 # test.c:7:     total += i * i;
12403         addl    %ecx, %eax      # tmp92, <retval>
12404         jmp     .L2     #
12405 .L5:
12406 # test.c:10: @}
12407         ret
12408         .cfi_endproc
12409 .LFE0:
12410         .size   test, .-test
12411         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12412         .section        .note.GNU-stack,"",@@progbits
12413 @end smallexample
12415 The comments are intended for humans rather than machines and hence the
12416 precise format of the comments is subject to change.
12418 @item -frecord-gcc-switches
12419 @opindex frecord-gcc-switches
12420 This switch causes the command line used to invoke the
12421 compiler to be recorded into the object file that is being created.
12422 This switch is only implemented on some targets and the exact format
12423 of the recording is target and binary file format dependent, but it
12424 usually takes the form of a section containing ASCII text.  This
12425 switch is related to the @option{-fverbose-asm} switch, but that
12426 switch only records information in the assembler output file as
12427 comments, so it never reaches the object file.
12428 See also @option{-grecord-gcc-switches} for another
12429 way of storing compiler options into the object file.
12431 @item -fpic
12432 @opindex fpic
12433 @cindex global offset table
12434 @cindex PIC
12435 Generate position-independent code (PIC) suitable for use in a shared
12436 library, if supported for the target machine.  Such code accesses all
12437 constant addresses through a global offset table (GOT)@.  The dynamic
12438 loader resolves the GOT entries when the program starts (the dynamic
12439 loader is not part of GCC; it is part of the operating system).  If
12440 the GOT size for the linked executable exceeds a machine-specific
12441 maximum size, you get an error message from the linker indicating that
12442 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12443 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12444 on the m68k and RS/6000.  The x86 has no such limit.)
12446 Position-independent code requires special support, and therefore works
12447 only on certain machines.  For the x86, GCC supports PIC for System V
12448 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12449 position-independent.
12451 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12452 are defined to 1.
12454 @item -fPIC
12455 @opindex fPIC
12456 If supported for the target machine, emit position-independent code,
12457 suitable for dynamic linking and avoiding any limit on the size of the
12458 global offset table.  This option makes a difference on AArch64, m68k,
12459 PowerPC and SPARC@.
12461 Position-independent code requires special support, and therefore works
12462 only on certain machines.
12464 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12465 are defined to 2.
12467 @item -fpie
12468 @itemx -fPIE
12469 @opindex fpie
12470 @opindex fPIE
12471 These options are similar to @option{-fpic} and @option{-fPIC}, but
12472 generated position independent code can be only linked into executables.
12473 Usually these options are used when @option{-pie} GCC option is
12474 used during linking.
12476 @option{-fpie} and @option{-fPIE} both define the macros
12477 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12478 for @option{-fpie} and 2 for @option{-fPIE}.
12480 @item -fno-plt
12481 @opindex fno-plt
12482 Do not use the PLT for external function calls in position-independent code.
12483 Instead, load the callee address at call sites from the GOT and branch to it.
12484 This leads to more efficient code by eliminating PLT stubs and exposing
12485 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12486 PLT stubs expect the GOT pointer in a specific register, this gives more
12487 register allocation freedom to the compiler.
12488 Lazy binding requires use of the PLT; 
12489 with @option{-fno-plt} all external symbols are resolved at load time.
12491 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12492 through the PLT for specific external functions.
12494 In position-dependent code, a few targets also convert calls to
12495 functions that are marked to not use the PLT to use the GOT instead.
12497 @item -fno-jump-tables
12498 @opindex fno-jump-tables
12499 Do not use jump tables for switch statements even where it would be
12500 more efficient than other code generation strategies.  This option is
12501 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12502 building code that forms part of a dynamic linker and cannot
12503 reference the address of a jump table.  On some targets, jump tables
12504 do not require a GOT and this option is not needed.
12506 @item -ffixed-@var{reg}
12507 @opindex ffixed
12508 Treat the register named @var{reg} as a fixed register; generated code
12509 should never refer to it (except perhaps as a stack pointer, frame
12510 pointer or in some other fixed role).
12512 @var{reg} must be the name of a register.  The register names accepted
12513 are machine-specific and are defined in the @code{REGISTER_NAMES}
12514 macro in the machine description macro file.
12516 This flag does not have a negative form, because it specifies a
12517 three-way choice.
12519 @item -fcall-used-@var{reg}
12520 @opindex fcall-used
12521 Treat the register named @var{reg} as an allocable register that is
12522 clobbered by function calls.  It may be allocated for temporaries or
12523 variables that do not live across a call.  Functions compiled this way
12524 do not save and restore the register @var{reg}.
12526 It is an error to use this flag with the frame pointer or stack pointer.
12527 Use of this flag for other registers that have fixed pervasive roles in
12528 the machine's execution model produces disastrous results.
12530 This flag does not have a negative form, because it specifies a
12531 three-way choice.
12533 @item -fcall-saved-@var{reg}
12534 @opindex fcall-saved
12535 Treat the register named @var{reg} as an allocable register saved by
12536 functions.  It may be allocated even for temporaries or variables that
12537 live across a call.  Functions compiled this way save and restore
12538 the register @var{reg} if they use it.
12540 It is an error to use this flag with the frame pointer or stack pointer.
12541 Use of this flag for other registers that have fixed pervasive roles in
12542 the machine's execution model produces disastrous results.
12544 A different sort of disaster results from the use of this flag for
12545 a register in which function values may be returned.
12547 This flag does not have a negative form, because it specifies a
12548 three-way choice.
12550 @item -fpack-struct[=@var{n}]
12551 @opindex fpack-struct
12552 Without a value specified, pack all structure members together without
12553 holes.  When a value is specified (which must be a small power of two), pack
12554 structure members according to this value, representing the maximum
12555 alignment (that is, objects with default alignment requirements larger than
12556 this are output potentially unaligned at the next fitting location.
12558 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12559 code that is not binary compatible with code generated without that switch.
12560 Additionally, it makes the code suboptimal.
12561 Use it to conform to a non-default application binary interface.
12563 @item -fleading-underscore
12564 @opindex fleading-underscore
12565 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12566 change the way C symbols are represented in the object file.  One use
12567 is to help link with legacy assembly code.
12569 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12570 generate code that is not binary compatible with code generated without that
12571 switch.  Use it to conform to a non-default application binary interface.
12572 Not all targets provide complete support for this switch.
12574 @item -ftls-model=@var{model}
12575 @opindex ftls-model
12576 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12577 The @var{model} argument should be one of @samp{global-dynamic},
12578 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12579 Note that the choice is subject to optimization: the compiler may use
12580 a more efficient model for symbols not visible outside of the translation
12581 unit, or if @option{-fpic} is not given on the command line.
12583 The default without @option{-fpic} is @samp{initial-exec}; with
12584 @option{-fpic} the default is @samp{global-dynamic}.
12586 @item -ftrampolines
12587 @opindex ftrampolines
12588 For targets that normally need trampolines for nested functions, always
12589 generate them instead of using descriptors.  Otherwise, for targets that
12590 do not need them, like for example HP-PA or IA-64, do nothing.
12592 A trampoline is a small piece of code that is created at run time on the
12593 stack when the address of a nested function is taken, and is used to call
12594 the nested function indirectly.  Therefore, it requires the stack to be
12595 made executable in order for the program to work properly.
12597 @option{-fno-trampolines} is enabled by default on a language by language
12598 basis to let the compiler avoid generating them, if it computes that this
12599 is safe, and replace them with descriptors.  Descriptors are made up of data
12600 only, but the generated code must be prepared to deal with them.  As of this
12601 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12603 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12604 @option{-fno-trampolines} are not binary compatible if nested functions are
12605 present.  This option must therefore be used on a program-wide basis and be
12606 manipulated with extreme care.
12608 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12609 @opindex fvisibility
12610 Set the default ELF image symbol visibility to the specified option---all
12611 symbols are marked with this unless overridden within the code.
12612 Using this feature can very substantially improve linking and
12613 load times of shared object libraries, produce more optimized
12614 code, provide near-perfect API export and prevent symbol clashes.
12615 It is @strong{strongly} recommended that you use this in any shared objects
12616 you distribute.
12618 Despite the nomenclature, @samp{default} always means public; i.e.,
12619 available to be linked against from outside the shared object.
12620 @samp{protected} and @samp{internal} are pretty useless in real-world
12621 usage so the only other commonly used option is @samp{hidden}.
12622 The default if @option{-fvisibility} isn't specified is
12623 @samp{default}, i.e., make every symbol public.
12625 A good explanation of the benefits offered by ensuring ELF
12626 symbols have the correct visibility is given by ``How To Write
12627 Shared Libraries'' by Ulrich Drepper (which can be found at
12628 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12629 solution made possible by this option to marking things hidden when
12630 the default is public is to make the default hidden and mark things
12631 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12632 and @code{__attribute__ ((visibility("default")))} instead of
12633 @code{__declspec(dllexport)} you get almost identical semantics with
12634 identical syntax.  This is a great boon to those working with
12635 cross-platform projects.
12637 For those adding visibility support to existing code, you may find
12638 @code{#pragma GCC visibility} of use.  This works by you enclosing
12639 the declarations you wish to set visibility for with (for example)
12640 @code{#pragma GCC visibility push(hidden)} and
12641 @code{#pragma GCC visibility pop}.
12642 Bear in mind that symbol visibility should be viewed @strong{as
12643 part of the API interface contract} and thus all new code should
12644 always specify visibility when it is not the default; i.e., declarations
12645 only for use within the local DSO should @strong{always} be marked explicitly
12646 as hidden as so to avoid PLT indirection overheads---making this
12647 abundantly clear also aids readability and self-documentation of the code.
12648 Note that due to ISO C++ specification requirements, @code{operator new} and
12649 @code{operator delete} must always be of default visibility.
12651 Be aware that headers from outside your project, in particular system
12652 headers and headers from any other library you use, may not be
12653 expecting to be compiled with visibility other than the default.  You
12654 may need to explicitly say @code{#pragma GCC visibility push(default)}
12655 before including any such headers.
12657 @code{extern} declarations are not affected by @option{-fvisibility}, so
12658 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12659 no modifications.  However, this means that calls to @code{extern}
12660 functions with no explicit visibility use the PLT, so it is more
12661 effective to use @code{__attribute ((visibility))} and/or
12662 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12663 declarations should be treated as hidden.
12665 Note that @option{-fvisibility} does affect C++ vague linkage
12666 entities. This means that, for instance, an exception class that is
12667 be thrown between DSOs must be explicitly marked with default
12668 visibility so that the @samp{type_info} nodes are unified between
12669 the DSOs.
12671 An overview of these techniques, their benefits and how to use them
12672 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12674 @item -fstrict-volatile-bitfields
12675 @opindex fstrict-volatile-bitfields
12676 This option should be used if accesses to volatile bit-fields (or other
12677 structure fields, although the compiler usually honors those types
12678 anyway) should use a single access of the width of the
12679 field's type, aligned to a natural alignment if possible.  For
12680 example, targets with memory-mapped peripheral registers might require
12681 all such accesses to be 16 bits wide; with this flag you can
12682 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12683 is 16 bits on these targets) to force GCC to use 16-bit accesses
12684 instead of, perhaps, a more efficient 32-bit access.
12686 If this option is disabled, the compiler uses the most efficient
12687 instruction.  In the previous example, that might be a 32-bit load
12688 instruction, even though that accesses bytes that do not contain
12689 any portion of the bit-field, or memory-mapped registers unrelated to
12690 the one being updated.
12692 In some cases, such as when the @code{packed} attribute is applied to a 
12693 structure field, it may not be possible to access the field with a single
12694 read or write that is correctly aligned for the target machine.  In this
12695 case GCC falls back to generating multiple accesses rather than code that 
12696 will fault or truncate the result at run time.
12698 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12699 not allowed to touch non bit-field members.  It is therefore recommended
12700 to define all bits of the field's type as bit-field members.
12702 The default value of this option is determined by the application binary
12703 interface for the target processor.
12705 @item -fsync-libcalls
12706 @opindex fsync-libcalls
12707 This option controls whether any out-of-line instance of the @code{__sync}
12708 family of functions may be used to implement the C++11 @code{__atomic}
12709 family of functions.
12711 The default value of this option is enabled, thus the only useful form
12712 of the option is @option{-fno-sync-libcalls}.  This option is used in
12713 the implementation of the @file{libatomic} runtime library.
12715 @end table
12717 @node Developer Options
12718 @section GCC Developer Options
12719 @cindex developer options
12720 @cindex debugging GCC
12721 @cindex debug dump options
12722 @cindex dump options
12723 @cindex compilation statistics
12725 This section describes command-line options that are primarily of
12726 interest to GCC developers, including options to support compiler
12727 testing and investigation of compiler bugs and compile-time
12728 performance problems.  This includes options that produce debug dumps
12729 at various points in the compilation; that print statistics such as
12730 memory use and execution time; and that print information about GCC's
12731 configuration, such as where it searches for libraries.  You should
12732 rarely need to use any of these options for ordinary compilation and
12733 linking tasks.
12735 @table @gcctabopt
12737 @item -d@var{letters}
12738 @itemx -fdump-rtl-@var{pass}
12739 @itemx -fdump-rtl-@var{pass}=@var{filename}
12740 @opindex d
12741 @opindex fdump-rtl-@var{pass}
12742 Says to make debugging dumps during compilation at times specified by
12743 @var{letters}.  This is used for debugging the RTL-based passes of the
12744 compiler.  The file names for most of the dumps are made by appending
12745 a pass number and a word to the @var{dumpname}, and the files are
12746 created in the directory of the output file.  In case of
12747 @option{=@var{filename}} option, the dump is output on the given file
12748 instead of the pass numbered dump files.  Note that the pass number is
12749 assigned as passes are registered into the pass manager.  Most passes
12750 are registered in the order that they will execute and for these passes
12751 the number corresponds to the pass execution order.  However, passes
12752 registered by plugins, passes specific to compilation targets, or
12753 passes that are otherwise registered after all the other passes are
12754 numbered higher than a pass named "final", even if they are executed
12755 earlier.  @var{dumpname} is generated from the name of the output
12756 file if explicitly specified and not an executable, otherwise it is
12757 the basename of the source file.  
12759 Some @option{-d@var{letters}} switches have different meaning when
12760 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12761 for information about preprocessor-specific dump options.
12763 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12764 @option{-d} option @var{letters}.  Here are the possible
12765 letters for use in @var{pass} and @var{letters}, and their meanings:
12767 @table @gcctabopt
12769 @item -fdump-rtl-alignments
12770 @opindex fdump-rtl-alignments
12771 Dump after branch alignments have been computed.
12773 @item -fdump-rtl-asmcons
12774 @opindex fdump-rtl-asmcons
12775 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12777 @item -fdump-rtl-auto_inc_dec
12778 @opindex fdump-rtl-auto_inc_dec
12779 Dump after auto-inc-dec discovery.  This pass is only run on
12780 architectures that have auto inc or auto dec instructions.
12782 @item -fdump-rtl-barriers
12783 @opindex fdump-rtl-barriers
12784 Dump after cleaning up the barrier instructions.
12786 @item -fdump-rtl-bbpart
12787 @opindex fdump-rtl-bbpart
12788 Dump after partitioning hot and cold basic blocks.
12790 @item -fdump-rtl-bbro
12791 @opindex fdump-rtl-bbro
12792 Dump after block reordering.
12794 @item -fdump-rtl-btl1
12795 @itemx -fdump-rtl-btl2
12796 @opindex fdump-rtl-btl2
12797 @opindex fdump-rtl-btl2
12798 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12799 after the two branch
12800 target load optimization passes.
12802 @item -fdump-rtl-bypass
12803 @opindex fdump-rtl-bypass
12804 Dump after jump bypassing and control flow optimizations.
12806 @item -fdump-rtl-combine
12807 @opindex fdump-rtl-combine
12808 Dump after the RTL instruction combination pass.
12810 @item -fdump-rtl-compgotos
12811 @opindex fdump-rtl-compgotos
12812 Dump after duplicating the computed gotos.
12814 @item -fdump-rtl-ce1
12815 @itemx -fdump-rtl-ce2
12816 @itemx -fdump-rtl-ce3
12817 @opindex fdump-rtl-ce1
12818 @opindex fdump-rtl-ce2
12819 @opindex fdump-rtl-ce3
12820 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12821 @option{-fdump-rtl-ce3} enable dumping after the three
12822 if conversion passes.
12824 @item -fdump-rtl-cprop_hardreg
12825 @opindex fdump-rtl-cprop_hardreg
12826 Dump after hard register copy propagation.
12828 @item -fdump-rtl-csa
12829 @opindex fdump-rtl-csa
12830 Dump after combining stack adjustments.
12832 @item -fdump-rtl-cse1
12833 @itemx -fdump-rtl-cse2
12834 @opindex fdump-rtl-cse1
12835 @opindex fdump-rtl-cse2
12836 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12837 the two common subexpression elimination passes.
12839 @item -fdump-rtl-dce
12840 @opindex fdump-rtl-dce
12841 Dump after the standalone dead code elimination passes.
12843 @item -fdump-rtl-dbr
12844 @opindex fdump-rtl-dbr
12845 Dump after delayed branch scheduling.
12847 @item -fdump-rtl-dce1
12848 @itemx -fdump-rtl-dce2
12849 @opindex fdump-rtl-dce1
12850 @opindex fdump-rtl-dce2
12851 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12852 the two dead store elimination passes.
12854 @item -fdump-rtl-eh
12855 @opindex fdump-rtl-eh
12856 Dump after finalization of EH handling code.
12858 @item -fdump-rtl-eh_ranges
12859 @opindex fdump-rtl-eh_ranges
12860 Dump after conversion of EH handling range regions.
12862 @item -fdump-rtl-expand
12863 @opindex fdump-rtl-expand
12864 Dump after RTL generation.
12866 @item -fdump-rtl-fwprop1
12867 @itemx -fdump-rtl-fwprop2
12868 @opindex fdump-rtl-fwprop1
12869 @opindex fdump-rtl-fwprop2
12870 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12871 dumping after the two forward propagation passes.
12873 @item -fdump-rtl-gcse1
12874 @itemx -fdump-rtl-gcse2
12875 @opindex fdump-rtl-gcse1
12876 @opindex fdump-rtl-gcse2
12877 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12878 after global common subexpression elimination.
12880 @item -fdump-rtl-init-regs
12881 @opindex fdump-rtl-init-regs
12882 Dump after the initialization of the registers.
12884 @item -fdump-rtl-initvals
12885 @opindex fdump-rtl-initvals
12886 Dump after the computation of the initial value sets.
12888 @item -fdump-rtl-into_cfglayout
12889 @opindex fdump-rtl-into_cfglayout
12890 Dump after converting to cfglayout mode.
12892 @item -fdump-rtl-ira
12893 @opindex fdump-rtl-ira
12894 Dump after iterated register allocation.
12896 @item -fdump-rtl-jump
12897 @opindex fdump-rtl-jump
12898 Dump after the second jump optimization.
12900 @item -fdump-rtl-loop2
12901 @opindex fdump-rtl-loop2
12902 @option{-fdump-rtl-loop2} enables dumping after the rtl
12903 loop optimization passes.
12905 @item -fdump-rtl-mach
12906 @opindex fdump-rtl-mach
12907 Dump after performing the machine dependent reorganization pass, if that
12908 pass exists.
12910 @item -fdump-rtl-mode_sw
12911 @opindex fdump-rtl-mode_sw
12912 Dump after removing redundant mode switches.
12914 @item -fdump-rtl-rnreg
12915 @opindex fdump-rtl-rnreg
12916 Dump after register renumbering.
12918 @item -fdump-rtl-outof_cfglayout
12919 @opindex fdump-rtl-outof_cfglayout
12920 Dump after converting from cfglayout mode.
12922 @item -fdump-rtl-peephole2
12923 @opindex fdump-rtl-peephole2
12924 Dump after the peephole pass.
12926 @item -fdump-rtl-postreload
12927 @opindex fdump-rtl-postreload
12928 Dump after post-reload optimizations.
12930 @item -fdump-rtl-pro_and_epilogue
12931 @opindex fdump-rtl-pro_and_epilogue
12932 Dump after generating the function prologues and epilogues.
12934 @item -fdump-rtl-sched1
12935 @itemx -fdump-rtl-sched2
12936 @opindex fdump-rtl-sched1
12937 @opindex fdump-rtl-sched2
12938 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12939 after the basic block scheduling passes.
12941 @item -fdump-rtl-ree
12942 @opindex fdump-rtl-ree
12943 Dump after sign/zero extension elimination.
12945 @item -fdump-rtl-seqabstr
12946 @opindex fdump-rtl-seqabstr
12947 Dump after common sequence discovery.
12949 @item -fdump-rtl-shorten
12950 @opindex fdump-rtl-shorten
12951 Dump after shortening branches.
12953 @item -fdump-rtl-sibling
12954 @opindex fdump-rtl-sibling
12955 Dump after sibling call optimizations.
12957 @item -fdump-rtl-split1
12958 @itemx -fdump-rtl-split2
12959 @itemx -fdump-rtl-split3
12960 @itemx -fdump-rtl-split4
12961 @itemx -fdump-rtl-split5
12962 @opindex fdump-rtl-split1
12963 @opindex fdump-rtl-split2
12964 @opindex fdump-rtl-split3
12965 @opindex fdump-rtl-split4
12966 @opindex fdump-rtl-split5
12967 These options enable dumping after five rounds of
12968 instruction splitting.
12970 @item -fdump-rtl-sms
12971 @opindex fdump-rtl-sms
12972 Dump after modulo scheduling.  This pass is only run on some
12973 architectures.
12975 @item -fdump-rtl-stack
12976 @opindex fdump-rtl-stack
12977 Dump after conversion from GCC's ``flat register file'' registers to the
12978 x87's stack-like registers.  This pass is only run on x86 variants.
12980 @item -fdump-rtl-subreg1
12981 @itemx -fdump-rtl-subreg2
12982 @opindex fdump-rtl-subreg1
12983 @opindex fdump-rtl-subreg2
12984 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12985 the two subreg expansion passes.
12987 @item -fdump-rtl-unshare
12988 @opindex fdump-rtl-unshare
12989 Dump after all rtl has been unshared.
12991 @item -fdump-rtl-vartrack
12992 @opindex fdump-rtl-vartrack
12993 Dump after variable tracking.
12995 @item -fdump-rtl-vregs
12996 @opindex fdump-rtl-vregs
12997 Dump after converting virtual registers to hard registers.
12999 @item -fdump-rtl-web
13000 @opindex fdump-rtl-web
13001 Dump after live range splitting.
13003 @item -fdump-rtl-regclass
13004 @itemx -fdump-rtl-subregs_of_mode_init
13005 @itemx -fdump-rtl-subregs_of_mode_finish
13006 @itemx -fdump-rtl-dfinit
13007 @itemx -fdump-rtl-dfinish
13008 @opindex fdump-rtl-regclass
13009 @opindex fdump-rtl-subregs_of_mode_init
13010 @opindex fdump-rtl-subregs_of_mode_finish
13011 @opindex fdump-rtl-dfinit
13012 @opindex fdump-rtl-dfinish
13013 These dumps are defined but always produce empty files.
13015 @item -da
13016 @itemx -fdump-rtl-all
13017 @opindex da
13018 @opindex fdump-rtl-all
13019 Produce all the dumps listed above.
13021 @item -dA
13022 @opindex dA
13023 Annotate the assembler output with miscellaneous debugging information.
13025 @item -dD
13026 @opindex dD
13027 Dump all macro definitions, at the end of preprocessing, in addition to
13028 normal output.
13030 @item -dH
13031 @opindex dH
13032 Produce a core dump whenever an error occurs.
13034 @item -dp
13035 @opindex dp
13036 Annotate the assembler output with a comment indicating which
13037 pattern and alternative is used.  The length of each instruction is
13038 also printed.
13040 @item -dP
13041 @opindex dP
13042 Dump the RTL in the assembler output as a comment before each instruction.
13043 Also turns on @option{-dp} annotation.
13045 @item -dx
13046 @opindex dx
13047 Just generate RTL for a function instead of compiling it.  Usually used
13048 with @option{-fdump-rtl-expand}.
13049 @end table
13051 @item -fdump-noaddr
13052 @opindex fdump-noaddr
13053 When doing debugging dumps, suppress address output.  This makes it more
13054 feasible to use diff on debugging dumps for compiler invocations with
13055 different compiler binaries and/or different
13056 text / bss / data / heap / stack / dso start locations.
13058 @item -freport-bug
13059 @opindex freport-bug
13060 Collect and dump debug information into a temporary file if an
13061 internal compiler error (ICE) occurs.
13063 @item -fdump-unnumbered
13064 @opindex fdump-unnumbered
13065 When doing debugging dumps, suppress instruction numbers and address output.
13066 This makes it more feasible to use diff on debugging dumps for compiler
13067 invocations with different options, in particular with and without
13068 @option{-g}.
13070 @item -fdump-unnumbered-links
13071 @opindex fdump-unnumbered-links
13072 When doing debugging dumps (see @option{-d} option above), suppress
13073 instruction numbers for the links to the previous and next instructions
13074 in a sequence.
13076 @item -fdump-ipa-@var{switch}
13077 @opindex fdump-ipa
13078 Control the dumping at various stages of inter-procedural analysis
13079 language tree to a file.  The file name is generated by appending a
13080 switch specific suffix to the source file name, and the file is created
13081 in the same directory as the output file.  The following dumps are
13082 possible:
13084 @table @samp
13085 @item all
13086 Enables all inter-procedural analysis dumps.
13088 @item cgraph
13089 Dumps information about call-graph optimization, unused function removal,
13090 and inlining decisions.
13092 @item inline
13093 Dump after function inlining.
13095 @end table
13097 @item -fdump-lang-all
13098 @itemx -fdump-lang-@var{switch}
13099 @itemx -fdump-lang-@var{switch}-@var{options}
13100 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13101 @opindex fdump-lang-all
13102 @opindex fdump-lang
13103 Control the dumping of language-specific information.  The @var{options}
13104 and @var{filename} portions behave as described in the
13105 @option{-fdump-tree} option.  The following @var{switch} values are
13106 accepted:
13108 @table @samp
13109 @item all
13111 Enable all language-specific dumps.
13113 @item class
13114 Dump class hierarchy information.  Virtual table information is emitted
13115 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13117 @item raw
13118 Dump the raw internal tree data.  This option is applicable to C++ only.
13120 @end table
13122 @item -fdump-passes
13123 @opindex fdump-passes
13124 Print on @file{stderr} the list of optimization passes that are turned
13125 on and off by the current command-line options.
13127 @item -fdump-statistics-@var{option}
13128 @opindex fdump-statistics
13129 Enable and control dumping of pass statistics in a separate file.  The
13130 file name is generated by appending a suffix ending in
13131 @samp{.statistics} to the source file name, and the file is created in
13132 the same directory as the output file.  If the @samp{-@var{option}}
13133 form is used, @samp{-stats} causes counters to be summed over the
13134 whole compilation unit while @samp{-details} dumps every event as
13135 the passes generate them.  The default with no option is to sum
13136 counters for each function compiled.
13138 @item -fdump-tree-all
13139 @itemx -fdump-tree-@var{switch}
13140 @itemx -fdump-tree-@var{switch}-@var{options}
13141 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13142 @opindex fdump-tree-all
13143 @opindex fdump-tree
13144 Control the dumping at various stages of processing the intermediate
13145 language tree to a file.  The file name is generated by appending a
13146 switch-specific suffix to the source file name, and the file is
13147 created in the same directory as the output file. In case of
13148 @option{=@var{filename}} option, the dump is output on the given file
13149 instead of the auto named dump files.  If the @samp{-@var{options}}
13150 form is used, @var{options} is a list of @samp{-} separated options
13151 which control the details of the dump.  Not all options are applicable
13152 to all dumps; those that are not meaningful are ignored.  The
13153 following options are available
13155 @table @samp
13156 @item address
13157 Print the address of each node.  Usually this is not meaningful as it
13158 changes according to the environment and source file.  Its primary use
13159 is for tying up a dump file with a debug environment.
13160 @item asmname
13161 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13162 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13163 use working backward from mangled names in the assembly file.
13164 @item slim
13165 When dumping front-end intermediate representations, inhibit dumping
13166 of members of a scope or body of a function merely because that scope
13167 has been reached.  Only dump such items when they are directly reachable
13168 by some other path.
13170 When dumping pretty-printed trees, this option inhibits dumping the
13171 bodies of control structures.
13173 When dumping RTL, print the RTL in slim (condensed) form instead of
13174 the default LISP-like representation.
13175 @item raw
13176 Print a raw representation of the tree.  By default, trees are
13177 pretty-printed into a C-like representation.
13178 @item details
13179 Enable more detailed dumps (not honored by every dump option). Also
13180 include information from the optimization passes.
13181 @item stats
13182 Enable dumping various statistics about the pass (not honored by every dump
13183 option).
13184 @item blocks
13185 Enable showing basic block boundaries (disabled in raw dumps).
13186 @item graph
13187 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13188 dump a representation of the control flow graph suitable for viewing with
13189 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13190 the file is pretty-printed as a subgraph, so that GraphViz can render them
13191 all in a single plot.
13193 This option currently only works for RTL dumps, and the RTL is always
13194 dumped in slim form.
13195 @item vops
13196 Enable showing virtual operands for every statement.
13197 @item lineno
13198 Enable showing line numbers for statements.
13199 @item uid
13200 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13201 @item verbose
13202 Enable showing the tree dump for each statement.
13203 @item eh
13204 Enable showing the EH region number holding each statement.
13205 @item scev
13206 Enable showing scalar evolution analysis details.
13207 @item optimized
13208 Enable showing optimization information (only available in certain
13209 passes).
13210 @item missed
13211 Enable showing missed optimization information (only available in certain
13212 passes).
13213 @item note
13214 Enable other detailed optimization information (only available in
13215 certain passes).
13216 @item =@var{filename}
13217 Instead of an auto named dump file, output into the given file
13218 name. The file names @file{stdout} and @file{stderr} are treated
13219 specially and are considered already open standard streams. For
13220 example,
13222 @smallexample
13223 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13224      -fdump-tree-pre=/dev/stderr file.c
13225 @end smallexample
13227 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13228 output on to @file{stderr}. If two conflicting dump filenames are
13229 given for the same pass, then the latter option overrides the earlier
13230 one.
13232 @item all
13233 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13234 and @option{lineno}.
13236 @item optall
13237 Turn on all optimization options, i.e., @option{optimized},
13238 @option{missed}, and @option{note}.
13239 @end table
13241 To determine what tree dumps are available or find the dump for a pass
13242 of interest follow the steps below.
13244 @enumerate
13245 @item
13246 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13247 look for a code that corresponds to the pass you are interested in.
13248 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13249 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13250 The number at the end distinguishes distinct invocations of the same pass.
13251 @item
13252 To enable the creation of the dump file, append the pass code to
13253 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13254 to enable the dump from the Early Value Range Propagation pass, invoke
13255 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13256 specify the name of the dump file.  If you don't specify one, GCC
13257 creates as described below.
13258 @item
13259 Find the pass dump in a file whose name is composed of three components
13260 separated by a period: the name of the source file GCC was invoked to
13261 compile, a numeric suffix indicating the pass number followed by the
13262 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13263 and finally the pass code.  For example, the Early VRP pass dump might
13264 be in a file named @file{myfile.c.038t.evrp} in the current working
13265 directory.  Note that the numeric codes are not stable and may change
13266 from one version of GCC to another.
13267 @end enumerate
13269 @item -fopt-info
13270 @itemx -fopt-info-@var{options}
13271 @itemx -fopt-info-@var{options}=@var{filename}
13272 @opindex fopt-info
13273 Controls optimization dumps from various optimization passes. If the
13274 @samp{-@var{options}} form is used, @var{options} is a list of
13275 @samp{-} separated option keywords to select the dump details and
13276 optimizations.  
13278 The @var{options} can be divided into two groups: options describing the
13279 verbosity of the dump, and options describing which optimizations
13280 should be included. The options from both the groups can be freely
13281 mixed as they are non-overlapping. However, in case of any conflicts,
13282 the later options override the earlier options on the command
13283 line. 
13285 The following options control the dump verbosity:
13287 @table @samp
13288 @item optimized
13289 Print information when an optimization is successfully applied. It is
13290 up to a pass to decide which information is relevant. For example, the
13291 vectorizer passes print the source location of loops which are
13292 successfully vectorized.
13293 @item missed
13294 Print information about missed optimizations. Individual passes
13295 control which information to include in the output. 
13296 @item note
13297 Print verbose information about optimizations, such as certain
13298 transformations, more detailed messages about decisions etc.
13299 @item all
13300 Print detailed optimization information. This includes
13301 @samp{optimized}, @samp{missed}, and @samp{note}.
13302 @end table
13304 One or more of the following option keywords can be used to describe a
13305 group of optimizations:
13307 @table @samp
13308 @item ipa
13309 Enable dumps from all interprocedural optimizations.
13310 @item loop
13311 Enable dumps from all loop optimizations.
13312 @item inline
13313 Enable dumps from all inlining optimizations.
13314 @item omp
13315 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13316 @item vec
13317 Enable dumps from all vectorization optimizations.
13318 @item optall
13319 Enable dumps from all optimizations. This is a superset of
13320 the optimization groups listed above.
13321 @end table
13323 If @var{options} is
13324 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13325 info about successful optimizations from all the passes.  
13327 If the @var{filename} is provided, then the dumps from all the
13328 applicable optimizations are concatenated into the @var{filename}.
13329 Otherwise the dump is output onto @file{stderr}. Though multiple
13330 @option{-fopt-info} options are accepted, only one of them can include
13331 a @var{filename}. If other filenames are provided then all but the
13332 first such option are ignored.
13334 Note that the output @var{filename} is overwritten
13335 in case of multiple translation units. If a combined output from
13336 multiple translation units is desired, @file{stderr} should be used
13337 instead.
13339 In the following example, the optimization info is output to
13340 @file{stderr}:
13342 @smallexample
13343 gcc -O3 -fopt-info
13344 @end smallexample
13346 This example:
13347 @smallexample
13348 gcc -O3 -fopt-info-missed=missed.all
13349 @end smallexample
13351 @noindent
13352 outputs missed optimization report from all the passes into
13353 @file{missed.all}, and this one:
13355 @smallexample
13356 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13357 @end smallexample
13359 @noindent
13360 prints information about missed optimization opportunities from
13361 vectorization passes on @file{stderr}.  
13362 Note that @option{-fopt-info-vec-missed} is equivalent to 
13363 @option{-fopt-info-missed-vec}.  The order of the optimization group
13364 names and message types listed after @option{-fopt-info} does not matter.
13366 As another example,
13367 @smallexample
13368 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13369 @end smallexample
13371 @noindent
13372 outputs information about missed optimizations as well as
13373 optimized locations from all the inlining passes into
13374 @file{inline.txt}.
13376 Finally, consider:
13378 @smallexample
13379 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13380 @end smallexample
13382 @noindent
13383 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13384 in conflict since only one output file is allowed. In this case, only
13385 the first option takes effect and the subsequent options are
13386 ignored. Thus only @file{vec.miss} is produced which contains
13387 dumps from the vectorizer about missed opportunities.
13389 @item -fsched-verbose=@var{n}
13390 @opindex fsched-verbose
13391 On targets that use instruction scheduling, this option controls the
13392 amount of debugging output the scheduler prints to the dump files.
13394 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13395 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13396 For @var{n} greater than one, it also output basic block probabilities,
13397 detailed ready list information and unit/insn info.  For @var{n} greater
13398 than two, it includes RTL at abort point, control-flow and regions info.
13399 And for @var{n} over four, @option{-fsched-verbose} also includes
13400 dependence info.
13404 @item -fenable-@var{kind}-@var{pass}
13405 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13406 @opindex fdisable-
13407 @opindex fenable-
13409 This is a set of options that are used to explicitly disable/enable
13410 optimization passes.  These options are intended for use for debugging GCC.
13411 Compiler users should use regular options for enabling/disabling
13412 passes instead.
13414 @table @gcctabopt
13416 @item -fdisable-ipa-@var{pass}
13417 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13418 statically invoked in the compiler multiple times, the pass name should be
13419 appended with a sequential number starting from 1.
13421 @item -fdisable-rtl-@var{pass}
13422 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13423 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13424 statically invoked in the compiler multiple times, the pass name should be
13425 appended with a sequential number starting from 1.  @var{range-list} is a 
13426 comma-separated list of function ranges or assembler names.  Each range is a number
13427 pair separated by a colon.  The range is inclusive in both ends.  If the range
13428 is trivial, the number pair can be simplified as a single number.  If the
13429 function's call graph node's @var{uid} falls within one of the specified ranges,
13430 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13431 function header of a dump file, and the pass names can be dumped by using
13432 option @option{-fdump-passes}.
13434 @item -fdisable-tree-@var{pass}
13435 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13436 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13437 option arguments.
13439 @item -fenable-ipa-@var{pass}
13440 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13441 statically invoked in the compiler multiple times, the pass name should be
13442 appended with a sequential number starting from 1.
13444 @item -fenable-rtl-@var{pass}
13445 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13446 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13447 description and examples.
13449 @item -fenable-tree-@var{pass}
13450 @itemx -fenable-tree-@var{pass}=@var{range-list}
13451 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13452 of option arguments.
13454 @end table
13456 Here are some examples showing uses of these options.
13458 @smallexample
13460 # disable ccp1 for all functions
13461    -fdisable-tree-ccp1
13462 # disable complete unroll for function whose cgraph node uid is 1
13463    -fenable-tree-cunroll=1
13464 # disable gcse2 for functions at the following ranges [1,1],
13465 # [300,400], and [400,1000]
13466 # disable gcse2 for functions foo and foo2
13467    -fdisable-rtl-gcse2=foo,foo2
13468 # disable early inlining
13469    -fdisable-tree-einline
13470 # disable ipa inlining
13471    -fdisable-ipa-inline
13472 # enable tree full unroll
13473    -fenable-tree-unroll
13475 @end smallexample
13477 @item -fchecking
13478 @itemx -fchecking=@var{n}
13479 @opindex fchecking
13480 @opindex fno-checking
13481 Enable internal consistency checking.  The default depends on
13482 the compiler configuration.  @option{-fchecking=2} enables further
13483 internal consistency checking that might affect code generation.
13485 @item -frandom-seed=@var{string}
13486 @opindex frandom-seed
13487 This option provides a seed that GCC uses in place of
13488 random numbers in generating certain symbol names
13489 that have to be different in every compiled file.  It is also used to
13490 place unique stamps in coverage data files and the object files that
13491 produce them.  You can use the @option{-frandom-seed} option to produce
13492 reproducibly identical object files.
13494 The @var{string} can either be a number (decimal, octal or hex) or an
13495 arbitrary string (in which case it's converted to a number by
13496 computing CRC32).
13498 The @var{string} should be different for every file you compile.
13500 @item -save-temps
13501 @itemx -save-temps=cwd
13502 @opindex save-temps
13503 Store the usual ``temporary'' intermediate files permanently; place them
13504 in the current directory and name them based on the source file.  Thus,
13505 compiling @file{foo.c} with @option{-c -save-temps} produces files
13506 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13507 preprocessed @file{foo.i} output file even though the compiler now
13508 normally uses an integrated preprocessor.
13510 When used in combination with the @option{-x} command-line option,
13511 @option{-save-temps} is sensible enough to avoid over writing an
13512 input source file with the same extension as an intermediate file.
13513 The corresponding intermediate file may be obtained by renaming the
13514 source file before using @option{-save-temps}.
13516 If you invoke GCC in parallel, compiling several different source
13517 files that share a common base name in different subdirectories or the
13518 same source file compiled for multiple output destinations, it is
13519 likely that the different parallel compilers will interfere with each
13520 other, and overwrite the temporary files.  For instance:
13522 @smallexample
13523 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13524 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13525 @end smallexample
13527 may result in @file{foo.i} and @file{foo.o} being written to
13528 simultaneously by both compilers.
13530 @item -save-temps=obj
13531 @opindex save-temps=obj
13532 Store the usual ``temporary'' intermediate files permanently.  If the
13533 @option{-o} option is used, the temporary files are based on the
13534 object file.  If the @option{-o} option is not used, the
13535 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13537 For example:
13539 @smallexample
13540 gcc -save-temps=obj -c foo.c
13541 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13542 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13543 @end smallexample
13545 @noindent
13546 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13547 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13548 @file{dir2/yfoobar.o}.
13550 @item -time@r{[}=@var{file}@r{]}
13551 @opindex time
13552 Report the CPU time taken by each subprocess in the compilation
13553 sequence.  For C source files, this is the compiler proper and assembler
13554 (plus the linker if linking is done).
13556 Without the specification of an output file, the output looks like this:
13558 @smallexample
13559 # cc1 0.12 0.01
13560 # as 0.00 0.01
13561 @end smallexample
13563 The first number on each line is the ``user time'', that is time spent
13564 executing the program itself.  The second number is ``system time'',
13565 time spent executing operating system routines on behalf of the program.
13566 Both numbers are in seconds.
13568 With the specification of an output file, the output is appended to the
13569 named file, and it looks like this:
13571 @smallexample
13572 0.12 0.01 cc1 @var{options}
13573 0.00 0.01 as @var{options}
13574 @end smallexample
13576 The ``user time'' and the ``system time'' are moved before the program
13577 name, and the options passed to the program are displayed, so that one
13578 can later tell what file was being compiled, and with which options.
13580 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13581 @opindex fdump-final-insns
13582 Dump the final internal representation (RTL) to @var{file}.  If the
13583 optional argument is omitted (or if @var{file} is @code{.}), the name
13584 of the dump file is determined by appending @code{.gkd} to the
13585 compilation output file name.
13587 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13588 @opindex fcompare-debug
13589 @opindex fno-compare-debug
13590 If no error occurs during compilation, run the compiler a second time,
13591 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13592 passed to the second compilation.  Dump the final internal
13593 representation in both compilations, and print an error if they differ.
13595 If the equal sign is omitted, the default @option{-gtoggle} is used.
13597 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13598 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13599 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13600 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13601 is used.
13603 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13604 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13605 of the final representation and the second compilation, preventing even
13606 @env{GCC_COMPARE_DEBUG} from taking effect.
13608 To verify full coverage during @option{-fcompare-debug} testing, set
13609 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13610 which GCC rejects as an invalid option in any actual compilation
13611 (rather than preprocessing, assembly or linking).  To get just a
13612 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13613 not overridden} will do.
13615 @item -fcompare-debug-second
13616 @opindex fcompare-debug-second
13617 This option is implicitly passed to the compiler for the second
13618 compilation requested by @option{-fcompare-debug}, along with options to
13619 silence warnings, and omitting other options that would cause
13620 side-effect compiler outputs to files or to the standard output.  Dump
13621 files and preserved temporary files are renamed so as to contain the
13622 @code{.gk} additional extension during the second compilation, to avoid
13623 overwriting those generated by the first.
13625 When this option is passed to the compiler driver, it causes the
13626 @emph{first} compilation to be skipped, which makes it useful for little
13627 other than debugging the compiler proper.
13629 @item -gtoggle
13630 @opindex gtoggle
13631 Turn off generation of debug info, if leaving out this option
13632 generates it, or turn it on at level 2 otherwise.  The position of this
13633 argument in the command line does not matter; it takes effect after all
13634 other options are processed, and it does so only once, no matter how
13635 many times it is given.  This is mainly intended to be used with
13636 @option{-fcompare-debug}.
13638 @item -fvar-tracking-assignments-toggle
13639 @opindex fvar-tracking-assignments-toggle
13640 @opindex fno-var-tracking-assignments-toggle
13641 Toggle @option{-fvar-tracking-assignments}, in the same way that
13642 @option{-gtoggle} toggles @option{-g}.
13644 @item -Q
13645 @opindex Q
13646 Makes the compiler print out each function name as it is compiled, and
13647 print some statistics about each pass when it finishes.
13649 @item -ftime-report
13650 @opindex ftime-report
13651 Makes the compiler print some statistics about the time consumed by each
13652 pass when it finishes.
13654 @item -ftime-report-details
13655 @opindex ftime-report-details
13656 Record the time consumed by infrastructure parts separately for each pass.
13658 @item -fira-verbose=@var{n}
13659 @opindex fira-verbose
13660 Control the verbosity of the dump file for the integrated register allocator.
13661 The default value is 5.  If the value @var{n} is greater or equal to 10,
13662 the dump output is sent to stderr using the same format as @var{n} minus 10.
13664 @item -flto-report
13665 @opindex flto-report
13666 Prints a report with internal details on the workings of the link-time
13667 optimizer.  The contents of this report vary from version to version.
13668 It is meant to be useful to GCC developers when processing object
13669 files in LTO mode (via @option{-flto}).
13671 Disabled by default.
13673 @item -flto-report-wpa
13674 @opindex flto-report-wpa
13675 Like @option{-flto-report}, but only print for the WPA phase of Link
13676 Time Optimization.
13678 @item -fmem-report
13679 @opindex fmem-report
13680 Makes the compiler print some statistics about permanent memory
13681 allocation when it finishes.
13683 @item -fmem-report-wpa
13684 @opindex fmem-report-wpa
13685 Makes the compiler print some statistics about permanent memory
13686 allocation for the WPA phase only.
13688 @item -fpre-ipa-mem-report
13689 @opindex fpre-ipa-mem-report
13690 @item -fpost-ipa-mem-report
13691 @opindex fpost-ipa-mem-report
13692 Makes the compiler print some statistics about permanent memory
13693 allocation before or after interprocedural optimization.
13695 @item -fprofile-report
13696 @opindex fprofile-report
13697 Makes the compiler print some statistics about consistency of the
13698 (estimated) profile and effect of individual passes.
13700 @item -fstack-usage
13701 @opindex fstack-usage
13702 Makes the compiler output stack usage information for the program, on a
13703 per-function basis.  The filename for the dump is made by appending
13704 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13705 the output file, if explicitly specified and it is not an executable,
13706 otherwise it is the basename of the source file.  An entry is made up
13707 of three fields:
13709 @itemize
13710 @item
13711 The name of the function.
13712 @item
13713 A number of bytes.
13714 @item
13715 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13716 @end itemize
13718 The qualifier @code{static} means that the function manipulates the stack
13719 statically: a fixed number of bytes are allocated for the frame on function
13720 entry and released on function exit; no stack adjustments are otherwise made
13721 in the function.  The second field is this fixed number of bytes.
13723 The qualifier @code{dynamic} means that the function manipulates the stack
13724 dynamically: in addition to the static allocation described above, stack
13725 adjustments are made in the body of the function, for example to push/pop
13726 arguments around function calls.  If the qualifier @code{bounded} is also
13727 present, the amount of these adjustments is bounded at compile time and
13728 the second field is an upper bound of the total amount of stack used by
13729 the function.  If it is not present, the amount of these adjustments is
13730 not bounded at compile time and the second field only represents the
13731 bounded part.
13733 @item -fstats
13734 @opindex fstats
13735 Emit statistics about front-end processing at the end of the compilation.
13736 This option is supported only by the C++ front end, and
13737 the information is generally only useful to the G++ development team.
13739 @item -fdbg-cnt-list
13740 @opindex fdbg-cnt-list
13741 Print the name and the counter upper bound for all debug counters.
13744 @item -fdbg-cnt=@var{counter-value-list}
13745 @opindex fdbg-cnt
13746 Set the internal debug counter upper bound.  @var{counter-value-list}
13747 is a comma-separated list of @var{name}:@var{value} pairs
13748 which sets the upper bound of each debug counter @var{name} to @var{value}.
13749 All debug counters have the initial upper bound of @code{UINT_MAX};
13750 thus @code{dbg_cnt} returns true always unless the upper bound
13751 is set by this option.
13752 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13753 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13755 @item -print-file-name=@var{library}
13756 @opindex print-file-name
13757 Print the full absolute name of the library file @var{library} that
13758 would be used when linking---and don't do anything else.  With this
13759 option, GCC does not compile or link anything; it just prints the
13760 file name.
13762 @item -print-multi-directory
13763 @opindex print-multi-directory
13764 Print the directory name corresponding to the multilib selected by any
13765 other switches present in the command line.  This directory is supposed
13766 to exist in @env{GCC_EXEC_PREFIX}.
13768 @item -print-multi-lib
13769 @opindex print-multi-lib
13770 Print the mapping from multilib directory names to compiler switches
13771 that enable them.  The directory name is separated from the switches by
13772 @samp{;}, and each switch starts with an @samp{@@} instead of the
13773 @samp{-}, without spaces between multiple switches.  This is supposed to
13774 ease shell processing.
13776 @item -print-multi-os-directory
13777 @opindex print-multi-os-directory
13778 Print the path to OS libraries for the selected
13779 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13780 present in the @file{lib} subdirectory and no multilibs are used, this is
13781 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13782 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13783 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13784 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13786 @item -print-multiarch
13787 @opindex print-multiarch
13788 Print the path to OS libraries for the selected multiarch,
13789 relative to some @file{lib} subdirectory.
13791 @item -print-prog-name=@var{program}
13792 @opindex print-prog-name
13793 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13795 @item -print-libgcc-file-name
13796 @opindex print-libgcc-file-name
13797 Same as @option{-print-file-name=libgcc.a}.
13799 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13800 but you do want to link with @file{libgcc.a}.  You can do:
13802 @smallexample
13803 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13804 @end smallexample
13806 @item -print-search-dirs
13807 @opindex print-search-dirs
13808 Print the name of the configured installation directory and a list of
13809 program and library directories @command{gcc} searches---and don't do anything else.
13811 This is useful when @command{gcc} prints the error message
13812 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13813 To resolve this you either need to put @file{cpp0} and the other compiler
13814 components where @command{gcc} expects to find them, or you can set the environment
13815 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13816 Don't forget the trailing @samp{/}.
13817 @xref{Environment Variables}.
13819 @item -print-sysroot
13820 @opindex print-sysroot
13821 Print the target sysroot directory that is used during
13822 compilation.  This is the target sysroot specified either at configure
13823 time or using the @option{--sysroot} option, possibly with an extra
13824 suffix that depends on compilation options.  If no target sysroot is
13825 specified, the option prints nothing.
13827 @item -print-sysroot-headers-suffix
13828 @opindex print-sysroot-headers-suffix
13829 Print the suffix added to the target sysroot when searching for
13830 headers, or give an error if the compiler is not configured with such
13831 a suffix---and don't do anything else.
13833 @item -dumpmachine
13834 @opindex dumpmachine
13835 Print the compiler's target machine (for example,
13836 @samp{i686-pc-linux-gnu})---and don't do anything else.
13838 @item -dumpversion
13839 @opindex dumpversion
13840 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13841 anything else.  This is the compiler version used in filesystem paths,
13842 specs, can be depending on how the compiler has been configured just
13843 a single number (major version), two numbers separated by dot (major and
13844 minor version) or three numbers separated by dots (major, minor and patchlevel
13845 version).
13847 @item -dumpfullversion
13848 @opindex dumpfullversion
13849 Print the full compiler version, always 3 numbers separated by dots,
13850 major, minor and patchlevel version.
13852 @item -dumpspecs
13853 @opindex dumpspecs
13854 Print the compiler's built-in specs---and don't do anything else.  (This
13855 is used when GCC itself is being built.)  @xref{Spec Files}.
13856 @end table
13858 @node Submodel Options
13859 @section Machine-Dependent Options
13860 @cindex submodel options
13861 @cindex specifying hardware config
13862 @cindex hardware models and configurations, specifying
13863 @cindex target-dependent options
13864 @cindex machine-dependent options
13866 Each target machine supported by GCC can have its own options---for
13867 example, to allow you to compile for a particular processor variant or
13868 ABI, or to control optimizations specific to that machine.  By
13869 convention, the names of machine-specific options start with
13870 @samp{-m}.
13872 Some configurations of the compiler also support additional target-specific
13873 options, usually for compatibility with other compilers on the same
13874 platform.
13876 @c This list is ordered alphanumerically by subsection name.
13877 @c It should be the same order and spelling as these options are listed
13878 @c in Machine Dependent Options
13880 @menu
13881 * AArch64 Options::
13882 * Adapteva Epiphany Options::
13883 * ARC Options::
13884 * ARM Options::
13885 * AVR Options::
13886 * Blackfin Options::
13887 * C6X Options::
13888 * CRIS Options::
13889 * CR16 Options::
13890 * Darwin Options::
13891 * DEC Alpha Options::
13892 * FR30 Options::
13893 * FT32 Options::
13894 * FRV Options::
13895 * GNU/Linux Options::
13896 * H8/300 Options::
13897 * HPPA Options::
13898 * IA-64 Options::
13899 * LM32 Options::
13900 * M32C Options::
13901 * M32R/D Options::
13902 * M680x0 Options::
13903 * MCore Options::
13904 * MeP Options::
13905 * MicroBlaze Options::
13906 * MIPS Options::
13907 * MMIX Options::
13908 * MN10300 Options::
13909 * Moxie Options::
13910 * MSP430 Options::
13911 * NDS32 Options::
13912 * Nios II Options::
13913 * Nvidia PTX Options::
13914 * PDP-11 Options::
13915 * picoChip Options::
13916 * PowerPC Options::
13917 * RISC-V Options::
13918 * RL78 Options::
13919 * RS/6000 and PowerPC Options::
13920 * RX Options::
13921 * S/390 and zSeries Options::
13922 * Score Options::
13923 * SH Options::
13924 * Solaris 2 Options::
13925 * SPARC Options::
13926 * SPU Options::
13927 * System V Options::
13928 * TILE-Gx Options::
13929 * TILEPro Options::
13930 * V850 Options::
13931 * VAX Options::
13932 * Visium Options::
13933 * VMS Options::
13934 * VxWorks Options::
13935 * x86 Options::
13936 * x86 Windows Options::
13937 * Xstormy16 Options::
13938 * Xtensa Options::
13939 * zSeries Options::
13940 @end menu
13942 @node AArch64 Options
13943 @subsection AArch64 Options
13944 @cindex AArch64 Options
13946 These options are defined for AArch64 implementations:
13948 @table @gcctabopt
13950 @item -mabi=@var{name}
13951 @opindex mabi
13952 Generate code for the specified data model.  Permissible values
13953 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13954 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13955 but long int and pointers are 64 bits.
13957 The default depends on the specific target configuration.  Note that
13958 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13959 entire program with the same ABI, and link with a compatible set of libraries.
13961 @item -mbig-endian
13962 @opindex mbig-endian
13963 Generate big-endian code.  This is the default when GCC is configured for an
13964 @samp{aarch64_be-*-*} target.
13966 @item -mgeneral-regs-only
13967 @opindex mgeneral-regs-only
13968 Generate code which uses only the general-purpose registers.  This will prevent
13969 the compiler from using floating-point and Advanced SIMD registers but will not
13970 impose any restrictions on the assembler.
13972 @item -mlittle-endian
13973 @opindex mlittle-endian
13974 Generate little-endian code.  This is the default when GCC is configured for an
13975 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13977 @item -mcmodel=tiny
13978 @opindex mcmodel=tiny
13979 Generate code for the tiny code model.  The program and its statically defined
13980 symbols must be within 1MB of each other.  Programs can be statically or
13981 dynamically linked.
13983 @item -mcmodel=small
13984 @opindex mcmodel=small
13985 Generate code for the small code model.  The program and its statically defined
13986 symbols must be within 4GB of each other.  Programs can be statically or
13987 dynamically linked.  This is the default code model.
13989 @item -mcmodel=large
13990 @opindex mcmodel=large
13991 Generate code for the large code model.  This makes no assumptions about
13992 addresses and sizes of sections.  Programs can be statically linked only.
13994 @item -mstrict-align
13995 @opindex mstrict-align
13996 Avoid generating memory accesses that may not be aligned on a natural object
13997 boundary as described in the architecture specification.
13999 @item -momit-leaf-frame-pointer
14000 @itemx -mno-omit-leaf-frame-pointer
14001 @opindex momit-leaf-frame-pointer
14002 @opindex mno-omit-leaf-frame-pointer
14003 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14004 default.
14006 @item -mtls-dialect=desc
14007 @opindex mtls-dialect=desc
14008 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14009 of TLS variables.  This is the default.
14011 @item -mtls-dialect=traditional
14012 @opindex mtls-dialect=traditional
14013 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14014 of TLS variables.
14016 @item -mtls-size=@var{size}
14017 @opindex mtls-size
14018 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14019 This option requires binutils 2.26 or newer.
14021 @item -mfix-cortex-a53-835769
14022 @itemx -mno-fix-cortex-a53-835769
14023 @opindex mfix-cortex-a53-835769
14024 @opindex mno-fix-cortex-a53-835769
14025 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14026 This involves inserting a NOP instruction between memory instructions and
14027 64-bit integer multiply-accumulate instructions.
14029 @item -mfix-cortex-a53-843419
14030 @itemx -mno-fix-cortex-a53-843419
14031 @opindex mfix-cortex-a53-843419
14032 @opindex mno-fix-cortex-a53-843419
14033 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14034 This erratum workaround is made at link time and this will only pass the
14035 corresponding flag to the linker.
14037 @item -mlow-precision-recip-sqrt
14038 @item -mno-low-precision-recip-sqrt
14039 @opindex mlow-precision-recip-sqrt
14040 @opindex mno-low-precision-recip-sqrt
14041 Enable or disable the reciprocal square root approximation.
14042 This option only has an effect if @option{-ffast-math} or
14043 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14044 precision of reciprocal square root results to about 16 bits for
14045 single precision and to 32 bits for double precision.
14047 @item -mlow-precision-sqrt
14048 @item -mno-low-precision-sqrt
14049 @opindex -mlow-precision-sqrt
14050 @opindex -mno-low-precision-sqrt
14051 Enable or disable the square root approximation.
14052 This option only has an effect if @option{-ffast-math} or
14053 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14054 precision of square root results to about 16 bits for
14055 single precision and to 32 bits for double precision.
14056 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14058 @item -mlow-precision-div
14059 @item -mno-low-precision-div
14060 @opindex -mlow-precision-div
14061 @opindex -mno-low-precision-div
14062 Enable or disable the division approximation.
14063 This option only has an effect if @option{-ffast-math} or
14064 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14065 precision of division results to about 16 bits for
14066 single precision and to 32 bits for double precision.
14068 @item -march=@var{name}
14069 @opindex march
14070 Specify the name of the target architecture and, optionally, one or
14071 more feature modifiers.  This option has the form
14072 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14074 The permissible values for @var{arch} are @samp{armv8-a},
14075 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14077 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14078 support for the ARMv8.3-A architecture extensions.
14080 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14081 support for the ARMv8.2-A architecture extensions.
14083 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14084 support for the ARMv8.1-A architecture extension.  In particular, it
14085 enables the @samp{+crc} and @samp{+lse} features.
14087 The value @samp{native} is available on native AArch64 GNU/Linux and
14088 causes the compiler to pick the architecture of the host system.  This
14089 option has no effect if the compiler is unable to recognize the
14090 architecture of the host system,
14092 The permissible values for @var{feature} are listed in the sub-section
14093 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14094 Feature Modifiers}.  Where conflicting feature modifiers are
14095 specified, the right-most feature is used.
14097 GCC uses @var{name} to determine what kind of instructions it can emit
14098 when generating assembly code.  If @option{-march} is specified
14099 without either of @option{-mtune} or @option{-mcpu} also being
14100 specified, the code is tuned to perform well across a range of target
14101 processors implementing the target architecture.
14103 @item -mtune=@var{name}
14104 @opindex mtune
14105 Specify the name of the target processor for which GCC should tune the
14106 performance of the code.  Permissible values for this option are:
14107 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14108 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14109 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14110 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14111 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14112 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14113 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14114 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14115 @samp{native}.
14117 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14118 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14119 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14120 big.LITTLE system.
14122 Additionally on native AArch64 GNU/Linux systems the value
14123 @samp{native} tunes performance to the host system.  This option has no effect
14124 if the compiler is unable to recognize the processor of the host system.
14126 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14127 are specified, the code is tuned to perform well across a range
14128 of target processors.
14130 This option cannot be suffixed by feature modifiers.
14132 @item -mcpu=@var{name}
14133 @opindex mcpu
14134 Specify the name of the target processor, optionally suffixed by one
14135 or more feature modifiers.  This option has the form
14136 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14137 the permissible values for @var{cpu} are the same as those available
14138 for @option{-mtune}.  The permissible values for @var{feature} are
14139 documented in the sub-section on
14140 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14141 Feature Modifiers}.  Where conflicting feature modifiers are
14142 specified, the right-most feature is used.
14144 GCC uses @var{name} to determine what kind of instructions it can emit when
14145 generating assembly code (as if by @option{-march}) and to determine
14146 the target processor for which to tune for performance (as if
14147 by @option{-mtune}).  Where this option is used in conjunction
14148 with @option{-march} or @option{-mtune}, those options take precedence
14149 over the appropriate part of this option.
14151 @item -moverride=@var{string}
14152 @opindex moverride
14153 Override tuning decisions made by the back-end in response to a
14154 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14155 for @var{string} in this option are not guaranteed to be consistent
14156 across releases.
14158 This option is only intended to be useful when developing GCC.
14160 @item -mpc-relative-literal-loads
14161 @itemx -mno-pc-relative-literal-loads
14162 @opindex mpc-relative-literal-loads
14163 @opindex mno-pc-relative-literal-loads
14164 Enable or disable PC-relative literal loads.  With this option literal pools are
14165 accessed using a single instruction and emitted after each function.  This
14166 limits the maximum size of functions to 1MB.  This is enabled by default for
14167 @option{-mcmodel=tiny}.
14169 @item -msign-return-address=@var{scope}
14170 @opindex msign-return-address
14171 Select the function scope on which return address signing will be applied.
14172 Permissible values are @samp{none}, which disables return address signing,
14173 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14174 functions, and @samp{all}, which enables pointer signing for all functions.  The
14175 default value is @samp{none}.
14177 @end table
14179 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14180 @anchor{aarch64-feature-modifiers}
14181 @cindex @option{-march} feature modifiers
14182 @cindex @option{-mcpu} feature modifiers
14183 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14184 the following and their inverses @option{no@var{feature}}:
14186 @table @samp
14187 @item crc
14188 Enable CRC extension.  This is on by default for
14189 @option{-march=armv8.1-a}.
14190 @item crypto
14191 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14192 instructions.
14193 @item fp
14194 Enable floating-point instructions.  This is on by default for all possible
14195 values for options @option{-march} and @option{-mcpu}.
14196 @item simd
14197 Enable Advanced SIMD instructions.  This also enables floating-point
14198 instructions.  This is on by default for all possible values for options
14199 @option{-march} and @option{-mcpu}.
14200 @item lse
14201 Enable Large System Extension instructions.  This is on by default for
14202 @option{-march=armv8.1-a}.
14203 @item fp16
14204 Enable FP16 extension.  This also enables floating-point instructions.
14205 @item rcpc
14206 Enable the RcPc extension.  This does not change code generation from GCC,
14207 but is passed on to the assembler, enabling inline asm statements to use
14208 instructions from the RcPc extension.
14210 @end table
14212 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14213 Conversely, @option{nofp} implies @option{nosimd}, which implies
14214 @option{nocrypto}.
14216 @node Adapteva Epiphany Options
14217 @subsection Adapteva Epiphany Options
14219 These @samp{-m} options are defined for Adapteva Epiphany:
14221 @table @gcctabopt
14222 @item -mhalf-reg-file
14223 @opindex mhalf-reg-file
14224 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14225 That allows code to run on hardware variants that lack these registers.
14227 @item -mprefer-short-insn-regs
14228 @opindex mprefer-short-insn-regs
14229 Preferentially allocate registers that allow short instruction generation.
14230 This can result in increased instruction count, so this may either reduce or
14231 increase overall code size.
14233 @item -mbranch-cost=@var{num}
14234 @opindex mbranch-cost
14235 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14236 This cost is only a heuristic and is not guaranteed to produce
14237 consistent results across releases.
14239 @item -mcmove
14240 @opindex mcmove
14241 Enable the generation of conditional moves.
14243 @item -mnops=@var{num}
14244 @opindex mnops
14245 Emit @var{num} NOPs before every other generated instruction.
14247 @item -mno-soft-cmpsf
14248 @opindex mno-soft-cmpsf
14249 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14250 and test the flags.  This is faster than a software comparison, but can
14251 get incorrect results in the presence of NaNs, or when two different small
14252 numbers are compared such that their difference is calculated as zero.
14253 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14254 software comparisons.
14256 @item -mstack-offset=@var{num}
14257 @opindex mstack-offset
14258 Set the offset between the top of the stack and the stack pointer.
14259 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14260 can be used by leaf functions without stack allocation.
14261 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14262 Note also that this option changes the ABI; compiling a program with a
14263 different stack offset than the libraries have been compiled with
14264 generally does not work.
14265 This option can be useful if you want to evaluate if a different stack
14266 offset would give you better code, but to actually use a different stack
14267 offset to build working programs, it is recommended to configure the
14268 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14270 @item -mno-round-nearest
14271 @opindex mno-round-nearest
14272 Make the scheduler assume that the rounding mode has been set to
14273 truncating.  The default is @option{-mround-nearest}.
14275 @item -mlong-calls
14276 @opindex mlong-calls
14277 If not otherwise specified by an attribute, assume all calls might be beyond
14278 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14279 function address into a register before performing a (otherwise direct) call.
14280 This is the default.
14282 @item -mshort-calls
14283 @opindex short-calls
14284 If not otherwise specified by an attribute, assume all direct calls are
14285 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14286 for direct calls.  The default is @option{-mlong-calls}.
14288 @item -msmall16
14289 @opindex msmall16
14290 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14291 apply to function addresses for which @option{-mlong-calls} semantics
14292 are in effect.
14294 @item -mfp-mode=@var{mode}
14295 @opindex mfp-mode
14296 Set the prevailing mode of the floating-point unit.
14297 This determines the floating-point mode that is provided and expected
14298 at function call and return time.  Making this mode match the mode you
14299 predominantly need at function start can make your programs smaller and
14300 faster by avoiding unnecessary mode switches.
14302 @var{mode} can be set to one the following values:
14304 @table @samp
14305 @item caller
14306 Any mode at function entry is valid, and retained or restored when
14307 the function returns, and when it calls other functions.
14308 This mode is useful for compiling libraries or other compilation units
14309 you might want to incorporate into different programs with different
14310 prevailing FPU modes, and the convenience of being able to use a single
14311 object file outweighs the size and speed overhead for any extra
14312 mode switching that might be needed, compared with what would be needed
14313 with a more specific choice of prevailing FPU mode.
14315 @item truncate
14316 This is the mode used for floating-point calculations with
14317 truncating (i.e.@: round towards zero) rounding mode.  That includes
14318 conversion from floating point to integer.
14320 @item round-nearest
14321 This is the mode used for floating-point calculations with
14322 round-to-nearest-or-even rounding mode.
14324 @item int
14325 This is the mode used to perform integer calculations in the FPU, e.g.@:
14326 integer multiply, or integer multiply-and-accumulate.
14327 @end table
14329 The default is @option{-mfp-mode=caller}
14331 @item -mnosplit-lohi
14332 @itemx -mno-postinc
14333 @itemx -mno-postmodify
14334 @opindex mnosplit-lohi
14335 @opindex mno-postinc
14336 @opindex mno-postmodify
14337 Code generation tweaks that disable, respectively, splitting of 32-bit
14338 loads, generation of post-increment addresses, and generation of
14339 post-modify addresses.  The defaults are @option{msplit-lohi},
14340 @option{-mpost-inc}, and @option{-mpost-modify}.
14342 @item -mnovect-double
14343 @opindex mno-vect-double
14344 Change the preferred SIMD mode to SImode.  The default is
14345 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14347 @item -max-vect-align=@var{num}
14348 @opindex max-vect-align
14349 The maximum alignment for SIMD vector mode types.
14350 @var{num} may be 4 or 8.  The default is 8.
14351 Note that this is an ABI change, even though many library function
14352 interfaces are unaffected if they don't use SIMD vector modes
14353 in places that affect size and/or alignment of relevant types.
14355 @item -msplit-vecmove-early
14356 @opindex msplit-vecmove-early
14357 Split vector moves into single word moves before reload.  In theory this
14358 can give better register allocation, but so far the reverse seems to be
14359 generally the case.
14361 @item -m1reg-@var{reg}
14362 @opindex m1reg-
14363 Specify a register to hold the constant @minus{}1, which makes loading small negative
14364 constants and certain bitmasks faster.
14365 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14366 which specify use of that register as a fixed register,
14367 and @samp{none}, which means that no register is used for this
14368 purpose.  The default is @option{-m1reg-none}.
14370 @end table
14372 @node ARC Options
14373 @subsection ARC Options
14374 @cindex ARC options
14376 The following options control the architecture variant for which code
14377 is being compiled:
14379 @c architecture variants
14380 @table @gcctabopt
14382 @item -mbarrel-shifter
14383 @opindex mbarrel-shifter
14384 Generate instructions supported by barrel shifter.  This is the default
14385 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14387 @item -mcpu=@var{cpu}
14388 @opindex mcpu
14389 Set architecture type, register usage, and instruction scheduling
14390 parameters for @var{cpu}.  There are also shortcut alias options
14391 available for backward compatibility and convenience.  Supported
14392 values for @var{cpu} are
14394 @table @samp
14395 @opindex mA6
14396 @opindex mARC600
14397 @item arc600
14398 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14400 @item arc601
14401 @opindex mARC601
14402 Compile for ARC601.  Alias: @option{-mARC601}.
14404 @item arc700
14405 @opindex mA7
14406 @opindex mARC700
14407 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14408 This is the default when configured with @option{--with-cpu=arc700}@.
14410 @item arcem
14411 Compile for ARC EM.
14413 @item archs
14414 Compile for ARC HS.
14416 @item em
14417 Compile for ARC EM CPU with no hardware extensions.
14419 @item em4
14420 Compile for ARC EM4 CPU.
14422 @item em4_dmips
14423 Compile for ARC EM4 DMIPS CPU.
14425 @item em4_fpus
14426 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14427 extension.
14429 @item em4_fpuda
14430 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14431 double assist instructions.
14433 @item hs
14434 Compile for ARC HS CPU with no hardware extensions except the atomic
14435 instructions.
14437 @item hs34
14438 Compile for ARC HS34 CPU.
14440 @item hs38
14441 Compile for ARC HS38 CPU.
14443 @item hs38_linux
14444 Compile for ARC HS38 CPU with all hardware extensions on.
14446 @item arc600_norm
14447 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14449 @item arc600_mul32x16
14450 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14451 instructions enabled.
14453 @item arc600_mul64
14454 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14455 instructions enabled.
14457 @item arc601_norm
14458 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14460 @item arc601_mul32x16
14461 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14462 instructions enabled.
14464 @item arc601_mul64
14465 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14466 instructions enabled.
14468 @item nps400
14469 Compile for ARC 700 on NPS400 chip.
14471 @end table
14473 @item -mdpfp
14474 @opindex mdpfp
14475 @itemx -mdpfp-compact
14476 @opindex mdpfp-compact
14477 Generate double-precision FPX instructions, tuned for the compact
14478 implementation.
14480 @item -mdpfp-fast
14481 @opindex mdpfp-fast
14482 Generate double-precision FPX instructions, tuned for the fast
14483 implementation.
14485 @item -mno-dpfp-lrsr
14486 @opindex mno-dpfp-lrsr
14487 Disable @code{lr} and @code{sr} instructions from using FPX extension
14488 aux registers.
14490 @item -mea
14491 @opindex mea
14492 Generate extended arithmetic instructions.  Currently only
14493 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14494 supported.  This is always enabled for @option{-mcpu=ARC700}.
14496 @item -mno-mpy
14497 @opindex mno-mpy
14498 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14499 deprecated.
14501 @item -mmul32x16
14502 @opindex mmul32x16
14503 Generate 32x16-bit multiply and multiply-accumulate instructions.
14505 @item -mmul64
14506 @opindex mmul64
14507 Generate @code{mul64} and @code{mulu64} instructions.  
14508 Only valid for @option{-mcpu=ARC600}.
14510 @item -mnorm
14511 @opindex mnorm
14512 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14513 is in effect.
14515 @item -mspfp
14516 @opindex mspfp
14517 @itemx -mspfp-compact
14518 @opindex mspfp-compact
14519 Generate single-precision FPX instructions, tuned for the compact
14520 implementation.
14522 @item -mspfp-fast
14523 @opindex mspfp-fast
14524 Generate single-precision FPX instructions, tuned for the fast
14525 implementation.
14527 @item -msimd
14528 @opindex msimd
14529 Enable generation of ARC SIMD instructions via target-specific
14530 builtins.  Only valid for @option{-mcpu=ARC700}.
14532 @item -msoft-float
14533 @opindex msoft-float
14534 This option ignored; it is provided for compatibility purposes only.
14535 Software floating-point code is emitted by default, and this default
14536 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14537 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14538 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14540 @item -mswap
14541 @opindex mswap
14542 Generate @code{swap} instructions.
14544 @item -matomic
14545 @opindex matomic
14546 This enables use of the locked load/store conditional extension to implement
14547 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14548 EM cores.
14550 @item -mdiv-rem
14551 @opindex mdiv-rem
14552 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14554 @item -mcode-density
14555 @opindex mcode-density
14556 Enable code density instructions for ARC EM.  
14557 This option is on by default for ARC HS.
14559 @item -mll64
14560 @opindex mll64
14561 Enable double load/store operations for ARC HS cores.
14563 @item -mtp-regno=@var{regno}
14564 @opindex mtp-regno
14565 Specify thread pointer register number.
14567 @item -mmpy-option=@var{multo}
14568 @opindex mmpy-option
14569 Compile ARCv2 code with a multiplier design option.  You can specify 
14570 the option using either a string or numeric value for @var{multo}.  
14571 @samp{wlh1} is the default value.  The recognized values are:
14573 @table @samp
14574 @item 0
14575 @itemx none
14576 No multiplier available.
14578 @item 1
14579 @itemx w
14580 16x16 multiplier, fully pipelined.
14581 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14583 @item 2
14584 @itemx wlh1
14585 32x32 multiplier, fully
14586 pipelined (1 stage).  The following instructions are additionally
14587 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14589 @item 3
14590 @itemx wlh2
14591 32x32 multiplier, fully pipelined
14592 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14593 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14595 @item 4
14596 @itemx wlh3
14597 Two 16x16 multipliers, blocking,
14598 sequential.  The following instructions are additionally enabled: @code{mpy},
14599 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14601 @item 5
14602 @itemx wlh4
14603 One 16x16 multiplier, blocking,
14604 sequential.  The following instructions are additionally enabled: @code{mpy},
14605 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14607 @item 6
14608 @itemx wlh5
14609 One 32x4 multiplier, blocking,
14610 sequential.  The following instructions are additionally enabled: @code{mpy},
14611 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14613 @item 7
14614 @itemx plus_dmpy
14615 ARC HS SIMD support.
14617 @item 8
14618 @itemx plus_macd
14619 ARC HS SIMD support.
14621 @item 9
14622 @itemx plus_qmacw
14623 ARC HS SIMD support.
14625 @end table
14627 This option is only available for ARCv2 cores@.
14629 @item -mfpu=@var{fpu}
14630 @opindex mfpu
14631 Enables support for specific floating-point hardware extensions for ARCv2
14632 cores.  Supported values for @var{fpu} are:
14634 @table @samp
14636 @item fpus
14637 Enables support for single-precision floating-point hardware
14638 extensions@.
14640 @item fpud
14641 Enables support for double-precision floating-point hardware
14642 extensions.  The single-precision floating-point extension is also
14643 enabled.  Not available for ARC EM@.
14645 @item fpuda
14646 Enables support for double-precision floating-point hardware
14647 extensions using double-precision assist instructions.  The single-precision
14648 floating-point extension is also enabled.  This option is
14649 only available for ARC EM@.
14651 @item fpuda_div
14652 Enables support for double-precision floating-point hardware
14653 extensions using double-precision assist instructions.
14654 The single-precision floating-point, square-root, and divide 
14655 extensions are also enabled.  This option is
14656 only available for ARC EM@.
14658 @item fpuda_fma
14659 Enables support for double-precision floating-point hardware
14660 extensions using double-precision assist instructions.
14661 The single-precision floating-point and fused multiply and add 
14662 hardware extensions are also enabled.  This option is
14663 only available for ARC EM@.
14665 @item fpuda_all
14666 Enables support for double-precision floating-point hardware
14667 extensions using double-precision assist instructions.
14668 All single-precision floating-point hardware extensions are also
14669 enabled.  This option is only available for ARC EM@.
14671 @item fpus_div
14672 Enables support for single-precision floating-point, square-root and divide 
14673 hardware extensions@.
14675 @item fpud_div
14676 Enables support for double-precision floating-point, square-root and divide 
14677 hardware extensions.  This option
14678 includes option @samp{fpus_div}. Not available for ARC EM@.
14680 @item fpus_fma
14681 Enables support for single-precision floating-point and 
14682 fused multiply and add hardware extensions@.
14684 @item fpud_fma
14685 Enables support for double-precision floating-point and 
14686 fused multiply and add hardware extensions.  This option
14687 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14689 @item fpus_all
14690 Enables support for all single-precision floating-point hardware
14691 extensions@.
14693 @item fpud_all
14694 Enables support for all single- and double-precision floating-point
14695 hardware extensions.  Not available for ARC EM@.
14697 @end table
14699 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14700 @opindex mirq-ctrl-saved
14701 Specifies general-purposes registers that the processor automatically
14702 saves/restores on interrupt entry and exit.  @var{register-range} is
14703 specified as two registers separated by a dash.  The register range
14704 always starts with @code{r0}, the upper limit is @code{fp} register.
14705 @var{blink} and @var{lp_count} are optional.  This option is only
14706 valid for ARC EM and ARC HS cores.
14708 @item -mrgf-banked-regs=@var{number}
14709 @opindex mrgf-banked-regs
14710 Specifies the number of registers replicated in second register bank
14711 on entry to fast interrupt.  Fast interrupts are interrupts with the
14712 highest priority level P0.  These interrupts save only PC and STATUS32
14713 registers to avoid memory transactions during interrupt entry and exit
14714 sequences.  Use this option when you are using fast interrupts in an
14715 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14717 @end table
14719 The following options are passed through to the assembler, and also
14720 define preprocessor macro symbols.
14722 @c Flags used by the assembler, but for which we define preprocessor
14723 @c macro symbols as well.
14724 @table @gcctabopt
14725 @item -mdsp-packa
14726 @opindex mdsp-packa
14727 Passed down to the assembler to enable the DSP Pack A extensions.
14728 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14729 deprecated.
14731 @item -mdvbf
14732 @opindex mdvbf
14733 Passed down to the assembler to enable the dual Viterbi butterfly
14734 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14735 option is deprecated.
14737 @c ARC700 4.10 extension instruction
14738 @item -mlock
14739 @opindex mlock
14740 Passed down to the assembler to enable the locked load/store
14741 conditional extension.  Also sets the preprocessor symbol
14742 @code{__Xlock}.
14744 @item -mmac-d16
14745 @opindex mmac-d16
14746 Passed down to the assembler.  Also sets the preprocessor symbol
14747 @code{__Xxmac_d16}.  This option is deprecated.
14749 @item -mmac-24
14750 @opindex mmac-24
14751 Passed down to the assembler.  Also sets the preprocessor symbol
14752 @code{__Xxmac_24}.  This option is deprecated.
14754 @c ARC700 4.10 extension instruction
14755 @item -mrtsc
14756 @opindex mrtsc
14757 Passed down to the assembler to enable the 64-bit time-stamp counter
14758 extension instruction.  Also sets the preprocessor symbol
14759 @code{__Xrtsc}.  This option is deprecated.
14761 @c ARC700 4.10 extension instruction
14762 @item -mswape
14763 @opindex mswape
14764 Passed down to the assembler to enable the swap byte ordering
14765 extension instruction.  Also sets the preprocessor symbol
14766 @code{__Xswape}.
14768 @item -mtelephony
14769 @opindex mtelephony
14770 Passed down to the assembler to enable dual- and single-operand
14771 instructions for telephony.  Also sets the preprocessor symbol
14772 @code{__Xtelephony}.  This option is deprecated.
14774 @item -mxy
14775 @opindex mxy
14776 Passed down to the assembler to enable the XY memory extension.  Also
14777 sets the preprocessor symbol @code{__Xxy}.
14779 @end table
14781 The following options control how the assembly code is annotated:
14783 @c Assembly annotation options
14784 @table @gcctabopt
14785 @item -misize
14786 @opindex misize
14787 Annotate assembler instructions with estimated addresses.
14789 @item -mannotate-align
14790 @opindex mannotate-align
14791 Explain what alignment considerations lead to the decision to make an
14792 instruction short or long.
14794 @end table
14796 The following options are passed through to the linker:
14798 @c options passed through to the linker
14799 @table @gcctabopt
14800 @item -marclinux
14801 @opindex marclinux
14802 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14803 This option is enabled by default in tool chains built for
14804 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14805 when profiling is not requested.
14807 @item -marclinux_prof
14808 @opindex marclinux_prof
14809 Passed through to the linker, to specify use of the
14810 @code{arclinux_prof} emulation.  This option is enabled by default in
14811 tool chains built for @w{@code{arc-linux-uclibc}} and
14812 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14814 @end table
14816 The following options control the semantics of generated code:
14818 @c semantically relevant code generation options
14819 @table @gcctabopt
14820 @item -mlong-calls
14821 @opindex mlong-calls
14822 Generate calls as register indirect calls, thus providing access
14823 to the full 32-bit address range.
14825 @item -mmedium-calls
14826 @opindex mmedium-calls
14827 Don't use less than 25-bit addressing range for calls, which is the
14828 offset available for an unconditional branch-and-link
14829 instruction.  Conditional execution of function calls is suppressed, to
14830 allow use of the 25-bit range, rather than the 21-bit range with
14831 conditional branch-and-link.  This is the default for tool chains built
14832 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14834 @item -mno-sdata
14835 @opindex mno-sdata
14836 Do not generate sdata references.  This is the default for tool chains
14837 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14838 targets.
14840 @item -mvolatile-cache
14841 @opindex mvolatile-cache
14842 Use ordinarily cached memory accesses for volatile references.  This is the
14843 default.
14845 @item -mno-volatile-cache
14846 @opindex mno-volatile-cache
14847 Enable cache bypass for volatile references.
14849 @end table
14851 The following options fine tune code generation:
14852 @c code generation tuning options
14853 @table @gcctabopt
14854 @item -malign-call
14855 @opindex malign-call
14856 Do alignment optimizations for call instructions.
14858 @item -mauto-modify-reg
14859 @opindex mauto-modify-reg
14860 Enable the use of pre/post modify with register displacement.
14862 @item -mbbit-peephole
14863 @opindex mbbit-peephole
14864 Enable bbit peephole2.
14866 @item -mno-brcc
14867 @opindex mno-brcc
14868 This option disables a target-specific pass in @file{arc_reorg} to
14869 generate compare-and-branch (@code{br@var{cc}}) instructions.  
14870 It has no effect on
14871 generation of these instructions driven by the combiner pass.
14873 @item -mcase-vector-pcrel
14874 @opindex mcase-vector-pcrel
14875 Use PC-relative switch case tables to enable case table shortening.
14876 This is the default for @option{-Os}.
14878 @item -mcompact-casesi
14879 @opindex mcompact-casesi
14880 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
14881 and only available for ARCv1 cores.
14883 @item -mno-cond-exec
14884 @opindex mno-cond-exec
14885 Disable the ARCompact-specific pass to generate conditional 
14886 execution instructions.
14888 Due to delay slot scheduling and interactions between operand numbers,
14889 literal sizes, instruction lengths, and the support for conditional execution,
14890 the target-independent pass to generate conditional execution is often lacking,
14891 so the ARC port has kept a special pass around that tries to find more
14892 conditional execution generation opportunities after register allocation,
14893 branch shortening, and delay slot scheduling have been done.  This pass
14894 generally, but not always, improves performance and code size, at the cost of
14895 extra compilation time, which is why there is an option to switch it off.
14896 If you have a problem with call instructions exceeding their allowable
14897 offset range because they are conditionalized, you should consider using
14898 @option{-mmedium-calls} instead.
14900 @item -mearly-cbranchsi
14901 @opindex mearly-cbranchsi
14902 Enable pre-reload use of the @code{cbranchsi} pattern.
14904 @item -mexpand-adddi
14905 @opindex mexpand-adddi
14906 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
14907 @code{add.f}, @code{adc} etc.
14909 @item -mindexed-loads
14910 @opindex mindexed-loads
14911 Enable the use of indexed loads.  This can be problematic because some
14912 optimizers then assume that indexed stores exist, which is not
14913 the case.
14915 @opindex mlra
14916 Enable Local Register Allocation.  This is still experimental for ARC,
14917 so by default the compiler uses standard reload
14918 (i.e. @option{-mno-lra}).
14920 @item -mlra-priority-none
14921 @opindex mlra-priority-none
14922 Don't indicate any priority for target registers.
14924 @item -mlra-priority-compact
14925 @opindex mlra-priority-compact
14926 Indicate target register priority for r0..r3 / r12..r15.
14928 @item -mlra-priority-noncompact
14929 @opindex mlra-priority-noncompact
14930 Reduce target register priority for r0..r3 / r12..r15.
14932 @item -mno-millicode
14933 @opindex mno-millicode
14934 When optimizing for size (using @option{-Os}), prologues and epilogues
14935 that have to save or restore a large number of registers are often
14936 shortened by using call to a special function in libgcc; this is
14937 referred to as a @emph{millicode} call.  As these calls can pose
14938 performance issues, and/or cause linking issues when linking in a
14939 nonstandard way, this option is provided to turn off millicode call
14940 generation.
14942 @item -mmixed-code
14943 @opindex mmixed-code
14944 Tweak register allocation to help 16-bit instruction generation.
14945 This generally has the effect of decreasing the average instruction size
14946 while increasing the instruction count.
14948 @item -mq-class
14949 @opindex mq-class
14950 Enable @samp{q} instruction alternatives.
14951 This is the default for @option{-Os}.
14953 @item -mRcq
14954 @opindex mRcq
14955 Enable @samp{Rcq} constraint handling.  
14956 Most short code generation depends on this.
14957 This is the default.
14959 @item -mRcw
14960 @opindex mRcw
14961 Enable @samp{Rcw} constraint handling.  
14962 Most ccfsm condexec mostly depends on this.
14963 This is the default.
14965 @item -msize-level=@var{level}
14966 @opindex msize-level
14967 Fine-tune size optimization with regards to instruction lengths and alignment.
14968 The recognized values for @var{level} are:
14969 @table @samp
14970 @item 0
14971 No size optimization.  This level is deprecated and treated like @samp{1}.
14973 @item 1
14974 Short instructions are used opportunistically.
14976 @item 2
14977 In addition, alignment of loops and of code after barriers are dropped.
14979 @item 3
14980 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14982 @end table
14984 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14985 the behavior when this is not set is equivalent to level @samp{1}.
14987 @item -mtune=@var{cpu}
14988 @opindex mtune
14989 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14990 by @option{-mcpu=}.
14992 Supported values for @var{cpu} are
14994 @table @samp
14995 @item ARC600
14996 Tune for ARC600 CPU.
14998 @item ARC601
14999 Tune for ARC601 CPU.
15001 @item ARC700
15002 Tune for ARC700 CPU with standard multiplier block.
15004 @item ARC700-xmac
15005 Tune for ARC700 CPU with XMAC block.
15007 @item ARC725D
15008 Tune for ARC725D CPU.
15010 @item ARC750D
15011 Tune for ARC750D CPU.
15013 @end table
15015 @item -mmultcost=@var{num}
15016 @opindex mmultcost
15017 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15018 normal instruction.
15020 @item -munalign-prob-threshold=@var{probability}
15021 @opindex munalign-prob-threshold
15022 Set probability threshold for unaligning branches.
15023 When tuning for @samp{ARC700} and optimizing for speed, branches without
15024 filled delay slot are preferably emitted unaligned and long, unless
15025 profiling indicates that the probability for the branch to be taken
15026 is below @var{probability}.  @xref{Cross-profiling}.
15027 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15029 @end table
15031 The following options are maintained for backward compatibility, but
15032 are now deprecated and will be removed in a future release:
15034 @c Deprecated options
15035 @table @gcctabopt
15037 @item -margonaut
15038 @opindex margonaut
15039 Obsolete FPX.
15041 @item -mbig-endian
15042 @opindex mbig-endian
15043 @itemx -EB
15044 @opindex EB
15045 Compile code for big-endian targets.  Use of these options is now
15046 deprecated.  Big-endian code is supported by configuring GCC to build
15047 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15048 for which big endian is the default.
15050 @item -mlittle-endian
15051 @opindex mlittle-endian
15052 @itemx -EL
15053 @opindex EL
15054 Compile code for little-endian targets.  Use of these options is now
15055 deprecated.  Little-endian code is supported by configuring GCC to build 
15056 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15057 for which little endian is the default.
15059 @item -mbarrel_shifter
15060 @opindex mbarrel_shifter
15061 Replaced by @option{-mbarrel-shifter}.
15063 @item -mdpfp_compact
15064 @opindex mdpfp_compact
15065 Replaced by @option{-mdpfp-compact}.
15067 @item -mdpfp_fast
15068 @opindex mdpfp_fast
15069 Replaced by @option{-mdpfp-fast}.
15071 @item -mdsp_packa
15072 @opindex mdsp_packa
15073 Replaced by @option{-mdsp-packa}.
15075 @item -mEA
15076 @opindex mEA
15077 Replaced by @option{-mea}.
15079 @item -mmac_24
15080 @opindex mmac_24
15081 Replaced by @option{-mmac-24}.
15083 @item -mmac_d16
15084 @opindex mmac_d16
15085 Replaced by @option{-mmac-d16}.
15087 @item -mspfp_compact
15088 @opindex mspfp_compact
15089 Replaced by @option{-mspfp-compact}.
15091 @item -mspfp_fast
15092 @opindex mspfp_fast
15093 Replaced by @option{-mspfp-fast}.
15095 @item -mtune=@var{cpu}
15096 @opindex mtune
15097 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15098 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15099 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15101 @item -multcost=@var{num}
15102 @opindex multcost
15103 Replaced by @option{-mmultcost}.
15105 @end table
15107 @node ARM Options
15108 @subsection ARM Options
15109 @cindex ARM options
15111 These @samp{-m} options are defined for the ARM port:
15113 @table @gcctabopt
15114 @item -mabi=@var{name}
15115 @opindex mabi
15116 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15117 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15119 @item -mapcs-frame
15120 @opindex mapcs-frame
15121 Generate a stack frame that is compliant with the ARM Procedure Call
15122 Standard for all functions, even if this is not strictly necessary for
15123 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15124 with this option causes the stack frames not to be generated for
15125 leaf functions.  The default is @option{-mno-apcs-frame}.
15126 This option is deprecated.
15128 @item -mapcs
15129 @opindex mapcs
15130 This is a synonym for @option{-mapcs-frame} and is deprecated.
15132 @ignore
15133 @c not currently implemented
15134 @item -mapcs-stack-check
15135 @opindex mapcs-stack-check
15136 Generate code to check the amount of stack space available upon entry to
15137 every function (that actually uses some stack space).  If there is
15138 insufficient space available then either the function
15139 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15140 called, depending upon the amount of stack space required.  The runtime
15141 system is required to provide these functions.  The default is
15142 @option{-mno-apcs-stack-check}, since this produces smaller code.
15144 @c not currently implemented
15145 @item -mapcs-reentrant
15146 @opindex mapcs-reentrant
15147 Generate reentrant, position-independent code.  The default is
15148 @option{-mno-apcs-reentrant}.
15149 @end ignore
15151 @item -mthumb-interwork
15152 @opindex mthumb-interwork
15153 Generate code that supports calling between the ARM and Thumb
15154 instruction sets.  Without this option, on pre-v5 architectures, the
15155 two instruction sets cannot be reliably used inside one program.  The
15156 default is @option{-mno-thumb-interwork}, since slightly larger code
15157 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15158 configurations this option is meaningless.
15160 @item -mno-sched-prolog
15161 @opindex mno-sched-prolog
15162 Prevent the reordering of instructions in the function prologue, or the
15163 merging of those instruction with the instructions in the function's
15164 body.  This means that all functions start with a recognizable set
15165 of instructions (or in fact one of a choice from a small set of
15166 different function prologues), and this information can be used to
15167 locate the start of functions inside an executable piece of code.  The
15168 default is @option{-msched-prolog}.
15170 @item -mfloat-abi=@var{name}
15171 @opindex mfloat-abi
15172 Specifies which floating-point ABI to use.  Permissible values
15173 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15175 Specifying @samp{soft} causes GCC to generate output containing
15176 library calls for floating-point operations.
15177 @samp{softfp} allows the generation of code using hardware floating-point
15178 instructions, but still uses the soft-float calling conventions.
15179 @samp{hard} allows generation of floating-point instructions
15180 and uses FPU-specific calling conventions.
15182 The default depends on the specific target configuration.  Note that
15183 the hard-float and soft-float ABIs are not link-compatible; you must
15184 compile your entire program with the same ABI, and link with a
15185 compatible set of libraries.
15187 @item -mlittle-endian
15188 @opindex mlittle-endian
15189 Generate code for a processor running in little-endian mode.  This is
15190 the default for all standard configurations.
15192 @item -mbig-endian
15193 @opindex mbig-endian
15194 Generate code for a processor running in big-endian mode; the default is
15195 to compile code for a little-endian processor.
15197 @item -mbe8
15198 @itemx -mbe32
15199 @opindex mbe8
15200 When linking a big-endian image select between BE8 and BE32 formats.
15201 The option has no effect for little-endian images and is ignored.  The
15202 default is dependent on the selected target architecture.  For ARMv6
15203 and later architectures the default is BE8, for older architectures
15204 the default is BE32.  BE32 format has been deprecated by ARM.
15206 @item -march=@var{name@r{[}+extension@dots{}@r{]}}
15207 @opindex march
15208 This specifies the name of the target ARM architecture.  GCC uses this
15209 name to determine what kind of instructions it can emit when generating
15210 assembly code.  This option can be used in conjunction with or instead
15211 of the @option{-mcpu=} option.
15213 Permissible names are:
15214 @samp{armv4t},
15215 @samp{armv5t}, @samp{armv5te},
15216 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15217 @samp{armv6z}, @samp{armv6zk},
15218 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15219 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15220 @samp{armv7-r},
15221 @samp{armv6-m}, @samp{armv6s-m},
15222 @samp{armv7-m}, @samp{armv7e-m},
15223 @samp{armv8-m.base}, @samp{armv8-m.main},
15224 @samp{iwmmxt} and @samp{iwmmxt2}.
15226 Additionally, the following architectures, which lack support for the
15227 Thumb exection state, are recognized but support is deprecated:
15228 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15229 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15231 Many of the architectures support extensions.  These can be added by
15232 appending @samp{+@var{extension}} to the architecture name.  Extension
15233 options are processed in order and capabilities accumulate.  An extension
15234 will also enable any necessary base extensions
15235 upon which it depends.  For example, the @samp{+crypto} extension
15236 will always enable the @samp{+simd} extension.  The exception to the
15237 additive construction is for extensions that are prefixed with
15238 @samp{+no@dots{}}: these extensions disable the specified option and
15239 any other extensions that may depend on the presence of that
15240 extension.
15242 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15243 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15244 entirely disabled by the @samp{+nofp} option that follows it.
15246 Most extension names are generically named, but have an effect that is
15247 dependent upon the architecture to which it is applied.  For example,
15248 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15249 @samp{armv8-a} architectures, but will enable the original ARMv7
15250 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15251 variant for @samp{armv8-a}.
15253 The table below lists the supported extensions for each architecture.
15254 Architectures not mentioned do not support any extensions.
15256 @table @samp
15257 @item  armv5e
15258 @itemx armv5te
15259 @itemx armv6
15260 @itemx armv6j
15261 @itemx armv6k
15262 @itemx armv6kz
15263 @itemx armv6t2
15264 @itemx armv6z
15265 @itemx armv6zk
15266 @table @samp
15267 @item +fp
15268 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15269 used as an alias for this extension.
15271 @item +nofp
15272 Disable the floating-point instructions.
15273 @end table
15275 @item armv7
15276 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15277 @table @samp
15278 @item +fp
15279 The VFPv3 floating-point instructions, with 16 double-precision
15280 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15281 for this extension.  Note that floating-point is not supported by the
15282 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15283 ARMv7-R architectures.
15285 @item +nofp
15286 Disable the floating-point instructions.
15287 @end table
15289 @item armv7-a
15290 @table @samp
15291 @item +fp
15292 The VFPv3 floating-point instructions, with 16 double-precision
15293 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15294 for this extension.
15296 @item +simd
15297 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15298 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15299 for this extension.
15301 @item +vfpv3
15302 The VFPv3 floating-point instructions, with 32 double-precision
15303 registers.
15305 @item +vfpv3-d16-fp16
15306 The VFPv3 floating-point instructions, with 16 double-precision
15307 registers and the half-precision floating-point conversion operations.
15309 @item +vfpv3-fp16
15310 The VFPv3 floating-point instructions, with 32 double-precision
15311 registers and the half-precision floating-point conversion operations.
15313 @item +vfpv4-d16
15314 The VFPv4 floating-point instructions, with 16 double-precision
15315 registers.
15317 @item +vfpv4
15318 The VFPv4 floating-point instructions, with 32 double-precision
15319 registers.
15321 @item +neon-fp16
15322 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15323 the half-precision floating-point conversion operations.
15325 @item +neon-vfpv4
15326 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15328 @item +nosimd
15329 Disable the Advanced SIMD instructions (does not disable floating point).
15331 @item +nofp
15332 Disable the floating-point and Advanced SIMD instructions.
15333 @end table
15335 @item armv7ve
15336 The extended version of the ARMv7-A architecture with support for
15337 virtualization.
15338 @table @samp
15339 @item +fp
15340 The VFPv4 floating-point instructions, with 16 double-precision registers.
15341 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15343 @item +simd
15344 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15345 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15347 @item +vfpv3-d16
15348 The VFPv3 floating-point instructions, with 16 double-precision
15349 registers.
15351 @item +vfpv3
15352 The VFPv3 floating-point instructions, with 32 double-precision
15353 registers.
15355 @item +vfpv3-d16-fp16
15356 The VFPv3 floating-point instructions, with 16 double-precision
15357 registers and the half-precision floating-point conversion operations.
15359 @item +vfpv3-fp16
15360 The VFPv3 floating-point instructions, with 32 double-precision
15361 registers and the half-precision floating-point conversion operations.
15363 @item +vfpv4-d16
15364 The VFPv4 floating-point instructions, with 16 double-precision
15365 registers.
15367 @item +vfpv4
15368 The VFPv4 floating-point instructions, with 32 double-precision
15369 registers.
15371 @item +neon
15372 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15373 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15375 @item +neon-fp16
15376 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15377 the half-precision floating-point conversion operations.
15379 @item +nosimd
15380 Disable the Advanced SIMD instructions (does not disable floating point).
15382 @item +nofp
15383 Disable the floating-point and Advanced SIMD instructions.
15384 @end table
15386 @item armv8-a
15387 @table @samp
15388 @item +crc
15389 The Cyclic Redundancy Check (CRC) instructions.
15390 @item +simd
15391 The ARMv8 Advanced SIMD and floating-point instructions.
15392 @item +crypto
15393 The cryptographic instructions.
15394 @item +nocrypto
15395 Disable the cryptographic isntructions.
15396 @item +nofp
15397 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15398 @end table
15400 @item armv8.1-a
15401 @table @samp
15402 @item +simd
15403 The ARMv8.1 Advanced SIMD and floating-point instructions.
15405 @item +crypto
15406 The cryptographic instructions.  This also enables the Advanced SIMD and
15407 floating-point instructions.
15409 @item +nocrypto
15410 Disable the cryptographic isntructions.
15412 @item +nofp
15413 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15414 @end table
15416 @item armv8.2-a
15417 @table @samp
15418 @item +fp16
15419 The half-precision floating-point data processing instructions.
15420 This also enables the Advanced SIMD and floating-point instructions.
15422 @item +simd
15423 The ARMv8.1 Advanced SIMD and floating-point instructions.
15425 @item +crypto
15426 The cryptographic instructions.  This also enables the Advanced SIMD and
15427 floating-point instructions.
15429 @item +nocrypto
15430 Disable the cryptographic extension.
15432 @item +nofp
15433 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15434 @end table
15436 @item armv7-r
15437 @table @samp
15438 @item +fp.sp
15439 The single-precision VFPv3 floating-point instructions.  The extension
15440 @samp{+vfpv3xd} can be used as an alias for this extension.
15442 @item +fp
15443 The VFPv3 floating-point instructions with 16 double-precision registers.
15444 The extension +vfpv3-d16 can be used as an alias for this extension.
15446 @item +nofp
15447 Disable the floating-point extension.
15449 @item +idiv
15450 The ARM-state integer division instructions.
15452 @item +noidiv
15453 Disable the ARM-state integer division extension.
15454 @end table
15456 @item armv7e-m
15457 @table @samp
15458 @item +fp
15459 The single-precision VFPv4 floating-point instructions.
15461 @item +fpv5
15462 The single-precision FPv5 floating-point instructions.
15464 @item +fp.dp
15465 The single- and double-precision FPv5 floating-point instructions.
15467 @item +nofp
15468 Disable the floating-point extensions.
15469 @end table
15471 @item  armv8-m.main
15472 @table @samp
15473 @item +dsp
15474 The DSP instructions.
15476 @item +nodsp
15477 Disable the DSP extension.
15479 @item +fp
15480 The single-precision floating-point instructions.
15482 @item +fp.dp
15483 The single- and double-precision floating-point instructions.
15485 @item +nofp
15486 Disable the floating-point extension.
15488 @end table
15490 @end table
15492 @option{-march=native} causes the compiler to auto-detect the architecture
15493 of the build computer.  At present, this feature is only supported on
15494 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15495 is unsuccessful the option has no effect.
15497 @item -mtune=@var{name}
15498 @opindex mtune
15499 This option specifies the name of the target ARM processor for
15500 which GCC should tune the performance of the code.
15501 For some ARM implementations better performance can be obtained by using
15502 this option.
15503 Permissible names are: @samp{arm2}, @samp{arm250},
15504 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15505 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15506 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15507 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15508 @samp{arm720},
15509 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15510 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15511 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15512 @samp{strongarm1110},
15513 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15514 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15515 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15516 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15517 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15518 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15519 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15520 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15521 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15522 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15523 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15524 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15525 @samp{cortex-r8},
15526 @samp{cortex-m33},
15527 @samp{cortex-m23},
15528 @samp{cortex-m7},
15529 @samp{cortex-m4},
15530 @samp{cortex-m3},
15531 @samp{cortex-m1},
15532 @samp{cortex-m0},
15533 @samp{cortex-m0plus},
15534 @samp{cortex-m1.small-multiply},
15535 @samp{cortex-m0.small-multiply},
15536 @samp{cortex-m0plus.small-multiply},
15537 @samp{exynos-m1},
15538 @samp{marvell-pj4},
15539 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15540 @samp{fa526}, @samp{fa626},
15541 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15542 @samp{xgene1}.
15544 Additionally, this option can specify that GCC should tune the performance
15545 of the code for a big.LITTLE system.  Permissible names are:
15546 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15547 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15548 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15549 @samp{cortex-a75.cortex-a55}.
15551 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15552 performance for a blend of processors within architecture @var{arch}.
15553 The aim is to generate code that run well on the current most popular
15554 processors, balancing between optimizations that benefit some CPUs in the
15555 range, and avoiding performance pitfalls of other CPUs.  The effects of
15556 this option may change in future GCC versions as CPU models come and go.
15558 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15559 the extension options do not affect the tuning of the generated code.
15561 @option{-mtune=native} causes the compiler to auto-detect the CPU
15562 of the build computer.  At present, this feature is only supported on
15563 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15564 unsuccessful the option has no effect.
15566 @item -mcpu=@var{name@r{[}+extension@dots{}@r{]}}
15567 @opindex mcpu
15568 This specifies the name of the target ARM processor.  GCC uses this name
15569 to derive the name of the target ARM architecture (as if specified
15570 by @option{-march}) and the ARM processor type for which to tune for
15571 performance (as if specified by @option{-mtune}).  Where this option
15572 is used in conjunction with @option{-march} or @option{-mtune},
15573 those options take precedence over the appropriate part of this option.
15575 Many of the supported CPUs implement optional architectural
15576 extensions.  Where this is so the architectural extensions are
15577 normally enabled by default.  If implementations that lack the
15578 extension exist, then the extension syntax can be used to disable
15579 those extensions that have been omitted.  For floating-point and
15580 Advanced SIMD (Neon) instructions, the settings of the options
15581 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15582 floating-point and Advanced SIMD instructions will only be used if
15583 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15584 @option{-mfpu} other than @samp{auto} will override the available
15585 floating-point and SIMD extension instructions.
15587 For example, @samp{cortex-a9} can be found in three major
15588 configurations: integer only, with just a floating-point unit or with
15589 floating-point and Advanced SIMD.  The default is to enable all the
15590 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15591 be used to disable just the SIMD or both the SIMD and floating-point
15592 instructions respectively.
15594 Permissible names for this option are the same as those for
15595 @option{-mtune}.
15597 The following extension options are common to the listed CPUs:
15599 @table @samp
15600 @item  +nofp
15601 Disables the floating-point instructions on @samp{arm9e},
15602 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15603 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15604 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15605 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15606 Disables the floating-point and SIMD instructions on
15607 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15608 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15609 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15610 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
15611 @samp{cortex-a53} and @samp{cortex-a55}.
15613 @item +nofp.dp
15614 Disables the double-precision component of the floating-point instructions
15615 on @samp{cortex-r5} and @samp{cortex-m7}.
15617 @item +nosimd
15618 Disables the SIMD (but not floating-point) instructions on
15619 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15620 and @samp{cortex-a9}.
15621 @end table
15623 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15624 VFPv3 with 16 double-precision registers.  It supports the following
15625 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15626 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15627 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15628 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15629 @option{-march=armv7-a}.
15631 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15632 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15633 See @option{-mtune} for more information.
15635 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15636 of the build computer.  At present, this feature is only supported on
15637 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15638 is unsuccessful the option has no effect.
15640 @item -mfpu=@var{name}
15641 @opindex mfpu
15642 This specifies what floating-point hardware (or hardware emulation) is
15643 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15644 @samp{vfpv3},
15645 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15646 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15647 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15648 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15649 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15650 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15651 is an alias for @samp{vfpv2}.
15653 The setting @samp{auto} is the default and is special.  It causes the
15654 compiler to select the floating-point and Advanced SIMD instructions
15655 based on the settings of @option{-mcpu} and @option{-march}.
15657 If the selected floating-point hardware includes the NEON extension
15658 (e.g. @option{-mfpu=neon}), note that floating-point
15659 operations are not generated by GCC's auto-vectorization pass unless
15660 @option{-funsafe-math-optimizations} is also specified.  This is
15661 because NEON hardware does not fully implement the IEEE 754 standard for
15662 floating-point arithmetic (in particular denormal values are treated as
15663 zero), so the use of NEON instructions may lead to a loss of precision.
15665 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}).
15667 @item -mfp16-format=@var{name}
15668 @opindex mfp16-format
15669 Specify the format of the @code{__fp16} half-precision floating-point type.
15670 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15671 the default is @samp{none}, in which case the @code{__fp16} type is not
15672 defined.  @xref{Half-Precision}, for more information.
15674 @item -mstructure-size-boundary=@var{n}
15675 @opindex mstructure-size-boundary
15676 The sizes of all structures and unions are rounded up to a multiple
15677 of the number of bits set by this option.  Permissible values are 8, 32
15678 and 64.  The default value varies for different toolchains.  For the COFF
15679 targeted toolchain the default value is 8.  A value of 64 is only allowed
15680 if the underlying ABI supports it.
15682 Specifying a larger number can produce faster, more efficient code, but
15683 can also increase the size of the program.  Different values are potentially
15684 incompatible.  Code compiled with one value cannot necessarily expect to
15685 work with code or libraries compiled with another value, if they exchange
15686 information using structures or unions.
15688 @item -mabort-on-noreturn
15689 @opindex mabort-on-noreturn
15690 Generate a call to the function @code{abort} at the end of a
15691 @code{noreturn} function.  It is executed if the function tries to
15692 return.
15694 @item -mlong-calls
15695 @itemx -mno-long-calls
15696 @opindex mlong-calls
15697 @opindex mno-long-calls
15698 Tells the compiler to perform function calls by first loading the
15699 address of the function into a register and then performing a subroutine
15700 call on this register.  This switch is needed if the target function
15701 lies outside of the 64-megabyte addressing range of the offset-based
15702 version of subroutine call instruction.
15704 Even if this switch is enabled, not all function calls are turned
15705 into long calls.  The heuristic is that static functions, functions
15706 that have the @code{short_call} attribute, functions that are inside
15707 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15708 definitions have already been compiled within the current compilation
15709 unit are not turned into long calls.  The exceptions to this rule are
15710 that weak function definitions, functions with the @code{long_call}
15711 attribute or the @code{section} attribute, and functions that are within
15712 the scope of a @code{#pragma long_calls} directive are always
15713 turned into long calls.
15715 This feature is not enabled by default.  Specifying
15716 @option{-mno-long-calls} restores the default behavior, as does
15717 placing the function calls within the scope of a @code{#pragma
15718 long_calls_off} directive.  Note these switches have no effect on how
15719 the compiler generates code to handle function calls via function
15720 pointers.
15722 @item -msingle-pic-base
15723 @opindex msingle-pic-base
15724 Treat the register used for PIC addressing as read-only, rather than
15725 loading it in the prologue for each function.  The runtime system is
15726 responsible for initializing this register with an appropriate value
15727 before execution begins.
15729 @item -mpic-register=@var{reg}
15730 @opindex mpic-register
15731 Specify the register to be used for PIC addressing.
15732 For standard PIC base case, the default is any suitable register
15733 determined by compiler.  For single PIC base case, the default is
15734 @samp{R9} if target is EABI based or stack-checking is enabled,
15735 otherwise the default is @samp{R10}.
15737 @item -mpic-data-is-text-relative
15738 @opindex mpic-data-is-text-relative
15739 Assume that the displacement between the text and data segments is fixed
15740 at static link time.  This permits using PC-relative addressing
15741 operations to access data known to be in the data segment.  For
15742 non-VxWorks RTP targets, this option is enabled by default.  When
15743 disabled on such targets, it will enable @option{-msingle-pic-base} by
15744 default.
15746 @item -mpoke-function-name
15747 @opindex mpoke-function-name
15748 Write the name of each function into the text section, directly
15749 preceding the function prologue.  The generated code is similar to this:
15751 @smallexample
15752      t0
15753          .ascii "arm_poke_function_name", 0
15754          .align
15755      t1
15756          .word 0xff000000 + (t1 - t0)
15757      arm_poke_function_name
15758          mov     ip, sp
15759          stmfd   sp!, @{fp, ip, lr, pc@}
15760          sub     fp, ip, #4
15761 @end smallexample
15763 When performing a stack backtrace, code can inspect the value of
15764 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15765 location @code{pc - 12} and the top 8 bits are set, then we know that
15766 there is a function name embedded immediately preceding this location
15767 and has length @code{((pc[-3]) & 0xff000000)}.
15769 @item -mthumb
15770 @itemx -marm
15771 @opindex marm
15772 @opindex mthumb
15774 Select between generating code that executes in ARM and Thumb
15775 states.  The default for most configurations is to generate code
15776 that executes in ARM state, but the default can be changed by
15777 configuring GCC with the @option{--with-mode=}@var{state}
15778 configure option.
15780 You can also override the ARM and Thumb mode for each function
15781 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15782 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15784 @item -mtpcs-frame
15785 @opindex mtpcs-frame
15786 Generate a stack frame that is compliant with the Thumb Procedure Call
15787 Standard for all non-leaf functions.  (A leaf function is one that does
15788 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15790 @item -mtpcs-leaf-frame
15791 @opindex mtpcs-leaf-frame
15792 Generate a stack frame that is compliant with the Thumb Procedure Call
15793 Standard for all leaf functions.  (A leaf function is one that does
15794 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15796 @item -mcallee-super-interworking
15797 @opindex mcallee-super-interworking
15798 Gives all externally visible functions in the file being compiled an ARM
15799 instruction set header which switches to Thumb mode before executing the
15800 rest of the function.  This allows these functions to be called from
15801 non-interworking code.  This option is not valid in AAPCS configurations
15802 because interworking is enabled by default.
15804 @item -mcaller-super-interworking
15805 @opindex mcaller-super-interworking
15806 Allows calls via function pointers (including virtual functions) to
15807 execute correctly regardless of whether the target code has been
15808 compiled for interworking or not.  There is a small overhead in the cost
15809 of executing a function pointer if this option is enabled.  This option
15810 is not valid in AAPCS configurations because interworking is enabled
15811 by default.
15813 @item -mtp=@var{name}
15814 @opindex mtp
15815 Specify the access model for the thread local storage pointer.  The valid
15816 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15817 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15818 (supported in the arm6k architecture), and @samp{auto}, which uses the
15819 best available method for the selected processor.  The default setting is
15820 @samp{auto}.
15822 @item -mtls-dialect=@var{dialect}
15823 @opindex mtls-dialect
15824 Specify the dialect to use for accessing thread local storage.  Two
15825 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15826 @samp{gnu} dialect selects the original GNU scheme for supporting
15827 local and global dynamic TLS models.  The @samp{gnu2} dialect
15828 selects the GNU descriptor scheme, which provides better performance
15829 for shared libraries.  The GNU descriptor scheme is compatible with
15830 the original scheme, but does require new assembler, linker and
15831 library support.  Initial and local exec TLS models are unaffected by
15832 this option and always use the original scheme.
15834 @item -mword-relocations
15835 @opindex mword-relocations
15836 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15837 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15838 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15839 is specified.
15841 @item -mfix-cortex-m3-ldrd
15842 @opindex mfix-cortex-m3-ldrd
15843 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15844 with overlapping destination and base registers are used.  This option avoids
15845 generating these instructions.  This option is enabled by default when
15846 @option{-mcpu=cortex-m3} is specified.
15848 @item -munaligned-access
15849 @itemx -mno-unaligned-access
15850 @opindex munaligned-access
15851 @opindex mno-unaligned-access
15852 Enables (or disables) reading and writing of 16- and 32- bit values
15853 from addresses that are not 16- or 32- bit aligned.  By default
15854 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15855 ARMv8-M Baseline architectures, and enabled for all other
15856 architectures.  If unaligned access is not enabled then words in packed
15857 data structures are accessed a byte at a time.
15859 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15860 generated object file to either true or false, depending upon the
15861 setting of this option.  If unaligned access is enabled then the
15862 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15863 defined.
15865 @item -mneon-for-64bits
15866 @opindex mneon-for-64bits
15867 Enables using Neon to handle scalar 64-bits operations. This is
15868 disabled by default since the cost of moving data from core registers
15869 to Neon is high.
15871 @item -mslow-flash-data
15872 @opindex mslow-flash-data
15873 Assume loading data from flash is slower than fetching instruction.
15874 Therefore literal load is minimized for better performance.
15875 This option is only supported when compiling for ARMv7 M-profile and
15876 off by default.
15878 @item -masm-syntax-unified
15879 @opindex masm-syntax-unified
15880 Assume inline assembler is using unified asm syntax.  The default is
15881 currently off which implies divided syntax.  This option has no impact
15882 on Thumb2. However, this may change in future releases of GCC.
15883 Divided syntax should be considered deprecated.
15885 @item -mrestrict-it
15886 @opindex mrestrict-it
15887 Restricts generation of IT blocks to conform to the rules of ARMv8.
15888 IT blocks can only contain a single 16-bit instruction from a select
15889 set of instructions. This option is on by default for ARMv8 Thumb mode.
15891 @item -mprint-tune-info
15892 @opindex mprint-tune-info
15893 Print CPU tuning information as comment in assembler file.  This is
15894 an option used only for regression testing of the compiler and not
15895 intended for ordinary use in compiling code.  This option is disabled
15896 by default.
15898 @item -mpure-code
15899 @opindex mpure-code
15900 Do not allow constant data to be placed in code sections.
15901 Additionally, when compiling for ELF object format give all text sections the
15902 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15903 is only available when generating non-pic code for M-profile targets with the
15904 MOVT instruction.
15906 @item -mcmse
15907 @opindex mcmse
15908 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15909 Development Tools Engineering Specification", which can be found on
15910 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15911 @end table
15913 @node AVR Options
15914 @subsection AVR Options
15915 @cindex AVR Options
15917 These options are defined for AVR implementations:
15919 @table @gcctabopt
15920 @item -mmcu=@var{mcu}
15921 @opindex mmcu
15922 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15924 The default for this option is@tie{}@samp{avr2}.
15926 GCC supports the following AVR devices and ISAs:
15928 @include avr-mmcu.texi
15930 @item -mabsdata
15931 @opindex mabsdata
15933 Assume that all data in static storage can be accessed by LDS / STS
15934 instructions.  This option has only an effect on reduced Tiny devices like
15935 ATtiny40.  See also the @code{absdata}
15936 @ref{AVR Variable Attributes,variable attribute}.
15938 @item -maccumulate-args
15939 @opindex maccumulate-args
15940 Accumulate outgoing function arguments and acquire/release the needed
15941 stack space for outgoing function arguments once in function
15942 prologue/epilogue.  Without this option, outgoing arguments are pushed
15943 before calling a function and popped afterwards.
15945 Popping the arguments after the function call can be expensive on
15946 AVR so that accumulating the stack space might lead to smaller
15947 executables because arguments need not be removed from the
15948 stack after such a function call.
15950 This option can lead to reduced code size for functions that perform
15951 several calls to functions that get their arguments on the stack like
15952 calls to printf-like functions.
15954 @item -mbranch-cost=@var{cost}
15955 @opindex mbranch-cost
15956 Set the branch costs for conditional branch instructions to
15957 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15958 integers. The default branch cost is 0.
15960 @item -mcall-prologues
15961 @opindex mcall-prologues
15962 Functions prologues/epilogues are expanded as calls to appropriate
15963 subroutines.  Code size is smaller.
15965 @item -mint8
15966 @opindex mint8
15967 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15968 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15969 and @code{long long} is 4 bytes.  Please note that this option does not
15970 conform to the C standards, but it results in smaller code
15971 size.
15973 @item -mn-flash=@var{num}
15974 @opindex mn-flash
15975 Assume that the flash memory has a size of 
15976 @var{num} times 64@tie{}KiB.
15978 @item -mno-interrupts
15979 @opindex mno-interrupts
15980 Generated code is not compatible with hardware interrupts.
15981 Code size is smaller.
15983 @item -mrelax
15984 @opindex mrelax
15985 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15986 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15987 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15988 the assembler's command line and the @option{--relax} option to the
15989 linker's command line.
15991 Jump relaxing is performed by the linker because jump offsets are not
15992 known before code is located. Therefore, the assembler code generated by the
15993 compiler is the same, but the instructions in the executable may
15994 differ from instructions in the assembler code.
15996 Relaxing must be turned on if linker stubs are needed, see the
15997 section on @code{EIND} and linker stubs below.
15999 @item -mrmw
16000 @opindex mrmw
16001 Assume that the device supports the Read-Modify-Write
16002 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16004 @item -mshort-calls
16005 @opindex mshort-calls
16007 Assume that @code{RJMP} and @code{RCALL} can target the whole
16008 program memory.
16010 This option is used internally for multilib selection.  It is
16011 not an optimization option, and you don't need to set it by hand.
16013 @item -msp8
16014 @opindex msp8
16015 Treat the stack pointer register as an 8-bit register,
16016 i.e.@: assume the high byte of the stack pointer is zero.
16017 In general, you don't need to set this option by hand.
16019 This option is used internally by the compiler to select and
16020 build multilibs for architectures @code{avr2} and @code{avr25}.
16021 These architectures mix devices with and without @code{SPH}.
16022 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16023 the compiler driver adds or removes this option from the compiler
16024 proper's command line, because the compiler then knows if the device
16025 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16026 register or not.
16028 @item -mstrict-X
16029 @opindex mstrict-X
16030 Use address register @code{X} in a way proposed by the hardware.  This means
16031 that @code{X} is only used in indirect, post-increment or
16032 pre-decrement addressing.
16034 Without this option, the @code{X} register may be used in the same way
16035 as @code{Y} or @code{Z} which then is emulated by additional
16036 instructions.  
16037 For example, loading a value with @code{X+const} addressing with a
16038 small non-negative @code{const < 64} to a register @var{Rn} is
16039 performed as
16041 @example
16042 adiw r26, const   ; X += const
16043 ld   @var{Rn}, X        ; @var{Rn} = *X
16044 sbiw r26, const   ; X -= const
16045 @end example
16047 @item -mtiny-stack
16048 @opindex mtiny-stack
16049 Only change the lower 8@tie{}bits of the stack pointer.
16051 @item -mfract-convert-truncate
16052 @opindex mfract-convert-truncate
16053 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16055 @item -nodevicelib
16056 @opindex nodevicelib
16057 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16059 @item -Waddr-space-convert
16060 @opindex Waddr-space-convert
16061 Warn about conversions between address spaces in the case where the
16062 resulting address space is not contained in the incoming address space.
16064 @item -Wmisspelled-isr
16065 @opindex Wmisspelled-isr
16066 Warn if the ISR is misspelled, i.e. without __vector prefix.
16067 Enabled by default.
16068 @end table
16070 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16071 @cindex @code{EIND}
16072 Pointers in the implementation are 16@tie{}bits wide.
16073 The address of a function or label is represented as word address so
16074 that indirect jumps and calls can target any code address in the
16075 range of 64@tie{}Ki words.
16077 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16078 bytes of program memory space, there is a special function register called
16079 @code{EIND} that serves as most significant part of the target address
16080 when @code{EICALL} or @code{EIJMP} instructions are used.
16082 Indirect jumps and calls on these devices are handled as follows by
16083 the compiler and are subject to some limitations:
16085 @itemize @bullet
16087 @item
16088 The compiler never sets @code{EIND}.
16090 @item
16091 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16092 instructions or might read @code{EIND} directly in order to emulate an
16093 indirect call/jump by means of a @code{RET} instruction.
16095 @item
16096 The compiler assumes that @code{EIND} never changes during the startup
16097 code or during the application. In particular, @code{EIND} is not
16098 saved/restored in function or interrupt service routine
16099 prologue/epilogue.
16101 @item
16102 For indirect calls to functions and computed goto, the linker
16103 generates @emph{stubs}. Stubs are jump pads sometimes also called
16104 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16105 The stub contains a direct jump to the desired address.
16107 @item
16108 Linker relaxation must be turned on so that the linker generates
16109 the stubs correctly in all situations. See the compiler option
16110 @option{-mrelax} and the linker option @option{--relax}.
16111 There are corner cases where the linker is supposed to generate stubs
16112 but aborts without relaxation and without a helpful error message.
16114 @item
16115 The default linker script is arranged for code with @code{EIND = 0}.
16116 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16117 linker script has to be used in order to place the sections whose
16118 name start with @code{.trampolines} into the segment where @code{EIND}
16119 points to.
16121 @item
16122 The startup code from libgcc never sets @code{EIND}.
16123 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16124 For the impact of AVR-LibC on @code{EIND}, see the
16125 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16127 @item
16128 It is legitimate for user-specific startup code to set up @code{EIND}
16129 early, for example by means of initialization code located in
16130 section @code{.init3}. Such code runs prior to general startup code
16131 that initializes RAM and calls constructors, but after the bit
16132 of startup code from AVR-LibC that sets @code{EIND} to the segment
16133 where the vector table is located.
16134 @example
16135 #include <avr/io.h>
16137 static void
16138 __attribute__((section(".init3"),naked,used,no_instrument_function))
16139 init3_set_eind (void)
16141   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16142                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16144 @end example
16146 @noindent
16147 The @code{__trampolines_start} symbol is defined in the linker script.
16149 @item
16150 Stubs are generated automatically by the linker if
16151 the following two conditions are met:
16152 @itemize @minus
16154 @item The address of a label is taken by means of the @code{gs} modifier
16155 (short for @emph{generate stubs}) like so:
16156 @example
16157 LDI r24, lo8(gs(@var{func}))
16158 LDI r25, hi8(gs(@var{func}))
16159 @end example
16160 @item The final location of that label is in a code segment
16161 @emph{outside} the segment where the stubs are located.
16162 @end itemize
16164 @item
16165 The compiler emits such @code{gs} modifiers for code labels in the
16166 following situations:
16167 @itemize @minus
16168 @item Taking address of a function or code label.
16169 @item Computed goto.
16170 @item If prologue-save function is used, see @option{-mcall-prologues}
16171 command-line option.
16172 @item Switch/case dispatch tables. If you do not want such dispatch
16173 tables you can specify the @option{-fno-jump-tables} command-line option.
16174 @item C and C++ constructors/destructors called during startup/shutdown.
16175 @item If the tools hit a @code{gs()} modifier explained above.
16176 @end itemize
16178 @item
16179 Jumping to non-symbolic addresses like so is @emph{not} supported:
16181 @example
16182 int main (void)
16184     /* Call function at word address 0x2 */
16185     return ((int(*)(void)) 0x2)();
16187 @end example
16189 Instead, a stub has to be set up, i.e.@: the function has to be called
16190 through a symbol (@code{func_4} in the example):
16192 @example
16193 int main (void)
16195     extern int func_4 (void);
16197     /* Call function at byte address 0x4 */
16198     return func_4();
16200 @end example
16202 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16203 Alternatively, @code{func_4} can be defined in the linker script.
16204 @end itemize
16206 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16207 @cindex @code{RAMPD}
16208 @cindex @code{RAMPX}
16209 @cindex @code{RAMPY}
16210 @cindex @code{RAMPZ}
16211 Some AVR devices support memories larger than the 64@tie{}KiB range
16212 that can be accessed with 16-bit pointers.  To access memory locations
16213 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16214 register is used as high part of the address:
16215 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16216 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16217 register, respectively, to get a wide address. Similarly,
16218 @code{RAMPD} is used together with direct addressing.
16220 @itemize
16221 @item
16222 The startup code initializes the @code{RAMP} special function
16223 registers with zero.
16225 @item
16226 If a @ref{AVR Named Address Spaces,named address space} other than
16227 generic or @code{__flash} is used, then @code{RAMPZ} is set
16228 as needed before the operation.
16230 @item
16231 If the device supports RAM larger than 64@tie{}KiB and the compiler
16232 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16233 is reset to zero after the operation.
16235 @item
16236 If the device comes with a specific @code{RAMP} register, the ISR
16237 prologue/epilogue saves/restores that SFR and initializes it with
16238 zero in case the ISR code might (implicitly) use it.
16240 @item
16241 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16242 If you use inline assembler to read from locations outside the
16243 16-bit address range and change one of the @code{RAMP} registers,
16244 you must reset it to zero after the access.
16246 @end itemize
16248 @subsubsection AVR Built-in Macros
16250 GCC defines several built-in macros so that the user code can test
16251 for the presence or absence of features.  Almost any of the following
16252 built-in macros are deduced from device capabilities and thus
16253 triggered by the @option{-mmcu=} command-line option.
16255 For even more AVR-specific built-in macros see
16256 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16258 @table @code
16260 @item __AVR_ARCH__
16261 Build-in macro that resolves to a decimal number that identifies the
16262 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16263 Possible values are:
16265 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16266 @code{4}, @code{5}, @code{51}, @code{6}
16268 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16269 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16271 respectively and
16273 @code{100},
16274 @code{102}, @code{103}, @code{104},
16275 @code{105}, @code{106}, @code{107}
16277 for @var{mcu}=@code{avrtiny},
16278 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16279 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16280 If @var{mcu} specifies a device, this built-in macro is set
16281 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16282 defined to @code{4}.
16284 @item __AVR_@var{Device}__
16285 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16286 the device's name. For example, @option{-mmcu=atmega8} defines the
16287 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16288 @code{__AVR_ATtiny261A__}, etc.
16290 The built-in macros' names follow
16291 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16292 the device name as from the AVR user manual. The difference between
16293 @var{Device} in the built-in macro and @var{device} in
16294 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16296 If @var{device} is not a device but only a core architecture like
16297 @samp{avr51}, this macro is not defined.
16299 @item __AVR_DEVICE_NAME__
16300 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16301 the device's name. For example, with @option{-mmcu=atmega8} the macro
16302 is defined to @code{atmega8}.
16304 If @var{device} is not a device but only a core architecture like
16305 @samp{avr51}, this macro is not defined.
16307 @item __AVR_XMEGA__
16308 The device / architecture belongs to the XMEGA family of devices.
16310 @item __AVR_HAVE_ELPM__
16311 The device has the @code{ELPM} instruction.
16313 @item __AVR_HAVE_ELPMX__
16314 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16315 R@var{n},Z+} instructions.
16317 @item __AVR_HAVE_MOVW__
16318 The device has the @code{MOVW} instruction to perform 16-bit
16319 register-register moves.
16321 @item __AVR_HAVE_LPMX__
16322 The device has the @code{LPM R@var{n},Z} and
16323 @code{LPM R@var{n},Z+} instructions.
16325 @item __AVR_HAVE_MUL__
16326 The device has a hardware multiplier. 
16328 @item __AVR_HAVE_JMP_CALL__
16329 The device has the @code{JMP} and @code{CALL} instructions.
16330 This is the case for devices with more than 8@tie{}KiB of program
16331 memory.
16333 @item __AVR_HAVE_EIJMP_EICALL__
16334 @itemx __AVR_3_BYTE_PC__
16335 The device has the @code{EIJMP} and @code{EICALL} instructions.
16336 This is the case for devices with more than 128@tie{}KiB of program memory.
16337 This also means that the program counter
16338 (PC) is 3@tie{}bytes wide.
16340 @item __AVR_2_BYTE_PC__
16341 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16342 with up to 128@tie{}KiB of program memory.
16344 @item __AVR_HAVE_8BIT_SP__
16345 @itemx __AVR_HAVE_16BIT_SP__
16346 The stack pointer (SP) register is treated as 8-bit respectively
16347 16-bit register by the compiler.
16348 The definition of these macros is affected by @option{-mtiny-stack}.
16350 @item __AVR_HAVE_SPH__
16351 @itemx __AVR_SP8__
16352 The device has the SPH (high part of stack pointer) special function
16353 register or has an 8-bit stack pointer, respectively.
16354 The definition of these macros is affected by @option{-mmcu=} and
16355 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16356 by @option{-msp8}.
16358 @item __AVR_HAVE_RAMPD__
16359 @itemx __AVR_HAVE_RAMPX__
16360 @itemx __AVR_HAVE_RAMPY__
16361 @itemx __AVR_HAVE_RAMPZ__
16362 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16363 @code{RAMPZ} special function register, respectively.
16365 @item __NO_INTERRUPTS__
16366 This macro reflects the @option{-mno-interrupts} command-line option.
16368 @item __AVR_ERRATA_SKIP__
16369 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16370 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16371 instructions because of a hardware erratum.  Skip instructions are
16372 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16373 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16374 set.
16376 @item __AVR_ISA_RMW__
16377 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16379 @item __AVR_SFR_OFFSET__=@var{offset}
16380 Instructions that can address I/O special function registers directly
16381 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16382 address as if addressed by an instruction to access RAM like @code{LD}
16383 or @code{STS}. This offset depends on the device architecture and has
16384 to be subtracted from the RAM address in order to get the
16385 respective I/O@tie{}address.
16387 @item __AVR_SHORT_CALLS__
16388 The @option{-mshort-calls} command line option is set.
16390 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16391 Some devices support reading from flash memory by means of @code{LD*}
16392 instructions.  The flash memory is seen in the data address space
16393 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16394 is not defined, this feature is not available.  If defined,
16395 the address space is linear and there is no need to put
16396 @code{.rodata} into RAM.  This is handled by the default linker
16397 description file, and is currently available for
16398 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16399 there is no need to use address spaces like @code{__flash} or
16400 features like attribute @code{progmem} and @code{pgm_read_*}.
16402 @item __WITH_AVRLIBC__
16403 The compiler is configured to be used together with AVR-Libc.
16404 See the @option{--with-avrlibc} configure option.
16406 @end table
16408 @node Blackfin Options
16409 @subsection Blackfin Options
16410 @cindex Blackfin Options
16412 @table @gcctabopt
16413 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16414 @opindex mcpu=
16415 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16416 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16417 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16418 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16419 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16420 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16421 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16422 @samp{bf561}, @samp{bf592}.
16424 The optional @var{sirevision} specifies the silicon revision of the target
16425 Blackfin processor.  Any workarounds available for the targeted silicon revision
16426 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16427 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16428 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16429 hexadecimal digits representing the major and minor numbers in the silicon
16430 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16431 is not defined.  If @var{sirevision} is @samp{any}, the
16432 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16433 If this optional @var{sirevision} is not used, GCC assumes the latest known
16434 silicon revision of the targeted Blackfin processor.
16436 GCC defines a preprocessor macro for the specified @var{cpu}.
16437 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16438 provided by libgloss to be linked in if @option{-msim} is not given.
16440 Without this option, @samp{bf532} is used as the processor by default.
16442 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16443 only the preprocessor macro is defined.
16445 @item -msim
16446 @opindex msim
16447 Specifies that the program will be run on the simulator.  This causes
16448 the simulator BSP provided by libgloss to be linked in.  This option
16449 has effect only for @samp{bfin-elf} toolchain.
16450 Certain other options, such as @option{-mid-shared-library} and
16451 @option{-mfdpic}, imply @option{-msim}.
16453 @item -momit-leaf-frame-pointer
16454 @opindex momit-leaf-frame-pointer
16455 Don't keep the frame pointer in a register for leaf functions.  This
16456 avoids the instructions to save, set up and restore frame pointers and
16457 makes an extra register available in leaf functions.  The option
16458 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16459 which might make debugging harder.
16461 @item -mspecld-anomaly
16462 @opindex mspecld-anomaly
16463 When enabled, the compiler ensures that the generated code does not
16464 contain speculative loads after jump instructions. If this option is used,
16465 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16467 @item -mno-specld-anomaly
16468 @opindex mno-specld-anomaly
16469 Don't generate extra code to prevent speculative loads from occurring.
16471 @item -mcsync-anomaly
16472 @opindex mcsync-anomaly
16473 When enabled, the compiler ensures that the generated code does not
16474 contain CSYNC or SSYNC instructions too soon after conditional branches.
16475 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16477 @item -mno-csync-anomaly
16478 @opindex mno-csync-anomaly
16479 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16480 occurring too soon after a conditional branch.
16482 @item -mlow-64k
16483 @opindex mlow-64k
16484 When enabled, the compiler is free to take advantage of the knowledge that
16485 the entire program fits into the low 64k of memory.
16487 @item -mno-low-64k
16488 @opindex mno-low-64k
16489 Assume that the program is arbitrarily large.  This is the default.
16491 @item -mstack-check-l1
16492 @opindex mstack-check-l1
16493 Do stack checking using information placed into L1 scratchpad memory by the
16494 uClinux kernel.
16496 @item -mid-shared-library
16497 @opindex mid-shared-library
16498 Generate code that supports shared libraries via the library ID method.
16499 This allows for execute in place and shared libraries in an environment
16500 without virtual memory management.  This option implies @option{-fPIC}.
16501 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16503 @item -mno-id-shared-library
16504 @opindex mno-id-shared-library
16505 Generate code that doesn't assume ID-based shared libraries are being used.
16506 This is the default.
16508 @item -mleaf-id-shared-library
16509 @opindex mleaf-id-shared-library
16510 Generate code that supports shared libraries via the library ID method,
16511 but assumes that this library or executable won't link against any other
16512 ID shared libraries.  That allows the compiler to use faster code for jumps
16513 and calls.
16515 @item -mno-leaf-id-shared-library
16516 @opindex mno-leaf-id-shared-library
16517 Do not assume that the code being compiled won't link against any ID shared
16518 libraries.  Slower code is generated for jump and call insns.
16520 @item -mshared-library-id=n
16521 @opindex mshared-library-id
16522 Specifies the identification number of the ID-based shared library being
16523 compiled.  Specifying a value of 0 generates more compact code; specifying
16524 other values forces the allocation of that number to the current
16525 library but is no more space- or time-efficient than omitting this option.
16527 @item -msep-data
16528 @opindex msep-data
16529 Generate code that allows the data segment to be located in a different
16530 area of memory from the text segment.  This allows for execute in place in
16531 an environment without virtual memory management by eliminating relocations
16532 against the text section.
16534 @item -mno-sep-data
16535 @opindex mno-sep-data
16536 Generate code that assumes that the data segment follows the text segment.
16537 This is the default.
16539 @item -mlong-calls
16540 @itemx -mno-long-calls
16541 @opindex mlong-calls
16542 @opindex mno-long-calls
16543 Tells the compiler to perform function calls by first loading the
16544 address of the function into a register and then performing a subroutine
16545 call on this register.  This switch is needed if the target function
16546 lies outside of the 24-bit addressing range of the offset-based
16547 version of subroutine call instruction.
16549 This feature is not enabled by default.  Specifying
16550 @option{-mno-long-calls} restores the default behavior.  Note these
16551 switches have no effect on how the compiler generates code to handle
16552 function calls via function pointers.
16554 @item -mfast-fp
16555 @opindex mfast-fp
16556 Link with the fast floating-point library. This library relaxes some of
16557 the IEEE floating-point standard's rules for checking inputs against
16558 Not-a-Number (NAN), in the interest of performance.
16560 @item -minline-plt
16561 @opindex minline-plt
16562 Enable inlining of PLT entries in function calls to functions that are
16563 not known to bind locally.  It has no effect without @option{-mfdpic}.
16565 @item -mmulticore
16566 @opindex mmulticore
16567 Build a standalone application for multicore Blackfin processors. 
16568 This option causes proper start files and link scripts supporting 
16569 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16570 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16572 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16573 selects the one-application-per-core programming model.  Without
16574 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16575 programming model is used. In this model, the main function of Core B
16576 should be named as @code{coreb_main}.
16578 If this option is not used, the single-core application programming
16579 model is used.
16581 @item -mcorea
16582 @opindex mcorea
16583 Build a standalone application for Core A of BF561 when using
16584 the one-application-per-core programming model. Proper start files
16585 and link scripts are used to support Core A, and the macro
16586 @code{__BFIN_COREA} is defined.
16587 This option can only be used in conjunction with @option{-mmulticore}.
16589 @item -mcoreb
16590 @opindex mcoreb
16591 Build a standalone application for Core B of BF561 when using
16592 the one-application-per-core programming model. Proper start files
16593 and link scripts are used to support Core B, and the macro
16594 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16595 should be used instead of @code{main}. 
16596 This option can only be used in conjunction with @option{-mmulticore}.
16598 @item -msdram
16599 @opindex msdram
16600 Build a standalone application for SDRAM. Proper start files and
16601 link scripts are used to put the application into SDRAM, and the macro
16602 @code{__BFIN_SDRAM} is defined.
16603 The loader should initialize SDRAM before loading the application.
16605 @item -micplb
16606 @opindex micplb
16607 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16608 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16609 are enabled; for standalone applications the default is off.
16610 @end table
16612 @node C6X Options
16613 @subsection C6X Options
16614 @cindex C6X Options
16616 @table @gcctabopt
16617 @item -march=@var{name}
16618 @opindex march
16619 This specifies the name of the target architecture.  GCC uses this
16620 name to determine what kind of instructions it can emit when generating
16621 assembly code.  Permissible names are: @samp{c62x},
16622 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16624 @item -mbig-endian
16625 @opindex mbig-endian
16626 Generate code for a big-endian target.
16628 @item -mlittle-endian
16629 @opindex mlittle-endian
16630 Generate code for a little-endian target.  This is the default.
16632 @item -msim
16633 @opindex msim
16634 Choose startup files and linker script suitable for the simulator.
16636 @item -msdata=default
16637 @opindex msdata=default
16638 Put small global and static data in the @code{.neardata} section,
16639 which is pointed to by register @code{B14}.  Put small uninitialized
16640 global and static data in the @code{.bss} section, which is adjacent
16641 to the @code{.neardata} section.  Put small read-only data into the
16642 @code{.rodata} section.  The corresponding sections used for large
16643 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16645 @item -msdata=all
16646 @opindex msdata=all
16647 Put all data, not just small objects, into the sections reserved for
16648 small data, and use addressing relative to the @code{B14} register to
16649 access them.
16651 @item -msdata=none
16652 @opindex msdata=none
16653 Make no use of the sections reserved for small data, and use absolute
16654 addresses to access all data.  Put all initialized global and static
16655 data in the @code{.fardata} section, and all uninitialized data in the
16656 @code{.far} section.  Put all constant data into the @code{.const}
16657 section.
16658 @end table
16660 @node CRIS Options
16661 @subsection CRIS Options
16662 @cindex CRIS Options
16664 These options are defined specifically for the CRIS ports.
16666 @table @gcctabopt
16667 @item -march=@var{architecture-type}
16668 @itemx -mcpu=@var{architecture-type}
16669 @opindex march
16670 @opindex mcpu
16671 Generate code for the specified architecture.  The choices for
16672 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16673 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16674 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16675 @samp{v10}.
16677 @item -mtune=@var{architecture-type}
16678 @opindex mtune
16679 Tune to @var{architecture-type} everything applicable about the generated
16680 code, except for the ABI and the set of available instructions.  The
16681 choices for @var{architecture-type} are the same as for
16682 @option{-march=@var{architecture-type}}.
16684 @item -mmax-stack-frame=@var{n}
16685 @opindex mmax-stack-frame
16686 Warn when the stack frame of a function exceeds @var{n} bytes.
16688 @item -metrax4
16689 @itemx -metrax100
16690 @opindex metrax4
16691 @opindex metrax100
16692 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16693 @option{-march=v3} and @option{-march=v8} respectively.
16695 @item -mmul-bug-workaround
16696 @itemx -mno-mul-bug-workaround
16697 @opindex mmul-bug-workaround
16698 @opindex mno-mul-bug-workaround
16699 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16700 models where it applies.  This option is active by default.
16702 @item -mpdebug
16703 @opindex mpdebug
16704 Enable CRIS-specific verbose debug-related information in the assembly
16705 code.  This option also has the effect of turning off the @samp{#NO_APP}
16706 formatted-code indicator to the assembler at the beginning of the
16707 assembly file.
16709 @item -mcc-init
16710 @opindex mcc-init
16711 Do not use condition-code results from previous instruction; always emit
16712 compare and test instructions before use of condition codes.
16714 @item -mno-side-effects
16715 @opindex mno-side-effects
16716 Do not emit instructions with side effects in addressing modes other than
16717 post-increment.
16719 @item -mstack-align
16720 @itemx -mno-stack-align
16721 @itemx -mdata-align
16722 @itemx -mno-data-align
16723 @itemx -mconst-align
16724 @itemx -mno-const-align
16725 @opindex mstack-align
16726 @opindex mno-stack-align
16727 @opindex mdata-align
16728 @opindex mno-data-align
16729 @opindex mconst-align
16730 @opindex mno-const-align
16731 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16732 stack frame, individual data and constants to be aligned for the maximum
16733 single data access size for the chosen CPU model.  The default is to
16734 arrange for 32-bit alignment.  ABI details such as structure layout are
16735 not affected by these options.
16737 @item -m32-bit
16738 @itemx -m16-bit
16739 @itemx -m8-bit
16740 @opindex m32-bit
16741 @opindex m16-bit
16742 @opindex m8-bit
16743 Similar to the stack- data- and const-align options above, these options
16744 arrange for stack frame, writable data and constants to all be 32-bit,
16745 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16747 @item -mno-prologue-epilogue
16748 @itemx -mprologue-epilogue
16749 @opindex mno-prologue-epilogue
16750 @opindex mprologue-epilogue
16751 With @option{-mno-prologue-epilogue}, the normal function prologue and
16752 epilogue which set up the stack frame are omitted and no return
16753 instructions or return sequences are generated in the code.  Use this
16754 option only together with visual inspection of the compiled code: no
16755 warnings or errors are generated when call-saved registers must be saved,
16756 or storage for local variables needs to be allocated.
16758 @item -mno-gotplt
16759 @itemx -mgotplt
16760 @opindex mno-gotplt
16761 @opindex mgotplt
16762 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16763 instruction sequences that load addresses for functions from the PLT part
16764 of the GOT rather than (traditional on other architectures) calls to the
16765 PLT@.  The default is @option{-mgotplt}.
16767 @item -melf
16768 @opindex melf
16769 Legacy no-op option only recognized with the cris-axis-elf and
16770 cris-axis-linux-gnu targets.
16772 @item -mlinux
16773 @opindex mlinux
16774 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16776 @item -sim
16777 @opindex sim
16778 This option, recognized for the cris-axis-elf, arranges
16779 to link with input-output functions from a simulator library.  Code,
16780 initialized data and zero-initialized data are allocated consecutively.
16782 @item -sim2
16783 @opindex sim2
16784 Like @option{-sim}, but pass linker options to locate initialized data at
16785 0x40000000 and zero-initialized data at 0x80000000.
16786 @end table
16788 @node CR16 Options
16789 @subsection CR16 Options
16790 @cindex CR16 Options
16792 These options are defined specifically for the CR16 ports.
16794 @table @gcctabopt
16796 @item -mmac
16797 @opindex mmac
16798 Enable the use of multiply-accumulate instructions. Disabled by default.
16800 @item -mcr16cplus
16801 @itemx -mcr16c
16802 @opindex mcr16cplus
16803 @opindex mcr16c
16804 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16805 is default.
16807 @item -msim
16808 @opindex msim
16809 Links the library libsim.a which is in compatible with simulator. Applicable
16810 to ELF compiler only.
16812 @item -mint32
16813 @opindex mint32
16814 Choose integer type as 32-bit wide.
16816 @item -mbit-ops
16817 @opindex mbit-ops
16818 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16820 @item -mdata-model=@var{model}
16821 @opindex mdata-model
16822 Choose a data model. The choices for @var{model} are @samp{near},
16823 @samp{far} or @samp{medium}. @samp{medium} is default.
16824 However, @samp{far} is not valid with @option{-mcr16c}, as the
16825 CR16C architecture does not support the far data model.
16826 @end table
16828 @node Darwin Options
16829 @subsection Darwin Options
16830 @cindex Darwin options
16832 These options are defined for all architectures running the Darwin operating
16833 system.
16835 FSF GCC on Darwin does not create ``fat'' object files; it creates
16836 an object file for the single architecture that GCC was built to
16837 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16838 @option{-arch} options are used; it does so by running the compiler or
16839 linker multiple times and joining the results together with
16840 @file{lipo}.
16842 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16843 @samp{i686}) is determined by the flags that specify the ISA
16844 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16845 @option{-force_cpusubtype_ALL} option can be used to override this.
16847 The Darwin tools vary in their behavior when presented with an ISA
16848 mismatch.  The assembler, @file{as}, only permits instructions to
16849 be used that are valid for the subtype of the file it is generating,
16850 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16851 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16852 and prints an error if asked to create a shared library with a less
16853 restrictive subtype than its input files (for instance, trying to put
16854 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16855 for executables, @command{ld}, quietly gives the executable the most
16856 restrictive subtype of any of its input files.
16858 @table @gcctabopt
16859 @item -F@var{dir}
16860 @opindex F
16861 Add the framework directory @var{dir} to the head of the list of
16862 directories to be searched for header files.  These directories are
16863 interleaved with those specified by @option{-I} options and are
16864 scanned in a left-to-right order.
16866 A framework directory is a directory with frameworks in it.  A
16867 framework is a directory with a @file{Headers} and/or
16868 @file{PrivateHeaders} directory contained directly in it that ends
16869 in @file{.framework}.  The name of a framework is the name of this
16870 directory excluding the @file{.framework}.  Headers associated with
16871 the framework are found in one of those two directories, with
16872 @file{Headers} being searched first.  A subframework is a framework
16873 directory that is in a framework's @file{Frameworks} directory.
16874 Includes of subframework headers can only appear in a header of a
16875 framework that contains the subframework, or in a sibling subframework
16876 header.  Two subframeworks are siblings if they occur in the same
16877 framework.  A subframework should not have the same name as a
16878 framework; a warning is issued if this is violated.  Currently a
16879 subframework cannot have subframeworks; in the future, the mechanism
16880 may be extended to support this.  The standard frameworks can be found
16881 in @file{/System/Library/Frameworks} and
16882 @file{/Library/Frameworks}.  An example include looks like
16883 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16884 the name of the framework and @file{header.h} is found in the
16885 @file{PrivateHeaders} or @file{Headers} directory.
16887 @item -iframework@var{dir}
16888 @opindex iframework
16889 Like @option{-F} except the directory is a treated as a system
16890 directory.  The main difference between this @option{-iframework} and
16891 @option{-F} is that with @option{-iframework} the compiler does not
16892 warn about constructs contained within header files found via
16893 @var{dir}.  This option is valid only for the C family of languages.
16895 @item -gused
16896 @opindex gused
16897 Emit debugging information for symbols that are used.  For stabs
16898 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16899 This is by default ON@.
16901 @item -gfull
16902 @opindex gfull
16903 Emit debugging information for all symbols and types.
16905 @item -mmacosx-version-min=@var{version}
16906 The earliest version of MacOS X that this executable will run on
16907 is @var{version}.  Typical values of @var{version} include @code{10.1},
16908 @code{10.2}, and @code{10.3.9}.
16910 If the compiler was built to use the system's headers by default,
16911 then the default for this option is the system version on which the
16912 compiler is running, otherwise the default is to make choices that
16913 are compatible with as many systems and code bases as possible.
16915 @item -mkernel
16916 @opindex mkernel
16917 Enable kernel development mode.  The @option{-mkernel} option sets
16918 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16919 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16920 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16921 applicable.  This mode also sets @option{-mno-altivec},
16922 @option{-msoft-float}, @option{-fno-builtin} and
16923 @option{-mlong-branch} for PowerPC targets.
16925 @item -mone-byte-bool
16926 @opindex mone-byte-bool
16927 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16928 By default @code{sizeof(bool)} is @code{4} when compiling for
16929 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16930 option has no effect on x86.
16932 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16933 to generate code that is not binary compatible with code generated
16934 without that switch.  Using this switch may require recompiling all
16935 other modules in a program, including system libraries.  Use this
16936 switch to conform to a non-default data model.
16938 @item -mfix-and-continue
16939 @itemx -ffix-and-continue
16940 @itemx -findirect-data
16941 @opindex mfix-and-continue
16942 @opindex ffix-and-continue
16943 @opindex findirect-data
16944 Generate code suitable for fast turnaround development, such as to
16945 allow GDB to dynamically load @file{.o} files into already-running
16946 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16947 are provided for backwards compatibility.
16949 @item -all_load
16950 @opindex all_load
16951 Loads all members of static archive libraries.
16952 See man ld(1) for more information.
16954 @item -arch_errors_fatal
16955 @opindex arch_errors_fatal
16956 Cause the errors having to do with files that have the wrong architecture
16957 to be fatal.
16959 @item -bind_at_load
16960 @opindex bind_at_load
16961 Causes the output file to be marked such that the dynamic linker will
16962 bind all undefined references when the file is loaded or launched.
16964 @item -bundle
16965 @opindex bundle
16966 Produce a Mach-o bundle format file.
16967 See man ld(1) for more information.
16969 @item -bundle_loader @var{executable}
16970 @opindex bundle_loader
16971 This option specifies the @var{executable} that will load the build
16972 output file being linked.  See man ld(1) for more information.
16974 @item -dynamiclib
16975 @opindex dynamiclib
16976 When passed this option, GCC produces a dynamic library instead of
16977 an executable when linking, using the Darwin @file{libtool} command.
16979 @item -force_cpusubtype_ALL
16980 @opindex force_cpusubtype_ALL
16981 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16982 one controlled by the @option{-mcpu} or @option{-march} option.
16984 @item -allowable_client  @var{client_name}
16985 @itemx -client_name
16986 @itemx -compatibility_version
16987 @itemx -current_version
16988 @itemx -dead_strip
16989 @itemx -dependency-file
16990 @itemx -dylib_file
16991 @itemx -dylinker_install_name
16992 @itemx -dynamic
16993 @itemx -exported_symbols_list
16994 @itemx -filelist
16995 @need 800
16996 @itemx -flat_namespace
16997 @itemx -force_flat_namespace
16998 @itemx -headerpad_max_install_names
16999 @itemx -image_base
17000 @itemx -init
17001 @itemx -install_name
17002 @itemx -keep_private_externs
17003 @itemx -multi_module
17004 @itemx -multiply_defined
17005 @itemx -multiply_defined_unused
17006 @need 800
17007 @itemx -noall_load
17008 @itemx -no_dead_strip_inits_and_terms
17009 @itemx -nofixprebinding
17010 @itemx -nomultidefs
17011 @itemx -noprebind
17012 @itemx -noseglinkedit
17013 @itemx -pagezero_size
17014 @itemx -prebind
17015 @itemx -prebind_all_twolevel_modules
17016 @itemx -private_bundle
17017 @need 800
17018 @itemx -read_only_relocs
17019 @itemx -sectalign
17020 @itemx -sectobjectsymbols
17021 @itemx -whyload
17022 @itemx -seg1addr
17023 @itemx -sectcreate
17024 @itemx -sectobjectsymbols
17025 @itemx -sectorder
17026 @itemx -segaddr
17027 @itemx -segs_read_only_addr
17028 @need 800
17029 @itemx -segs_read_write_addr
17030 @itemx -seg_addr_table
17031 @itemx -seg_addr_table_filename
17032 @itemx -seglinkedit
17033 @itemx -segprot
17034 @itemx -segs_read_only_addr
17035 @itemx -segs_read_write_addr
17036 @itemx -single_module
17037 @itemx -static
17038 @itemx -sub_library
17039 @need 800
17040 @itemx -sub_umbrella
17041 @itemx -twolevel_namespace
17042 @itemx -umbrella
17043 @itemx -undefined
17044 @itemx -unexported_symbols_list
17045 @itemx -weak_reference_mismatches
17046 @itemx -whatsloaded
17047 @opindex allowable_client
17048 @opindex client_name
17049 @opindex compatibility_version
17050 @opindex current_version
17051 @opindex dead_strip
17052 @opindex dependency-file
17053 @opindex dylib_file
17054 @opindex dylinker_install_name
17055 @opindex dynamic
17056 @opindex exported_symbols_list
17057 @opindex filelist
17058 @opindex flat_namespace
17059 @opindex force_flat_namespace
17060 @opindex headerpad_max_install_names
17061 @opindex image_base
17062 @opindex init
17063 @opindex install_name
17064 @opindex keep_private_externs
17065 @opindex multi_module
17066 @opindex multiply_defined
17067 @opindex multiply_defined_unused
17068 @opindex noall_load
17069 @opindex no_dead_strip_inits_and_terms
17070 @opindex nofixprebinding
17071 @opindex nomultidefs
17072 @opindex noprebind
17073 @opindex noseglinkedit
17074 @opindex pagezero_size
17075 @opindex prebind
17076 @opindex prebind_all_twolevel_modules
17077 @opindex private_bundle
17078 @opindex read_only_relocs
17079 @opindex sectalign
17080 @opindex sectobjectsymbols
17081 @opindex whyload
17082 @opindex seg1addr
17083 @opindex sectcreate
17084 @opindex sectobjectsymbols
17085 @opindex sectorder
17086 @opindex segaddr
17087 @opindex segs_read_only_addr
17088 @opindex segs_read_write_addr
17089 @opindex seg_addr_table
17090 @opindex seg_addr_table_filename
17091 @opindex seglinkedit
17092 @opindex segprot
17093 @opindex segs_read_only_addr
17094 @opindex segs_read_write_addr
17095 @opindex single_module
17096 @opindex static
17097 @opindex sub_library
17098 @opindex sub_umbrella
17099 @opindex twolevel_namespace
17100 @opindex umbrella
17101 @opindex undefined
17102 @opindex unexported_symbols_list
17103 @opindex weak_reference_mismatches
17104 @opindex whatsloaded
17105 These options are passed to the Darwin linker.  The Darwin linker man page
17106 describes them in detail.
17107 @end table
17109 @node DEC Alpha Options
17110 @subsection DEC Alpha Options
17112 These @samp{-m} options are defined for the DEC Alpha implementations:
17114 @table @gcctabopt
17115 @item -mno-soft-float
17116 @itemx -msoft-float
17117 @opindex mno-soft-float
17118 @opindex msoft-float
17119 Use (do not use) the hardware floating-point instructions for
17120 floating-point operations.  When @option{-msoft-float} is specified,
17121 functions in @file{libgcc.a} are used to perform floating-point
17122 operations.  Unless they are replaced by routines that emulate the
17123 floating-point operations, or compiled in such a way as to call such
17124 emulations routines, these routines issue floating-point
17125 operations.   If you are compiling for an Alpha without floating-point
17126 operations, you must ensure that the library is built so as not to call
17127 them.
17129 Note that Alpha implementations without floating-point operations are
17130 required to have floating-point registers.
17132 @item -mfp-reg
17133 @itemx -mno-fp-regs
17134 @opindex mfp-reg
17135 @opindex mno-fp-regs
17136 Generate code that uses (does not use) the floating-point register set.
17137 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17138 register set is not used, floating-point operands are passed in integer
17139 registers as if they were integers and floating-point results are passed
17140 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17141 so any function with a floating-point argument or return value called by code
17142 compiled with @option{-mno-fp-regs} must also be compiled with that
17143 option.
17145 A typical use of this option is building a kernel that does not use,
17146 and hence need not save and restore, any floating-point registers.
17148 @item -mieee
17149 @opindex mieee
17150 The Alpha architecture implements floating-point hardware optimized for
17151 maximum performance.  It is mostly compliant with the IEEE floating-point
17152 standard.  However, for full compliance, software assistance is
17153 required.  This option generates code fully IEEE-compliant code
17154 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17155 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17156 defined during compilation.  The resulting code is less efficient but is
17157 able to correctly support denormalized numbers and exceptional IEEE
17158 values such as not-a-number and plus/minus infinity.  Other Alpha
17159 compilers call this option @option{-ieee_with_no_inexact}.
17161 @item -mieee-with-inexact
17162 @opindex mieee-with-inexact
17163 This is like @option{-mieee} except the generated code also maintains
17164 the IEEE @var{inexact-flag}.  Turning on this option causes the
17165 generated code to implement fully-compliant IEEE math.  In addition to
17166 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17167 macro.  On some Alpha implementations the resulting code may execute
17168 significantly slower than the code generated by default.  Since there is
17169 very little code that depends on the @var{inexact-flag}, you should
17170 normally not specify this option.  Other Alpha compilers call this
17171 option @option{-ieee_with_inexact}.
17173 @item -mfp-trap-mode=@var{trap-mode}
17174 @opindex mfp-trap-mode
17175 This option controls what floating-point related traps are enabled.
17176 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17177 The trap mode can be set to one of four values:
17179 @table @samp
17180 @item n
17181 This is the default (normal) setting.  The only traps that are enabled
17182 are the ones that cannot be disabled in software (e.g., division by zero
17183 trap).
17185 @item u
17186 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17187 as well.
17189 @item su
17190 Like @samp{u}, but the instructions are marked to be safe for software
17191 completion (see Alpha architecture manual for details).
17193 @item sui
17194 Like @samp{su}, but inexact traps are enabled as well.
17195 @end table
17197 @item -mfp-rounding-mode=@var{rounding-mode}
17198 @opindex mfp-rounding-mode
17199 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17200 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17203 @table @samp
17204 @item n
17205 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17206 the nearest machine number or towards the even machine number in case
17207 of a tie.
17209 @item m
17210 Round towards minus infinity.
17212 @item c
17213 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17215 @item d
17216 Dynamic rounding mode.  A field in the floating-point control register
17217 (@var{fpcr}, see Alpha architecture reference manual) controls the
17218 rounding mode in effect.  The C library initializes this register for
17219 rounding towards plus infinity.  Thus, unless your program modifies the
17220 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17221 @end table
17223 @item -mtrap-precision=@var{trap-precision}
17224 @opindex mtrap-precision
17225 In the Alpha architecture, floating-point traps are imprecise.  This
17226 means without software assistance it is impossible to recover from a
17227 floating trap and program execution normally needs to be terminated.
17228 GCC can generate code that can assist operating system trap handlers
17229 in determining the exact location that caused a floating-point trap.
17230 Depending on the requirements of an application, different levels of
17231 precisions can be selected:
17233 @table @samp
17234 @item p
17235 Program precision.  This option is the default and means a trap handler
17236 can only identify which program caused a floating-point exception.
17238 @item f
17239 Function precision.  The trap handler can determine the function that
17240 caused a floating-point exception.
17242 @item i
17243 Instruction precision.  The trap handler can determine the exact
17244 instruction that caused a floating-point exception.
17245 @end table
17247 Other Alpha compilers provide the equivalent options called
17248 @option{-scope_safe} and @option{-resumption_safe}.
17250 @item -mieee-conformant
17251 @opindex mieee-conformant
17252 This option marks the generated code as IEEE conformant.  You must not
17253 use this option unless you also specify @option{-mtrap-precision=i} and either
17254 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17255 is to emit the line @samp{.eflag 48} in the function prologue of the
17256 generated assembly file.
17258 @item -mbuild-constants
17259 @opindex mbuild-constants
17260 Normally GCC examines a 32- or 64-bit integer constant to
17261 see if it can construct it from smaller constants in two or three
17262 instructions.  If it cannot, it outputs the constant as a literal and
17263 generates code to load it from the data segment at run time.
17265 Use this option to require GCC to construct @emph{all} integer constants
17266 using code, even if it takes more instructions (the maximum is six).
17268 You typically use this option to build a shared library dynamic
17269 loader.  Itself a shared library, it must relocate itself in memory
17270 before it can find the variables and constants in its own data segment.
17272 @item -mbwx
17273 @itemx -mno-bwx
17274 @itemx -mcix
17275 @itemx -mno-cix
17276 @itemx -mfix
17277 @itemx -mno-fix
17278 @itemx -mmax
17279 @itemx -mno-max
17280 @opindex mbwx
17281 @opindex mno-bwx
17282 @opindex mcix
17283 @opindex mno-cix
17284 @opindex mfix
17285 @opindex mno-fix
17286 @opindex mmax
17287 @opindex mno-max
17288 Indicate whether GCC should generate code to use the optional BWX,
17289 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17290 sets supported by the CPU type specified via @option{-mcpu=} option or that
17291 of the CPU on which GCC was built if none is specified.
17293 @item -mfloat-vax
17294 @itemx -mfloat-ieee
17295 @opindex mfloat-vax
17296 @opindex mfloat-ieee
17297 Generate code that uses (does not use) VAX F and G floating-point
17298 arithmetic instead of IEEE single and double precision.
17300 @item -mexplicit-relocs
17301 @itemx -mno-explicit-relocs
17302 @opindex mexplicit-relocs
17303 @opindex mno-explicit-relocs
17304 Older Alpha assemblers provided no way to generate symbol relocations
17305 except via assembler macros.  Use of these macros does not allow
17306 optimal instruction scheduling.  GNU binutils as of version 2.12
17307 supports a new syntax that allows the compiler to explicitly mark
17308 which relocations should apply to which instructions.  This option
17309 is mostly useful for debugging, as GCC detects the capabilities of
17310 the assembler when it is built and sets the default accordingly.
17312 @item -msmall-data
17313 @itemx -mlarge-data
17314 @opindex msmall-data
17315 @opindex mlarge-data
17316 When @option{-mexplicit-relocs} is in effect, static data is
17317 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17318 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17319 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17320 16-bit relocations off of the @code{$gp} register.  This limits the
17321 size of the small data area to 64KB, but allows the variables to be
17322 directly accessed via a single instruction.
17324 The default is @option{-mlarge-data}.  With this option the data area
17325 is limited to just below 2GB@.  Programs that require more than 2GB of
17326 data must use @code{malloc} or @code{mmap} to allocate the data in the
17327 heap instead of in the program's data segment.
17329 When generating code for shared libraries, @option{-fpic} implies
17330 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17332 @item -msmall-text
17333 @itemx -mlarge-text
17334 @opindex msmall-text
17335 @opindex mlarge-text
17336 When @option{-msmall-text} is used, the compiler assumes that the
17337 code of the entire program (or shared library) fits in 4MB, and is
17338 thus reachable with a branch instruction.  When @option{-msmall-data}
17339 is used, the compiler can assume that all local symbols share the
17340 same @code{$gp} value, and thus reduce the number of instructions
17341 required for a function call from 4 to 1.
17343 The default is @option{-mlarge-text}.
17345 @item -mcpu=@var{cpu_type}
17346 @opindex mcpu
17347 Set the instruction set and instruction scheduling parameters for
17348 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17349 style name or the corresponding chip number.  GCC supports scheduling
17350 parameters for the EV4, EV5 and EV6 family of processors and
17351 chooses the default values for the instruction set from the processor
17352 you specify.  If you do not specify a processor type, GCC defaults
17353 to the processor on which the compiler was built.
17355 Supported values for @var{cpu_type} are
17357 @table @samp
17358 @item ev4
17359 @itemx ev45
17360 @itemx 21064
17361 Schedules as an EV4 and has no instruction set extensions.
17363 @item ev5
17364 @itemx 21164
17365 Schedules as an EV5 and has no instruction set extensions.
17367 @item ev56
17368 @itemx 21164a
17369 Schedules as an EV5 and supports the BWX extension.
17371 @item pca56
17372 @itemx 21164pc
17373 @itemx 21164PC
17374 Schedules as an EV5 and supports the BWX and MAX extensions.
17376 @item ev6
17377 @itemx 21264
17378 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17380 @item ev67
17381 @itemx 21264a
17382 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17383 @end table
17385 Native toolchains also support the value @samp{native},
17386 which selects the best architecture option for the host processor.
17387 @option{-mcpu=native} has no effect if GCC does not recognize
17388 the processor.
17390 @item -mtune=@var{cpu_type}
17391 @opindex mtune
17392 Set only the instruction scheduling parameters for machine type
17393 @var{cpu_type}.  The instruction set is not changed.
17395 Native toolchains also support the value @samp{native},
17396 which selects the best architecture option for the host processor.
17397 @option{-mtune=native} has no effect if GCC does not recognize
17398 the processor.
17400 @item -mmemory-latency=@var{time}
17401 @opindex mmemory-latency
17402 Sets the latency the scheduler should assume for typical memory
17403 references as seen by the application.  This number is highly
17404 dependent on the memory access patterns used by the application
17405 and the size of the external cache on the machine.
17407 Valid options for @var{time} are
17409 @table @samp
17410 @item @var{number}
17411 A decimal number representing clock cycles.
17413 @item L1
17414 @itemx L2
17415 @itemx L3
17416 @itemx main
17417 The compiler contains estimates of the number of clock cycles for
17418 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17419 (also called Dcache, Scache, and Bcache), as well as to main memory.
17420 Note that L3 is only valid for EV5.
17422 @end table
17423 @end table
17425 @node FR30 Options
17426 @subsection FR30 Options
17427 @cindex FR30 Options
17429 These options are defined specifically for the FR30 port.
17431 @table @gcctabopt
17433 @item -msmall-model
17434 @opindex msmall-model
17435 Use the small address space model.  This can produce smaller code, but
17436 it does assume that all symbolic values and addresses fit into a
17437 20-bit range.
17439 @item -mno-lsim
17440 @opindex mno-lsim
17441 Assume that runtime support has been provided and so there is no need
17442 to include the simulator library (@file{libsim.a}) on the linker
17443 command line.
17445 @end table
17447 @node FT32 Options
17448 @subsection FT32 Options
17449 @cindex FT32 Options
17451 These options are defined specifically for the FT32 port.
17453 @table @gcctabopt
17455 @item -msim
17456 @opindex msim
17457 Specifies that the program will be run on the simulator.  This causes
17458 an alternate runtime startup and library to be linked.
17459 You must not use this option when generating programs that will run on
17460 real hardware; you must provide your own runtime library for whatever
17461 I/O functions are needed.
17463 @item -mlra
17464 @opindex mlra
17465 Enable Local Register Allocation.  This is still experimental for FT32,
17466 so by default the compiler uses standard reload.
17468 @item -mnodiv
17469 @opindex mnodiv
17470 Do not use div and mod instructions.
17472 @end table
17474 @node FRV Options
17475 @subsection FRV Options
17476 @cindex FRV Options
17478 @table @gcctabopt
17479 @item -mgpr-32
17480 @opindex mgpr-32
17482 Only use the first 32 general-purpose registers.
17484 @item -mgpr-64
17485 @opindex mgpr-64
17487 Use all 64 general-purpose registers.
17489 @item -mfpr-32
17490 @opindex mfpr-32
17492 Use only the first 32 floating-point registers.
17494 @item -mfpr-64
17495 @opindex mfpr-64
17497 Use all 64 floating-point registers.
17499 @item -mhard-float
17500 @opindex mhard-float
17502 Use hardware instructions for floating-point operations.
17504 @item -msoft-float
17505 @opindex msoft-float
17507 Use library routines for floating-point operations.
17509 @item -malloc-cc
17510 @opindex malloc-cc
17512 Dynamically allocate condition code registers.
17514 @item -mfixed-cc
17515 @opindex mfixed-cc
17517 Do not try to dynamically allocate condition code registers, only
17518 use @code{icc0} and @code{fcc0}.
17520 @item -mdword
17521 @opindex mdword
17523 Change ABI to use double word insns.
17525 @item -mno-dword
17526 @opindex mno-dword
17528 Do not use double word instructions.
17530 @item -mdouble
17531 @opindex mdouble
17533 Use floating-point double instructions.
17535 @item -mno-double
17536 @opindex mno-double
17538 Do not use floating-point double instructions.
17540 @item -mmedia
17541 @opindex mmedia
17543 Use media instructions.
17545 @item -mno-media
17546 @opindex mno-media
17548 Do not use media instructions.
17550 @item -mmuladd
17551 @opindex mmuladd
17553 Use multiply and add/subtract instructions.
17555 @item -mno-muladd
17556 @opindex mno-muladd
17558 Do not use multiply and add/subtract instructions.
17560 @item -mfdpic
17561 @opindex mfdpic
17563 Select the FDPIC ABI, which uses function descriptors to represent
17564 pointers to functions.  Without any PIC/PIE-related options, it
17565 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17566 assumes GOT entries and small data are within a 12-bit range from the
17567 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17568 are computed with 32 bits.
17569 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17571 @item -minline-plt
17572 @opindex minline-plt
17574 Enable inlining of PLT entries in function calls to functions that are
17575 not known to bind locally.  It has no effect without @option{-mfdpic}.
17576 It's enabled by default if optimizing for speed and compiling for
17577 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17578 optimization option such as @option{-O3} or above is present in the
17579 command line.
17581 @item -mTLS
17582 @opindex mTLS
17584 Assume a large TLS segment when generating thread-local code.
17586 @item -mtls
17587 @opindex mtls
17589 Do not assume a large TLS segment when generating thread-local code.
17591 @item -mgprel-ro
17592 @opindex mgprel-ro
17594 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17595 that is known to be in read-only sections.  It's enabled by default,
17596 except for @option{-fpic} or @option{-fpie}: even though it may help
17597 make the global offset table smaller, it trades 1 instruction for 4.
17598 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17599 one of which may be shared by multiple symbols, and it avoids the need
17600 for a GOT entry for the referenced symbol, so it's more likely to be a
17601 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17603 @item -multilib-library-pic
17604 @opindex multilib-library-pic
17606 Link with the (library, not FD) pic libraries.  It's implied by
17607 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17608 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17609 it explicitly.
17611 @item -mlinked-fp
17612 @opindex mlinked-fp
17614 Follow the EABI requirement of always creating a frame pointer whenever
17615 a stack frame is allocated.  This option is enabled by default and can
17616 be disabled with @option{-mno-linked-fp}.
17618 @item -mlong-calls
17619 @opindex mlong-calls
17621 Use indirect addressing to call functions outside the current
17622 compilation unit.  This allows the functions to be placed anywhere
17623 within the 32-bit address space.
17625 @item -malign-labels
17626 @opindex malign-labels
17628 Try to align labels to an 8-byte boundary by inserting NOPs into the
17629 previous packet.  This option only has an effect when VLIW packing
17630 is enabled.  It doesn't create new packets; it merely adds NOPs to
17631 existing ones.
17633 @item -mlibrary-pic
17634 @opindex mlibrary-pic
17636 Generate position-independent EABI code.
17638 @item -macc-4
17639 @opindex macc-4
17641 Use only the first four media accumulator registers.
17643 @item -macc-8
17644 @opindex macc-8
17646 Use all eight media accumulator registers.
17648 @item -mpack
17649 @opindex mpack
17651 Pack VLIW instructions.
17653 @item -mno-pack
17654 @opindex mno-pack
17656 Do not pack VLIW instructions.
17658 @item -mno-eflags
17659 @opindex mno-eflags
17661 Do not mark ABI switches in e_flags.
17663 @item -mcond-move
17664 @opindex mcond-move
17666 Enable the use of conditional-move instructions (default).
17668 This switch is mainly for debugging the compiler and will likely be removed
17669 in a future version.
17671 @item -mno-cond-move
17672 @opindex mno-cond-move
17674 Disable the use of conditional-move instructions.
17676 This switch is mainly for debugging the compiler and will likely be removed
17677 in a future version.
17679 @item -mscc
17680 @opindex mscc
17682 Enable the use of conditional set instructions (default).
17684 This switch is mainly for debugging the compiler and will likely be removed
17685 in a future version.
17687 @item -mno-scc
17688 @opindex mno-scc
17690 Disable the use of conditional set instructions.
17692 This switch is mainly for debugging the compiler and will likely be removed
17693 in a future version.
17695 @item -mcond-exec
17696 @opindex mcond-exec
17698 Enable the use of conditional execution (default).
17700 This switch is mainly for debugging the compiler and will likely be removed
17701 in a future version.
17703 @item -mno-cond-exec
17704 @opindex mno-cond-exec
17706 Disable the use of conditional execution.
17708 This switch is mainly for debugging the compiler and will likely be removed
17709 in a future version.
17711 @item -mvliw-branch
17712 @opindex mvliw-branch
17714 Run a pass to pack branches into VLIW instructions (default).
17716 This switch is mainly for debugging the compiler and will likely be removed
17717 in a future version.
17719 @item -mno-vliw-branch
17720 @opindex mno-vliw-branch
17722 Do not run a pass to pack branches into VLIW instructions.
17724 This switch is mainly for debugging the compiler and will likely be removed
17725 in a future version.
17727 @item -mmulti-cond-exec
17728 @opindex mmulti-cond-exec
17730 Enable optimization of @code{&&} and @code{||} in conditional execution
17731 (default).
17733 This switch is mainly for debugging the compiler and will likely be removed
17734 in a future version.
17736 @item -mno-multi-cond-exec
17737 @opindex mno-multi-cond-exec
17739 Disable optimization of @code{&&} and @code{||} in conditional execution.
17741 This switch is mainly for debugging the compiler and will likely be removed
17742 in a future version.
17744 @item -mnested-cond-exec
17745 @opindex mnested-cond-exec
17747 Enable nested conditional execution optimizations (default).
17749 This switch is mainly for debugging the compiler and will likely be removed
17750 in a future version.
17752 @item -mno-nested-cond-exec
17753 @opindex mno-nested-cond-exec
17755 Disable nested conditional execution optimizations.
17757 This switch is mainly for debugging the compiler and will likely be removed
17758 in a future version.
17760 @item -moptimize-membar
17761 @opindex moptimize-membar
17763 This switch removes redundant @code{membar} instructions from the
17764 compiler-generated code.  It is enabled by default.
17766 @item -mno-optimize-membar
17767 @opindex mno-optimize-membar
17769 This switch disables the automatic removal of redundant @code{membar}
17770 instructions from the generated code.
17772 @item -mtomcat-stats
17773 @opindex mtomcat-stats
17775 Cause gas to print out tomcat statistics.
17777 @item -mcpu=@var{cpu}
17778 @opindex mcpu
17780 Select the processor type for which to generate code.  Possible values are
17781 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17782 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17784 @end table
17786 @node GNU/Linux Options
17787 @subsection GNU/Linux Options
17789 These @samp{-m} options are defined for GNU/Linux targets:
17791 @table @gcctabopt
17792 @item -mglibc
17793 @opindex mglibc
17794 Use the GNU C library.  This is the default except
17795 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17796 @samp{*-*-linux-*android*} targets.
17798 @item -muclibc
17799 @opindex muclibc
17800 Use uClibc C library.  This is the default on
17801 @samp{*-*-linux-*uclibc*} targets.
17803 @item -mmusl
17804 @opindex mmusl
17805 Use the musl C library.  This is the default on
17806 @samp{*-*-linux-*musl*} targets.
17808 @item -mbionic
17809 @opindex mbionic
17810 Use Bionic C library.  This is the default on
17811 @samp{*-*-linux-*android*} targets.
17813 @item -mandroid
17814 @opindex mandroid
17815 Compile code compatible with Android platform.  This is the default on
17816 @samp{*-*-linux-*android*} targets.
17818 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17819 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17820 this option makes the GCC driver pass Android-specific options to the linker.
17821 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17822 to be defined.
17824 @item -tno-android-cc
17825 @opindex tno-android-cc
17826 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17827 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17828 @option{-fno-rtti} by default.
17830 @item -tno-android-ld
17831 @opindex tno-android-ld
17832 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17833 linking options to the linker.
17835 @end table
17837 @node H8/300 Options
17838 @subsection H8/300 Options
17840 These @samp{-m} options are defined for the H8/300 implementations:
17842 @table @gcctabopt
17843 @item -mrelax
17844 @opindex mrelax
17845 Shorten some address references at link time, when possible; uses the
17846 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17847 ld, Using ld}, for a fuller description.
17849 @item -mh
17850 @opindex mh
17851 Generate code for the H8/300H@.
17853 @item -ms
17854 @opindex ms
17855 Generate code for the H8S@.
17857 @item -mn
17858 @opindex mn
17859 Generate code for the H8S and H8/300H in the normal mode.  This switch
17860 must be used either with @option{-mh} or @option{-ms}.
17862 @item -ms2600
17863 @opindex ms2600
17864 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17866 @item -mexr
17867 @opindex mexr
17868 Extended registers are stored on stack before execution of function
17869 with monitor attribute. Default option is @option{-mexr}.
17870 This option is valid only for H8S targets.
17872 @item -mno-exr
17873 @opindex mno-exr
17874 Extended registers are not stored on stack before execution of function 
17875 with monitor attribute. Default option is @option{-mno-exr}. 
17876 This option is valid only for H8S targets.
17878 @item -mint32
17879 @opindex mint32
17880 Make @code{int} data 32 bits by default.
17882 @item -malign-300
17883 @opindex malign-300
17884 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17885 The default for the H8/300H and H8S is to align longs and floats on
17886 4-byte boundaries.
17887 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17888 This option has no effect on the H8/300.
17889 @end table
17891 @node HPPA Options
17892 @subsection HPPA Options
17893 @cindex HPPA Options
17895 These @samp{-m} options are defined for the HPPA family of computers:
17897 @table @gcctabopt
17898 @item -march=@var{architecture-type}
17899 @opindex march
17900 Generate code for the specified architecture.  The choices for
17901 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17902 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17903 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17904 architecture option for your machine.  Code compiled for lower numbered
17905 architectures runs on higher numbered architectures, but not the
17906 other way around.
17908 @item -mpa-risc-1-0
17909 @itemx -mpa-risc-1-1
17910 @itemx -mpa-risc-2-0
17911 @opindex mpa-risc-1-0
17912 @opindex mpa-risc-1-1
17913 @opindex mpa-risc-2-0
17914 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17916 @item -mcaller-copies
17917 @opindex mcaller-copies
17918 The caller copies function arguments passed by hidden reference.  This
17919 option should be used with care as it is not compatible with the default
17920 32-bit runtime.  However, only aggregates larger than eight bytes are
17921 passed by hidden reference and the option provides better compatibility
17922 with OpenMP.
17924 @item -mjump-in-delay
17925 @opindex mjump-in-delay
17926 This option is ignored and provided for compatibility purposes only.
17928 @item -mdisable-fpregs
17929 @opindex mdisable-fpregs
17930 Prevent floating-point registers from being used in any manner.  This is
17931 necessary for compiling kernels that perform lazy context switching of
17932 floating-point registers.  If you use this option and attempt to perform
17933 floating-point operations, the compiler aborts.
17935 @item -mdisable-indexing
17936 @opindex mdisable-indexing
17937 Prevent the compiler from using indexing address modes.  This avoids some
17938 rather obscure problems when compiling MIG generated code under MACH@.
17940 @item -mno-space-regs
17941 @opindex mno-space-regs
17942 Generate code that assumes the target has no space registers.  This allows
17943 GCC to generate faster indirect calls and use unscaled index address modes.
17945 Such code is suitable for level 0 PA systems and kernels.
17947 @item -mfast-indirect-calls
17948 @opindex mfast-indirect-calls
17949 Generate code that assumes calls never cross space boundaries.  This
17950 allows GCC to emit code that performs faster indirect calls.
17952 This option does not work in the presence of shared libraries or nested
17953 functions.
17955 @item -mfixed-range=@var{register-range}
17956 @opindex mfixed-range
17957 Generate code treating the given register range as fixed registers.
17958 A fixed register is one that the register allocator cannot use.  This is
17959 useful when compiling kernel code.  A register range is specified as
17960 two registers separated by a dash.  Multiple register ranges can be
17961 specified separated by a comma.
17963 @item -mlong-load-store
17964 @opindex mlong-load-store
17965 Generate 3-instruction load and store sequences as sometimes required by
17966 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17967 the HP compilers.
17969 @item -mportable-runtime
17970 @opindex mportable-runtime
17971 Use the portable calling conventions proposed by HP for ELF systems.
17973 @item -mgas
17974 @opindex mgas
17975 Enable the use of assembler directives only GAS understands.
17977 @item -mschedule=@var{cpu-type}
17978 @opindex mschedule
17979 Schedule code according to the constraints for the machine type
17980 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17981 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17982 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17983 proper scheduling option for your machine.  The default scheduling is
17984 @samp{8000}.
17986 @item -mlinker-opt
17987 @opindex mlinker-opt
17988 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17989 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17990 linkers in which they give bogus error messages when linking some programs.
17992 @item -msoft-float
17993 @opindex msoft-float
17994 Generate output containing library calls for floating point.
17995 @strong{Warning:} the requisite libraries are not available for all HPPA
17996 targets.  Normally the facilities of the machine's usual C compiler are
17997 used, but this cannot be done directly in cross-compilation.  You must make
17998 your own arrangements to provide suitable library functions for
17999 cross-compilation.
18001 @option{-msoft-float} changes the calling convention in the output file;
18002 therefore, it is only useful if you compile @emph{all} of a program with
18003 this option.  In particular, you need to compile @file{libgcc.a}, the
18004 library that comes with GCC, with @option{-msoft-float} in order for
18005 this to work.
18007 @item -msio
18008 @opindex msio
18009 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18010 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18011 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18012 options are available under HP-UX and HI-UX@.
18014 @item -mgnu-ld
18015 @opindex mgnu-ld
18016 Use options specific to GNU @command{ld}.
18017 This passes @option{-shared} to @command{ld} when
18018 building a shared library.  It is the default when GCC is configured,
18019 explicitly or implicitly, with the GNU linker.  This option does not
18020 affect which @command{ld} is called; it only changes what parameters
18021 are passed to that @command{ld}.
18022 The @command{ld} that is called is determined by the
18023 @option{--with-ld} configure option, GCC's program search path, and
18024 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18025 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18026 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18028 @item -mhp-ld
18029 @opindex mhp-ld
18030 Use options specific to HP @command{ld}.
18031 This passes @option{-b} to @command{ld} when building
18032 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18033 links.  It is the default when GCC is configured, explicitly or
18034 implicitly, with the HP linker.  This option does not affect
18035 which @command{ld} is called; it only changes what parameters are passed to that
18036 @command{ld}.
18037 The @command{ld} that is called is determined by the @option{--with-ld}
18038 configure option, GCC's program search path, and finally by the user's
18039 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18040 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18041 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18043 @item -mlong-calls
18044 @opindex mno-long-calls
18045 Generate code that uses long call sequences.  This ensures that a call
18046 is always able to reach linker generated stubs.  The default is to generate
18047 long calls only when the distance from the call site to the beginning
18048 of the function or translation unit, as the case may be, exceeds a
18049 predefined limit set by the branch type being used.  The limits for
18050 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18051 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18052 240,000 bytes.
18054 Distances are measured from the beginning of functions when using the
18055 @option{-ffunction-sections} option, or when using the @option{-mgas}
18056 and @option{-mno-portable-runtime} options together under HP-UX with
18057 the SOM linker.
18059 It is normally not desirable to use this option as it degrades
18060 performance.  However, it may be useful in large applications,
18061 particularly when partial linking is used to build the application.
18063 The types of long calls used depends on the capabilities of the
18064 assembler and linker, and the type of code being generated.  The
18065 impact on systems that support long absolute calls, and long pic
18066 symbol-difference or pc-relative calls should be relatively small.
18067 However, an indirect call is used on 32-bit ELF systems in pic code
18068 and it is quite long.
18070 @item -munix=@var{unix-std}
18071 @opindex march
18072 Generate compiler predefines and select a startfile for the specified
18073 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18074 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18075 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18076 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18077 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18078 and later.
18080 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18081 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18082 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18083 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18084 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18085 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18087 It is @emph{important} to note that this option changes the interfaces
18088 for various library routines.  It also affects the operational behavior
18089 of the C library.  Thus, @emph{extreme} care is needed in using this
18090 option.
18092 Library code that is intended to operate with more than one UNIX
18093 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18094 as appropriate.  Most GNU software doesn't provide this capability.
18096 @item -nolibdld
18097 @opindex nolibdld
18098 Suppress the generation of link options to search libdld.sl when the
18099 @option{-static} option is specified on HP-UX 10 and later.
18101 @item -static
18102 @opindex static
18103 The HP-UX implementation of setlocale in libc has a dependency on
18104 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18105 when the @option{-static} option is specified, special link options
18106 are needed to resolve this dependency.
18108 On HP-UX 10 and later, the GCC driver adds the necessary options to
18109 link with libdld.sl when the @option{-static} option is specified.
18110 This causes the resulting binary to be dynamic.  On the 64-bit port,
18111 the linkers generate dynamic binaries by default in any case.  The
18112 @option{-nolibdld} option can be used to prevent the GCC driver from
18113 adding these link options.
18115 @item -threads
18116 @opindex threads
18117 Add support for multithreading with the @dfn{dce thread} library
18118 under HP-UX@.  This option sets flags for both the preprocessor and
18119 linker.
18120 @end table
18122 @node IA-64 Options
18123 @subsection IA-64 Options
18124 @cindex IA-64 Options
18126 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18128 @table @gcctabopt
18129 @item -mbig-endian
18130 @opindex mbig-endian
18131 Generate code for a big-endian target.  This is the default for HP-UX@.
18133 @item -mlittle-endian
18134 @opindex mlittle-endian
18135 Generate code for a little-endian target.  This is the default for AIX5
18136 and GNU/Linux.
18138 @item -mgnu-as
18139 @itemx -mno-gnu-as
18140 @opindex mgnu-as
18141 @opindex mno-gnu-as
18142 Generate (or don't) code for the GNU assembler.  This is the default.
18143 @c Also, this is the default if the configure option @option{--with-gnu-as}
18144 @c is used.
18146 @item -mgnu-ld
18147 @itemx -mno-gnu-ld
18148 @opindex mgnu-ld
18149 @opindex mno-gnu-ld
18150 Generate (or don't) code for the GNU linker.  This is the default.
18151 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18152 @c is used.
18154 @item -mno-pic
18155 @opindex mno-pic
18156 Generate code that does not use a global pointer register.  The result
18157 is not position independent code, and violates the IA-64 ABI@.
18159 @item -mvolatile-asm-stop
18160 @itemx -mno-volatile-asm-stop
18161 @opindex mvolatile-asm-stop
18162 @opindex mno-volatile-asm-stop
18163 Generate (or don't) a stop bit immediately before and after volatile asm
18164 statements.
18166 @item -mregister-names
18167 @itemx -mno-register-names
18168 @opindex mregister-names
18169 @opindex mno-register-names
18170 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18171 the stacked registers.  This may make assembler output more readable.
18173 @item -mno-sdata
18174 @itemx -msdata
18175 @opindex mno-sdata
18176 @opindex msdata
18177 Disable (or enable) optimizations that use the small data section.  This may
18178 be useful for working around optimizer bugs.
18180 @item -mconstant-gp
18181 @opindex mconstant-gp
18182 Generate code that uses a single constant global pointer value.  This is
18183 useful when compiling kernel code.
18185 @item -mauto-pic
18186 @opindex mauto-pic
18187 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18188 This is useful when compiling firmware code.
18190 @item -minline-float-divide-min-latency
18191 @opindex minline-float-divide-min-latency
18192 Generate code for inline divides of floating-point values
18193 using the minimum latency algorithm.
18195 @item -minline-float-divide-max-throughput
18196 @opindex minline-float-divide-max-throughput
18197 Generate code for inline divides of floating-point values
18198 using the maximum throughput algorithm.
18200 @item -mno-inline-float-divide
18201 @opindex mno-inline-float-divide
18202 Do not generate inline code for divides of floating-point values.
18204 @item -minline-int-divide-min-latency
18205 @opindex minline-int-divide-min-latency
18206 Generate code for inline divides of integer values
18207 using the minimum latency algorithm.
18209 @item -minline-int-divide-max-throughput
18210 @opindex minline-int-divide-max-throughput
18211 Generate code for inline divides of integer values
18212 using the maximum throughput algorithm.
18214 @item -mno-inline-int-divide
18215 @opindex mno-inline-int-divide
18216 Do not generate inline code for divides of integer values.
18218 @item -minline-sqrt-min-latency
18219 @opindex minline-sqrt-min-latency
18220 Generate code for inline square roots
18221 using the minimum latency algorithm.
18223 @item -minline-sqrt-max-throughput
18224 @opindex minline-sqrt-max-throughput
18225 Generate code for inline square roots
18226 using the maximum throughput algorithm.
18228 @item -mno-inline-sqrt
18229 @opindex mno-inline-sqrt
18230 Do not generate inline code for @code{sqrt}.
18232 @item -mfused-madd
18233 @itemx -mno-fused-madd
18234 @opindex mfused-madd
18235 @opindex mno-fused-madd
18236 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18237 instructions.  The default is to use these instructions.
18239 @item -mno-dwarf2-asm
18240 @itemx -mdwarf2-asm
18241 @opindex mno-dwarf2-asm
18242 @opindex mdwarf2-asm
18243 Don't (or do) generate assembler code for the DWARF line number debugging
18244 info.  This may be useful when not using the GNU assembler.
18246 @item -mearly-stop-bits
18247 @itemx -mno-early-stop-bits
18248 @opindex mearly-stop-bits
18249 @opindex mno-early-stop-bits
18250 Allow stop bits to be placed earlier than immediately preceding the
18251 instruction that triggered the stop bit.  This can improve instruction
18252 scheduling, but does not always do so.
18254 @item -mfixed-range=@var{register-range}
18255 @opindex mfixed-range
18256 Generate code treating the given register range as fixed registers.
18257 A fixed register is one that the register allocator cannot use.  This is
18258 useful when compiling kernel code.  A register range is specified as
18259 two registers separated by a dash.  Multiple register ranges can be
18260 specified separated by a comma.
18262 @item -mtls-size=@var{tls-size}
18263 @opindex mtls-size
18264 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18267 @item -mtune=@var{cpu-type}
18268 @opindex mtune
18269 Tune the instruction scheduling for a particular CPU, Valid values are
18270 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18271 and @samp{mckinley}.
18273 @item -milp32
18274 @itemx -mlp64
18275 @opindex milp32
18276 @opindex mlp64
18277 Generate code for a 32-bit or 64-bit environment.
18278 The 32-bit environment sets int, long and pointer to 32 bits.
18279 The 64-bit environment sets int to 32 bits and long and pointer
18280 to 64 bits.  These are HP-UX specific flags.
18282 @item -mno-sched-br-data-spec
18283 @itemx -msched-br-data-spec
18284 @opindex mno-sched-br-data-spec
18285 @opindex msched-br-data-spec
18286 (Dis/En)able data speculative scheduling before reload.
18287 This results in generation of @code{ld.a} instructions and
18288 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18289 The default setting is disabled.
18291 @item -msched-ar-data-spec
18292 @itemx -mno-sched-ar-data-spec
18293 @opindex msched-ar-data-spec
18294 @opindex mno-sched-ar-data-spec
18295 (En/Dis)able data speculative scheduling after reload.
18296 This results in generation of @code{ld.a} instructions and
18297 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18298 The default setting is enabled.
18300 @item -mno-sched-control-spec
18301 @itemx -msched-control-spec
18302 @opindex mno-sched-control-spec
18303 @opindex msched-control-spec
18304 (Dis/En)able control speculative scheduling.  This feature is
18305 available only during region scheduling (i.e.@: before reload).
18306 This results in generation of the @code{ld.s} instructions and
18307 the corresponding check instructions @code{chk.s}.
18308 The default setting is disabled.
18310 @item -msched-br-in-data-spec
18311 @itemx -mno-sched-br-in-data-spec
18312 @opindex msched-br-in-data-spec
18313 @opindex mno-sched-br-in-data-spec
18314 (En/Dis)able speculative scheduling of the instructions that
18315 are dependent on the data speculative loads before reload.
18316 This is effective only with @option{-msched-br-data-spec} enabled.
18317 The default setting is enabled.
18319 @item -msched-ar-in-data-spec
18320 @itemx -mno-sched-ar-in-data-spec
18321 @opindex msched-ar-in-data-spec
18322 @opindex mno-sched-ar-in-data-spec
18323 (En/Dis)able speculative scheduling of the instructions that
18324 are dependent on the data speculative loads after reload.
18325 This is effective only with @option{-msched-ar-data-spec} enabled.
18326 The default setting is enabled.
18328 @item -msched-in-control-spec
18329 @itemx -mno-sched-in-control-spec
18330 @opindex msched-in-control-spec
18331 @opindex mno-sched-in-control-spec
18332 (En/Dis)able speculative scheduling of the instructions that
18333 are dependent on the control speculative loads.
18334 This is effective only with @option{-msched-control-spec} enabled.
18335 The default setting is enabled.
18337 @item -mno-sched-prefer-non-data-spec-insns
18338 @itemx -msched-prefer-non-data-spec-insns
18339 @opindex mno-sched-prefer-non-data-spec-insns
18340 @opindex msched-prefer-non-data-spec-insns
18341 If enabled, data-speculative instructions are chosen for schedule
18342 only if there are no other choices at the moment.  This makes
18343 the use of the data speculation much more conservative.
18344 The default setting is disabled.
18346 @item -mno-sched-prefer-non-control-spec-insns
18347 @itemx -msched-prefer-non-control-spec-insns
18348 @opindex mno-sched-prefer-non-control-spec-insns
18349 @opindex msched-prefer-non-control-spec-insns
18350 If enabled, control-speculative instructions are chosen for schedule
18351 only if there are no other choices at the moment.  This makes
18352 the use of the control speculation much more conservative.
18353 The default setting is disabled.
18355 @item -mno-sched-count-spec-in-critical-path
18356 @itemx -msched-count-spec-in-critical-path
18357 @opindex mno-sched-count-spec-in-critical-path
18358 @opindex msched-count-spec-in-critical-path
18359 If enabled, speculative dependencies are considered during
18360 computation of the instructions priorities.  This makes the use of the
18361 speculation a bit more conservative.
18362 The default setting is disabled.
18364 @item -msched-spec-ldc
18365 @opindex msched-spec-ldc
18366 Use a simple data speculation check.  This option is on by default.
18368 @item -msched-control-spec-ldc
18369 @opindex msched-spec-ldc
18370 Use a simple check for control speculation.  This option is on by default.
18372 @item -msched-stop-bits-after-every-cycle
18373 @opindex msched-stop-bits-after-every-cycle
18374 Place a stop bit after every cycle when scheduling.  This option is on
18375 by default.
18377 @item -msched-fp-mem-deps-zero-cost
18378 @opindex msched-fp-mem-deps-zero-cost
18379 Assume that floating-point stores and loads are not likely to cause a conflict
18380 when placed into the same instruction group.  This option is disabled by
18381 default.
18383 @item -msel-sched-dont-check-control-spec
18384 @opindex msel-sched-dont-check-control-spec
18385 Generate checks for control speculation in selective scheduling.
18386 This flag is disabled by default.
18388 @item -msched-max-memory-insns=@var{max-insns}
18389 @opindex msched-max-memory-insns
18390 Limit on the number of memory insns per instruction group, giving lower
18391 priority to subsequent memory insns attempting to schedule in the same
18392 instruction group. Frequently useful to prevent cache bank conflicts.
18393 The default value is 1.
18395 @item -msched-max-memory-insns-hard-limit
18396 @opindex msched-max-memory-insns-hard-limit
18397 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18398 disallowing more than that number in an instruction group.
18399 Otherwise, the limit is ``soft'', meaning that non-memory operations
18400 are preferred when the limit is reached, but memory operations may still
18401 be scheduled.
18403 @end table
18405 @node LM32 Options
18406 @subsection LM32 Options
18407 @cindex LM32 options
18409 These @option{-m} options are defined for the LatticeMico32 architecture:
18411 @table @gcctabopt
18412 @item -mbarrel-shift-enabled
18413 @opindex mbarrel-shift-enabled
18414 Enable barrel-shift instructions.
18416 @item -mdivide-enabled
18417 @opindex mdivide-enabled
18418 Enable divide and modulus instructions.
18420 @item -mmultiply-enabled
18421 @opindex multiply-enabled
18422 Enable multiply instructions.
18424 @item -msign-extend-enabled
18425 @opindex msign-extend-enabled
18426 Enable sign extend instructions.
18428 @item -muser-enabled
18429 @opindex muser-enabled
18430 Enable user-defined instructions.
18432 @end table
18434 @node M32C Options
18435 @subsection M32C Options
18436 @cindex M32C options
18438 @table @gcctabopt
18439 @item -mcpu=@var{name}
18440 @opindex mcpu=
18441 Select the CPU for which code is generated.  @var{name} may be one of
18442 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18443 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18444 the M32C/80 series.
18446 @item -msim
18447 @opindex msim
18448 Specifies that the program will be run on the simulator.  This causes
18449 an alternate runtime library to be linked in which supports, for
18450 example, file I/O@.  You must not use this option when generating
18451 programs that will run on real hardware; you must provide your own
18452 runtime library for whatever I/O functions are needed.
18454 @item -memregs=@var{number}
18455 @opindex memregs=
18456 Specifies the number of memory-based pseudo-registers GCC uses
18457 during code generation.  These pseudo-registers are used like real
18458 registers, so there is a tradeoff between GCC's ability to fit the
18459 code into available registers, and the performance penalty of using
18460 memory instead of registers.  Note that all modules in a program must
18461 be compiled with the same value for this option.  Because of that, you
18462 must not use this option with GCC's default runtime libraries.
18464 @end table
18466 @node M32R/D Options
18467 @subsection M32R/D Options
18468 @cindex M32R/D options
18470 These @option{-m} options are defined for Renesas M32R/D architectures:
18472 @table @gcctabopt
18473 @item -m32r2
18474 @opindex m32r2
18475 Generate code for the M32R/2@.
18477 @item -m32rx
18478 @opindex m32rx
18479 Generate code for the M32R/X@.
18481 @item -m32r
18482 @opindex m32r
18483 Generate code for the M32R@.  This is the default.
18485 @item -mmodel=small
18486 @opindex mmodel=small
18487 Assume all objects live in the lower 16MB of memory (so that their addresses
18488 can be loaded with the @code{ld24} instruction), and assume all subroutines
18489 are reachable with the @code{bl} instruction.
18490 This is the default.
18492 The addressability of a particular object can be set with the
18493 @code{model} attribute.
18495 @item -mmodel=medium
18496 @opindex mmodel=medium
18497 Assume objects may be anywhere in the 32-bit address space (the compiler
18498 generates @code{seth/add3} instructions to load their addresses), and
18499 assume all subroutines are reachable with the @code{bl} instruction.
18501 @item -mmodel=large
18502 @opindex mmodel=large
18503 Assume objects may be anywhere in the 32-bit address space (the compiler
18504 generates @code{seth/add3} instructions to load their addresses), and
18505 assume subroutines may not be reachable with the @code{bl} instruction
18506 (the compiler generates the much slower @code{seth/add3/jl}
18507 instruction sequence).
18509 @item -msdata=none
18510 @opindex msdata=none
18511 Disable use of the small data area.  Variables are put into
18512 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18513 @code{section} attribute has been specified).
18514 This is the default.
18516 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18517 Objects may be explicitly put in the small data area with the
18518 @code{section} attribute using one of these sections.
18520 @item -msdata=sdata
18521 @opindex msdata=sdata
18522 Put small global and static data in the small data area, but do not
18523 generate special code to reference them.
18525 @item -msdata=use
18526 @opindex msdata=use
18527 Put small global and static data in the small data area, and generate
18528 special instructions to reference them.
18530 @item -G @var{num}
18531 @opindex G
18532 @cindex smaller data references
18533 Put global and static objects less than or equal to @var{num} bytes
18534 into the small data or BSS sections instead of the normal data or BSS
18535 sections.  The default value of @var{num} is 8.
18536 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18537 for this option to have any effect.
18539 All modules should be compiled with the same @option{-G @var{num}} value.
18540 Compiling with different values of @var{num} may or may not work; if it
18541 doesn't the linker gives an error message---incorrect code is not
18542 generated.
18544 @item -mdebug
18545 @opindex mdebug
18546 Makes the M32R-specific code in the compiler display some statistics
18547 that might help in debugging programs.
18549 @item -malign-loops
18550 @opindex malign-loops
18551 Align all loops to a 32-byte boundary.
18553 @item -mno-align-loops
18554 @opindex mno-align-loops
18555 Do not enforce a 32-byte alignment for loops.  This is the default.
18557 @item -missue-rate=@var{number}
18558 @opindex missue-rate=@var{number}
18559 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18560 or 2.
18562 @item -mbranch-cost=@var{number}
18563 @opindex mbranch-cost=@var{number}
18564 @var{number} can only be 1 or 2.  If it is 1 then branches are
18565 preferred over conditional code, if it is 2, then the opposite applies.
18567 @item -mflush-trap=@var{number}
18568 @opindex mflush-trap=@var{number}
18569 Specifies the trap number to use to flush the cache.  The default is
18570 12.  Valid numbers are between 0 and 15 inclusive.
18572 @item -mno-flush-trap
18573 @opindex mno-flush-trap
18574 Specifies that the cache cannot be flushed by using a trap.
18576 @item -mflush-func=@var{name}
18577 @opindex mflush-func=@var{name}
18578 Specifies the name of the operating system function to call to flush
18579 the cache.  The default is @samp{_flush_cache}, but a function call
18580 is only used if a trap is not available.
18582 @item -mno-flush-func
18583 @opindex mno-flush-func
18584 Indicates that there is no OS function for flushing the cache.
18586 @end table
18588 @node M680x0 Options
18589 @subsection M680x0 Options
18590 @cindex M680x0 options
18592 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18593 The default settings depend on which architecture was selected when
18594 the compiler was configured; the defaults for the most common choices
18595 are given below.
18597 @table @gcctabopt
18598 @item -march=@var{arch}
18599 @opindex march
18600 Generate code for a specific M680x0 or ColdFire instruction set
18601 architecture.  Permissible values of @var{arch} for M680x0
18602 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18603 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18604 architectures are selected according to Freescale's ISA classification
18605 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18606 @samp{isab} and @samp{isac}.
18608 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18609 code for a ColdFire target.  The @var{arch} in this macro is one of the
18610 @option{-march} arguments given above.
18612 When used together, @option{-march} and @option{-mtune} select code
18613 that runs on a family of similar processors but that is optimized
18614 for a particular microarchitecture.
18616 @item -mcpu=@var{cpu}
18617 @opindex mcpu
18618 Generate code for a specific M680x0 or ColdFire processor.
18619 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18620 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18621 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18622 below, which also classifies the CPUs into families:
18624 @multitable @columnfractions 0.20 0.80
18625 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18626 @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}
18627 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18628 @item @samp{5206e} @tab @samp{5206e}
18629 @item @samp{5208} @tab @samp{5207} @samp{5208}
18630 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18631 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18632 @item @samp{5216} @tab @samp{5214} @samp{5216}
18633 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18634 @item @samp{5225} @tab @samp{5224} @samp{5225}
18635 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18636 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18637 @item @samp{5249} @tab @samp{5249}
18638 @item @samp{5250} @tab @samp{5250}
18639 @item @samp{5271} @tab @samp{5270} @samp{5271}
18640 @item @samp{5272} @tab @samp{5272}
18641 @item @samp{5275} @tab @samp{5274} @samp{5275}
18642 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18643 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18644 @item @samp{5307} @tab @samp{5307}
18645 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18646 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18647 @item @samp{5407} @tab @samp{5407}
18648 @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}
18649 @end multitable
18651 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18652 @var{arch} is compatible with @var{cpu}.  Other combinations of
18653 @option{-mcpu} and @option{-march} are rejected.
18655 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18656 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18657 where the value of @var{family} is given by the table above.
18659 @item -mtune=@var{tune}
18660 @opindex mtune
18661 Tune the code for a particular microarchitecture within the
18662 constraints set by @option{-march} and @option{-mcpu}.
18663 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18664 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18665 and @samp{cpu32}.  The ColdFire microarchitectures
18666 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18668 You can also use @option{-mtune=68020-40} for code that needs
18669 to run relatively well on 68020, 68030 and 68040 targets.
18670 @option{-mtune=68020-60} is similar but includes 68060 targets
18671 as well.  These two options select the same tuning decisions as
18672 @option{-m68020-40} and @option{-m68020-60} respectively.
18674 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18675 when tuning for 680x0 architecture @var{arch}.  It also defines
18676 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18677 option is used.  If GCC is tuning for a range of architectures,
18678 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18679 it defines the macros for every architecture in the range.
18681 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18682 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18683 of the arguments given above.
18685 @item -m68000
18686 @itemx -mc68000
18687 @opindex m68000
18688 @opindex mc68000
18689 Generate output for a 68000.  This is the default
18690 when the compiler is configured for 68000-based systems.
18691 It is equivalent to @option{-march=68000}.
18693 Use this option for microcontrollers with a 68000 or EC000 core,
18694 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18696 @item -m68010
18697 @opindex m68010
18698 Generate output for a 68010.  This is the default
18699 when the compiler is configured for 68010-based systems.
18700 It is equivalent to @option{-march=68010}.
18702 @item -m68020
18703 @itemx -mc68020
18704 @opindex m68020
18705 @opindex mc68020
18706 Generate output for a 68020.  This is the default
18707 when the compiler is configured for 68020-based systems.
18708 It is equivalent to @option{-march=68020}.
18710 @item -m68030
18711 @opindex m68030
18712 Generate output for a 68030.  This is the default when the compiler is
18713 configured for 68030-based systems.  It is equivalent to
18714 @option{-march=68030}.
18716 @item -m68040
18717 @opindex m68040
18718 Generate output for a 68040.  This is the default when the compiler is
18719 configured for 68040-based systems.  It is equivalent to
18720 @option{-march=68040}.
18722 This option inhibits the use of 68881/68882 instructions that have to be
18723 emulated by software on the 68040.  Use this option if your 68040 does not
18724 have code to emulate those instructions.
18726 @item -m68060
18727 @opindex m68060
18728 Generate output for a 68060.  This is the default when the compiler is
18729 configured for 68060-based systems.  It is equivalent to
18730 @option{-march=68060}.
18732 This option inhibits the use of 68020 and 68881/68882 instructions that
18733 have to be emulated by software on the 68060.  Use this option if your 68060
18734 does not have code to emulate those instructions.
18736 @item -mcpu32
18737 @opindex mcpu32
18738 Generate output for a CPU32.  This is the default
18739 when the compiler is configured for CPU32-based systems.
18740 It is equivalent to @option{-march=cpu32}.
18742 Use this option for microcontrollers with a
18743 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18744 68336, 68340, 68341, 68349 and 68360.
18746 @item -m5200
18747 @opindex m5200
18748 Generate output for a 520X ColdFire CPU@.  This is the default
18749 when the compiler is configured for 520X-based systems.
18750 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18751 in favor of that option.
18753 Use this option for microcontroller with a 5200 core, including
18754 the MCF5202, MCF5203, MCF5204 and MCF5206.
18756 @item -m5206e
18757 @opindex m5206e
18758 Generate output for a 5206e ColdFire CPU@.  The option is now
18759 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18761 @item -m528x
18762 @opindex m528x
18763 Generate output for a member of the ColdFire 528X family.
18764 The option is now deprecated in favor of the equivalent
18765 @option{-mcpu=528x}.
18767 @item -m5307
18768 @opindex m5307
18769 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18770 in favor of the equivalent @option{-mcpu=5307}.
18772 @item -m5407
18773 @opindex m5407
18774 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18775 in favor of the equivalent @option{-mcpu=5407}.
18777 @item -mcfv4e
18778 @opindex mcfv4e
18779 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18780 This includes use of hardware floating-point instructions.
18781 The option is equivalent to @option{-mcpu=547x}, and is now
18782 deprecated in favor of that option.
18784 @item -m68020-40
18785 @opindex m68020-40
18786 Generate output for a 68040, without using any of the new instructions.
18787 This results in code that can run relatively efficiently on either a
18788 68020/68881 or a 68030 or a 68040.  The generated code does use the
18789 68881 instructions that are emulated on the 68040.
18791 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18793 @item -m68020-60
18794 @opindex m68020-60
18795 Generate output for a 68060, without using any of the new instructions.
18796 This results in code that can run relatively efficiently on either a
18797 68020/68881 or a 68030 or a 68040.  The generated code does use the
18798 68881 instructions that are emulated on the 68060.
18800 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18802 @item -mhard-float
18803 @itemx -m68881
18804 @opindex mhard-float
18805 @opindex m68881
18806 Generate floating-point instructions.  This is the default for 68020
18807 and above, and for ColdFire devices that have an FPU@.  It defines the
18808 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18809 on ColdFire targets.
18811 @item -msoft-float
18812 @opindex msoft-float
18813 Do not generate floating-point instructions; use library calls instead.
18814 This is the default for 68000, 68010, and 68832 targets.  It is also
18815 the default for ColdFire devices that have no FPU.
18817 @item -mdiv
18818 @itemx -mno-div
18819 @opindex mdiv
18820 @opindex mno-div
18821 Generate (do not generate) ColdFire hardware divide and remainder
18822 instructions.  If @option{-march} is used without @option{-mcpu},
18823 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18824 architectures.  Otherwise, the default is taken from the target CPU
18825 (either the default CPU, or the one specified by @option{-mcpu}).  For
18826 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18827 @option{-mcpu=5206e}.
18829 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18831 @item -mshort
18832 @opindex mshort
18833 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18834 Additionally, parameters passed on the stack are also aligned to a
18835 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18837 @item -mno-short
18838 @opindex mno-short
18839 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18841 @item -mnobitfield
18842 @itemx -mno-bitfield
18843 @opindex mnobitfield
18844 @opindex mno-bitfield
18845 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18846 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18848 @item -mbitfield
18849 @opindex mbitfield
18850 Do use the bit-field instructions.  The @option{-m68020} option implies
18851 @option{-mbitfield}.  This is the default if you use a configuration
18852 designed for a 68020.
18854 @item -mrtd
18855 @opindex mrtd
18856 Use a different function-calling convention, in which functions
18857 that take a fixed number of arguments return with the @code{rtd}
18858 instruction, which pops their arguments while returning.  This
18859 saves one instruction in the caller since there is no need to pop
18860 the arguments there.
18862 This calling convention is incompatible with the one normally
18863 used on Unix, so you cannot use it if you need to call libraries
18864 compiled with the Unix compiler.
18866 Also, you must provide function prototypes for all functions that
18867 take variable numbers of arguments (including @code{printf});
18868 otherwise incorrect code is generated for calls to those
18869 functions.
18871 In addition, seriously incorrect code results if you call a
18872 function with too many arguments.  (Normally, extra arguments are
18873 harmlessly ignored.)
18875 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18876 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18878 @item -mno-rtd
18879 @opindex mno-rtd
18880 Do not use the calling conventions selected by @option{-mrtd}.
18881 This is the default.
18883 @item -malign-int
18884 @itemx -mno-align-int
18885 @opindex malign-int
18886 @opindex mno-align-int
18887 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18888 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18889 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18890 Aligning variables on 32-bit boundaries produces code that runs somewhat
18891 faster on processors with 32-bit busses at the expense of more memory.
18893 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18894 aligns structures containing the above types differently than
18895 most published application binary interface specifications for the m68k.
18897 @item -mpcrel
18898 @opindex mpcrel
18899 Use the pc-relative addressing mode of the 68000 directly, instead of
18900 using a global offset table.  At present, this option implies @option{-fpic},
18901 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18902 not presently supported with @option{-mpcrel}, though this could be supported for
18903 68020 and higher processors.
18905 @item -mno-strict-align
18906 @itemx -mstrict-align
18907 @opindex mno-strict-align
18908 @opindex mstrict-align
18909 Do not (do) assume that unaligned memory references are handled by
18910 the system.
18912 @item -msep-data
18913 Generate code that allows the data segment to be located in a different
18914 area of memory from the text segment.  This allows for execute-in-place in
18915 an environment without virtual memory management.  This option implies
18916 @option{-fPIC}.
18918 @item -mno-sep-data
18919 Generate code that assumes that the data segment follows the text segment.
18920 This is the default.
18922 @item -mid-shared-library
18923 Generate code that supports shared libraries via the library ID method.
18924 This allows for execute-in-place and shared libraries in an environment
18925 without virtual memory management.  This option implies @option{-fPIC}.
18927 @item -mno-id-shared-library
18928 Generate code that doesn't assume ID-based shared libraries are being used.
18929 This is the default.
18931 @item -mshared-library-id=n
18932 Specifies the identification number of the ID-based shared library being
18933 compiled.  Specifying a value of 0 generates more compact code; specifying
18934 other values forces the allocation of that number to the current
18935 library, but is no more space- or time-efficient than omitting this option.
18937 @item -mxgot
18938 @itemx -mno-xgot
18939 @opindex mxgot
18940 @opindex mno-xgot
18941 When generating position-independent code for ColdFire, generate code
18942 that works if the GOT has more than 8192 entries.  This code is
18943 larger and slower than code generated without this option.  On M680x0
18944 processors, this option is not needed; @option{-fPIC} suffices.
18946 GCC normally uses a single instruction to load values from the GOT@.
18947 While this is relatively efficient, it only works if the GOT
18948 is smaller than about 64k.  Anything larger causes the linker
18949 to report an error such as:
18951 @cindex relocation truncated to fit (ColdFire)
18952 @smallexample
18953 relocation truncated to fit: R_68K_GOT16O foobar
18954 @end smallexample
18956 If this happens, you should recompile your code with @option{-mxgot}.
18957 It should then work with very large GOTs.  However, code generated with
18958 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18959 the value of a global symbol.
18961 Note that some linkers, including newer versions of the GNU linker,
18962 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18963 you should only need to use @option{-mxgot} when compiling a single
18964 object file that accesses more than 8192 GOT entries.  Very few do.
18966 These options have no effect unless GCC is generating
18967 position-independent code.
18969 @item -mlong-jump-table-offsets
18970 @opindex mlong-jump-table-offsets
18971 Use 32-bit offsets in @code{switch} tables.  The default is to use
18972 16-bit offsets.
18974 @end table
18976 @node MCore Options
18977 @subsection MCore Options
18978 @cindex MCore options
18980 These are the @samp{-m} options defined for the Motorola M*Core
18981 processors.
18983 @table @gcctabopt
18985 @item -mhardlit
18986 @itemx -mno-hardlit
18987 @opindex mhardlit
18988 @opindex mno-hardlit
18989 Inline constants into the code stream if it can be done in two
18990 instructions or less.
18992 @item -mdiv
18993 @itemx -mno-div
18994 @opindex mdiv
18995 @opindex mno-div
18996 Use the divide instruction.  (Enabled by default).
18998 @item -mrelax-immediate
18999 @itemx -mno-relax-immediate
19000 @opindex mrelax-immediate
19001 @opindex mno-relax-immediate
19002 Allow arbitrary-sized immediates in bit operations.
19004 @item -mwide-bitfields
19005 @itemx -mno-wide-bitfields
19006 @opindex mwide-bitfields
19007 @opindex mno-wide-bitfields
19008 Always treat bit-fields as @code{int}-sized.
19010 @item -m4byte-functions
19011 @itemx -mno-4byte-functions
19012 @opindex m4byte-functions
19013 @opindex mno-4byte-functions
19014 Force all functions to be aligned to a 4-byte boundary.
19016 @item -mcallgraph-data
19017 @itemx -mno-callgraph-data
19018 @opindex mcallgraph-data
19019 @opindex mno-callgraph-data
19020 Emit callgraph information.
19022 @item -mslow-bytes
19023 @itemx -mno-slow-bytes
19024 @opindex mslow-bytes
19025 @opindex mno-slow-bytes
19026 Prefer word access when reading byte quantities.
19028 @item -mlittle-endian
19029 @itemx -mbig-endian
19030 @opindex mlittle-endian
19031 @opindex mbig-endian
19032 Generate code for a little-endian target.
19034 @item -m210
19035 @itemx -m340
19036 @opindex m210
19037 @opindex m340
19038 Generate code for the 210 processor.
19040 @item -mno-lsim
19041 @opindex mno-lsim
19042 Assume that runtime support has been provided and so omit the
19043 simulator library (@file{libsim.a)} from the linker command line.
19045 @item -mstack-increment=@var{size}
19046 @opindex mstack-increment
19047 Set the maximum amount for a single stack increment operation.  Large
19048 values can increase the speed of programs that contain functions
19049 that need a large amount of stack space, but they can also trigger a
19050 segmentation fault if the stack is extended too much.  The default
19051 value is 0x1000.
19053 @end table
19055 @node MeP Options
19056 @subsection MeP Options
19057 @cindex MeP options
19059 @table @gcctabopt
19061 @item -mabsdiff
19062 @opindex mabsdiff
19063 Enables the @code{abs} instruction, which is the absolute difference
19064 between two registers.
19066 @item -mall-opts
19067 @opindex mall-opts
19068 Enables all the optional instructions---average, multiply, divide, bit
19069 operations, leading zero, absolute difference, min/max, clip, and
19070 saturation.
19073 @item -maverage
19074 @opindex maverage
19075 Enables the @code{ave} instruction, which computes the average of two
19076 registers.
19078 @item -mbased=@var{n}
19079 @opindex mbased=
19080 Variables of size @var{n} bytes or smaller are placed in the
19081 @code{.based} section by default.  Based variables use the @code{$tp}
19082 register as a base register, and there is a 128-byte limit to the
19083 @code{.based} section.
19085 @item -mbitops
19086 @opindex mbitops
19087 Enables the bit operation instructions---bit test (@code{btstm}), set
19088 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19089 test-and-set (@code{tas}).
19091 @item -mc=@var{name}
19092 @opindex mc=
19093 Selects which section constant data is placed in.  @var{name} may
19094 be @samp{tiny}, @samp{near}, or @samp{far}.
19096 @item -mclip
19097 @opindex mclip
19098 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19099 useful unless you also provide @option{-mminmax}.
19101 @item -mconfig=@var{name}
19102 @opindex mconfig=
19103 Selects one of the built-in core configurations.  Each MeP chip has
19104 one or more modules in it; each module has a core CPU and a variety of
19105 coprocessors, optional instructions, and peripherals.  The
19106 @code{MeP-Integrator} tool, not part of GCC, provides these
19107 configurations through this option; using this option is the same as
19108 using all the corresponding command-line options.  The default
19109 configuration is @samp{default}.
19111 @item -mcop
19112 @opindex mcop
19113 Enables the coprocessor instructions.  By default, this is a 32-bit
19114 coprocessor.  Note that the coprocessor is normally enabled via the
19115 @option{-mconfig=} option.
19117 @item -mcop32
19118 @opindex mcop32
19119 Enables the 32-bit coprocessor's instructions.
19121 @item -mcop64
19122 @opindex mcop64
19123 Enables the 64-bit coprocessor's instructions.
19125 @item -mivc2
19126 @opindex mivc2
19127 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19129 @item -mdc
19130 @opindex mdc
19131 Causes constant variables to be placed in the @code{.near} section.
19133 @item -mdiv
19134 @opindex mdiv
19135 Enables the @code{div} and @code{divu} instructions.
19137 @item -meb
19138 @opindex meb
19139 Generate big-endian code.
19141 @item -mel
19142 @opindex mel
19143 Generate little-endian code.
19145 @item -mio-volatile
19146 @opindex mio-volatile
19147 Tells the compiler that any variable marked with the @code{io}
19148 attribute is to be considered volatile.
19150 @item -ml
19151 @opindex ml
19152 Causes variables to be assigned to the @code{.far} section by default.
19154 @item -mleadz
19155 @opindex mleadz
19156 Enables the @code{leadz} (leading zero) instruction.
19158 @item -mm
19159 @opindex mm
19160 Causes variables to be assigned to the @code{.near} section by default.
19162 @item -mminmax
19163 @opindex mminmax
19164 Enables the @code{min} and @code{max} instructions.
19166 @item -mmult
19167 @opindex mmult
19168 Enables the multiplication and multiply-accumulate instructions.
19170 @item -mno-opts
19171 @opindex mno-opts
19172 Disables all the optional instructions enabled by @option{-mall-opts}.
19174 @item -mrepeat
19175 @opindex mrepeat
19176 Enables the @code{repeat} and @code{erepeat} instructions, used for
19177 low-overhead looping.
19179 @item -ms
19180 @opindex ms
19181 Causes all variables to default to the @code{.tiny} section.  Note
19182 that there is a 65536-byte limit to this section.  Accesses to these
19183 variables use the @code{%gp} base register.
19185 @item -msatur
19186 @opindex msatur
19187 Enables the saturation instructions.  Note that the compiler does not
19188 currently generate these itself, but this option is included for
19189 compatibility with other tools, like @code{as}.
19191 @item -msdram
19192 @opindex msdram
19193 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19195 @item -msim
19196 @opindex msim
19197 Link the simulator run-time libraries.
19199 @item -msimnovec
19200 @opindex msimnovec
19201 Link the simulator runtime libraries, excluding built-in support
19202 for reset and exception vectors and tables.
19204 @item -mtf
19205 @opindex mtf
19206 Causes all functions to default to the @code{.far} section.  Without
19207 this option, functions default to the @code{.near} section.
19209 @item -mtiny=@var{n}
19210 @opindex mtiny=
19211 Variables that are @var{n} bytes or smaller are allocated to the
19212 @code{.tiny} section.  These variables use the @code{$gp} base
19213 register.  The default for this option is 4, but note that there's a
19214 65536-byte limit to the @code{.tiny} section.
19216 @end table
19218 @node MicroBlaze Options
19219 @subsection MicroBlaze Options
19220 @cindex MicroBlaze Options
19222 @table @gcctabopt
19224 @item -msoft-float
19225 @opindex msoft-float
19226 Use software emulation for floating point (default).
19228 @item -mhard-float
19229 @opindex mhard-float
19230 Use hardware floating-point instructions.
19232 @item -mmemcpy
19233 @opindex mmemcpy
19234 Do not optimize block moves, use @code{memcpy}.
19236 @item -mno-clearbss
19237 @opindex mno-clearbss
19238 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19240 @item -mcpu=@var{cpu-type}
19241 @opindex mcpu=
19242 Use features of, and schedule code for, the given CPU.
19243 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19244 where @var{X} is a major version, @var{YY} is the minor version, and
19245 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19246 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19248 @item -mxl-soft-mul
19249 @opindex mxl-soft-mul
19250 Use software multiply emulation (default).
19252 @item -mxl-soft-div
19253 @opindex mxl-soft-div
19254 Use software emulation for divides (default).
19256 @item -mxl-barrel-shift
19257 @opindex mxl-barrel-shift
19258 Use the hardware barrel shifter.
19260 @item -mxl-pattern-compare
19261 @opindex mxl-pattern-compare
19262 Use pattern compare instructions.
19264 @item -msmall-divides
19265 @opindex msmall-divides
19266 Use table lookup optimization for small signed integer divisions.
19268 @item -mxl-stack-check
19269 @opindex mxl-stack-check
19270 This option is deprecated.  Use @option{-fstack-check} instead.
19272 @item -mxl-gp-opt
19273 @opindex mxl-gp-opt
19274 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19276 @item -mxl-multiply-high
19277 @opindex mxl-multiply-high
19278 Use multiply high instructions for high part of 32x32 multiply.
19280 @item -mxl-float-convert
19281 @opindex mxl-float-convert
19282 Use hardware floating-point conversion instructions.
19284 @item -mxl-float-sqrt
19285 @opindex mxl-float-sqrt
19286 Use hardware floating-point square root instruction.
19288 @item -mbig-endian
19289 @opindex mbig-endian
19290 Generate code for a big-endian target.
19292 @item -mlittle-endian
19293 @opindex mlittle-endian
19294 Generate code for a little-endian target.
19296 @item -mxl-reorder
19297 @opindex mxl-reorder
19298 Use reorder instructions (swap and byte reversed load/store).
19300 @item -mxl-mode-@var{app-model}
19301 Select application model @var{app-model}.  Valid models are
19302 @table @samp
19303 @item executable
19304 normal executable (default), uses startup code @file{crt0.o}.
19306 @item xmdstub
19307 for use with Xilinx Microprocessor Debugger (XMD) based
19308 software intrusive debug agent called xmdstub. This uses startup file
19309 @file{crt1.o} and sets the start address of the program to 0x800.
19311 @item bootstrap
19312 for applications that are loaded using a bootloader.
19313 This model uses startup file @file{crt2.o} which does not contain a processor
19314 reset vector handler. This is suitable for transferring control on a
19315 processor reset to the bootloader rather than the application.
19317 @item novectors
19318 for applications that do not require any of the
19319 MicroBlaze vectors. This option may be useful for applications running
19320 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19321 @end table
19323 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19324 @option{-mxl-mode-@var{app-model}}.
19326 @end table
19328 @node MIPS Options
19329 @subsection MIPS Options
19330 @cindex MIPS options
19332 @table @gcctabopt
19334 @item -EB
19335 @opindex EB
19336 Generate big-endian code.
19338 @item -EL
19339 @opindex EL
19340 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19341 configurations.
19343 @item -march=@var{arch}
19344 @opindex march
19345 Generate code that runs on @var{arch}, which can be the name of a
19346 generic MIPS ISA, or the name of a particular processor.
19347 The ISA names are:
19348 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19349 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19350 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19351 @samp{mips64r5} and @samp{mips64r6}.
19352 The processor names are:
19353 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19354 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19355 @samp{5kc}, @samp{5kf},
19356 @samp{20kc},
19357 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19358 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19359 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19360 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19361 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19362 @samp{i6400},
19363 @samp{interaptiv},
19364 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19365 @samp{m4k},
19366 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19367 @samp{m5100}, @samp{m5101},
19368 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19369 @samp{orion},
19370 @samp{p5600},
19371 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19372 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19373 @samp{rm7000}, @samp{rm9000},
19374 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19375 @samp{sb1},
19376 @samp{sr71000},
19377 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19378 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19379 @samp{xlr} and @samp{xlp}.
19380 The special value @samp{from-abi} selects the
19381 most compatible architecture for the selected ABI (that is,
19382 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19384 The native Linux/GNU toolchain also supports the value @samp{native},
19385 which selects the best architecture option for the host processor.
19386 @option{-march=native} has no effect if GCC does not recognize
19387 the processor.
19389 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19390 (for example, @option{-march=r2k}).  Prefixes are optional, and
19391 @samp{vr} may be written @samp{r}.
19393 Names of the form @samp{@var{n}f2_1} refer to processors with
19394 FPUs clocked at half the rate of the core, names of the form
19395 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19396 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19397 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19398 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19399 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19400 accepted as synonyms for @samp{@var{n}f1_1}.
19402 GCC defines two macros based on the value of this option.  The first
19403 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19404 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19405 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19406 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19407 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19409 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19410 above.  In other words, it has the full prefix and does not
19411 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19412 the macro names the resolved architecture (either @code{"mips1"} or
19413 @code{"mips3"}).  It names the default architecture when no
19414 @option{-march} option is given.
19416 @item -mtune=@var{arch}
19417 @opindex mtune
19418 Optimize for @var{arch}.  Among other things, this option controls
19419 the way instructions are scheduled, and the perceived cost of arithmetic
19420 operations.  The list of @var{arch} values is the same as for
19421 @option{-march}.
19423 When this option is not used, GCC optimizes for the processor
19424 specified by @option{-march}.  By using @option{-march} and
19425 @option{-mtune} together, it is possible to generate code that
19426 runs on a family of processors, but optimize the code for one
19427 particular member of that family.
19429 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19430 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19431 @option{-march} ones described above.
19433 @item -mips1
19434 @opindex mips1
19435 Equivalent to @option{-march=mips1}.
19437 @item -mips2
19438 @opindex mips2
19439 Equivalent to @option{-march=mips2}.
19441 @item -mips3
19442 @opindex mips3
19443 Equivalent to @option{-march=mips3}.
19445 @item -mips4
19446 @opindex mips4
19447 Equivalent to @option{-march=mips4}.
19449 @item -mips32
19450 @opindex mips32
19451 Equivalent to @option{-march=mips32}.
19453 @item -mips32r3
19454 @opindex mips32r3
19455 Equivalent to @option{-march=mips32r3}.
19457 @item -mips32r5
19458 @opindex mips32r5
19459 Equivalent to @option{-march=mips32r5}.
19461 @item -mips32r6
19462 @opindex mips32r6
19463 Equivalent to @option{-march=mips32r6}.
19465 @item -mips64
19466 @opindex mips64
19467 Equivalent to @option{-march=mips64}.
19469 @item -mips64r2
19470 @opindex mips64r2
19471 Equivalent to @option{-march=mips64r2}.
19473 @item -mips64r3
19474 @opindex mips64r3
19475 Equivalent to @option{-march=mips64r3}.
19477 @item -mips64r5
19478 @opindex mips64r5
19479 Equivalent to @option{-march=mips64r5}.
19481 @item -mips64r6
19482 @opindex mips64r6
19483 Equivalent to @option{-march=mips64r6}.
19485 @item -mips16
19486 @itemx -mno-mips16
19487 @opindex mips16
19488 @opindex mno-mips16
19489 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19490 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19492 MIPS16 code generation can also be controlled on a per-function basis
19493 by means of @code{mips16} and @code{nomips16} attributes.
19494 @xref{Function Attributes}, for more information.
19496 @item -mflip-mips16
19497 @opindex mflip-mips16
19498 Generate MIPS16 code on alternating functions.  This option is provided
19499 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19500 not intended for ordinary use in compiling user code.
19502 @item -minterlink-compressed
19503 @item -mno-interlink-compressed
19504 @opindex minterlink-compressed
19505 @opindex mno-interlink-compressed
19506 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19507 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19509 For example, code using the standard ISA encoding cannot jump directly
19510 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19511 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19512 knows that the target of the jump is not compressed.
19514 @item -minterlink-mips16
19515 @itemx -mno-interlink-mips16
19516 @opindex minterlink-mips16
19517 @opindex mno-interlink-mips16
19518 Aliases of @option{-minterlink-compressed} and
19519 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19520 and are retained for backwards compatibility.
19522 @item -mabi=32
19523 @itemx -mabi=o64
19524 @itemx -mabi=n32
19525 @itemx -mabi=64
19526 @itemx -mabi=eabi
19527 @opindex mabi=32
19528 @opindex mabi=o64
19529 @opindex mabi=n32
19530 @opindex mabi=64
19531 @opindex mabi=eabi
19532 Generate code for the given ABI@.
19534 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19535 generates 64-bit code when you select a 64-bit architecture, but you
19536 can use @option{-mgp32} to get 32-bit code instead.
19538 For information about the O64 ABI, see
19539 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19541 GCC supports a variant of the o32 ABI in which floating-point registers
19542 are 64 rather than 32 bits wide.  You can select this combination with
19543 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19544 and @code{mfhc1} instructions and is therefore only supported for
19545 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19547 The register assignments for arguments and return values remain the
19548 same, but each scalar value is passed in a single 64-bit register
19549 rather than a pair of 32-bit registers.  For example, scalar
19550 floating-point values are returned in @samp{$f0} only, not a
19551 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19552 remains the same in that the even-numbered double-precision registers
19553 are saved.
19555 Two additional variants of the o32 ABI are supported to enable
19556 a transition from 32-bit to 64-bit registers.  These are FPXX
19557 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19558 The FPXX extension mandates that all code must execute correctly
19559 when run using 32-bit or 64-bit registers.  The code can be interlinked
19560 with either FP32 or FP64, but not both.
19561 The FP64A extension is similar to the FP64 extension but forbids the
19562 use of odd-numbered single-precision registers.  This can be used
19563 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19564 processors and allows both FP32 and FP64A code to interlink and
19565 run in the same process without changing FPU modes.
19567 @item -mabicalls
19568 @itemx -mno-abicalls
19569 @opindex mabicalls
19570 @opindex mno-abicalls
19571 Generate (do not generate) code that is suitable for SVR4-style
19572 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19573 systems.
19575 @item -mshared
19576 @itemx -mno-shared
19577 Generate (do not generate) code that is fully position-independent,
19578 and that can therefore be linked into shared libraries.  This option
19579 only affects @option{-mabicalls}.
19581 All @option{-mabicalls} code has traditionally been position-independent,
19582 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19583 as an extension, the GNU toolchain allows executables to use absolute
19584 accesses for locally-binding symbols.  It can also use shorter GP
19585 initialization sequences and generate direct calls to locally-defined
19586 functions.  This mode is selected by @option{-mno-shared}.
19588 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19589 objects that can only be linked by the GNU linker.  However, the option
19590 does not affect the ABI of the final executable; it only affects the ABI
19591 of relocatable objects.  Using @option{-mno-shared} generally makes
19592 executables both smaller and quicker.
19594 @option{-mshared} is the default.
19596 @item -mplt
19597 @itemx -mno-plt
19598 @opindex mplt
19599 @opindex mno-plt
19600 Assume (do not assume) that the static and dynamic linkers
19601 support PLTs and copy relocations.  This option only affects
19602 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19603 has no effect without @option{-msym32}.
19605 You can make @option{-mplt} the default by configuring
19606 GCC with @option{--with-mips-plt}.  The default is
19607 @option{-mno-plt} otherwise.
19609 @item -mxgot
19610 @itemx -mno-xgot
19611 @opindex mxgot
19612 @opindex mno-xgot
19613 Lift (do not lift) the usual restrictions on the size of the global
19614 offset table.
19616 GCC normally uses a single instruction to load values from the GOT@.
19617 While this is relatively efficient, it only works if the GOT
19618 is smaller than about 64k.  Anything larger causes the linker
19619 to report an error such as:
19621 @cindex relocation truncated to fit (MIPS)
19622 @smallexample
19623 relocation truncated to fit: R_MIPS_GOT16 foobar
19624 @end smallexample
19626 If this happens, you should recompile your code with @option{-mxgot}.
19627 This works with very large GOTs, although the code is also
19628 less efficient, since it takes three instructions to fetch the
19629 value of a global symbol.
19631 Note that some linkers can create multiple GOTs.  If you have such a
19632 linker, you should only need to use @option{-mxgot} when a single object
19633 file accesses more than 64k's worth of GOT entries.  Very few do.
19635 These options have no effect unless GCC is generating position
19636 independent code.
19638 @item -mgp32
19639 @opindex mgp32
19640 Assume that general-purpose registers are 32 bits wide.
19642 @item -mgp64
19643 @opindex mgp64
19644 Assume that general-purpose registers are 64 bits wide.
19646 @item -mfp32
19647 @opindex mfp32
19648 Assume that floating-point registers are 32 bits wide.
19650 @item -mfp64
19651 @opindex mfp64
19652 Assume that floating-point registers are 64 bits wide.
19654 @item -mfpxx
19655 @opindex mfpxx
19656 Do not assume the width of floating-point registers.
19658 @item -mhard-float
19659 @opindex mhard-float
19660 Use floating-point coprocessor instructions.
19662 @item -msoft-float
19663 @opindex msoft-float
19664 Do not use floating-point coprocessor instructions.  Implement
19665 floating-point calculations using library calls instead.
19667 @item -mno-float
19668 @opindex mno-float
19669 Equivalent to @option{-msoft-float}, but additionally asserts that the
19670 program being compiled does not perform any floating-point operations.
19671 This option is presently supported only by some bare-metal MIPS
19672 configurations, where it may select a special set of libraries
19673 that lack all floating-point support (including, for example, the
19674 floating-point @code{printf} formats).  
19675 If code compiled with @option{-mno-float} accidentally contains
19676 floating-point operations, it is likely to suffer a link-time
19677 or run-time failure.
19679 @item -msingle-float
19680 @opindex msingle-float
19681 Assume that the floating-point coprocessor only supports single-precision
19682 operations.
19684 @item -mdouble-float
19685 @opindex mdouble-float
19686 Assume that the floating-point coprocessor supports double-precision
19687 operations.  This is the default.
19689 @item -modd-spreg
19690 @itemx -mno-odd-spreg
19691 @opindex modd-spreg
19692 @opindex mno-odd-spreg
19693 Enable the use of odd-numbered single-precision floating-point registers
19694 for the o32 ABI.  This is the default for processors that are known to
19695 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19696 is set by default.
19698 @item -mabs=2008
19699 @itemx -mabs=legacy
19700 @opindex mabs=2008
19701 @opindex mabs=legacy
19702 These options control the treatment of the special not-a-number (NaN)
19703 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19704 @code{neg.@i{fmt}} machine instructions.
19706 By default or when @option{-mabs=legacy} is used the legacy
19707 treatment is selected.  In this case these instructions are considered
19708 arithmetic and avoided where correct operation is required and the
19709 input operand might be a NaN.  A longer sequence of instructions that
19710 manipulate the sign bit of floating-point datum manually is used
19711 instead unless the @option{-ffinite-math-only} option has also been
19712 specified.
19714 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19715 this case these instructions are considered non-arithmetic and therefore
19716 operating correctly in all cases, including in particular where the
19717 input operand is a NaN.  These instructions are therefore always used
19718 for the respective operations.
19720 @item -mnan=2008
19721 @itemx -mnan=legacy
19722 @opindex mnan=2008
19723 @opindex mnan=legacy
19724 These options control the encoding of the special not-a-number (NaN)
19725 IEEE 754 floating-point data.
19727 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19728 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19729 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19730 by the first bit of their trailing significand field being 1.
19732 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19733 this case qNaNs are denoted by the first bit of their trailing
19734 significand field being 1, whereas sNaNs are denoted by the first bit of
19735 their trailing significand field being 0.
19737 The default is @option{-mnan=legacy} unless GCC has been configured with
19738 @option{--with-nan=2008}.
19740 @item -mllsc
19741 @itemx -mno-llsc
19742 @opindex mllsc
19743 @opindex mno-llsc
19744 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19745 implement atomic memory built-in functions.  When neither option is
19746 specified, GCC uses the instructions if the target architecture
19747 supports them.
19749 @option{-mllsc} is useful if the runtime environment can emulate the
19750 instructions and @option{-mno-llsc} can be useful when compiling for
19751 nonstandard ISAs.  You can make either option the default by
19752 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19753 respectively.  @option{--with-llsc} is the default for some
19754 configurations; see the installation documentation for details.
19756 @item -mdsp
19757 @itemx -mno-dsp
19758 @opindex mdsp
19759 @opindex mno-dsp
19760 Use (do not use) revision 1 of the MIPS DSP ASE@.
19761 @xref{MIPS DSP Built-in Functions}.  This option defines the
19762 preprocessor macro @code{__mips_dsp}.  It also defines
19763 @code{__mips_dsp_rev} to 1.
19765 @item -mdspr2
19766 @itemx -mno-dspr2
19767 @opindex mdspr2
19768 @opindex mno-dspr2
19769 Use (do not use) revision 2 of the MIPS DSP ASE@.
19770 @xref{MIPS DSP Built-in Functions}.  This option defines the
19771 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19772 It also defines @code{__mips_dsp_rev} to 2.
19774 @item -msmartmips
19775 @itemx -mno-smartmips
19776 @opindex msmartmips
19777 @opindex mno-smartmips
19778 Use (do not use) the MIPS SmartMIPS ASE.
19780 @item -mpaired-single
19781 @itemx -mno-paired-single
19782 @opindex mpaired-single
19783 @opindex mno-paired-single
19784 Use (do not use) paired-single floating-point instructions.
19785 @xref{MIPS Paired-Single Support}.  This option requires
19786 hardware floating-point support to be enabled.
19788 @item -mdmx
19789 @itemx -mno-mdmx
19790 @opindex mdmx
19791 @opindex mno-mdmx
19792 Use (do not use) MIPS Digital Media Extension instructions.
19793 This option can only be used when generating 64-bit code and requires
19794 hardware floating-point support to be enabled.
19796 @item -mips3d
19797 @itemx -mno-mips3d
19798 @opindex mips3d
19799 @opindex mno-mips3d
19800 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19801 The option @option{-mips3d} implies @option{-mpaired-single}.
19803 @item -mmicromips
19804 @itemx -mno-micromips
19805 @opindex mmicromips
19806 @opindex mno-mmicromips
19807 Generate (do not generate) microMIPS code.
19809 MicroMIPS code generation can also be controlled on a per-function basis
19810 by means of @code{micromips} and @code{nomicromips} attributes.
19811 @xref{Function Attributes}, for more information.
19813 @item -mmt
19814 @itemx -mno-mt
19815 @opindex mmt
19816 @opindex mno-mt
19817 Use (do not use) MT Multithreading instructions.
19819 @item -mmcu
19820 @itemx -mno-mcu
19821 @opindex mmcu
19822 @opindex mno-mcu
19823 Use (do not use) the MIPS MCU ASE instructions.
19825 @item -meva
19826 @itemx -mno-eva
19827 @opindex meva
19828 @opindex mno-eva
19829 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19831 @item -mvirt
19832 @itemx -mno-virt
19833 @opindex mvirt
19834 @opindex mno-virt
19835 Use (do not use) the MIPS Virtualization (VZ) instructions.
19837 @item -mxpa
19838 @itemx -mno-xpa
19839 @opindex mxpa
19840 @opindex mno-xpa
19841 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19843 @item -mlong64
19844 @opindex mlong64
19845 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19846 an explanation of the default and the way that the pointer size is
19847 determined.
19849 @item -mlong32
19850 @opindex mlong32
19851 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19853 The default size of @code{int}s, @code{long}s and pointers depends on
19854 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19855 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19856 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19857 or the same size as integer registers, whichever is smaller.
19859 @item -msym32
19860 @itemx -mno-sym32
19861 @opindex msym32
19862 @opindex mno-sym32
19863 Assume (do not assume) that all symbols have 32-bit values, regardless
19864 of the selected ABI@.  This option is useful in combination with
19865 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19866 to generate shorter and faster references to symbolic addresses.
19868 @item -G @var{num}
19869 @opindex G
19870 Put definitions of externally-visible data in a small data section
19871 if that data is no bigger than @var{num} bytes.  GCC can then generate
19872 more efficient accesses to the data; see @option{-mgpopt} for details.
19874 The default @option{-G} option depends on the configuration.
19876 @item -mlocal-sdata
19877 @itemx -mno-local-sdata
19878 @opindex mlocal-sdata
19879 @opindex mno-local-sdata
19880 Extend (do not extend) the @option{-G} behavior to local data too,
19881 such as to static variables in C@.  @option{-mlocal-sdata} is the
19882 default for all configurations.
19884 If the linker complains that an application is using too much small data,
19885 you might want to try rebuilding the less performance-critical parts with
19886 @option{-mno-local-sdata}.  You might also want to build large
19887 libraries with @option{-mno-local-sdata}, so that the libraries leave
19888 more room for the main program.
19890 @item -mextern-sdata
19891 @itemx -mno-extern-sdata
19892 @opindex mextern-sdata
19893 @opindex mno-extern-sdata
19894 Assume (do not assume) that externally-defined data is in
19895 a small data section if the size of that data is within the @option{-G} limit.
19896 @option{-mextern-sdata} is the default for all configurations.
19898 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19899 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19900 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19901 is placed in a small data section.  If @var{Var} is defined by another
19902 module, you must either compile that module with a high-enough
19903 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19904 definition.  If @var{Var} is common, you must link the application
19905 with a high-enough @option{-G} setting.
19907 The easiest way of satisfying these restrictions is to compile
19908 and link every module with the same @option{-G} option.  However,
19909 you may wish to build a library that supports several different
19910 small data limits.  You can do this by compiling the library with
19911 the highest supported @option{-G} setting and additionally using
19912 @option{-mno-extern-sdata} to stop the library from making assumptions
19913 about externally-defined data.
19915 @item -mgpopt
19916 @itemx -mno-gpopt
19917 @opindex mgpopt
19918 @opindex mno-gpopt
19919 Use (do not use) GP-relative accesses for symbols that are known to be
19920 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19921 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19922 configurations.
19924 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19925 might not hold the value of @code{_gp}.  For example, if the code is
19926 part of a library that might be used in a boot monitor, programs that
19927 call boot monitor routines pass an unknown value in @code{$gp}.
19928 (In such situations, the boot monitor itself is usually compiled
19929 with @option{-G0}.)
19931 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19932 @option{-mno-extern-sdata}.
19934 @item -membedded-data
19935 @itemx -mno-embedded-data
19936 @opindex membedded-data
19937 @opindex mno-embedded-data
19938 Allocate variables to the read-only data section first if possible, then
19939 next in the small data section if possible, otherwise in data.  This gives
19940 slightly slower code than the default, but reduces the amount of RAM required
19941 when executing, and thus may be preferred for some embedded systems.
19943 @item -muninit-const-in-rodata
19944 @itemx -mno-uninit-const-in-rodata
19945 @opindex muninit-const-in-rodata
19946 @opindex mno-uninit-const-in-rodata
19947 Put uninitialized @code{const} variables in the read-only data section.
19948 This option is only meaningful in conjunction with @option{-membedded-data}.
19950 @item -mcode-readable=@var{setting}
19951 @opindex mcode-readable
19952 Specify whether GCC may generate code that reads from executable sections.
19953 There are three possible settings:
19955 @table @gcctabopt
19956 @item -mcode-readable=yes
19957 Instructions may freely access executable sections.  This is the
19958 default setting.
19960 @item -mcode-readable=pcrel
19961 MIPS16 PC-relative load instructions can access executable sections,
19962 but other instructions must not do so.  This option is useful on 4KSc
19963 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19964 It is also useful on processors that can be configured to have a dual
19965 instruction/data SRAM interface and that, like the M4K, automatically
19966 redirect PC-relative loads to the instruction RAM.
19968 @item -mcode-readable=no
19969 Instructions must not access executable sections.  This option can be
19970 useful on targets that are configured to have a dual instruction/data
19971 SRAM interface but that (unlike the M4K) do not automatically redirect
19972 PC-relative loads to the instruction RAM.
19973 @end table
19975 @item -msplit-addresses
19976 @itemx -mno-split-addresses
19977 @opindex msplit-addresses
19978 @opindex mno-split-addresses
19979 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19980 relocation operators.  This option has been superseded by
19981 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19983 @item -mexplicit-relocs
19984 @itemx -mno-explicit-relocs
19985 @opindex mexplicit-relocs
19986 @opindex mno-explicit-relocs
19987 Use (do not use) assembler relocation operators when dealing with symbolic
19988 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19989 is to use assembler macros instead.
19991 @option{-mexplicit-relocs} is the default if GCC was configured
19992 to use an assembler that supports relocation operators.
19994 @item -mcheck-zero-division
19995 @itemx -mno-check-zero-division
19996 @opindex mcheck-zero-division
19997 @opindex mno-check-zero-division
19998 Trap (do not trap) on integer division by zero.
20000 The default is @option{-mcheck-zero-division}.
20002 @item -mdivide-traps
20003 @itemx -mdivide-breaks
20004 @opindex mdivide-traps
20005 @opindex mdivide-breaks
20006 MIPS systems check for division by zero by generating either a
20007 conditional trap or a break instruction.  Using traps results in
20008 smaller code, but is only supported on MIPS II and later.  Also, some
20009 versions of the Linux kernel have a bug that prevents trap from
20010 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20011 allow conditional traps on architectures that support them and
20012 @option{-mdivide-breaks} to force the use of breaks.
20014 The default is usually @option{-mdivide-traps}, but this can be
20015 overridden at configure time using @option{--with-divide=breaks}.
20016 Divide-by-zero checks can be completely disabled using
20017 @option{-mno-check-zero-division}.
20019 @item -mload-store-pairs
20020 @itemx -mno-load-store-pairs
20021 @opindex mload-store-pairs
20022 @opindex mno-load-store-pairs
20023 Enable (disable) an optimization that pairs consecutive load or store
20024 instructions to enable load/store bonding.  This option is enabled by
20025 default but only takes effect when the selected architecture is known
20026 to support bonding.
20028 @item -mmemcpy
20029 @itemx -mno-memcpy
20030 @opindex mmemcpy
20031 @opindex mno-memcpy
20032 Force (do not force) the use of @code{memcpy} for non-trivial block
20033 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20034 most constant-sized copies.
20036 @item -mlong-calls
20037 @itemx -mno-long-calls
20038 @opindex mlong-calls
20039 @opindex mno-long-calls
20040 Disable (do not disable) use of the @code{jal} instruction.  Calling
20041 functions using @code{jal} is more efficient but requires the caller
20042 and callee to be in the same 256 megabyte segment.
20044 This option has no effect on abicalls code.  The default is
20045 @option{-mno-long-calls}.
20047 @item -mmad
20048 @itemx -mno-mad
20049 @opindex mmad
20050 @opindex mno-mad
20051 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20052 instructions, as provided by the R4650 ISA@.
20054 @item -mimadd
20055 @itemx -mno-imadd
20056 @opindex mimadd
20057 @opindex mno-imadd
20058 Enable (disable) use of the @code{madd} and @code{msub} integer
20059 instructions.  The default is @option{-mimadd} on architectures
20060 that support @code{madd} and @code{msub} except for the 74k 
20061 architecture where it was found to generate slower code.
20063 @item -mfused-madd
20064 @itemx -mno-fused-madd
20065 @opindex mfused-madd
20066 @opindex mno-fused-madd
20067 Enable (disable) use of the floating-point multiply-accumulate
20068 instructions, when they are available.  The default is
20069 @option{-mfused-madd}.
20071 On the R8000 CPU when multiply-accumulate instructions are used,
20072 the intermediate product is calculated to infinite precision
20073 and is not subject to the FCSR Flush to Zero bit.  This may be
20074 undesirable in some circumstances.  On other processors the result
20075 is numerically identical to the equivalent computation using
20076 separate multiply, add, subtract and negate instructions.
20078 @item -nocpp
20079 @opindex nocpp
20080 Tell the MIPS assembler to not run its preprocessor over user
20081 assembler files (with a @samp{.s} suffix) when assembling them.
20083 @item -mfix-24k
20084 @item -mno-fix-24k
20085 @opindex mfix-24k
20086 @opindex mno-fix-24k
20087 Work around the 24K E48 (lost data on stores during refill) errata.
20088 The workarounds are implemented by the assembler rather than by GCC@.
20090 @item -mfix-r4000
20091 @itemx -mno-fix-r4000
20092 @opindex mfix-r4000
20093 @opindex mno-fix-r4000
20094 Work around certain R4000 CPU errata:
20095 @itemize @minus
20096 @item
20097 A double-word or a variable shift may give an incorrect result if executed
20098 immediately after starting an integer division.
20099 @item
20100 A double-word or a variable shift may give an incorrect result if executed
20101 while an integer multiplication is in progress.
20102 @item
20103 An integer division may give an incorrect result if started in a delay slot
20104 of a taken branch or a jump.
20105 @end itemize
20107 @item -mfix-r4400
20108 @itemx -mno-fix-r4400
20109 @opindex mfix-r4400
20110 @opindex mno-fix-r4400
20111 Work around certain R4400 CPU errata:
20112 @itemize @minus
20113 @item
20114 A double-word or a variable shift may give an incorrect result if executed
20115 immediately after starting an integer division.
20116 @end itemize
20118 @item -mfix-r10000
20119 @itemx -mno-fix-r10000
20120 @opindex mfix-r10000
20121 @opindex mno-fix-r10000
20122 Work around certain R10000 errata:
20123 @itemize @minus
20124 @item
20125 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20126 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20127 @end itemize
20129 This option can only be used if the target architecture supports
20130 branch-likely instructions.  @option{-mfix-r10000} is the default when
20131 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20132 otherwise.
20134 @item -mfix-rm7000
20135 @itemx -mno-fix-rm7000
20136 @opindex mfix-rm7000
20137 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20138 workarounds are implemented by the assembler rather than by GCC@.
20140 @item -mfix-vr4120
20141 @itemx -mno-fix-vr4120
20142 @opindex mfix-vr4120
20143 Work around certain VR4120 errata:
20144 @itemize @minus
20145 @item
20146 @code{dmultu} does not always produce the correct result.
20147 @item
20148 @code{div} and @code{ddiv} do not always produce the correct result if one
20149 of the operands is negative.
20150 @end itemize
20151 The workarounds for the division errata rely on special functions in
20152 @file{libgcc.a}.  At present, these functions are only provided by
20153 the @code{mips64vr*-elf} configurations.
20155 Other VR4120 errata require a NOP to be inserted between certain pairs of
20156 instructions.  These errata are handled by the assembler, not by GCC itself.
20158 @item -mfix-vr4130
20159 @opindex mfix-vr4130
20160 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20161 workarounds are implemented by the assembler rather than by GCC,
20162 although GCC avoids using @code{mflo} and @code{mfhi} if the
20163 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20164 instructions are available instead.
20166 @item -mfix-sb1
20167 @itemx -mno-fix-sb1
20168 @opindex mfix-sb1
20169 Work around certain SB-1 CPU core errata.
20170 (This flag currently works around the SB-1 revision 2
20171 ``F1'' and ``F2'' floating-point errata.)
20173 @item -mr10k-cache-barrier=@var{setting}
20174 @opindex mr10k-cache-barrier
20175 Specify whether GCC should insert cache barriers to avoid the
20176 side-effects of speculation on R10K processors.
20178 In common with many processors, the R10K tries to predict the outcome
20179 of a conditional branch and speculatively executes instructions from
20180 the ``taken'' branch.  It later aborts these instructions if the
20181 predicted outcome is wrong.  However, on the R10K, even aborted
20182 instructions can have side effects.
20184 This problem only affects kernel stores and, depending on the system,
20185 kernel loads.  As an example, a speculatively-executed store may load
20186 the target memory into cache and mark the cache line as dirty, even if
20187 the store itself is later aborted.  If a DMA operation writes to the
20188 same area of memory before the ``dirty'' line is flushed, the cached
20189 data overwrites the DMA-ed data.  See the R10K processor manual
20190 for a full description, including other potential problems.
20192 One workaround is to insert cache barrier instructions before every memory
20193 access that might be speculatively executed and that might have side
20194 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20195 controls GCC's implementation of this workaround.  It assumes that
20196 aborted accesses to any byte in the following regions does not have
20197 side effects:
20199 @enumerate
20200 @item
20201 the memory occupied by the current function's stack frame;
20203 @item
20204 the memory occupied by an incoming stack argument;
20206 @item
20207 the memory occupied by an object with a link-time-constant address.
20208 @end enumerate
20210 It is the kernel's responsibility to ensure that speculative
20211 accesses to these regions are indeed safe.
20213 If the input program contains a function declaration such as:
20215 @smallexample
20216 void foo (void);
20217 @end smallexample
20219 then the implementation of @code{foo} must allow @code{j foo} and
20220 @code{jal foo} to be executed speculatively.  GCC honors this
20221 restriction for functions it compiles itself.  It expects non-GCC
20222 functions (such as hand-written assembly code) to do the same.
20224 The option has three forms:
20226 @table @gcctabopt
20227 @item -mr10k-cache-barrier=load-store
20228 Insert a cache barrier before a load or store that might be
20229 speculatively executed and that might have side effects even
20230 if aborted.
20232 @item -mr10k-cache-barrier=store
20233 Insert a cache barrier before a store that might be speculatively
20234 executed and that might have side effects even if aborted.
20236 @item -mr10k-cache-barrier=none
20237 Disable the insertion of cache barriers.  This is the default setting.
20238 @end table
20240 @item -mflush-func=@var{func}
20241 @itemx -mno-flush-func
20242 @opindex mflush-func
20243 Specifies the function to call to flush the I and D caches, or to not
20244 call any such function.  If called, the function must take the same
20245 arguments as the common @code{_flush_func}, that is, the address of the
20246 memory range for which the cache is being flushed, the size of the
20247 memory range, and the number 3 (to flush both caches).  The default
20248 depends on the target GCC was configured for, but commonly is either
20249 @code{_flush_func} or @code{__cpu_flush}.
20251 @item mbranch-cost=@var{num}
20252 @opindex mbranch-cost
20253 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20254 This cost is only a heuristic and is not guaranteed to produce
20255 consistent results across releases.  A zero cost redundantly selects
20256 the default, which is based on the @option{-mtune} setting.
20258 @item -mbranch-likely
20259 @itemx -mno-branch-likely
20260 @opindex mbranch-likely
20261 @opindex mno-branch-likely
20262 Enable or disable use of Branch Likely instructions, regardless of the
20263 default for the selected architecture.  By default, Branch Likely
20264 instructions may be generated if they are supported by the selected
20265 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20266 and processors that implement those architectures; for those, Branch
20267 Likely instructions are not be generated by default because the MIPS32
20268 and MIPS64 architectures specifically deprecate their use.
20270 @item -mcompact-branches=never
20271 @itemx -mcompact-branches=optimal
20272 @itemx -mcompact-branches=always
20273 @opindex mcompact-branches=never
20274 @opindex mcompact-branches=optimal
20275 @opindex mcompact-branches=always
20276 These options control which form of branches will be generated.  The
20277 default is @option{-mcompact-branches=optimal}.
20279 The @option{-mcompact-branches=never} option ensures that compact branch
20280 instructions will never be generated.
20282 The @option{-mcompact-branches=always} option ensures that a compact
20283 branch instruction will be generated if available.  If a compact branch
20284 instruction is not available, a delay slot form of the branch will be
20285 used instead.
20287 This option is supported from MIPS Release 6 onwards.
20289 The @option{-mcompact-branches=optimal} option will cause a delay slot
20290 branch to be used if one is available in the current ISA and the delay
20291 slot is successfully filled.  If the delay slot is not filled, a compact
20292 branch will be chosen if one is available.
20294 @item -mfp-exceptions
20295 @itemx -mno-fp-exceptions
20296 @opindex mfp-exceptions
20297 Specifies whether FP exceptions are enabled.  This affects how
20298 FP instructions are scheduled for some processors.
20299 The default is that FP exceptions are
20300 enabled.
20302 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20303 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20304 FP pipe.
20306 @item -mvr4130-align
20307 @itemx -mno-vr4130-align
20308 @opindex mvr4130-align
20309 The VR4130 pipeline is two-way superscalar, but can only issue two
20310 instructions together if the first one is 8-byte aligned.  When this
20311 option is enabled, GCC aligns pairs of instructions that it
20312 thinks should execute in parallel.
20314 This option only has an effect when optimizing for the VR4130.
20315 It normally makes code faster, but at the expense of making it bigger.
20316 It is enabled by default at optimization level @option{-O3}.
20318 @item -msynci
20319 @itemx -mno-synci
20320 @opindex msynci
20321 Enable (disable) generation of @code{synci} instructions on
20322 architectures that support it.  The @code{synci} instructions (if
20323 enabled) are generated when @code{__builtin___clear_cache} is
20324 compiled.
20326 This option defaults to @option{-mno-synci}, but the default can be
20327 overridden by configuring GCC with @option{--with-synci}.
20329 When compiling code for single processor systems, it is generally safe
20330 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20331 does not invalidate the instruction caches on all cores and may lead
20332 to undefined behavior.
20334 @item -mrelax-pic-calls
20335 @itemx -mno-relax-pic-calls
20336 @opindex mrelax-pic-calls
20337 Try to turn PIC calls that are normally dispatched via register
20338 @code{$25} into direct calls.  This is only possible if the linker can
20339 resolve the destination at link time and if the destination is within
20340 range for a direct call.
20342 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20343 an assembler and a linker that support the @code{.reloc} assembly
20344 directive and @option{-mexplicit-relocs} is in effect.  With
20345 @option{-mno-explicit-relocs}, this optimization can be performed by the
20346 assembler and the linker alone without help from the compiler.
20348 @item -mmcount-ra-address
20349 @itemx -mno-mcount-ra-address
20350 @opindex mmcount-ra-address
20351 @opindex mno-mcount-ra-address
20352 Emit (do not emit) code that allows @code{_mcount} to modify the
20353 calling function's return address.  When enabled, this option extends
20354 the usual @code{_mcount} interface with a new @var{ra-address}
20355 parameter, which has type @code{intptr_t *} and is passed in register
20356 @code{$12}.  @code{_mcount} can then modify the return address by
20357 doing both of the following:
20358 @itemize
20359 @item
20360 Returning the new address in register @code{$31}.
20361 @item
20362 Storing the new address in @code{*@var{ra-address}},
20363 if @var{ra-address} is nonnull.
20364 @end itemize
20366 The default is @option{-mno-mcount-ra-address}.
20368 @item -mframe-header-opt
20369 @itemx -mno-frame-header-opt
20370 @opindex mframe-header-opt
20371 Enable (disable) frame header optimization in the o32 ABI.  When using the
20372 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20373 function to write out register arguments.  When enabled, this optimization
20374 will suppress the allocation of the frame header if it can be determined that
20375 it is unused.
20377 This optimization is off by default at all optimization levels.
20379 @item -mlxc1-sxc1
20380 @itemx -mno-lxc1-sxc1
20381 @opindex mlxc1-sxc1
20382 When applicable, enable (disable) the generation of @code{lwxc1},
20383 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20385 @item -mmadd4
20386 @itemx -mno-madd4
20387 @opindex mmadd4
20388 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20389 @code{madd.d} and related instructions.  Enabled by default.
20391 @end table
20393 @node MMIX Options
20394 @subsection MMIX Options
20395 @cindex MMIX Options
20397 These options are defined for the MMIX:
20399 @table @gcctabopt
20400 @item -mlibfuncs
20401 @itemx -mno-libfuncs
20402 @opindex mlibfuncs
20403 @opindex mno-libfuncs
20404 Specify that intrinsic library functions are being compiled, passing all
20405 values in registers, no matter the size.
20407 @item -mepsilon
20408 @itemx -mno-epsilon
20409 @opindex mepsilon
20410 @opindex mno-epsilon
20411 Generate floating-point comparison instructions that compare with respect
20412 to the @code{rE} epsilon register.
20414 @item -mabi=mmixware
20415 @itemx -mabi=gnu
20416 @opindex mabi=mmixware
20417 @opindex mabi=gnu
20418 Generate code that passes function parameters and return values that (in
20419 the called function) are seen as registers @code{$0} and up, as opposed to
20420 the GNU ABI which uses global registers @code{$231} and up.
20422 @item -mzero-extend
20423 @itemx -mno-zero-extend
20424 @opindex mzero-extend
20425 @opindex mno-zero-extend
20426 When reading data from memory in sizes shorter than 64 bits, use (do not
20427 use) zero-extending load instructions by default, rather than
20428 sign-extending ones.
20430 @item -mknuthdiv
20431 @itemx -mno-knuthdiv
20432 @opindex mknuthdiv
20433 @opindex mno-knuthdiv
20434 Make the result of a division yielding a remainder have the same sign as
20435 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20436 remainder follows the sign of the dividend.  Both methods are
20437 arithmetically valid, the latter being almost exclusively used.
20439 @item -mtoplevel-symbols
20440 @itemx -mno-toplevel-symbols
20441 @opindex mtoplevel-symbols
20442 @opindex mno-toplevel-symbols
20443 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20444 code can be used with the @code{PREFIX} assembly directive.
20446 @item -melf
20447 @opindex melf
20448 Generate an executable in the ELF format, rather than the default
20449 @samp{mmo} format used by the @command{mmix} simulator.
20451 @item -mbranch-predict
20452 @itemx -mno-branch-predict
20453 @opindex mbranch-predict
20454 @opindex mno-branch-predict
20455 Use (do not use) the probable-branch instructions, when static branch
20456 prediction indicates a probable branch.
20458 @item -mbase-addresses
20459 @itemx -mno-base-addresses
20460 @opindex mbase-addresses
20461 @opindex mno-base-addresses
20462 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20463 base address automatically generates a request (handled by the assembler
20464 and the linker) for a constant to be set up in a global register.  The
20465 register is used for one or more base address requests within the range 0
20466 to 255 from the value held in the register.  The generally leads to short
20467 and fast code, but the number of different data items that can be
20468 addressed is limited.  This means that a program that uses lots of static
20469 data may require @option{-mno-base-addresses}.
20471 @item -msingle-exit
20472 @itemx -mno-single-exit
20473 @opindex msingle-exit
20474 @opindex mno-single-exit
20475 Force (do not force) generated code to have a single exit point in each
20476 function.
20477 @end table
20479 @node MN10300 Options
20480 @subsection MN10300 Options
20481 @cindex MN10300 options
20483 These @option{-m} options are defined for Matsushita MN10300 architectures:
20485 @table @gcctabopt
20486 @item -mmult-bug
20487 @opindex mmult-bug
20488 Generate code to avoid bugs in the multiply instructions for the MN10300
20489 processors.  This is the default.
20491 @item -mno-mult-bug
20492 @opindex mno-mult-bug
20493 Do not generate code to avoid bugs in the multiply instructions for the
20494 MN10300 processors.
20496 @item -mam33
20497 @opindex mam33
20498 Generate code using features specific to the AM33 processor.
20500 @item -mno-am33
20501 @opindex mno-am33
20502 Do not generate code using features specific to the AM33 processor.  This
20503 is the default.
20505 @item -mam33-2
20506 @opindex mam33-2
20507 Generate code using features specific to the AM33/2.0 processor.
20509 @item -mam34
20510 @opindex mam34
20511 Generate code using features specific to the AM34 processor.
20513 @item -mtune=@var{cpu-type}
20514 @opindex mtune
20515 Use the timing characteristics of the indicated CPU type when
20516 scheduling instructions.  This does not change the targeted processor
20517 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20518 @samp{am33-2} or @samp{am34}.
20520 @item -mreturn-pointer-on-d0
20521 @opindex mreturn-pointer-on-d0
20522 When generating a function that returns a pointer, return the pointer
20523 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20524 only in @code{a0}, and attempts to call such functions without a prototype
20525 result in errors.  Note that this option is on by default; use
20526 @option{-mno-return-pointer-on-d0} to disable it.
20528 @item -mno-crt0
20529 @opindex mno-crt0
20530 Do not link in the C run-time initialization object file.
20532 @item -mrelax
20533 @opindex mrelax
20534 Indicate to the linker that it should perform a relaxation optimization pass
20535 to shorten branches, calls and absolute memory addresses.  This option only
20536 has an effect when used on the command line for the final link step.
20538 This option makes symbolic debugging impossible.
20540 @item -mliw
20541 @opindex mliw
20542 Allow the compiler to generate @emph{Long Instruction Word}
20543 instructions if the target is the @samp{AM33} or later.  This is the
20544 default.  This option defines the preprocessor macro @code{__LIW__}.
20546 @item -mnoliw
20547 @opindex mnoliw
20548 Do not allow the compiler to generate @emph{Long Instruction Word}
20549 instructions.  This option defines the preprocessor macro
20550 @code{__NO_LIW__}.
20552 @item -msetlb
20553 @opindex msetlb
20554 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20555 instructions if the target is the @samp{AM33} or later.  This is the
20556 default.  This option defines the preprocessor macro @code{__SETLB__}.
20558 @item -mnosetlb
20559 @opindex mnosetlb
20560 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20561 instructions.  This option defines the preprocessor macro
20562 @code{__NO_SETLB__}.
20564 @end table
20566 @node Moxie Options
20567 @subsection Moxie Options
20568 @cindex Moxie Options
20570 @table @gcctabopt
20572 @item -meb
20573 @opindex meb
20574 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20575 configurations.
20577 @item -mel
20578 @opindex mel
20579 Generate little-endian code.
20581 @item -mmul.x
20582 @opindex mmul.x
20583 Generate mul.x and umul.x instructions.  This is the default for
20584 @samp{moxiebox-*-*} configurations.
20586 @item -mno-crt0
20587 @opindex mno-crt0
20588 Do not link in the C run-time initialization object file.
20590 @end table
20592 @node MSP430 Options
20593 @subsection MSP430 Options
20594 @cindex MSP430 Options
20596 These options are defined for the MSP430:
20598 @table @gcctabopt
20600 @item -masm-hex
20601 @opindex masm-hex
20602 Force assembly output to always use hex constants.  Normally such
20603 constants are signed decimals, but this option is available for
20604 testsuite and/or aesthetic purposes.
20606 @item -mmcu=
20607 @opindex mmcu=
20608 Select the MCU to target.  This is used to create a C preprocessor
20609 symbol based upon the MCU name, converted to upper case and pre- and
20610 post-fixed with @samp{__}.  This in turn is used by the
20611 @file{msp430.h} header file to select an MCU-specific supplementary
20612 header file.
20614 The option also sets the ISA to use.  If the MCU name is one that is
20615 known to only support the 430 ISA then that is selected, otherwise the
20616 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20617 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20618 name selects the 430X ISA.
20620 In addition an MCU-specific linker script is added to the linker
20621 command line.  The script's name is the name of the MCU with
20622 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20623 command line defines the C preprocessor symbol @code{__XXX__} and
20624 cause the linker to search for a script called @file{xxx.ld}.
20626 This option is also passed on to the assembler.
20628 @item -mwarn-mcu
20629 @itemx -mno-warn-mcu
20630 @opindex mwarn-mcu
20631 @opindex mno-warn-mcu
20632 This option enables or disables warnings about conflicts between the
20633 MCU name specified by the @option{-mmcu} option and the ISA set by the
20634 @option{-mcpu} option and/or the hardware multiply support set by the
20635 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20636 MCU names.  This option is on by default.
20638 @item -mcpu=
20639 @opindex mcpu=
20640 Specifies the ISA to use.  Accepted values are @samp{msp430},
20641 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20642 @option{-mmcu=} option should be used to select the ISA.
20644 @item -msim
20645 @opindex msim
20646 Link to the simulator runtime libraries and linker script.  Overrides
20647 any scripts that would be selected by the @option{-mmcu=} option.
20649 @item -mlarge
20650 @opindex mlarge
20651 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20653 @item -msmall
20654 @opindex msmall
20655 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20657 @item -mrelax
20658 @opindex mrelax
20659 This option is passed to the assembler and linker, and allows the
20660 linker to perform certain optimizations that cannot be done until
20661 the final link.
20663 @item mhwmult=
20664 @opindex mhwmult=
20665 Describes the type of hardware multiply supported by the target.
20666 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20667 for the original 16-bit-only multiply supported by early MCUs.
20668 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20669 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20670 A value of @samp{auto} can also be given.  This tells GCC to deduce
20671 the hardware multiply support based upon the MCU name provided by the
20672 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20673 the MCU name is not recognized then no hardware multiply support is
20674 assumed.  @code{auto} is the default setting.
20676 Hardware multiplies are normally performed by calling a library
20677 routine.  This saves space in the generated code.  When compiling at
20678 @option{-O3} or higher however the hardware multiplier is invoked
20679 inline.  This makes for bigger, but faster code.
20681 The hardware multiply routines disable interrupts whilst running and
20682 restore the previous interrupt state when they finish.  This makes
20683 them safe to use inside interrupt handlers as well as in normal code.
20685 @item -minrt
20686 @opindex minrt
20687 Enable the use of a minimum runtime environment - no static
20688 initializers or constructors.  This is intended for memory-constrained
20689 devices.  The compiler includes special symbols in some objects
20690 that tell the linker and runtime which code fragments are required.
20692 @item -mcode-region=
20693 @itemx -mdata-region=
20694 @opindex mcode-region
20695 @opindex mdata-region
20696 These options tell the compiler where to place functions and data that
20697 do not have one of the @code{lower}, @code{upper}, @code{either} or
20698 @code{section} attributes.  Possible values are @code{lower},
20699 @code{upper}, @code{either} or @code{any}.  The first three behave
20700 like the corresponding attribute.  The fourth possible value -
20701 @code{any} - is the default.  It leaves placement entirely up to the
20702 linker script and how it assigns the standard sections
20703 (@code{.text}, @code{.data}, etc) to the memory regions.
20705 @item -msilicon-errata=
20706 @opindex msilicon-errata
20707 This option passes on a request to assembler to enable the fixes for
20708 the named silicon errata.
20710 @item -msilicon-errata-warn=
20711 @opindex msilicon-errata-warn
20712 This option passes on a request to the assembler to enable warning
20713 messages when a silicon errata might need to be applied.
20715 @end table
20717 @node NDS32 Options
20718 @subsection NDS32 Options
20719 @cindex NDS32 Options
20721 These options are defined for NDS32 implementations:
20723 @table @gcctabopt
20725 @item -mbig-endian
20726 @opindex mbig-endian
20727 Generate code in big-endian mode.
20729 @item -mlittle-endian
20730 @opindex mlittle-endian
20731 Generate code in little-endian mode.
20733 @item -mreduced-regs
20734 @opindex mreduced-regs
20735 Use reduced-set registers for register allocation.
20737 @item -mfull-regs
20738 @opindex mfull-regs
20739 Use full-set registers for register allocation.
20741 @item -mcmov
20742 @opindex mcmov
20743 Generate conditional move instructions.
20745 @item -mno-cmov
20746 @opindex mno-cmov
20747 Do not generate conditional move instructions.
20749 @item -mperf-ext
20750 @opindex mperf-ext
20751 Generate performance extension instructions.
20753 @item -mno-perf-ext
20754 @opindex mno-perf-ext
20755 Do not generate performance extension instructions.
20757 @item -mv3push
20758 @opindex mv3push
20759 Generate v3 push25/pop25 instructions.
20761 @item -mno-v3push
20762 @opindex mno-v3push
20763 Do not generate v3 push25/pop25 instructions.
20765 @item -m16-bit
20766 @opindex m16-bit
20767 Generate 16-bit instructions.
20769 @item -mno-16-bit
20770 @opindex mno-16-bit
20771 Do not generate 16-bit instructions.
20773 @item -misr-vector-size=@var{num}
20774 @opindex misr-vector-size
20775 Specify the size of each interrupt vector, which must be 4 or 16.
20777 @item -mcache-block-size=@var{num}
20778 @opindex mcache-block-size
20779 Specify the size of each cache block,
20780 which must be a power of 2 between 4 and 512.
20782 @item -march=@var{arch}
20783 @opindex march
20784 Specify the name of the target architecture.
20786 @item -mcmodel=@var{code-model}
20787 @opindex mcmodel
20788 Set the code model to one of
20789 @table @asis
20790 @item @samp{small}
20791 All the data and read-only data segments must be within 512KB addressing space.
20792 The text segment must be within 16MB addressing space.
20793 @item @samp{medium}
20794 The data segment must be within 512KB while the read-only data segment can be
20795 within 4GB addressing space.  The text segment should be still within 16MB
20796 addressing space.
20797 @item @samp{large}
20798 All the text and data segments can be within 4GB addressing space.
20799 @end table
20801 @item -mctor-dtor
20802 @opindex mctor-dtor
20803 Enable constructor/destructor feature.
20805 @item -mrelax
20806 @opindex mrelax
20807 Guide linker to relax instructions.
20809 @end table
20811 @node Nios II Options
20812 @subsection Nios II Options
20813 @cindex Nios II options
20814 @cindex Altera Nios II options
20816 These are the options defined for the Altera Nios II processor.
20818 @table @gcctabopt
20820 @item -G @var{num}
20821 @opindex G
20822 @cindex smaller data references
20823 Put global and static objects less than or equal to @var{num} bytes
20824 into the small data or BSS sections instead of the normal data or BSS
20825 sections.  The default value of @var{num} is 8.
20827 @item -mgpopt=@var{option}
20828 @item -mgpopt
20829 @itemx -mno-gpopt
20830 @opindex mgpopt
20831 @opindex mno-gpopt
20832 Generate (do not generate) GP-relative accesses.  The following 
20833 @var{option} names are recognized:
20835 @table @samp
20837 @item none
20838 Do not generate GP-relative accesses.
20840 @item local
20841 Generate GP-relative accesses for small data objects that are not 
20842 external, weak, or uninitialized common symbols.  
20843 Also use GP-relative addressing for objects that
20844 have been explicitly placed in a small data section via a @code{section}
20845 attribute.
20847 @item global
20848 As for @samp{local}, but also generate GP-relative accesses for
20849 small data objects that are external, weak, or common.  If you use this option,
20850 you must ensure that all parts of your program (including libraries) are
20851 compiled with the same @option{-G} setting.
20853 @item data
20854 Generate GP-relative accesses for all data objects in the program.  If you
20855 use this option, the entire data and BSS segments
20856 of your program must fit in 64K of memory and you must use an appropriate
20857 linker script to allocate them within the addressable range of the
20858 global pointer.
20860 @item all
20861 Generate GP-relative addresses for function pointers as well as data
20862 pointers.  If you use this option, the entire text, data, and BSS segments
20863 of your program must fit in 64K of memory and you must use an appropriate
20864 linker script to allocate them within the addressable range of the
20865 global pointer.
20867 @end table
20869 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20870 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20872 The default is @option{-mgpopt} except when @option{-fpic} or
20873 @option{-fPIC} is specified to generate position-independent code.
20874 Note that the Nios II ABI does not permit GP-relative accesses from
20875 shared libraries.
20877 You may need to specify @option{-mno-gpopt} explicitly when building
20878 programs that include large amounts of small data, including large
20879 GOT data sections.  In this case, the 16-bit offset for GP-relative
20880 addressing may not be large enough to allow access to the entire 
20881 small data section.
20883 @item -mel
20884 @itemx -meb
20885 @opindex mel
20886 @opindex meb
20887 Generate little-endian (default) or big-endian (experimental) code,
20888 respectively.
20890 @item -march=@var{arch}
20891 @opindex march
20892 This specifies the name of the target Nios II architecture.  GCC uses this
20893 name to determine what kind of instructions it can emit when generating
20894 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20896 The preprocessor macro @code{__nios2_arch__} is available to programs,
20897 with value 1 or 2, indicating the targeted ISA level.
20899 @item -mbypass-cache
20900 @itemx -mno-bypass-cache
20901 @opindex mno-bypass-cache
20902 @opindex mbypass-cache
20903 Force all load and store instructions to always bypass cache by 
20904 using I/O variants of the instructions. The default is not to
20905 bypass the cache.
20907 @item -mno-cache-volatile 
20908 @itemx -mcache-volatile       
20909 @opindex mcache-volatile 
20910 @opindex mno-cache-volatile
20911 Volatile memory access bypass the cache using the I/O variants of 
20912 the load and store instructions. The default is not to bypass the cache.
20914 @item -mno-fast-sw-div
20915 @itemx -mfast-sw-div
20916 @opindex mno-fast-sw-div
20917 @opindex mfast-sw-div
20918 Do not use table-based fast divide for small numbers. The default 
20919 is to use the fast divide at @option{-O3} and above.
20921 @item -mno-hw-mul
20922 @itemx -mhw-mul
20923 @itemx -mno-hw-mulx
20924 @itemx -mhw-mulx
20925 @itemx -mno-hw-div
20926 @itemx -mhw-div
20927 @opindex mno-hw-mul
20928 @opindex mhw-mul
20929 @opindex mno-hw-mulx
20930 @opindex mhw-mulx
20931 @opindex mno-hw-div
20932 @opindex mhw-div
20933 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20934 instructions by the compiler. The default is to emit @code{mul}
20935 and not emit @code{div} and @code{mulx}.
20937 @item -mbmx
20938 @itemx -mno-bmx
20939 @itemx -mcdx
20940 @itemx -mno-cdx
20941 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20942 CDX (code density) instructions.  Enabling these instructions also
20943 requires @option{-march=r2}.  Since these instructions are optional
20944 extensions to the R2 architecture, the default is not to emit them.
20946 @item -mcustom-@var{insn}=@var{N}
20947 @itemx -mno-custom-@var{insn}
20948 @opindex mcustom-@var{insn}
20949 @opindex mno-custom-@var{insn}
20950 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20951 custom instruction with encoding @var{N} when generating code that uses 
20952 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20953 instruction 253 for single-precision floating-point add operations instead
20954 of the default behavior of using a library call.
20956 The following values of @var{insn} are supported.  Except as otherwise
20957 noted, floating-point operations are expected to be implemented with
20958 normal IEEE 754 semantics and correspond directly to the C operators or the
20959 equivalent GCC built-in functions (@pxref{Other Builtins}).
20961 Single-precision floating point:
20962 @table @asis
20964 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20965 Binary arithmetic operations.
20967 @item @samp{fnegs}
20968 Unary negation.
20970 @item @samp{fabss}
20971 Unary absolute value.
20973 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20974 Comparison operations.
20976 @item @samp{fmins}, @samp{fmaxs}
20977 Floating-point minimum and maximum.  These instructions are only
20978 generated if @option{-ffinite-math-only} is specified.
20980 @item @samp{fsqrts}
20981 Unary square root operation.
20983 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20984 Floating-point trigonometric and exponential functions.  These instructions
20985 are only generated if @option{-funsafe-math-optimizations} is also specified.
20987 @end table
20989 Double-precision floating point:
20990 @table @asis
20992 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20993 Binary arithmetic operations.
20995 @item @samp{fnegd}
20996 Unary negation.
20998 @item @samp{fabsd}
20999 Unary absolute value.
21001 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21002 Comparison operations.
21004 @item @samp{fmind}, @samp{fmaxd}
21005 Double-precision minimum and maximum.  These instructions are only
21006 generated if @option{-ffinite-math-only} is specified.
21008 @item @samp{fsqrtd}
21009 Unary square root operation.
21011 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21012 Double-precision trigonometric and exponential functions.  These instructions
21013 are only generated if @option{-funsafe-math-optimizations} is also specified.
21015 @end table
21017 Conversions:
21018 @table @asis
21019 @item @samp{fextsd}
21020 Conversion from single precision to double precision.
21022 @item @samp{ftruncds}
21023 Conversion from double precision to single precision.
21025 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21026 Conversion from floating point to signed or unsigned integer types, with
21027 truncation towards zero.
21029 @item @samp{round}
21030 Conversion from single-precision floating point to signed integer,
21031 rounding to the nearest integer and ties away from zero.
21032 This corresponds to the @code{__builtin_lroundf} function when
21033 @option{-fno-math-errno} is used.
21035 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21036 Conversion from signed or unsigned integer types to floating-point types.
21038 @end table
21040 In addition, all of the following transfer instructions for internal
21041 registers X and Y must be provided to use any of the double-precision
21042 floating-point instructions.  Custom instructions taking two
21043 double-precision source operands expect the first operand in the
21044 64-bit register X.  The other operand (or only operand of a unary
21045 operation) is given to the custom arithmetic instruction with the
21046 least significant half in source register @var{src1} and the most
21047 significant half in @var{src2}.  A custom instruction that returns a
21048 double-precision result returns the most significant 32 bits in the
21049 destination register and the other half in 32-bit register Y.  
21050 GCC automatically generates the necessary code sequences to write
21051 register X and/or read register Y when double-precision floating-point
21052 instructions are used.
21054 @table @asis
21056 @item @samp{fwrx}
21057 Write @var{src1} into the least significant half of X and @var{src2} into
21058 the most significant half of X.
21060 @item @samp{fwry}
21061 Write @var{src1} into Y.
21063 @item @samp{frdxhi}, @samp{frdxlo}
21064 Read the most or least (respectively) significant half of X and store it in
21065 @var{dest}.
21067 @item @samp{frdy}
21068 Read the value of Y and store it into @var{dest}.
21069 @end table
21071 Note that you can gain more local control over generation of Nios II custom
21072 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21073 and @code{target("no-custom-@var{insn}")} function attributes
21074 (@pxref{Function Attributes})
21075 or pragmas (@pxref{Function Specific Option Pragmas}).
21077 @item -mcustom-fpu-cfg=@var{name}
21078 @opindex mcustom-fpu-cfg
21080 This option enables a predefined, named set of custom instruction encodings
21081 (see @option{-mcustom-@var{insn}} above).  
21082 Currently, the following sets are defined:
21084 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21085 @gccoptlist{-mcustom-fmuls=252 @gol
21086 -mcustom-fadds=253 @gol
21087 -mcustom-fsubs=254 @gol
21088 -fsingle-precision-constant}
21090 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21091 @gccoptlist{-mcustom-fmuls=252 @gol
21092 -mcustom-fadds=253 @gol
21093 -mcustom-fsubs=254 @gol
21094 -mcustom-fdivs=255 @gol
21095 -fsingle-precision-constant}
21097 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21098 @gccoptlist{-mcustom-floatus=243 @gol
21099 -mcustom-fixsi=244 @gol
21100 -mcustom-floatis=245 @gol
21101 -mcustom-fcmpgts=246 @gol
21102 -mcustom-fcmples=249 @gol
21103 -mcustom-fcmpeqs=250 @gol
21104 -mcustom-fcmpnes=251 @gol
21105 -mcustom-fmuls=252 @gol
21106 -mcustom-fadds=253 @gol
21107 -mcustom-fsubs=254 @gol
21108 -mcustom-fdivs=255 @gol
21109 -fsingle-precision-constant}
21111 Custom instruction assignments given by individual
21112 @option{-mcustom-@var{insn}=} options override those given by
21113 @option{-mcustom-fpu-cfg=}, regardless of the
21114 order of the options on the command line.
21116 Note that you can gain more local control over selection of a FPU
21117 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21118 function attribute (@pxref{Function Attributes})
21119 or pragma (@pxref{Function Specific Option Pragmas}).
21121 @end table
21123 These additional @samp{-m} options are available for the Altera Nios II
21124 ELF (bare-metal) target:
21126 @table @gcctabopt
21128 @item -mhal
21129 @opindex mhal
21130 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21131 startup and termination code, and is typically used in conjunction with
21132 @option{-msys-crt0=} to specify the location of the alternate startup code
21133 provided by the HAL BSP.
21135 @item -msmallc
21136 @opindex msmallc
21137 Link with a limited version of the C library, @option{-lsmallc}, rather than
21138 Newlib.
21140 @item -msys-crt0=@var{startfile}
21141 @opindex msys-crt0
21142 @var{startfile} is the file name of the startfile (crt0) to use 
21143 when linking.  This option is only useful in conjunction with @option{-mhal}.
21145 @item -msys-lib=@var{systemlib}
21146 @opindex msys-lib
21147 @var{systemlib} is the library name of the library that provides
21148 low-level system calls required by the C library,
21149 e.g. @code{read} and @code{write}.
21150 This option is typically used to link with a library provided by a HAL BSP.
21152 @end table
21154 @node Nvidia PTX Options
21155 @subsection Nvidia PTX Options
21156 @cindex Nvidia PTX options
21157 @cindex nvptx options
21159 These options are defined for Nvidia PTX:
21161 @table @gcctabopt
21163 @item -m32
21164 @itemx -m64
21165 @opindex m32
21166 @opindex m64
21167 Generate code for 32-bit or 64-bit ABI.
21169 @item -mmainkernel
21170 @opindex mmainkernel
21171 Link in code for a __main kernel.  This is for stand-alone instead of
21172 offloading execution.
21174 @item -moptimize
21175 @opindex moptimize
21176 Apply partitioned execution optimizations.  This is the default when any
21177 level of optimization is selected.
21179 @item -msoft-stack
21180 @opindex msoft-stack
21181 Generate code that does not use @code{.local} memory
21182 directly for stack storage. Instead, a per-warp stack pointer is
21183 maintained explicitly. This enables variable-length stack allocation (with
21184 variable-length arrays or @code{alloca}), and when global memory is used for
21185 underlying storage, makes it possible to access automatic variables from other
21186 threads, or with atomic instructions. This code generation variant is used
21187 for OpenMP offloading, but the option is exposed on its own for the purpose
21188 of testing the compiler; to generate code suitable for linking into programs
21189 using OpenMP offloading, use option @option{-mgomp}.
21191 @item -muniform-simt
21192 @opindex muniform-simt
21193 Switch to code generation variant that allows to execute all threads in each
21194 warp, while maintaining memory state and side effects as if only one thread
21195 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21196 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21197 current lane index equals the master lane index), and the register being
21198 assigned is copied via a shuffle instruction from the master lane.  Outside of
21199 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21200 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21201 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21202 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21203 with current lane index to compute the master lane index.
21205 @item -mgomp
21206 @opindex mgomp
21207 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21208 @option{-muniform-simt} options, and selects corresponding multilib variant.
21210 @end table
21212 @node PDP-11 Options
21213 @subsection PDP-11 Options
21214 @cindex PDP-11 Options
21216 These options are defined for the PDP-11:
21218 @table @gcctabopt
21219 @item -mfpu
21220 @opindex mfpu
21221 Use hardware FPP floating point.  This is the default.  (FIS floating
21222 point on the PDP-11/40 is not supported.)
21224 @item -msoft-float
21225 @opindex msoft-float
21226 Do not use hardware floating point.
21228 @item -mac0
21229 @opindex mac0
21230 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21232 @item -mno-ac0
21233 @opindex mno-ac0
21234 Return floating-point results in memory.  This is the default.
21236 @item -m40
21237 @opindex m40
21238 Generate code for a PDP-11/40.
21240 @item -m45
21241 @opindex m45
21242 Generate code for a PDP-11/45.  This is the default.
21244 @item -m10
21245 @opindex m10
21246 Generate code for a PDP-11/10.
21248 @item -mbcopy-builtin
21249 @opindex mbcopy-builtin
21250 Use inline @code{movmemhi} patterns for copying memory.  This is the
21251 default.
21253 @item -mbcopy
21254 @opindex mbcopy
21255 Do not use inline @code{movmemhi} patterns for copying memory.
21257 @item -mint16
21258 @itemx -mno-int32
21259 @opindex mint16
21260 @opindex mno-int32
21261 Use 16-bit @code{int}.  This is the default.
21263 @item -mint32
21264 @itemx -mno-int16
21265 @opindex mint32
21266 @opindex mno-int16
21267 Use 32-bit @code{int}.
21269 @item -mfloat64
21270 @itemx -mno-float32
21271 @opindex mfloat64
21272 @opindex mno-float32
21273 Use 64-bit @code{float}.  This is the default.
21275 @item -mfloat32
21276 @itemx -mno-float64
21277 @opindex mfloat32
21278 @opindex mno-float64
21279 Use 32-bit @code{float}.
21281 @item -mabshi
21282 @opindex mabshi
21283 Use @code{abshi2} pattern.  This is the default.
21285 @item -mno-abshi
21286 @opindex mno-abshi
21287 Do not use @code{abshi2} pattern.
21289 @item -mbranch-expensive
21290 @opindex mbranch-expensive
21291 Pretend that branches are expensive.  This is for experimenting with
21292 code generation only.
21294 @item -mbranch-cheap
21295 @opindex mbranch-cheap
21296 Do not pretend that branches are expensive.  This is the default.
21298 @item -munix-asm
21299 @opindex munix-asm
21300 Use Unix assembler syntax.  This is the default when configured for
21301 @samp{pdp11-*-bsd}.
21303 @item -mdec-asm
21304 @opindex mdec-asm
21305 Use DEC assembler syntax.  This is the default when configured for any
21306 PDP-11 target other than @samp{pdp11-*-bsd}.
21307 @end table
21309 @node picoChip Options
21310 @subsection picoChip Options
21311 @cindex picoChip options
21313 These @samp{-m} options are defined for picoChip implementations:
21315 @table @gcctabopt
21317 @item -mae=@var{ae_type}
21318 @opindex mcpu
21319 Set the instruction set, register set, and instruction scheduling
21320 parameters for array element type @var{ae_type}.  Supported values
21321 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21323 @option{-mae=ANY} selects a completely generic AE type.  Code
21324 generated with this option runs on any of the other AE types.  The
21325 code is not as efficient as it would be if compiled for a specific
21326 AE type, and some types of operation (e.g., multiplication) do not
21327 work properly on all types of AE.
21329 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21330 for compiled code, and is the default.
21332 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21333 option may suffer from poor performance of byte (char) manipulation,
21334 since the DSP AE does not provide hardware support for byte load/stores.
21336 @item -msymbol-as-address
21337 Enable the compiler to directly use a symbol name as an address in a
21338 load/store instruction, without first loading it into a
21339 register.  Typically, the use of this option generates larger
21340 programs, which run faster than when the option isn't used.  However, the
21341 results vary from program to program, so it is left as a user option,
21342 rather than being permanently enabled.
21344 @item -mno-inefficient-warnings
21345 Disables warnings about the generation of inefficient code.  These
21346 warnings can be generated, for example, when compiling code that
21347 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21348 no hardware support for byte-level memory operations, so all byte
21349 load/stores must be synthesized from word load/store operations.  This is
21350 inefficient and a warning is generated to indicate
21351 that you should rewrite the code to avoid byte operations, or to target
21352 an AE type that has the necessary hardware support.  This option disables
21353 these warnings.
21355 @end table
21357 @node PowerPC Options
21358 @subsection PowerPC Options
21359 @cindex PowerPC options
21361 These are listed under @xref{RS/6000 and PowerPC Options}.
21363 @node RISC-V Options
21364 @subsection RISC-V Options
21365 @cindex RISC-V Options
21367 These command-line options are defined for RISC-V targets:
21369 @table @gcctabopt
21370 @item -mbranch-cost=@var{n}
21371 @opindex mbranch-cost
21372 Set the cost of branches to roughly @var{n} instructions.
21374 @item -mmemcpy
21375 @itemx -mno-memcpy
21376 @opindex mmemcpy
21377 Don't optimize block moves.
21379 @item -mplt
21380 @itemx -mno-plt
21381 @opindex plt
21382 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21384 @item -mabi=@var{ABI-string}
21385 @opindex mabi
21386 Specify integer and floating-point calling convention.  This defaults to the
21387 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21388 RV64G.
21390 @item -mfdiv
21391 @itemx -mno-fdiv
21392 @opindex mfdiv
21393 Use hardware floating-point divide and square root instructions.  This requires
21394 the F or D extensions for floating-point registers.
21396 @item -mdiv
21397 @itemx -mno-div
21398 @opindex mdiv
21399 Use hardware instructions for integer division.  This requires the M extension.
21401 @item -march=@var{ISA-string}
21402 @opindex march
21403 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21404 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21406 @item -mtune=@var{processor-string}
21407 @opindex mtune
21408 Optimize the output for the given processor, specified by microarchitecture
21409 name.
21411 @item -msmall-data-limit=@var{n}
21412 @opindex msmall-data-limit
21413 Put global and static data smaller than @var{n} bytes into a special section
21414 (on some targets).
21416 @item -msave-restore
21417 @itemx -mno-save-restore
21418 @opindex msave-restore
21419 Use smaller but slower prologue and epilogue code.
21421 @item -mstrict-align
21422 @itemx -mno-strict-align
21423 @opindex mstrict-align
21424 Do not generate unaligned memory accesses.
21426 @item -mcmodel=@var{code-model}
21427 @opindex mcmodel
21428 Specify the code model.
21430 @end table
21432 @node RL78 Options
21433 @subsection RL78 Options
21434 @cindex RL78 Options
21436 @table @gcctabopt
21438 @item -msim
21439 @opindex msim
21440 Links in additional target libraries to support operation within a
21441 simulator.
21443 @item -mmul=none
21444 @itemx -mmul=g10
21445 @itemx -mmul=g13
21446 @itemx -mmul=g14
21447 @itemx -mmul=rl78
21448 @opindex mmul
21449 Specifies the type of hardware multiplication and division support to
21450 be used.  The simplest is @code{none}, which uses software for both
21451 multiplication and division.  This is the default.  The @code{g13}
21452 value is for the hardware multiply/divide peripheral found on the
21453 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21454 the multiplication and division instructions supported by the RL78/G14
21455 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21456 the value @code{mg10} is an alias for @code{none}.
21458 In addition a C preprocessor macro is defined, based upon the setting
21459 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21460 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21462 @item -mcpu=g10
21463 @itemx -mcpu=g13
21464 @itemx -mcpu=g14
21465 @itemx -mcpu=rl78
21466 @opindex mcpu
21467 Specifies the RL78 core to target.  The default is the G14 core, also
21468 known as an S3 core or just RL78.  The G13 or S2 core does not have
21469 multiply or divide instructions, instead it uses a hardware peripheral
21470 for these operations.  The G10 or S1 core does not have register
21471 banks, so it uses a different calling convention.
21473 If this option is set it also selects the type of hardware multiply
21474 support to use, unless this is overridden by an explicit
21475 @option{-mmul=none} option on the command line.  Thus specifying
21476 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21477 peripheral and specifying @option{-mcpu=g10} disables the use of
21478 hardware multiplications altogether.
21480 Note, although the RL78/G14 core is the default target, specifying
21481 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21482 change the behavior of the toolchain since it also enables G14
21483 hardware multiply support.  If these options are not specified on the
21484 command line then software multiplication routines will be used even
21485 though the code targets the RL78 core.  This is for backwards
21486 compatibility with older toolchains which did not have hardware
21487 multiply and divide support.
21489 In addition a C preprocessor macro is defined, based upon the setting
21490 of this option.  Possible values are: @code{__RL78_G10__},
21491 @code{__RL78_G13__} or @code{__RL78_G14__}.
21493 @item -mg10
21494 @itemx -mg13
21495 @itemx -mg14
21496 @itemx -mrl78
21497 @opindex mg10
21498 @opindex mg13
21499 @opindex mg14
21500 @opindex mrl78
21501 These are aliases for the corresponding @option{-mcpu=} option.  They
21502 are provided for backwards compatibility.
21504 @item -mallregs
21505 @opindex mallregs
21506 Allow the compiler to use all of the available registers.  By default
21507 registers @code{r24..r31} are reserved for use in interrupt handlers.
21508 With this option enabled these registers can be used in ordinary
21509 functions as well.
21511 @item -m64bit-doubles
21512 @itemx -m32bit-doubles
21513 @opindex m64bit-doubles
21514 @opindex m32bit-doubles
21515 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21516 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21517 @option{-m32bit-doubles}.
21519 @item -msave-mduc-in-interrupts
21520 @item -mno-save-mduc-in-interrupts
21521 @opindex msave-mduc-in-interrupts
21522 @opindex mno-save-mduc-in-interrupts
21523 Specifies that interrupt handler functions should preserve the
21524 MDUC registers.  This is only necessary if normal code might use
21525 the MDUC registers, for example because it performs multiplication
21526 and division operations.  The default is to ignore the MDUC registers
21527 as this makes the interrupt handlers faster.  The target option -mg13
21528 needs to be passed for this to work as this feature is only available
21529 on the G13 target (S2 core).  The MDUC registers will only be saved
21530 if the interrupt handler performs a multiplication or division
21531 operation or it calls another function.
21533 @end table
21535 @node RS/6000 and PowerPC Options
21536 @subsection IBM RS/6000 and PowerPC Options
21537 @cindex RS/6000 and PowerPC Options
21538 @cindex IBM RS/6000 and PowerPC Options
21540 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21541 @table @gcctabopt
21542 @item -mpowerpc-gpopt
21543 @itemx -mno-powerpc-gpopt
21544 @itemx -mpowerpc-gfxopt
21545 @itemx -mno-powerpc-gfxopt
21546 @need 800
21547 @itemx -mpowerpc64
21548 @itemx -mno-powerpc64
21549 @itemx -mmfcrf
21550 @itemx -mno-mfcrf
21551 @itemx -mpopcntb
21552 @itemx -mno-popcntb
21553 @itemx -mpopcntd
21554 @itemx -mno-popcntd
21555 @itemx -mfprnd
21556 @itemx -mno-fprnd
21557 @need 800
21558 @itemx -mcmpb
21559 @itemx -mno-cmpb
21560 @itemx -mmfpgpr
21561 @itemx -mno-mfpgpr
21562 @itemx -mhard-dfp
21563 @itemx -mno-hard-dfp
21564 @opindex mpowerpc-gpopt
21565 @opindex mno-powerpc-gpopt
21566 @opindex mpowerpc-gfxopt
21567 @opindex mno-powerpc-gfxopt
21568 @opindex mpowerpc64
21569 @opindex mno-powerpc64
21570 @opindex mmfcrf
21571 @opindex mno-mfcrf
21572 @opindex mpopcntb
21573 @opindex mno-popcntb
21574 @opindex mpopcntd
21575 @opindex mno-popcntd
21576 @opindex mfprnd
21577 @opindex mno-fprnd
21578 @opindex mcmpb
21579 @opindex mno-cmpb
21580 @opindex mmfpgpr
21581 @opindex mno-mfpgpr
21582 @opindex mhard-dfp
21583 @opindex mno-hard-dfp
21584 You use these options to specify which instructions are available on the
21585 processor you are using.  The default value of these options is
21586 determined when configuring GCC@.  Specifying the
21587 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21588 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21589 rather than the options listed above.
21591 Specifying @option{-mpowerpc-gpopt} allows
21592 GCC to use the optional PowerPC architecture instructions in the
21593 General Purpose group, including floating-point square root.  Specifying
21594 @option{-mpowerpc-gfxopt} allows GCC to
21595 use the optional PowerPC architecture instructions in the Graphics
21596 group, including floating-point select.
21598 The @option{-mmfcrf} option allows GCC to generate the move from
21599 condition register field instruction implemented on the POWER4
21600 processor and other processors that support the PowerPC V2.01
21601 architecture.
21602 The @option{-mpopcntb} option allows GCC to generate the popcount and
21603 double-precision FP reciprocal estimate instruction implemented on the
21604 POWER5 processor and other processors that support the PowerPC V2.02
21605 architecture.
21606 The @option{-mpopcntd} option allows GCC to generate the popcount
21607 instruction implemented on the POWER7 processor and other processors
21608 that support the PowerPC V2.06 architecture.
21609 The @option{-mfprnd} option allows GCC to generate the FP round to
21610 integer instructions implemented on the POWER5+ processor and other
21611 processors that support the PowerPC V2.03 architecture.
21612 The @option{-mcmpb} option allows GCC to generate the compare bytes
21613 instruction implemented on the POWER6 processor and other processors
21614 that support the PowerPC V2.05 architecture.
21615 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21616 general-purpose register instructions implemented on the POWER6X
21617 processor and other processors that support the extended PowerPC V2.05
21618 architecture.
21619 The @option{-mhard-dfp} option allows GCC to generate the decimal
21620 floating-point instructions implemented on some POWER processors.
21622 The @option{-mpowerpc64} option allows GCC to generate the additional
21623 64-bit instructions that are found in the full PowerPC64 architecture
21624 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21625 @option{-mno-powerpc64}.
21627 @item -mcpu=@var{cpu_type}
21628 @opindex mcpu
21629 Set architecture type, register usage, and
21630 instruction scheduling parameters for machine type @var{cpu_type}.
21631 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21632 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21633 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21634 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21635 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21636 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21637 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21638 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21639 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21640 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21641 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21642 and @samp{rs64}.
21644 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21645 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21646 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21647 architecture machine types, with an appropriate, generic processor
21648 model assumed for scheduling purposes.
21650 The other options specify a specific processor.  Code generated under
21651 those options runs best on that processor, and may not run at all on
21652 others.
21654 The @option{-mcpu} options automatically enable or disable the
21655 following options:
21657 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21658 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21659 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21660 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21661 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21662 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21664 The particular options set for any particular CPU varies between
21665 compiler versions, depending on what setting seems to produce optimal
21666 code for that CPU; it doesn't necessarily reflect the actual hardware's
21667 capabilities.  If you wish to set an individual option to a particular
21668 value, you may specify it after the @option{-mcpu} option, like
21669 @option{-mcpu=970 -mno-altivec}.
21671 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21672 not enabled or disabled by the @option{-mcpu} option at present because
21673 AIX does not have full support for these options.  You may still
21674 enable or disable them individually if you're sure it'll work in your
21675 environment.
21677 @item -mtune=@var{cpu_type}
21678 @opindex mtune
21679 Set the instruction scheduling parameters for machine type
21680 @var{cpu_type}, but do not set the architecture type or register usage,
21681 as @option{-mcpu=@var{cpu_type}} does.  The same
21682 values for @var{cpu_type} are used for @option{-mtune} as for
21683 @option{-mcpu}.  If both are specified, the code generated uses the
21684 architecture and registers set by @option{-mcpu}, but the
21685 scheduling parameters set by @option{-mtune}.
21687 @item -mcmodel=small
21688 @opindex mcmodel=small
21689 Generate PowerPC64 code for the small model: The TOC is limited to
21690 64k.
21692 @item -mcmodel=medium
21693 @opindex mcmodel=medium
21694 Generate PowerPC64 code for the medium model: The TOC and other static
21695 data may be up to a total of 4G in size.  This is the default for 64-bit
21696 Linux.
21698 @item -mcmodel=large
21699 @opindex mcmodel=large
21700 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21701 in size.  Other data and code is only limited by the 64-bit address
21702 space.
21704 @item -maltivec
21705 @itemx -mno-altivec
21706 @opindex maltivec
21707 @opindex mno-altivec
21708 Generate code that uses (does not use) AltiVec instructions, and also
21709 enable the use of built-in functions that allow more direct access to
21710 the AltiVec instruction set.  You may also need to set
21711 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21712 enhancements.
21714 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21715 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21716 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21717 match array element order corresponding to the endianness of the
21718 target.  That is, element zero identifies the leftmost element in a
21719 vector register when targeting a big-endian platform, and identifies
21720 the rightmost element in a vector register when targeting a
21721 little-endian platform.
21723 @item -maltivec=be
21724 @opindex maltivec=be
21725 Generate AltiVec instructions using big-endian element order,
21726 regardless of whether the target is big- or little-endian.  This is
21727 the default when targeting a big-endian platform.
21729 The element order is used to interpret element numbers in AltiVec
21730 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21731 @code{vec_insert}.  By default, these match array element order
21732 corresponding to the endianness for the target.
21734 @item -maltivec=le
21735 @opindex maltivec=le
21736 Generate AltiVec instructions using little-endian element order,
21737 regardless of whether the target is big- or little-endian.  This is
21738 the default when targeting a little-endian platform.  This option is
21739 currently ignored when targeting a big-endian platform.
21741 The element order is used to interpret element numbers in AltiVec
21742 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21743 @code{vec_insert}.  By default, these match array element order
21744 corresponding to the endianness for the target.
21746 @item -mvrsave
21747 @itemx -mno-vrsave
21748 @opindex mvrsave
21749 @opindex mno-vrsave
21750 Generate VRSAVE instructions when generating AltiVec code.
21752 @item -msecure-plt
21753 @opindex msecure-plt
21754 Generate code that allows @command{ld} and @command{ld.so}
21755 to build executables and shared
21756 libraries with non-executable @code{.plt} and @code{.got} sections.
21757 This is a PowerPC
21758 32-bit SYSV ABI option.
21760 @item -mbss-plt
21761 @opindex mbss-plt
21762 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21763 fills in, and
21764 requires @code{.plt} and @code{.got}
21765 sections that are both writable and executable.
21766 This is a PowerPC 32-bit SYSV ABI option.
21768 @item -misel
21769 @itemx -mno-isel
21770 @opindex misel
21771 @opindex mno-isel
21772 This switch enables or disables the generation of ISEL instructions.
21774 @item -misel=@var{yes/no}
21775 This switch has been deprecated.  Use @option{-misel} and
21776 @option{-mno-isel} instead.
21778 @item -mlra
21779 @opindex mlra
21780 Enable Local Register Allocation. By default the port uses LRA.
21781 (i.e. @option{-mno-lra}).
21783 @item -mspe
21784 @itemx -mno-spe
21785 @opindex mspe
21786 @opindex mno-spe
21787 This switch enables or disables the generation of SPE simd
21788 instructions.
21790 @item -mpaired
21791 @itemx -mno-paired
21792 @opindex mpaired
21793 @opindex mno-paired
21794 This switch enables or disables the generation of PAIRED simd
21795 instructions.
21797 @item -mspe=@var{yes/no}
21798 This option has been deprecated.  Use @option{-mspe} and
21799 @option{-mno-spe} instead.
21801 @item -mvsx
21802 @itemx -mno-vsx
21803 @opindex mvsx
21804 @opindex mno-vsx
21805 Generate code that uses (does not use) vector/scalar (VSX)
21806 instructions, and also enable the use of built-in functions that allow
21807 more direct access to the VSX instruction set.
21809 @item -mcrypto
21810 @itemx -mno-crypto
21811 @opindex mcrypto
21812 @opindex mno-crypto
21813 Enable the use (disable) of the built-in functions that allow direct
21814 access to the cryptographic instructions that were added in version
21815 2.07 of the PowerPC ISA.
21817 @item -mdirect-move
21818 @itemx -mno-direct-move
21819 @opindex mdirect-move
21820 @opindex mno-direct-move
21821 Generate code that uses (does not use) the instructions to move data
21822 between the general purpose registers and the vector/scalar (VSX)
21823 registers that were added in version 2.07 of the PowerPC ISA.
21825 @item -mhtm
21826 @itemx -mno-htm
21827 @opindex mhtm
21828 @opindex mno-htm
21829 Enable (disable) the use of the built-in functions that allow direct
21830 access to the Hardware Transactional Memory (HTM) instructions that
21831 were added in version 2.07 of the PowerPC ISA.
21833 @item -mpower8-fusion
21834 @itemx -mno-power8-fusion
21835 @opindex mpower8-fusion
21836 @opindex mno-power8-fusion
21837 Generate code that keeps (does not keeps) some integer operations
21838 adjacent so that the instructions can be fused together on power8 and
21839 later processors.
21841 @item -mpower8-vector
21842 @itemx -mno-power8-vector
21843 @opindex mpower8-vector
21844 @opindex mno-power8-vector
21845 Generate code that uses (does not use) the vector and scalar
21846 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21847 enable the use of built-in functions that allow more direct access to
21848 the vector instructions.
21850 @item -mquad-memory
21851 @itemx -mno-quad-memory
21852 @opindex mquad-memory
21853 @opindex mno-quad-memory
21854 Generate code that uses (does not use) the non-atomic quad word memory
21855 instructions.  The @option{-mquad-memory} option requires use of
21856 64-bit mode.
21858 @item -mquad-memory-atomic
21859 @itemx -mno-quad-memory-atomic
21860 @opindex mquad-memory-atomic
21861 @opindex mno-quad-memory-atomic
21862 Generate code that uses (does not use) the atomic quad word memory
21863 instructions.  The @option{-mquad-memory-atomic} option requires use of
21864 64-bit mode.
21866 @item -mupper-regs-di
21867 @itemx -mno-upper-regs-di
21868 @opindex mupper-regs-di
21869 @opindex mno-upper-regs-di
21870 Generate code that uses (does not use) the scalar instructions that
21871 target all 64 registers in the vector/scalar floating point register
21872 set that were added in version 2.06 of the PowerPC ISA when processing
21873 integers.  @option{-mupper-regs-di} is turned on by default if you use
21874 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21875 @option{-mcpu=power9}, or @option{-mvsx} options.
21877 @item -mupper-regs-df
21878 @itemx -mno-upper-regs-df
21879 @opindex mupper-regs-df
21880 @opindex mno-upper-regs-df
21881 Generate code that uses (does not use) the scalar double precision
21882 instructions that target all 64 registers in the vector/scalar
21883 floating point register set that were added in version 2.06 of the
21884 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21885 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21886 @option{-mcpu=power9}, or @option{-mvsx} options.
21888 @item -mupper-regs-sf
21889 @itemx -mno-upper-regs-sf
21890 @opindex mupper-regs-sf
21891 @opindex mno-upper-regs-sf
21892 Generate code that uses (does not use) the scalar single precision
21893 instructions that target all 64 registers in the vector/scalar
21894 floating point register set that were added in version 2.07 of the
21895 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21896 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21897 @option{-mcpu=power9} options.
21899 @item -mupper-regs
21900 @itemx -mno-upper-regs
21901 @opindex mupper-regs
21902 @opindex mno-upper-regs
21903 Generate code that uses (does not use) the scalar
21904 instructions that target all 64 registers in the vector/scalar
21905 floating point register set, depending on the model of the machine.
21907 If the @option{-mno-upper-regs} option is used, it turns off both
21908 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21910 @item -mfloat128
21911 @itemx -mno-float128
21912 @opindex mfloat128
21913 @opindex mno-float128
21914 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21915 and use either software emulation for IEEE 128-bit floating point or
21916 hardware instructions.
21918 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21919 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21920 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21921 Linux systems.
21923 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21924 @option{-mfloat128} option will also enable the generation of ISA 3.0
21925 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21926 floating point will be done with software emulation.
21928 @item -mfloat128-hardware
21929 @itemx -mno-float128-hardware
21930 @opindex mfloat128-hardware
21931 @opindex mno-float128-hardware
21932 Enable/disable using ISA 3.0 hardware instructions to support the
21933 @var{__float128} data type.
21935 If you use @option{-mfloat128-hardware}, it will enable the option
21936 @option{-mfloat128} as well.
21938 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21939 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21940 the IEEE 128-bit floating point support will not be enabled.
21942 @item -mfloat-gprs=@var{yes/single/double/no}
21943 @itemx -mfloat-gprs
21944 @opindex mfloat-gprs
21945 This switch enables or disables the generation of floating-point
21946 operations on the general-purpose registers for architectures that
21947 support it.
21949 The argument @samp{yes} or @samp{single} enables the use of
21950 single-precision floating-point operations.
21952 The argument @samp{double} enables the use of single and
21953 double-precision floating-point operations.
21955 The argument @samp{no} disables floating-point operations on the
21956 general-purpose registers.
21958 This option is currently only available on the MPC854x.
21960 @item -m32
21961 @itemx -m64
21962 @opindex m32
21963 @opindex m64
21964 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21965 targets (including GNU/Linux).  The 32-bit environment sets int, long
21966 and pointer to 32 bits and generates code that runs on any PowerPC
21967 variant.  The 64-bit environment sets int to 32 bits and long and
21968 pointer to 64 bits, and generates code for PowerPC64, as for
21969 @option{-mpowerpc64}.
21971 @item -mfull-toc
21972 @itemx -mno-fp-in-toc
21973 @itemx -mno-sum-in-toc
21974 @itemx -mminimal-toc
21975 @opindex mfull-toc
21976 @opindex mno-fp-in-toc
21977 @opindex mno-sum-in-toc
21978 @opindex mminimal-toc
21979 Modify generation of the TOC (Table Of Contents), which is created for
21980 every executable file.  The @option{-mfull-toc} option is selected by
21981 default.  In that case, GCC allocates at least one TOC entry for
21982 each unique non-automatic variable reference in your program.  GCC
21983 also places floating-point constants in the TOC@.  However, only
21984 16,384 entries are available in the TOC@.
21986 If you receive a linker error message that saying you have overflowed
21987 the available TOC space, you can reduce the amount of TOC space used
21988 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21989 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21990 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21991 generate code to calculate the sum of an address and a constant at
21992 run time instead of putting that sum into the TOC@.  You may specify one
21993 or both of these options.  Each causes GCC to produce very slightly
21994 slower and larger code at the expense of conserving TOC space.
21996 If you still run out of space in the TOC even when you specify both of
21997 these options, specify @option{-mminimal-toc} instead.  This option causes
21998 GCC to make only one TOC entry for every file.  When you specify this
21999 option, GCC produces code that is slower and larger but which
22000 uses extremely little TOC space.  You may wish to use this option
22001 only on files that contain less frequently-executed code.
22003 @item -maix64
22004 @itemx -maix32
22005 @opindex maix64
22006 @opindex maix32
22007 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22008 @code{long} type, and the infrastructure needed to support them.
22009 Specifying @option{-maix64} implies @option{-mpowerpc64},
22010 while @option{-maix32} disables the 64-bit ABI and
22011 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22013 @item -mxl-compat
22014 @itemx -mno-xl-compat
22015 @opindex mxl-compat
22016 @opindex mno-xl-compat
22017 Produce code that conforms more closely to IBM XL compiler semantics
22018 when using AIX-compatible ABI@.  Pass floating-point arguments to
22019 prototyped functions beyond the register save area (RSA) on the stack
22020 in addition to argument FPRs.  Do not assume that most significant
22021 double in 128-bit long double value is properly rounded when comparing
22022 values and converting to double.  Use XL symbol names for long double
22023 support routines.
22025 The AIX calling convention was extended but not initially documented to
22026 handle an obscure K&R C case of calling a function that takes the
22027 address of its arguments with fewer arguments than declared.  IBM XL
22028 compilers access floating-point arguments that do not fit in the
22029 RSA from the stack when a subroutine is compiled without
22030 optimization.  Because always storing floating-point arguments on the
22031 stack is inefficient and rarely needed, this option is not enabled by
22032 default and only is necessary when calling subroutines compiled by IBM
22033 XL compilers without optimization.
22035 @item -mpe
22036 @opindex mpe
22037 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22038 application written to use message passing with special startup code to
22039 enable the application to run.  The system must have PE installed in the
22040 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22041 must be overridden with the @option{-specs=} option to specify the
22042 appropriate directory location.  The Parallel Environment does not
22043 support threads, so the @option{-mpe} option and the @option{-pthread}
22044 option are incompatible.
22046 @item -malign-natural
22047 @itemx -malign-power
22048 @opindex malign-natural
22049 @opindex malign-power
22050 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22051 @option{-malign-natural} overrides the ABI-defined alignment of larger
22052 types, such as floating-point doubles, on their natural size-based boundary.
22053 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22054 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22056 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22057 is not supported.
22059 @item -msoft-float
22060 @itemx -mhard-float
22061 @opindex msoft-float
22062 @opindex mhard-float
22063 Generate code that does not use (uses) the floating-point register set.
22064 Software floating-point emulation is provided if you use the
22065 @option{-msoft-float} option, and pass the option to GCC when linking.
22067 @item -msingle-float
22068 @itemx -mdouble-float
22069 @opindex msingle-float
22070 @opindex mdouble-float
22071 Generate code for single- or double-precision floating-point operations.
22072 @option{-mdouble-float} implies @option{-msingle-float}.
22074 @item -msimple-fpu
22075 @opindex msimple-fpu
22076 Do not generate @code{sqrt} and @code{div} instructions for hardware
22077 floating-point unit.
22079 @item -mfpu=@var{name}
22080 @opindex mfpu
22081 Specify type of floating-point unit.  Valid values for @var{name} are
22082 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22083 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22084 @samp{sp_full} (equivalent to @option{-msingle-float}),
22085 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22087 @item -mxilinx-fpu
22088 @opindex mxilinx-fpu
22089 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22091 @item -mmultiple
22092 @itemx -mno-multiple
22093 @opindex mmultiple
22094 @opindex mno-multiple
22095 Generate code that uses (does not use) the load multiple word
22096 instructions and the store multiple word instructions.  These
22097 instructions are generated by default on POWER systems, and not
22098 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22099 PowerPC systems, since those instructions do not work when the
22100 processor is in little-endian mode.  The exceptions are PPC740 and
22101 PPC750 which permit these instructions in little-endian mode.
22103 @item -mstring
22104 @itemx -mno-string
22105 @opindex mstring
22106 @opindex mno-string
22107 Generate code that uses (does not use) the load string instructions
22108 and the store string word instructions to save multiple registers and
22109 do small block moves.  These instructions are generated by default on
22110 POWER systems, and not generated on PowerPC systems.  Do not use
22111 @option{-mstring} on little-endian PowerPC systems, since those
22112 instructions do not work when the processor is in little-endian mode.
22113 The exceptions are PPC740 and PPC750 which permit these instructions
22114 in little-endian mode.
22116 @item -mupdate
22117 @itemx -mno-update
22118 @opindex mupdate
22119 @opindex mno-update
22120 Generate code that uses (does not use) the load or store instructions
22121 that update the base register to the address of the calculated memory
22122 location.  These instructions are generated by default.  If you use
22123 @option{-mno-update}, there is a small window between the time that the
22124 stack pointer is updated and the address of the previous frame is
22125 stored, which means code that walks the stack frame across interrupts or
22126 signals may get corrupted data.
22128 @item -mavoid-indexed-addresses
22129 @itemx -mno-avoid-indexed-addresses
22130 @opindex mavoid-indexed-addresses
22131 @opindex mno-avoid-indexed-addresses
22132 Generate code that tries to avoid (not avoid) the use of indexed load
22133 or store instructions. These instructions can incur a performance
22134 penalty on Power6 processors in certain situations, such as when
22135 stepping through large arrays that cross a 16M boundary.  This option
22136 is enabled by default when targeting Power6 and disabled otherwise.
22138 @item -mfused-madd
22139 @itemx -mno-fused-madd
22140 @opindex mfused-madd
22141 @opindex mno-fused-madd
22142 Generate code that uses (does not use) the floating-point multiply and
22143 accumulate instructions.  These instructions are generated by default
22144 if hardware floating point is used.  The machine-dependent
22145 @option{-mfused-madd} option is now mapped to the machine-independent
22146 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22147 mapped to @option{-ffp-contract=off}.
22149 @item -mmulhw
22150 @itemx -mno-mulhw
22151 @opindex mmulhw
22152 @opindex mno-mulhw
22153 Generate code that uses (does not use) the half-word multiply and
22154 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22155 These instructions are generated by default when targeting those
22156 processors.
22158 @item -mdlmzb
22159 @itemx -mno-dlmzb
22160 @opindex mdlmzb
22161 @opindex mno-dlmzb
22162 Generate code that uses (does not use) the string-search @samp{dlmzb}
22163 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22164 generated by default when targeting those processors.
22166 @item -mno-bit-align
22167 @itemx -mbit-align
22168 @opindex mno-bit-align
22169 @opindex mbit-align
22170 On System V.4 and embedded PowerPC systems do not (do) force structures
22171 and unions that contain bit-fields to be aligned to the base type of the
22172 bit-field.
22174 For example, by default a structure containing nothing but 8
22175 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22176 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22177 the structure is aligned to a 1-byte boundary and is 1 byte in
22178 size.
22180 @item -mno-strict-align
22181 @itemx -mstrict-align
22182 @opindex mno-strict-align
22183 @opindex mstrict-align
22184 On System V.4 and embedded PowerPC systems do not (do) assume that
22185 unaligned memory references are handled by the system.
22187 @item -mrelocatable
22188 @itemx -mno-relocatable
22189 @opindex mrelocatable
22190 @opindex mno-relocatable
22191 Generate code that allows (does not allow) a static executable to be
22192 relocated to a different address at run time.  A simple embedded
22193 PowerPC system loader should relocate the entire contents of
22194 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22195 a table of 32-bit addresses generated by this option.  For this to
22196 work, all objects linked together must be compiled with
22197 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22198 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22200 @item -mrelocatable-lib
22201 @itemx -mno-relocatable-lib
22202 @opindex mrelocatable-lib
22203 @opindex mno-relocatable-lib
22204 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22205 @code{.fixup} section to allow static executables to be relocated at
22206 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22207 alignment of @option{-mrelocatable}.  Objects compiled with
22208 @option{-mrelocatable-lib} may be linked with objects compiled with
22209 any combination of the @option{-mrelocatable} options.
22211 @item -mno-toc
22212 @itemx -mtoc
22213 @opindex mno-toc
22214 @opindex mtoc
22215 On System V.4 and embedded PowerPC systems do not (do) assume that
22216 register 2 contains a pointer to a global area pointing to the addresses
22217 used in the program.
22219 @item -mlittle
22220 @itemx -mlittle-endian
22221 @opindex mlittle
22222 @opindex mlittle-endian
22223 On System V.4 and embedded PowerPC systems compile code for the
22224 processor in little-endian mode.  The @option{-mlittle-endian} option is
22225 the same as @option{-mlittle}.
22227 @item -mbig
22228 @itemx -mbig-endian
22229 @opindex mbig
22230 @opindex mbig-endian
22231 On System V.4 and embedded PowerPC systems compile code for the
22232 processor in big-endian mode.  The @option{-mbig-endian} option is
22233 the same as @option{-mbig}.
22235 @item -mdynamic-no-pic
22236 @opindex mdynamic-no-pic
22237 On Darwin and Mac OS X systems, compile code so that it is not
22238 relocatable, but that its external references are relocatable.  The
22239 resulting code is suitable for applications, but not shared
22240 libraries.
22242 @item -msingle-pic-base
22243 @opindex msingle-pic-base
22244 Treat the register used for PIC addressing as read-only, rather than
22245 loading it in the prologue for each function.  The runtime system is
22246 responsible for initializing this register with an appropriate value
22247 before execution begins.
22249 @item -mprioritize-restricted-insns=@var{priority}
22250 @opindex mprioritize-restricted-insns
22251 This option controls the priority that is assigned to
22252 dispatch-slot restricted instructions during the second scheduling
22253 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22254 or @samp{2} to assign no, highest, or second-highest (respectively) 
22255 priority to dispatch-slot restricted
22256 instructions.
22258 @item -msched-costly-dep=@var{dependence_type}
22259 @opindex msched-costly-dep
22260 This option controls which dependences are considered costly
22261 by the target during instruction scheduling.  The argument
22262 @var{dependence_type} takes one of the following values:
22264 @table @asis
22265 @item @samp{no}
22266 No dependence is costly.
22268 @item @samp{all}
22269 All dependences are costly.
22271 @item @samp{true_store_to_load}
22272 A true dependence from store to load is costly.
22274 @item @samp{store_to_load}
22275 Any dependence from store to load is costly.
22277 @item @var{number}
22278 Any dependence for which the latency is greater than or equal to 
22279 @var{number} is costly.
22280 @end table
22282 @item -minsert-sched-nops=@var{scheme}
22283 @opindex minsert-sched-nops
22284 This option controls which NOP insertion scheme is used during
22285 the second scheduling pass.  The argument @var{scheme} takes one of the
22286 following values:
22288 @table @asis
22289 @item @samp{no}
22290 Don't insert NOPs.
22292 @item @samp{pad}
22293 Pad with NOPs any dispatch group that has vacant issue slots,
22294 according to the scheduler's grouping.
22296 @item @samp{regroup_exact}
22297 Insert NOPs to force costly dependent insns into
22298 separate groups.  Insert exactly as many NOPs as needed to force an insn
22299 to a new group, according to the estimated processor grouping.
22301 @item @var{number}
22302 Insert NOPs to force costly dependent insns into
22303 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22304 @end table
22306 @item -mcall-sysv
22307 @opindex mcall-sysv
22308 On System V.4 and embedded PowerPC systems compile code using calling
22309 conventions that adhere to the March 1995 draft of the System V
22310 Application Binary Interface, PowerPC processor supplement.  This is the
22311 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22313 @item -mcall-sysv-eabi
22314 @itemx -mcall-eabi
22315 @opindex mcall-sysv-eabi
22316 @opindex mcall-eabi
22317 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22319 @item -mcall-sysv-noeabi
22320 @opindex mcall-sysv-noeabi
22321 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22323 @item -mcall-aixdesc
22324 @opindex m
22325 On System V.4 and embedded PowerPC systems compile code for the AIX
22326 operating system.
22328 @item -mcall-linux
22329 @opindex mcall-linux
22330 On System V.4 and embedded PowerPC systems compile code for the
22331 Linux-based GNU system.
22333 @item -mcall-freebsd
22334 @opindex mcall-freebsd
22335 On System V.4 and embedded PowerPC systems compile code for the
22336 FreeBSD operating system.
22338 @item -mcall-netbsd
22339 @opindex mcall-netbsd
22340 On System V.4 and embedded PowerPC systems compile code for the
22341 NetBSD operating system.
22343 @item -mcall-openbsd
22344 @opindex mcall-netbsd
22345 On System V.4 and embedded PowerPC systems compile code for the
22346 OpenBSD operating system.
22348 @item -maix-struct-return
22349 @opindex maix-struct-return
22350 Return all structures in memory (as specified by the AIX ABI)@.
22352 @item -msvr4-struct-return
22353 @opindex msvr4-struct-return
22354 Return structures smaller than 8 bytes in registers (as specified by the
22355 SVR4 ABI)@.
22357 @item -mabi=@var{abi-type}
22358 @opindex mabi
22359 Extend the current ABI with a particular extension, or remove such extension.
22360 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22361 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22362 @samp{elfv1}, @samp{elfv2}@.
22364 @item -mabi=spe
22365 @opindex mabi=spe
22366 Extend the current ABI with SPE ABI extensions.  This does not change
22367 the default ABI, instead it adds the SPE ABI extensions to the current
22368 ABI@.
22370 @item -mabi=no-spe
22371 @opindex mabi=no-spe
22372 Disable Book-E SPE ABI extensions for the current ABI@.
22374 @item -mabi=ibmlongdouble
22375 @opindex mabi=ibmlongdouble
22376 Change the current ABI to use IBM extended-precision long double.
22377 This is a PowerPC 32-bit SYSV ABI option.
22379 @item -mabi=ieeelongdouble
22380 @opindex mabi=ieeelongdouble
22381 Change the current ABI to use IEEE extended-precision long double.
22382 This is a PowerPC 32-bit Linux ABI option.
22384 @item -mabi=elfv1
22385 @opindex mabi=elfv1
22386 Change the current ABI to use the ELFv1 ABI.
22387 This is the default ABI for big-endian PowerPC 64-bit Linux.
22388 Overriding the default ABI requires special system support and is
22389 likely to fail in spectacular ways.
22391 @item -mabi=elfv2
22392 @opindex mabi=elfv2
22393 Change the current ABI to use the ELFv2 ABI.
22394 This is the default ABI for little-endian PowerPC 64-bit Linux.
22395 Overriding the default ABI requires special system support and is
22396 likely to fail in spectacular ways.
22398 @item -mgnu-attribute
22399 @itemx -mno-gnu-attribute
22400 @opindex mgnu-attribute
22401 @opindex mno-gnu-attribute
22402 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22403 .gnu.attributes section that specify ABI variations in function
22404 parameters or return values.
22406 @item -mprototype
22407 @itemx -mno-prototype
22408 @opindex mprototype
22409 @opindex mno-prototype
22410 On System V.4 and embedded PowerPC systems assume that all calls to
22411 variable argument functions are properly prototyped.  Otherwise, the
22412 compiler must insert an instruction before every non-prototyped call to
22413 set or clear bit 6 of the condition code register (@code{CR}) to
22414 indicate whether floating-point values are passed in the floating-point
22415 registers in case the function takes variable arguments.  With
22416 @option{-mprototype}, only calls to prototyped variable argument functions
22417 set or clear the bit.
22419 @item -msim
22420 @opindex msim
22421 On embedded PowerPC systems, assume that the startup module is called
22422 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22423 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22424 configurations.
22426 @item -mmvme
22427 @opindex mmvme
22428 On embedded PowerPC systems, assume that the startup module is called
22429 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22430 @file{libc.a}.
22432 @item -mads
22433 @opindex mads
22434 On embedded PowerPC systems, assume that the startup module is called
22435 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22436 @file{libc.a}.
22438 @item -myellowknife
22439 @opindex myellowknife
22440 On embedded PowerPC systems, assume that the startup module is called
22441 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22442 @file{libc.a}.
22444 @item -mvxworks
22445 @opindex mvxworks
22446 On System V.4 and embedded PowerPC systems, specify that you are
22447 compiling for a VxWorks system.
22449 @item -memb
22450 @opindex memb
22451 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22452 header to indicate that @samp{eabi} extended relocations are used.
22454 @item -meabi
22455 @itemx -mno-eabi
22456 @opindex meabi
22457 @opindex mno-eabi
22458 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22459 Embedded Applications Binary Interface (EABI), which is a set of
22460 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22461 means that the stack is aligned to an 8-byte boundary, a function
22462 @code{__eabi} is called from @code{main} to set up the EABI
22463 environment, and the @option{-msdata} option can use both @code{r2} and
22464 @code{r13} to point to two separate small data areas.  Selecting
22465 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22466 no EABI initialization function is called from @code{main}, and the
22467 @option{-msdata} option only uses @code{r13} to point to a single
22468 small data area.  The @option{-meabi} option is on by default if you
22469 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22471 @item -msdata=eabi
22472 @opindex msdata=eabi
22473 On System V.4 and embedded PowerPC systems, put small initialized
22474 @code{const} global and static data in the @code{.sdata2} section, which
22475 is pointed to by register @code{r2}.  Put small initialized
22476 non-@code{const} global and static data in the @code{.sdata} section,
22477 which is pointed to by register @code{r13}.  Put small uninitialized
22478 global and static data in the @code{.sbss} section, which is adjacent to
22479 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22480 incompatible with the @option{-mrelocatable} option.  The
22481 @option{-msdata=eabi} option also sets the @option{-memb} option.
22483 @item -msdata=sysv
22484 @opindex msdata=sysv
22485 On System V.4 and embedded PowerPC systems, put small global and static
22486 data in the @code{.sdata} section, which is pointed to by register
22487 @code{r13}.  Put small uninitialized global and static data in the
22488 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22489 The @option{-msdata=sysv} option is incompatible with the
22490 @option{-mrelocatable} option.
22492 @item -msdata=default
22493 @itemx -msdata
22494 @opindex msdata=default
22495 @opindex msdata
22496 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22497 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22498 same as @option{-msdata=sysv}.
22500 @item -msdata=data
22501 @opindex msdata=data
22502 On System V.4 and embedded PowerPC systems, put small global
22503 data in the @code{.sdata} section.  Put small uninitialized global
22504 data in the @code{.sbss} section.  Do not use register @code{r13}
22505 to address small data however.  This is the default behavior unless
22506 other @option{-msdata} options are used.
22508 @item -msdata=none
22509 @itemx -mno-sdata
22510 @opindex msdata=none
22511 @opindex mno-sdata
22512 On embedded PowerPC systems, put all initialized global and static data
22513 in the @code{.data} section, and all uninitialized data in the
22514 @code{.bss} section.
22516 @item -mblock-move-inline-limit=@var{num}
22517 @opindex mblock-move-inline-limit
22518 Inline all block moves (such as calls to @code{memcpy} or structure
22519 copies) less than or equal to @var{num} bytes.  The minimum value for
22520 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22521 targets.  The default value is target-specific.
22523 @item -G @var{num}
22524 @opindex G
22525 @cindex smaller data references (PowerPC)
22526 @cindex .sdata/.sdata2 references (PowerPC)
22527 On embedded PowerPC systems, put global and static items less than or
22528 equal to @var{num} bytes into the small data or BSS sections instead of
22529 the normal data or BSS section.  By default, @var{num} is 8.  The
22530 @option{-G @var{num}} switch is also passed to the linker.
22531 All modules should be compiled with the same @option{-G @var{num}} value.
22533 @item -mregnames
22534 @itemx -mno-regnames
22535 @opindex mregnames
22536 @opindex mno-regnames
22537 On System V.4 and embedded PowerPC systems do (do not) emit register
22538 names in the assembly language output using symbolic forms.
22540 @item -mlongcall
22541 @itemx -mno-longcall
22542 @opindex mlongcall
22543 @opindex mno-longcall
22544 By default assume that all calls are far away so that a longer and more
22545 expensive calling sequence is required.  This is required for calls
22546 farther than 32 megabytes (33,554,432 bytes) from the current location.
22547 A short call is generated if the compiler knows
22548 the call cannot be that far away.  This setting can be overridden by
22549 the @code{shortcall} function attribute, or by @code{#pragma
22550 longcall(0)}.
22552 Some linkers are capable of detecting out-of-range calls and generating
22553 glue code on the fly.  On these systems, long calls are unnecessary and
22554 generate slower code.  As of this writing, the AIX linker can do this,
22555 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22556 to the GNU linker for 32-bit PowerPC systems as well.
22558 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22559 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22560 addresses represent the callee and the branch island.  The
22561 Darwin/PPC linker prefers the first address and generates a @code{bl
22562 callee} if the PPC @code{bl} instruction reaches the callee directly;
22563 otherwise, the linker generates @code{bl L42} to call the branch
22564 island.  The branch island is appended to the body of the
22565 calling function; it computes the full 32-bit address of the callee
22566 and jumps to it.
22568 On Mach-O (Darwin) systems, this option directs the compiler emit to
22569 the glue for every direct call, and the Darwin linker decides whether
22570 to use or discard it.
22572 In the future, GCC may ignore all longcall specifications
22573 when the linker is known to generate glue.
22575 @item -mtls-markers
22576 @itemx -mno-tls-markers
22577 @opindex mtls-markers
22578 @opindex mno-tls-markers
22579 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22580 specifying the function argument.  The relocation allows the linker to
22581 reliably associate function call with argument setup instructions for
22582 TLS optimization, which in turn allows GCC to better schedule the
22583 sequence.
22585 @item -mrecip
22586 @itemx -mno-recip
22587 @opindex mrecip
22588 This option enables use of the reciprocal estimate and
22589 reciprocal square root estimate instructions with additional
22590 Newton-Raphson steps to increase precision instead of doing a divide or
22591 square root and divide for floating-point arguments.  You should use
22592 the @option{-ffast-math} option when using @option{-mrecip} (or at
22593 least @option{-funsafe-math-optimizations},
22594 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22595 @option{-fno-trapping-math}).  Note that while the throughput of the
22596 sequence is generally higher than the throughput of the non-reciprocal
22597 instruction, the precision of the sequence can be decreased by up to 2
22598 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22599 roots.
22601 @item -mrecip=@var{opt}
22602 @opindex mrecip=opt
22603 This option controls which reciprocal estimate instructions
22604 may be used.  @var{opt} is a comma-separated list of options, which may
22605 be preceded by a @code{!} to invert the option:
22607 @table @samp
22609 @item all
22610 Enable all estimate instructions.
22612 @item default 
22613 Enable the default instructions, equivalent to @option{-mrecip}.
22615 @item none 
22616 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22618 @item div 
22619 Enable the reciprocal approximation instructions for both 
22620 single and double precision.
22622 @item divf 
22623 Enable the single-precision reciprocal approximation instructions.
22625 @item divd 
22626 Enable the double-precision reciprocal approximation instructions.
22628 @item rsqrt 
22629 Enable the reciprocal square root approximation instructions for both
22630 single and double precision.
22632 @item rsqrtf 
22633 Enable the single-precision reciprocal square root approximation instructions.
22635 @item rsqrtd 
22636 Enable the double-precision reciprocal square root approximation instructions.
22638 @end table
22640 So, for example, @option{-mrecip=all,!rsqrtd} enables
22641 all of the reciprocal estimate instructions, except for the
22642 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22643 which handle the double-precision reciprocal square root calculations.
22645 @item -mrecip-precision
22646 @itemx -mno-recip-precision
22647 @opindex mrecip-precision
22648 Assume (do not assume) that the reciprocal estimate instructions
22649 provide higher-precision estimates than is mandated by the PowerPC
22650 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22651 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22652 The double-precision square root estimate instructions are not generated by
22653 default on low-precision machines, since they do not provide an
22654 estimate that converges after three steps.
22656 @item -mveclibabi=@var{type}
22657 @opindex mveclibabi
22658 Specifies the ABI type to use for vectorizing intrinsics using an
22659 external library.  The only type supported at present is @samp{mass},
22660 which specifies to use IBM's Mathematical Acceleration Subsystem
22661 (MASS) libraries for vectorizing intrinsics using external libraries.
22662 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22663 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22664 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22665 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22666 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22667 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22668 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22669 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22670 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22671 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22672 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22673 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22674 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22675 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22676 for power7.  Both @option{-ftree-vectorize} and
22677 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22678 libraries must be specified at link time.
22680 @item -mfriz
22681 @itemx -mno-friz
22682 @opindex mfriz
22683 Generate (do not generate) the @code{friz} instruction when the
22684 @option{-funsafe-math-optimizations} option is used to optimize
22685 rounding of floating-point values to 64-bit integer and back to floating
22686 point.  The @code{friz} instruction does not return the same value if
22687 the floating-point number is too large to fit in an integer.
22689 @item -mpointers-to-nested-functions
22690 @itemx -mno-pointers-to-nested-functions
22691 @opindex mpointers-to-nested-functions
22692 Generate (do not generate) code to load up the static chain register
22693 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22694 systems where a function pointer points to a 3-word descriptor giving
22695 the function address, TOC value to be loaded in register @code{r2}, and
22696 static chain value to be loaded in register @code{r11}.  The
22697 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22698 call through pointers to nested functions or pointers
22699 to functions compiled in other languages that use the static chain if
22700 you use @option{-mno-pointers-to-nested-functions}.
22702 @item -msave-toc-indirect
22703 @itemx -mno-save-toc-indirect
22704 @opindex msave-toc-indirect
22705 Generate (do not generate) code to save the TOC value in the reserved
22706 stack location in the function prologue if the function calls through
22707 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22708 saved in the prologue, it is saved just before the call through the
22709 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22711 @item -mcompat-align-parm
22712 @itemx -mno-compat-align-parm
22713 @opindex mcompat-align-parm
22714 Generate (do not generate) code to pass structure parameters with a
22715 maximum alignment of 64 bits, for compatibility with older versions
22716 of GCC.
22718 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22719 structure parameter on a 128-bit boundary when that structure contained
22720 a member requiring 128-bit alignment.  This is corrected in more
22721 recent versions of GCC.  This option may be used to generate code
22722 that is compatible with functions compiled with older versions of
22723 GCC.
22725 The @option{-mno-compat-align-parm} option is the default.
22727 @item -mstack-protector-guard=@var{guard}
22728 @itemx -mstack-protector-guard-reg=@var{reg}
22729 @itemx -mstack-protector-guard-offset=@var{offset}
22730 @opindex mstack-protector-guard
22731 @opindex mstack-protector-guard-reg
22732 @opindex mstack-protector-guard-offset
22733 Generate stack protection code using canary at @var{guard}.  Supported
22734 locations are @samp{global} for global canary or @samp{tls} for per-thread
22735 canary in the TLS block (the default with GNU libc version 2.4 or later).
22737 With the latter choice the options
22738 @option{-mstack-protector-guard-reg=@var{reg}} and
22739 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22740 which register to use as base register for reading the canary, and from what
22741 offset from that base register. The default for those is as specified in the
22742 relevant ABI.
22743 @end table
22745 @node RX Options
22746 @subsection RX Options
22747 @cindex RX Options
22749 These command-line options are defined for RX targets:
22751 @table @gcctabopt
22752 @item -m64bit-doubles
22753 @itemx -m32bit-doubles
22754 @opindex m64bit-doubles
22755 @opindex m32bit-doubles
22756 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22757 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22758 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22759 works on 32-bit values, which is why the default is
22760 @option{-m32bit-doubles}.
22762 @item -fpu
22763 @itemx -nofpu
22764 @opindex fpu
22765 @opindex nofpu
22766 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22767 floating-point hardware.  The default is enabled for the RX600
22768 series and disabled for the RX200 series.
22770 Floating-point instructions are only generated for 32-bit floating-point 
22771 values, however, so the FPU hardware is not used for doubles if the
22772 @option{-m64bit-doubles} option is used.
22774 @emph{Note} If the @option{-fpu} option is enabled then
22775 @option{-funsafe-math-optimizations} is also enabled automatically.
22776 This is because the RX FPU instructions are themselves unsafe.
22778 @item -mcpu=@var{name}
22779 @opindex mcpu
22780 Selects the type of RX CPU to be targeted.  Currently three types are
22781 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22782 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22784 The only difference between @samp{RX600} and @samp{RX610} is that the
22785 @samp{RX610} does not support the @code{MVTIPL} instruction.
22787 The @samp{RX200} series does not have a hardware floating-point unit
22788 and so @option{-nofpu} is enabled by default when this type is
22789 selected.
22791 @item -mbig-endian-data
22792 @itemx -mlittle-endian-data
22793 @opindex mbig-endian-data
22794 @opindex mlittle-endian-data
22795 Store data (but not code) in the big-endian format.  The default is
22796 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22797 format.
22799 @item -msmall-data-limit=@var{N}
22800 @opindex msmall-data-limit
22801 Specifies the maximum size in bytes of global and static variables
22802 which can be placed into the small data area.  Using the small data
22803 area can lead to smaller and faster code, but the size of area is
22804 limited and it is up to the programmer to ensure that the area does
22805 not overflow.  Also when the small data area is used one of the RX's
22806 registers (usually @code{r13}) is reserved for use pointing to this
22807 area, so it is no longer available for use by the compiler.  This
22808 could result in slower and/or larger code if variables are pushed onto
22809 the stack instead of being held in this register.
22811 Note, common variables (variables that have not been initialized) and
22812 constants are not placed into the small data area as they are assigned
22813 to other sections in the output executable.
22815 The default value is zero, which disables this feature.  Note, this
22816 feature is not enabled by default with higher optimization levels
22817 (@option{-O2} etc) because of the potentially detrimental effects of
22818 reserving a register.  It is up to the programmer to experiment and
22819 discover whether this feature is of benefit to their program.  See the
22820 description of the @option{-mpid} option for a description of how the
22821 actual register to hold the small data area pointer is chosen.
22823 @item -msim
22824 @itemx -mno-sim
22825 @opindex msim
22826 @opindex mno-sim
22827 Use the simulator runtime.  The default is to use the libgloss
22828 board-specific runtime.
22830 @item -mas100-syntax
22831 @itemx -mno-as100-syntax
22832 @opindex mas100-syntax
22833 @opindex mno-as100-syntax
22834 When generating assembler output use a syntax that is compatible with
22835 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22836 assembler, but it has some restrictions so it is not generated by default.
22838 @item -mmax-constant-size=@var{N}
22839 @opindex mmax-constant-size
22840 Specifies the maximum size, in bytes, of a constant that can be used as
22841 an operand in a RX instruction.  Although the RX instruction set does
22842 allow constants of up to 4 bytes in length to be used in instructions,
22843 a longer value equates to a longer instruction.  Thus in some
22844 circumstances it can be beneficial to restrict the size of constants
22845 that are used in instructions.  Constants that are too big are instead
22846 placed into a constant pool and referenced via register indirection.
22848 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22849 or 4 means that constants of any size are allowed.
22851 @item -mrelax
22852 @opindex mrelax
22853 Enable linker relaxation.  Linker relaxation is a process whereby the
22854 linker attempts to reduce the size of a program by finding shorter
22855 versions of various instructions.  Disabled by default.
22857 @item -mint-register=@var{N}
22858 @opindex mint-register
22859 Specify the number of registers to reserve for fast interrupt handler
22860 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22861 means that register @code{r13} is reserved for the exclusive use
22862 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22863 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22864 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22865 A value of 0, the default, does not reserve any registers.
22867 @item -msave-acc-in-interrupts
22868 @opindex msave-acc-in-interrupts
22869 Specifies that interrupt handler functions should preserve the
22870 accumulator register.  This is only necessary if normal code might use
22871 the accumulator register, for example because it performs 64-bit
22872 multiplications.  The default is to ignore the accumulator as this
22873 makes the interrupt handlers faster.
22875 @item -mpid
22876 @itemx -mno-pid
22877 @opindex mpid
22878 @opindex mno-pid
22879 Enables the generation of position independent data.  When enabled any
22880 access to constant data is done via an offset from a base address
22881 held in a register.  This allows the location of constant data to be
22882 determined at run time without requiring the executable to be
22883 relocated, which is a benefit to embedded applications with tight
22884 memory constraints.  Data that can be modified is not affected by this
22885 option.
22887 Note, using this feature reserves a register, usually @code{r13}, for
22888 the constant data base address.  This can result in slower and/or
22889 larger code, especially in complicated functions.
22891 The actual register chosen to hold the constant data base address
22892 depends upon whether the @option{-msmall-data-limit} and/or the
22893 @option{-mint-register} command-line options are enabled.  Starting
22894 with register @code{r13} and proceeding downwards, registers are
22895 allocated first to satisfy the requirements of @option{-mint-register},
22896 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22897 is possible for the small data area register to be @code{r8} if both
22898 @option{-mint-register=4} and @option{-mpid} are specified on the
22899 command line.
22901 By default this feature is not enabled.  The default can be restored
22902 via the @option{-mno-pid} command-line option.
22904 @item -mno-warn-multiple-fast-interrupts
22905 @itemx -mwarn-multiple-fast-interrupts
22906 @opindex mno-warn-multiple-fast-interrupts
22907 @opindex mwarn-multiple-fast-interrupts
22908 Prevents GCC from issuing a warning message if it finds more than one
22909 fast interrupt handler when it is compiling a file.  The default is to
22910 issue a warning for each extra fast interrupt handler found, as the RX
22911 only supports one such interrupt.
22913 @item -mallow-string-insns
22914 @itemx -mno-allow-string-insns
22915 @opindex mallow-string-insns
22916 @opindex mno-allow-string-insns
22917 Enables or disables the use of the string manipulation instructions
22918 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22919 @code{SWHILE} and also the @code{RMPA} instruction.  These
22920 instructions may prefetch data, which is not safe to do if accessing
22921 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22922 for more information).
22924 The default is to allow these instructions, but it is not possible for
22925 GCC to reliably detect all circumstances where a string instruction
22926 might be used to access an I/O register, so their use cannot be
22927 disabled automatically.  Instead it is reliant upon the programmer to
22928 use the @option{-mno-allow-string-insns} option if their program
22929 accesses I/O space.
22931 When the instructions are enabled GCC defines the C preprocessor
22932 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22933 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22935 @item -mjsr
22936 @itemx -mno-jsr
22937 @opindex mjsr
22938 @opindex mno-jsr
22939 Use only (or not only) @code{JSR} instructions to access functions.
22940 This option can be used when code size exceeds the range of @code{BSR}
22941 instructions.  Note that @option{-mno-jsr} does not mean to not use
22942 @code{JSR} but instead means that any type of branch may be used.
22943 @end table
22945 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22946 has special significance to the RX port when used with the
22947 @code{interrupt} function attribute.  This attribute indicates a
22948 function intended to process fast interrupts.  GCC ensures
22949 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22950 and/or @code{r13} and only provided that the normal use of the
22951 corresponding registers have been restricted via the
22952 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22953 options.
22955 @node S/390 and zSeries Options
22956 @subsection S/390 and zSeries Options
22957 @cindex S/390 and zSeries Options
22959 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22961 @table @gcctabopt
22962 @item -mhard-float
22963 @itemx -msoft-float
22964 @opindex mhard-float
22965 @opindex msoft-float
22966 Use (do not use) the hardware floating-point instructions and registers
22967 for floating-point operations.  When @option{-msoft-float} is specified,
22968 functions in @file{libgcc.a} are used to perform floating-point
22969 operations.  When @option{-mhard-float} is specified, the compiler
22970 generates IEEE floating-point instructions.  This is the default.
22972 @item -mhard-dfp
22973 @itemx -mno-hard-dfp
22974 @opindex mhard-dfp
22975 @opindex mno-hard-dfp
22976 Use (do not use) the hardware decimal-floating-point instructions for
22977 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22978 specified, functions in @file{libgcc.a} are used to perform
22979 decimal-floating-point operations.  When @option{-mhard-dfp} is
22980 specified, the compiler generates decimal-floating-point hardware
22981 instructions.  This is the default for @option{-march=z9-ec} or higher.
22983 @item -mlong-double-64
22984 @itemx -mlong-double-128
22985 @opindex mlong-double-64
22986 @opindex mlong-double-128
22987 These switches control the size of @code{long double} type. A size
22988 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22989 type. This is the default.
22991 @item -mbackchain
22992 @itemx -mno-backchain
22993 @opindex mbackchain
22994 @opindex mno-backchain
22995 Store (do not store) the address of the caller's frame as backchain pointer
22996 into the callee's stack frame.
22997 A backchain may be needed to allow debugging using tools that do not understand
22998 DWARF call frame information.
22999 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23000 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23001 the backchain is placed into the topmost word of the 96/160 byte register
23002 save area.
23004 In general, code compiled with @option{-mbackchain} is call-compatible with
23005 code compiled with @option{-mmo-backchain}; however, use of the backchain
23006 for debugging purposes usually requires that the whole binary is built with
23007 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23008 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23009 to build a linux kernel use @option{-msoft-float}.
23011 The default is to not maintain the backchain.
23013 @item -mpacked-stack
23014 @itemx -mno-packed-stack
23015 @opindex mpacked-stack
23016 @opindex mno-packed-stack
23017 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23018 specified, the compiler uses the all fields of the 96/160 byte register save
23019 area only for their default purpose; unused fields still take up stack space.
23020 When @option{-mpacked-stack} is specified, register save slots are densely
23021 packed at the top of the register save area; unused space is reused for other
23022 purposes, allowing for more efficient use of the available stack space.
23023 However, when @option{-mbackchain} is also in effect, the topmost word of
23024 the save area is always used to store the backchain, and the return address
23025 register is always saved two words below the backchain.
23027 As long as the stack frame backchain is not used, code generated with
23028 @option{-mpacked-stack} is call-compatible with code generated with
23029 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23030 S/390 or zSeries generated code that uses the stack frame backchain at run
23031 time, not just for debugging purposes.  Such code is not call-compatible
23032 with code compiled with @option{-mpacked-stack}.  Also, note that the
23033 combination of @option{-mbackchain},
23034 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23035 to build a linux kernel use @option{-msoft-float}.
23037 The default is to not use the packed stack layout.
23039 @item -msmall-exec
23040 @itemx -mno-small-exec
23041 @opindex msmall-exec
23042 @opindex mno-small-exec
23043 Generate (or do not generate) code using the @code{bras} instruction
23044 to do subroutine calls.
23045 This only works reliably if the total executable size does not
23046 exceed 64k.  The default is to use the @code{basr} instruction instead,
23047 which does not have this limitation.
23049 @item -m64
23050 @itemx -m31
23051 @opindex m64
23052 @opindex m31
23053 When @option{-m31} is specified, generate code compliant to the
23054 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23055 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23056 particular to generate 64-bit instructions.  For the @samp{s390}
23057 targets, the default is @option{-m31}, while the @samp{s390x}
23058 targets default to @option{-m64}.
23060 @item -mzarch
23061 @itemx -mesa
23062 @opindex mzarch
23063 @opindex mesa
23064 When @option{-mzarch} is specified, generate code using the
23065 instructions available on z/Architecture.
23066 When @option{-mesa} is specified, generate code using the
23067 instructions available on ESA/390.  Note that @option{-mesa} is
23068 not possible with @option{-m64}.
23069 When generating code compliant to the GNU/Linux for S/390 ABI,
23070 the default is @option{-mesa}.  When generating code compliant
23071 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23073 @item -mhtm
23074 @itemx -mno-htm
23075 @opindex mhtm
23076 @opindex mno-htm
23077 The @option{-mhtm} option enables a set of builtins making use of
23078 instructions available with the transactional execution facility
23079 introduced with the IBM zEnterprise EC12 machine generation
23080 @ref{S/390 System z Built-in Functions}.
23081 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23083 @item -mvx
23084 @itemx -mno-vx
23085 @opindex mvx
23086 @opindex mno-vx
23087 When @option{-mvx} is specified, generate code using the instructions
23088 available with the vector extension facility introduced with the IBM
23089 z13 machine generation.
23090 This option changes the ABI for some vector type values with regard to
23091 alignment and calling conventions.  In case vector type values are
23092 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23093 command will be added to mark the resulting binary with the ABI used.
23094 @option{-mvx} is enabled by default when using @option{-march=z13}.
23096 @item -mzvector
23097 @itemx -mno-zvector
23098 @opindex mzvector
23099 @opindex mno-zvector
23100 The @option{-mzvector} option enables vector language extensions and
23101 builtins using instructions available with the vector extension
23102 facility introduced with the IBM z13 machine generation.
23103 This option adds support for @samp{vector} to be used as a keyword to
23104 define vector type variables and arguments.  @samp{vector} is only
23105 available when GNU extensions are enabled.  It will not be expanded
23106 when requesting strict standard compliance e.g. with @option{-std=c99}.
23107 In addition to the GCC low-level builtins @option{-mzvector} enables
23108 a set of builtins added for compatibility with AltiVec-style
23109 implementations like Power and Cell.  In order to make use of these
23110 builtins the header file @file{vecintrin.h} needs to be included.
23111 @option{-mzvector} is disabled by default.
23113 @item -mmvcle
23114 @itemx -mno-mvcle
23115 @opindex mmvcle
23116 @opindex mno-mvcle
23117 Generate (or do not generate) code using the @code{mvcle} instruction
23118 to perform block moves.  When @option{-mno-mvcle} is specified,
23119 use a @code{mvc} loop instead.  This is the default unless optimizing for
23120 size.
23122 @item -mdebug
23123 @itemx -mno-debug
23124 @opindex mdebug
23125 @opindex mno-debug
23126 Print (or do not print) additional debug information when compiling.
23127 The default is to not print debug information.
23129 @item -march=@var{cpu-type}
23130 @opindex march
23131 Generate code that runs on @var{cpu-type}, which is the name of a
23132 system representing a certain processor type.  Possible values for
23133 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23134 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23135 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23136 @samp{native}.
23138 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23139 @samp{g6} are deprecated and will be removed with future releases.
23141 Specifying @samp{native} as cpu type can be used to select the best
23142 architecture option for the host processor.
23143 @option{-march=native} has no effect if GCC does not recognize the
23144 processor.
23146 @item -mtune=@var{cpu-type}
23147 @opindex mtune
23148 Tune to @var{cpu-type} everything applicable about the generated code,
23149 except for the ABI and the set of available instructions.
23150 The list of @var{cpu-type} values is the same as for @option{-march}.
23151 The default is the value used for @option{-march}.
23153 @item -mtpf-trace
23154 @itemx -mno-tpf-trace
23155 @opindex mtpf-trace
23156 @opindex mno-tpf-trace
23157 Generate code that adds (does not add) in TPF OS specific branches to trace
23158 routines in the operating system.  This option is off by default, even
23159 when compiling for the TPF OS@.
23161 @item -mfused-madd
23162 @itemx -mno-fused-madd
23163 @opindex mfused-madd
23164 @opindex mno-fused-madd
23165 Generate code that uses (does not use) the floating-point multiply and
23166 accumulate instructions.  These instructions are generated by default if
23167 hardware floating point is used.
23169 @item -mwarn-framesize=@var{framesize}
23170 @opindex mwarn-framesize
23171 Emit a warning if the current function exceeds the given frame size.  Because
23172 this is a compile-time check it doesn't need to be a real problem when the program
23173 runs.  It is intended to identify functions that most probably cause
23174 a stack overflow.  It is useful to be used in an environment with limited stack
23175 size e.g.@: the linux kernel.
23177 @item -mwarn-dynamicstack
23178 @opindex mwarn-dynamicstack
23179 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23180 arrays.  This is generally a bad idea with a limited stack size.
23182 @item -mstack-guard=@var{stack-guard}
23183 @itemx -mstack-size=@var{stack-size}
23184 @opindex mstack-guard
23185 @opindex mstack-size
23186 If these options are provided the S/390 back end emits additional instructions in
23187 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23188 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23189 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23190 the frame size of the compiled function is chosen.
23191 These options are intended to be used to help debugging stack overflow problems.
23192 The additionally emitted code causes only little overhead and hence can also be
23193 used in production-like systems without greater performance degradation.  The given
23194 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23195 @var{stack-guard} without exceeding 64k.
23196 In order to be efficient the extra code makes the assumption that the stack starts
23197 at an address aligned to the value given by @var{stack-size}.
23198 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23200 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23201 @opindex mhotpatch
23202 If the hotpatch option is enabled, a ``hot-patching'' function
23203 prologue is generated for all functions in the compilation unit.
23204 The funtion label is prepended with the given number of two-byte
23205 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23206 the label, 2 * @var{post-halfwords} bytes are appended, using the
23207 largest NOP like instructions the architecture allows (maximum
23208 1000000).
23210 If both arguments are zero, hotpatching is disabled.
23212 This option can be overridden for individual functions with the
23213 @code{hotpatch} attribute.
23214 @end table
23216 @node Score Options
23217 @subsection Score Options
23218 @cindex Score Options
23220 These options are defined for Score implementations:
23222 @table @gcctabopt
23223 @item -meb
23224 @opindex meb
23225 Compile code for big-endian mode.  This is the default.
23227 @item -mel
23228 @opindex mel
23229 Compile code for little-endian mode.
23231 @item -mnhwloop
23232 @opindex mnhwloop
23233 Disable generation of @code{bcnz} instructions.
23235 @item -muls
23236 @opindex muls
23237 Enable generation of unaligned load and store instructions.
23239 @item -mmac
23240 @opindex mmac
23241 Enable the use of multiply-accumulate instructions. Disabled by default.
23243 @item -mscore5
23244 @opindex mscore5
23245 Specify the SCORE5 as the target architecture.
23247 @item -mscore5u
23248 @opindex mscore5u
23249 Specify the SCORE5U of the target architecture.
23251 @item -mscore7
23252 @opindex mscore7
23253 Specify the SCORE7 as the target architecture. This is the default.
23255 @item -mscore7d
23256 @opindex mscore7d
23257 Specify the SCORE7D as the target architecture.
23258 @end table
23260 @node SH Options
23261 @subsection SH Options
23263 These @samp{-m} options are defined for the SH implementations:
23265 @table @gcctabopt
23266 @item -m1
23267 @opindex m1
23268 Generate code for the SH1.
23270 @item -m2
23271 @opindex m2
23272 Generate code for the SH2.
23274 @item -m2e
23275 Generate code for the SH2e.
23277 @item -m2a-nofpu
23278 @opindex m2a-nofpu
23279 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23280 that the floating-point unit is not used.
23282 @item -m2a-single-only
23283 @opindex m2a-single-only
23284 Generate code for the SH2a-FPU, in such a way that no double-precision
23285 floating-point operations are used.
23287 @item -m2a-single
23288 @opindex m2a-single
23289 Generate code for the SH2a-FPU assuming the floating-point unit is in
23290 single-precision mode by default.
23292 @item -m2a
23293 @opindex m2a
23294 Generate code for the SH2a-FPU assuming the floating-point unit is in
23295 double-precision mode by default.
23297 @item -m3
23298 @opindex m3
23299 Generate code for the SH3.
23301 @item -m3e
23302 @opindex m3e
23303 Generate code for the SH3e.
23305 @item -m4-nofpu
23306 @opindex m4-nofpu
23307 Generate code for the SH4 without a floating-point unit.
23309 @item -m4-single-only
23310 @opindex m4-single-only
23311 Generate code for the SH4 with a floating-point unit that only
23312 supports single-precision arithmetic.
23314 @item -m4-single
23315 @opindex m4-single
23316 Generate code for the SH4 assuming the floating-point unit is in
23317 single-precision mode by default.
23319 @item -m4
23320 @opindex m4
23321 Generate code for the SH4.
23323 @item -m4-100
23324 @opindex m4-100
23325 Generate code for SH4-100.
23327 @item -m4-100-nofpu
23328 @opindex m4-100-nofpu
23329 Generate code for SH4-100 in such a way that the
23330 floating-point unit is not used.
23332 @item -m4-100-single
23333 @opindex m4-100-single
23334 Generate code for SH4-100 assuming the floating-point unit is in
23335 single-precision mode by default.
23337 @item -m4-100-single-only
23338 @opindex m4-100-single-only
23339 Generate code for SH4-100 in such a way that no double-precision
23340 floating-point operations are used.
23342 @item -m4-200
23343 @opindex m4-200
23344 Generate code for SH4-200.
23346 @item -m4-200-nofpu
23347 @opindex m4-200-nofpu
23348 Generate code for SH4-200 without in such a way that the
23349 floating-point unit is not used.
23351 @item -m4-200-single
23352 @opindex m4-200-single
23353 Generate code for SH4-200 assuming the floating-point unit is in
23354 single-precision mode by default.
23356 @item -m4-200-single-only
23357 @opindex m4-200-single-only
23358 Generate code for SH4-200 in such a way that no double-precision
23359 floating-point operations are used.
23361 @item -m4-300
23362 @opindex m4-300
23363 Generate code for SH4-300.
23365 @item -m4-300-nofpu
23366 @opindex m4-300-nofpu
23367 Generate code for SH4-300 without in such a way that the
23368 floating-point unit is not used.
23370 @item -m4-300-single
23371 @opindex m4-300-single
23372 Generate code for SH4-300 in such a way that no double-precision
23373 floating-point operations are used.
23375 @item -m4-300-single-only
23376 @opindex m4-300-single-only
23377 Generate code for SH4-300 in such a way that no double-precision
23378 floating-point operations are used.
23380 @item -m4-340
23381 @opindex m4-340
23382 Generate code for SH4-340 (no MMU, no FPU).
23384 @item -m4-500
23385 @opindex m4-500
23386 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23387 assembler.
23389 @item -m4a-nofpu
23390 @opindex m4a-nofpu
23391 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23392 floating-point unit is not used.
23394 @item -m4a-single-only
23395 @opindex m4a-single-only
23396 Generate code for the SH4a, in such a way that no double-precision
23397 floating-point operations are used.
23399 @item -m4a-single
23400 @opindex m4a-single
23401 Generate code for the SH4a assuming the floating-point unit is in
23402 single-precision mode by default.
23404 @item -m4a
23405 @opindex m4a
23406 Generate code for the SH4a.
23408 @item -m4al
23409 @opindex m4al
23410 Same as @option{-m4a-nofpu}, except that it implicitly passes
23411 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23412 instructions at the moment.
23414 @item -mb
23415 @opindex mb
23416 Compile code for the processor in big-endian mode.
23418 @item -ml
23419 @opindex ml
23420 Compile code for the processor in little-endian mode.
23422 @item -mdalign
23423 @opindex mdalign
23424 Align doubles at 64-bit boundaries.  Note that this changes the calling
23425 conventions, and thus some functions from the standard C library do
23426 not work unless you recompile it first with @option{-mdalign}.
23428 @item -mrelax
23429 @opindex mrelax
23430 Shorten some address references at link time, when possible; uses the
23431 linker option @option{-relax}.
23433 @item -mbigtable
23434 @opindex mbigtable
23435 Use 32-bit offsets in @code{switch} tables.  The default is to use
23436 16-bit offsets.
23438 @item -mbitops
23439 @opindex mbitops
23440 Enable the use of bit manipulation instructions on SH2A.
23442 @item -mfmovd
23443 @opindex mfmovd
23444 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23445 alignment constraints.
23447 @item -mrenesas
23448 @opindex mrenesas
23449 Comply with the calling conventions defined by Renesas.
23451 @item -mno-renesas
23452 @opindex mno-renesas
23453 Comply with the calling conventions defined for GCC before the Renesas
23454 conventions were available.  This option is the default for all
23455 targets of the SH toolchain.
23457 @item -mnomacsave
23458 @opindex mnomacsave
23459 Mark the @code{MAC} register as call-clobbered, even if
23460 @option{-mrenesas} is given.
23462 @item -mieee
23463 @itemx -mno-ieee
23464 @opindex mieee
23465 @opindex mno-ieee
23466 Control the IEEE compliance of floating-point comparisons, which affects the
23467 handling of cases where the result of a comparison is unordered.  By default
23468 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23469 enabled @option{-mno-ieee} is implicitly set, which results in faster
23470 floating-point greater-equal and less-equal comparisons.  The implicit settings
23471 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23473 @item -minline-ic_invalidate
23474 @opindex minline-ic_invalidate
23475 Inline code to invalidate instruction cache entries after setting up
23476 nested function trampolines.
23477 This option has no effect if @option{-musermode} is in effect and the selected
23478 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23479 instruction.
23480 If the selected code generation option does not allow the use of the @code{icbi}
23481 instruction, and @option{-musermode} is not in effect, the inlined code
23482 manipulates the instruction cache address array directly with an associative
23483 write.  This not only requires privileged mode at run time, but it also
23484 fails if the cache line had been mapped via the TLB and has become unmapped.
23486 @item -misize
23487 @opindex misize
23488 Dump instruction size and location in the assembly code.
23490 @item -mpadstruct
23491 @opindex mpadstruct
23492 This option is deprecated.  It pads structures to multiple of 4 bytes,
23493 which is incompatible with the SH ABI@.
23495 @item -matomic-model=@var{model}
23496 @opindex matomic-model=@var{model}
23497 Sets the model of atomic operations and additional parameters as a comma
23498 separated list.  For details on the atomic built-in functions see
23499 @ref{__atomic Builtins}.  The following models and parameters are supported:
23501 @table @samp
23503 @item none
23504 Disable compiler generated atomic sequences and emit library calls for atomic
23505 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23507 @item soft-gusa
23508 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23509 built-in functions.  The generated atomic sequences require additional support
23510 from the interrupt/exception handling code of the system and are only suitable
23511 for SH3* and SH4* single-core systems.  This option is enabled by default when
23512 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23513 this option also partially utilizes the hardware atomic instructions
23514 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23515 @samp{strict} is specified.  
23517 @item soft-tcb
23518 Generate software atomic sequences that use a variable in the thread control
23519 block.  This is a variation of the gUSA sequences which can also be used on
23520 SH1* and SH2* targets.  The generated atomic sequences require additional
23521 support from the interrupt/exception handling code of the system and are only
23522 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23523 parameter has to be specified as well.
23525 @item soft-imask
23526 Generate software atomic sequences that temporarily disable interrupts by
23527 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23528 in privileged mode and is only suitable for single-core systems.  Additional
23529 support from the interrupt/exception handling code of the system is not
23530 required.  This model is enabled by default when the target is
23531 @code{sh*-*-linux*} and SH1* or SH2*.
23533 @item hard-llcs
23534 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23535 instructions only.  This is only available on SH4A and is suitable for
23536 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23537 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23538 Code compiled with this option is also compatible with other software
23539 atomic model interrupt/exception handling systems if executed on an SH4A
23540 system.  Additional support from the interrupt/exception handling code of the
23541 system is not required for this model.
23543 @item gbr-offset=
23544 This parameter specifies the offset in bytes of the variable in the thread
23545 control block structure that should be used by the generated atomic sequences
23546 when the @samp{soft-tcb} model has been selected.  For other models this
23547 parameter is ignored.  The specified value must be an integer multiple of four
23548 and in the range 0-1020.
23550 @item strict
23551 This parameter prevents mixed usage of multiple atomic models, even if they
23552 are compatible, and makes the compiler generate atomic sequences of the
23553 specified model only.
23555 @end table
23557 @item -mtas
23558 @opindex mtas
23559 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23560 Notice that depending on the particular hardware and software configuration
23561 this can degrade overall performance due to the operand cache line flushes
23562 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23563 processors the @code{tas.b} instruction must be used with caution since it
23564 can result in data corruption for certain cache configurations.
23566 @item -mprefergot
23567 @opindex mprefergot
23568 When generating position-independent code, emit function calls using
23569 the Global Offset Table instead of the Procedure Linkage Table.
23571 @item -musermode
23572 @itemx -mno-usermode
23573 @opindex musermode
23574 @opindex mno-usermode
23575 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23576 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23577 inlined code would not work in user mode.  @option{-musermode} is the default
23578 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23579 @option{-musermode} has no effect, since there is no user mode.
23581 @item -multcost=@var{number}
23582 @opindex multcost=@var{number}
23583 Set the cost to assume for a multiply insn.
23585 @item -mdiv=@var{strategy}
23586 @opindex mdiv=@var{strategy}
23587 Set the division strategy to be used for integer division operations.
23588 @var{strategy} can be one of: 
23590 @table @samp
23592 @item call-div1
23593 Calls a library function that uses the single-step division instruction
23594 @code{div1} to perform the operation.  Division by zero calculates an
23595 unspecified result and does not trap.  This is the default except for SH4,
23596 SH2A and SHcompact.
23598 @item call-fp
23599 Calls a library function that performs the operation in double precision
23600 floating point.  Division by zero causes a floating-point exception.  This is
23601 the default for SHcompact with FPU.  Specifying this for targets that do not
23602 have a double precision FPU defaults to @code{call-div1}.
23604 @item call-table
23605 Calls a library function that uses a lookup table for small divisors and
23606 the @code{div1} instruction with case distinction for larger divisors.  Division
23607 by zero calculates an unspecified result and does not trap.  This is the default
23608 for SH4.  Specifying this for targets that do not have dynamic shift
23609 instructions defaults to @code{call-div1}.
23611 @end table
23613 When a division strategy has not been specified the default strategy is
23614 selected based on the current target.  For SH2A the default strategy is to
23615 use the @code{divs} and @code{divu} instructions instead of library function
23616 calls.
23618 @item -maccumulate-outgoing-args
23619 @opindex maccumulate-outgoing-args
23620 Reserve space once for outgoing arguments in the function prologue rather
23621 than around each call.  Generally beneficial for performance and size.  Also
23622 needed for unwinding to avoid changing the stack frame around conditional code.
23624 @item -mdivsi3_libfunc=@var{name}
23625 @opindex mdivsi3_libfunc=@var{name}
23626 Set the name of the library function used for 32-bit signed division to
23627 @var{name}.
23628 This only affects the name used in the @samp{call} division strategies, and
23629 the compiler still expects the same sets of input/output/clobbered registers as
23630 if this option were not present.
23632 @item -mfixed-range=@var{register-range}
23633 @opindex mfixed-range
23634 Generate code treating the given register range as fixed registers.
23635 A fixed register is one that the register allocator can not use.  This is
23636 useful when compiling kernel code.  A register range is specified as
23637 two registers separated by a dash.  Multiple register ranges can be
23638 specified separated by a comma.
23640 @item -mbranch-cost=@var{num}
23641 @opindex mbranch-cost=@var{num}
23642 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23643 make the compiler try to generate more branch-free code if possible.  
23644 If not specified the value is selected depending on the processor type that
23645 is being compiled for.
23647 @item -mzdcbranch
23648 @itemx -mno-zdcbranch
23649 @opindex mzdcbranch
23650 @opindex mno-zdcbranch
23651 Assume (do not assume) that zero displacement conditional branch instructions
23652 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23653 compiler prefers zero displacement branch code sequences.  This is
23654 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23655 disabled by specifying @option{-mno-zdcbranch}.
23657 @item -mcbranch-force-delay-slot
23658 @opindex mcbranch-force-delay-slot
23659 Force the usage of delay slots for conditional branches, which stuffs the delay
23660 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23661 this option is disabled.  It can be enabled to work around hardware bugs as
23662 found in the original SH7055.
23664 @item -mfused-madd
23665 @itemx -mno-fused-madd
23666 @opindex mfused-madd
23667 @opindex mno-fused-madd
23668 Generate code that uses (does not use) the floating-point multiply and
23669 accumulate instructions.  These instructions are generated by default
23670 if hardware floating point is used.  The machine-dependent
23671 @option{-mfused-madd} option is now mapped to the machine-independent
23672 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23673 mapped to @option{-ffp-contract=off}.
23675 @item -mfsca
23676 @itemx -mno-fsca
23677 @opindex mfsca
23678 @opindex mno-fsca
23679 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23680 and cosine approximations.  The option @option{-mfsca} must be used in
23681 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23682 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23683 approximations even if @option{-funsafe-math-optimizations} is in effect.
23685 @item -mfsrra
23686 @itemx -mno-fsrra
23687 @opindex mfsrra
23688 @opindex mno-fsrra
23689 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23690 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23691 in combination with @option{-funsafe-math-optimizations} and
23692 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23693 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23694 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23695 in effect.
23697 @item -mpretend-cmove
23698 @opindex mpretend-cmove
23699 Prefer zero-displacement conditional branches for conditional move instruction
23700 patterns.  This can result in faster code on the SH4 processor.
23702 @item -mfdpic
23703 @opindex fdpic
23704 Generate code using the FDPIC ABI.
23706 @end table
23708 @node Solaris 2 Options
23709 @subsection Solaris 2 Options
23710 @cindex Solaris 2 options
23712 These @samp{-m} options are supported on Solaris 2:
23714 @table @gcctabopt
23715 @item -mclear-hwcap
23716 @opindex mclear-hwcap
23717 @option{-mclear-hwcap} tells the compiler to remove the hardware
23718 capabilities generated by the Solaris assembler.  This is only necessary
23719 when object files use ISA extensions not supported by the current
23720 machine, but check at runtime whether or not to use them.
23722 @item -mimpure-text
23723 @opindex mimpure-text
23724 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23725 the compiler to not pass @option{-z text} to the linker when linking a
23726 shared object.  Using this option, you can link position-dependent
23727 code into a shared object.
23729 @option{-mimpure-text} suppresses the ``relocations remain against
23730 allocatable but non-writable sections'' linker error message.
23731 However, the necessary relocations trigger copy-on-write, and the
23732 shared object is not actually shared across processes.  Instead of
23733 using @option{-mimpure-text}, you should compile all source code with
23734 @option{-fpic} or @option{-fPIC}.
23736 @end table
23738 These switches are supported in addition to the above on Solaris 2:
23740 @table @gcctabopt
23741 @item -pthreads
23742 @opindex pthreads
23743 This is a synonym for @option{-pthread}.
23744 @end table
23746 @node SPARC Options
23747 @subsection SPARC Options
23748 @cindex SPARC options
23750 These @samp{-m} options are supported on the SPARC:
23752 @table @gcctabopt
23753 @item -mno-app-regs
23754 @itemx -mapp-regs
23755 @opindex mno-app-regs
23756 @opindex mapp-regs
23757 Specify @option{-mapp-regs} to generate output using the global registers
23758 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23759 global register 1, each global register 2 through 4 is then treated as an
23760 allocable register that is clobbered by function calls.  This is the default.
23762 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23763 specify @option{-mno-app-regs}.  You should compile libraries and system
23764 software with this option.
23766 @item -mflat
23767 @itemx -mno-flat
23768 @opindex mflat
23769 @opindex mno-flat
23770 With @option{-mflat}, the compiler does not generate save/restore instructions
23771 and uses a ``flat'' or single register window model.  This model is compatible
23772 with the regular register window model.  The local registers and the input
23773 registers (0--5) are still treated as ``call-saved'' registers and are
23774 saved on the stack as needed.
23776 With @option{-mno-flat} (the default), the compiler generates save/restore
23777 instructions (except for leaf functions).  This is the normal operating mode.
23779 @item -mfpu
23780 @itemx -mhard-float
23781 @opindex mfpu
23782 @opindex mhard-float
23783 Generate output containing floating-point instructions.  This is the
23784 default.
23786 @item -mno-fpu
23787 @itemx -msoft-float
23788 @opindex mno-fpu
23789 @opindex msoft-float
23790 Generate output containing library calls for floating point.
23791 @strong{Warning:} the requisite libraries are not available for all SPARC
23792 targets.  Normally the facilities of the machine's usual C compiler are
23793 used, but this cannot be done directly in cross-compilation.  You must make
23794 your own arrangements to provide suitable library functions for
23795 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23796 @samp{sparclite-*-*} do provide software floating-point support.
23798 @option{-msoft-float} changes the calling convention in the output file;
23799 therefore, it is only useful if you compile @emph{all} of a program with
23800 this option.  In particular, you need to compile @file{libgcc.a}, the
23801 library that comes with GCC, with @option{-msoft-float} in order for
23802 this to work.
23804 @item -mhard-quad-float
23805 @opindex mhard-quad-float
23806 Generate output containing quad-word (long double) floating-point
23807 instructions.
23809 @item -msoft-quad-float
23810 @opindex msoft-quad-float
23811 Generate output containing library calls for quad-word (long double)
23812 floating-point instructions.  The functions called are those specified
23813 in the SPARC ABI@.  This is the default.
23815 As of this writing, there are no SPARC implementations that have hardware
23816 support for the quad-word floating-point instructions.  They all invoke
23817 a trap handler for one of these instructions, and then the trap handler
23818 emulates the effect of the instruction.  Because of the trap handler overhead,
23819 this is much slower than calling the ABI library routines.  Thus the
23820 @option{-msoft-quad-float} option is the default.
23822 @item -mno-unaligned-doubles
23823 @itemx -munaligned-doubles
23824 @opindex mno-unaligned-doubles
23825 @opindex munaligned-doubles
23826 Assume that doubles have 8-byte alignment.  This is the default.
23828 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23829 alignment only if they are contained in another type, or if they have an
23830 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23831 Specifying this option avoids some rare compatibility problems with code
23832 generated by other compilers.  It is not the default because it results
23833 in a performance loss, especially for floating-point code.
23835 @item -muser-mode
23836 @itemx -mno-user-mode
23837 @opindex muser-mode
23838 @opindex mno-user-mode
23839 Do not generate code that can only run in supervisor mode.  This is relevant
23840 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23841 is the default.
23843 @item -mfaster-structs
23844 @itemx -mno-faster-structs
23845 @opindex mfaster-structs
23846 @opindex mno-faster-structs
23847 With @option{-mfaster-structs}, the compiler assumes that structures
23848 should have 8-byte alignment.  This enables the use of pairs of
23849 @code{ldd} and @code{std} instructions for copies in structure
23850 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23851 However, the use of this changed alignment directly violates the SPARC
23852 ABI@.  Thus, it's intended only for use on targets where the developer
23853 acknowledges that their resulting code is not directly in line with
23854 the rules of the ABI@.
23856 @item -mstd-struct-return
23857 @itemx -mno-std-struct-return
23858 @opindex mstd-struct-return
23859 @opindex mno-std-struct-return
23860 With @option{-mstd-struct-return}, the compiler generates checking code
23861 in functions returning structures or unions to detect size mismatches
23862 between the two sides of function calls, as per the 32-bit ABI@.
23864 The default is @option{-mno-std-struct-return}.  This option has no effect
23865 in 64-bit mode.
23867 @item -mlra
23868 @itemx -mno-lra
23869 @opindex mlra
23870 @opindex mno-lra
23871 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23872 so @option{-mno-lra} needs to be passed to get old Reload.
23874 @item -mcpu=@var{cpu_type}
23875 @opindex mcpu
23876 Set the instruction set, register set, and instruction scheduling parameters
23877 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23878 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23879 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23880 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23881 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23882 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23884 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23885 which selects the best architecture option for the host processor.
23886 @option{-mcpu=native} has no effect if GCC does not recognize
23887 the processor.
23889 Default instruction scheduling parameters are used for values that select
23890 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23891 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23893 Here is a list of each supported architecture and their supported
23894 implementations.
23896 @table @asis
23897 @item v7
23898 cypress, leon3v7
23900 @item v8
23901 supersparc, hypersparc, leon, leon3
23903 @item sparclite
23904 f930, f934, sparclite86x
23906 @item sparclet
23907 tsc701
23909 @item v9
23910 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23911 @end table
23913 By default (unless configured otherwise), GCC generates code for the V7
23914 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23915 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23916 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23917 SPARCStation 1, 2, IPX etc.
23919 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23920 architecture.  The only difference from V7 code is that the compiler emits
23921 the integer multiply and integer divide instructions which exist in SPARC-V8
23922 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23923 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23924 2000 series.
23926 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23927 the SPARC architecture.  This adds the integer multiply, integer divide step
23928 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23929 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23930 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23931 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23932 MB86934 chip, which is the more recent SPARClite with FPU@.
23934 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23935 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23936 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23937 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23938 optimizes it for the TEMIC SPARClet chip.
23940 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23941 architecture.  This adds 64-bit integer and floating-point move instructions,
23942 3 additional floating-point condition code registers and conditional move
23943 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23944 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23945 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23946 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23947 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23948 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23949 additionally optimizes it for Sun UltraSPARC T2 chips. With
23950 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23951 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23952 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23953 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23954 Oracle SPARC M7 chips.
23956 @item -mtune=@var{cpu_type}
23957 @opindex mtune
23958 Set the instruction scheduling parameters for machine type
23959 @var{cpu_type}, but do not set the instruction set or register set that the
23960 option @option{-mcpu=@var{cpu_type}} does.
23962 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23963 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23964 that select a particular CPU implementation.  Those are
23965 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23966 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23967 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23968 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23969 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23970 GNU/Linux toolchains, @samp{native} can also be used.
23972 @item -mv8plus
23973 @itemx -mno-v8plus
23974 @opindex mv8plus
23975 @opindex mno-v8plus
23976 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23977 difference from the V8 ABI is that the global and out registers are
23978 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23979 mode for all SPARC-V9 processors.
23981 @item -mvis
23982 @itemx -mno-vis
23983 @opindex mvis
23984 @opindex mno-vis
23985 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23986 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23988 @item -mvis2
23989 @itemx -mno-vis2
23990 @opindex mvis2
23991 @opindex mno-vis2
23992 With @option{-mvis2}, GCC generates code that takes advantage of
23993 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23994 default is @option{-mvis2} when targeting a cpu that supports such
23995 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23996 also sets @option{-mvis}.
23998 @item -mvis3
23999 @itemx -mno-vis3
24000 @opindex mvis3
24001 @opindex mno-vis3
24002 With @option{-mvis3}, GCC generates code that takes advantage of
24003 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24004 default is @option{-mvis3} when targeting a cpu that supports such
24005 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24006 also sets @option{-mvis2} and @option{-mvis}.
24008 @item -mvis4
24009 @itemx -mno-vis4
24010 @opindex mvis4
24011 @opindex mno-vis4
24012 With @option{-mvis4}, GCC generates code that takes advantage of
24013 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24014 default is @option{-mvis4} when targeting a cpu that supports such
24015 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24016 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24018 @item -mcbcond
24019 @itemx -mno-cbcond
24020 @opindex mcbcond
24021 @opindex mno-cbcond
24022 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24023 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24024 when targeting a CPU that supports such instructions, such as Niagara-4 and
24025 later.
24027 @item -mfmaf
24028 @itemx -mno-fmaf
24029 @opindex mfmaf
24030 @opindex mno-fmaf
24031 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24032 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24033 when targeting a CPU that supports such instructions, such as Niagara-3 and
24034 later.
24036 @item -mpopc
24037 @itemx -mno-popc
24038 @opindex mpopc
24039 @opindex mno-popc
24040 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24041 Population Count instruction.  The default is @option{-mpopc}
24042 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24043 later.
24045 @item -msubxc
24046 @itemx -mno-subxc
24047 @opindex msubxc
24048 @opindex mno-subxc
24049 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24050 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24051 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24052 later.
24054 @item -mfix-at697f
24055 @opindex mfix-at697f
24056 Enable the documented workaround for the single erratum of the Atmel AT697F
24057 processor (which corresponds to erratum #13 of the AT697E processor).
24059 @item -mfix-ut699
24060 @opindex mfix-ut699
24061 Enable the documented workarounds for the floating-point errata and the data
24062 cache nullify errata of the UT699 processor.
24063 @end table
24065 These @samp{-m} options are supported in addition to the above
24066 on SPARC-V9 processors in 64-bit environments:
24068 @table @gcctabopt
24069 @item -m32
24070 @itemx -m64
24071 @opindex m32
24072 @opindex m64
24073 Generate code for a 32-bit or 64-bit environment.
24074 The 32-bit environment sets int, long and pointer to 32 bits.
24075 The 64-bit environment sets int to 32 bits and long and pointer
24076 to 64 bits.
24078 @item -mcmodel=@var{which}
24079 @opindex mcmodel
24080 Set the code model to one of
24082 @table @samp
24083 @item medlow
24084 The Medium/Low code model: 64-bit addresses, programs
24085 must be linked in the low 32 bits of memory.  Programs can be statically
24086 or dynamically linked.
24088 @item medmid
24089 The Medium/Middle code model: 64-bit addresses, programs
24090 must be linked in the low 44 bits of memory, the text and data segments must
24091 be less than 2GB in size and the data segment must be located within 2GB of
24092 the text segment.
24094 @item medany
24095 The Medium/Anywhere code model: 64-bit addresses, programs
24096 may be linked anywhere in memory, the text and data segments must be less
24097 than 2GB in size and the data segment must be located within 2GB of the
24098 text segment.
24100 @item embmedany
24101 The Medium/Anywhere code model for embedded systems:
24102 64-bit addresses, the text and data segments must be less than 2GB in
24103 size, both starting anywhere in memory (determined at link time).  The
24104 global register %g4 points to the base of the data segment.  Programs
24105 are statically linked and PIC is not supported.
24106 @end table
24108 @item -mmemory-model=@var{mem-model}
24109 @opindex mmemory-model
24110 Set the memory model in force on the processor to one of
24112 @table @samp
24113 @item default
24114 The default memory model for the processor and operating system.
24116 @item rmo
24117 Relaxed Memory Order
24119 @item pso
24120 Partial Store Order
24122 @item tso
24123 Total Store Order
24125 @item sc
24126 Sequential Consistency
24127 @end table
24129 These memory models are formally defined in Appendix D of the SPARC-V9
24130 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24132 @item -mstack-bias
24133 @itemx -mno-stack-bias
24134 @opindex mstack-bias
24135 @opindex mno-stack-bias
24136 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24137 frame pointer if present, are offset by @minus{}2047 which must be added back
24138 when making stack frame references.  This is the default in 64-bit mode.
24139 Otherwise, assume no such offset is present.
24140 @end table
24142 @node SPU Options
24143 @subsection SPU Options
24144 @cindex SPU options
24146 These @samp{-m} options are supported on the SPU:
24148 @table @gcctabopt
24149 @item -mwarn-reloc
24150 @itemx -merror-reloc
24151 @opindex mwarn-reloc
24152 @opindex merror-reloc
24154 The loader for SPU does not handle dynamic relocations.  By default, GCC
24155 gives an error when it generates code that requires a dynamic
24156 relocation.  @option{-mno-error-reloc} disables the error,
24157 @option{-mwarn-reloc} generates a warning instead.
24159 @item -msafe-dma
24160 @itemx -munsafe-dma
24161 @opindex msafe-dma
24162 @opindex munsafe-dma
24164 Instructions that initiate or test completion of DMA must not be
24165 reordered with respect to loads and stores of the memory that is being
24166 accessed.
24167 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24168 memory accesses, but that can lead to inefficient code in places where the
24169 memory is known to not change.  Rather than mark the memory as volatile,
24170 you can use @option{-msafe-dma} to tell the compiler to treat
24171 the DMA instructions as potentially affecting all memory.  
24173 @item -mbranch-hints
24174 @opindex mbranch-hints
24176 By default, GCC generates a branch hint instruction to avoid
24177 pipeline stalls for always-taken or probably-taken branches.  A hint
24178 is not generated closer than 8 instructions away from its branch.
24179 There is little reason to disable them, except for debugging purposes,
24180 or to make an object a little bit smaller.
24182 @item -msmall-mem
24183 @itemx -mlarge-mem
24184 @opindex msmall-mem
24185 @opindex mlarge-mem
24187 By default, GCC generates code assuming that addresses are never larger
24188 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24189 a full 32-bit address.
24191 @item -mstdmain
24192 @opindex mstdmain
24194 By default, GCC links against startup code that assumes the SPU-style
24195 main function interface (which has an unconventional parameter list).
24196 With @option{-mstdmain}, GCC links your program against startup
24197 code that assumes a C99-style interface to @code{main}, including a
24198 local copy of @code{argv} strings.
24200 @item -mfixed-range=@var{register-range}
24201 @opindex mfixed-range
24202 Generate code treating the given register range as fixed registers.
24203 A fixed register is one that the register allocator cannot use.  This is
24204 useful when compiling kernel code.  A register range is specified as
24205 two registers separated by a dash.  Multiple register ranges can be
24206 specified separated by a comma.
24208 @item -mea32
24209 @itemx -mea64
24210 @opindex mea32
24211 @opindex mea64
24212 Compile code assuming that pointers to the PPU address space accessed
24213 via the @code{__ea} named address space qualifier are either 32 or 64
24214 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24215 all object code in an executable must be compiled with the same setting.
24217 @item -maddress-space-conversion
24218 @itemx -mno-address-space-conversion
24219 @opindex maddress-space-conversion
24220 @opindex mno-address-space-conversion
24221 Allow/disallow treating the @code{__ea} address space as superset
24222 of the generic address space.  This enables explicit type casts
24223 between @code{__ea} and generic pointer as well as implicit
24224 conversions of generic pointers to @code{__ea} pointers.  The
24225 default is to allow address space pointer conversions.
24227 @item -mcache-size=@var{cache-size}
24228 @opindex mcache-size
24229 This option controls the version of libgcc that the compiler links to an
24230 executable and selects a software-managed cache for accessing variables
24231 in the @code{__ea} address space with a particular cache size.  Possible
24232 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24233 and @samp{128}.  The default cache size is 64KB.
24235 @item -matomic-updates
24236 @itemx -mno-atomic-updates
24237 @opindex matomic-updates
24238 @opindex mno-atomic-updates
24239 This option controls the version of libgcc that the compiler links to an
24240 executable and selects whether atomic updates to the software-managed
24241 cache of PPU-side variables are used.  If you use atomic updates, changes
24242 to a PPU variable from SPU code using the @code{__ea} named address space
24243 qualifier do not interfere with changes to other PPU variables residing
24244 in the same cache line from PPU code.  If you do not use atomic updates,
24245 such interference may occur; however, writing back cache lines is
24246 more efficient.  The default behavior is to use atomic updates.
24248 @item -mdual-nops
24249 @itemx -mdual-nops=@var{n}
24250 @opindex mdual-nops
24251 By default, GCC inserts NOPs to increase dual issue when it expects
24252 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24253 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24254 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24256 @item -mhint-max-nops=@var{n}
24257 @opindex mhint-max-nops
24258 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24259 be at least 8 instructions away from the branch it is affecting.  GCC
24260 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24261 generate the branch hint.
24263 @item -mhint-max-distance=@var{n}
24264 @opindex mhint-max-distance
24265 The encoding of the branch hint instruction limits the hint to be within
24266 256 instructions of the branch it is affecting.  By default, GCC makes
24267 sure it is within 125.
24269 @item -msafe-hints
24270 @opindex msafe-hints
24271 Work around a hardware bug that causes the SPU to stall indefinitely.
24272 By default, GCC inserts the @code{hbrp} instruction to make sure
24273 this stall won't happen.
24275 @end table
24277 @node System V Options
24278 @subsection Options for System V
24280 These additional options are available on System V Release 4 for
24281 compatibility with other compilers on those systems:
24283 @table @gcctabopt
24284 @item -G
24285 @opindex G
24286 Create a shared object.
24287 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24289 @item -Qy
24290 @opindex Qy
24291 Identify the versions of each tool used by the compiler, in a
24292 @code{.ident} assembler directive in the output.
24294 @item -Qn
24295 @opindex Qn
24296 Refrain from adding @code{.ident} directives to the output file (this is
24297 the default).
24299 @item -YP,@var{dirs}
24300 @opindex YP
24301 Search the directories @var{dirs}, and no others, for libraries
24302 specified with @option{-l}.
24304 @item -Ym,@var{dir}
24305 @opindex Ym
24306 Look in the directory @var{dir} to find the M4 preprocessor.
24307 The assembler uses this option.
24308 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24309 @c the generic assembler that comes with Solaris takes just -Ym.
24310 @end table
24312 @node TILE-Gx Options
24313 @subsection TILE-Gx Options
24314 @cindex TILE-Gx options
24316 These @samp{-m} options are supported on the TILE-Gx:
24318 @table @gcctabopt
24319 @item -mcmodel=small
24320 @opindex mcmodel=small
24321 Generate code for the small model.  The distance for direct calls is
24322 limited to 500M in either direction.  PC-relative addresses are 32
24323 bits.  Absolute addresses support the full address range.
24325 @item -mcmodel=large
24326 @opindex mcmodel=large
24327 Generate code for the large model.  There is no limitation on call
24328 distance, pc-relative addresses, or absolute addresses.
24330 @item -mcpu=@var{name}
24331 @opindex mcpu
24332 Selects the type of CPU to be targeted.  Currently the only supported
24333 type is @samp{tilegx}.
24335 @item -m32
24336 @itemx -m64
24337 @opindex m32
24338 @opindex m64
24339 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24340 environment sets int, long, and pointer to 32 bits.  The 64-bit
24341 environment sets int to 32 bits and long and pointer to 64 bits.
24343 @item -mbig-endian
24344 @itemx -mlittle-endian
24345 @opindex mbig-endian
24346 @opindex mlittle-endian
24347 Generate code in big/little endian mode, respectively.
24348 @end table
24350 @node TILEPro Options
24351 @subsection TILEPro Options
24352 @cindex TILEPro options
24354 These @samp{-m} options are supported on the TILEPro:
24356 @table @gcctabopt
24357 @item -mcpu=@var{name}
24358 @opindex mcpu
24359 Selects the type of CPU to be targeted.  Currently the only supported
24360 type is @samp{tilepro}.
24362 @item -m32
24363 @opindex m32
24364 Generate code for a 32-bit environment, which sets int, long, and
24365 pointer to 32 bits.  This is the only supported behavior so the flag
24366 is essentially ignored.
24367 @end table
24369 @node V850 Options
24370 @subsection V850 Options
24371 @cindex V850 Options
24373 These @samp{-m} options are defined for V850 implementations:
24375 @table @gcctabopt
24376 @item -mlong-calls
24377 @itemx -mno-long-calls
24378 @opindex mlong-calls
24379 @opindex mno-long-calls
24380 Treat all calls as being far away (near).  If calls are assumed to be
24381 far away, the compiler always loads the function's address into a
24382 register, and calls indirect through the pointer.
24384 @item -mno-ep
24385 @itemx -mep
24386 @opindex mno-ep
24387 @opindex mep
24388 Do not optimize (do optimize) basic blocks that use the same index
24389 pointer 4 or more times to copy pointer into the @code{ep} register, and
24390 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24391 option is on by default if you optimize.
24393 @item -mno-prolog-function
24394 @itemx -mprolog-function
24395 @opindex mno-prolog-function
24396 @opindex mprolog-function
24397 Do not use (do use) external functions to save and restore registers
24398 at the prologue and epilogue of a function.  The external functions
24399 are slower, but use less code space if more than one function saves
24400 the same number of registers.  The @option{-mprolog-function} option
24401 is on by default if you optimize.
24403 @item -mspace
24404 @opindex mspace
24405 Try to make the code as small as possible.  At present, this just turns
24406 on the @option{-mep} and @option{-mprolog-function} options.
24408 @item -mtda=@var{n}
24409 @opindex mtda
24410 Put static or global variables whose size is @var{n} bytes or less into
24411 the tiny data area that register @code{ep} points to.  The tiny data
24412 area can hold up to 256 bytes in total (128 bytes for byte references).
24414 @item -msda=@var{n}
24415 @opindex msda
24416 Put static or global variables whose size is @var{n} bytes or less into
24417 the small data area that register @code{gp} points to.  The small data
24418 area can hold up to 64 kilobytes.
24420 @item -mzda=@var{n}
24421 @opindex mzda
24422 Put static or global variables whose size is @var{n} bytes or less into
24423 the first 32 kilobytes of memory.
24425 @item -mv850
24426 @opindex mv850
24427 Specify that the target processor is the V850.
24429 @item -mv850e3v5
24430 @opindex mv850e3v5
24431 Specify that the target processor is the V850E3V5.  The preprocessor
24432 constant @code{__v850e3v5__} is defined if this option is used.
24434 @item -mv850e2v4
24435 @opindex mv850e2v4
24436 Specify that the target processor is the V850E3V5.  This is an alias for
24437 the @option{-mv850e3v5} option.
24439 @item -mv850e2v3
24440 @opindex mv850e2v3
24441 Specify that the target processor is the V850E2V3.  The preprocessor
24442 constant @code{__v850e2v3__} is defined if this option is used.
24444 @item -mv850e2
24445 @opindex mv850e2
24446 Specify that the target processor is the V850E2.  The preprocessor
24447 constant @code{__v850e2__} is defined if this option is used.
24449 @item -mv850e1
24450 @opindex mv850e1
24451 Specify that the target processor is the V850E1.  The preprocessor
24452 constants @code{__v850e1__} and @code{__v850e__} are defined if
24453 this option is used.
24455 @item -mv850es
24456 @opindex mv850es
24457 Specify that the target processor is the V850ES.  This is an alias for
24458 the @option{-mv850e1} option.
24460 @item -mv850e
24461 @opindex mv850e
24462 Specify that the target processor is the V850E@.  The preprocessor
24463 constant @code{__v850e__} is defined if this option is used.
24465 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24466 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24467 are defined then a default target processor is chosen and the
24468 relevant @samp{__v850*__} preprocessor constant is defined.
24470 The preprocessor constants @code{__v850} and @code{__v851__} are always
24471 defined, regardless of which processor variant is the target.
24473 @item -mdisable-callt
24474 @itemx -mno-disable-callt
24475 @opindex mdisable-callt
24476 @opindex mno-disable-callt
24477 This option suppresses generation of the @code{CALLT} instruction for the
24478 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24479 architecture.
24481 This option is enabled by default when the RH850 ABI is
24482 in use (see @option{-mrh850-abi}), and disabled by default when the
24483 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24484 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24486 @item -mrelax
24487 @itemx -mno-relax
24488 @opindex mrelax
24489 @opindex mno-relax
24490 Pass on (or do not pass on) the @option{-mrelax} command-line option
24491 to the assembler.
24493 @item -mlong-jumps
24494 @itemx -mno-long-jumps
24495 @opindex mlong-jumps
24496 @opindex mno-long-jumps
24497 Disable (or re-enable) the generation of PC-relative jump instructions.
24499 @item -msoft-float
24500 @itemx -mhard-float
24501 @opindex msoft-float
24502 @opindex mhard-float
24503 Disable (or re-enable) the generation of hardware floating point
24504 instructions.  This option is only significant when the target
24505 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24506 instructions are being generated then the C preprocessor symbol
24507 @code{__FPU_OK__} is defined, otherwise the symbol
24508 @code{__NO_FPU__} is defined.
24510 @item -mloop
24511 @opindex mloop
24512 Enables the use of the e3v5 LOOP instruction.  The use of this
24513 instruction is not enabled by default when the e3v5 architecture is
24514 selected because its use is still experimental.
24516 @item -mrh850-abi
24517 @itemx -mghs
24518 @opindex mrh850-abi
24519 @opindex mghs
24520 Enables support for the RH850 version of the V850 ABI.  This is the
24521 default.  With this version of the ABI the following rules apply:
24523 @itemize
24524 @item
24525 Integer sized structures and unions are returned via a memory pointer
24526 rather than a register.
24528 @item
24529 Large structures and unions (more than 8 bytes in size) are passed by
24530 value.
24532 @item
24533 Functions are aligned to 16-bit boundaries.
24535 @item
24536 The @option{-m8byte-align} command-line option is supported.
24538 @item
24539 The @option{-mdisable-callt} command-line option is enabled by
24540 default.  The @option{-mno-disable-callt} command-line option is not
24541 supported.
24542 @end itemize
24544 When this version of the ABI is enabled the C preprocessor symbol
24545 @code{__V850_RH850_ABI__} is defined.
24547 @item -mgcc-abi
24548 @opindex mgcc-abi
24549 Enables support for the old GCC version of the V850 ABI.  With this
24550 version of the ABI the following rules apply:
24552 @itemize
24553 @item
24554 Integer sized structures and unions are returned in register @code{r10}.
24556 @item
24557 Large structures and unions (more than 8 bytes in size) are passed by
24558 reference.
24560 @item
24561 Functions are aligned to 32-bit boundaries, unless optimizing for
24562 size.
24564 @item
24565 The @option{-m8byte-align} command-line option is not supported.
24567 @item
24568 The @option{-mdisable-callt} command-line option is supported but not
24569 enabled by default.
24570 @end itemize
24572 When this version of the ABI is enabled the C preprocessor symbol
24573 @code{__V850_GCC_ABI__} is defined.
24575 @item -m8byte-align
24576 @itemx -mno-8byte-align
24577 @opindex m8byte-align
24578 @opindex mno-8byte-align
24579 Enables support for @code{double} and @code{long long} types to be
24580 aligned on 8-byte boundaries.  The default is to restrict the
24581 alignment of all objects to at most 4-bytes.  When
24582 @option{-m8byte-align} is in effect the C preprocessor symbol
24583 @code{__V850_8BYTE_ALIGN__} is defined.
24585 @item -mbig-switch
24586 @opindex mbig-switch
24587 Generate code suitable for big switch tables.  Use this option only if
24588 the assembler/linker complain about out of range branches within a switch
24589 table.
24591 @item -mapp-regs
24592 @opindex mapp-regs
24593 This option causes r2 and r5 to be used in the code generated by
24594 the compiler.  This setting is the default.
24596 @item -mno-app-regs
24597 @opindex mno-app-regs
24598 This option causes r2 and r5 to be treated as fixed registers.
24600 @end table
24602 @node VAX Options
24603 @subsection VAX Options
24604 @cindex VAX options
24606 These @samp{-m} options are defined for the VAX:
24608 @table @gcctabopt
24609 @item -munix
24610 @opindex munix
24611 Do not output certain jump instructions (@code{aobleq} and so on)
24612 that the Unix assembler for the VAX cannot handle across long
24613 ranges.
24615 @item -mgnu
24616 @opindex mgnu
24617 Do output those jump instructions, on the assumption that the
24618 GNU assembler is being used.
24620 @item -mg
24621 @opindex mg
24622 Output code for G-format floating-point numbers instead of D-format.
24623 @end table
24625 @node Visium Options
24626 @subsection Visium Options
24627 @cindex Visium options
24629 @table @gcctabopt
24631 @item -mdebug
24632 @opindex mdebug
24633 A program which performs file I/O and is destined to run on an MCM target
24634 should be linked with this option.  It causes the libraries libc.a and
24635 libdebug.a to be linked.  The program should be run on the target under
24636 the control of the GDB remote debugging stub.
24638 @item -msim
24639 @opindex msim
24640 A program which performs file I/O and is destined to run on the simulator
24641 should be linked with option.  This causes libraries libc.a and libsim.a to
24642 be linked.
24644 @item -mfpu
24645 @itemx -mhard-float
24646 @opindex mfpu
24647 @opindex mhard-float
24648 Generate code containing floating-point instructions.  This is the
24649 default.
24651 @item -mno-fpu
24652 @itemx -msoft-float
24653 @opindex mno-fpu
24654 @opindex msoft-float
24655 Generate code containing library calls for floating-point.
24657 @option{-msoft-float} changes the calling convention in the output file;
24658 therefore, it is only useful if you compile @emph{all} of a program with
24659 this option.  In particular, you need to compile @file{libgcc.a}, the
24660 library that comes with GCC, with @option{-msoft-float} in order for
24661 this to work.
24663 @item -mcpu=@var{cpu_type}
24664 @opindex mcpu
24665 Set the instruction set, register set, and instruction scheduling parameters
24666 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24667 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24669 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24671 By default (unless configured otherwise), GCC generates code for the GR5
24672 variant of the Visium architecture.  
24674 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24675 architecture.  The only difference from GR5 code is that the compiler will
24676 generate block move instructions.
24678 @item -mtune=@var{cpu_type}
24679 @opindex mtune
24680 Set the instruction scheduling parameters for machine type @var{cpu_type},
24681 but do not set the instruction set or register set that the option
24682 @option{-mcpu=@var{cpu_type}} would.
24684 @item -msv-mode
24685 @opindex msv-mode
24686 Generate code for the supervisor mode, where there are no restrictions on
24687 the access to general registers.  This is the default.
24689 @item -muser-mode
24690 @opindex muser-mode
24691 Generate code for the user mode, where the access to some general registers
24692 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24693 mode; on the GR6, only registers r29 to r31 are affected.
24694 @end table
24696 @node VMS Options
24697 @subsection VMS Options
24699 These @samp{-m} options are defined for the VMS implementations:
24701 @table @gcctabopt
24702 @item -mvms-return-codes
24703 @opindex mvms-return-codes
24704 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24705 condition (e.g.@ error) codes.
24707 @item -mdebug-main=@var{prefix}
24708 @opindex mdebug-main=@var{prefix}
24709 Flag the first routine whose name starts with @var{prefix} as the main
24710 routine for the debugger.
24712 @item -mmalloc64
24713 @opindex mmalloc64
24714 Default to 64-bit memory allocation routines.
24716 @item -mpointer-size=@var{size}
24717 @opindex mpointer-size=@var{size}
24718 Set the default size of pointers. Possible options for @var{size} are
24719 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24720 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24721 The later option disables @code{pragma pointer_size}.
24722 @end table
24724 @node VxWorks Options
24725 @subsection VxWorks Options
24726 @cindex VxWorks Options
24728 The options in this section are defined for all VxWorks targets.
24729 Options specific to the target hardware are listed with the other
24730 options for that target.
24732 @table @gcctabopt
24733 @item -mrtp
24734 @opindex mrtp
24735 GCC can generate code for both VxWorks kernels and real time processes
24736 (RTPs).  This option switches from the former to the latter.  It also
24737 defines the preprocessor macro @code{__RTP__}.
24739 @item -non-static
24740 @opindex non-static
24741 Link an RTP executable against shared libraries rather than static
24742 libraries.  The options @option{-static} and @option{-shared} can
24743 also be used for RTPs (@pxref{Link Options}); @option{-static}
24744 is the default.
24746 @item -Bstatic
24747 @itemx -Bdynamic
24748 @opindex Bstatic
24749 @opindex Bdynamic
24750 These options are passed down to the linker.  They are defined for
24751 compatibility with Diab.
24753 @item -Xbind-lazy
24754 @opindex Xbind-lazy
24755 Enable lazy binding of function calls.  This option is equivalent to
24756 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24758 @item -Xbind-now
24759 @opindex Xbind-now
24760 Disable lazy binding of function calls.  This option is the default and
24761 is defined for compatibility with Diab.
24762 @end table
24764 @node x86 Options
24765 @subsection x86 Options
24766 @cindex x86 Options
24768 These @samp{-m} options are defined for the x86 family of computers.
24770 @table @gcctabopt
24772 @item -march=@var{cpu-type}
24773 @opindex march
24774 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24775 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24776 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24777 to generate code that may not run at all on processors other than the one
24778 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24779 @option{-mtune=@var{cpu-type}}.
24781 The choices for @var{cpu-type} are:
24783 @table @samp
24784 @item native
24785 This selects the CPU to generate code for at compilation time by determining
24786 the processor type of the compiling machine.  Using @option{-march=native}
24787 enables all instruction subsets supported by the local machine (hence
24788 the result might not run on different machines).  Using @option{-mtune=native}
24789 produces code optimized for the local machine under the constraints
24790 of the selected instruction set.  
24792 @item i386
24793 Original Intel i386 CPU@.
24795 @item i486
24796 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24798 @item i586
24799 @itemx pentium
24800 Intel Pentium CPU with no MMX support.
24802 @item lakemont
24803 Intel Lakemont MCU, based on Intel Pentium CPU.
24805 @item pentium-mmx
24806 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24808 @item pentiumpro
24809 Intel Pentium Pro CPU@.
24811 @item i686
24812 When used with @option{-march}, the Pentium Pro
24813 instruction set is used, so the code runs on all i686 family chips.
24814 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24816 @item pentium2
24817 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24818 support.
24820 @item pentium3
24821 @itemx pentium3m
24822 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24823 set support.
24825 @item pentium-m
24826 Intel Pentium M; low-power version of Intel Pentium III CPU
24827 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24829 @item pentium4
24830 @itemx pentium4m
24831 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24833 @item prescott
24834 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24835 set support.
24837 @item nocona
24838 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24839 SSE2 and SSE3 instruction set support.
24841 @item core2
24842 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24843 instruction set support.
24845 @item nehalem
24846 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24847 SSE4.1, SSE4.2 and POPCNT instruction set support.
24849 @item westmere
24850 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24851 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24853 @item sandybridge
24854 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24855 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24857 @item ivybridge
24858 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24859 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24860 instruction set support.
24862 @item haswell
24863 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24864 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24865 BMI, BMI2 and F16C instruction set support.
24867 @item broadwell
24868 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24869 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24870 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24872 @item skylake
24873 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24874 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24875 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24876 XSAVES instruction set support.
24878 @item bonnell
24879 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24880 instruction set support.
24882 @item silvermont
24883 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24884 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24886 @item knl
24887 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24888 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24889 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24890 AVX512CD instruction set support.
24892 @item skylake-avx512
24893 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24894 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24895 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24896 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24898 @item k6
24899 AMD K6 CPU with MMX instruction set support.
24901 @item k6-2
24902 @itemx k6-3
24903 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24905 @item athlon
24906 @itemx athlon-tbird
24907 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24908 support.
24910 @item athlon-4
24911 @itemx athlon-xp
24912 @itemx athlon-mp
24913 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24914 instruction set support.
24916 @item k8
24917 @itemx opteron
24918 @itemx athlon64
24919 @itemx athlon-fx
24920 Processors based on the AMD K8 core with x86-64 instruction set support,
24921 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24922 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24923 instruction set extensions.)
24925 @item k8-sse3
24926 @itemx opteron-sse3
24927 @itemx athlon64-sse3
24928 Improved versions of AMD K8 cores with SSE3 instruction set support.
24930 @item amdfam10
24931 @itemx barcelona
24932 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24933 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24934 instruction set extensions.)
24936 @item bdver1
24937 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24938 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24939 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24940 @item bdver2
24941 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24942 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24943 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24944 extensions.)
24945 @item bdver3
24946 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24947 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24948 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24949 64-bit instruction set extensions.
24950 @item bdver4
24951 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24952 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24953 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24954 SSE4.2, ABM and 64-bit instruction set extensions.
24956 @item znver1
24957 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24958 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24959 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24960 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24961 instruction set extensions.
24963 @item btver1
24964 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24965 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24966 instruction set extensions.)
24968 @item btver2
24969 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24970 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24971 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24973 @item winchip-c6
24974 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24975 set support.
24977 @item winchip2
24978 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24979 instruction set support.
24981 @item c3
24982 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24983 (No scheduling is implemented for this chip.)
24985 @item c3-2
24986 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24987 (No scheduling is implemented for this chip.)
24989 @item c7
24990 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24991 (No scheduling is implemented for this chip.)
24993 @item samuel-2
24994 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24995 (No scheduling is implemented for this chip.)
24997 @item nehemiah
24998 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24999 (No scheduling is implemented for this chip.)
25001 @item esther
25002 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25003 (No scheduling is implemented for this chip.)
25005 @item eden-x2
25006 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25007 (No scheduling is implemented for this chip.)
25009 @item eden-x4
25010 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25011 AVX and AVX2 instruction set support.
25012 (No scheduling is implemented for this chip.)
25014 @item nano
25015 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25016 instruction set support.
25017 (No scheduling is implemented for this chip.)
25019 @item nano-1000
25020 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25021 instruction set support.
25022 (No scheduling is implemented for this chip.)
25024 @item nano-2000
25025 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25026 instruction set support.
25027 (No scheduling is implemented for this chip.)
25029 @item nano-3000
25030 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25031 instruction set support.
25032 (No scheduling is implemented for this chip.)
25034 @item nano-x2
25035 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25036 instruction set support.
25037 (No scheduling is implemented for this chip.)
25039 @item nano-x4
25040 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25041 instruction set support.
25042 (No scheduling is implemented for this chip.)
25044 @item geode
25045 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25046 @end table
25048 @item -mtune=@var{cpu-type}
25049 @opindex mtune
25050 Tune to @var{cpu-type} everything applicable about the generated code, except
25051 for the ABI and the set of available instructions.  
25052 While picking a specific @var{cpu-type} schedules things appropriately
25053 for that particular chip, the compiler does not generate any code that
25054 cannot run on the default machine type unless you use a
25055 @option{-march=@var{cpu-type}} option.
25056 For example, if GCC is configured for i686-pc-linux-gnu
25057 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25058 but still runs on i686 machines.
25060 The choices for @var{cpu-type} are the same as for @option{-march}.
25061 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25063 @table @samp
25064 @item generic
25065 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25066 If you know the CPU on which your code will run, then you should use
25067 the corresponding @option{-mtune} or @option{-march} option instead of
25068 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25069 of your application will have, then you should use this option.
25071 As new processors are deployed in the marketplace, the behavior of this
25072 option will change.  Therefore, if you upgrade to a newer version of
25073 GCC, code generation controlled by this option will change to reflect
25074 the processors
25075 that are most common at the time that version of GCC is released.
25077 There is no @option{-march=generic} option because @option{-march}
25078 indicates the instruction set the compiler can use, and there is no
25079 generic instruction set applicable to all processors.  In contrast,
25080 @option{-mtune} indicates the processor (or, in this case, collection of
25081 processors) for which the code is optimized.
25083 @item intel
25084 Produce code optimized for the most current Intel processors, which are
25085 Haswell and Silvermont for this version of GCC.  If you know the CPU
25086 on which your code will run, then you should use the corresponding
25087 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25088 But, if you want your application performs better on both Haswell and
25089 Silvermont, then you should use this option.
25091 As new Intel processors are deployed in the marketplace, the behavior of
25092 this option will change.  Therefore, if you upgrade to a newer version of
25093 GCC, code generation controlled by this option will change to reflect
25094 the most current Intel processors at the time that version of GCC is
25095 released.
25097 There is no @option{-march=intel} option because @option{-march} indicates
25098 the instruction set the compiler can use, and there is no common
25099 instruction set applicable to all processors.  In contrast,
25100 @option{-mtune} indicates the processor (or, in this case, collection of
25101 processors) for which the code is optimized.
25102 @end table
25104 @item -mcpu=@var{cpu-type}
25105 @opindex mcpu
25106 A deprecated synonym for @option{-mtune}.
25108 @item -mfpmath=@var{unit}
25109 @opindex mfpmath
25110 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25111 for @var{unit} are:
25113 @table @samp
25114 @item 387
25115 Use the standard 387 floating-point coprocessor present on the majority of chips and
25116 emulated otherwise.  Code compiled with this option runs almost everywhere.
25117 The temporary results are computed in 80-bit precision instead of the precision
25118 specified by the type, resulting in slightly different results compared to most
25119 of other chips.  See @option{-ffloat-store} for more detailed description.
25121 This is the default choice for non-Darwin x86-32 targets.
25123 @item sse
25124 Use scalar floating-point instructions present in the SSE instruction set.
25125 This instruction set is supported by Pentium III and newer chips,
25126 and in the AMD line
25127 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25128 instruction set supports only single-precision arithmetic, thus the double and
25129 extended-precision arithmetic are still done using 387.  A later version, present
25130 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25131 arithmetic too.
25133 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25134 or @option{-msse2} switches to enable SSE extensions and make this option
25135 effective.  For the x86-64 compiler, these extensions are enabled by default.
25137 The resulting code should be considerably faster in the majority of cases and avoid
25138 the numerical instability problems of 387 code, but may break some existing
25139 code that expects temporaries to be 80 bits.
25141 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25142 and the default choice for x86-32 targets with the SSE2 instruction set
25143 when @option{-ffast-math} is enabled.
25145 @item sse,387
25146 @itemx sse+387
25147 @itemx both
25148 Attempt to utilize both instruction sets at once.  This effectively doubles the
25149 amount of available registers, and on chips with separate execution units for
25150 387 and SSE the execution resources too.  Use this option with care, as it is
25151 still experimental, because the GCC register allocator does not model separate
25152 functional units well, resulting in unstable performance.
25153 @end table
25155 @item -masm=@var{dialect}
25156 @opindex masm=@var{dialect}
25157 Output assembly instructions using selected @var{dialect}.  Also affects
25158 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25159 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25160 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25161 not support @samp{intel}.
25163 @item -mieee-fp
25164 @itemx -mno-ieee-fp
25165 @opindex mieee-fp
25166 @opindex mno-ieee-fp
25167 Control whether or not the compiler uses IEEE floating-point
25168 comparisons.  These correctly handle the case where the result of a
25169 comparison is unordered.
25171 @item -m80387
25172 @item -mhard-float
25173 @opindex 80387
25174 @opindex mhard-float
25175 Generate output containing 80387 instructions for floating point.
25177 @item -mno-80387
25178 @item -msoft-float
25179 @opindex no-80387
25180 @opindex msoft-float
25181 Generate output containing library calls for floating point.
25183 @strong{Warning:} the requisite libraries are not part of GCC@.
25184 Normally the facilities of the machine's usual C compiler are used, but
25185 this cannot be done directly in cross-compilation.  You must make your
25186 own arrangements to provide suitable library functions for
25187 cross-compilation.
25189 On machines where a function returns floating-point results in the 80387
25190 register stack, some floating-point opcodes may be emitted even if
25191 @option{-msoft-float} is used.
25193 @item -mno-fp-ret-in-387
25194 @opindex mno-fp-ret-in-387
25195 Do not use the FPU registers for return values of functions.
25197 The usual calling convention has functions return values of types
25198 @code{float} and @code{double} in an FPU register, even if there
25199 is no FPU@.  The idea is that the operating system should emulate
25200 an FPU@.
25202 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25203 in ordinary CPU registers instead.
25205 @item -mno-fancy-math-387
25206 @opindex mno-fancy-math-387
25207 Some 387 emulators do not support the @code{sin}, @code{cos} and
25208 @code{sqrt} instructions for the 387.  Specify this option to avoid
25209 generating those instructions.  This option is the default on
25210 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25211 indicates that the target CPU always has an FPU and so the
25212 instruction does not need emulation.  These
25213 instructions are not generated unless you also use the
25214 @option{-funsafe-math-optimizations} switch.
25216 @item -malign-double
25217 @itemx -mno-align-double
25218 @opindex malign-double
25219 @opindex mno-align-double
25220 Control whether GCC aligns @code{double}, @code{long double}, and
25221 @code{long long} variables on a two-word boundary or a one-word
25222 boundary.  Aligning @code{double} variables on a two-word boundary
25223 produces code that runs somewhat faster on a Pentium at the
25224 expense of more memory.
25226 On x86-64, @option{-malign-double} is enabled by default.
25228 @strong{Warning:} if you use the @option{-malign-double} switch,
25229 structures containing the above types are aligned differently than
25230 the published application binary interface specifications for the x86-32
25231 and are not binary compatible with structures in code compiled
25232 without that switch.
25234 @item -m96bit-long-double
25235 @itemx -m128bit-long-double
25236 @opindex m96bit-long-double
25237 @opindex m128bit-long-double
25238 These switches control the size of @code{long double} type.  The x86-32
25239 application binary interface specifies the size to be 96 bits,
25240 so @option{-m96bit-long-double} is the default in 32-bit mode.
25242 Modern architectures (Pentium and newer) prefer @code{long double}
25243 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25244 conforming to the ABI, this is not possible.  So specifying
25245 @option{-m128bit-long-double} aligns @code{long double}
25246 to a 16-byte boundary by padding the @code{long double} with an additional
25247 32-bit zero.
25249 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25250 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25252 Notice that neither of these options enable any extra precision over the x87
25253 standard of 80 bits for a @code{long double}.
25255 @strong{Warning:} if you override the default value for your target ABI, this
25256 changes the size of 
25257 structures and arrays containing @code{long double} variables,
25258 as well as modifying the function calling convention for functions taking
25259 @code{long double}.  Hence they are not binary-compatible
25260 with code compiled without that switch.
25262 @item -mlong-double-64
25263 @itemx -mlong-double-80
25264 @itemx -mlong-double-128
25265 @opindex mlong-double-64
25266 @opindex mlong-double-80
25267 @opindex mlong-double-128
25268 These switches control the size of @code{long double} type. A size
25269 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25270 type. This is the default for 32-bit Bionic C library.  A size
25271 of 128 bits makes the @code{long double} type equivalent to the
25272 @code{__float128} type. This is the default for 64-bit Bionic C library.
25274 @strong{Warning:} if you override the default value for your target ABI, this
25275 changes the size of
25276 structures and arrays containing @code{long double} variables,
25277 as well as modifying the function calling convention for functions taking
25278 @code{long double}.  Hence they are not binary-compatible
25279 with code compiled without that switch.
25281 @item -malign-data=@var{type}
25282 @opindex malign-data
25283 Control how GCC aligns variables.  Supported values for @var{type} are
25284 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25285 and earlier, @samp{abi} uses alignment value as specified by the
25286 psABI, and @samp{cacheline} uses increased alignment value to match
25287 the cache line size.  @samp{compat} is the default.
25289 @item -mlarge-data-threshold=@var{threshold}
25290 @opindex mlarge-data-threshold
25291 When @option{-mcmodel=medium} is specified, data objects larger than
25292 @var{threshold} are placed in the large data section.  This value must be the
25293 same across all objects linked into the binary, and defaults to 65535.
25295 @item -mrtd
25296 @opindex mrtd
25297 Use a different function-calling convention, in which functions that
25298 take a fixed number of arguments return with the @code{ret @var{num}}
25299 instruction, which pops their arguments while returning.  This saves one
25300 instruction in the caller since there is no need to pop the arguments
25301 there.
25303 You can specify that an individual function is called with this calling
25304 sequence with the function attribute @code{stdcall}.  You can also
25305 override the @option{-mrtd} option by using the function attribute
25306 @code{cdecl}.  @xref{Function Attributes}.
25308 @strong{Warning:} this calling convention is incompatible with the one
25309 normally used on Unix, so you cannot use it if you need to call
25310 libraries compiled with the Unix compiler.
25312 Also, you must provide function prototypes for all functions that
25313 take variable numbers of arguments (including @code{printf});
25314 otherwise incorrect code is generated for calls to those
25315 functions.
25317 In addition, seriously incorrect code results if you call a
25318 function with too many arguments.  (Normally, extra arguments are
25319 harmlessly ignored.)
25321 @item -mregparm=@var{num}
25322 @opindex mregparm
25323 Control how many registers are used to pass integer arguments.  By
25324 default, no registers are used to pass arguments, and at most 3
25325 registers can be used.  You can control this behavior for a specific
25326 function by using the function attribute @code{regparm}.
25327 @xref{Function Attributes}.
25329 @strong{Warning:} if you use this switch, and
25330 @var{num} is nonzero, then you must build all modules with the same
25331 value, including any libraries.  This includes the system libraries and
25332 startup modules.
25334 @item -msseregparm
25335 @opindex msseregparm
25336 Use SSE register passing conventions for float and double arguments
25337 and return values.  You can control this behavior for a specific
25338 function by using the function attribute @code{sseregparm}.
25339 @xref{Function Attributes}.
25341 @strong{Warning:} if you use this switch then you must build all
25342 modules with the same value, including any libraries.  This includes
25343 the system libraries and startup modules.
25345 @item -mvect8-ret-in-mem
25346 @opindex mvect8-ret-in-mem
25347 Return 8-byte vectors in memory instead of MMX registers.  This is the
25348 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25349 Studio compilers until version 12.  Later compiler versions (starting
25350 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25351 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25352 you need to remain compatible with existing code produced by those
25353 previous compiler versions or older versions of GCC@.
25355 @item -mpc32
25356 @itemx -mpc64
25357 @itemx -mpc80
25358 @opindex mpc32
25359 @opindex mpc64
25360 @opindex mpc80
25362 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25363 is specified, the significands of results of floating-point operations are
25364 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25365 significands of results of floating-point operations to 53 bits (double
25366 precision) and @option{-mpc80} rounds the significands of results of
25367 floating-point operations to 64 bits (extended double precision), which is
25368 the default.  When this option is used, floating-point operations in higher
25369 precisions are not available to the programmer without setting the FPU
25370 control word explicitly.
25372 Setting the rounding of floating-point operations to less than the default
25373 80 bits can speed some programs by 2% or more.  Note that some mathematical
25374 libraries assume that extended-precision (80-bit) floating-point operations
25375 are enabled by default; routines in such libraries could suffer significant
25376 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25377 when this option is used to set the precision to less than extended precision.
25379 @item -mstackrealign
25380 @opindex mstackrealign
25381 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25382 option generates an alternate prologue and epilogue that realigns the
25383 run-time stack if necessary.  This supports mixing legacy codes that keep
25384 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25385 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25386 applicable to individual functions.
25388 @item -mpreferred-stack-boundary=@var{num}
25389 @opindex mpreferred-stack-boundary
25390 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25391 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25392 the default is 4 (16 bytes or 128 bits).
25394 @strong{Warning:} When generating code for the x86-64 architecture with
25395 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25396 used to keep the stack boundary aligned to 8 byte boundary.  Since
25397 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25398 intended to be used in controlled environment where stack space is
25399 important limitation.  This option leads to wrong code when functions
25400 compiled with 16 byte stack alignment (such as functions from a standard
25401 library) are called with misaligned stack.  In this case, SSE
25402 instructions may lead to misaligned memory access traps.  In addition,
25403 variable arguments are handled incorrectly for 16 byte aligned
25404 objects (including x87 long double and __int128), leading to wrong
25405 results.  You must build all modules with
25406 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25407 includes the system libraries and startup modules.
25409 @item -mincoming-stack-boundary=@var{num}
25410 @opindex mincoming-stack-boundary
25411 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25412 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25413 the one specified by @option{-mpreferred-stack-boundary} is used.
25415 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25416 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25417 suffer significant run time performance penalties.  On Pentium III, the
25418 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25419 properly if it is not 16-byte aligned.
25421 To ensure proper alignment of this values on the stack, the stack boundary
25422 must be as aligned as that required by any value stored on the stack.
25423 Further, every function must be generated such that it keeps the stack
25424 aligned.  Thus calling a function compiled with a higher preferred
25425 stack boundary from a function compiled with a lower preferred stack
25426 boundary most likely misaligns the stack.  It is recommended that
25427 libraries that use callbacks always use the default setting.
25429 This extra alignment does consume extra stack space, and generally
25430 increases code size.  Code that is sensitive to stack space usage, such
25431 as embedded systems and operating system kernels, may want to reduce the
25432 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25434 @need 200
25435 @item -mmmx
25436 @opindex mmmx
25437 @need 200
25438 @itemx -msse
25439 @opindex msse
25440 @need 200
25441 @itemx -msse2
25442 @opindex msse2
25443 @need 200
25444 @itemx -msse3
25445 @opindex msse3
25446 @need 200
25447 @itemx -mssse3
25448 @opindex mssse3
25449 @need 200
25450 @itemx -msse4
25451 @opindex msse4
25452 @need 200
25453 @itemx -msse4a
25454 @opindex msse4a
25455 @need 200
25456 @itemx -msse4.1
25457 @opindex msse4.1
25458 @need 200
25459 @itemx -msse4.2
25460 @opindex msse4.2
25461 @need 200
25462 @itemx -mavx
25463 @opindex mavx
25464 @need 200
25465 @itemx -mavx2
25466 @opindex mavx2
25467 @need 200
25468 @itemx -mavx512f
25469 @opindex mavx512f
25470 @need 200
25471 @itemx -mavx512pf
25472 @opindex mavx512pf
25473 @need 200
25474 @itemx -mavx512er
25475 @opindex mavx512er
25476 @need 200
25477 @itemx -mavx512cd
25478 @opindex mavx512cd
25479 @need 200
25480 @itemx -mavx512vl
25481 @opindex mavx512vl
25482 @need 200
25483 @itemx -mavx512bw
25484 @opindex mavx512bw
25485 @need 200
25486 @itemx -mavx512dq
25487 @opindex mavx512dq
25488 @need 200
25489 @itemx -mavx512ifma
25490 @opindex mavx512ifma
25491 @need 200
25492 @itemx -mavx512vbmi
25493 @opindex mavx512vbmi
25494 @need 200
25495 @itemx -msha
25496 @opindex msha
25497 @need 200
25498 @itemx -maes
25499 @opindex maes
25500 @need 200
25501 @itemx -mpclmul
25502 @opindex mpclmul
25503 @need 200
25504 @itemx -mclfushopt
25505 @opindex mclfushopt
25506 @need 200
25507 @itemx -mfsgsbase
25508 @opindex mfsgsbase
25509 @need 200
25510 @itemx -mrdrnd
25511 @opindex mrdrnd
25512 @need 200
25513 @itemx -mf16c
25514 @opindex mf16c
25515 @need 200
25516 @itemx -mfma
25517 @opindex mfma
25518 @need 200
25519 @itemx -mfma4
25520 @opindex mfma4
25521 @need 200
25522 @itemx -mprefetchwt1
25523 @opindex mprefetchwt1
25524 @need 200
25525 @itemx -mxop
25526 @opindex mxop
25527 @need 200
25528 @itemx -mlwp
25529 @opindex mlwp
25530 @need 200
25531 @itemx -m3dnow
25532 @opindex m3dnow
25533 @need 200
25534 @itemx -m3dnowa
25535 @opindex m3dnowa
25536 @need 200
25537 @itemx -mpopcnt
25538 @opindex mpopcnt
25539 @need 200
25540 @itemx -mabm
25541 @opindex mabm
25542 @need 200
25543 @itemx -mbmi
25544 @opindex mbmi
25545 @need 200
25546 @itemx -mbmi2
25547 @need 200
25548 @itemx -mlzcnt
25549 @opindex mlzcnt
25550 @need 200
25551 @itemx -mfxsr
25552 @opindex mfxsr
25553 @need 200
25554 @itemx -mxsave
25555 @opindex mxsave
25556 @need 200
25557 @itemx -mxsaveopt
25558 @opindex mxsaveopt
25559 @need 200
25560 @itemx -mxsavec
25561 @opindex mxsavec
25562 @need 200
25563 @itemx -mxsaves
25564 @opindex mxsaves
25565 @need 200
25566 @itemx -mrtm
25567 @opindex mrtm
25568 @need 200
25569 @itemx -mtbm
25570 @opindex mtbm
25571 @need 200
25572 @itemx -mmpx
25573 @opindex mmpx
25574 @need 200
25575 @itemx -mmwaitx
25576 @opindex mmwaitx
25577 @need 200
25578 @itemx -mclzero
25579 @opindex mclzero
25580 @itemx -mpku
25581 @opindex mpku
25582 These switches enable the use of instructions in the MMX, SSE,
25583 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25584 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25585 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25586 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25587 extended instruction sets.  Each has a corresponding @option{-mno-} option
25588 to disable use of these instructions.
25590 These extensions are also available as built-in functions: see
25591 @ref{x86 Built-in Functions}, for details of the functions enabled and
25592 disabled by these switches.
25594 To generate SSE/SSE2 instructions automatically from floating-point
25595 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25597 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25598 generates new AVX instructions or AVX equivalence for all SSEx instructions
25599 when needed.
25601 These options enable GCC to use these extended instructions in
25602 generated code, even without @option{-mfpmath=sse}.  Applications that
25603 perform run-time CPU detection must compile separate files for each
25604 supported architecture, using the appropriate flags.  In particular,
25605 the file containing the CPU detection code should be compiled without
25606 these options.
25608 @item -mdump-tune-features
25609 @opindex mdump-tune-features
25610 This option instructs GCC to dump the names of the x86 performance 
25611 tuning features and default settings. The names can be used in 
25612 @option{-mtune-ctrl=@var{feature-list}}.
25614 @item -mtune-ctrl=@var{feature-list}
25615 @opindex mtune-ctrl=@var{feature-list}
25616 This option is used to do fine grain control of x86 code generation features.
25617 @var{feature-list} is a comma separated list of @var{feature} names. See also
25618 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25619 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25620 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25621 developers. Using it may lead to code paths not covered by testing and can
25622 potentially result in compiler ICEs or runtime errors.
25624 @item -mno-default
25625 @opindex mno-default
25626 This option instructs GCC to turn off all tunable features. See also 
25627 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25629 @item -mcld
25630 @opindex mcld
25631 This option instructs GCC to emit a @code{cld} instruction in the prologue
25632 of functions that use string instructions.  String instructions depend on
25633 the DF flag to select between autoincrement or autodecrement mode.  While the
25634 ABI specifies the DF flag to be cleared on function entry, some operating
25635 systems violate this specification by not clearing the DF flag in their
25636 exception dispatchers.  The exception handler can be invoked with the DF flag
25637 set, which leads to wrong direction mode when string instructions are used.
25638 This option can be enabled by default on 32-bit x86 targets by configuring
25639 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25640 instructions can be suppressed with the @option{-mno-cld} compiler option
25641 in this case.
25643 @item -mvzeroupper
25644 @opindex mvzeroupper
25645 This option instructs GCC to emit a @code{vzeroupper} instruction
25646 before a transfer of control flow out of the function to minimize
25647 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25648 intrinsics.
25650 @item -mprefer-avx128
25651 @opindex mprefer-avx128
25652 This option instructs GCC to use 128-bit AVX instructions instead of
25653 256-bit AVX instructions in the auto-vectorizer.
25655 @item -mcx16
25656 @opindex mcx16
25657 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25658 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25659 objects.  This is useful for atomic updates of data structures exceeding one
25660 machine word in size.  The compiler uses this instruction to implement
25661 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25662 128-bit integers, a library call is always used.
25664 @item -msahf
25665 @opindex msahf
25666 This option enables generation of @code{SAHF} instructions in 64-bit code.
25667 Early Intel Pentium 4 CPUs with Intel 64 support,
25668 prior to the introduction of Pentium 4 G1 step in December 2005,
25669 lacked the @code{LAHF} and @code{SAHF} instructions
25670 which are supported by AMD64.
25671 These are load and store instructions, respectively, for certain status flags.
25672 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25673 @code{drem}, and @code{remainder} built-in functions;
25674 see @ref{Other Builtins} for details.
25676 @item -mmovbe
25677 @opindex mmovbe
25678 This option enables use of the @code{movbe} instruction to implement
25679 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25681 @item -mcrc32
25682 @opindex mcrc32
25683 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25684 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25685 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25687 @item -mrecip
25688 @opindex mrecip
25689 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25690 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25691 with an additional Newton-Raphson step
25692 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25693 (and their vectorized
25694 variants) for single-precision floating-point arguments.  These instructions
25695 are generated only when @option{-funsafe-math-optimizations} is enabled
25696 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25697 Note that while the throughput of the sequence is higher than the throughput
25698 of the non-reciprocal instruction, the precision of the sequence can be
25699 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25701 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25702 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25703 combination), and doesn't need @option{-mrecip}.
25705 Also note that GCC emits the above sequence with additional Newton-Raphson step
25706 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25707 already with @option{-ffast-math} (or the above option combination), and
25708 doesn't need @option{-mrecip}.
25710 @item -mrecip=@var{opt}
25711 @opindex mrecip=opt
25712 This option controls which reciprocal estimate instructions
25713 may be used.  @var{opt} is a comma-separated list of options, which may
25714 be preceded by a @samp{!} to invert the option:
25716 @table @samp
25717 @item all
25718 Enable all estimate instructions.
25720 @item default
25721 Enable the default instructions, equivalent to @option{-mrecip}.
25723 @item none
25724 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25726 @item div
25727 Enable the approximation for scalar division.
25729 @item vec-div
25730 Enable the approximation for vectorized division.
25732 @item sqrt
25733 Enable the approximation for scalar square root.
25735 @item vec-sqrt
25736 Enable the approximation for vectorized square root.
25737 @end table
25739 So, for example, @option{-mrecip=all,!sqrt} enables
25740 all of the reciprocal approximations, except for square root.
25742 @item -mveclibabi=@var{type}
25743 @opindex mveclibabi
25744 Specifies the ABI type to use for vectorizing intrinsics using an
25745 external library.  Supported values for @var{type} are @samp{svml} 
25746 for the Intel short
25747 vector math library and @samp{acml} for the AMD math core library.
25748 To use this option, both @option{-ftree-vectorize} and
25749 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25750 ABI-compatible library must be specified at link time.
25752 GCC currently emits calls to @code{vmldExp2},
25753 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25754 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25755 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25756 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25757 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25758 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25759 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25760 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25761 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25762 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25763 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25764 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25765 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25766 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25767 when @option{-mveclibabi=acml} is used.  
25769 @item -mabi=@var{name}
25770 @opindex mabi
25771 Generate code for the specified calling convention.  Permissible values
25772 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25773 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25774 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25775 You can control this behavior for specific functions by
25776 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25777 @xref{Function Attributes}.
25779 @item -mcall-ms2sysv-xlogues
25780 @opindex mcall-ms2sysv-xlogues
25781 @opindex mno-call-ms2sysv-xlogues
25782 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
25783 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
25784 default, the code for saving and restoring these registers is emitted inline,
25785 resulting in fairly lengthy prologues and epilogues.  Using
25786 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
25787 use stubs in the static portion of libgcc to perform these saves and restores,
25788 thus reducing function size at the cost of a few extra instructions.
25790 @item -mtls-dialect=@var{type}
25791 @opindex mtls-dialect
25792 Generate code to access thread-local storage using the @samp{gnu} or
25793 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25794 @samp{gnu2} is more efficient, but it may add compile- and run-time
25795 requirements that cannot be satisfied on all systems.
25797 @item -mpush-args
25798 @itemx -mno-push-args
25799 @opindex mpush-args
25800 @opindex mno-push-args
25801 Use PUSH operations to store outgoing parameters.  This method is shorter
25802 and usually equally fast as method using SUB/MOV operations and is enabled
25803 by default.  In some cases disabling it may improve performance because of
25804 improved scheduling and reduced dependencies.
25806 @item -maccumulate-outgoing-args
25807 @opindex maccumulate-outgoing-args
25808 If enabled, the maximum amount of space required for outgoing arguments is
25809 computed in the function prologue.  This is faster on most modern CPUs
25810 because of reduced dependencies, improved scheduling and reduced stack usage
25811 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25812 increase in code size.  This switch implies @option{-mno-push-args}.
25814 @item -mthreads
25815 @opindex mthreads
25816 Support thread-safe exception handling on MinGW.  Programs that rely
25817 on thread-safe exception handling must compile and link all code with the
25818 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25819 @option{-D_MT}; when linking, it links in a special thread helper library
25820 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25822 @item -mms-bitfields
25823 @itemx -mno-ms-bitfields
25824 @opindex mms-bitfields
25825 @opindex mno-ms-bitfields
25827 Enable/disable bit-field layout compatible with the native Microsoft
25828 Windows compiler.  
25830 If @code{packed} is used on a structure, or if bit-fields are used,
25831 it may be that the Microsoft ABI lays out the structure differently
25832 than the way GCC normally does.  Particularly when moving packed
25833 data between functions compiled with GCC and the native Microsoft compiler
25834 (either via function call or as data in a file), it may be necessary to access
25835 either format.
25837 This option is enabled by default for Microsoft Windows
25838 targets.  This behavior can also be controlled locally by use of variable
25839 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25840 and @ref{x86 Type Attributes}.
25842 The Microsoft structure layout algorithm is fairly simple with the exception
25843 of the bit-field packing.  
25844 The padding and alignment of members of structures and whether a bit-field 
25845 can straddle a storage-unit boundary are determine by these rules:
25847 @enumerate
25848 @item Structure members are stored sequentially in the order in which they are
25849 declared: the first member has the lowest memory address and the last member
25850 the highest.
25852 @item Every data object has an alignment requirement.  The alignment requirement
25853 for all data except structures, unions, and arrays is either the size of the
25854 object or the current packing size (specified with either the
25855 @code{aligned} attribute or the @code{pack} pragma),
25856 whichever is less.  For structures, unions, and arrays,
25857 the alignment requirement is the largest alignment requirement of its members.
25858 Every object is allocated an offset so that:
25860 @smallexample
25861 offset % alignment_requirement == 0
25862 @end smallexample
25864 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25865 unit if the integral types are the same size and if the next bit-field fits
25866 into the current allocation unit without crossing the boundary imposed by the
25867 common alignment requirements of the bit-fields.
25868 @end enumerate
25870 MSVC interprets zero-length bit-fields in the following ways:
25872 @enumerate
25873 @item If a zero-length bit-field is inserted between two bit-fields that
25874 are normally coalesced, the bit-fields are not coalesced.
25876 For example:
25878 @smallexample
25879 struct
25880  @{
25881    unsigned long bf_1 : 12;
25882    unsigned long : 0;
25883    unsigned long bf_2 : 12;
25884  @} t1;
25885 @end smallexample
25887 @noindent
25888 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25889 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25891 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25892 alignment of the zero-length bit-field is greater than the member that follows it,
25893 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25895 For example:
25897 @smallexample
25898 struct
25899  @{
25900    char foo : 4;
25901    short : 0;
25902    char bar;
25903  @} t2;
25905 struct
25906  @{
25907    char foo : 4;
25908    short : 0;
25909    double bar;
25910  @} t3;
25911 @end smallexample
25913 @noindent
25914 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25915 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25916 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25917 of the structure.
25919 Taking this into account, it is important to note the following:
25921 @enumerate
25922 @item If a zero-length bit-field follows a normal bit-field, the type of the
25923 zero-length bit-field may affect the alignment of the structure as whole. For
25924 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25925 normal bit-field, and is of type short.
25927 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25928 still affect the alignment of the structure:
25930 @smallexample
25931 struct
25932  @{
25933    char foo : 6;
25934    long : 0;
25935  @} t4;
25936 @end smallexample
25938 @noindent
25939 Here, @code{t4} takes up 4 bytes.
25940 @end enumerate
25942 @item Zero-length bit-fields following non-bit-field members are ignored:
25944 @smallexample
25945 struct
25946  @{
25947    char foo;
25948    long : 0;
25949    char bar;
25950  @} t5;
25951 @end smallexample
25953 @noindent
25954 Here, @code{t5} takes up 2 bytes.
25955 @end enumerate
25958 @item -mno-align-stringops
25959 @opindex mno-align-stringops
25960 Do not align the destination of inlined string operations.  This switch reduces
25961 code size and improves performance in case the destination is already aligned,
25962 but GCC doesn't know about it.
25964 @item -minline-all-stringops
25965 @opindex minline-all-stringops
25966 By default GCC inlines string operations only when the destination is 
25967 known to be aligned to least a 4-byte boundary.  
25968 This enables more inlining and increases code
25969 size, but may improve performance of code that depends on fast
25970 @code{memcpy}, @code{strlen},
25971 and @code{memset} for short lengths.
25973 @item -minline-stringops-dynamically
25974 @opindex minline-stringops-dynamically
25975 For string operations of unknown size, use run-time checks with
25976 inline code for small blocks and a library call for large blocks.
25978 @item -mstringop-strategy=@var{alg}
25979 @opindex mstringop-strategy=@var{alg}
25980 Override the internal decision heuristic for the particular algorithm to use
25981 for inlining string operations.  The allowed values for @var{alg} are:
25983 @table @samp
25984 @item rep_byte
25985 @itemx rep_4byte
25986 @itemx rep_8byte
25987 Expand using i386 @code{rep} prefix of the specified size.
25989 @item byte_loop
25990 @itemx loop
25991 @itemx unrolled_loop
25992 Expand into an inline loop.
25994 @item libcall
25995 Always use a library call.
25996 @end table
25998 @item -mmemcpy-strategy=@var{strategy}
25999 @opindex mmemcpy-strategy=@var{strategy}
26000 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26001 should be inlined and what inline algorithm to use when the expected size
26002 of the copy operation is known. @var{strategy} 
26003 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26004 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26005 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26006 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26007 in the list must be specified in increasing order.  The minimal byte size for 
26008 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26009 preceding range.
26011 @item -mmemset-strategy=@var{strategy}
26012 @opindex mmemset-strategy=@var{strategy}
26013 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26014 @code{__builtin_memset} expansion.
26016 @item -momit-leaf-frame-pointer
26017 @opindex momit-leaf-frame-pointer
26018 Don't keep the frame pointer in a register for leaf functions.  This
26019 avoids the instructions to save, set up, and restore frame pointers and
26020 makes an extra register available in leaf functions.  The option
26021 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26022 which might make debugging harder.
26024 @item -mtls-direct-seg-refs
26025 @itemx -mno-tls-direct-seg-refs
26026 @opindex mtls-direct-seg-refs
26027 Controls whether TLS variables may be accessed with offsets from the
26028 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26029 or whether the thread base pointer must be added.  Whether or not this
26030 is valid depends on the operating system, and whether it maps the
26031 segment to cover the entire TLS area.
26033 For systems that use the GNU C Library, the default is on.
26035 @item -msse2avx
26036 @itemx -mno-sse2avx
26037 @opindex msse2avx
26038 Specify that the assembler should encode SSE instructions with VEX
26039 prefix.  The option @option{-mavx} turns this on by default.
26041 @item -mfentry
26042 @itemx -mno-fentry
26043 @opindex mfentry
26044 If profiling is active (@option{-pg}), put the profiling
26045 counter call before the prologue.
26046 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26047 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26049 @item -mrecord-mcount
26050 @itemx -mno-record-mcount
26051 @opindex mrecord-mcount
26052 If profiling is active (@option{-pg}), generate a __mcount_loc section
26053 that contains pointers to each profiling call. This is useful for
26054 automatically patching and out calls.
26056 @item -mnop-mcount
26057 @itemx -mno-nop-mcount
26058 @opindex mnop-mcount
26059 If profiling is active (@option{-pg}), generate the calls to
26060 the profiling functions as NOPs. This is useful when they
26061 should be patched in later dynamically. This is likely only
26062 useful together with @option{-mrecord-mcount}.
26064 @item -mskip-rax-setup
26065 @itemx -mno-skip-rax-setup
26066 @opindex mskip-rax-setup
26067 When generating code for the x86-64 architecture with SSE extensions
26068 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26069 register when there are no variable arguments passed in vector registers.
26071 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26072 saving vector registers on stack when passing variable arguments, the
26073 impacts of this option are callees may waste some stack space,
26074 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26075 those issues, regardless the RAX register value.
26077 @item -m8bit-idiv
26078 @itemx -mno-8bit-idiv
26079 @opindex m8bit-idiv
26080 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26081 much faster than 32-bit/64-bit integer divide.  This option generates a
26082 run-time check.  If both dividend and divisor are within range of 0
26083 to 255, 8-bit unsigned integer divide is used instead of
26084 32-bit/64-bit integer divide.
26086 @item -mavx256-split-unaligned-load
26087 @itemx -mavx256-split-unaligned-store
26088 @opindex mavx256-split-unaligned-load
26089 @opindex mavx256-split-unaligned-store
26090 Split 32-byte AVX unaligned load and store.
26092 @item -mstack-protector-guard=@var{guard}
26093 @opindex mstack-protector-guard=@var{guard}
26094 Generate stack protection code using canary at @var{guard}.  Supported
26095 locations are @samp{global} for global canary or @samp{tls} for per-thread
26096 canary in the TLS block (the default).  This option has effect only when
26097 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26099 @item -mmitigate-rop
26100 @opindex mmitigate-rop
26101 Try to avoid generating code sequences that contain unintended return
26102 opcodes, to mitigate against certain forms of attack. At the moment,
26103 this option is limited in what it can do and should not be relied
26104 on to provide serious protection.
26106 @item -mgeneral-regs-only
26107 @opindex mgeneral-regs-only
26108 Generate code that uses only the general-purpose registers.  This
26109 prevents the compiler from using floating-point, vector, mask and bound
26110 registers.
26112 @end table
26114 These @samp{-m} switches are supported in addition to the above
26115 on x86-64 processors in 64-bit environments.
26117 @table @gcctabopt
26118 @item -m32
26119 @itemx -m64
26120 @itemx -mx32
26121 @itemx -m16
26122 @itemx -miamcu
26123 @opindex m32
26124 @opindex m64
26125 @opindex mx32
26126 @opindex m16
26127 @opindex miamcu
26128 Generate code for a 16-bit, 32-bit or 64-bit environment.
26129 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26130 to 32 bits, and
26131 generates code that runs on any i386 system.
26133 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26134 types to 64 bits, and generates code for the x86-64 architecture.
26135 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26136 and @option{-mdynamic-no-pic} options.
26138 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26139 to 32 bits, and
26140 generates code for the x86-64 architecture.
26142 The @option{-m16} option is the same as @option{-m32}, except for that
26143 it outputs the @code{.code16gcc} assembly directive at the beginning of
26144 the assembly output so that the binary can run in 16-bit mode.
26146 The @option{-miamcu} option generates code which conforms to Intel MCU
26147 psABI.  It requires the @option{-m32} option to be turned on.
26149 @item -mno-red-zone
26150 @opindex mno-red-zone
26151 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26152 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26153 stack pointer that is not modified by signal or interrupt handlers
26154 and therefore can be used for temporary data without adjusting the stack
26155 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26157 @item -mcmodel=small
26158 @opindex mcmodel=small
26159 Generate code for the small code model: the program and its symbols must
26160 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26161 Programs can be statically or dynamically linked.  This is the default
26162 code model.
26164 @item -mcmodel=kernel
26165 @opindex mcmodel=kernel
26166 Generate code for the kernel code model.  The kernel runs in the
26167 negative 2 GB of the address space.
26168 This model has to be used for Linux kernel code.
26170 @item -mcmodel=medium
26171 @opindex mcmodel=medium
26172 Generate code for the medium model: the program is linked in the lower 2
26173 GB of the address space.  Small symbols are also placed there.  Symbols
26174 with sizes larger than @option{-mlarge-data-threshold} are put into
26175 large data or BSS sections and can be located above 2GB.  Programs can
26176 be statically or dynamically linked.
26178 @item -mcmodel=large
26179 @opindex mcmodel=large
26180 Generate code for the large model.  This model makes no assumptions
26181 about addresses and sizes of sections.
26183 @item -maddress-mode=long
26184 @opindex maddress-mode=long
26185 Generate code for long address mode.  This is only supported for 64-bit
26186 and x32 environments.  It is the default address mode for 64-bit
26187 environments.
26189 @item -maddress-mode=short
26190 @opindex maddress-mode=short
26191 Generate code for short address mode.  This is only supported for 32-bit
26192 and x32 environments.  It is the default address mode for 32-bit and
26193 x32 environments.
26194 @end table
26196 @node x86 Windows Options
26197 @subsection x86 Windows Options
26198 @cindex x86 Windows Options
26199 @cindex Windows Options for x86
26201 These additional options are available for Microsoft Windows targets:
26203 @table @gcctabopt
26204 @item -mconsole
26205 @opindex mconsole
26206 This option
26207 specifies that a console application is to be generated, by
26208 instructing the linker to set the PE header subsystem type
26209 required for console applications.
26210 This option is available for Cygwin and MinGW targets and is
26211 enabled by default on those targets.
26213 @item -mdll
26214 @opindex mdll
26215 This option is available for Cygwin and MinGW targets.  It
26216 specifies that a DLL---a dynamic link library---is to be
26217 generated, enabling the selection of the required runtime
26218 startup object and entry point.
26220 @item -mnop-fun-dllimport
26221 @opindex mnop-fun-dllimport
26222 This option is available for Cygwin and MinGW targets.  It
26223 specifies that the @code{dllimport} attribute should be ignored.
26225 @item -mthread
26226 @opindex mthread
26227 This option is available for MinGW targets. It specifies
26228 that MinGW-specific thread support is to be used.
26230 @item -municode
26231 @opindex municode
26232 This option is available for MinGW-w64 targets.  It causes
26233 the @code{UNICODE} preprocessor macro to be predefined, and
26234 chooses Unicode-capable runtime startup code.
26236 @item -mwin32
26237 @opindex mwin32
26238 This option is available for Cygwin and MinGW targets.  It
26239 specifies that the typical Microsoft Windows predefined macros are to
26240 be set in the pre-processor, but does not influence the choice
26241 of runtime library/startup code.
26243 @item -mwindows
26244 @opindex mwindows
26245 This option is available for Cygwin and MinGW targets.  It
26246 specifies that a GUI application is to be generated by
26247 instructing the linker to set the PE header subsystem type
26248 appropriately.
26250 @item -fno-set-stack-executable
26251 @opindex fno-set-stack-executable
26252 This option is available for MinGW targets. It specifies that
26253 the executable flag for the stack used by nested functions isn't
26254 set. This is necessary for binaries running in kernel mode of
26255 Microsoft Windows, as there the User32 API, which is used to set executable
26256 privileges, isn't available.
26258 @item -fwritable-relocated-rdata
26259 @opindex fno-writable-relocated-rdata
26260 This option is available for MinGW and Cygwin targets.  It specifies
26261 that relocated-data in read-only section is put into the @code{.data}
26262 section.  This is a necessary for older runtimes not supporting
26263 modification of @code{.rdata} sections for pseudo-relocation.
26265 @item -mpe-aligned-commons
26266 @opindex mpe-aligned-commons
26267 This option is available for Cygwin and MinGW targets.  It
26268 specifies that the GNU extension to the PE file format that
26269 permits the correct alignment of COMMON variables should be
26270 used when generating code.  It is enabled by default if
26271 GCC detects that the target assembler found during configuration
26272 supports the feature.
26273 @end table
26275 See also under @ref{x86 Options} for standard options.
26277 @node Xstormy16 Options
26278 @subsection Xstormy16 Options
26279 @cindex Xstormy16 Options
26281 These options are defined for Xstormy16:
26283 @table @gcctabopt
26284 @item -msim
26285 @opindex msim
26286 Choose startup files and linker script suitable for the simulator.
26287 @end table
26289 @node Xtensa Options
26290 @subsection Xtensa Options
26291 @cindex Xtensa Options
26293 These options are supported for Xtensa targets:
26295 @table @gcctabopt
26296 @item -mconst16
26297 @itemx -mno-const16
26298 @opindex mconst16
26299 @opindex mno-const16
26300 Enable or disable use of @code{CONST16} instructions for loading
26301 constant values.  The @code{CONST16} instruction is currently not a
26302 standard option from Tensilica.  When enabled, @code{CONST16}
26303 instructions are always used in place of the standard @code{L32R}
26304 instructions.  The use of @code{CONST16} is enabled by default only if
26305 the @code{L32R} instruction is not available.
26307 @item -mfused-madd
26308 @itemx -mno-fused-madd
26309 @opindex mfused-madd
26310 @opindex mno-fused-madd
26311 Enable or disable use of fused multiply/add and multiply/subtract
26312 instructions in the floating-point option.  This has no effect if the
26313 floating-point option is not also enabled.  Disabling fused multiply/add
26314 and multiply/subtract instructions forces the compiler to use separate
26315 instructions for the multiply and add/subtract operations.  This may be
26316 desirable in some cases where strict IEEE 754-compliant results are
26317 required: the fused multiply add/subtract instructions do not round the
26318 intermediate result, thereby producing results with @emph{more} bits of
26319 precision than specified by the IEEE standard.  Disabling fused multiply
26320 add/subtract instructions also ensures that the program output is not
26321 sensitive to the compiler's ability to combine multiply and add/subtract
26322 operations.
26324 @item -mserialize-volatile
26325 @itemx -mno-serialize-volatile
26326 @opindex mserialize-volatile
26327 @opindex mno-serialize-volatile
26328 When this option is enabled, GCC inserts @code{MEMW} instructions before
26329 @code{volatile} memory references to guarantee sequential consistency.
26330 The default is @option{-mserialize-volatile}.  Use
26331 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26333 @item -mforce-no-pic
26334 @opindex mforce-no-pic
26335 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26336 position-independent code (PIC), this option disables PIC for compiling
26337 kernel code.
26339 @item -mtext-section-literals
26340 @itemx -mno-text-section-literals
26341 @opindex mtext-section-literals
26342 @opindex mno-text-section-literals
26343 These options control the treatment of literal pools.  The default is
26344 @option{-mno-text-section-literals}, which places literals in a separate
26345 section in the output file.  This allows the literal pool to be placed
26346 in a data RAM/ROM, and it also allows the linker to combine literal
26347 pools from separate object files to remove redundant literals and
26348 improve code size.  With @option{-mtext-section-literals}, the literals
26349 are interspersed in the text section in order to keep them as close as
26350 possible to their references.  This may be necessary for large assembly
26351 files.  Literals for each function are placed right before that function.
26353 @item -mauto-litpools
26354 @itemx -mno-auto-litpools
26355 @opindex mauto-litpools
26356 @opindex mno-auto-litpools
26357 These options control the treatment of literal pools.  The default is
26358 @option{-mno-auto-litpools}, which places literals in a separate
26359 section in the output file unless @option{-mtext-section-literals} is
26360 used.  With @option{-mauto-litpools} the literals are interspersed in
26361 the text section by the assembler.  Compiler does not produce explicit
26362 @code{.literal} directives and loads literals into registers with
26363 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26364 do relaxation and place literals as necessary.  This option allows
26365 assembler to create several literal pools per function and assemble
26366 very big functions, which may not be possible with
26367 @option{-mtext-section-literals}.
26369 @item -mtarget-align
26370 @itemx -mno-target-align
26371 @opindex mtarget-align
26372 @opindex mno-target-align
26373 When this option is enabled, GCC instructs the assembler to
26374 automatically align instructions to reduce branch penalties at the
26375 expense of some code density.  The assembler attempts to widen density
26376 instructions to align branch targets and the instructions following call
26377 instructions.  If there are not enough preceding safe density
26378 instructions to align a target, no widening is performed.  The
26379 default is @option{-mtarget-align}.  These options do not affect the
26380 treatment of auto-aligned instructions like @code{LOOP}, which the
26381 assembler always aligns, either by widening density instructions or
26382 by inserting NOP instructions.
26384 @item -mlongcalls
26385 @itemx -mno-longcalls
26386 @opindex mlongcalls
26387 @opindex mno-longcalls
26388 When this option is enabled, GCC instructs the assembler to translate
26389 direct calls to indirect calls unless it can determine that the target
26390 of a direct call is in the range allowed by the call instruction.  This
26391 translation typically occurs for calls to functions in other source
26392 files.  Specifically, the assembler translates a direct @code{CALL}
26393 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26394 The default is @option{-mno-longcalls}.  This option should be used in
26395 programs where the call target can potentially be out of range.  This
26396 option is implemented in the assembler, not the compiler, so the
26397 assembly code generated by GCC still shows direct call
26398 instructions---look at the disassembled object code to see the actual
26399 instructions.  Note that the assembler uses an indirect call for
26400 every cross-file call, not just those that really are out of range.
26401 @end table
26403 @node zSeries Options
26404 @subsection zSeries Options
26405 @cindex zSeries options
26407 These are listed under @xref{S/390 and zSeries Options}.
26410 @c man end
26412 @node Spec Files
26413 @section Specifying Subprocesses and the Switches to Pass to Them
26414 @cindex Spec Files
26416 @command{gcc} is a driver program.  It performs its job by invoking a
26417 sequence of other programs to do the work of compiling, assembling and
26418 linking.  GCC interprets its command-line parameters and uses these to
26419 deduce which programs it should invoke, and which command-line options
26420 it ought to place on their command lines.  This behavior is controlled
26421 by @dfn{spec strings}.  In most cases there is one spec string for each
26422 program that GCC can invoke, but a few programs have multiple spec
26423 strings to control their behavior.  The spec strings built into GCC can
26424 be overridden by using the @option{-specs=} command-line switch to specify
26425 a spec file.
26427 @dfn{Spec files} are plain-text files that are used to construct spec
26428 strings.  They consist of a sequence of directives separated by blank
26429 lines.  The type of directive is determined by the first non-whitespace
26430 character on the line, which can be one of the following:
26432 @table @code
26433 @item %@var{command}
26434 Issues a @var{command} to the spec file processor.  The commands that can
26435 appear here are:
26437 @table @code
26438 @item %include <@var{file}>
26439 @cindex @code{%include}
26440 Search for @var{file} and insert its text at the current point in the
26441 specs file.
26443 @item %include_noerr <@var{file}>
26444 @cindex @code{%include_noerr}
26445 Just like @samp{%include}, but do not generate an error message if the include
26446 file cannot be found.
26448 @item %rename @var{old_name} @var{new_name}
26449 @cindex @code{%rename}
26450 Rename the spec string @var{old_name} to @var{new_name}.
26452 @end table
26454 @item *[@var{spec_name}]:
26455 This tells the compiler to create, override or delete the named spec
26456 string.  All lines after this directive up to the next directive or
26457 blank line are considered to be the text for the spec string.  If this
26458 results in an empty string then the spec is deleted.  (Or, if the
26459 spec did not exist, then nothing happens.)  Otherwise, if the spec
26460 does not currently exist a new spec is created.  If the spec does
26461 exist then its contents are overridden by the text of this
26462 directive, unless the first character of that text is the @samp{+}
26463 character, in which case the text is appended to the spec.
26465 @item [@var{suffix}]:
26466 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26467 and up to the next directive or blank line are considered to make up the
26468 spec string for the indicated suffix.  When the compiler encounters an
26469 input file with the named suffix, it processes the spec string in
26470 order to work out how to compile that file.  For example:
26472 @smallexample
26473 .ZZ:
26474 z-compile -input %i
26475 @end smallexample
26477 This says that any input file whose name ends in @samp{.ZZ} should be
26478 passed to the program @samp{z-compile}, which should be invoked with the
26479 command-line switch @option{-input} and with the result of performing the
26480 @samp{%i} substitution.  (See below.)
26482 As an alternative to providing a spec string, the text following a
26483 suffix directive can be one of the following:
26485 @table @code
26486 @item @@@var{language}
26487 This says that the suffix is an alias for a known @var{language}.  This is
26488 similar to using the @option{-x} command-line switch to GCC to specify a
26489 language explicitly.  For example:
26491 @smallexample
26492 .ZZ:
26493 @@c++
26494 @end smallexample
26496 Says that .ZZ files are, in fact, C++ source files.
26498 @item #@var{name}
26499 This causes an error messages saying:
26501 @smallexample
26502 @var{name} compiler not installed on this system.
26503 @end smallexample
26504 @end table
26506 GCC already has an extensive list of suffixes built into it.
26507 This directive adds an entry to the end of the list of suffixes, but
26508 since the list is searched from the end backwards, it is effectively
26509 possible to override earlier entries using this technique.
26511 @end table
26513 GCC has the following spec strings built into it.  Spec files can
26514 override these strings or create their own.  Note that individual
26515 targets can also add their own spec strings to this list.
26517 @smallexample
26518 asm          Options to pass to the assembler
26519 asm_final    Options to pass to the assembler post-processor
26520 cpp          Options to pass to the C preprocessor
26521 cc1          Options to pass to the C compiler
26522 cc1plus      Options to pass to the C++ compiler
26523 endfile      Object files to include at the end of the link
26524 link         Options to pass to the linker
26525 lib          Libraries to include on the command line to the linker
26526 libgcc       Decides which GCC support library to pass to the linker
26527 linker       Sets the name of the linker
26528 predefines   Defines to be passed to the C preprocessor
26529 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26530              by default
26531 startfile    Object files to include at the start of the link
26532 @end smallexample
26534 Here is a small example of a spec file:
26536 @smallexample
26537 %rename lib                 old_lib
26539 *lib:
26540 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26541 @end smallexample
26543 This example renames the spec called @samp{lib} to @samp{old_lib} and
26544 then overrides the previous definition of @samp{lib} with a new one.
26545 The new definition adds in some extra command-line options before
26546 including the text of the old definition.
26548 @dfn{Spec strings} are a list of command-line options to be passed to their
26549 corresponding program.  In addition, the spec strings can contain
26550 @samp{%}-prefixed sequences to substitute variable text or to
26551 conditionally insert text into the command line.  Using these constructs
26552 it is possible to generate quite complex command lines.
26554 Here is a table of all defined @samp{%}-sequences for spec
26555 strings.  Note that spaces are not generated automatically around the
26556 results of expanding these sequences.  Therefore you can concatenate them
26557 together or combine them with constant text in a single argument.
26559 @table @code
26560 @item %%
26561 Substitute one @samp{%} into the program name or argument.
26563 @item %i
26564 Substitute the name of the input file being processed.
26566 @item %b
26567 Substitute the basename of the input file being processed.
26568 This is the substring up to (and not including) the last period
26569 and not including the directory.
26571 @item %B
26572 This is the same as @samp{%b}, but include the file suffix (text after
26573 the last period).
26575 @item %d
26576 Marks the argument containing or following the @samp{%d} as a
26577 temporary file name, so that that file is deleted if GCC exits
26578 successfully.  Unlike @samp{%g}, this contributes no text to the
26579 argument.
26581 @item %g@var{suffix}
26582 Substitute a file name that has suffix @var{suffix} and is chosen
26583 once per compilation, and mark the argument in the same way as
26584 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26585 name is now chosen in a way that is hard to predict even when previously
26586 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26587 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26588 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26589 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26590 was simply substituted with a file name chosen once per compilation,
26591 without regard to any appended suffix (which was therefore treated
26592 just like ordinary text), making such attacks more likely to succeed.
26594 @item %u@var{suffix}
26595 Like @samp{%g}, but generates a new temporary file name
26596 each time it appears instead of once per compilation.
26598 @item %U@var{suffix}
26599 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26600 new one if there is no such last file name.  In the absence of any
26601 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26602 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26603 involves the generation of two distinct file names, one
26604 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26605 simply substituted with a file name chosen for the previous @samp{%u},
26606 without regard to any appended suffix.
26608 @item %j@var{suffix}
26609 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26610 writable, and if @option{-save-temps} is not used; 
26611 otherwise, substitute the name
26612 of a temporary file, just like @samp{%u}.  This temporary file is not
26613 meant for communication between processes, but rather as a junk
26614 disposal mechanism.
26616 @item %|@var{suffix}
26617 @itemx %m@var{suffix}
26618 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26619 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26620 all.  These are the two most common ways to instruct a program that it
26621 should read from standard input or write to standard output.  If you
26622 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26623 construct: see for example @file{f/lang-specs.h}.
26625 @item %.@var{SUFFIX}
26626 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26627 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26628 terminated by the next space or %.
26630 @item %w
26631 Marks the argument containing or following the @samp{%w} as the
26632 designated output file of this compilation.  This puts the argument
26633 into the sequence of arguments that @samp{%o} substitutes.
26635 @item %o
26636 Substitutes the names of all the output files, with spaces
26637 automatically placed around them.  You should write spaces
26638 around the @samp{%o} as well or the results are undefined.
26639 @samp{%o} is for use in the specs for running the linker.
26640 Input files whose names have no recognized suffix are not compiled
26641 at all, but they are included among the output files, so they are
26642 linked.
26644 @item %O
26645 Substitutes the suffix for object files.  Note that this is
26646 handled specially when it immediately follows @samp{%g, %u, or %U},
26647 because of the need for those to form complete file names.  The
26648 handling is such that @samp{%O} is treated exactly as if it had already
26649 been substituted, except that @samp{%g, %u, and %U} do not currently
26650 support additional @var{suffix} characters following @samp{%O} as they do
26651 following, for example, @samp{.o}.
26653 @item %p
26654 Substitutes the standard macro predefinitions for the
26655 current target machine.  Use this when running @command{cpp}.
26657 @item %P
26658 Like @samp{%p}, but puts @samp{__} before and after the name of each
26659 predefined macro, except for macros that start with @samp{__} or with
26660 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26663 @item %I
26664 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26665 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26666 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26667 and @option{-imultilib} as necessary.
26669 @item %s
26670 Current argument is the name of a library or startup file of some sort.
26671 Search for that file in a standard list of directories and substitute
26672 the full name found.  The current working directory is included in the
26673 list of directories scanned.
26675 @item %T
26676 Current argument is the name of a linker script.  Search for that file
26677 in the current list of directories to scan for libraries. If the file
26678 is located insert a @option{--script} option into the command line
26679 followed by the full path name found.  If the file is not found then
26680 generate an error message.  Note: the current working directory is not
26681 searched.
26683 @item %e@var{str}
26684 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26685 Use this when inconsistent options are detected.
26687 @item %(@var{name})
26688 Substitute the contents of spec string @var{name} at this point.
26690 @item %x@{@var{option}@}
26691 Accumulate an option for @samp{%X}.
26693 @item %X
26694 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26695 spec string.
26697 @item %Y
26698 Output the accumulated assembler options specified by @option{-Wa}.
26700 @item %Z
26701 Output the accumulated preprocessor options specified by @option{-Wp}.
26703 @item %a
26704 Process the @code{asm} spec.  This is used to compute the
26705 switches to be passed to the assembler.
26707 @item %A
26708 Process the @code{asm_final} spec.  This is a spec string for
26709 passing switches to an assembler post-processor, if such a program is
26710 needed.
26712 @item %l
26713 Process the @code{link} spec.  This is the spec for computing the
26714 command line passed to the linker.  Typically it makes use of the
26715 @samp{%L %G %S %D and %E} sequences.
26717 @item %D
26718 Dump out a @option{-L} option for each directory that GCC believes might
26719 contain startup files.  If the target supports multilibs then the
26720 current multilib directory is prepended to each of these paths.
26722 @item %L
26723 Process the @code{lib} spec.  This is a spec string for deciding which
26724 libraries are included on the command line to the linker.
26726 @item %G
26727 Process the @code{libgcc} spec.  This is a spec string for deciding
26728 which GCC support library is included on the command line to the linker.
26730 @item %S
26731 Process the @code{startfile} spec.  This is a spec for deciding which
26732 object files are the first ones passed to the linker.  Typically
26733 this might be a file named @file{crt0.o}.
26735 @item %E
26736 Process the @code{endfile} spec.  This is a spec string that specifies
26737 the last object files that are passed to the linker.
26739 @item %C
26740 Process the @code{cpp} spec.  This is used to construct the arguments
26741 to be passed to the C preprocessor.
26743 @item %1
26744 Process the @code{cc1} spec.  This is used to construct the options to be
26745 passed to the actual C compiler (@command{cc1}).
26747 @item %2
26748 Process the @code{cc1plus} spec.  This is used to construct the options to be
26749 passed to the actual C++ compiler (@command{cc1plus}).
26751 @item %*
26752 Substitute the variable part of a matched option.  See below.
26753 Note that each comma in the substituted string is replaced by
26754 a single space.
26756 @item %<S
26757 Remove all occurrences of @code{-S} from the command line.  Note---this
26758 command is position dependent.  @samp{%} commands in the spec string
26759 before this one see @code{-S}, @samp{%} commands in the spec string
26760 after this one do not.
26762 @item %:@var{function}(@var{args})
26763 Call the named function @var{function}, passing it @var{args}.
26764 @var{args} is first processed as a nested spec string, then split
26765 into an argument vector in the usual fashion.  The function returns
26766 a string which is processed as if it had appeared literally as part
26767 of the current spec.
26769 The following built-in spec functions are provided:
26771 @table @code
26772 @item @code{getenv}
26773 The @code{getenv} spec function takes two arguments: an environment
26774 variable name and a string.  If the environment variable is not
26775 defined, a fatal error is issued.  Otherwise, the return value is the
26776 value of the environment variable concatenated with the string.  For
26777 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26779 @smallexample
26780 %:getenv(TOPDIR /include)
26781 @end smallexample
26783 expands to @file{/path/to/top/include}.
26785 @item @code{if-exists}
26786 The @code{if-exists} spec function takes one argument, an absolute
26787 pathname to a file.  If the file exists, @code{if-exists} returns the
26788 pathname.  Here is a small example of its usage:
26790 @smallexample
26791 *startfile:
26792 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26793 @end smallexample
26795 @item @code{if-exists-else}
26796 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26797 spec function, except that it takes two arguments.  The first argument is
26798 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26799 returns the pathname.  If it does not exist, it returns the second argument.
26800 This way, @code{if-exists-else} can be used to select one file or another,
26801 based on the existence of the first.  Here is a small example of its usage:
26803 @smallexample
26804 *startfile:
26805 crt0%O%s %:if-exists(crti%O%s) \
26806 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26807 @end smallexample
26809 @item @code{replace-outfile}
26810 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26811 first argument in the outfiles array and replaces it with the second argument.  Here
26812 is a small example of its usage:
26814 @smallexample
26815 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26816 @end smallexample
26818 @item @code{remove-outfile}
26819 The @code{remove-outfile} spec function takes one argument.  It looks for the
26820 first argument in the outfiles array and removes it.  Here is a small example
26821 its usage:
26823 @smallexample
26824 %:remove-outfile(-lm)
26825 @end smallexample
26827 @item @code{pass-through-libs}
26828 The @code{pass-through-libs} spec function takes any number of arguments.  It
26829 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26830 assumes are the names of linker input library archive files) and returns a
26831 result containing all the found arguments each prepended by
26832 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26833 intended to be passed to the LTO linker plugin.
26835 @smallexample
26836 %:pass-through-libs(%G %L %G)
26837 @end smallexample
26839 @item @code{print-asm-header}
26840 The @code{print-asm-header} function takes no arguments and simply
26841 prints a banner like:
26843 @smallexample
26844 Assembler options
26845 =================
26847 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26848 @end smallexample
26850 It is used to separate compiler options from assembler options
26851 in the @option{--target-help} output.
26852 @end table
26854 @item %@{S@}
26855 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26856 If that switch is not specified, this substitutes nothing.  Note that
26857 the leading dash is omitted when specifying this option, and it is
26858 automatically inserted if the substitution is performed.  Thus the spec
26859 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26860 and outputs the command-line option @option{-foo}.
26862 @item %W@{S@}
26863 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26864 deleted on failure.
26866 @item %@{S*@}
26867 Substitutes all the switches specified to GCC whose names start
26868 with @code{-S}, but which also take an argument.  This is used for
26869 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26870 GCC considers @option{-o foo} as being
26871 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26872 text, including the space.  Thus two arguments are generated.
26874 @item %@{S*&T*@}
26875 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26876 (the order of @code{S} and @code{T} in the spec is not significant).
26877 There can be any number of ampersand-separated variables; for each the
26878 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26880 @item %@{S:X@}
26881 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26883 @item %@{!S:X@}
26884 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26886 @item %@{S*:X@}
26887 Substitutes @code{X} if one or more switches whose names start with
26888 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26889 once, no matter how many such switches appeared.  However, if @code{%*}
26890 appears somewhere in @code{X}, then @code{X} is substituted once
26891 for each matching switch, with the @code{%*} replaced by the part of
26892 that switch matching the @code{*}.
26894 If @code{%*} appears as the last part of a spec sequence then a space
26895 is added after the end of the last substitution.  If there is more
26896 text in the sequence, however, then a space is not generated.  This
26897 allows the @code{%*} substitution to be used as part of a larger
26898 string.  For example, a spec string like this:
26900 @smallexample
26901 %@{mcu=*:--script=%*/memory.ld@}
26902 @end smallexample
26904 @noindent
26905 when matching an option like @option{-mcu=newchip} produces:
26907 @smallexample
26908 --script=newchip/memory.ld
26909 @end smallexample
26911 @item %@{.S:X@}
26912 Substitutes @code{X}, if processing a file with suffix @code{S}.
26914 @item %@{!.S:X@}
26915 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26917 @item %@{,S:X@}
26918 Substitutes @code{X}, if processing a file for language @code{S}.
26920 @item %@{!,S:X@}
26921 Substitutes @code{X}, if not processing a file for language @code{S}.
26923 @item %@{S|P:X@}
26924 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26925 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26926 @code{*} sequences as well, although they have a stronger binding than
26927 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26928 alternatives must be starred, and only the first matching alternative
26929 is substituted.
26931 For example, a spec string like this:
26933 @smallexample
26934 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26935 @end smallexample
26937 @noindent
26938 outputs the following command-line options from the following input
26939 command-line options:
26941 @smallexample
26942 fred.c        -foo -baz
26943 jim.d         -bar -boggle
26944 -d fred.c     -foo -baz -boggle
26945 -d jim.d      -bar -baz -boggle
26946 @end smallexample
26948 @item %@{S:X; T:Y; :D@}
26950 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26951 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26952 be as many clauses as you need.  This may be combined with @code{.},
26953 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26956 @end table
26958 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
26959 or similar construct can use a backslash to ignore the special meaning
26960 of the character following it, thus allowing literal matching of a
26961 character that is otherwise specially treated.  For example,
26962 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
26963 @option{-std=iso9899:1999} option is given.
26965 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
26966 construct may contain other nested @samp{%} constructs or spaces, or
26967 even newlines.  They are processed as usual, as described above.
26968 Trailing white space in @code{X} is ignored.  White space may also
26969 appear anywhere on the left side of the colon in these constructs,
26970 except between @code{.} or @code{*} and the corresponding word.
26972 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26973 handled specifically in these constructs.  If another value of
26974 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26975 @option{-W} switch is found later in the command line, the earlier
26976 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26977 just one letter, which passes all matching options.
26979 The character @samp{|} at the beginning of the predicate text is used to
26980 indicate that a command should be piped to the following command, but
26981 only if @option{-pipe} is specified.
26983 It is built into GCC which switches take arguments and which do not.
26984 (You might think it would be useful to generalize this to allow each
26985 compiler's spec to say which switches take arguments.  But this cannot
26986 be done in a consistent fashion.  GCC cannot even decide which input
26987 files have been specified without knowing which switches take arguments,
26988 and it must know which input files to compile in order to tell which
26989 compilers to run).
26991 GCC also knows implicitly that arguments starting in @option{-l} are to be
26992 treated as compiler output files, and passed to the linker in their
26993 proper position among the other output files.
26995 @node Environment Variables
26996 @section Environment Variables Affecting GCC
26997 @cindex environment variables
26999 @c man begin ENVIRONMENT
27000 This section describes several environment variables that affect how GCC
27001 operates.  Some of them work by specifying directories or prefixes to use
27002 when searching for various kinds of files.  Some are used to specify other
27003 aspects of the compilation environment.
27005 Note that you can also specify places to search using options such as
27006 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27007 take precedence over places specified using environment variables, which
27008 in turn take precedence over those specified by the configuration of GCC@.
27009 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27010 GNU Compiler Collection (GCC) Internals}.
27012 @table @env
27013 @item LANG
27014 @itemx LC_CTYPE
27015 @c @itemx LC_COLLATE
27016 @itemx LC_MESSAGES
27017 @c @itemx LC_MONETARY
27018 @c @itemx LC_NUMERIC
27019 @c @itemx LC_TIME
27020 @itemx LC_ALL
27021 @findex LANG
27022 @findex LC_CTYPE
27023 @c @findex LC_COLLATE
27024 @findex LC_MESSAGES
27025 @c @findex LC_MONETARY
27026 @c @findex LC_NUMERIC
27027 @c @findex LC_TIME
27028 @findex LC_ALL
27029 @cindex locale
27030 These environment variables control the way that GCC uses
27031 localization information which allows GCC to work with different
27032 national conventions.  GCC inspects the locale categories
27033 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27034 so.  These locale categories can be set to any value supported by your
27035 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27036 Kingdom encoded in UTF-8.
27038 The @env{LC_CTYPE} environment variable specifies character
27039 classification.  GCC uses it to determine the character boundaries in
27040 a string; this is needed for some multibyte encodings that contain quote
27041 and escape characters that are otherwise interpreted as a string
27042 end or escape.
27044 The @env{LC_MESSAGES} environment variable specifies the language to
27045 use in diagnostic messages.
27047 If the @env{LC_ALL} environment variable is set, it overrides the value
27048 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27049 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27050 environment variable.  If none of these variables are set, GCC
27051 defaults to traditional C English behavior.
27053 @item TMPDIR
27054 @findex TMPDIR
27055 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27056 files.  GCC uses temporary files to hold the output of one stage of
27057 compilation which is to be used as input to the next stage: for example,
27058 the output of the preprocessor, which is the input to the compiler
27059 proper.
27061 @item GCC_COMPARE_DEBUG
27062 @findex GCC_COMPARE_DEBUG
27063 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27064 @option{-fcompare-debug} to the compiler driver.  See the documentation
27065 of this option for more details.
27067 @item GCC_EXEC_PREFIX
27068 @findex GCC_EXEC_PREFIX
27069 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27070 names of the subprograms executed by the compiler.  No slash is added
27071 when this prefix is combined with the name of a subprogram, but you can
27072 specify a prefix that ends with a slash if you wish.
27074 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27075 an appropriate prefix to use based on the pathname it is invoked with.
27077 If GCC cannot find the subprogram using the specified prefix, it
27078 tries looking in the usual places for the subprogram.
27080 The default value of @env{GCC_EXEC_PREFIX} is
27081 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27082 the installed compiler. In many cases @var{prefix} is the value
27083 of @code{prefix} when you ran the @file{configure} script.
27085 Other prefixes specified with @option{-B} take precedence over this prefix.
27087 This prefix is also used for finding files such as @file{crt0.o} that are
27088 used for linking.
27090 In addition, the prefix is used in an unusual way in finding the
27091 directories to search for header files.  For each of the standard
27092 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27093 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27094 replacing that beginning with the specified prefix to produce an
27095 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27096 @file{foo/bar} just before it searches the standard directory 
27097 @file{/usr/local/lib/bar}.
27098 If a standard directory begins with the configured
27099 @var{prefix} then the value of @var{prefix} is replaced by
27100 @env{GCC_EXEC_PREFIX} when looking for header files.
27102 @item COMPILER_PATH
27103 @findex COMPILER_PATH
27104 The value of @env{COMPILER_PATH} is a colon-separated list of
27105 directories, much like @env{PATH}.  GCC tries the directories thus
27106 specified when searching for subprograms, if it cannot find the
27107 subprograms using @env{GCC_EXEC_PREFIX}.
27109 @item LIBRARY_PATH
27110 @findex LIBRARY_PATH
27111 The value of @env{LIBRARY_PATH} is a colon-separated list of
27112 directories, much like @env{PATH}.  When configured as a native compiler,
27113 GCC tries the directories thus specified when searching for special
27114 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27115 using GCC also uses these directories when searching for ordinary
27116 libraries for the @option{-l} option (but directories specified with
27117 @option{-L} come first).
27119 @item LANG
27120 @findex LANG
27121 @cindex locale definition
27122 This variable is used to pass locale information to the compiler.  One way in
27123 which this information is used is to determine the character set to be used
27124 when character literals, string literals and comments are parsed in C and C++.
27125 When the compiler is configured to allow multibyte characters,
27126 the following values for @env{LANG} are recognized:
27128 @table @samp
27129 @item C-JIS
27130 Recognize JIS characters.
27131 @item C-SJIS
27132 Recognize SJIS characters.
27133 @item C-EUCJP
27134 Recognize EUCJP characters.
27135 @end table
27137 If @env{LANG} is not defined, or if it has some other value, then the
27138 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27139 recognize and translate multibyte characters.
27140 @end table
27142 @noindent
27143 Some additional environment variables affect the behavior of the
27144 preprocessor.
27146 @include cppenv.texi
27148 @c man end
27150 @node Precompiled Headers
27151 @section Using Precompiled Headers
27152 @cindex precompiled headers
27153 @cindex speed of compilation
27155 Often large projects have many header files that are included in every
27156 source file.  The time the compiler takes to process these header files
27157 over and over again can account for nearly all of the time required to
27158 build the project.  To make builds faster, GCC allows you to
27159 @dfn{precompile} a header file.
27161 To create a precompiled header file, simply compile it as you would any
27162 other file, if necessary using the @option{-x} option to make the driver
27163 treat it as a C or C++ header file.  You may want to use a
27164 tool like @command{make} to keep the precompiled header up-to-date when
27165 the headers it contains change.
27167 A precompiled header file is searched for when @code{#include} is
27168 seen in the compilation.  As it searches for the included file
27169 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27170 compiler looks for a precompiled header in each directory just before it
27171 looks for the include file in that directory.  The name searched for is
27172 the name specified in the @code{#include} with @samp{.gch} appended.  If
27173 the precompiled header file cannot be used, it is ignored.
27175 For instance, if you have @code{#include "all.h"}, and you have
27176 @file{all.h.gch} in the same directory as @file{all.h}, then the
27177 precompiled header file is used if possible, and the original
27178 header is used otherwise.
27180 Alternatively, you might decide to put the precompiled header file in a
27181 directory and use @option{-I} to ensure that directory is searched
27182 before (or instead of) the directory containing the original header.
27183 Then, if you want to check that the precompiled header file is always
27184 used, you can put a file of the same name as the original header in this
27185 directory containing an @code{#error} command.
27187 This also works with @option{-include}.  So yet another way to use
27188 precompiled headers, good for projects not designed with precompiled
27189 header files in mind, is to simply take most of the header files used by
27190 a project, include them from another header file, precompile that header
27191 file, and @option{-include} the precompiled header.  If the header files
27192 have guards against multiple inclusion, they are skipped because
27193 they've already been included (in the precompiled header).
27195 If you need to precompile the same header file for different
27196 languages, targets, or compiler options, you can instead make a
27197 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27198 header in the directory, perhaps using @option{-o}.  It doesn't matter
27199 what you call the files in the directory; every precompiled header in
27200 the directory is considered.  The first precompiled header
27201 encountered in the directory that is valid for this compilation is
27202 used; they're searched in no particular order.
27204 There are many other possibilities, limited only by your imagination,
27205 good sense, and the constraints of your build system.
27207 A precompiled header file can be used only when these conditions apply:
27209 @itemize
27210 @item
27211 Only one precompiled header can be used in a particular compilation.
27213 @item
27214 A precompiled header cannot be used once the first C token is seen.  You
27215 can have preprocessor directives before a precompiled header; you cannot
27216 include a precompiled header from inside another header.
27218 @item
27219 The precompiled header file must be produced for the same language as
27220 the current compilation.  You cannot use a C precompiled header for a C++
27221 compilation.
27223 @item
27224 The precompiled header file must have been produced by the same compiler
27225 binary as the current compilation is using.
27227 @item
27228 Any macros defined before the precompiled header is included must
27229 either be defined in the same way as when the precompiled header was
27230 generated, or must not affect the precompiled header, which usually
27231 means that they don't appear in the precompiled header at all.
27233 The @option{-D} option is one way to define a macro before a
27234 precompiled header is included; using a @code{#define} can also do it.
27235 There are also some options that define macros implicitly, like
27236 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27237 defined this way.
27239 @item If debugging information is output when using the precompiled
27240 header, using @option{-g} or similar, the same kind of debugging information
27241 must have been output when building the precompiled header.  However,
27242 a precompiled header built using @option{-g} can be used in a compilation
27243 when no debugging information is being output.
27245 @item The same @option{-m} options must generally be used when building
27246 and using the precompiled header.  @xref{Submodel Options},
27247 for any cases where this rule is relaxed.
27249 @item Each of the following options must be the same when building and using
27250 the precompiled header:
27252 @gccoptlist{-fexceptions}
27254 @item
27255 Some other command-line options starting with @option{-f},
27256 @option{-p}, or @option{-O} must be defined in the same way as when
27257 the precompiled header was generated.  At present, it's not clear
27258 which options are safe to change and which are not; the safest choice
27259 is to use exactly the same options when generating and using the
27260 precompiled header.  The following are known to be safe:
27262 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27263 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27264 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27265 -pedantic-errors}
27267 @end itemize
27269 For all of these except the last, the compiler automatically
27270 ignores the precompiled header if the conditions aren't met.  If you
27271 find an option combination that doesn't work and doesn't cause the
27272 precompiled header to be ignored, please consider filing a bug report,
27273 see @ref{Bugs}.
27275 If you do use differing options when generating and using the
27276 precompiled header, the actual behavior is a mixture of the
27277 behavior for the options.  For instance, if you use @option{-g} to
27278 generate the precompiled header but not when using it, you may or may
27279 not get debugging information for routines in the precompiled header.