remove -floop-* flags
[official-gcc.git] / gcc / doc / invoke.texi
blobc0ec0fde639d6cd7cbb5b6858f19b4b2c2fdf5a9
1 @c Copyright (C) 1988-2015 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-2015 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.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified.  Also,
105 the placement of the @option{-l} option is significant.
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}.  This manual documents
112 only one of these two forms, whichever one is not the default.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
118 @menu
119 * Option Summary::      Brief list of all options, without explanations.
120 * Overall Options::     Controlling the kind of output:
121                         an executable, object files, assembler files,
122                         or preprocessed source.
123 * Invoking G++::        Compiling C++ programs.
124 * C Dialect Options::   Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127                         and Objective-C++.
128 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
129                         be formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
161 -pipe  -pass-exit-codes  @gol
162 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
171 -fhosted  -ffreestanding -fopenacc -fopenmp -fopenmp-simd @gol
172 -fms-extensions -fplan9-extensions -trigraphs -traditional -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti -fsized-deallocation @gol
191 -fstats  -ftemplate-backtrace-limit=@var{n} @gol
192 -ftemplate-depth=@var{n} @gol
193 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
194 -fno-weak  -nostdinc++ @gol
195 -fvisibility-inlines-hidden @gol
196 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
197 -fvtv-counts -fvtv-debug @gol
198 -fvisibility-ms-compat @gol
199 -fext-numeric-literals @gol
200 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime  -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -fno-local-ivars @gol
222 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
223 -freplace-objc-classes @gol
224 -fzero-link @gol
225 -gen-decls @gol
226 -Wassign-intercept @gol
227 -Wno-protocol  -Wselector @gol
228 -Wstrict-selector-match @gol
229 -Wundeclared-selector}
231 @item Diagnostic Message Formatting Options
232 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
233 @gccoptlist{-fmessage-length=@var{n}  @gol
234 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
235 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
236 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
238 @item Warning Options
239 @xref{Warning Options,,Options to Request or Suppress Warnings}.
240 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
241 -pedantic-errors @gol
242 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
243 -Waggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
244 -Wbool-compare -Wframe-address @gol
245 -Wno-attributes -Wno-builtin-macro-redefined @gol
246 -Wc90-c99-compat -Wc99-c11-compat @gol
247 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
248 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
249 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
250 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
251 -Wdisabled-optimization @gol
252 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
253 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
254 -Wno-endif-labels -Werror  -Werror=* @gol
255 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
256 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
257 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
258 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
259 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
260 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
261 -Winit-self  -Winline  -Wno-int-conversion @gol
262 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
263 -Wnull-dereference @gol
264 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
265 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
266 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args @gol
267 -Wmisleading-indentation -Wmissing-braces @gol
268 -Wmissing-field-initializers -Wmissing-include-dirs @gol
269 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
270 -Wodr  -Wno-overflow  -Wopenmp-simd @gol
271 -Woverride-init-side-effects @gol
272 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
273 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
274 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
275 -Wredundant-decls  -Wno-return-local-addr @gol
276 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
277 -Wshift-overflow -Wshift-overflow=@var{n} @gol
278 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
279 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
280 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
281 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
282 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
283 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
284 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
285 -Wmissing-format-attribute @gol
286 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
287 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
288 -Wtype-limits  -Wundef @gol
289 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
290 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
291 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
292 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
293 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
294 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
295 -Wvla -Wvolatile-register-var  -Wwrite-strings @gol
296 -Wzero-as-null-pointer-constant}
298 @item C and Objective-C-only Warning Options
299 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
300 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
301 -Wold-style-declaration  -Wold-style-definition @gol
302 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
303 -Wdeclaration-after-statement -Wpointer-sign}
305 @item Debugging Options
306 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
307 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
308 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
309 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
310 -fsanitize-undefined-trap-on-error @gol
311 -fcheck-pointer-bounds -fchkp-check-incomplete-type @gol
312 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
313 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
314 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
315 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
316 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
317 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
318 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
319 -fchkp-use-wrappers @gol
320 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
321 -fdisable-ipa-@var{pass_name} @gol
322 -fdisable-rtl-@var{pass_name} @gol
323 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
324 -fdisable-tree-@var{pass_name} @gol
325 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
326 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
327 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
328 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
329 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
330 -fdump-passes @gol
331 -fdump-statistics @gol
332 -fdump-tree-all @gol
333 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
334 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
335 -fdump-tree-cfg -fdump-tree-alias @gol
336 -fdump-tree-ch @gol
337 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
338 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
339 -fdump-tree-gimple@r{[}-raw@r{]} @gol
340 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
341 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
342 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
343 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
344 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
345 -fdump-tree-nrv -fdump-tree-vect @gol
346 -fdump-tree-sink @gol
347 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
348 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
349 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
350 -fdump-tree-vtable-verify @gol
351 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
352 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
353 -fdump-final-insns=@var{file} @gol
354 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
355 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
356 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
357 -fenable-@var{kind}-@var{pass} @gol
358 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
359 -fdebug-types-section -fmem-report-wpa @gol
360 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
361 -fopt-info @gol
362 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
363 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
364 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
365 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
366 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
367 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
368 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
369 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
370 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
371 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
372 -fdebug-prefix-map=@var{old}=@var{new} @gol
373 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
374 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
375 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
376 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
377 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
378 -print-sysroot -print-sysroot-headers-suffix @gol
379 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
381 @item Optimization Options
382 @xref{Optimize Options,,Options that Control Optimization}.
383 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
384 -falign-jumps[=@var{n}] @gol
385 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
386 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
387 -fauto-inc-dec -fbranch-probabilities @gol
388 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
389 -fbtr-bb-exclusive -fcaller-saves @gol
390 -fcombine-stack-adjustments -fconserve-stack @gol
391 -fcompare-elim -fcprop-registers -fcrossjumping @gol
392 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
393 -fcx-limited-range @gol
394 -fdata-sections -fdce -fdelayed-branch @gol
395 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
396 -fdevirtualize-at-ltrans -fdse @gol
397 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
398 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
399 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
400 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
401 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
402 -fif-conversion2 -findirect-inlining @gol
403 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
404 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment @gol
405 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
406 -fira-algorithm=@var{algorithm} @gol
407 -fira-region=@var{region} -fira-hoist-pressure @gol
408 -fira-loop-pressure -fno-ira-share-save-slots @gol
409 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
410 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
411 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
412 -flive-range-shrinkage @gol
413 -floop-block -floop-interchange -floop-strip-mine @gol
414 -floop-unroll-and-jam -floop-nest-optimize @gol
415 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
416 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
417 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
418 -fmove-loop-invariants -fno-branch-count-reg @gol
419 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
420 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
421 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
422 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
423 -fomit-frame-pointer -foptimize-sibling-calls @gol
424 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
425 -fprefetch-loop-arrays -fprofile-report @gol
426 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
427 -fprofile-generate=@var{path} @gol
428 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
429 -fprofile-reorder-functions @gol
430 -freciprocal-math -free -frename-registers -freorder-blocks @gol
431 -freorder-blocks-and-partition -freorder-functions @gol
432 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
433 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
434 -fsched-spec-load -fsched-spec-load-dangerous @gol
435 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
436 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
437 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
438 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
439 -fschedule-fusion @gol
440 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
441 -fselective-scheduling -fselective-scheduling2 @gol
442 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
443 -fsemantic-interposition @gol
444 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
445 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt @gol
446 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
447 -fstack-protector-explicit -fstdarg-opt -fstrict-aliasing @gol
448 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
449 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
450 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
451 -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
452 -ftree-loop-if-convert-stores -ftree-loop-im @gol
453 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
454 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
455 -ftree-loop-vectorize @gol
456 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
457 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
458 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
459 -ftree-vectorize -ftree-vrp @gol
460 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
461 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
462 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
463 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
464 --param @var{name}=@var{value}
465 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
467 @item Preprocessor Options
468 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
469 @gccoptlist{-A@var{question}=@var{answer} @gol
470 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
471 -C  -dD  -dI  -dM  -dN @gol
472 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
473 -idirafter @var{dir} @gol
474 -include @var{file}  -imacros @var{file} @gol
475 -iprefix @var{file}  -iwithprefix @var{dir} @gol
476 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
477 -imultilib @var{dir} -isysroot @var{dir} @gol
478 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
479 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
480 -remap -trigraphs  -undef  -U@var{macro}  @gol
481 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
483 @item Assembler Option
484 @xref{Assembler Options,,Passing Options to the Assembler}.
485 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
487 @item Linker Options
488 @xref{Link Options,,Options for Linking}.
489 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
490 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
491 -s  -static -static-libgcc -static-libstdc++ @gol
492 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
493 -static-libmpx -static-libmpxwrappers @gol
494 -shared -shared-libgcc  -symbolic @gol
495 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
496 -u @var{symbol} -z @var{keyword}}
498 @item Directory Options
499 @xref{Directory Options,,Options for Directory Search}.
500 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
501 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
502 --sysroot=@var{dir} --no-sysroot-suffix}
504 @item Machine Dependent Options
505 @xref{Submodel Options,,Hardware Models and Configurations}.
506 @c This list is ordered alphanumerically by subsection name.
507 @c Try and put the significant identifier (CPU or system) first,
508 @c so users have a clue at guessing where the ones they want will be.
510 @emph{AArch64 Options}
511 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
512 -mgeneral-regs-only @gol
513 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
514 -mstrict-align @gol
515 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
516 -mtls-dialect=desc  -mtls-dialect=traditional @gol
517 -mtls-size=@var{size} @gol
518 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
519 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
520 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
522 @emph{Adapteva Epiphany Options}
523 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
524 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
525 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
526 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
527 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
528 -msplit-vecmove-early -m1reg-@var{reg}}
530 @emph{ARC Options}
531 @gccoptlist{-mbarrel-shifter @gol
532 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
533 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
534 -mea -mno-mpy -mmul32x16 -mmul64 @gol
535 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
536 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
537 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
538 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
539 -mucb-mcount -mvolatile-cache @gol
540 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
541 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
542 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
543 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
544 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
545 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
547 @emph{ARM Options}
548 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
549 -mabi=@var{name} @gol
550 -mapcs-stack-check  -mno-apcs-stack-check @gol
551 -mapcs-float  -mno-apcs-float @gol
552 -mapcs-reentrant  -mno-apcs-reentrant @gol
553 -msched-prolog  -mno-sched-prolog @gol
554 -mlittle-endian  -mbig-endian @gol
555 -mfloat-abi=@var{name} @gol
556 -mfp16-format=@var{name}
557 -mthumb-interwork  -mno-thumb-interwork @gol
558 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
559 -mtune=@var{name} -mprint-tune-info @gol
560 -mstructure-size-boundary=@var{n} @gol
561 -mabort-on-noreturn @gol
562 -mlong-calls  -mno-long-calls @gol
563 -msingle-pic-base  -mno-single-pic-base @gol
564 -mpic-register=@var{reg} @gol
565 -mnop-fun-dllimport @gol
566 -mpoke-function-name @gol
567 -mthumb  -marm @gol
568 -mtpcs-frame  -mtpcs-leaf-frame @gol
569 -mcaller-super-interworking  -mcallee-super-interworking @gol
570 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
571 -mword-relocations @gol
572 -mfix-cortex-m3-ldrd @gol
573 -munaligned-access @gol
574 -mneon-for-64bits @gol
575 -mslow-flash-data @gol
576 -masm-syntax-unified @gol
577 -mrestrict-it}
579 @emph{AVR Options}
580 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
581 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
582 -mrelax -mrmw -mstrict-X -mtiny-stack -nodevicelib -Waddr-space-convert}
584 @emph{Blackfin Options}
585 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
586 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
587 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
588 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
589 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
590 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
591 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
592 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
593 -micplb}
595 @emph{C6X Options}
596 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
597 -msim -msdata=@var{sdata-type}}
599 @emph{CRIS Options}
600 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
601 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
602 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
603 -mstack-align  -mdata-align  -mconst-align @gol
604 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
605 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
606 -mmul-bug-workaround  -mno-mul-bug-workaround}
608 @emph{CR16 Options}
609 @gccoptlist{-mmac @gol
610 -mcr16cplus -mcr16c @gol
611 -msim -mint32 -mbit-ops
612 -mdata-model=@var{model}}
614 @emph{Darwin Options}
615 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
616 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
617 -client_name  -compatibility_version  -current_version @gol
618 -dead_strip @gol
619 -dependency-file  -dylib_file  -dylinker_install_name @gol
620 -dynamic  -dynamiclib  -exported_symbols_list @gol
621 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
622 -force_flat_namespace  -headerpad_max_install_names @gol
623 -iframework @gol
624 -image_base  -init  -install_name  -keep_private_externs @gol
625 -multi_module  -multiply_defined  -multiply_defined_unused @gol
626 -noall_load   -no_dead_strip_inits_and_terms @gol
627 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
628 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
629 -private_bundle  -read_only_relocs  -sectalign @gol
630 -sectobjectsymbols  -whyload  -seg1addr @gol
631 -sectcreate  -sectobjectsymbols  -sectorder @gol
632 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
633 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
634 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
635 -single_module  -static  -sub_library  -sub_umbrella @gol
636 -twolevel_namespace  -umbrella  -undefined @gol
637 -unexported_symbols_list  -weak_reference_mismatches @gol
638 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
639 -mkernel -mone-byte-bool}
641 @emph{DEC Alpha Options}
642 @gccoptlist{-mno-fp-regs  -msoft-float @gol
643 -mieee  -mieee-with-inexact  -mieee-conformant @gol
644 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
645 -mtrap-precision=@var{mode}  -mbuild-constants @gol
646 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
647 -mbwx  -mmax  -mfix  -mcix @gol
648 -mfloat-vax  -mfloat-ieee @gol
649 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
650 -msmall-text  -mlarge-text @gol
651 -mmemory-latency=@var{time}}
653 @emph{FR30 Options}
654 @gccoptlist{-msmall-model -mno-lsim}
656 @emph{FT32 Options}
657 @gccoptlist{-msim -mlra}
659 @emph{FRV Options}
660 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
661 -mhard-float  -msoft-float @gol
662 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
663 -mdouble  -mno-double @gol
664 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
665 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
666 -mlinked-fp  -mlong-calls  -malign-labels @gol
667 -mlibrary-pic  -macc-4  -macc-8 @gol
668 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
669 -moptimize-membar -mno-optimize-membar @gol
670 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
671 -mvliw-branch  -mno-vliw-branch @gol
672 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
673 -mno-nested-cond-exec  -mtomcat-stats @gol
674 -mTLS -mtls @gol
675 -mcpu=@var{cpu}}
677 @emph{GNU/Linux Options}
678 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
679 -tno-android-cc -tno-android-ld}
681 @emph{H8/300 Options}
682 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
684 @emph{HPPA Options}
685 @gccoptlist{-march=@var{architecture-type} @gol
686 -mdisable-fpregs  -mdisable-indexing @gol
687 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
688 -mfixed-range=@var{register-range} @gol
689 -mjump-in-delay -mlinker-opt -mlong-calls @gol
690 -mlong-load-store  -mno-disable-fpregs @gol
691 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
692 -mno-jump-in-delay  -mno-long-load-store @gol
693 -mno-portable-runtime  -mno-soft-float @gol
694 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
695 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
696 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
697 -munix=@var{unix-std}  -nolibdld  -static  -threads}
699 @emph{IA-64 Options}
700 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
701 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
702 -mconstant-gp  -mauto-pic  -mfused-madd @gol
703 -minline-float-divide-min-latency @gol
704 -minline-float-divide-max-throughput @gol
705 -mno-inline-float-divide @gol
706 -minline-int-divide-min-latency @gol
707 -minline-int-divide-max-throughput  @gol
708 -mno-inline-int-divide @gol
709 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
710 -mno-inline-sqrt @gol
711 -mdwarf2-asm -mearly-stop-bits @gol
712 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
713 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
714 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
715 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
716 -msched-spec-ldc -msched-spec-control-ldc @gol
717 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
718 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
719 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
720 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
722 @emph{LM32 Options}
723 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
724 -msign-extend-enabled -muser-enabled}
726 @emph{M32R/D Options}
727 @gccoptlist{-m32r2 -m32rx -m32r @gol
728 -mdebug @gol
729 -malign-loops -mno-align-loops @gol
730 -missue-rate=@var{number} @gol
731 -mbranch-cost=@var{number} @gol
732 -mmodel=@var{code-size-model-type} @gol
733 -msdata=@var{sdata-type} @gol
734 -mno-flush-func -mflush-func=@var{name} @gol
735 -mno-flush-trap -mflush-trap=@var{number} @gol
736 -G @var{num}}
738 @emph{M32C Options}
739 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
741 @emph{M680x0 Options}
742 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
743 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
744 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
745 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
746 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
747 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
748 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
749 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
750 -mxgot -mno-xgot}
752 @emph{MCore Options}
753 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
754 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
755 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
756 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
757 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
759 @emph{MeP Options}
760 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
761 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
762 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
763 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
764 -mtiny=@var{n}}
766 @emph{MicroBlaze Options}
767 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
768 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
769 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
770 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
771 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
773 @emph{MIPS Options}
774 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
775 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
776 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
777 -mips16  -mno-mips16  -mflip-mips16 @gol
778 -minterlink-compressed -mno-interlink-compressed @gol
779 -minterlink-mips16  -mno-interlink-mips16 @gol
780 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
781 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
782 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
783 -mno-float  -msingle-float  -mdouble-float @gol
784 -modd-spreg -mno-odd-spreg @gol
785 -mabs=@var{mode}  -mnan=@var{encoding} @gol
786 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
787 -mmcu -mmno-mcu @gol
788 -meva -mno-eva @gol
789 -mvirt -mno-virt @gol
790 -mxpa -mno-xpa @gol
791 -mmicromips -mno-micromips @gol
792 -mfpu=@var{fpu-type} @gol
793 -msmartmips  -mno-smartmips @gol
794 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
795 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
796 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
797 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
798 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
799 -membedded-data  -mno-embedded-data @gol
800 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
801 -mcode-readable=@var{setting} @gol
802 -msplit-addresses  -mno-split-addresses @gol
803 -mexplicit-relocs  -mno-explicit-relocs @gol
804 -mcheck-zero-division  -mno-check-zero-division @gol
805 -mdivide-traps  -mdivide-breaks @gol
806 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
807 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
808 -mfix-24k -mno-fix-24k @gol
809 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
810 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
811 -mfix-vr4120  -mno-fix-vr4120 @gol
812 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
813 -mflush-func=@var{func}  -mno-flush-func @gol
814 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
815 -mfp-exceptions -mno-fp-exceptions @gol
816 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
817 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
819 @emph{MMIX Options}
820 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
821 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
822 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
823 -mno-base-addresses  -msingle-exit  -mno-single-exit}
825 @emph{MN10300 Options}
826 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
827 -mno-am33 -mam33 -mam33-2 -mam34 @gol
828 -mtune=@var{cpu-type} @gol
829 -mreturn-pointer-on-d0 @gol
830 -mno-crt0  -mrelax -mliw -msetlb}
832 @emph{Moxie Options}
833 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
835 @emph{MSP430 Options}
836 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
837 -mcode-region= -mdata-region= @gol
838 -mhwmult= -minrt}
840 @emph{NDS32 Options}
841 @gccoptlist{-mbig-endian -mlittle-endian @gol
842 -mreduced-regs -mfull-regs @gol
843 -mcmov -mno-cmov @gol
844 -mperf-ext -mno-perf-ext @gol
845 -mv3push -mno-v3push @gol
846 -m16bit -mno-16bit @gol
847 -misr-vector-size=@var{num} @gol
848 -mcache-block-size=@var{num} @gol
849 -march=@var{arch} @gol
850 -mcmodel=@var{code-model} @gol
851 -mctor-dtor -mrelax}
853 @emph{Nios II Options}
854 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
855 -mel -meb @gol
856 -mno-bypass-cache -mbypass-cache @gol
857 -mno-cache-volatile -mcache-volatile @gol
858 -mno-fast-sw-div -mfast-sw-div @gol
859 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
860 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
861 -mcustom-fpu-cfg=@var{name} @gol
862 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
863 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
865 @emph{Nvidia PTX Options}
866 @gccoptlist{-m32 -m64 -mmainkernel}
868 @emph{PDP-11 Options}
869 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
870 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
871 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
872 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
873 -mbranch-expensive  -mbranch-cheap @gol
874 -munix-asm  -mdec-asm}
876 @emph{picoChip Options}
877 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
878 -msymbol-as-address -mno-inefficient-warnings}
880 @emph{PowerPC Options}
881 See RS/6000 and PowerPC Options.
883 @emph{RL78 Options}
884 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
885 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
886 -m64bit-doubles -m32bit-doubles}
888 @emph{RS/6000 and PowerPC Options}
889 @gccoptlist{-mcpu=@var{cpu-type} @gol
890 -mtune=@var{cpu-type} @gol
891 -mcmodel=@var{code-model} @gol
892 -mpowerpc64 @gol
893 -maltivec  -mno-altivec @gol
894 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
895 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
896 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
897 -mfprnd  -mno-fprnd @gol
898 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
899 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
900 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
901 -malign-power  -malign-natural @gol
902 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
903 -msingle-float -mdouble-float -msimple-fpu @gol
904 -mstring  -mno-string  -mupdate  -mno-update @gol
905 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
906 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
907 -mstrict-align  -mno-strict-align  -mrelocatable @gol
908 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
909 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
910 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
911 -mprioritize-restricted-insns=@var{priority} @gol
912 -msched-costly-dep=@var{dependence_type} @gol
913 -minsert-sched-nops=@var{scheme} @gol
914 -mcall-sysv  -mcall-netbsd @gol
915 -maix-struct-return  -msvr4-struct-return @gol
916 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
917 -mblock-move-inline-limit=@var{num} @gol
918 -misel -mno-isel @gol
919 -misel=yes  -misel=no @gol
920 -mspe -mno-spe @gol
921 -mspe=yes  -mspe=no @gol
922 -mpaired @gol
923 -mgen-cell-microcode -mwarn-cell-microcode @gol
924 -mvrsave -mno-vrsave @gol
925 -mmulhw -mno-mulhw @gol
926 -mdlmzb -mno-dlmzb @gol
927 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
928 -mprototype  -mno-prototype @gol
929 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
930 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
931 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
932 -mno-recip-precision @gol
933 -mveclibabi=@var{type} -mfriz -mno-friz @gol
934 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
935 -msave-toc-indirect -mno-save-toc-indirect @gol
936 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
937 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
938 -mquad-memory -mno-quad-memory @gol
939 -mquad-memory-atomic -mno-quad-memory-atomic @gol
940 -mcompat-align-parm -mno-compat-align-parm @gol
941 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
942 -mupper-regs -mno-upper-regs}
944 @emph{RX Options}
945 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
946 -mcpu=@gol
947 -mbig-endian-data -mlittle-endian-data @gol
948 -msmall-data @gol
949 -msim  -mno-sim@gol
950 -mas100-syntax -mno-as100-syntax@gol
951 -mrelax@gol
952 -mmax-constant-size=@gol
953 -mint-register=@gol
954 -mpid@gol
955 -mallow-string-insns -mno-allow-string-insns@gol
956 -mno-warn-multiple-fast-interrupts@gol
957 -msave-acc-in-interrupts}
959 @emph{S/390 and zSeries Options}
960 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
961 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
962 -mlong-double-64 -mlong-double-128 @gol
963 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
964 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
965 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
966 -mhtm -mvx -mzvector @gol
967 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
968 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
969 -mhotpatch=@var{halfwords},@var{halfwords}}
971 @emph{Score Options}
972 @gccoptlist{-meb -mel @gol
973 -mnhwloop @gol
974 -muls @gol
975 -mmac @gol
976 -mscore5 -mscore5u -mscore7 -mscore7d}
978 @emph{SH Options}
979 @gccoptlist{-m1  -m2  -m2e @gol
980 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
981 -m3  -m3e @gol
982 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
983 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
984 -m5-64media  -m5-64media-nofpu @gol
985 -m5-32media  -m5-32media-nofpu @gol
986 -m5-compact  -m5-compact-nofpu @gol
987 -mb  -ml  -mdalign  -mrelax @gol
988 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
989 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
990 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
991 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
992 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
993 -maccumulate-outgoing-args -minvalid-symbols @gol
994 -matomic-model=@var{atomic-model} @gol
995 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
996 -mcbranch-force-delay-slot @gol
997 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
998 -mpretend-cmove -mtas}
1000 @emph{Solaris 2 Options}
1001 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1002 -pthreads -pthread}
1004 @emph{SPARC Options}
1005 @gccoptlist{-mcpu=@var{cpu-type} @gol
1006 -mtune=@var{cpu-type} @gol
1007 -mcmodel=@var{code-model} @gol
1008 -mmemory-model=@var{mem-model} @gol
1009 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1010 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1011 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1012 -mhard-quad-float  -msoft-quad-float @gol
1013 -mstack-bias  -mno-stack-bias @gol
1014 -munaligned-doubles  -mno-unaligned-doubles @gol
1015 -muser-mode  -mno-user-mode @gol
1016 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1017 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1018 -mcbcond -mno-cbcond @gol
1019 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1020 -mfix-at697f -mfix-ut699}
1022 @emph{SPU Options}
1023 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1024 -msafe-dma -munsafe-dma @gol
1025 -mbranch-hints @gol
1026 -msmall-mem -mlarge-mem -mstdmain @gol
1027 -mfixed-range=@var{register-range} @gol
1028 -mea32 -mea64 @gol
1029 -maddress-space-conversion -mno-address-space-conversion @gol
1030 -mcache-size=@var{cache-size} @gol
1031 -matomic-updates -mno-atomic-updates}
1033 @emph{System V Options}
1034 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1036 @emph{TILE-Gx Options}
1037 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1038 -mcmodel=@var{code-model}}
1040 @emph{TILEPro Options}
1041 @gccoptlist{-mcpu=@var{cpu} -m32}
1043 @emph{V850 Options}
1044 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1045 -mprolog-function  -mno-prolog-function  -mspace @gol
1046 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1047 -mapp-regs  -mno-app-regs @gol
1048 -mdisable-callt  -mno-disable-callt @gol
1049 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1050 -mv850e -mv850 -mv850e3v5 @gol
1051 -mloop @gol
1052 -mrelax @gol
1053 -mlong-jumps @gol
1054 -msoft-float @gol
1055 -mhard-float @gol
1056 -mgcc-abi @gol
1057 -mrh850-abi @gol
1058 -mbig-switch}
1060 @emph{VAX Options}
1061 @gccoptlist{-mg  -mgnu  -munix}
1063 @emph{Visium Options}
1064 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1065 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1067 @emph{VMS Options}
1068 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1069 -mpointer-size=@var{size}}
1071 @emph{VxWorks Options}
1072 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1073 -Xbind-lazy  -Xbind-now}
1075 @emph{x86 Options}
1076 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1077 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1078 -mfpmath=@var{unit} @gol
1079 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1080 -mno-fp-ret-in-387  -msoft-float @gol
1081 -mno-wide-multiply  -mrtd  -malign-double @gol
1082 -mpreferred-stack-boundary=@var{num} @gol
1083 -mincoming-stack-boundary=@var{num} @gol
1084 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1085 -mrecip -mrecip=@var{opt} @gol
1086 -mvzeroupper -mprefer-avx128 @gol
1087 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1088 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
1089 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
1090 -mclflushopt -mxsavec -mxsaves @gol
1091 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1092 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mthreads @gol
1093 -mno-align-stringops  -minline-all-stringops @gol
1094 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1095 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1096 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1097 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1098 -mregparm=@var{num}  -msseregparm @gol
1099 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1100 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1101 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1102 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1103 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1104 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1105 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1106 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
1108 @emph{x86 Windows Options}
1109 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1110 -mnop-fun-dllimport -mthread @gol
1111 -municode -mwin32 -mwindows -fno-set-stack-executable}
1113 @emph{Xstormy16 Options}
1114 @gccoptlist{-msim}
1116 @emph{Xtensa Options}
1117 @gccoptlist{-mconst16 -mno-const16 @gol
1118 -mfused-madd  -mno-fused-madd @gol
1119 -mforce-no-pic @gol
1120 -mserialize-volatile  -mno-serialize-volatile @gol
1121 -mtext-section-literals  -mno-text-section-literals @gol
1122 -mauto-litpools  -mno-auto-litpools @gol
1123 -mtarget-align  -mno-target-align @gol
1124 -mlongcalls  -mno-longcalls}
1126 @emph{zSeries Options}
1127 See S/390 and zSeries Options.
1129 @item Code Generation Options
1130 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1131 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1132 -ffixed-@var{reg}  -fexceptions @gol
1133 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1134 -fasynchronous-unwind-tables @gol
1135 -fno-gnu-unique @gol
1136 -finhibit-size-directive  -finstrument-functions @gol
1137 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1138 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1139 -fno-common  -fno-ident @gol
1140 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
1141 -fno-jump-tables @gol
1142 -frecord-gcc-switches @gol
1143 -freg-struct-return  -fshort-enums @gol
1144 -fshort-double  -fshort-wchar @gol
1145 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1146 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1147 -fno-stack-limit -fsplit-stack @gol
1148 -fleading-underscore  -ftls-model=@var{model} @gol
1149 -fstack-reuse=@var{reuse_level} @gol
1150 -ftrapv  -fwrapv  -fbounds-check @gol
1151 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
1152 -fstrict-volatile-bitfields -fsync-libcalls}
1153 @end table
1156 @node Overall Options
1157 @section Options Controlling the Kind of Output
1159 Compilation can involve up to four stages: preprocessing, compilation
1160 proper, assembly and linking, always in that order.  GCC is capable of
1161 preprocessing and compiling several files either into several
1162 assembler input files, or into one assembler input file; then each
1163 assembler input file produces an object file, and linking combines all
1164 the object files (those newly compiled, and those specified as input)
1165 into an executable file.
1167 @cindex file name suffix
1168 For any given input file, the file name suffix determines what kind of
1169 compilation is done:
1171 @table @gcctabopt
1172 @item @var{file}.c
1173 C source code that must be preprocessed.
1175 @item @var{file}.i
1176 C source code that should not be preprocessed.
1178 @item @var{file}.ii
1179 C++ source code that should not be preprocessed.
1181 @item @var{file}.m
1182 Objective-C source code.  Note that you must link with the @file{libobjc}
1183 library to make an Objective-C program work.
1185 @item @var{file}.mi
1186 Objective-C source code that should not be preprocessed.
1188 @item @var{file}.mm
1189 @itemx @var{file}.M
1190 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1191 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1192 to a literal capital M@.
1194 @item @var{file}.mii
1195 Objective-C++ source code that should not be preprocessed.
1197 @item @var{file}.h
1198 C, C++, Objective-C or Objective-C++ header file to be turned into a
1199 precompiled header (default), or C, C++ header file to be turned into an
1200 Ada spec (via the @option{-fdump-ada-spec} switch).
1202 @item @var{file}.cc
1203 @itemx @var{file}.cp
1204 @itemx @var{file}.cxx
1205 @itemx @var{file}.cpp
1206 @itemx @var{file}.CPP
1207 @itemx @var{file}.c++
1208 @itemx @var{file}.C
1209 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1210 the last two letters must both be literally @samp{x}.  Likewise,
1211 @samp{.C} refers to a literal capital C@.
1213 @item @var{file}.mm
1214 @itemx @var{file}.M
1215 Objective-C++ source code that must be preprocessed.
1217 @item @var{file}.mii
1218 Objective-C++ source code that should not be preprocessed.
1220 @item @var{file}.hh
1221 @itemx @var{file}.H
1222 @itemx @var{file}.hp
1223 @itemx @var{file}.hxx
1224 @itemx @var{file}.hpp
1225 @itemx @var{file}.HPP
1226 @itemx @var{file}.h++
1227 @itemx @var{file}.tcc
1228 C++ header file to be turned into a precompiled header or Ada spec.
1230 @item @var{file}.f
1231 @itemx @var{file}.for
1232 @itemx @var{file}.ftn
1233 Fixed form Fortran source code that should not be preprocessed.
1235 @item @var{file}.F
1236 @itemx @var{file}.FOR
1237 @itemx @var{file}.fpp
1238 @itemx @var{file}.FPP
1239 @itemx @var{file}.FTN
1240 Fixed form Fortran source code that must be preprocessed (with the traditional
1241 preprocessor).
1243 @item @var{file}.f90
1244 @itemx @var{file}.f95
1245 @itemx @var{file}.f03
1246 @itemx @var{file}.f08
1247 Free form Fortran source code that should not be preprocessed.
1249 @item @var{file}.F90
1250 @itemx @var{file}.F95
1251 @itemx @var{file}.F03
1252 @itemx @var{file}.F08
1253 Free form Fortran source code that must be preprocessed (with the
1254 traditional preprocessor).
1256 @item @var{file}.go
1257 Go source code.
1259 @c FIXME: Descriptions of Java file types.
1260 @c @var{file}.java
1261 @c @var{file}.class
1262 @c @var{file}.zip
1263 @c @var{file}.jar
1265 @item @var{file}.ads
1266 Ada source code file that contains a library unit declaration (a
1267 declaration of a package, subprogram, or generic, or a generic
1268 instantiation), or a library unit renaming declaration (a package,
1269 generic, or subprogram renaming declaration).  Such files are also
1270 called @dfn{specs}.
1272 @item @var{file}.adb
1273 Ada source code file containing a library unit body (a subprogram or
1274 package body).  Such files are also called @dfn{bodies}.
1276 @c GCC also knows about some suffixes for languages not yet included:
1277 @c Pascal:
1278 @c @var{file}.p
1279 @c @var{file}.pas
1280 @c Ratfor:
1281 @c @var{file}.r
1283 @item @var{file}.s
1284 Assembler code.
1286 @item @var{file}.S
1287 @itemx @var{file}.sx
1288 Assembler code that must be preprocessed.
1290 @item @var{other}
1291 An object file to be fed straight into linking.
1292 Any file name with no recognized suffix is treated this way.
1293 @end table
1295 @opindex x
1296 You can specify the input language explicitly with the @option{-x} option:
1298 @table @gcctabopt
1299 @item -x @var{language}
1300 Specify explicitly the @var{language} for the following input files
1301 (rather than letting the compiler choose a default based on the file
1302 name suffix).  This option applies to all following input files until
1303 the next @option{-x} option.  Possible values for @var{language} are:
1304 @smallexample
1305 c  c-header  cpp-output
1306 c++  c++-header  c++-cpp-output
1307 objective-c  objective-c-header  objective-c-cpp-output
1308 objective-c++ objective-c++-header objective-c++-cpp-output
1309 assembler  assembler-with-cpp
1311 f77  f77-cpp-input f95  f95-cpp-input
1313 java
1314 @end smallexample
1316 @item -x none
1317 Turn off any specification of a language, so that subsequent files are
1318 handled according to their file name suffixes (as they are if @option{-x}
1319 has not been used at all).
1321 @item -pass-exit-codes
1322 @opindex pass-exit-codes
1323 Normally the @command{gcc} program exits with the code of 1 if any
1324 phase of the compiler returns a non-success return code.  If you specify
1325 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1326 the numerically highest error produced by any phase returning an error
1327 indication.  The C, C++, and Fortran front ends return 4 if an internal
1328 compiler error is encountered.
1329 @end table
1331 If you only want some of the stages of compilation, you can use
1332 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1333 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1334 @command{gcc} is to stop.  Note that some combinations (for example,
1335 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1337 @table @gcctabopt
1338 @item -c
1339 @opindex c
1340 Compile or assemble the source files, but do not link.  The linking
1341 stage simply is not done.  The ultimate output is in the form of an
1342 object file for each source file.
1344 By default, the object file name for a source file is made by replacing
1345 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1347 Unrecognized input files, not requiring compilation or assembly, are
1348 ignored.
1350 @item -S
1351 @opindex S
1352 Stop after the stage of compilation proper; do not assemble.  The output
1353 is in the form of an assembler code file for each non-assembler input
1354 file specified.
1356 By default, the assembler file name for a source file is made by
1357 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1359 Input files that don't require compilation are ignored.
1361 @item -E
1362 @opindex E
1363 Stop after the preprocessing stage; do not run the compiler proper.  The
1364 output is in the form of preprocessed source code, which is sent to the
1365 standard output.
1367 Input files that don't require preprocessing are ignored.
1369 @cindex output file option
1370 @item -o @var{file}
1371 @opindex o
1372 Place output in file @var{file}.  This applies to whatever
1373 sort of output is being produced, whether it be an executable file,
1374 an object file, an assembler file or preprocessed C code.
1376 If @option{-o} is not specified, the default is to put an executable
1377 file in @file{a.out}, the object file for
1378 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1379 assembler file in @file{@var{source}.s}, a precompiled header file in
1380 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1381 standard output.
1383 @item -v
1384 @opindex v
1385 Print (on standard error output) the commands executed to run the stages
1386 of compilation.  Also print the version number of the compiler driver
1387 program and of the preprocessor and the compiler proper.
1389 @item -###
1390 @opindex ###
1391 Like @option{-v} except the commands are not executed and arguments
1392 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1393 This is useful for shell scripts to capture the driver-generated command lines.
1395 @item -pipe
1396 @opindex pipe
1397 Use pipes rather than temporary files for communication between the
1398 various stages of compilation.  This fails to work on some systems where
1399 the assembler is unable to read from a pipe; but the GNU assembler has
1400 no trouble.
1402 @item --help
1403 @opindex help
1404 Print (on the standard output) a description of the command-line options
1405 understood by @command{gcc}.  If the @option{-v} option is also specified
1406 then @option{--help} is also passed on to the various processes
1407 invoked by @command{gcc}, so that they can display the command-line options
1408 they accept.  If the @option{-Wextra} option has also been specified
1409 (prior to the @option{--help} option), then command-line options that
1410 have no documentation associated with them are also displayed.
1412 @item --target-help
1413 @opindex target-help
1414 Print (on the standard output) a description of target-specific command-line
1415 options for each tool.  For some targets extra target-specific
1416 information may also be printed.
1418 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1419 Print (on the standard output) a description of the command-line
1420 options understood by the compiler that fit into all specified classes
1421 and qualifiers.  These are the supported classes:
1423 @table @asis
1424 @item @samp{optimizers}
1425 Display all of the optimization options supported by the
1426 compiler.
1428 @item @samp{warnings}
1429 Display all of the options controlling warning messages
1430 produced by the compiler.
1432 @item @samp{target}
1433 Display target-specific options.  Unlike the
1434 @option{--target-help} option however, target-specific options of the
1435 linker and assembler are not displayed.  This is because those
1436 tools do not currently support the extended @option{--help=} syntax.
1438 @item @samp{params}
1439 Display the values recognized by the @option{--param}
1440 option.
1442 @item @var{language}
1443 Display the options supported for @var{language}, where
1444 @var{language} is the name of one of the languages supported in this
1445 version of GCC@.
1447 @item @samp{common}
1448 Display the options that are common to all languages.
1449 @end table
1451 These are the supported qualifiers:
1453 @table @asis
1454 @item @samp{undocumented}
1455 Display only those options that are undocumented.
1457 @item @samp{joined}
1458 Display options taking an argument that appears after an equal
1459 sign in the same continuous piece of text, such as:
1460 @samp{--help=target}.
1462 @item @samp{separate}
1463 Display options taking an argument that appears as a separate word
1464 following the original option, such as: @samp{-o output-file}.
1465 @end table
1467 Thus for example to display all the undocumented target-specific
1468 switches supported by the compiler, use:
1470 @smallexample
1471 --help=target,undocumented
1472 @end smallexample
1474 The sense of a qualifier can be inverted by prefixing it with the
1475 @samp{^} character, so for example to display all binary warning
1476 options (i.e., ones that are either on or off and that do not take an
1477 argument) that have a description, use:
1479 @smallexample
1480 --help=warnings,^joined,^undocumented
1481 @end smallexample
1483 The argument to @option{--help=} should not consist solely of inverted
1484 qualifiers.
1486 Combining several classes is possible, although this usually
1487 restricts the output so much that there is nothing to display.  One
1488 case where it does work, however, is when one of the classes is
1489 @var{target}.  For example, to display all the target-specific
1490 optimization options, use:
1492 @smallexample
1493 --help=target,optimizers
1494 @end smallexample
1496 The @option{--help=} option can be repeated on the command line.  Each
1497 successive use displays its requested class of options, skipping
1498 those that have already been displayed.
1500 If the @option{-Q} option appears on the command line before the
1501 @option{--help=} option, then the descriptive text displayed by
1502 @option{--help=} is changed.  Instead of describing the displayed
1503 options, an indication is given as to whether the option is enabled,
1504 disabled or set to a specific value (assuming that the compiler
1505 knows this at the point where the @option{--help=} option is used).
1507 Here is a truncated example from the ARM port of @command{gcc}:
1509 @smallexample
1510   % gcc -Q -mabi=2 --help=target -c
1511   The following options are target specific:
1512   -mabi=                                2
1513   -mabort-on-noreturn                   [disabled]
1514   -mapcs                                [disabled]
1515 @end smallexample
1517 The output is sensitive to the effects of previous command-line
1518 options, so for example it is possible to find out which optimizations
1519 are enabled at @option{-O2} by using:
1521 @smallexample
1522 -Q -O2 --help=optimizers
1523 @end smallexample
1525 Alternatively you can discover which binary optimizations are enabled
1526 by @option{-O3} by using:
1528 @smallexample
1529 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1530 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1531 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1532 @end smallexample
1534 @item -no-canonical-prefixes
1535 @opindex no-canonical-prefixes
1536 Do not expand any symbolic links, resolve references to @samp{/../}
1537 or @samp{/./}, or make the path absolute when generating a relative
1538 prefix.
1540 @item --version
1541 @opindex version
1542 Display the version number and copyrights of the invoked GCC@.
1544 @item -wrapper
1545 @opindex wrapper
1546 Invoke all subcommands under a wrapper program.  The name of the
1547 wrapper program and its parameters are passed as a comma separated
1548 list.
1550 @smallexample
1551 gcc -c t.c -wrapper gdb,--args
1552 @end smallexample
1554 @noindent
1555 This invokes all subprograms of @command{gcc} under
1556 @samp{gdb --args}, thus the invocation of @command{cc1} is
1557 @samp{gdb --args cc1 @dots{}}.
1559 @item -fplugin=@var{name}.so
1560 @opindex fplugin
1561 Load the plugin code in file @var{name}.so, assumed to be a
1562 shared object to be dlopen'd by the compiler.  The base name of
1563 the shared object file is used to identify the plugin for the
1564 purposes of argument parsing (See
1565 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1566 Each plugin should define the callback functions specified in the
1567 Plugins API.
1569 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1570 @opindex fplugin-arg
1571 Define an argument called @var{key} with a value of @var{value}
1572 for the plugin called @var{name}.
1574 @item -fdump-ada-spec@r{[}-slim@r{]}
1575 @opindex fdump-ada-spec
1576 For C and C++ source and include files, generate corresponding Ada specs.
1577 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1578 GNAT User's Guide}, which provides detailed documentation on this feature.
1580 @item -fada-spec-parent=@var{unit}
1581 @opindex fada-spec-parent
1582 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1583 Ada specs as child units of parent @var{unit}.
1585 @item -fdump-go-spec=@var{file}
1586 @opindex fdump-go-spec
1587 For input files in any language, generate corresponding Go
1588 declarations in @var{file}.  This generates Go @code{const},
1589 @code{type}, @code{var}, and @code{func} declarations which may be a
1590 useful way to start writing a Go interface to code written in some
1591 other language.
1593 @include @value{srcdir}/../libiberty/at-file.texi
1594 @end table
1596 @node Invoking G++
1597 @section Compiling C++ Programs
1599 @cindex suffixes for C++ source
1600 @cindex C++ source file suffixes
1601 C++ source files conventionally use one of the suffixes @samp{.C},
1602 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1603 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1604 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1605 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1606 files with these names and compiles them as C++ programs even if you
1607 call the compiler the same way as for compiling C programs (usually
1608 with the name @command{gcc}).
1610 @findex g++
1611 @findex c++
1612 However, the use of @command{gcc} does not add the C++ library.
1613 @command{g++} is a program that calls GCC and automatically specifies linking
1614 against the C++ library.  It treats @samp{.c},
1615 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1616 files unless @option{-x} is used.  This program is also useful when
1617 precompiling a C header file with a @samp{.h} extension for use in C++
1618 compilations.  On many systems, @command{g++} is also installed with
1619 the name @command{c++}.
1621 @cindex invoking @command{g++}
1622 When you compile C++ programs, you may specify many of the same
1623 command-line options that you use for compiling programs in any
1624 language; or command-line options meaningful for C and related
1625 languages; or options that are meaningful only for C++ programs.
1626 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1627 explanations of options for languages related to C@.
1628 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1629 explanations of options that are meaningful only for C++ programs.
1631 @node C Dialect Options
1632 @section Options Controlling C Dialect
1633 @cindex dialect options
1634 @cindex language dialect options
1635 @cindex options, dialect
1637 The following options control the dialect of C (or languages derived
1638 from C, such as C++, Objective-C and Objective-C++) that the compiler
1639 accepts:
1641 @table @gcctabopt
1642 @cindex ANSI support
1643 @cindex ISO support
1644 @item -ansi
1645 @opindex ansi
1646 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1647 equivalent to @option{-std=c++98}.
1649 This turns off certain features of GCC that are incompatible with ISO
1650 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1651 such as the @code{asm} and @code{typeof} keywords, and
1652 predefined macros such as @code{unix} and @code{vax} that identify the
1653 type of system you are using.  It also enables the undesirable and
1654 rarely used ISO trigraph feature.  For the C compiler,
1655 it disables recognition of C++ style @samp{//} comments as well as
1656 the @code{inline} keyword.
1658 The alternate keywords @code{__asm__}, @code{__extension__},
1659 @code{__inline__} and @code{__typeof__} continue to work despite
1660 @option{-ansi}.  You would not want to use them in an ISO C program, of
1661 course, but it is useful to put them in header files that might be included
1662 in compilations done with @option{-ansi}.  Alternate predefined macros
1663 such as @code{__unix__} and @code{__vax__} are also available, with or
1664 without @option{-ansi}.
1666 The @option{-ansi} option does not cause non-ISO programs to be
1667 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1668 addition to @option{-ansi}.  @xref{Warning Options}.
1670 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1671 option is used.  Some header files may notice this macro and refrain
1672 from declaring certain functions or defining certain macros that the
1673 ISO standard doesn't call for; this is to avoid interfering with any
1674 programs that might use these names for other things.
1676 Functions that are normally built in but do not have semantics
1677 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1678 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1679 built-in functions provided by GCC}, for details of the functions
1680 affected.
1682 @item -std=
1683 @opindex std
1684 Determine the language standard. @xref{Standards,,Language Standards
1685 Supported by GCC}, for details of these standard versions.  This option
1686 is currently only supported when compiling C or C++.
1688 The compiler can accept several base standards, such as @samp{c90} or
1689 @samp{c++98}, and GNU dialects of those standards, such as
1690 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1691 compiler accepts all programs following that standard plus those
1692 using GNU extensions that do not contradict it.  For example,
1693 @option{-std=c90} turns off certain features of GCC that are
1694 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1695 keywords, but not other GNU extensions that do not have a meaning in
1696 ISO C90, such as omitting the middle term of a @code{?:}
1697 expression. On the other hand, when a GNU dialect of a standard is
1698 specified, all features supported by the compiler are enabled, even when
1699 those features change the meaning of the base standard.  As a result, some
1700 strict-conforming programs may be rejected.  The particular standard
1701 is used by @option{-Wpedantic} to identify which features are GNU
1702 extensions given that version of the standard. For example
1703 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1704 comments, while @option{-std=gnu99 -Wpedantic} does not.
1706 A value for this option must be provided; possible values are
1708 @table @samp
1709 @item c90
1710 @itemx c89
1711 @itemx iso9899:1990
1712 Support all ISO C90 programs (certain GNU extensions that conflict
1713 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1715 @item iso9899:199409
1716 ISO C90 as modified in amendment 1.
1718 @item c99
1719 @itemx c9x
1720 @itemx iso9899:1999
1721 @itemx iso9899:199x
1722 ISO C99.  This standard is substantially completely supported, modulo
1723 bugs and floating-point issues
1724 (mainly but not entirely relating to optional C99 features from
1725 Annexes F and G).  See
1726 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1727 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1729 @item c11
1730 @itemx c1x
1731 @itemx iso9899:2011
1732 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1733 substantially completely supported, modulo bugs, floating-point issues
1734 (mainly but not entirely relating to optional C11 features from
1735 Annexes F and G) and the optional Annexes K (Bounds-checking
1736 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1738 @item gnu90
1739 @itemx gnu89
1740 GNU dialect of ISO C90 (including some C99 features).
1742 @item gnu99
1743 @itemx gnu9x
1744 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1746 @item gnu11
1747 @itemx gnu1x
1748 GNU dialect of ISO C11.  This is the default for C code.
1749 The name @samp{gnu1x} is deprecated.
1751 @item c++98
1752 @itemx c++03
1753 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1754 additional defect reports. Same as @option{-ansi} for C++ code.
1756 @item gnu++98
1757 @itemx gnu++03
1758 GNU dialect of @option{-std=c++98}.  This is the default for
1759 C++ code.
1761 @item c++11
1762 @itemx c++0x
1763 The 2011 ISO C++ standard plus amendments.
1764 The name @samp{c++0x} is deprecated.
1766 @item gnu++11
1767 @itemx gnu++0x
1768 GNU dialect of @option{-std=c++11}.
1769 The name @samp{gnu++0x} is deprecated.
1771 @item c++14
1772 @itemx c++1y
1773 The 2014 ISO C++ standard plus amendments.
1774 The name @samp{c++1y} is deprecated.
1776 @item gnu++14
1777 @itemx gnu++1y
1778 GNU dialect of @option{-std=c++14}.
1779 The name @samp{gnu++1y} is deprecated.
1781 @item c++1z
1782 The next revision of the ISO C++ standard, tentatively planned for
1783 2017.  Support is highly experimental, and will almost certainly
1784 change in incompatible ways in future releases.
1786 @item gnu++1z
1787 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1788 and will almost certainly change in incompatible ways in future
1789 releases.
1790 @end table
1792 @item -fgnu89-inline
1793 @opindex fgnu89-inline
1794 The option @option{-fgnu89-inline} tells GCC to use the traditional
1795 GNU semantics for @code{inline} functions when in C99 mode.
1796 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1797 Using this option is roughly equivalent to adding the
1798 @code{gnu_inline} function attribute to all inline functions
1799 (@pxref{Function Attributes}).
1801 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1802 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1803 specifies the default behavior).
1804 This option is not supported in @option{-std=c90} or
1805 @option{-std=gnu90} mode.
1807 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1808 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1809 in effect for @code{inline} functions.  @xref{Common Predefined
1810 Macros,,,cpp,The C Preprocessor}.
1812 @item -aux-info @var{filename}
1813 @opindex aux-info
1814 Output to the given filename prototyped declarations for all functions
1815 declared and/or defined in a translation unit, including those in header
1816 files.  This option is silently ignored in any language other than C@.
1818 Besides declarations, the file indicates, in comments, the origin of
1819 each declaration (source file and line), whether the declaration was
1820 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1821 @samp{O} for old, respectively, in the first character after the line
1822 number and the colon), and whether it came from a declaration or a
1823 definition (@samp{C} or @samp{F}, respectively, in the following
1824 character).  In the case of function definitions, a K&R-style list of
1825 arguments followed by their declarations is also provided, inside
1826 comments, after the declaration.
1828 @item -fallow-parameterless-variadic-functions
1829 @opindex fallow-parameterless-variadic-functions
1830 Accept variadic functions without named parameters.
1832 Although it is possible to define such a function, this is not very
1833 useful as it is not possible to read the arguments.  This is only
1834 supported for C as this construct is allowed by C++.
1836 @item -fno-asm
1837 @opindex fno-asm
1838 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1839 keyword, so that code can use these words as identifiers.  You can use
1840 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1841 instead.  @option{-ansi} implies @option{-fno-asm}.
1843 In C++, this switch only affects the @code{typeof} keyword, since
1844 @code{asm} and @code{inline} are standard keywords.  You may want to
1845 use the @option{-fno-gnu-keywords} flag instead, which has the same
1846 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1847 switch only affects the @code{asm} and @code{typeof} keywords, since
1848 @code{inline} is a standard keyword in ISO C99.
1850 @item -fno-builtin
1851 @itemx -fno-builtin-@var{function}
1852 @opindex fno-builtin
1853 @cindex built-in functions
1854 Don't recognize built-in functions that do not begin with
1855 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1856 functions provided by GCC}, for details of the functions affected,
1857 including those which are not built-in functions when @option{-ansi} or
1858 @option{-std} options for strict ISO C conformance are used because they
1859 do not have an ISO standard meaning.
1861 GCC normally generates special code to handle certain built-in functions
1862 more efficiently; for instance, calls to @code{alloca} may become single
1863 instructions which adjust the stack directly, and calls to @code{memcpy}
1864 may become inline copy loops.  The resulting code is often both smaller
1865 and faster, but since the function calls no longer appear as such, you
1866 cannot set a breakpoint on those calls, nor can you change the behavior
1867 of the functions by linking with a different library.  In addition,
1868 when a function is recognized as a built-in function, GCC may use
1869 information about that function to warn about problems with calls to
1870 that function, or to generate more efficient code, even if the
1871 resulting code still contains calls to that function.  For example,
1872 warnings are given with @option{-Wformat} for bad calls to
1873 @code{printf} when @code{printf} is built in and @code{strlen} is
1874 known not to modify global memory.
1876 With the @option{-fno-builtin-@var{function}} option
1877 only the built-in function @var{function} is
1878 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1879 function is named that is not built-in in this version of GCC, this
1880 option is ignored.  There is no corresponding
1881 @option{-fbuiltin-@var{function}} option; if you wish to enable
1882 built-in functions selectively when using @option{-fno-builtin} or
1883 @option{-ffreestanding}, you may define macros such as:
1885 @smallexample
1886 #define abs(n)          __builtin_abs ((n))
1887 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1888 @end smallexample
1890 @item -fhosted
1891 @opindex fhosted
1892 @cindex hosted environment
1894 Assert that compilation targets a hosted environment.  This implies
1895 @option{-fbuiltin}.  A hosted environment is one in which the
1896 entire standard library is available, and in which @code{main} has a return
1897 type of @code{int}.  Examples are nearly everything except a kernel.
1898 This is equivalent to @option{-fno-freestanding}.
1900 @item -ffreestanding
1901 @opindex ffreestanding
1902 @cindex hosted environment
1904 Assert that compilation targets a freestanding environment.  This
1905 implies @option{-fno-builtin}.  A freestanding environment
1906 is one in which the standard library may not exist, and program startup may
1907 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1908 This is equivalent to @option{-fno-hosted}.
1910 @xref{Standards,,Language Standards Supported by GCC}, for details of
1911 freestanding and hosted environments.
1913 @item -fopenacc
1914 @opindex fopenacc
1915 @cindex OpenACC accelerator programming
1916 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1917 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1918 compiler generates accelerated code according to the OpenACC Application
1919 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1920 implies @option{-pthread}, and thus is only supported on targets that
1921 have support for @option{-pthread}.
1923 Note that this is an experimental feature, incomplete, and subject to
1924 change in future versions of GCC.  See
1925 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
1927 @item -fopenmp
1928 @opindex fopenmp
1929 @cindex OpenMP parallel
1930 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1931 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1932 compiler generates parallel code according to the OpenMP Application
1933 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1934 implies @option{-pthread}, and thus is only supported on targets that
1935 have support for @option{-pthread}. @option{-fopenmp} implies
1936 @option{-fopenmp-simd}.
1938 @item -fopenmp-simd
1939 @opindex fopenmp-simd
1940 @cindex OpenMP SIMD
1941 @cindex SIMD
1942 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1943 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1944 are ignored.
1946 @item -fcilkplus
1947 @opindex fcilkplus
1948 @cindex Enable Cilk Plus
1949 Enable the usage of Cilk Plus language extension features for C/C++.
1950 When the option @option{-fcilkplus} is specified, enable the usage of
1951 the Cilk Plus Language extension features for C/C++.  The present
1952 implementation follows ABI version 1.2.  This is an experimental
1953 feature that is only partially complete, and whose interface may
1954 change in future versions of GCC as the official specification
1955 changes.  Currently, all features but @code{_Cilk_for} have been
1956 implemented.
1958 @item -fgnu-tm
1959 @opindex fgnu-tm
1960 When the option @option{-fgnu-tm} is specified, the compiler
1961 generates code for the Linux variant of Intel's current Transactional
1962 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1963 an experimental feature whose interface may change in future versions
1964 of GCC, as the official specification changes.  Please note that not
1965 all architectures are supported for this feature.
1967 For more information on GCC's support for transactional memory,
1968 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1969 Transactional Memory Library}.
1971 Note that the transactional memory feature is not supported with
1972 non-call exceptions (@option{-fnon-call-exceptions}).
1974 @item -fms-extensions
1975 @opindex fms-extensions
1976 Accept some non-standard constructs used in Microsoft header files.
1978 In C++ code, this allows member names in structures to be similar
1979 to previous types declarations.
1981 @smallexample
1982 typedef int UOW;
1983 struct ABC @{
1984   UOW UOW;
1986 @end smallexample
1988 Some cases of unnamed fields in structures and unions are only
1989 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1990 fields within structs/unions}, for details.
1992 Note that this option is off for all targets but x86 
1993 targets using ms-abi.
1995 @item -fplan9-extensions
1996 @opindex fplan9-extensions
1997 Accept some non-standard constructs used in Plan 9 code.
1999 This enables @option{-fms-extensions}, permits passing pointers to
2000 structures with anonymous fields to functions that expect pointers to
2001 elements of the type of the field, and permits referring to anonymous
2002 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2003 struct/union fields within structs/unions}, for details.  This is only
2004 supported for C, not C++.
2006 @item -trigraphs
2007 @opindex trigraphs
2008 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2009 options for strict ISO C conformance) implies @option{-trigraphs}.
2011 @cindex traditional C language
2012 @cindex C language, traditional
2013 @item -traditional
2014 @itemx -traditional-cpp
2015 @opindex traditional-cpp
2016 @opindex traditional
2017 Formerly, these options caused GCC to attempt to emulate a pre-standard
2018 C compiler.  They are now only supported with the @option{-E} switch.
2019 The preprocessor continues to support a pre-standard mode.  See the GNU
2020 CPP manual for details.
2022 @item -fcond-mismatch
2023 @opindex fcond-mismatch
2024 Allow conditional expressions with mismatched types in the second and
2025 third arguments.  The value of such an expression is void.  This option
2026 is not supported for C++.
2028 @item -flax-vector-conversions
2029 @opindex flax-vector-conversions
2030 Allow implicit conversions between vectors with differing numbers of
2031 elements and/or incompatible element types.  This option should not be
2032 used for new code.
2034 @item -funsigned-char
2035 @opindex funsigned-char
2036 Let the type @code{char} be unsigned, like @code{unsigned char}.
2038 Each kind of machine has a default for what @code{char} should
2039 be.  It is either like @code{unsigned char} by default or like
2040 @code{signed char} by default.
2042 Ideally, a portable program should always use @code{signed char} or
2043 @code{unsigned char} when it depends on the signedness of an object.
2044 But many programs have been written to use plain @code{char} and
2045 expect it to be signed, or expect it to be unsigned, depending on the
2046 machines they were written for.  This option, and its inverse, let you
2047 make such a program work with the opposite default.
2049 The type @code{char} is always a distinct type from each of
2050 @code{signed char} or @code{unsigned char}, even though its behavior
2051 is always just like one of those two.
2053 @item -fsigned-char
2054 @opindex fsigned-char
2055 Let the type @code{char} be signed, like @code{signed char}.
2057 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2058 the negative form of @option{-funsigned-char}.  Likewise, the option
2059 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2061 @item -fsigned-bitfields
2062 @itemx -funsigned-bitfields
2063 @itemx -fno-signed-bitfields
2064 @itemx -fno-unsigned-bitfields
2065 @opindex fsigned-bitfields
2066 @opindex funsigned-bitfields
2067 @opindex fno-signed-bitfields
2068 @opindex fno-unsigned-bitfields
2069 These options control whether a bit-field is signed or unsigned, when the
2070 declaration does not use either @code{signed} or @code{unsigned}.  By
2071 default, such a bit-field is signed, because this is consistent: the
2072 basic integer types such as @code{int} are signed types.
2073 @end table
2075 @node C++ Dialect Options
2076 @section Options Controlling C++ Dialect
2078 @cindex compiler options, C++
2079 @cindex C++ options, command-line
2080 @cindex options, C++
2081 This section describes the command-line options that are only meaningful
2082 for C++ programs.  You can also use most of the GNU compiler options
2083 regardless of what language your program is in.  For example, you
2084 might compile a file @file{firstClass.C} like this:
2086 @smallexample
2087 g++ -g -frepo -O -c firstClass.C
2088 @end smallexample
2090 @noindent
2091 In this example, only @option{-frepo} is an option meant
2092 only for C++ programs; you can use the other options with any
2093 language supported by GCC@.
2095 Here is a list of options that are @emph{only} for compiling C++ programs:
2097 @table @gcctabopt
2099 @item -fabi-version=@var{n}
2100 @opindex fabi-version
2101 Use version @var{n} of the C++ ABI@.  The default is version 0.
2103 Version 0 refers to the version conforming most closely to
2104 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2105 will change in different versions of G++ as ABI bugs are fixed.
2107 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2109 Version 2 is the version of the C++ ABI that first appeared in G++
2110 3.4, and was the default through G++ 4.9.
2112 Version 3 corrects an error in mangling a constant address as a
2113 template argument.
2115 Version 4, which first appeared in G++ 4.5, implements a standard
2116 mangling for vector types.
2118 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2119 attribute const/volatile on function pointer types, decltype of a
2120 plain decl, and use of a function parameter in the declaration of
2121 another parameter.
2123 Version 6, which first appeared in G++ 4.7, corrects the promotion
2124 behavior of C++11 scoped enums and the mangling of template argument
2125 packs, const/static_cast, prefix ++ and --, and a class scope function
2126 used as a template argument.
2128 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2129 builtin type and corrects the mangling of lambdas in default argument
2130 scope.
2132 Version 8, which first appeared in G++ 4.9, corrects the substitution
2133 behavior of function types with function-cv-qualifiers.
2135 See also @option{-Wabi}.
2137 @item -fabi-compat-version=@var{n}
2138 @opindex fabi-compat-version
2139 On targets that support strong aliases, G++
2140 works around mangling changes by creating an alias with the correct
2141 mangled name when defining a symbol with an incorrect mangled name.
2142 This switch specifies which ABI version to use for the alias.
2144 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2145 another ABI version is explicitly selected, this defaults to 0.
2147 The compatibility version is also set by @option{-Wabi=@var{n}}.
2149 @item -fno-access-control
2150 @opindex fno-access-control
2151 Turn off all access checking.  This switch is mainly useful for working
2152 around bugs in the access control code.
2154 @item -fcheck-new
2155 @opindex fcheck-new
2156 Check that the pointer returned by @code{operator new} is non-null
2157 before attempting to modify the storage allocated.  This check is
2158 normally unnecessary because the C++ standard specifies that
2159 @code{operator new} only returns @code{0} if it is declared
2160 @code{throw()}, in which case the compiler always checks the
2161 return value even without this option.  In all other cases, when
2162 @code{operator new} has a non-empty exception specification, memory
2163 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2164 @samp{new (nothrow)}.
2166 @item -fconstexpr-depth=@var{n}
2167 @opindex fconstexpr-depth
2168 Set the maximum nested evaluation depth for C++11 constexpr functions
2169 to @var{n}.  A limit is needed to detect endless recursion during
2170 constant expression evaluation.  The minimum specified by the standard
2171 is 512.
2173 @item -fdeduce-init-list
2174 @opindex fdeduce-init-list
2175 Enable deduction of a template type parameter as
2176 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2178 @smallexample
2179 template <class T> auto forward(T t) -> decltype (realfn (t))
2181   return realfn (t);
2184 void f()
2186   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2188 @end smallexample
2190 This deduction was implemented as a possible extension to the
2191 originally proposed semantics for the C++11 standard, but was not part
2192 of the final standard, so it is disabled by default.  This option is
2193 deprecated, and may be removed in a future version of G++.
2195 @item -ffriend-injection
2196 @opindex ffriend-injection
2197 Inject friend functions into the enclosing namespace, so that they are
2198 visible outside the scope of the class in which they are declared.
2199 Friend functions were documented to work this way in the old Annotated
2200 C++ Reference Manual.  
2201 However, in ISO C++ a friend function that is not declared
2202 in an enclosing scope can only be found using argument dependent
2203 lookup.  GCC defaults to the standard behavior.
2205 This option is for compatibility, and may be removed in a future
2206 release of G++.
2208 @item -fno-elide-constructors
2209 @opindex fno-elide-constructors
2210 The C++ standard allows an implementation to omit creating a temporary
2211 that is only used to initialize another object of the same type.
2212 Specifying this option disables that optimization, and forces G++ to
2213 call the copy constructor in all cases.
2215 @item -fno-enforce-eh-specs
2216 @opindex fno-enforce-eh-specs
2217 Don't generate code to check for violation of exception specifications
2218 at run time.  This option violates the C++ standard, but may be useful
2219 for reducing code size in production builds, much like defining
2220 @code{NDEBUG}.  This does not give user code permission to throw
2221 exceptions in violation of the exception specifications; the compiler
2222 still optimizes based on the specifications, so throwing an
2223 unexpected exception results in undefined behavior at run time.
2225 @item -fextern-tls-init
2226 @itemx -fno-extern-tls-init
2227 @opindex fextern-tls-init
2228 @opindex fno-extern-tls-init
2229 The C++11 and OpenMP standards allow @code{thread_local} and
2230 @code{threadprivate} variables to have dynamic (runtime)
2231 initialization.  To support this, any use of such a variable goes
2232 through a wrapper function that performs any necessary initialization.
2233 When the use and definition of the variable are in the same
2234 translation unit, this overhead can be optimized away, but when the
2235 use is in a different translation unit there is significant overhead
2236 even if the variable doesn't actually need dynamic initialization.  If
2237 the programmer can be sure that no use of the variable in a
2238 non-defining TU needs to trigger dynamic initialization (either
2239 because the variable is statically initialized, or a use of the
2240 variable in the defining TU will be executed before any uses in
2241 another TU), they can avoid this overhead with the
2242 @option{-fno-extern-tls-init} option.
2244 On targets that support symbol aliases, the default is
2245 @option{-fextern-tls-init}.  On targets that do not support symbol
2246 aliases, the default is @option{-fno-extern-tls-init}.
2248 @item -ffor-scope
2249 @itemx -fno-for-scope
2250 @opindex ffor-scope
2251 @opindex fno-for-scope
2252 If @option{-ffor-scope} is specified, the scope of variables declared in
2253 a @i{for-init-statement} is limited to the @code{for} loop itself,
2254 as specified by the C++ standard.
2255 If @option{-fno-for-scope} is specified, the scope of variables declared in
2256 a @i{for-init-statement} extends to the end of the enclosing scope,
2257 as was the case in old versions of G++, and other (traditional)
2258 implementations of C++.
2260 If neither flag is given, the default is to follow the standard,
2261 but to allow and give a warning for old-style code that would
2262 otherwise be invalid, or have different behavior.
2264 @item -fno-gnu-keywords
2265 @opindex fno-gnu-keywords
2266 Do not recognize @code{typeof} as a keyword, so that code can use this
2267 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2268 @option{-ansi} implies @option{-fno-gnu-keywords}.
2270 @item -fno-implicit-templates
2271 @opindex fno-implicit-templates
2272 Never emit code for non-inline templates that are instantiated
2273 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2274 @xref{Template Instantiation}, for more information.
2276 @item -fno-implicit-inline-templates
2277 @opindex fno-implicit-inline-templates
2278 Don't emit code for implicit instantiations of inline templates, either.
2279 The default is to handle inlines differently so that compiles with and
2280 without optimization need the same set of explicit instantiations.
2282 @item -fno-implement-inlines
2283 @opindex fno-implement-inlines
2284 To save space, do not emit out-of-line copies of inline functions
2285 controlled by @code{#pragma implementation}.  This causes linker
2286 errors if these functions are not inlined everywhere they are called.
2288 @item -fms-extensions
2289 @opindex fms-extensions
2290 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2291 int and getting a pointer to member function via non-standard syntax.
2293 @item -fno-nonansi-builtins
2294 @opindex fno-nonansi-builtins
2295 Disable built-in declarations of functions that are not mandated by
2296 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2297 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2299 @item -fnothrow-opt
2300 @opindex fnothrow-opt
2301 Treat a @code{throw()} exception specification as if it were a
2302 @code{noexcept} specification to reduce or eliminate the text size
2303 overhead relative to a function with no exception specification.  If
2304 the function has local variables of types with non-trivial
2305 destructors, the exception specification actually makes the
2306 function smaller because the EH cleanups for those variables can be
2307 optimized away.  The semantic effect is that an exception thrown out of
2308 a function with such an exception specification results in a call
2309 to @code{terminate} rather than @code{unexpected}.
2311 @item -fno-operator-names
2312 @opindex fno-operator-names
2313 Do not treat the operator name keywords @code{and}, @code{bitand},
2314 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2315 synonyms as keywords.
2317 @item -fno-optional-diags
2318 @opindex fno-optional-diags
2319 Disable diagnostics that the standard says a compiler does not need to
2320 issue.  Currently, the only such diagnostic issued by G++ is the one for
2321 a name having multiple meanings within a class.
2323 @item -fpermissive
2324 @opindex fpermissive
2325 Downgrade some diagnostics about nonconformant code from errors to
2326 warnings.  Thus, using @option{-fpermissive} allows some
2327 nonconforming code to compile.
2329 @item -fno-pretty-templates
2330 @opindex fno-pretty-templates
2331 When an error message refers to a specialization of a function
2332 template, the compiler normally prints the signature of the
2333 template followed by the template arguments and any typedefs or
2334 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2335 rather than @code{void f(int)}) so that it's clear which template is
2336 involved.  When an error message refers to a specialization of a class
2337 template, the compiler omits any template arguments that match
2338 the default template arguments for that template.  If either of these
2339 behaviors make it harder to understand the error message rather than
2340 easier, you can use @option{-fno-pretty-templates} to disable them.
2342 @item -frepo
2343 @opindex frepo
2344 Enable automatic template instantiation at link time.  This option also
2345 implies @option{-fno-implicit-templates}.  @xref{Template
2346 Instantiation}, for more information.
2348 @item -fno-rtti
2349 @opindex fno-rtti
2350 Disable generation of information about every class with virtual
2351 functions for use by the C++ run-time type identification features
2352 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2353 of the language, you can save some space by using this flag.  Note that
2354 exception handling uses the same information, but G++ generates it as
2355 needed. The @code{dynamic_cast} operator can still be used for casts that
2356 do not require run-time type information, i.e.@: casts to @code{void *} or to
2357 unambiguous base classes.
2359 @item -fsized-deallocation
2360 @opindex fsized-deallocation
2361 Enable the built-in global declarations
2362 @smallexample
2363 void operator delete (void *, std::size_t) noexcept;
2364 void operator delete[] (void *, std::size_t) noexcept;
2365 @end smallexample
2366 as introduced in C++14.  This is useful for user-defined replacement
2367 deallocation functions that, for example, use the size of the object
2368 to make deallocation faster.  Enabled by default under
2369 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2370 warns about places that might want to add a definition.
2372 @item -fstats
2373 @opindex fstats
2374 Emit statistics about front-end processing at the end of the compilation.
2375 This information is generally only useful to the G++ development team.
2377 @item -fstrict-enums
2378 @opindex fstrict-enums
2379 Allow the compiler to optimize using the assumption that a value of
2380 enumerated type can only be one of the values of the enumeration (as
2381 defined in the C++ standard; basically, a value that can be
2382 represented in the minimum number of bits needed to represent all the
2383 enumerators).  This assumption may not be valid if the program uses a
2384 cast to convert an arbitrary integer value to the enumerated type.
2386 @item -ftemplate-backtrace-limit=@var{n}
2387 @opindex ftemplate-backtrace-limit
2388 Set the maximum number of template instantiation notes for a single
2389 warning or error to @var{n}.  The default value is 10.
2391 @item -ftemplate-depth=@var{n}
2392 @opindex ftemplate-depth
2393 Set the maximum instantiation depth for template classes to @var{n}.
2394 A limit on the template instantiation depth is needed to detect
2395 endless recursions during template class instantiation.  ANSI/ISO C++
2396 conforming programs must not rely on a maximum depth greater than 17
2397 (changed to 1024 in C++11).  The default value is 900, as the compiler
2398 can run out of stack space before hitting 1024 in some situations.
2400 @item -fno-threadsafe-statics
2401 @opindex fno-threadsafe-statics
2402 Do not emit the extra code to use the routines specified in the C++
2403 ABI for thread-safe initialization of local statics.  You can use this
2404 option to reduce code size slightly in code that doesn't need to be
2405 thread-safe.
2407 @item -fuse-cxa-atexit
2408 @opindex fuse-cxa-atexit
2409 Register destructors for objects with static storage duration with the
2410 @code{__cxa_atexit} function rather than the @code{atexit} function.
2411 This option is required for fully standards-compliant handling of static
2412 destructors, but only works if your C library supports
2413 @code{__cxa_atexit}.
2415 @item -fno-use-cxa-get-exception-ptr
2416 @opindex fno-use-cxa-get-exception-ptr
2417 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2418 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2419 if the runtime routine is not available.
2421 @item -fvisibility-inlines-hidden
2422 @opindex fvisibility-inlines-hidden
2423 This switch declares that the user does not attempt to compare
2424 pointers to inline functions or methods where the addresses of the two functions
2425 are taken in different shared objects.
2427 The effect of this is that GCC may, effectively, mark inline methods with
2428 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2429 appear in the export table of a DSO and do not require a PLT indirection
2430 when used within the DSO@.  Enabling this option can have a dramatic effect
2431 on load and link times of a DSO as it massively reduces the size of the
2432 dynamic export table when the library makes heavy use of templates.
2434 The behavior of this switch is not quite the same as marking the
2435 methods as hidden directly, because it does not affect static variables
2436 local to the function or cause the compiler to deduce that
2437 the function is defined in only one shared object.
2439 You may mark a method as having a visibility explicitly to negate the
2440 effect of the switch for that method.  For example, if you do want to
2441 compare pointers to a particular inline method, you might mark it as
2442 having default visibility.  Marking the enclosing class with explicit
2443 visibility has no effect.
2445 Explicitly instantiated inline methods are unaffected by this option
2446 as their linkage might otherwise cross a shared library boundary.
2447 @xref{Template Instantiation}.
2449 @item -fvisibility-ms-compat
2450 @opindex fvisibility-ms-compat
2451 This flag attempts to use visibility settings to make GCC's C++
2452 linkage model compatible with that of Microsoft Visual Studio.
2454 The flag makes these changes to GCC's linkage model:
2456 @enumerate
2457 @item
2458 It sets the default visibility to @code{hidden}, like
2459 @option{-fvisibility=hidden}.
2461 @item
2462 Types, but not their members, are not hidden by default.
2464 @item
2465 The One Definition Rule is relaxed for types without explicit
2466 visibility specifications that are defined in more than one
2467 shared object: those declarations are permitted if they are
2468 permitted when this option is not used.
2469 @end enumerate
2471 In new code it is better to use @option{-fvisibility=hidden} and
2472 export those classes that are intended to be externally visible.
2473 Unfortunately it is possible for code to rely, perhaps accidentally,
2474 on the Visual Studio behavior.
2476 Among the consequences of these changes are that static data members
2477 of the same type with the same name but defined in different shared
2478 objects are different, so changing one does not change the other;
2479 and that pointers to function members defined in different shared
2480 objects may not compare equal.  When this flag is given, it is a
2481 violation of the ODR to define types with the same name differently.
2483 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
2484 @opindex fvtable-verify
2485 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2486 feature that verifies at run time, for every virtual call, that
2487 the vtable pointer through which the call is made is valid for the type of
2488 the object, and has not been corrupted or overwritten.  If an invalid vtable
2489 pointer is detected at run time, an error is reported and execution of the
2490 program is immediately halted.
2492 This option causes run-time data structures to be built at program startup,
2493 which are used for verifying the vtable pointers.  
2494 The options @samp{std} and @samp{preinit}
2495 control the timing of when these data structures are built.  In both cases the
2496 data structures are built before execution reaches @code{main}.  Using
2497 @option{-fvtable-verify=std} causes the data structures to be built after
2498 shared libraries have been loaded and initialized.
2499 @option{-fvtable-verify=preinit} causes them to be built before shared
2500 libraries have been loaded and initialized.
2502 If this option appears multiple times in the command line with different
2503 values specified, @samp{none} takes highest priority over both @samp{std} and
2504 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
2506 @item -fvtv-debug
2507 @opindex fvtv-debug
2508 When used in conjunction with @option{-fvtable-verify=std} or 
2509 @option{-fvtable-verify=preinit}, causes debug versions of the 
2510 runtime functions for the vtable verification feature to be called.  
2511 This flag also causes the compiler to log information about which 
2512 vtable pointers it finds for each class.
2513 This information is written to a file named @file{vtv_set_ptr_data.log} 
2514 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
2515 if that is defined or the current working directory otherwise.
2517 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
2518 file, be sure to delete any existing one.
2520 @item -fvtv-counts
2521 @opindex fvtv-counts
2522 This is a debugging flag.  When used in conjunction with
2523 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2524 causes the compiler to keep track of the total number of virtual calls
2525 it encounters and the number of verifications it inserts.  It also
2526 counts the number of calls to certain run-time library functions
2527 that it inserts and logs this information for each compilation unit.
2528 The compiler writes this information to a file named
2529 @file{vtv_count_data.log} in the directory named by the environment
2530 variable @env{VTV_LOGS_DIR} if that is defined or the current working
2531 directory otherwise.  It also counts the size of the vtable pointer sets
2532 for each class, and writes this information to @file{vtv_class_set_sizes.log}
2533 in the same directory.
2535 Note:  This feature @emph{appends} data to the log files.  To get fresh log
2536 files, be sure to delete any existing ones.
2538 @item -fno-weak
2539 @opindex fno-weak
2540 Do not use weak symbol support, even if it is provided by the linker.
2541 By default, G++ uses weak symbols if they are available.  This
2542 option exists only for testing, and should not be used by end-users;
2543 it results in inferior code and has no benefits.  This option may
2544 be removed in a future release of G++.
2546 @item -nostdinc++
2547 @opindex nostdinc++
2548 Do not search for header files in the standard directories specific to
2549 C++, but do still search the other standard directories.  (This option
2550 is used when building the C++ library.)
2551 @end table
2553 In addition, these optimization, warning, and code generation options
2554 have meanings only for C++ programs:
2556 @table @gcctabopt
2557 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2558 @opindex Wabi
2559 @opindex Wno-abi
2560 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2561 G++ to warn when it generates code that is probably not compatible with the
2562 vendor-neutral C++ ABI@.  Since G++ now defaults to
2563 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2564 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2565 or an older compatibility version is selected (with
2566 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2568 Although an effort has been made to warn about
2569 all such cases, there are probably some cases that are not warned about,
2570 even though G++ is generating incompatible code.  There may also be
2571 cases where warnings are emitted even though the code that is generated
2572 is compatible.
2574 You should rewrite your code to avoid these warnings if you are
2575 concerned about the fact that code generated by G++ may not be binary
2576 compatible with code generated by other compilers.
2578 @option{-Wabi} can also be used with an explicit version number to
2579 warn about compatibility with a particular @option{-fabi-version}
2580 level, e.g. @option{-Wabi=2} to warn about changes relative to
2581 @option{-fabi-version=2}.  Specifying a version number also sets
2582 @option{-fabi-compat-version=@var{n}}.
2584 The known incompatibilities in @option{-fabi-version=2} (which was the
2585 default from GCC 3.4 to 4.9) include:
2587 @itemize @bullet
2589 @item
2590 A template with a non-type template parameter of reference type was
2591 mangled incorrectly:
2592 @smallexample
2593 extern int N;
2594 template <int &> struct S @{@};
2595 void n (S<N>) @{2@}
2596 @end smallexample
2598 This was fixed in @option{-fabi-version=3}.
2600 @item
2601 SIMD vector types declared using @code{__attribute ((vector_size))} were
2602 mangled in a non-standard way that does not allow for overloading of
2603 functions taking vectors of different sizes.
2605 The mangling was changed in @option{-fabi-version=4}.
2607 @item
2608 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2609 qualifiers, and @code{decltype} of a plain declaration was folded away.
2611 These mangling issues were fixed in @option{-fabi-version=5}.
2613 @item
2614 Scoped enumerators passed as arguments to a variadic function are
2615 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2616 On most targets this does not actually affect the parameter passing
2617 ABI, as there is no way to pass an argument smaller than @code{int}.
2619 Also, the ABI changed the mangling of template argument packs,
2620 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2621 a class scope function used as a template argument.
2623 These issues were corrected in @option{-fabi-version=6}.
2625 @item
2626 Lambdas in default argument scope were mangled incorrectly, and the
2627 ABI changed the mangling of @code{nullptr_t}.
2629 These issues were corrected in @option{-fabi-version=7}.
2631 @item
2632 When mangling a function type with function-cv-qualifiers, the
2633 un-qualified function type was incorrectly treated as a substitution
2634 candidate.
2636 This was fixed in @option{-fabi-version=8}.
2637 @end itemize
2639 It also warns about psABI-related changes.  The known psABI changes at this
2640 point include:
2642 @itemize @bullet
2644 @item
2645 For SysV/x86-64, unions with @code{long double} members are 
2646 passed in memory as specified in psABI.  For example:
2648 @smallexample
2649 union U @{
2650   long double ld;
2651   int i;
2653 @end smallexample
2655 @noindent
2656 @code{union U} is always passed in memory.
2658 @end itemize
2660 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2661 @opindex Wabi-tag
2662 @opindex -Wabi-tag
2663 Warn when a type with an ABI tag is used in a context that does not
2664 have that ABI tag.  See @ref{C++ Attributes} for more information
2665 about ABI tags.
2667 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2668 @opindex Wctor-dtor-privacy
2669 @opindex Wno-ctor-dtor-privacy
2670 Warn when a class seems unusable because all the constructors or
2671 destructors in that class are private, and it has neither friends nor
2672 public static member functions.  Also warn if there are no non-private
2673 methods, and there's at least one private member function that isn't
2674 a constructor or destructor.
2676 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2677 @opindex Wdelete-non-virtual-dtor
2678 @opindex Wno-delete-non-virtual-dtor
2679 Warn when @code{delete} is used to destroy an instance of a class that
2680 has virtual functions and non-virtual destructor. It is unsafe to delete
2681 an instance of a derived class through a pointer to a base class if the
2682 base class does not have a virtual destructor.  This warning is enabled
2683 by @option{-Wall}.
2685 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2686 @opindex Wliteral-suffix
2687 @opindex Wno-literal-suffix
2688 Warn when a string or character literal is followed by a ud-suffix which does
2689 not begin with an underscore.  As a conforming extension, GCC treats such
2690 suffixes as separate preprocessing tokens in order to maintain backwards
2691 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2692 For example:
2694 @smallexample
2695 #define __STDC_FORMAT_MACROS
2696 #include <inttypes.h>
2697 #include <stdio.h>
2699 int main() @{
2700   int64_t i64 = 123;
2701   printf("My int64: %" PRId64"\n", i64);
2703 @end smallexample
2705 In this case, @code{PRId64} is treated as a separate preprocessing token.
2707 This warning is enabled by default.
2709 @item -Wlto-type-mismatch
2710 @opindex Wlto-type-mismatch
2711 @opindex Wno-lto-type-mistmach
2713 During the link-time optimization warn about type mismatches in between
2714 global declarations from different compilation units.
2715 Requires @option{-flto} to be enabled.  Enabled by default.
2717 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2718 @opindex Wnarrowing
2719 @opindex Wno-narrowing
2720 Warn when a narrowing conversion prohibited by C++11 occurs within
2721 @samp{@{ @}}, e.g.
2723 @smallexample
2724 int i = @{ 2.2 @}; // error: narrowing from double to int
2725 @end smallexample
2727 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2729 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2730 required by the standard.  Note that this does not affect the meaning
2731 of well-formed code; narrowing conversions are still considered
2732 ill-formed in SFINAE context.
2734 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2735 @opindex Wnoexcept
2736 @opindex Wno-noexcept
2737 Warn when a noexcept-expression evaluates to false because of a call
2738 to a function that does not have a non-throwing exception
2739 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2740 the compiler to never throw an exception.
2742 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2743 @opindex Wnon-virtual-dtor
2744 @opindex Wno-non-virtual-dtor
2745 Warn when a class has virtual functions and an accessible non-virtual
2746 destructor itself or in an accessible polymorphic base class, in which
2747 case it is possible but unsafe to delete an instance of a derived
2748 class through a pointer to the class itself or base class.  This
2749 warning is automatically enabled if @option{-Weffc++} is specified.
2751 @item -Wreorder @r{(C++ and Objective-C++ only)}
2752 @opindex Wreorder
2753 @opindex Wno-reorder
2754 @cindex reordering, warning
2755 @cindex warning for reordering of member initializers
2756 Warn when the order of member initializers given in the code does not
2757 match the order in which they must be executed.  For instance:
2759 @smallexample
2760 struct A @{
2761   int i;
2762   int j;
2763   A(): j (0), i (1) @{ @}
2765 @end smallexample
2767 @noindent
2768 The compiler rearranges the member initializers for @code{i}
2769 and @code{j} to match the declaration order of the members, emitting
2770 a warning to that effect.  This warning is enabled by @option{-Wall}.
2772 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2773 @opindex fext-numeric-literals
2774 @opindex fno-ext-numeric-literals
2775 Accept imaginary, fixed-point, or machine-defined
2776 literal number suffixes as GNU extensions.
2777 When this option is turned off these suffixes are treated
2778 as C++11 user-defined literal numeric suffixes.
2779 This is on by default for all pre-C++11 dialects and all GNU dialects:
2780 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2781 @option{-std=gnu++14}.
2782 This option is off by default
2783 for ISO C++11 onwards (@option{-std=c++11}, ...).
2784 @end table
2786 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2788 @table @gcctabopt
2789 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2790 @opindex Weffc++
2791 @opindex Wno-effc++
2792 Warn about violations of the following style guidelines from Scott Meyers'
2793 @cite{Effective C++} series of books:
2795 @itemize @bullet
2796 @item
2797 Define a copy constructor and an assignment operator for classes
2798 with dynamically-allocated memory.
2800 @item
2801 Prefer initialization to assignment in constructors.
2803 @item
2804 Have @code{operator=} return a reference to @code{*this}.
2806 @item
2807 Don't try to return a reference when you must return an object.
2809 @item
2810 Distinguish between prefix and postfix forms of increment and
2811 decrement operators.
2813 @item
2814 Never overload @code{&&}, @code{||}, or @code{,}.
2816 @end itemize
2818 This option also enables @option{-Wnon-virtual-dtor}, which is also
2819 one of the effective C++ recommendations.  However, the check is
2820 extended to warn about the lack of virtual destructor in accessible
2821 non-polymorphic bases classes too.
2823 When selecting this option, be aware that the standard library
2824 headers do not obey all of these guidelines; use @samp{grep -v}
2825 to filter out those warnings.
2827 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2828 @opindex Wstrict-null-sentinel
2829 @opindex Wno-strict-null-sentinel
2830 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2831 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2832 to @code{__null}.  Although it is a null pointer constant rather than a
2833 null pointer, it is guaranteed to be of the same size as a pointer.
2834 But this use is not portable across different compilers.
2836 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2837 @opindex Wno-non-template-friend
2838 @opindex Wnon-template-friend
2839 Disable warnings when non-templatized friend functions are declared
2840 within a template.  Since the advent of explicit template specification
2841 support in G++, if the name of the friend is an unqualified-id (i.e.,
2842 @samp{friend foo(int)}), the C++ language specification demands that the
2843 friend declare or define an ordinary, nontemplate function.  (Section
2844 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2845 could be interpreted as a particular specialization of a templatized
2846 function.  Because this non-conforming behavior is no longer the default
2847 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2848 check existing code for potential trouble spots and is on by default.
2849 This new compiler behavior can be turned off with
2850 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2851 but disables the helpful warning.
2853 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2854 @opindex Wold-style-cast
2855 @opindex Wno-old-style-cast
2856 Warn if an old-style (C-style) cast to a non-void type is used within
2857 a C++ program.  The new-style casts (@code{dynamic_cast},
2858 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2859 less vulnerable to unintended effects and much easier to search for.
2861 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2862 @opindex Woverloaded-virtual
2863 @opindex Wno-overloaded-virtual
2864 @cindex overloaded virtual function, warning
2865 @cindex warning for overloaded virtual function
2866 Warn when a function declaration hides virtual functions from a
2867 base class.  For example, in:
2869 @smallexample
2870 struct A @{
2871   virtual void f();
2874 struct B: public A @{
2875   void f(int);
2877 @end smallexample
2879 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2880 like:
2882 @smallexample
2883 B* b;
2884 b->f();
2885 @end smallexample
2887 @noindent
2888 fails to compile.
2890 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2891 @opindex Wno-pmf-conversions
2892 @opindex Wpmf-conversions
2893 Disable the diagnostic for converting a bound pointer to member function
2894 to a plain pointer.
2896 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2897 @opindex Wsign-promo
2898 @opindex Wno-sign-promo
2899 Warn when overload resolution chooses a promotion from unsigned or
2900 enumerated type to a signed type, over a conversion to an unsigned type of
2901 the same size.  Previous versions of G++ tried to preserve
2902 unsignedness, but the standard mandates the current behavior.
2904 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
2905 @opindex Wterminate
2906 @opindex Wno-terminate
2907 Disable the warning about a throw-expression that will immediately
2908 result in a call to @code{terminate}.
2909 @end table
2911 @node Objective-C and Objective-C++ Dialect Options
2912 @section Options Controlling Objective-C and Objective-C++ Dialects
2914 @cindex compiler options, Objective-C and Objective-C++
2915 @cindex Objective-C and Objective-C++ options, command-line
2916 @cindex options, Objective-C and Objective-C++
2917 (NOTE: This manual does not describe the Objective-C and Objective-C++
2918 languages themselves.  @xref{Standards,,Language Standards
2919 Supported by GCC}, for references.)
2921 This section describes the command-line options that are only meaningful
2922 for Objective-C and Objective-C++ programs.  You can also use most of
2923 the language-independent GNU compiler options.
2924 For example, you might compile a file @file{some_class.m} like this:
2926 @smallexample
2927 gcc -g -fgnu-runtime -O -c some_class.m
2928 @end smallexample
2930 @noindent
2931 In this example, @option{-fgnu-runtime} is an option meant only for
2932 Objective-C and Objective-C++ programs; you can use the other options with
2933 any language supported by GCC@.
2935 Note that since Objective-C is an extension of the C language, Objective-C
2936 compilations may also use options specific to the C front-end (e.g.,
2937 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2938 C++-specific options (e.g., @option{-Wabi}).
2940 Here is a list of options that are @emph{only} for compiling Objective-C
2941 and Objective-C++ programs:
2943 @table @gcctabopt
2944 @item -fconstant-string-class=@var{class-name}
2945 @opindex fconstant-string-class
2946 Use @var{class-name} as the name of the class to instantiate for each
2947 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2948 class name is @code{NXConstantString} if the GNU runtime is being used, and
2949 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2950 @option{-fconstant-cfstrings} option, if also present, overrides the
2951 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2952 to be laid out as constant CoreFoundation strings.
2954 @item -fgnu-runtime
2955 @opindex fgnu-runtime
2956 Generate object code compatible with the standard GNU Objective-C
2957 runtime.  This is the default for most types of systems.
2959 @item -fnext-runtime
2960 @opindex fnext-runtime
2961 Generate output compatible with the NeXT runtime.  This is the default
2962 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2963 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2964 used.
2966 @item -fno-nil-receivers
2967 @opindex fno-nil-receivers
2968 Assume that all Objective-C message dispatches (@code{[receiver
2969 message:arg]}) in this translation unit ensure that the receiver is
2970 not @code{nil}.  This allows for more efficient entry points in the
2971 runtime to be used.  This option is only available in conjunction with
2972 the NeXT runtime and ABI version 0 or 1.
2974 @item -fobjc-abi-version=@var{n}
2975 @opindex fobjc-abi-version
2976 Use version @var{n} of the Objective-C ABI for the selected runtime.
2977 This option is currently supported only for the NeXT runtime.  In that
2978 case, Version 0 is the traditional (32-bit) ABI without support for
2979 properties and other Objective-C 2.0 additions.  Version 1 is the
2980 traditional (32-bit) ABI with support for properties and other
2981 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2982 nothing is specified, the default is Version 0 on 32-bit target
2983 machines, and Version 2 on 64-bit target machines.
2985 @item -fobjc-call-cxx-cdtors
2986 @opindex fobjc-call-cxx-cdtors
2987 For each Objective-C class, check if any of its instance variables is a
2988 C++ object with a non-trivial default constructor.  If so, synthesize a
2989 special @code{- (id) .cxx_construct} instance method which runs
2990 non-trivial default constructors on any such instance variables, in order,
2991 and then return @code{self}.  Similarly, check if any instance variable
2992 is a C++ object with a non-trivial destructor, and if so, synthesize a
2993 special @code{- (void) .cxx_destruct} method which runs
2994 all such default destructors, in reverse order.
2996 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2997 methods thusly generated only operate on instance variables
2998 declared in the current Objective-C class, and not those inherited
2999 from superclasses.  It is the responsibility of the Objective-C
3000 runtime to invoke all such methods in an object's inheritance
3001 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3002 by the runtime immediately after a new object instance is allocated;
3003 the @code{- (void) .cxx_destruct} methods are invoked immediately
3004 before the runtime deallocates an object instance.
3006 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3007 support for invoking the @code{- (id) .cxx_construct} and
3008 @code{- (void) .cxx_destruct} methods.
3010 @item -fobjc-direct-dispatch
3011 @opindex fobjc-direct-dispatch
3012 Allow fast jumps to the message dispatcher.  On Darwin this is
3013 accomplished via the comm page.
3015 @item -fobjc-exceptions
3016 @opindex fobjc-exceptions
3017 Enable syntactic support for structured exception handling in
3018 Objective-C, similar to what is offered by C++ and Java.  This option
3019 is required to use the Objective-C keywords @code{@@try},
3020 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3021 @code{@@synchronized}.  This option is available with both the GNU
3022 runtime and the NeXT runtime (but not available in conjunction with
3023 the NeXT runtime on Mac OS X 10.2 and earlier).
3025 @item -fobjc-gc
3026 @opindex fobjc-gc
3027 Enable garbage collection (GC) in Objective-C and Objective-C++
3028 programs.  This option is only available with the NeXT runtime; the
3029 GNU runtime has a different garbage collection implementation that
3030 does not require special compiler flags.
3032 @item -fobjc-nilcheck
3033 @opindex fobjc-nilcheck
3034 For the NeXT runtime with version 2 of the ABI, check for a nil
3035 receiver in method invocations before doing the actual method call.
3036 This is the default and can be disabled using
3037 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3038 checked for nil in this way no matter what this flag is set to.
3039 Currently this flag does nothing when the GNU runtime, or an older
3040 version of the NeXT runtime ABI, is used.
3042 @item -fobjc-std=objc1
3043 @opindex fobjc-std
3044 Conform to the language syntax of Objective-C 1.0, the language
3045 recognized by GCC 4.0.  This only affects the Objective-C additions to
3046 the C/C++ language; it does not affect conformance to C/C++ standards,
3047 which is controlled by the separate C/C++ dialect option flags.  When
3048 this option is used with the Objective-C or Objective-C++ compiler,
3049 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3050 This is useful if you need to make sure that your Objective-C code can
3051 be compiled with older versions of GCC@.
3053 @item -freplace-objc-classes
3054 @opindex freplace-objc-classes
3055 Emit a special marker instructing @command{ld(1)} not to statically link in
3056 the resulting object file, and allow @command{dyld(1)} to load it in at
3057 run time instead.  This is used in conjunction with the Fix-and-Continue
3058 debugging mode, where the object file in question may be recompiled and
3059 dynamically reloaded in the course of program execution, without the need
3060 to restart the program itself.  Currently, Fix-and-Continue functionality
3061 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3062 and later.
3064 @item -fzero-link
3065 @opindex fzero-link
3066 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3067 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3068 compile time) with static class references that get initialized at load time,
3069 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3070 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3071 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3072 for individual class implementations to be modified during program execution.
3073 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3074 regardless of command-line options.
3076 @item -fno-local-ivars
3077 @opindex fno-local-ivars
3078 @opindex flocal-ivars
3079 By default instance variables in Objective-C can be accessed as if
3080 they were local variables from within the methods of the class they're
3081 declared in.  This can lead to shadowing between instance variables
3082 and other variables declared either locally inside a class method or
3083 globally with the same name.  Specifying the @option{-fno-local-ivars}
3084 flag disables this behavior thus avoiding variable shadowing issues.
3086 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3087 @opindex fivar-visibility
3088 Set the default instance variable visibility to the specified option
3089 so that instance variables declared outside the scope of any access
3090 modifier directives default to the specified visibility.
3092 @item -gen-decls
3093 @opindex gen-decls
3094 Dump interface declarations for all classes seen in the source file to a
3095 file named @file{@var{sourcename}.decl}.
3097 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3098 @opindex Wassign-intercept
3099 @opindex Wno-assign-intercept
3100 Warn whenever an Objective-C assignment is being intercepted by the
3101 garbage collector.
3103 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3104 @opindex Wno-protocol
3105 @opindex Wprotocol
3106 If a class is declared to implement a protocol, a warning is issued for
3107 every method in the protocol that is not implemented by the class.  The
3108 default behavior is to issue a warning for every method not explicitly
3109 implemented in the class, even if a method implementation is inherited
3110 from the superclass.  If you use the @option{-Wno-protocol} option, then
3111 methods inherited from the superclass are considered to be implemented,
3112 and no warning is issued for them.
3114 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3115 @opindex Wselector
3116 @opindex Wno-selector
3117 Warn if multiple methods of different types for the same selector are
3118 found during compilation.  The check is performed on the list of methods
3119 in the final stage of compilation.  Additionally, a check is performed
3120 for each selector appearing in a @code{@@selector(@dots{})}
3121 expression, and a corresponding method for that selector has been found
3122 during compilation.  Because these checks scan the method table only at
3123 the end of compilation, these warnings are not produced if the final
3124 stage of compilation is not reached, for example because an error is
3125 found during compilation, or because the @option{-fsyntax-only} option is
3126 being used.
3128 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3129 @opindex Wstrict-selector-match
3130 @opindex Wno-strict-selector-match
3131 Warn if multiple methods with differing argument and/or return types are
3132 found for a given selector when attempting to send a message using this
3133 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3134 is off (which is the default behavior), the compiler omits such warnings
3135 if any differences found are confined to types that share the same size
3136 and alignment.
3138 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3139 @opindex Wundeclared-selector
3140 @opindex Wno-undeclared-selector
3141 Warn if a @code{@@selector(@dots{})} expression referring to an
3142 undeclared selector is found.  A selector is considered undeclared if no
3143 method with that name has been declared before the
3144 @code{@@selector(@dots{})} expression, either explicitly in an
3145 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3146 an @code{@@implementation} section.  This option always performs its
3147 checks as soon as a @code{@@selector(@dots{})} expression is found,
3148 while @option{-Wselector} only performs its checks in the final stage of
3149 compilation.  This also enforces the coding style convention
3150 that methods and selectors must be declared before being used.
3152 @item -print-objc-runtime-info
3153 @opindex print-objc-runtime-info
3154 Generate C header describing the largest structure that is passed by
3155 value, if any.
3157 @end table
3159 @node Diagnostic Message Formatting Options
3160 @section Options to Control Diagnostic Messages Formatting
3161 @cindex options to control diagnostics formatting
3162 @cindex diagnostic messages
3163 @cindex message formatting
3165 Traditionally, diagnostic messages have been formatted irrespective of
3166 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3167 options described below
3168 to control the formatting algorithm for diagnostic messages, 
3169 e.g.@: how many characters per line, how often source location
3170 information should be reported.  Note that some language front ends may not
3171 honor these options.
3173 @table @gcctabopt
3174 @item -fmessage-length=@var{n}
3175 @opindex fmessage-length
3176 Try to format error messages so that they fit on lines of about
3177 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3178 done; each error message appears on a single line.  This is the
3179 default for all front ends.
3181 @item -fdiagnostics-show-location=once
3182 @opindex fdiagnostics-show-location
3183 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3184 reporter to emit source location information @emph{once}; that is, in
3185 case the message is too long to fit on a single physical line and has to
3186 be wrapped, the source location won't be emitted (as prefix) again,
3187 over and over, in subsequent continuation lines.  This is the default
3188 behavior.
3190 @item -fdiagnostics-show-location=every-line
3191 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3192 messages reporter to emit the same source location information (as
3193 prefix) for physical lines that result from the process of breaking
3194 a message which is too long to fit on a single line.
3196 @item -fdiagnostics-color[=@var{WHEN}]
3197 @itemx -fno-diagnostics-color
3198 @opindex fdiagnostics-color
3199 @cindex highlight, color, colour
3200 @vindex GCC_COLORS @r{environment variable}
3201 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3202 or @samp{auto}.  The default depends on how the compiler has been configured,
3203 it can be any of the above @var{WHEN} options or also @samp{never}
3204 if @env{GCC_COLORS} environment variable isn't present in the environment,
3205 and @samp{auto} otherwise.
3206 @samp{auto} means to use color only when the standard error is a terminal.
3207 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3208 aliases for @option{-fdiagnostics-color=always} and
3209 @option{-fdiagnostics-color=never}, respectively.
3211 The colors are defined by the environment variable @env{GCC_COLORS}.
3212 Its value is a colon-separated list of capabilities and Select Graphic
3213 Rendition (SGR) substrings. SGR commands are interpreted by the
3214 terminal or terminal emulator.  (See the section in the documentation
3215 of your text terminal for permitted values and their meanings as
3216 character attributes.)  These substring values are integers in decimal
3217 representation and can be concatenated with semicolons.
3218 Common values to concatenate include
3219 @samp{1} for bold,
3220 @samp{4} for underline,
3221 @samp{5} for blink,
3222 @samp{7} for inverse,
3223 @samp{39} for default foreground color,
3224 @samp{30} to @samp{37} for foreground colors,
3225 @samp{90} to @samp{97} for 16-color mode foreground colors,
3226 @samp{38;5;0} to @samp{38;5;255}
3227 for 88-color and 256-color modes foreground colors,
3228 @samp{49} for default background color,
3229 @samp{40} to @samp{47} for background colors,
3230 @samp{100} to @samp{107} for 16-color mode background colors,
3231 and @samp{48;5;0} to @samp{48;5;255}
3232 for 88-color and 256-color modes background colors.
3234 The default @env{GCC_COLORS} is
3235 @smallexample
3236 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3237 @end smallexample
3238 @noindent
3239 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3240 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3241 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3242 string disables colors.
3243 Supported capabilities are as follows.
3245 @table @code
3246 @item error=
3247 @vindex error GCC_COLORS @r{capability}
3248 SGR substring for error: markers.
3250 @item warning=
3251 @vindex warning GCC_COLORS @r{capability}
3252 SGR substring for warning: markers.
3254 @item note=
3255 @vindex note GCC_COLORS @r{capability}
3256 SGR substring for note: markers.
3258 @item caret=
3259 @vindex caret GCC_COLORS @r{capability}
3260 SGR substring for caret line.
3262 @item locus=
3263 @vindex locus GCC_COLORS @r{capability}
3264 SGR substring for location information, @samp{file:line} or
3265 @samp{file:line:column} etc.
3267 @item quote=
3268 @vindex quote GCC_COLORS @r{capability}
3269 SGR substring for information printed within quotes.
3270 @end table
3272 @item -fno-diagnostics-show-option
3273 @opindex fno-diagnostics-show-option
3274 @opindex fdiagnostics-show-option
3275 By default, each diagnostic emitted includes text indicating the
3276 command-line option that directly controls the diagnostic (if such an
3277 option is known to the diagnostic machinery).  Specifying the
3278 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3280 @item -fno-diagnostics-show-caret
3281 @opindex fno-diagnostics-show-caret
3282 @opindex fdiagnostics-show-caret
3283 By default, each diagnostic emitted includes the original source line
3284 and a caret '^' indicating the column.  This option suppresses this
3285 information.  The source line is truncated to @var{n} characters, if
3286 the @option{-fmessage-length=n} option is given.  When the output is done
3287 to the terminal, the width is limited to the width given by the
3288 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3290 @end table
3292 @node Warning Options
3293 @section Options to Request or Suppress Warnings
3294 @cindex options to control warnings
3295 @cindex warning messages
3296 @cindex messages, warning
3297 @cindex suppressing warnings
3299 Warnings are diagnostic messages that report constructions that
3300 are not inherently erroneous but that are risky or suggest there
3301 may have been an error.
3303 The following language-independent options do not enable specific
3304 warnings but control the kinds of diagnostics produced by GCC@.
3306 @table @gcctabopt
3307 @cindex syntax checking
3308 @item -fsyntax-only
3309 @opindex fsyntax-only
3310 Check the code for syntax errors, but don't do anything beyond that.
3312 @item -fmax-errors=@var{n}
3313 @opindex fmax-errors
3314 Limits the maximum number of error messages to @var{n}, at which point
3315 GCC bails out rather than attempting to continue processing the source
3316 code.  If @var{n} is 0 (the default), there is no limit on the number
3317 of error messages produced.  If @option{-Wfatal-errors} is also
3318 specified, then @option{-Wfatal-errors} takes precedence over this
3319 option.
3321 @item -w
3322 @opindex w
3323 Inhibit all warning messages.
3325 @item -Werror
3326 @opindex Werror
3327 @opindex Wno-error
3328 Make all warnings into errors.
3330 @item -Werror=
3331 @opindex Werror=
3332 @opindex Wno-error=
3333 Make the specified warning into an error.  The specifier for a warning
3334 is appended; for example @option{-Werror=switch} turns the warnings
3335 controlled by @option{-Wswitch} into errors.  This switch takes a
3336 negative form, to be used to negate @option{-Werror} for specific
3337 warnings; for example @option{-Wno-error=switch} makes
3338 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3339 is in effect.
3341 The warning message for each controllable warning includes the
3342 option that controls the warning.  That option can then be used with
3343 @option{-Werror=} and @option{-Wno-error=} as described above.
3344 (Printing of the option in the warning message can be disabled using the
3345 @option{-fno-diagnostics-show-option} flag.)
3347 Note that specifying @option{-Werror=}@var{foo} automatically implies
3348 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3349 imply anything.
3351 @item -Wfatal-errors
3352 @opindex Wfatal-errors
3353 @opindex Wno-fatal-errors
3354 This option causes the compiler to abort compilation on the first error
3355 occurred rather than trying to keep going and printing further error
3356 messages.
3358 @end table
3360 You can request many specific warnings with options beginning with
3361 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3362 implicit declarations.  Each of these specific warning options also
3363 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3364 example, @option{-Wno-implicit}.  This manual lists only one of the
3365 two forms, whichever is not the default.  For further
3366 language-specific options also refer to @ref{C++ Dialect Options} and
3367 @ref{Objective-C and Objective-C++ Dialect Options}.
3369 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3370 options, such as @option{-Wunused}, which may turn on further options,
3371 such as @option{-Wunused-value}. The combined effect of positive and
3372 negative forms is that more specific options have priority over less
3373 specific ones, independently of their position in the command-line. For
3374 options of the same specificity, the last one takes effect. Options
3375 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3376 as if they appeared at the end of the command-line.
3378 When an unrecognized warning option is requested (e.g.,
3379 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3380 that the option is not recognized.  However, if the @option{-Wno-} form
3381 is used, the behavior is slightly different: no diagnostic is
3382 produced for @option{-Wno-unknown-warning} unless other diagnostics
3383 are being produced.  This allows the use of new @option{-Wno-} options
3384 with old compilers, but if something goes wrong, the compiler
3385 warns that an unrecognized option is present.
3387 @table @gcctabopt
3388 @item -Wpedantic
3389 @itemx -pedantic
3390 @opindex pedantic
3391 @opindex Wpedantic
3392 Issue all the warnings demanded by strict ISO C and ISO C++;
3393 reject all programs that use forbidden extensions, and some other
3394 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3395 version of the ISO C standard specified by any @option{-std} option used.
3397 Valid ISO C and ISO C++ programs should compile properly with or without
3398 this option (though a rare few require @option{-ansi} or a
3399 @option{-std} option specifying the required version of ISO C)@.  However,
3400 without this option, certain GNU extensions and traditional C and C++
3401 features are supported as well.  With this option, they are rejected.
3403 @option{-Wpedantic} does not cause warning messages for use of the
3404 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3405 warnings are also disabled in the expression that follows
3406 @code{__extension__}.  However, only system header files should use
3407 these escape routes; application programs should avoid them.
3408 @xref{Alternate Keywords}.
3410 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3411 C conformance.  They soon find that it does not do quite what they want:
3412 it finds some non-ISO practices, but not all---only those for which
3413 ISO C @emph{requires} a diagnostic, and some others for which
3414 diagnostics have been added.
3416 A feature to report any failure to conform to ISO C might be useful in
3417 some instances, but would require considerable additional work and would
3418 be quite different from @option{-Wpedantic}.  We don't have plans to
3419 support such a feature in the near future.
3421 Where the standard specified with @option{-std} represents a GNU
3422 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3423 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3424 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3425 where they are required by the base standard.  (It does not make sense
3426 for such warnings to be given only for features not in the specified GNU
3427 C dialect, since by definition the GNU dialects of C include all
3428 features the compiler supports with the given option, and there would be
3429 nothing to warn about.)
3431 @item -pedantic-errors
3432 @opindex pedantic-errors
3433 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3434 requires a diagnostic, in some cases where there is undefined behavior
3435 at compile-time and in some other cases that do not prevent compilation
3436 of programs that are valid according to the standard. This is not
3437 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3438 by this option and not enabled by the latter and vice versa.
3440 @item -Wall
3441 @opindex Wall
3442 @opindex Wno-all
3443 This enables all the warnings about constructions that some users
3444 consider questionable, and that are easy to avoid (or modify to
3445 prevent the warning), even in conjunction with macros.  This also
3446 enables some language-specific warnings described in @ref{C++ Dialect
3447 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3449 @option{-Wall} turns on the following warning flags:
3451 @gccoptlist{-Waddress   @gol
3452 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3453 -Wc++11-compat  -Wc++14-compat@gol
3454 -Wchar-subscripts  @gol
3455 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3456 -Wimplicit-int @r{(C and Objective-C only)} @gol
3457 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3458 -Wbool-compare  @gol
3459 -Wcomment  @gol
3460 -Wformat   @gol
3461 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3462 -Wmaybe-uninitialized @gol
3463 -Wmissing-braces @r{(only for C/ObjC)} @gol
3464 -Wnonnull  @gol
3465 -Wopenmp-simd @gol
3466 -Wparentheses  @gol
3467 -Wpointer-sign  @gol
3468 -Wreorder   @gol
3469 -Wreturn-type  @gol
3470 -Wsequence-point  @gol
3471 -Wsign-compare @r{(only in C++)}  @gol
3472 -Wstrict-aliasing  @gol
3473 -Wstrict-overflow=1  @gol
3474 -Wswitch  @gol
3475 -Wtautological-compare  @gol
3476 -Wtrigraphs  @gol
3477 -Wuninitialized  @gol
3478 -Wunknown-pragmas  @gol
3479 -Wunused-function  @gol
3480 -Wunused-label     @gol
3481 -Wunused-value     @gol
3482 -Wunused-variable  @gol
3483 -Wvolatile-register-var @gol
3486 Note that some warning flags are not implied by @option{-Wall}.  Some of
3487 them warn about constructions that users generally do not consider
3488 questionable, but which occasionally you might wish to check for;
3489 others warn about constructions that are necessary or hard to avoid in
3490 some cases, and there is no simple way to modify the code to suppress
3491 the warning. Some of them are enabled by @option{-Wextra} but many of
3492 them must be enabled individually.
3494 @item -Wextra
3495 @opindex W
3496 @opindex Wextra
3497 @opindex Wno-extra
3498 This enables some extra warning flags that are not enabled by
3499 @option{-Wall}. (This option used to be called @option{-W}.  The older
3500 name is still supported, but the newer name is more descriptive.)
3502 @gccoptlist{-Wclobbered  @gol
3503 -Wempty-body  @gol
3504 -Wignored-qualifiers @gol
3505 -Wmissing-field-initializers  @gol
3506 -Wmissing-parameter-type @r{(C only)}  @gol
3507 -Wold-style-declaration @r{(C only)}  @gol
3508 -Woverride-init  @gol
3509 -Wsign-compare  @gol
3510 -Wtype-limits  @gol
3511 -Wuninitialized  @gol
3512 -Wshift-negative-value  @gol
3513 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3514 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3517 The option @option{-Wextra} also prints warning messages for the
3518 following cases:
3520 @itemize @bullet
3522 @item
3523 A pointer is compared against integer zero with @code{<}, @code{<=},
3524 @code{>}, or @code{>=}.
3526 @item
3527 (C++ only) An enumerator and a non-enumerator both appear in a
3528 conditional expression.
3530 @item
3531 (C++ only) Ambiguous virtual bases.
3533 @item
3534 (C++ only) Subscripting an array that has been declared @code{register}.
3536 @item
3537 (C++ only) Taking the address of a variable that has been declared
3538 @code{register}.
3540 @item
3541 (C++ only) A base class is not initialized in a derived class's copy
3542 constructor.
3544 @end itemize
3546 @item -Wchar-subscripts
3547 @opindex Wchar-subscripts
3548 @opindex Wno-char-subscripts
3549 Warn if an array subscript has type @code{char}.  This is a common cause
3550 of error, as programmers often forget that this type is signed on some
3551 machines.
3552 This warning is enabled by @option{-Wall}.
3554 @item -Wcomment
3555 @opindex Wcomment
3556 @opindex Wno-comment
3557 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3558 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3559 This warning is enabled by @option{-Wall}.
3561 @item -Wno-coverage-mismatch
3562 @opindex Wno-coverage-mismatch
3563 Warn if feedback profiles do not match when using the
3564 @option{-fprofile-use} option.
3565 If a source file is changed between compiling with @option{-fprofile-gen} and
3566 with @option{-fprofile-use}, the files with the profile feedback can fail
3567 to match the source file and GCC cannot use the profile feedback
3568 information.  By default, this warning is enabled and is treated as an
3569 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3570 warning or @option{-Wno-error=coverage-mismatch} can be used to
3571 disable the error.  Disabling the error for this warning can result in
3572 poorly optimized code and is useful only in the
3573 case of very minor changes such as bug fixes to an existing code-base.
3574 Completely disabling the warning is not recommended.
3576 @item -Wno-cpp
3577 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3579 Suppress warning messages emitted by @code{#warning} directives.
3581 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3582 @opindex Wdouble-promotion
3583 @opindex Wno-double-promotion
3584 Give a warning when a value of type @code{float} is implicitly
3585 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3586 floating-point unit implement @code{float} in hardware, but emulate
3587 @code{double} in software.  On such a machine, doing computations
3588 using @code{double} values is much more expensive because of the
3589 overhead required for software emulation.
3591 It is easy to accidentally do computations with @code{double} because
3592 floating-point literals are implicitly of type @code{double}.  For
3593 example, in:
3594 @smallexample
3595 @group
3596 float area(float radius)
3598    return 3.14159 * radius * radius;
3600 @end group
3601 @end smallexample
3602 the compiler performs the entire computation with @code{double}
3603 because the floating-point literal is a @code{double}.
3605 @item -Wformat
3606 @itemx -Wformat=@var{n}
3607 @opindex Wformat
3608 @opindex Wno-format
3609 @opindex ffreestanding
3610 @opindex fno-builtin
3611 @opindex Wformat=
3612 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3613 the arguments supplied have types appropriate to the format string
3614 specified, and that the conversions specified in the format string make
3615 sense.  This includes standard functions, and others specified by format
3616 attributes (@pxref{Function Attributes}), in the @code{printf},
3617 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3618 not in the C standard) families (or other target-specific families).
3619 Which functions are checked without format attributes having been
3620 specified depends on the standard version selected, and such checks of
3621 functions without the attribute specified are disabled by
3622 @option{-ffreestanding} or @option{-fno-builtin}.
3624 The formats are checked against the format features supported by GNU
3625 libc version 2.2.  These include all ISO C90 and C99 features, as well
3626 as features from the Single Unix Specification and some BSD and GNU
3627 extensions.  Other library implementations may not support all these
3628 features; GCC does not support warning about features that go beyond a
3629 particular library's limitations.  However, if @option{-Wpedantic} is used
3630 with @option{-Wformat}, warnings are given about format features not
3631 in the selected standard version (but not for @code{strfmon} formats,
3632 since those are not in any version of the C standard).  @xref{C Dialect
3633 Options,,Options Controlling C Dialect}.
3635 @table @gcctabopt
3636 @item -Wformat=1
3637 @itemx -Wformat
3638 @opindex Wformat
3639 @opindex Wformat=1
3640 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3641 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3642 @option{-Wformat} also checks for null format arguments for several
3643 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3644 aspects of this level of format checking can be disabled by the
3645 options: @option{-Wno-format-contains-nul},
3646 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3647 @option{-Wformat} is enabled by @option{-Wall}.
3649 @item -Wno-format-contains-nul
3650 @opindex Wno-format-contains-nul
3651 @opindex Wformat-contains-nul
3652 If @option{-Wformat} is specified, do not warn about format strings that
3653 contain NUL bytes.
3655 @item -Wno-format-extra-args
3656 @opindex Wno-format-extra-args
3657 @opindex Wformat-extra-args
3658 If @option{-Wformat} is specified, do not warn about excess arguments to a
3659 @code{printf} or @code{scanf} format function.  The C standard specifies
3660 that such arguments are ignored.
3662 Where the unused arguments lie between used arguments that are
3663 specified with @samp{$} operand number specifications, normally
3664 warnings are still given, since the implementation could not know what
3665 type to pass to @code{va_arg} to skip the unused arguments.  However,
3666 in the case of @code{scanf} formats, this option suppresses the
3667 warning if the unused arguments are all pointers, since the Single
3668 Unix Specification says that such unused arguments are allowed.
3670 @item -Wno-format-zero-length
3671 @opindex Wno-format-zero-length
3672 @opindex Wformat-zero-length
3673 If @option{-Wformat} is specified, do not warn about zero-length formats.
3674 The C standard specifies that zero-length formats are allowed.
3677 @item -Wformat=2
3678 @opindex Wformat=2
3679 Enable @option{-Wformat} plus additional format checks.  Currently
3680 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3681 -Wformat-y2k}.
3683 @item -Wformat-nonliteral
3684 @opindex Wformat-nonliteral
3685 @opindex Wno-format-nonliteral
3686 If @option{-Wformat} is specified, also warn if the format string is not a
3687 string literal and so cannot be checked, unless the format function
3688 takes its format arguments as a @code{va_list}.
3690 @item -Wformat-security
3691 @opindex Wformat-security
3692 @opindex Wno-format-security
3693 If @option{-Wformat} is specified, also warn about uses of format
3694 functions that represent possible security problems.  At present, this
3695 warns about calls to @code{printf} and @code{scanf} functions where the
3696 format string is not a string literal and there are no format arguments,
3697 as in @code{printf (foo);}.  This may be a security hole if the format
3698 string came from untrusted input and contains @samp{%n}.  (This is
3699 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3700 in future warnings may be added to @option{-Wformat-security} that are not
3701 included in @option{-Wformat-nonliteral}.)
3703 @item -Wformat-signedness
3704 @opindex Wformat-signedness
3705 @opindex Wno-format-signedness
3706 If @option{-Wformat} is specified, also warn if the format string
3707 requires an unsigned argument and the argument is signed and vice versa.
3709 @item -Wformat-y2k
3710 @opindex Wformat-y2k
3711 @opindex Wno-format-y2k
3712 If @option{-Wformat} is specified, also warn about @code{strftime}
3713 formats that may yield only a two-digit year.
3714 @end table
3716 @item -Wnonnull
3717 @opindex Wnonnull
3718 @opindex Wno-nonnull
3719 Warn about passing a null pointer for arguments marked as
3720 requiring a non-null value by the @code{nonnull} function attribute.
3722 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3723 can be disabled with the @option{-Wno-nonnull} option.
3725 @item -Wnull-dereference
3726 @opindex Wnull-dereference
3727 @opindex Wno-null-dereference
3728 Warn if the compiler detects paths that trigger erroneous or
3729 undefined behavior due to dereferencing a null pointer.  This option
3730 is only active when @option{-fdelete-null-pointer-checks} is active,
3731 which is enabled by optimizations in most targets.  The precision of
3732 the warnings depends on the optimization options used.
3734 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3735 @opindex Winit-self
3736 @opindex Wno-init-self
3737 Warn about uninitialized variables that are initialized with themselves.
3738 Note this option can only be used with the @option{-Wuninitialized} option.
3740 For example, GCC warns about @code{i} being uninitialized in the
3741 following snippet only when @option{-Winit-self} has been specified:
3742 @smallexample
3743 @group
3744 int f()
3746   int i = i;
3747   return i;
3749 @end group
3750 @end smallexample
3752 This warning is enabled by @option{-Wall} in C++.
3754 @item -Wimplicit-int @r{(C and Objective-C only)}
3755 @opindex Wimplicit-int
3756 @opindex Wno-implicit-int
3757 Warn when a declaration does not specify a type.
3758 This warning is enabled by @option{-Wall}.
3760 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3761 @opindex Wimplicit-function-declaration
3762 @opindex Wno-implicit-function-declaration
3763 Give a warning whenever a function is used before being declared. In
3764 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3765 enabled by default and it is made into an error by
3766 @option{-pedantic-errors}. This warning is also enabled by
3767 @option{-Wall}.
3769 @item -Wimplicit @r{(C and Objective-C only)}
3770 @opindex Wimplicit
3771 @opindex Wno-implicit
3772 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3773 This warning is enabled by @option{-Wall}.
3775 @item -Wignored-qualifiers @r{(C and C++ only)}
3776 @opindex Wignored-qualifiers
3777 @opindex Wno-ignored-qualifiers
3778 Warn if the return type of a function has a type qualifier
3779 such as @code{const}.  For ISO C such a type qualifier has no effect,
3780 since the value returned by a function is not an lvalue.
3781 For C++, the warning is only emitted for scalar types or @code{void}.
3782 ISO C prohibits qualified @code{void} return types on function
3783 definitions, so such return types always receive a warning
3784 even without this option.
3786 This warning is also enabled by @option{-Wextra}.
3788 @item -Wmain
3789 @opindex Wmain
3790 @opindex Wno-main
3791 Warn if the type of @code{main} is suspicious.  @code{main} should be
3792 a function with external linkage, returning int, taking either zero
3793 arguments, two, or three arguments of appropriate types.  This warning
3794 is enabled by default in C++ and is enabled by either @option{-Wall}
3795 or @option{-Wpedantic}.
3797 @item -Wmisleading-indentation @r{(C and C++ only)}
3798 @opindex Wmisleading-indentation
3799 @opindex Wno-misleading-indentation
3800 Warn when the indentation of the code does not reflect the block structure.
3801 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
3802 @code{for} clauses with a guarded statement that does not use braces,
3803 followed by an unguarded statement with the same indentation.
3805 This warning is disabled by default.
3807 In the following example, the call to ``bar'' is misleadingly indented as
3808 if it were guarded by the ``if'' conditional.
3810 @smallexample
3811   if (some_condition ())
3812     foo ();
3813     bar ();  /* Gotcha: this is not guarded by the "if".  */
3814 @end smallexample
3816 In the case of mixed tabs and spaces, the warning uses the
3817 @option{-ftabstop=} option to determine if the statements line up
3818 (defaulting to 8).
3820 The warning is not issued for code involving multiline preprocessor logic
3821 such as the following example.
3823 @smallexample
3824   if (flagA)
3825     foo (0);
3826 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
3827   if (flagB)
3828 #endif
3829     foo (1);
3830 @end smallexample
3832 The warning is not issued after a @code{#line} directive, since this
3833 typically indicates autogenerated code, and no assumptions can be made
3834 about the layout of the file that the directive references.
3836 @item -Wmissing-braces
3837 @opindex Wmissing-braces
3838 @opindex Wno-missing-braces
3839 Warn if an aggregate or union initializer is not fully bracketed.  In
3840 the following example, the initializer for @code{a} is not fully
3841 bracketed, but that for @code{b} is fully bracketed.  This warning is
3842 enabled by @option{-Wall} in C.
3844 @smallexample
3845 int a[2][2] = @{ 0, 1, 2, 3 @};
3846 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3847 @end smallexample
3849 This warning is enabled by @option{-Wall}.
3851 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3852 @opindex Wmissing-include-dirs
3853 @opindex Wno-missing-include-dirs
3854 Warn if a user-supplied include directory does not exist.
3856 @item -Wparentheses
3857 @opindex Wparentheses
3858 @opindex Wno-parentheses
3859 Warn if parentheses are omitted in certain contexts, such
3860 as when there is an assignment in a context where a truth value
3861 is expected, or when operators are nested whose precedence people
3862 often get confused about.
3864 Also warn if a comparison like @code{x<=y<=z} appears; this is
3865 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3866 interpretation from that of ordinary mathematical notation.
3868 Also warn about constructions where there may be confusion to which
3869 @code{if} statement an @code{else} branch belongs.  Here is an example of
3870 such a case:
3872 @smallexample
3873 @group
3875   if (a)
3876     if (b)
3877       foo ();
3878   else
3879     bar ();
3881 @end group
3882 @end smallexample
3884 In C/C++, every @code{else} branch belongs to the innermost possible
3885 @code{if} statement, which in this example is @code{if (b)}.  This is
3886 often not what the programmer expected, as illustrated in the above
3887 example by indentation the programmer chose.  When there is the
3888 potential for this confusion, GCC issues a warning when this flag
3889 is specified.  To eliminate the warning, add explicit braces around
3890 the innermost @code{if} statement so there is no way the @code{else}
3891 can belong to the enclosing @code{if}.  The resulting code
3892 looks like this:
3894 @smallexample
3895 @group
3897   if (a)
3898     @{
3899       if (b)
3900         foo ();
3901       else
3902         bar ();
3903     @}
3905 @end group
3906 @end smallexample
3908 Also warn for dangerous uses of the GNU extension to
3909 @code{?:} with omitted middle operand. When the condition
3910 in the @code{?}: operator is a boolean expression, the omitted value is
3911 always 1.  Often programmers expect it to be a value computed
3912 inside the conditional expression instead.
3914 This warning is enabled by @option{-Wall}.
3916 @item -Wsequence-point
3917 @opindex Wsequence-point
3918 @opindex Wno-sequence-point
3919 Warn about code that may have undefined semantics because of violations
3920 of sequence point rules in the C and C++ standards.
3922 The C and C++ standards define the order in which expressions in a C/C++
3923 program are evaluated in terms of @dfn{sequence points}, which represent
3924 a partial ordering between the execution of parts of the program: those
3925 executed before the sequence point, and those executed after it.  These
3926 occur after the evaluation of a full expression (one which is not part
3927 of a larger expression), after the evaluation of the first operand of a
3928 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3929 function is called (but after the evaluation of its arguments and the
3930 expression denoting the called function), and in certain other places.
3931 Other than as expressed by the sequence point rules, the order of
3932 evaluation of subexpressions of an expression is not specified.  All
3933 these rules describe only a partial order rather than a total order,
3934 since, for example, if two functions are called within one expression
3935 with no sequence point between them, the order in which the functions
3936 are called is not specified.  However, the standards committee have
3937 ruled that function calls do not overlap.
3939 It is not specified when between sequence points modifications to the
3940 values of objects take effect.  Programs whose behavior depends on this
3941 have undefined behavior; the C and C++ standards specify that ``Between
3942 the previous and next sequence point an object shall have its stored
3943 value modified at most once by the evaluation of an expression.
3944 Furthermore, the prior value shall be read only to determine the value
3945 to be stored.''.  If a program breaks these rules, the results on any
3946 particular implementation are entirely unpredictable.
3948 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3949 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3950 diagnosed by this option, and it may give an occasional false positive
3951 result, but in general it has been found fairly effective at detecting
3952 this sort of problem in programs.
3954 The standard is worded confusingly, therefore there is some debate
3955 over the precise meaning of the sequence point rules in subtle cases.
3956 Links to discussions of the problem, including proposed formal
3957 definitions, may be found on the GCC readings page, at
3958 @uref{http://gcc.gnu.org/@/readings.html}.
3960 This warning is enabled by @option{-Wall} for C and C++.
3962 @item -Wno-return-local-addr
3963 @opindex Wno-return-local-addr
3964 @opindex Wreturn-local-addr
3965 Do not warn about returning a pointer (or in C++, a reference) to a
3966 variable that goes out of scope after the function returns.
3968 @item -Wreturn-type
3969 @opindex Wreturn-type
3970 @opindex Wno-return-type
3971 Warn whenever a function is defined with a return type that defaults
3972 to @code{int}.  Also warn about any @code{return} statement with no
3973 return value in a function whose return type is not @code{void}
3974 (falling off the end of the function body is considered returning
3975 without a value), and about a @code{return} statement with an
3976 expression in a function whose return type is @code{void}.
3978 For C++, a function without return type always produces a diagnostic
3979 message, even when @option{-Wno-return-type} is specified.  The only
3980 exceptions are @code{main} and functions defined in system headers.
3982 This warning is enabled by @option{-Wall}.
3984 @item -Wshift-count-negative
3985 @opindex Wshift-count-negative
3986 @opindex Wno-shift-count-negative
3987 Warn if shift count is negative. This warning is enabled by default.
3989 @item -Wshift-count-overflow
3990 @opindex Wshift-count-overflow
3991 @opindex Wno-shift-count-overflow
3992 Warn if shift count >= width of type. This warning is enabled by default.
3994 @item -Wshift-negative-value
3995 @opindex Wshift-negative-value
3996 @opindex Wno-shift-negative-value
3997 Warn if left shifting a negative value.  This warning is enabled by
3998 @option{-Wextra} in C99 and C++11 modes (and newer).
4000 @item -Wshift-overflow
4001 @itemx -Wshift-overflow=@var{n}
4002 @opindex Wshift-overflow
4003 @opindex Wno-shift-overflow
4004 Warn about left shift overflows.  This warning is enabled by
4005 default in C99 and C++11 modes (and newer).
4007 @table @gcctabopt
4008 @item -Wshift-overflow=1
4009 This is the warning level of @option{-Wshift-overflow} and is enabled
4010 by default in C99 and C++11 modes (and newer).  This warning level does
4011 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4012 an overflow is still rejected in contexts where an integer constant expression
4013 is required.)
4015 @item -Wshift-overflow=2
4016 This warning level also warns about left-shifting 1 into the sign bit,
4017 unless C++14 mode is active.
4018 @end table
4020 @item -Wswitch
4021 @opindex Wswitch
4022 @opindex Wno-switch
4023 Warn whenever a @code{switch} statement has an index of enumerated type
4024 and lacks a @code{case} for one or more of the named codes of that
4025 enumeration.  (The presence of a @code{default} label prevents this
4026 warning.)  @code{case} labels outside the enumeration range also
4027 provoke warnings when this option is used (even if there is a
4028 @code{default} label).
4029 This warning is enabled by @option{-Wall}.
4031 @item -Wswitch-default
4032 @opindex Wswitch-default
4033 @opindex Wno-switch-default
4034 Warn whenever a @code{switch} statement does not have a @code{default}
4035 case.
4037 @item -Wswitch-enum
4038 @opindex Wswitch-enum
4039 @opindex Wno-switch-enum
4040 Warn whenever a @code{switch} statement has an index of enumerated type
4041 and lacks a @code{case} for one or more of the named codes of that
4042 enumeration.  @code{case} labels outside the enumeration range also
4043 provoke warnings when this option is used.  The only difference
4044 between @option{-Wswitch} and this option is that this option gives a
4045 warning about an omitted enumeration code even if there is a
4046 @code{default} label.
4048 @item -Wswitch-bool
4049 @opindex Wswitch-bool
4050 @opindex Wno-switch-bool
4051 Warn whenever a @code{switch} statement has an index of boolean type
4052 and the case values are outside the range of a boolean type.
4053 It is possible to suppress this warning by casting the controlling
4054 expression to a type other than @code{bool}.  For example:
4055 @smallexample
4056 @group
4057 switch ((int) (a == 4))
4058   @{
4059   @dots{}
4060   @}
4061 @end group
4062 @end smallexample
4063 This warning is enabled by default for C and C++ programs.
4065 @item -Wsync-nand @r{(C and C++ only)}
4066 @opindex Wsync-nand
4067 @opindex Wno-sync-nand
4068 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4069 built-in functions are used.  These functions changed semantics in GCC 4.4.
4071 @item -Wtrigraphs
4072 @opindex Wtrigraphs
4073 @opindex Wno-trigraphs
4074 Warn if any trigraphs are encountered that might change the meaning of
4075 the program (trigraphs within comments are not warned about).
4076 This warning is enabled by @option{-Wall}.
4078 @item -Wunused-but-set-parameter
4079 @opindex Wunused-but-set-parameter
4080 @opindex Wno-unused-but-set-parameter
4081 Warn whenever a function parameter is assigned to, but otherwise unused
4082 (aside from its declaration).
4084 To suppress this warning use the @code{unused} attribute
4085 (@pxref{Variable Attributes}).
4087 This warning is also enabled by @option{-Wunused} together with
4088 @option{-Wextra}.
4090 @item -Wunused-but-set-variable
4091 @opindex Wunused-but-set-variable
4092 @opindex Wno-unused-but-set-variable
4093 Warn whenever a local variable is assigned to, but otherwise unused
4094 (aside from its declaration).
4095 This warning is enabled by @option{-Wall}.
4097 To suppress this warning use the @code{unused} attribute
4098 (@pxref{Variable Attributes}).
4100 This warning is also enabled by @option{-Wunused}, which is enabled
4101 by @option{-Wall}.
4103 @item -Wunused-function
4104 @opindex Wunused-function
4105 @opindex Wno-unused-function
4106 Warn whenever a static function is declared but not defined or a
4107 non-inline static function is unused.
4108 This warning is enabled by @option{-Wall}.
4110 @item -Wunused-label
4111 @opindex Wunused-label
4112 @opindex Wno-unused-label
4113 Warn whenever a label is declared but not used.
4114 This warning is enabled by @option{-Wall}.
4116 To suppress this warning use the @code{unused} attribute
4117 (@pxref{Variable Attributes}).
4119 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4120 @opindex Wunused-local-typedefs
4121 Warn when a typedef locally defined in a function is not used.
4122 This warning is enabled by @option{-Wall}.
4124 @item -Wunused-parameter
4125 @opindex Wunused-parameter
4126 @opindex Wno-unused-parameter
4127 Warn whenever a function parameter is unused aside from its declaration.
4129 To suppress this warning use the @code{unused} attribute
4130 (@pxref{Variable Attributes}).
4132 @item -Wno-unused-result
4133 @opindex Wunused-result
4134 @opindex Wno-unused-result
4135 Do not warn if a caller of a function marked with attribute
4136 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4137 its return value. The default is @option{-Wunused-result}.
4139 @item -Wunused-variable
4140 @opindex Wunused-variable
4141 @opindex Wno-unused-variable
4142 Warn whenever a local variable or non-constant static variable is unused
4143 aside from its declaration.
4144 This warning is enabled by @option{-Wall}.
4146 To suppress this warning use the @code{unused} attribute
4147 (@pxref{Variable Attributes}).
4149 @item -Wunused-value
4150 @opindex Wunused-value
4151 @opindex Wno-unused-value
4152 Warn whenever a statement computes a result that is explicitly not
4153 used. To suppress this warning cast the unused expression to
4154 @code{void}. This includes an expression-statement or the left-hand
4155 side of a comma expression that contains no side effects. For example,
4156 an expression such as @code{x[i,j]} causes a warning, while
4157 @code{x[(void)i,j]} does not.
4159 This warning is enabled by @option{-Wall}.
4161 @item -Wunused
4162 @opindex Wunused
4163 @opindex Wno-unused
4164 All the above @option{-Wunused} options combined.
4166 In order to get a warning about an unused function parameter, you must
4167 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4168 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4170 @item -Wuninitialized
4171 @opindex Wuninitialized
4172 @opindex Wno-uninitialized
4173 Warn if an automatic variable is used without first being initialized
4174 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4175 warn if a non-static reference or non-static @code{const} member
4176 appears in a class without constructors.
4178 If you want to warn about code that uses the uninitialized value of the
4179 variable in its own initializer, use the @option{-Winit-self} option.
4181 These warnings occur for individual uninitialized or clobbered
4182 elements of structure, union or array variables as well as for
4183 variables that are uninitialized or clobbered as a whole.  They do
4184 not occur for variables or elements declared @code{volatile}.  Because
4185 these warnings depend on optimization, the exact variables or elements
4186 for which there are warnings depends on the precise optimization
4187 options and version of GCC used.
4189 Note that there may be no warning about a variable that is used only
4190 to compute a value that itself is never used, because such
4191 computations may be deleted by data flow analysis before the warnings
4192 are printed.
4194 @item -Wmaybe-uninitialized
4195 @opindex Wmaybe-uninitialized
4196 @opindex Wno-maybe-uninitialized
4197 For an automatic variable, if there exists a path from the function
4198 entry to a use of the variable that is initialized, but there exist
4199 some other paths for which the variable is not initialized, the compiler
4200 emits a warning if it cannot prove the uninitialized paths are not
4201 executed at run time. These warnings are made optional because GCC is
4202 not smart enough to see all the reasons why the code might be correct
4203 in spite of appearing to have an error.  Here is one example of how
4204 this can happen:
4206 @smallexample
4207 @group
4209   int x;
4210   switch (y)
4211     @{
4212     case 1: x = 1;
4213       break;
4214     case 2: x = 4;
4215       break;
4216     case 3: x = 5;
4217     @}
4218   foo (x);
4220 @end group
4221 @end smallexample
4223 @noindent
4224 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4225 always initialized, but GCC doesn't know this. To suppress the
4226 warning, you need to provide a default case with assert(0) or
4227 similar code.
4229 @cindex @code{longjmp} warnings
4230 This option also warns when a non-volatile automatic variable might be
4231 changed by a call to @code{longjmp}.  These warnings as well are possible
4232 only in optimizing compilation.
4234 The compiler sees only the calls to @code{setjmp}.  It cannot know
4235 where @code{longjmp} will be called; in fact, a signal handler could
4236 call it at any point in the code.  As a result, you may get a warning
4237 even when there is in fact no problem because @code{longjmp} cannot
4238 in fact be called at the place that would cause a problem.
4240 Some spurious warnings can be avoided if you declare all the functions
4241 you use that never return as @code{noreturn}.  @xref{Function
4242 Attributes}.
4244 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4246 @item -Wunknown-pragmas
4247 @opindex Wunknown-pragmas
4248 @opindex Wno-unknown-pragmas
4249 @cindex warning for unknown pragmas
4250 @cindex unknown pragmas, warning
4251 @cindex pragmas, warning of unknown
4252 Warn when a @code{#pragma} directive is encountered that is not understood by 
4253 GCC@.  If this command-line option is used, warnings are even issued
4254 for unknown pragmas in system header files.  This is not the case if
4255 the warnings are only enabled by the @option{-Wall} command-line option.
4257 @item -Wno-pragmas
4258 @opindex Wno-pragmas
4259 @opindex Wpragmas
4260 Do not warn about misuses of pragmas, such as incorrect parameters,
4261 invalid syntax, or conflicts between pragmas.  See also
4262 @option{-Wunknown-pragmas}.
4264 @item -Wstrict-aliasing
4265 @opindex Wstrict-aliasing
4266 @opindex Wno-strict-aliasing
4267 This option is only active when @option{-fstrict-aliasing} is active.
4268 It warns about code that might break the strict aliasing rules that the
4269 compiler is using for optimization.  The warning does not catch all
4270 cases, but does attempt to catch the more common pitfalls.  It is
4271 included in @option{-Wall}.
4272 It is equivalent to @option{-Wstrict-aliasing=3}
4274 @item -Wstrict-aliasing=n
4275 @opindex Wstrict-aliasing=n
4276 This option is only active when @option{-fstrict-aliasing} is active.
4277 It warns about code that might break the strict aliasing rules that the
4278 compiler is using for optimization.
4279 Higher levels correspond to higher accuracy (fewer false positives).
4280 Higher levels also correspond to more effort, similar to the way @option{-O} 
4281 works.
4282 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4284 Level 1: Most aggressive, quick, least accurate.
4285 Possibly useful when higher levels
4286 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4287 false negatives.  However, it has many false positives.
4288 Warns for all pointer conversions between possibly incompatible types,
4289 even if never dereferenced.  Runs in the front end only.
4291 Level 2: Aggressive, quick, not too precise.
4292 May still have many false positives (not as many as level 1 though),
4293 and few false negatives (but possibly more than level 1).
4294 Unlike level 1, it only warns when an address is taken.  Warns about
4295 incomplete types.  Runs in the front end only.
4297 Level 3 (default for @option{-Wstrict-aliasing}):
4298 Should have very few false positives and few false
4299 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4300 Takes care of the common pun+dereference pattern in the front end:
4301 @code{*(int*)&some_float}.
4302 If optimization is enabled, it also runs in the back end, where it deals
4303 with multiple statement cases using flow-sensitive points-to information.
4304 Only warns when the converted pointer is dereferenced.
4305 Does not warn about incomplete types.
4307 @item -Wstrict-overflow
4308 @itemx -Wstrict-overflow=@var{n}
4309 @opindex Wstrict-overflow
4310 @opindex Wno-strict-overflow
4311 This option is only active when @option{-fstrict-overflow} is active.
4312 It warns about cases where the compiler optimizes based on the
4313 assumption that signed overflow does not occur.  Note that it does not
4314 warn about all cases where the code might overflow: it only warns
4315 about cases where the compiler implements some optimization.  Thus
4316 this warning depends on the optimization level.
4318 An optimization that assumes that signed overflow does not occur is
4319 perfectly safe if the values of the variables involved are such that
4320 overflow never does, in fact, occur.  Therefore this warning can
4321 easily give a false positive: a warning about code that is not
4322 actually a problem.  To help focus on important issues, several
4323 warning levels are defined.  No warnings are issued for the use of
4324 undefined signed overflow when estimating how many iterations a loop
4325 requires, in particular when determining whether a loop will be
4326 executed at all.
4328 @table @gcctabopt
4329 @item -Wstrict-overflow=1
4330 Warn about cases that are both questionable and easy to avoid.  For
4331 example,  with @option{-fstrict-overflow}, the compiler simplifies
4332 @code{x + 1 > x} to @code{1}.  This level of
4333 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4334 are not, and must be explicitly requested.
4336 @item -Wstrict-overflow=2
4337 Also warn about other cases where a comparison is simplified to a
4338 constant.  For example: @code{abs (x) >= 0}.  This can only be
4339 simplified when @option{-fstrict-overflow} is in effect, because
4340 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4341 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4342 @option{-Wstrict-overflow=2}.
4344 @item -Wstrict-overflow=3
4345 Also warn about other cases where a comparison is simplified.  For
4346 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4348 @item -Wstrict-overflow=4
4349 Also warn about other simplifications not covered by the above cases.
4350 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4352 @item -Wstrict-overflow=5
4353 Also warn about cases where the compiler reduces the magnitude of a
4354 constant involved in a comparison.  For example: @code{x + 2 > y} is
4355 simplified to @code{x + 1 >= y}.  This is reported only at the
4356 highest warning level because this simplification applies to many
4357 comparisons, so this warning level gives a very large number of
4358 false positives.
4359 @end table
4361 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4362 @opindex Wsuggest-attribute=
4363 @opindex Wno-suggest-attribute=
4364 Warn for cases where adding an attribute may be beneficial. The
4365 attributes currently supported are listed below.
4367 @table @gcctabopt
4368 @item -Wsuggest-attribute=pure
4369 @itemx -Wsuggest-attribute=const
4370 @itemx -Wsuggest-attribute=noreturn
4371 @opindex Wsuggest-attribute=pure
4372 @opindex Wno-suggest-attribute=pure
4373 @opindex Wsuggest-attribute=const
4374 @opindex Wno-suggest-attribute=const
4375 @opindex Wsuggest-attribute=noreturn
4376 @opindex Wno-suggest-attribute=noreturn
4378 Warn about functions that might be candidates for attributes
4379 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4380 functions visible in other compilation units or (in the case of @code{pure} and
4381 @code{const}) if it cannot prove that the function returns normally. A function
4382 returns normally if it doesn't contain an infinite loop or return abnormally
4383 by throwing, calling @code{abort} or trapping.  This analysis requires option
4384 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4385 higher.  Higher optimization levels improve the accuracy of the analysis.
4387 @item -Wsuggest-attribute=format
4388 @itemx -Wmissing-format-attribute
4389 @opindex Wsuggest-attribute=format
4390 @opindex Wmissing-format-attribute
4391 @opindex Wno-suggest-attribute=format
4392 @opindex Wno-missing-format-attribute
4393 @opindex Wformat
4394 @opindex Wno-format
4396 Warn about function pointers that might be candidates for @code{format}
4397 attributes.  Note these are only possible candidates, not absolute ones.
4398 GCC guesses that function pointers with @code{format} attributes that
4399 are used in assignment, initialization, parameter passing or return
4400 statements should have a corresponding @code{format} attribute in the
4401 resulting type.  I.e.@: the left-hand side of the assignment or
4402 initialization, the type of the parameter variable, or the return type
4403 of the containing function respectively should also have a @code{format}
4404 attribute to avoid the warning.
4406 GCC also warns about function definitions that might be
4407 candidates for @code{format} attributes.  Again, these are only
4408 possible candidates.  GCC guesses that @code{format} attributes
4409 might be appropriate for any function that calls a function like
4410 @code{vprintf} or @code{vscanf}, but this might not always be the
4411 case, and some functions for which @code{format} attributes are
4412 appropriate may not be detected.
4413 @end table
4415 @item -Wsuggest-final-types
4416 @opindex Wno-suggest-final-types
4417 @opindex Wsuggest-final-types
4418 Warn about types with virtual methods where code quality would be improved
4419 if the type were declared with the C++11 @code{final} specifier, 
4420 or, if possible,
4421 declared in an anonymous namespace. This allows GCC to more aggressively
4422 devirtualize the polymorphic calls. This warning is more effective with link
4423 time optimization, where the information about the class hierarchy graph is
4424 more complete.
4426 @item -Wsuggest-final-methods
4427 @opindex Wno-suggest-final-methods
4428 @opindex Wsuggest-final-methods
4429 Warn about virtual methods where code quality would be improved if the method
4430 were declared with the C++11 @code{final} specifier, 
4431 or, if possible, its type were
4432 declared in an anonymous namespace or with the @code{final} specifier.
4433 This warning is
4434 more effective with link time optimization, where the information about the
4435 class hierarchy graph is more complete. It is recommended to first consider
4436 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4437 annotations.
4439 @item -Wsuggest-override
4440 Warn about overriding virtual functions that are not marked with the override
4441 keyword.
4443 @item -Warray-bounds
4444 @itemx -Warray-bounds=@var{n}
4445 @opindex Wno-array-bounds
4446 @opindex Warray-bounds
4447 This option is only active when @option{-ftree-vrp} is active
4448 (default for @option{-O2} and above). It warns about subscripts to arrays
4449 that are always out of bounds. This warning is enabled by @option{-Wall}.
4451 @table @gcctabopt
4452 @item -Warray-bounds=1
4453 This is the warning level of @option{-Warray-bounds} and is enabled
4454 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4456 @item -Warray-bounds=2
4457 This warning level also warns about out of bounds access for
4458 arrays at the end of a struct and for arrays accessed through
4459 pointers. This warning level may give a larger number of
4460 false positives and is deactivated by default.
4461 @end table
4463 @item -Wbool-compare
4464 @opindex Wno-bool-compare
4465 @opindex Wbool-compare
4466 Warn about boolean expression compared with an integer value different from
4467 @code{true}/@code{false}.  For instance, the following comparison is
4468 always false:
4469 @smallexample
4470 int n = 5;
4471 @dots{}
4472 if ((n > 1) == 2) @{ @dots{} @}
4473 @end smallexample
4474 This warning is enabled by @option{-Wall}.
4476 @item -Wframe-address
4477 @opindex Wno-frame-address
4478 @opindex Wframe-address
4479 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
4480 is called with an argument greater than 0.  Such calls may return indeterminate
4481 values or crash the program.  The warning is included in @option{-Wall}.
4483 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4484 @opindex Wno-discarded-qualifiers
4485 @opindex Wdiscarded-qualifiers
4486 Do not warn if type qualifiers on pointers are being discarded.
4487 Typically, the compiler warns if a @code{const char *} variable is
4488 passed to a function that takes a @code{char *} parameter.  This option
4489 can be used to suppress such a warning.
4491 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4492 @opindex Wno-discarded-array-qualifiers
4493 @opindex Wdiscarded-array-qualifiers
4494 Do not warn if type qualifiers on arrays which are pointer targets
4495 are being discarded. Typically, the compiler warns if a
4496 @code{const int (*)[]} variable is passed to a function that
4497 takes a @code{int (*)[]} parameter.  This option can be used to
4498 suppress such a warning.
4500 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4501 @opindex Wno-incompatible-pointer-types
4502 @opindex Wincompatible-pointer-types
4503 Do not warn when there is a conversion between pointers that have incompatible
4504 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4505 which warns for pointer argument passing or assignment with different
4506 signedness.
4508 @item -Wno-int-conversion @r{(C and Objective-C only)}
4509 @opindex Wno-int-conversion
4510 @opindex Wint-conversion
4511 Do not warn about incompatible integer to pointer and pointer to integer
4512 conversions.  This warning is about implicit conversions; for explicit
4513 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4514 @option{-Wno-pointer-to-int-cast} may be used.
4516 @item -Wno-div-by-zero
4517 @opindex Wno-div-by-zero
4518 @opindex Wdiv-by-zero
4519 Do not warn about compile-time integer division by zero.  Floating-point
4520 division by zero is not warned about, as it can be a legitimate way of
4521 obtaining infinities and NaNs.
4523 @item -Wsystem-headers
4524 @opindex Wsystem-headers
4525 @opindex Wno-system-headers
4526 @cindex warnings from system headers
4527 @cindex system headers, warnings from
4528 Print warning messages for constructs found in system header files.
4529 Warnings from system headers are normally suppressed, on the assumption
4530 that they usually do not indicate real problems and would only make the
4531 compiler output harder to read.  Using this command-line option tells
4532 GCC to emit warnings from system headers as if they occurred in user
4533 code.  However, note that using @option{-Wall} in conjunction with this
4534 option does @emph{not} warn about unknown pragmas in system
4535 headers---for that, @option{-Wunknown-pragmas} must also be used.
4537 @item -Wtautological-compare
4538 @opindex Wtautological-compare
4539 @opindex Wno-tautological-compare
4540 Warn if a self-comparison always evaluates to true or false.  This
4541 warning detects various mistakes such as:
4542 @smallexample
4543 int i = 1;
4544 @dots{}
4545 if (i > i) @{ @dots{} @}
4546 @end smallexample
4547 This warning is enabled by @option{-Wall}.
4549 @item -Wtrampolines
4550 @opindex Wtrampolines
4551 @opindex Wno-trampolines
4552 Warn about trampolines generated for pointers to nested functions.
4553 A trampoline is a small piece of data or code that is created at run
4554 time on the stack when the address of a nested function is taken, and is
4555 used to call the nested function indirectly.  For some targets, it is
4556 made up of data only and thus requires no special treatment.  But, for
4557 most targets, it is made up of code and thus requires the stack to be
4558 made executable in order for the program to work properly.
4560 @item -Wfloat-equal
4561 @opindex Wfloat-equal
4562 @opindex Wno-float-equal
4563 Warn if floating-point values are used in equality comparisons.
4565 The idea behind this is that sometimes it is convenient (for the
4566 programmer) to consider floating-point values as approximations to
4567 infinitely precise real numbers.  If you are doing this, then you need
4568 to compute (by analyzing the code, or in some other way) the maximum or
4569 likely maximum error that the computation introduces, and allow for it
4570 when performing comparisons (and when producing output, but that's a
4571 different problem).  In particular, instead of testing for equality, you
4572 should check to see whether the two values have ranges that overlap; and
4573 this is done with the relational operators, so equality comparisons are
4574 probably mistaken.
4576 @item -Wtraditional @r{(C and Objective-C only)}
4577 @opindex Wtraditional
4578 @opindex Wno-traditional
4579 Warn about certain constructs that behave differently in traditional and
4580 ISO C@.  Also warn about ISO C constructs that have no traditional C
4581 equivalent, and/or problematic constructs that should be avoided.
4583 @itemize @bullet
4584 @item
4585 Macro parameters that appear within string literals in the macro body.
4586 In traditional C macro replacement takes place within string literals,
4587 but in ISO C it does not.
4589 @item
4590 In traditional C, some preprocessor directives did not exist.
4591 Traditional preprocessors only considered a line to be a directive
4592 if the @samp{#} appeared in column 1 on the line.  Therefore
4593 @option{-Wtraditional} warns about directives that traditional C
4594 understands but ignores because the @samp{#} does not appear as the
4595 first character on the line.  It also suggests you hide directives like
4596 @code{#pragma} not understood by traditional C by indenting them.  Some
4597 traditional implementations do not recognize @code{#elif}, so this option
4598 suggests avoiding it altogether.
4600 @item
4601 A function-like macro that appears without arguments.
4603 @item
4604 The unary plus operator.
4606 @item
4607 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4608 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4609 constants.)  Note, these suffixes appear in macros defined in the system
4610 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4611 Use of these macros in user code might normally lead to spurious
4612 warnings, however GCC's integrated preprocessor has enough context to
4613 avoid warning in these cases.
4615 @item
4616 A function declared external in one block and then used after the end of
4617 the block.
4619 @item
4620 A @code{switch} statement has an operand of type @code{long}.
4622 @item
4623 A non-@code{static} function declaration follows a @code{static} one.
4624 This construct is not accepted by some traditional C compilers.
4626 @item
4627 The ISO type of an integer constant has a different width or
4628 signedness from its traditional type.  This warning is only issued if
4629 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4630 typically represent bit patterns, are not warned about.
4632 @item
4633 Usage of ISO string concatenation is detected.
4635 @item
4636 Initialization of automatic aggregates.
4638 @item
4639 Identifier conflicts with labels.  Traditional C lacks a separate
4640 namespace for labels.
4642 @item
4643 Initialization of unions.  If the initializer is zero, the warning is
4644 omitted.  This is done under the assumption that the zero initializer in
4645 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4646 initializer warnings and relies on default initialization to zero in the
4647 traditional C case.
4649 @item
4650 Conversions by prototypes between fixed/floating-point values and vice
4651 versa.  The absence of these prototypes when compiling with traditional
4652 C causes serious problems.  This is a subset of the possible
4653 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4655 @item
4656 Use of ISO C style function definitions.  This warning intentionally is
4657 @emph{not} issued for prototype declarations or variadic functions
4658 because these ISO C features appear in your code when using
4659 libiberty's traditional C compatibility macros, @code{PARAMS} and
4660 @code{VPARAMS}.  This warning is also bypassed for nested functions
4661 because that feature is already a GCC extension and thus not relevant to
4662 traditional C compatibility.
4663 @end itemize
4665 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4666 @opindex Wtraditional-conversion
4667 @opindex Wno-traditional-conversion
4668 Warn if a prototype causes a type conversion that is different from what
4669 would happen to the same argument in the absence of a prototype.  This
4670 includes conversions of fixed point to floating and vice versa, and
4671 conversions changing the width or signedness of a fixed-point argument
4672 except when the same as the default promotion.
4674 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4675 @opindex Wdeclaration-after-statement
4676 @opindex Wno-declaration-after-statement
4677 Warn when a declaration is found after a statement in a block.  This
4678 construct, known from C++, was introduced with ISO C99 and is by default
4679 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4681 @item -Wundef
4682 @opindex Wundef
4683 @opindex Wno-undef
4684 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4686 @item -Wno-endif-labels
4687 @opindex Wno-endif-labels
4688 @opindex Wendif-labels
4689 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4691 @item -Wshadow
4692 @opindex Wshadow
4693 @opindex Wno-shadow
4694 Warn whenever a local variable or type declaration shadows another
4695 variable, parameter, type, class member (in C++), or instance variable
4696 (in Objective-C) or whenever a built-in function is shadowed. Note
4697 that in C++, the compiler warns if a local variable shadows an
4698 explicit typedef, but not if it shadows a struct/class/enum.
4700 @item -Wno-shadow-ivar @r{(Objective-C only)}
4701 @opindex Wno-shadow-ivar
4702 @opindex Wshadow-ivar
4703 Do not warn whenever a local variable shadows an instance variable in an
4704 Objective-C method.
4706 @item -Wlarger-than=@var{len}
4707 @opindex Wlarger-than=@var{len}
4708 @opindex Wlarger-than-@var{len}
4709 Warn whenever an object of larger than @var{len} bytes is defined.
4711 @item -Wframe-larger-than=@var{len}
4712 @opindex Wframe-larger-than
4713 Warn if the size of a function frame is larger than @var{len} bytes.
4714 The computation done to determine the stack frame size is approximate
4715 and not conservative.
4716 The actual requirements may be somewhat greater than @var{len}
4717 even if you do not get a warning.  In addition, any space allocated
4718 via @code{alloca}, variable-length arrays, or related constructs
4719 is not included by the compiler when determining
4720 whether or not to issue a warning.
4722 @item -Wno-free-nonheap-object
4723 @opindex Wno-free-nonheap-object
4724 @opindex Wfree-nonheap-object
4725 Do not warn when attempting to free an object that was not allocated
4726 on the heap.
4728 @item -Wstack-usage=@var{len}
4729 @opindex Wstack-usage
4730 Warn if the stack usage of a function might be larger than @var{len} bytes.
4731 The computation done to determine the stack usage is conservative.
4732 Any space allocated via @code{alloca}, variable-length arrays, or related
4733 constructs is included by the compiler when determining whether or not to
4734 issue a warning.
4736 The message is in keeping with the output of @option{-fstack-usage}.
4738 @itemize
4739 @item
4740 If the stack usage is fully static but exceeds the specified amount, it's:
4742 @smallexample
4743   warning: stack usage is 1120 bytes
4744 @end smallexample
4745 @item
4746 If the stack usage is (partly) dynamic but bounded, it's:
4748 @smallexample
4749   warning: stack usage might be 1648 bytes
4750 @end smallexample
4751 @item
4752 If the stack usage is (partly) dynamic and not bounded, it's:
4754 @smallexample
4755   warning: stack usage might be unbounded
4756 @end smallexample
4757 @end itemize
4759 @item -Wunsafe-loop-optimizations
4760 @opindex Wunsafe-loop-optimizations
4761 @opindex Wno-unsafe-loop-optimizations
4762 Warn if the loop cannot be optimized because the compiler cannot
4763 assume anything on the bounds of the loop indices.  With
4764 @option{-funsafe-loop-optimizations} warn if the compiler makes
4765 such assumptions.
4767 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4768 @opindex Wno-pedantic-ms-format
4769 @opindex Wpedantic-ms-format
4770 When used in combination with @option{-Wformat}
4771 and @option{-pedantic} without GNU extensions, this option
4772 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4773 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4774 which depend on the MS runtime.
4776 @item -Wpointer-arith
4777 @opindex Wpointer-arith
4778 @opindex Wno-pointer-arith
4779 Warn about anything that depends on the ``size of'' a function type or
4780 of @code{void}.  GNU C assigns these types a size of 1, for
4781 convenience in calculations with @code{void *} pointers and pointers
4782 to functions.  In C++, warn also when an arithmetic operation involves
4783 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4785 @item -Wtype-limits
4786 @opindex Wtype-limits
4787 @opindex Wno-type-limits
4788 Warn if a comparison is always true or always false due to the limited
4789 range of the data type, but do not warn for constant expressions.  For
4790 example, warn if an unsigned variable is compared against zero with
4791 @code{<} or @code{>=}.  This warning is also enabled by
4792 @option{-Wextra}.
4794 @item -Wbad-function-cast @r{(C and Objective-C only)}
4795 @opindex Wbad-function-cast
4796 @opindex Wno-bad-function-cast
4797 Warn when a function call is cast to a non-matching type.
4798 For example, warn if a call to a function returning an integer type 
4799 is cast to a pointer type.
4801 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4802 @opindex Wc90-c99-compat
4803 @opindex Wno-c90-c99-compat
4804 Warn about features not present in ISO C90, but present in ISO C99.
4805 For instance, warn about use of variable length arrays, @code{long long}
4806 type, @code{bool} type, compound literals, designated initializers, and so
4807 on.  This option is independent of the standards mode.  Warnings are disabled
4808 in the expression that follows @code{__extension__}.
4810 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4811 @opindex Wc99-c11-compat
4812 @opindex Wno-c99-c11-compat
4813 Warn about features not present in ISO C99, but present in ISO C11.
4814 For instance, warn about use of anonymous structures and unions,
4815 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4816 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4817 and so on.  This option is independent of the standards mode.  Warnings are
4818 disabled in the expression that follows @code{__extension__}.
4820 @item -Wc++-compat @r{(C and Objective-C only)}
4821 @opindex Wc++-compat
4822 Warn about ISO C constructs that are outside of the common subset of
4823 ISO C and ISO C++, e.g.@: request for implicit conversion from
4824 @code{void *} to a pointer to non-@code{void} type.
4826 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4827 @opindex Wc++11-compat
4828 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4829 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4830 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4831 enabled by @option{-Wall}.
4833 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4834 @opindex Wc++14-compat
4835 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4836 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4838 @item -Wcast-qual
4839 @opindex Wcast-qual
4840 @opindex Wno-cast-qual
4841 Warn whenever a pointer is cast so as to remove a type qualifier from
4842 the target type.  For example, warn if a @code{const char *} is cast
4843 to an ordinary @code{char *}.
4845 Also warn when making a cast that introduces a type qualifier in an
4846 unsafe way.  For example, casting @code{char **} to @code{const char **}
4847 is unsafe, as in this example:
4849 @smallexample
4850   /* p is char ** value.  */
4851   const char **q = (const char **) p;
4852   /* Assignment of readonly string to const char * is OK.  */
4853   *q = "string";
4854   /* Now char** pointer points to read-only memory.  */
4855   **p = 'b';
4856 @end smallexample
4858 @item -Wcast-align
4859 @opindex Wcast-align
4860 @opindex Wno-cast-align
4861 Warn whenever a pointer is cast such that the required alignment of the
4862 target is increased.  For example, warn if a @code{char *} is cast to
4863 an @code{int *} on machines where integers can only be accessed at
4864 two- or four-byte boundaries.
4866 @item -Wwrite-strings
4867 @opindex Wwrite-strings
4868 @opindex Wno-write-strings
4869 When compiling C, give string constants the type @code{const
4870 char[@var{length}]} so that copying the address of one into a
4871 non-@code{const} @code{char *} pointer produces a warning.  These
4872 warnings help you find at compile time code that can try to write
4873 into a string constant, but only if you have been very careful about
4874 using @code{const} in declarations and prototypes.  Otherwise, it is
4875 just a nuisance. This is why we did not make @option{-Wall} request
4876 these warnings.
4878 When compiling C++, warn about the deprecated conversion from string
4879 literals to @code{char *}.  This warning is enabled by default for C++
4880 programs.
4882 @item -Wclobbered
4883 @opindex Wclobbered
4884 @opindex Wno-clobbered
4885 Warn for variables that might be changed by @code{longjmp} or
4886 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
4888 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4889 @opindex Wconditionally-supported
4890 @opindex Wno-conditionally-supported
4891 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4893 @item -Wconversion
4894 @opindex Wconversion
4895 @opindex Wno-conversion
4896 Warn for implicit conversions that may alter a value. This includes
4897 conversions between real and integer, like @code{abs (x)} when
4898 @code{x} is @code{double}; conversions between signed and unsigned,
4899 like @code{unsigned ui = -1}; and conversions to smaller types, like
4900 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4901 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4902 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4903 conversions between signed and unsigned integers can be disabled by
4904 using @option{-Wno-sign-conversion}.
4906 For C++, also warn for confusing overload resolution for user-defined
4907 conversions; and conversions that never use a type conversion
4908 operator: conversions to @code{void}, the same type, a base class or a
4909 reference to them. Warnings about conversions between signed and
4910 unsigned integers are disabled by default in C++ unless
4911 @option{-Wsign-conversion} is explicitly enabled.
4913 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4914 @opindex Wconversion-null
4915 @opindex Wno-conversion-null
4916 Do not warn for conversions between @code{NULL} and non-pointer
4917 types. @option{-Wconversion-null} is enabled by default.
4919 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4920 @opindex Wzero-as-null-pointer-constant
4921 @opindex Wno-zero-as-null-pointer-constant
4922 Warn when a literal '0' is used as null pointer constant.  This can
4923 be useful to facilitate the conversion to @code{nullptr} in C++11.
4925 @item -Wdate-time
4926 @opindex Wdate-time
4927 @opindex Wno-date-time
4928 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4929 are encountered as they might prevent bit-wise-identical reproducible
4930 compilations.
4932 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4933 @opindex Wdelete-incomplete
4934 @opindex Wno-delete-incomplete
4935 Warn when deleting a pointer to incomplete type, which may cause
4936 undefined behavior at runtime.  This warning is enabled by default.
4938 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4939 @opindex Wuseless-cast
4940 @opindex Wno-useless-cast
4941 Warn when an expression is casted to its own type.
4943 @item -Wempty-body
4944 @opindex Wempty-body
4945 @opindex Wno-empty-body
4946 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
4947 while} statement.  This warning is also enabled by @option{-Wextra}.
4949 @item -Wenum-compare
4950 @opindex Wenum-compare
4951 @opindex Wno-enum-compare
4952 Warn about a comparison between values of different enumerated types.
4953 In C++ enumeral mismatches in conditional expressions are also
4954 diagnosed and the warning is enabled by default.  In C this warning is 
4955 enabled by @option{-Wall}.
4957 @item -Wjump-misses-init @r{(C, Objective-C only)}
4958 @opindex Wjump-misses-init
4959 @opindex Wno-jump-misses-init
4960 Warn if a @code{goto} statement or a @code{switch} statement jumps
4961 forward across the initialization of a variable, or jumps backward to a
4962 label after the variable has been initialized.  This only warns about
4963 variables that are initialized when they are declared.  This warning is
4964 only supported for C and Objective-C; in C++ this sort of branch is an
4965 error in any case.
4967 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4968 can be disabled with the @option{-Wno-jump-misses-init} option.
4970 @item -Wsign-compare
4971 @opindex Wsign-compare
4972 @opindex Wno-sign-compare
4973 @cindex warning for comparison of signed and unsigned values
4974 @cindex comparison of signed and unsigned values, warning
4975 @cindex signed and unsigned values, comparison warning
4976 Warn when a comparison between signed and unsigned values could produce
4977 an incorrect result when the signed value is converted to unsigned.
4978 This warning is also enabled by @option{-Wextra}; to get the other warnings
4979 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4981 @item -Wsign-conversion
4982 @opindex Wsign-conversion
4983 @opindex Wno-sign-conversion
4984 Warn for implicit conversions that may change the sign of an integer
4985 value, like assigning a signed integer expression to an unsigned
4986 integer variable. An explicit cast silences the warning. In C, this
4987 option is enabled also by @option{-Wconversion}.
4989 @item -Wfloat-conversion
4990 @opindex Wfloat-conversion
4991 @opindex Wno-float-conversion
4992 Warn for implicit conversions that reduce the precision of a real value.
4993 This includes conversions from real to integer, and from higher precision
4994 real to lower precision real values.  This option is also enabled by
4995 @option{-Wconversion}.
4997 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4998 @opindex Wsized-deallocation
4999 @opindex Wno-sized-deallocation
5000 Warn about a definition of an unsized deallocation function
5001 @smallexample
5002 void operator delete (void *) noexcept;
5003 void operator delete[] (void *) noexcept;
5004 @end smallexample
5005 without a definition of the corresponding sized deallocation function
5006 @smallexample
5007 void operator delete (void *, std::size_t) noexcept;
5008 void operator delete[] (void *, std::size_t) noexcept;
5009 @end smallexample
5010 or vice versa.  Enabled by @option{-Wextra} along with
5011 @option{-fsized-deallocation}.
5013 @item -Wsizeof-pointer-memaccess
5014 @opindex Wsizeof-pointer-memaccess
5015 @opindex Wno-sizeof-pointer-memaccess
5016 Warn for suspicious length parameters to certain string and memory built-in
5017 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
5018 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
5019 but a pointer, and suggests a possible fix, or about
5020 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
5021 @option{-Wall}.
5023 @item -Wsizeof-array-argument
5024 @opindex Wsizeof-array-argument
5025 @opindex Wno-sizeof-array-argument
5026 Warn when the @code{sizeof} operator is applied to a parameter that is
5027 declared as an array in a function definition.  This warning is enabled by
5028 default for C and C++ programs.
5030 @item -Wmemset-transposed-args
5031 @opindex Wmemset-transposed-args
5032 @opindex Wno-memset-transposed-args
5033 Warn for suspicious calls to the @code{memset} built-in function, if the
5034 second argument is not zero and the third argument is zero.  This warns e.g.@
5035 about @code{memset (buf, sizeof buf, 0)} where most probably
5036 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
5037 is only emitted if the third argument is literal zero.  If it is some
5038 expression that is folded to zero, a cast of zero to some type, etc., 
5039 it is far less likely that the user has mistakenly exchanged the arguments 
5040 and no warning is emitted.  This warning is enabled by @option{-Wall}.
5042 @item -Waddress
5043 @opindex Waddress
5044 @opindex Wno-address
5045 Warn about suspicious uses of memory addresses. These include using
5046 the address of a function in a conditional expression, such as
5047 @code{void func(void); if (func)}, and comparisons against the memory
5048 address of a string literal, such as @code{if (x == "abc")}.  Such
5049 uses typically indicate a programmer error: the address of a function
5050 always evaluates to true, so their use in a conditional usually
5051 indicate that the programmer forgot the parentheses in a function
5052 call; and comparisons against string literals result in unspecified
5053 behavior and are not portable in C, so they usually indicate that the
5054 programmer intended to use @code{strcmp}.  This warning is enabled by
5055 @option{-Wall}.
5057 @item -Wlogical-op
5058 @opindex Wlogical-op
5059 @opindex Wno-logical-op
5060 Warn about suspicious uses of logical operators in expressions.
5061 This includes using logical operators in contexts where a
5062 bit-wise operator is likely to be expected.  Also warns when
5063 the operands of a logical operator are the same:
5064 @smallexample
5065 extern int a;
5066 if (a < 0 && a < 0) @{ @dots{} @}
5067 @end smallexample
5069 @item -Wlogical-not-parentheses
5070 @opindex Wlogical-not-parentheses
5071 @opindex Wno-logical-not-parentheses
5072 Warn about logical not used on the left hand side operand of a comparison.
5073 This option does not warn if the RHS operand is of a boolean type.  Its
5074 purpose is to detect suspicious code like the following:
5075 @smallexample
5076 int a;
5077 @dots{}
5078 if (!a > 1) @{ @dots{} @}
5079 @end smallexample
5081 It is possible to suppress the warning by wrapping the LHS into
5082 parentheses:
5083 @smallexample
5084 if ((!a) > 1) @{ @dots{} @}
5085 @end smallexample
5087 This warning is enabled by @option{-Wall}.
5089 @item -Waggregate-return
5090 @opindex Waggregate-return
5091 @opindex Wno-aggregate-return
5092 Warn if any functions that return structures or unions are defined or
5093 called.  (In languages where you can return an array, this also elicits
5094 a warning.)
5096 @item -Wno-aggressive-loop-optimizations
5097 @opindex Wno-aggressive-loop-optimizations
5098 @opindex Waggressive-loop-optimizations
5099 Warn if in a loop with constant number of iterations the compiler detects
5100 undefined behavior in some statement during one or more of the iterations.
5102 @item -Wno-attributes
5103 @opindex Wno-attributes
5104 @opindex Wattributes
5105 Do not warn if an unexpected @code{__attribute__} is used, such as
5106 unrecognized attributes, function attributes applied to variables,
5107 etc.  This does not stop errors for incorrect use of supported
5108 attributes.
5110 @item -Wno-builtin-macro-redefined
5111 @opindex Wno-builtin-macro-redefined
5112 @opindex Wbuiltin-macro-redefined
5113 Do not warn if certain built-in macros are redefined.  This suppresses
5114 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5115 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5117 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5118 @opindex Wstrict-prototypes
5119 @opindex Wno-strict-prototypes
5120 Warn if a function is declared or defined without specifying the
5121 argument types.  (An old-style function definition is permitted without
5122 a warning if preceded by a declaration that specifies the argument
5123 types.)
5125 @item -Wold-style-declaration @r{(C and Objective-C only)}
5126 @opindex Wold-style-declaration
5127 @opindex Wno-old-style-declaration
5128 Warn for obsolescent usages, according to the C Standard, in a
5129 declaration. For example, warn if storage-class specifiers like
5130 @code{static} are not the first things in a declaration.  This warning
5131 is also enabled by @option{-Wextra}.
5133 @item -Wold-style-definition @r{(C and Objective-C only)}
5134 @opindex Wold-style-definition
5135 @opindex Wno-old-style-definition
5136 Warn if an old-style function definition is used.  A warning is given
5137 even if there is a previous prototype.
5139 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5140 @opindex Wmissing-parameter-type
5141 @opindex Wno-missing-parameter-type
5142 A function parameter is declared without a type specifier in K&R-style
5143 functions:
5145 @smallexample
5146 void foo(bar) @{ @}
5147 @end smallexample
5149 This warning is also enabled by @option{-Wextra}.
5151 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5152 @opindex Wmissing-prototypes
5153 @opindex Wno-missing-prototypes
5154 Warn if a global function is defined without a previous prototype
5155 declaration.  This warning is issued even if the definition itself
5156 provides a prototype.  Use this option to detect global functions
5157 that do not have a matching prototype declaration in a header file.
5158 This option is not valid for C++ because all function declarations
5159 provide prototypes and a non-matching declaration declares an
5160 overload rather than conflict with an earlier declaration.
5161 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5163 @item -Wmissing-declarations
5164 @opindex Wmissing-declarations
5165 @opindex Wno-missing-declarations
5166 Warn if a global function is defined without a previous declaration.
5167 Do so even if the definition itself provides a prototype.
5168 Use this option to detect global functions that are not declared in
5169 header files.  In C, no warnings are issued for functions with previous
5170 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5171 missing prototypes.  In C++, no warnings are issued for function templates,
5172 or for inline functions, or for functions in anonymous namespaces.
5174 @item -Wmissing-field-initializers
5175 @opindex Wmissing-field-initializers
5176 @opindex Wno-missing-field-initializers
5177 @opindex W
5178 @opindex Wextra
5179 @opindex Wno-extra
5180 Warn if a structure's initializer has some fields missing.  For
5181 example, the following code causes such a warning, because
5182 @code{x.h} is implicitly zero:
5184 @smallexample
5185 struct s @{ int f, g, h; @};
5186 struct s x = @{ 3, 4 @};
5187 @end smallexample
5189 This option does not warn about designated initializers, so the following
5190 modification does not trigger a warning:
5192 @smallexample
5193 struct s @{ int f, g, h; @};
5194 struct s x = @{ .f = 3, .g = 4 @};
5195 @end smallexample
5197 In C++ this option does not warn either about the empty @{ @}
5198 initializer, for example:
5200 @smallexample
5201 struct s @{ int f, g, h; @};
5202 s x = @{ @};
5203 @end smallexample
5205 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5206 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5208 @item -Wno-multichar
5209 @opindex Wno-multichar
5210 @opindex Wmultichar
5211 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5212 Usually they indicate a typo in the user's code, as they have
5213 implementation-defined values, and should not be used in portable code.
5215 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5216 @opindex Wnormalized=
5217 @opindex Wnormalized
5218 @opindex Wno-normalized
5219 @cindex NFC
5220 @cindex NFKC
5221 @cindex character set, input normalization
5222 In ISO C and ISO C++, two identifiers are different if they are
5223 different sequences of characters.  However, sometimes when characters
5224 outside the basic ASCII character set are used, you can have two
5225 different character sequences that look the same.  To avoid confusion,
5226 the ISO 10646 standard sets out some @dfn{normalization rules} which
5227 when applied ensure that two sequences that look the same are turned into
5228 the same sequence.  GCC can warn you if you are using identifiers that
5229 have not been normalized; this option controls that warning.
5231 There are four levels of warning supported by GCC@.  The default is
5232 @option{-Wnormalized=nfc}, which warns about any identifier that is
5233 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5234 recommended form for most uses.  It is equivalent to
5235 @option{-Wnormalized}.
5237 Unfortunately, there are some characters allowed in identifiers by
5238 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5239 identifiers.  That is, there's no way to use these symbols in portable
5240 ISO C or C++ and have all your identifiers in NFC@.
5241 @option{-Wnormalized=id} suppresses the warning for these characters.
5242 It is hoped that future versions of the standards involved will correct
5243 this, which is why this option is not the default.
5245 You can switch the warning off for all characters by writing
5246 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5247 only do this if you are using some other normalization scheme (like
5248 ``D''), because otherwise you can easily create bugs that are
5249 literally impossible to see.
5251 Some characters in ISO 10646 have distinct meanings but look identical
5252 in some fonts or display methodologies, especially once formatting has
5253 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5254 LETTER N'', displays just like a regular @code{n} that has been
5255 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5256 normalization scheme to convert all these into a standard form as
5257 well, and GCC warns if your code is not in NFKC if you use
5258 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5259 about every identifier that contains the letter O because it might be
5260 confused with the digit 0, and so is not the default, but may be
5261 useful as a local coding convention if the programming environment 
5262 cannot be fixed to display these characters distinctly.
5264 @item -Wno-deprecated
5265 @opindex Wno-deprecated
5266 @opindex Wdeprecated
5267 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5269 @item -Wno-deprecated-declarations
5270 @opindex Wno-deprecated-declarations
5271 @opindex Wdeprecated-declarations
5272 Do not warn about uses of functions (@pxref{Function Attributes}),
5273 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5274 Attributes}) marked as deprecated by using the @code{deprecated}
5275 attribute.
5277 @item -Wno-overflow
5278 @opindex Wno-overflow
5279 @opindex Woverflow
5280 Do not warn about compile-time overflow in constant expressions.
5282 @item -Wno-odr
5283 @opindex Wno-odr
5284 @opindex Wodr
5285 Warn about One Definition Rule violations during link-time optimization.
5286 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5288 @item -Wopenmp-simd
5289 @opindex Wopenm-simd
5290 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5291 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5292 option can be used to relax the cost model.
5294 @item -Woverride-init @r{(C and Objective-C only)}
5295 @opindex Woverride-init
5296 @opindex Wno-override-init
5297 @opindex W
5298 @opindex Wextra
5299 @opindex Wno-extra
5300 Warn if an initialized field without side effects is overridden when
5301 using designated initializers (@pxref{Designated Inits, , Designated
5302 Initializers}).
5304 This warning is included in @option{-Wextra}.  To get other
5305 @option{-Wextra} warnings without this one, use @option{-Wextra
5306 -Wno-override-init}.
5308 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
5309 @opindex Woverride-init-side-effects
5310 @opindex Wno-override-init-side-effects
5311 Warn if an initialized field with side effects is overridden when
5312 using designated initializers (@pxref{Designated Inits, , Designated
5313 Initializers}).  This warning is enabled by default.
5315 @item -Wpacked
5316 @opindex Wpacked
5317 @opindex Wno-packed
5318 Warn if a structure is given the packed attribute, but the packed
5319 attribute has no effect on the layout or size of the structure.
5320 Such structures may be mis-aligned for little benefit.  For
5321 instance, in this code, the variable @code{f.x} in @code{struct bar}
5322 is misaligned even though @code{struct bar} does not itself
5323 have the packed attribute:
5325 @smallexample
5326 @group
5327 struct foo @{
5328   int x;
5329   char a, b, c, d;
5330 @} __attribute__((packed));
5331 struct bar @{
5332   char z;
5333   struct foo f;
5335 @end group
5336 @end smallexample
5338 @item -Wpacked-bitfield-compat
5339 @opindex Wpacked-bitfield-compat
5340 @opindex Wno-packed-bitfield-compat
5341 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5342 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5343 the change can lead to differences in the structure layout.  GCC
5344 informs you when the offset of such a field has changed in GCC 4.4.
5345 For example there is no longer a 4-bit padding between field @code{a}
5346 and @code{b} in this structure:
5348 @smallexample
5349 struct foo
5351   char a:4;
5352   char b:8;
5353 @} __attribute__ ((packed));
5354 @end smallexample
5356 This warning is enabled by default.  Use
5357 @option{-Wno-packed-bitfield-compat} to disable this warning.
5359 @item -Wpadded
5360 @opindex Wpadded
5361 @opindex Wno-padded
5362 Warn if padding is included in a structure, either to align an element
5363 of the structure or to align the whole structure.  Sometimes when this
5364 happens it is possible to rearrange the fields of the structure to
5365 reduce the padding and so make the structure smaller.
5367 @item -Wredundant-decls
5368 @opindex Wredundant-decls
5369 @opindex Wno-redundant-decls
5370 Warn if anything is declared more than once in the same scope, even in
5371 cases where multiple declaration is valid and changes nothing.
5373 @item -Wnested-externs @r{(C and Objective-C only)}
5374 @opindex Wnested-externs
5375 @opindex Wno-nested-externs
5376 Warn if an @code{extern} declaration is encountered within a function.
5378 @item -Wno-inherited-variadic-ctor
5379 @opindex Winherited-variadic-ctor
5380 @opindex Wno-inherited-variadic-ctor
5381 Suppress warnings about use of C++11 inheriting constructors when the
5382 base class inherited from has a C variadic constructor; the warning is
5383 on by default because the ellipsis is not inherited.
5385 @item -Winline
5386 @opindex Winline
5387 @opindex Wno-inline
5388 Warn if a function that is declared as inline cannot be inlined.
5389 Even with this option, the compiler does not warn about failures to
5390 inline functions declared in system headers.
5392 The compiler uses a variety of heuristics to determine whether or not
5393 to inline a function.  For example, the compiler takes into account
5394 the size of the function being inlined and the amount of inlining
5395 that has already been done in the current function.  Therefore,
5396 seemingly insignificant changes in the source program can cause the
5397 warnings produced by @option{-Winline} to appear or disappear.
5399 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5400 @opindex Wno-invalid-offsetof
5401 @opindex Winvalid-offsetof
5402 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5403 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5404 to a non-standard-layout type is undefined.  In existing C++ implementations,
5405 however, @code{offsetof} typically gives meaningful results.
5406 This flag is for users who are aware that they are
5407 writing nonportable code and who have deliberately chosen to ignore the
5408 warning about it.
5410 The restrictions on @code{offsetof} may be relaxed in a future version
5411 of the C++ standard.
5413 @item -Wno-int-to-pointer-cast
5414 @opindex Wno-int-to-pointer-cast
5415 @opindex Wint-to-pointer-cast
5416 Suppress warnings from casts to pointer type of an integer of a
5417 different size. In C++, casting to a pointer type of smaller size is
5418 an error. @option{Wint-to-pointer-cast} is enabled by default.
5421 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5422 @opindex Wno-pointer-to-int-cast
5423 @opindex Wpointer-to-int-cast
5424 Suppress warnings from casts from a pointer to an integer type of a
5425 different size.
5427 @item -Winvalid-pch
5428 @opindex Winvalid-pch
5429 @opindex Wno-invalid-pch
5430 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5431 the search path but can't be used.
5433 @item -Wlong-long
5434 @opindex Wlong-long
5435 @opindex Wno-long-long
5436 Warn if @code{long long} type is used.  This is enabled by either
5437 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5438 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5440 @item -Wvariadic-macros
5441 @opindex Wvariadic-macros
5442 @opindex Wno-variadic-macros
5443 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5444 alternate syntax is used in ISO C99 mode.  This is enabled by either
5445 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5446 messages, use @option{-Wno-variadic-macros}.
5448 @item -Wvarargs
5449 @opindex Wvarargs
5450 @opindex Wno-varargs
5451 Warn upon questionable usage of the macros used to handle variable
5452 arguments like @code{va_start}.  This is default.  To inhibit the
5453 warning messages, use @option{-Wno-varargs}.
5455 @item -Wvector-operation-performance
5456 @opindex Wvector-operation-performance
5457 @opindex Wno-vector-operation-performance
5458 Warn if vector operation is not implemented via SIMD capabilities of the
5459 architecture.  Mainly useful for the performance tuning.
5460 Vector operation can be implemented @code{piecewise}, which means that the
5461 scalar operation is performed on every vector element; 
5462 @code{in parallel}, which means that the vector operation is implemented
5463 using scalars of wider type, which normally is more performance efficient;
5464 and @code{as a single scalar}, which means that vector fits into a
5465 scalar type.
5467 @item -Wno-virtual-move-assign
5468 @opindex Wvirtual-move-assign
5469 @opindex Wno-virtual-move-assign
5470 Suppress warnings about inheriting from a virtual base with a
5471 non-trivial C++11 move assignment operator.  This is dangerous because
5472 if the virtual base is reachable along more than one path, it is
5473 moved multiple times, which can mean both objects end up in the
5474 moved-from state.  If the move assignment operator is written to avoid
5475 moving from a moved-from object, this warning can be disabled.
5477 @item -Wvla
5478 @opindex Wvla
5479 @opindex Wno-vla
5480 Warn if variable length array is used in the code.
5481 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5482 the variable length array.
5484 @item -Wvolatile-register-var
5485 @opindex Wvolatile-register-var
5486 @opindex Wno-volatile-register-var
5487 Warn if a register variable is declared volatile.  The volatile
5488 modifier does not inhibit all optimizations that may eliminate reads
5489 and/or writes to register variables.  This warning is enabled by
5490 @option{-Wall}.
5492 @item -Wdisabled-optimization
5493 @opindex Wdisabled-optimization
5494 @opindex Wno-disabled-optimization
5495 Warn if a requested optimization pass is disabled.  This warning does
5496 not generally indicate that there is anything wrong with your code; it
5497 merely indicates that GCC's optimizers are unable to handle the code
5498 effectively.  Often, the problem is that your code is too big or too
5499 complex; GCC refuses to optimize programs when the optimization
5500 itself is likely to take inordinate amounts of time.
5502 @item -Wpointer-sign @r{(C and Objective-C only)}
5503 @opindex Wpointer-sign
5504 @opindex Wno-pointer-sign
5505 Warn for pointer argument passing or assignment with different signedness.
5506 This option is only supported for C and Objective-C@.  It is implied by
5507 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5508 @option{-Wno-pointer-sign}.
5510 @item -Wstack-protector
5511 @opindex Wstack-protector
5512 @opindex Wno-stack-protector
5513 This option is only active when @option{-fstack-protector} is active.  It
5514 warns about functions that are not protected against stack smashing.
5516 @item -Woverlength-strings
5517 @opindex Woverlength-strings
5518 @opindex Wno-overlength-strings
5519 Warn about string constants that are longer than the ``minimum
5520 maximum'' length specified in the C standard.  Modern compilers
5521 generally allow string constants that are much longer than the
5522 standard's minimum limit, but very portable programs should avoid
5523 using longer strings.
5525 The limit applies @emph{after} string constant concatenation, and does
5526 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5527 C99, it was raised to 4095.  C++98 does not specify a normative
5528 minimum maximum, so we do not diagnose overlength strings in C++@.
5530 This option is implied by @option{-Wpedantic}, and can be disabled with
5531 @option{-Wno-overlength-strings}.
5533 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5534 @opindex Wunsuffixed-float-constants
5536 Issue a warning for any floating constant that does not have
5537 a suffix.  When used together with @option{-Wsystem-headers} it
5538 warns about such constants in system header files.  This can be useful
5539 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5540 from the decimal floating-point extension to C99.
5542 @item -Wno-designated-init @r{(C and Objective-C only)}
5543 Suppress warnings when a positional initializer is used to initialize
5544 a structure that has been marked with the @code{designated_init}
5545 attribute.
5547 @end table
5549 @node Debugging Options
5550 @section Options for Debugging Your Program or GCC
5551 @cindex options, debugging
5552 @cindex debugging information options
5554 GCC has various special options that are used for debugging
5555 either your program or GCC:
5557 @table @gcctabopt
5558 @item -g
5559 @opindex g
5560 Produce debugging information in the operating system's native format
5561 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5562 information.
5564 On most systems that use stabs format, @option{-g} enables use of extra
5565 debugging information that only GDB can use; this extra information
5566 makes debugging work better in GDB but probably makes other debuggers
5567 crash or
5568 refuse to read the program.  If you want to control for certain whether
5569 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5570 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5572 GCC allows you to use @option{-g} with
5573 @option{-O}.  The shortcuts taken by optimized code may occasionally
5574 produce surprising results: some variables you declared may not exist
5575 at all; flow of control may briefly move where you did not expect it;
5576 some statements may not be executed because they compute constant
5577 results or their values are already at hand; some statements may
5578 execute in different places because they have been moved out of loops.
5580 Nevertheless it proves possible to debug optimized output.  This makes
5581 it reasonable to use the optimizer for programs that might have bugs.
5583 The following options are useful when GCC is generated with the
5584 capability for more than one debugging format.
5586 @item -gsplit-dwarf
5587 @opindex gsplit-dwarf
5588 Separate as much dwarf debugging information as possible into a
5589 separate output file with the extension .dwo.  This option allows
5590 the build system to avoid linking files with debug information.  To
5591 be useful, this option requires a debugger capable of reading .dwo
5592 files.
5594 @item -ggdb
5595 @opindex ggdb
5596 Produce debugging information for use by GDB@.  This means to use the
5597 most expressive format available (DWARF 2, stabs, or the native format
5598 if neither of those are supported), including GDB extensions if at all
5599 possible.
5601 @item -gpubnames
5602 @opindex gpubnames
5603 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5605 @item -ggnu-pubnames
5606 @opindex ggnu-pubnames
5607 Generate .debug_pubnames and .debug_pubtypes sections in a format
5608 suitable for conversion into a GDB@ index.  This option is only useful
5609 with a linker that can produce GDB@ index version 7.
5611 @item -gstabs
5612 @opindex gstabs
5613 Produce debugging information in stabs format (if that is supported),
5614 without GDB extensions.  This is the format used by DBX on most BSD
5615 systems.  On MIPS, Alpha and System V Release 4 systems this option
5616 produces stabs debugging output that is not understood by DBX or SDB@.
5617 On System V Release 4 systems this option requires the GNU assembler.
5619 @item -feliminate-unused-debug-symbols
5620 @opindex feliminate-unused-debug-symbols
5621 Produce debugging information in stabs format (if that is supported),
5622 for only symbols that are actually used.
5624 @item -femit-class-debug-always
5625 @opindex femit-class-debug-always
5626 Instead of emitting debugging information for a C++ class in only one
5627 object file, emit it in all object files using the class.  This option
5628 should be used only with debuggers that are unable to handle the way GCC
5629 normally emits debugging information for classes because using this
5630 option increases the size of debugging information by as much as a
5631 factor of two.
5633 @item -fdebug-types-section
5634 @opindex fdebug-types-section
5635 @opindex fno-debug-types-section
5636 When using DWARF Version 4 or higher, type DIEs can be put into
5637 their own @code{.debug_types} section instead of making them part of the
5638 @code{.debug_info} section.  It is more efficient to put them in a separate
5639 comdat sections since the linker can then remove duplicates.
5640 But not all DWARF consumers support @code{.debug_types} sections yet
5641 and on some objects @code{.debug_types} produces larger instead of smaller
5642 debugging information.
5644 @item -gstabs+
5645 @opindex gstabs+
5646 Produce debugging information in stabs format (if that is supported),
5647 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5648 use of these extensions is likely to make other debuggers crash or
5649 refuse to read the program.
5651 @item -gcoff
5652 @opindex gcoff
5653 Produce debugging information in COFF format (if that is supported).
5654 This is the format used by SDB on most System V systems prior to
5655 System V Release 4.
5657 @item -gxcoff
5658 @opindex gxcoff
5659 Produce debugging information in XCOFF format (if that is supported).
5660 This is the format used by the DBX debugger on IBM RS/6000 systems.
5662 @item -gxcoff+
5663 @opindex gxcoff+
5664 Produce debugging information in XCOFF format (if that is supported),
5665 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5666 use of these extensions is likely to make other debuggers crash or
5667 refuse to read the program, and may cause assemblers other than the GNU
5668 assembler (GAS) to fail with an error.
5670 @item -gdwarf-@var{version}
5671 @opindex gdwarf-@var{version}
5672 Produce debugging information in DWARF format (if that is supported).
5673 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5674 for most targets is 4.  DWARF Version 5 is only experimental.
5676 Note that with DWARF Version 2, some ports require and always
5677 use some non-conflicting DWARF 3 extensions in the unwind tables.
5679 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5680 for maximum benefit.
5682 @item -grecord-gcc-switches
5683 @opindex grecord-gcc-switches
5684 This switch causes the command-line options used to invoke the
5685 compiler that may affect code generation to be appended to the
5686 DW_AT_producer attribute in DWARF debugging information.  The options
5687 are concatenated with spaces separating them from each other and from
5688 the compiler version.  See also @option{-frecord-gcc-switches} for another
5689 way of storing compiler options into the object file.  This is the default.
5691 @item -gno-record-gcc-switches
5692 @opindex gno-record-gcc-switches
5693 Disallow appending command-line options to the DW_AT_producer attribute
5694 in DWARF debugging information.
5696 @item -gstrict-dwarf
5697 @opindex gstrict-dwarf
5698 Disallow using extensions of later DWARF standard version than selected
5699 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5700 DWARF extensions from later standard versions is allowed.
5702 @item -gno-strict-dwarf
5703 @opindex gno-strict-dwarf
5704 Allow using extensions of later DWARF standard version than selected with
5705 @option{-gdwarf-@var{version}}.
5707 @item -gz@r{[}=@var{type}@r{]}
5708 @opindex gz
5709 Produce compressed debug sections in DWARF format, if that is supported.
5710 If @var{type} is not given, the default type depends on the capabilities
5711 of the assembler and linker used.  @var{type} may be one of
5712 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
5713 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
5714 compression in traditional GNU format).  If the linker doesn't support
5715 writing compressed debug sections, the option is rejected.  Otherwise,
5716 if the assembler does not support them, @option{-gz} is silently ignored
5717 when producing object files.
5719 @item -gvms
5720 @opindex gvms
5721 Produce debugging information in Alpha/VMS debug format (if that is
5722 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5724 @item -g@var{level}
5725 @itemx -ggdb@var{level}
5726 @itemx -gstabs@var{level}
5727 @itemx -gcoff@var{level}
5728 @itemx -gxcoff@var{level}
5729 @itemx -gvms@var{level}
5730 Request debugging information and also use @var{level} to specify how
5731 much information.  The default level is 2.
5733 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5734 @option{-g}.
5736 Level 1 produces minimal information, enough for making backtraces in
5737 parts of the program that you don't plan to debug.  This includes
5738 descriptions of functions and external variables, and line number
5739 tables, but no information about local variables.
5741 Level 3 includes extra information, such as all the macro definitions
5742 present in the program.  Some debuggers support macro expansion when
5743 you use @option{-g3}.
5745 @option{-gdwarf-2} does not accept a concatenated debug level, because
5746 GCC used to support an option @option{-gdwarf} that meant to generate
5747 debug information in version 1 of the DWARF format (which is very
5748 different from version 2), and it would have been too confusing.  That
5749 debug format is long obsolete, but the option cannot be changed now.
5750 Instead use an additional @option{-g@var{level}} option to change the
5751 debug level for DWARF.
5753 @item -gtoggle
5754 @opindex gtoggle
5755 Turn off generation of debug info, if leaving out this option
5756 generates it, or turn it on at level 2 otherwise.  The position of this
5757 argument in the command line does not matter; it takes effect after all
5758 other options are processed, and it does so only once, no matter how
5759 many times it is given.  This is mainly intended to be used with
5760 @option{-fcompare-debug}.
5762 @item -fsanitize=address
5763 @opindex fsanitize=address
5764 Enable AddressSanitizer, a fast memory error detector.
5765 Memory access instructions are instrumented to detect
5766 out-of-bounds and use-after-free bugs.
5767 See @uref{http://code.google.com/p/address-sanitizer/} for
5768 more details.  The run-time behavior can be influenced using the
5769 @env{ASAN_OPTIONS} environment variable; see
5770 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5771 a list of supported options.
5773 @item -fsanitize=kernel-address
5774 @opindex fsanitize=kernel-address
5775 Enable AddressSanitizer for Linux kernel.
5776 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5778 @item -fsanitize=thread
5779 @opindex fsanitize=thread
5780 Enable ThreadSanitizer, a fast data race detector.
5781 Memory access instructions are instrumented to detect
5782 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5783 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5784 environment variable; see
5785 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5786 supported options.
5788 @item -fsanitize=leak
5789 @opindex fsanitize=leak
5790 Enable LeakSanitizer, a memory leak detector.
5791 This option only matters for linking of executables and if neither
5792 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5793 case the executable is linked against a library that overrides @code{malloc}
5794 and other allocator functions.  See
5795 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5796 details.  The run-time behavior can be influenced using the
5797 @env{LSAN_OPTIONS} environment variable.
5799 @item -fsanitize=undefined
5800 @opindex fsanitize=undefined
5801 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5802 Various computations are instrumented to detect undefined behavior
5803 at runtime.  Current suboptions are:
5805 @table @gcctabopt
5807 @item -fsanitize=shift
5808 @opindex fsanitize=shift
5809 This option enables checking that the result of a shift operation is
5810 not undefined.  Note that what exactly is considered undefined differs
5811 slightly between C and C++, as well as between ISO C90 and C99, etc.
5813 @item -fsanitize=integer-divide-by-zero
5814 @opindex fsanitize=integer-divide-by-zero
5815 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5817 @item -fsanitize=unreachable
5818 @opindex fsanitize=unreachable
5819 With this option, the compiler turns the @code{__builtin_unreachable}
5820 call into a diagnostics message call instead.  When reaching the
5821 @code{__builtin_unreachable} call, the behavior is undefined.
5823 @item -fsanitize=vla-bound
5824 @opindex fsanitize=vla-bound
5825 This option instructs the compiler to check that the size of a variable
5826 length array is positive.
5828 @item -fsanitize=null
5829 @opindex fsanitize=null
5830 This option enables pointer checking.  Particularly, the application
5831 built with this option turned on will issue an error message when it
5832 tries to dereference a NULL pointer, or if a reference (possibly an
5833 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5834 on an object pointed by a NULL pointer.
5836 @item -fsanitize=return
5837 @opindex fsanitize=return
5838 This option enables return statement checking.  Programs
5839 built with this option turned on will issue an error message
5840 when the end of a non-void function is reached without actually
5841 returning a value.  This option works in C++ only.
5843 @item -fsanitize=signed-integer-overflow
5844 @opindex fsanitize=signed-integer-overflow
5845 This option enables signed integer overflow checking.  We check that
5846 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5847 does not overflow in the signed arithmetics.  Note, integer promotion
5848 rules must be taken into account.  That is, the following is not an
5849 overflow:
5850 @smallexample
5851 signed char a = SCHAR_MAX;
5852 a++;
5853 @end smallexample
5855 @item -fsanitize=bounds
5856 @opindex fsanitize=bounds
5857 This option enables instrumentation of array bounds.  Various out of bounds
5858 accesses are detected.  Flexible array members, flexible array member-like
5859 arrays, and initializers of variables with static storage are not instrumented.
5861 @item -fsanitize=bounds-strict
5862 @opindex fsanitize=bounds-strict
5863 This option enables strict instrumentation of array bounds.  Most out of bounds
5864 accesses are detected, including flexible array members and flexible array
5865 member-like arrays.  Initializers of variables with static storage are not
5866 instrumented.
5868 @item -fsanitize=alignment
5869 @opindex fsanitize=alignment
5871 This option enables checking of alignment of pointers when they are
5872 dereferenced, or when a reference is bound to insufficiently aligned target,
5873 or when a method or constructor is invoked on insufficiently aligned object.
5875 @item -fsanitize=object-size
5876 @opindex fsanitize=object-size
5877 This option enables instrumentation of memory references using the
5878 @code{__builtin_object_size} function.  Various out of bounds pointer
5879 accesses are detected.
5881 @item -fsanitize=float-divide-by-zero
5882 @opindex fsanitize=float-divide-by-zero
5883 Detect floating-point division by zero.  Unlike other similar options,
5884 @option{-fsanitize=float-divide-by-zero} is not enabled by
5885 @option{-fsanitize=undefined}, since floating-point division by zero can
5886 be a legitimate way of obtaining infinities and NaNs.
5888 @item -fsanitize=float-cast-overflow
5889 @opindex fsanitize=float-cast-overflow
5890 This option enables floating-point type to integer conversion checking.
5891 We check that the result of the conversion does not overflow.
5892 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
5893 not enabled by @option{-fsanitize=undefined}.
5894 This option does not work well with @code{FE_INVALID} exceptions enabled.
5896 @item -fsanitize=nonnull-attribute
5897 @opindex fsanitize=nonnull-attribute
5899 This option enables instrumentation of calls, checking whether null values
5900 are not passed to arguments marked as requiring a non-null value by the
5901 @code{nonnull} function attribute.
5903 @item -fsanitize=returns-nonnull-attribute
5904 @opindex fsanitize=returns-nonnull-attribute
5906 This option enables instrumentation of return statements in functions
5907 marked with @code{returns_nonnull} function attribute, to detect returning
5908 of null values from such functions.
5910 @item -fsanitize=bool
5911 @opindex fsanitize=bool
5913 This option enables instrumentation of loads from bool.  If a value other
5914 than 0/1 is loaded, a run-time error is issued.
5916 @item -fsanitize=enum
5917 @opindex fsanitize=enum
5919 This option enables instrumentation of loads from an enum type.  If
5920 a value outside the range of values for the enum type is loaded,
5921 a run-time error is issued.
5923 @item -fsanitize=vptr
5924 @opindex fsanitize=vptr
5926 This option enables instrumentation of C++ member function calls, member
5927 accesses and some conversions between pointers to base and derived classes,
5928 to verify the referenced object has the correct dynamic type.
5930 @end table
5932 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5933 @option{-fsanitize=undefined} gives a diagnostic message.
5934 This currently works only for the C family of languages.
5936 @item -fno-sanitize=all
5937 @opindex fno-sanitize=all
5939 This option disables all previously enabled sanitizers.
5940 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
5941 together.
5943 @item -fasan-shadow-offset=@var{number}
5944 @opindex fasan-shadow-offset
5945 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5946 It is useful for experimenting with different shadow memory layouts in
5947 Kernel AddressSanitizer.
5949 @item -fsanitize-sections=@var{s1},@var{s2},...
5950 @opindex fsanitize-sections
5951 Sanitize global variables in selected user-defined sections.  @var{si} may
5952 contain wildcards.
5954 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5955 @opindex fsanitize-recover
5956 @opindex fno-sanitize-recover
5957 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5958 mentioned in comma-separated list of @var{opts}.  Enabling this option
5959 for a sanitizer component causes it to attempt to continue
5960 running the program as if no error happened.  This means multiple
5961 runtime errors can be reported in a single program run, and the exit
5962 code of the program may indicate success even when errors
5963 have been reported.  The @option{-fno-sanitize-recover=} option
5964 can be used to alter
5965 this behavior: only the first detected error is reported
5966 and program then exits with a non-zero exit code.
5968 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5969 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5970 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5971 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5972 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
5973 accepted, the former enables recovery for all sanitizers that support it,
5974 the latter disables recovery for all sanitizers that support it.
5976 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5977 @smallexample
5978 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5979 @end smallexample
5980 @noindent
5981 Similarly @option{-fno-sanitize-recover} is equivalent to
5982 @smallexample
5983 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5984 @end smallexample
5986 @item -fsanitize-undefined-trap-on-error
5987 @opindex fsanitize-undefined-trap-on-error
5988 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
5989 report undefined behavior using @code{__builtin_trap} rather than
5990 a @code{libubsan} library routine.  The advantage of this is that the
5991 @code{libubsan} library is not needed and is not linked in, so this
5992 is usable even in freestanding environments.
5994 @item -fcheck-pointer-bounds
5995 @opindex fcheck-pointer-bounds
5996 @opindex fno-check-pointer-bounds
5997 @cindex Pointer Bounds Checker options
5998 Enable Pointer Bounds Checker instrumentation.  Each memory reference
5999 is instrumented with checks of the pointer used for memory access against
6000 bounds associated with that pointer.  
6002 Currently there
6003 is only an implementation for Intel MPX available, thus x86 target
6004 and @option{-mmpx} are required to enable this feature.  
6005 MPX-based instrumentation requires
6006 a runtime library to enable MPX in hardware and handle bounds
6007 violation signals.  By default when @option{-fcheck-pointer-bounds}
6008 and @option{-mmpx} options are used to link a program, the GCC driver
6009 links against the @file{libmpx} runtime library and @file{libmpxwrappers}
6010 library.  It also passes '-z bndplt' to a linker in case it supports this
6011 option (which is checked on libmpx configuration).  Note that old versions
6012 of linker may ignore option.  Gold linker doesn't support '-z bndplt'
6013 option.  With no '-z bndplt' support in linker all calls to dynamic libraries
6014 lose passed bounds reducing overall protection level.  It's highly
6015 recommended to use linker with '-z bndplt' support.  In case such linker
6016 is not available it is adviced to always use @option{-static-libmpxwrappers}
6017 for better protection level or use @option{-static} to completely avoid
6018 external calls to dynamic libraries.  MPX-based instrumentation
6019 may be used for debugging and also may be included in production code
6020 to increase program security.  Depending on usage, you may
6021 have different requirements for the runtime library.  The current version
6022 of the MPX runtime library is more oriented for use as a debugging
6023 tool.  MPX runtime library usage implies @option{-lpthread}.  See
6024 also @option{-static-libmpx}.  The runtime library  behavior can be
6025 influenced using various @env{CHKP_RT_*} environment variables.  See
6026 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
6027 for more details.
6029 Generated instrumentation may be controlled by various
6030 @option{-fchkp-*} options and by the @code{bnd_variable_size}
6031 structure field attribute (@pxref{Type Attributes}) and
6032 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
6033 (@pxref{Function Attributes}).  GCC also provides a number of built-in
6034 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
6035 Bounds Checker builtins}, for more information.
6037 @item -fchkp-check-incomplete-type
6038 @opindex fchkp-check-incomplete-type
6039 @opindex fno-chkp-check-incomplete-type
6040 Generate pointer bounds checks for variables with incomplete type.
6041 Enabled by default.
6043 @item -fchkp-narrow-bounds
6044 @opindex fchkp-narrow-bounds
6045 @opindex fno-chkp-narrow-bounds
6046 Controls bounds used by Pointer Bounds Checker for pointers to object
6047 fields.  If narrowing is enabled then field bounds are used.  Otherwise
6048 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
6049 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
6051 @item -fchkp-first-field-has-own-bounds
6052 @opindex fchkp-first-field-has-own-bounds
6053 @opindex fno-chkp-first-field-has-own-bounds
6054 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
6055 first field in the structure.  By default a pointer to the first field has
6056 the same bounds as a pointer to the whole structure.
6058 @item -fchkp-narrow-to-innermost-array
6059 @opindex fchkp-narrow-to-innermost-array
6060 @opindex fno-chkp-narrow-to-innermost-array
6061 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
6062 case of nested static array access.  By default this option is disabled and
6063 bounds of the outermost array are used.
6065 @item -fchkp-optimize
6066 @opindex fchkp-optimize
6067 @opindex fno-chkp-optimize
6068 Enables Pointer Bounds Checker optimizations.  Enabled by default at
6069 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
6071 @item -fchkp-use-fast-string-functions
6072 @opindex fchkp-use-fast-string-functions
6073 @opindex fno-chkp-use-fast-string-functions
6074 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
6075 by Pointer Bounds Checker.  Disabled by default.
6077 @item -fchkp-use-nochk-string-functions
6078 @opindex fchkp-use-nochk-string-functions
6079 @opindex fno-chkp-use-nochk-string-functions
6080 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
6081 by Pointer Bounds Checker.  Disabled by default.
6083 @item -fchkp-use-static-bounds
6084 @opindex fchkp-use-static-bounds
6085 @opindex fno-chkp-use-static-bounds
6086 Allow Pointer Bounds Checker to generate static bounds holding
6087 bounds of static variables.  Enabled by default.
6089 @item -fchkp-use-static-const-bounds
6090 @opindex fchkp-use-static-const-bounds
6091 @opindex fno-chkp-use-static-const-bounds
6092 Use statically-initialized bounds for constant bounds instead of
6093 generating them each time they are required.  By default enabled when
6094 @option{-fchkp-use-static-bounds} is enabled.
6096 @item -fchkp-treat-zero-dynamic-size-as-infinite
6097 @opindex fchkp-treat-zero-dynamic-size-as-infinite
6098 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
6099 With this option, objects with incomplete type whose
6100 dynamically-obtained size is zero are treated as having infinite size
6101 instead by Pointer Bounds
6102 Checker.  This option may be helpful if a program is linked with a library
6103 missing size information for some symbols.  Disabled by default.
6105 @item -fchkp-check-read
6106 @opindex fchkp-check-read
6107 @opindex fno-chkp-check-read
6108 Instructs Pointer Bounds Checker to generate checks for all read
6109 accesses to memory.  Enabled by default.
6111 @item -fchkp-check-write
6112 @opindex fchkp-check-write
6113 @opindex fno-chkp-check-write
6114 Instructs Pointer Bounds Checker to generate checks for all write
6115 accesses to memory.  Enabled by default.
6117 @item -fchkp-store-bounds
6118 @opindex fchkp-store-bounds
6119 @opindex fno-chkp-store-bounds
6120 Instructs Pointer Bounds Checker to generate bounds stores for
6121 pointer writes.  Enabled by default.
6123 @item -fchkp-instrument-calls
6124 @opindex fchkp-instrument-calls
6125 @opindex fno-chkp-instrument-calls
6126 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
6127 Enabled by default.
6129 @item -fchkp-instrument-marked-only
6130 @opindex fchkp-instrument-marked-only
6131 @opindex fno-chkp-instrument-marked-only
6132 Instructs Pointer Bounds Checker to instrument only functions
6133 marked with the @code{bnd_instrument} attribute
6134 (@pxref{Function Attributes}).  Disabled by default.
6136 @item -fchkp-use-wrappers
6137 @opindex fchkp-use-wrappers
6138 @opindex fno-chkp-use-wrappers
6139 Allows Pointer Bounds Checker to replace calls to built-in functions
6140 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
6141 is used to link a program, the GCC driver automatically links
6142 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
6143 Enabled by default.
6145 @item -fdump-final-insns@r{[}=@var{file}@r{]}
6146 @opindex fdump-final-insns
6147 Dump the final internal representation (RTL) to @var{file}.  If the
6148 optional argument is omitted (or if @var{file} is @code{.}), the name
6149 of the dump file is determined by appending @code{.gkd} to the
6150 compilation output file name.
6152 @item -fcompare-debug@r{[}=@var{opts}@r{]}
6153 @opindex fcompare-debug
6154 @opindex fno-compare-debug
6155 If no error occurs during compilation, run the compiler a second time,
6156 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
6157 passed to the second compilation.  Dump the final internal
6158 representation in both compilations, and print an error if they differ.
6160 If the equal sign is omitted, the default @option{-gtoggle} is used.
6162 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
6163 and nonzero, implicitly enables @option{-fcompare-debug}.  If
6164 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
6165 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
6166 is used.
6168 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
6169 is equivalent to @option{-fno-compare-debug}, which disables the dumping
6170 of the final representation and the second compilation, preventing even
6171 @env{GCC_COMPARE_DEBUG} from taking effect.
6173 To verify full coverage during @option{-fcompare-debug} testing, set
6174 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
6175 which GCC rejects as an invalid option in any actual compilation
6176 (rather than preprocessing, assembly or linking).  To get just a
6177 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
6178 not overridden} will do.
6180 @item -fcompare-debug-second
6181 @opindex fcompare-debug-second
6182 This option is implicitly passed to the compiler for the second
6183 compilation requested by @option{-fcompare-debug}, along with options to
6184 silence warnings, and omitting other options that would cause
6185 side-effect compiler outputs to files or to the standard output.  Dump
6186 files and preserved temporary files are renamed so as to contain the
6187 @code{.gk} additional extension during the second compilation, to avoid
6188 overwriting those generated by the first.
6190 When this option is passed to the compiler driver, it causes the
6191 @emph{first} compilation to be skipped, which makes it useful for little
6192 other than debugging the compiler proper.
6194 @item -feliminate-dwarf2-dups
6195 @opindex feliminate-dwarf2-dups
6196 Compress DWARF 2 debugging information by eliminating duplicated
6197 information about each symbol.  This option only makes sense when
6198 generating DWARF 2 debugging information with @option{-gdwarf-2}.
6200 @item -femit-struct-debug-baseonly
6201 @opindex femit-struct-debug-baseonly
6202 Emit debug information for struct-like types
6203 only when the base name of the compilation source file
6204 matches the base name of file in which the struct is defined.
6206 This option substantially reduces the size of debugging information,
6207 but at significant potential loss in type information to the debugger.
6208 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6209 See @option{-femit-struct-debug-detailed} for more detailed control.
6211 This option works only with DWARF 2.
6213 @item -femit-struct-debug-reduced
6214 @opindex femit-struct-debug-reduced
6215 Emit debug information for struct-like types
6216 only when the base name of the compilation source file
6217 matches the base name of file in which the type is defined,
6218 unless the struct is a template or defined in a system header.
6220 This option significantly reduces the size of debugging information,
6221 with some potential loss in type information to the debugger.
6222 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6223 See @option{-femit-struct-debug-detailed} for more detailed control.
6225 This option works only with DWARF 2.
6227 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6228 @opindex femit-struct-debug-detailed
6229 Specify the struct-like types
6230 for which the compiler generates debug information.
6231 The intent is to reduce duplicate struct debug information
6232 between different object files within the same program.
6234 This option is a detailed version of
6235 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6236 which serves for most needs.
6238 A specification has the syntax@*
6239 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6241 The optional first word limits the specification to
6242 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6243 A struct type is used directly when it is the type of a variable, member.
6244 Indirect uses arise through pointers to structs.
6245 That is, when use of an incomplete struct is valid, the use is indirect.
6246 An example is
6247 @samp{struct one direct; struct two * indirect;}.
6249 The optional second word limits the specification to
6250 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6251 Generic structs are a bit complicated to explain.
6252 For C++, these are non-explicit specializations of template classes,
6253 or non-template classes within the above.
6254 Other programming languages have generics,
6255 but @option{-femit-struct-debug-detailed} does not yet implement them.
6257 The third word specifies the source files for those
6258 structs for which the compiler should emit debug information.
6259 The values @samp{none} and @samp{any} have the normal meaning.
6260 The value @samp{base} means that
6261 the base of name of the file in which the type declaration appears
6262 must match the base of the name of the main compilation file.
6263 In practice, this means that when compiling @file{foo.c}, debug information
6264 is generated for types declared in that file and @file{foo.h},
6265 but not other header files.
6266 The value @samp{sys} means those types satisfying @samp{base}
6267 or declared in system or compiler headers.
6269 You may need to experiment to determine the best settings for your application.
6271 The default is @option{-femit-struct-debug-detailed=all}.
6273 This option works only with DWARF 2.
6275 @item -fno-merge-debug-strings
6276 @opindex fmerge-debug-strings
6277 @opindex fno-merge-debug-strings
6278 Direct the linker to not merge together strings in the debugging
6279 information that are identical in different object files.  Merging is
6280 not supported by all assemblers or linkers.  Merging decreases the size
6281 of the debug information in the output file at the cost of increasing
6282 link processing time.  Merging is enabled by default.
6284 @item -fdebug-prefix-map=@var{old}=@var{new}
6285 @opindex fdebug-prefix-map
6286 When compiling files in directory @file{@var{old}}, record debugging
6287 information describing them as in @file{@var{new}} instead.
6289 @item -fno-dwarf2-cfi-asm
6290 @opindex fdwarf2-cfi-asm
6291 @opindex fno-dwarf2-cfi-asm
6292 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
6293 instead of using GAS @code{.cfi_*} directives.
6295 @cindex @command{prof}
6296 @item -p
6297 @opindex p
6298 Generate extra code to write profile information suitable for the
6299 analysis program @command{prof}.  You must use this option when compiling
6300 the source files you want data about, and you must also use it when
6301 linking.
6303 @cindex @command{gprof}
6304 @item -pg
6305 @opindex pg
6306 Generate extra code to write profile information suitable for the
6307 analysis program @command{gprof}.  You must use this option when compiling
6308 the source files you want data about, and you must also use it when
6309 linking.
6311 @item -Q
6312 @opindex Q
6313 Makes the compiler print out each function name as it is compiled, and
6314 print some statistics about each pass when it finishes.
6316 @item -ftime-report
6317 @opindex ftime-report
6318 Makes the compiler print some statistics about the time consumed by each
6319 pass when it finishes.
6321 @item -fmem-report
6322 @opindex fmem-report
6323 Makes the compiler print some statistics about permanent memory
6324 allocation when it finishes.
6326 @item -fmem-report-wpa
6327 @opindex fmem-report-wpa
6328 Makes the compiler print some statistics about permanent memory
6329 allocation for the WPA phase only.
6331 @item -fpre-ipa-mem-report
6332 @opindex fpre-ipa-mem-report
6333 @item -fpost-ipa-mem-report
6334 @opindex fpost-ipa-mem-report
6335 Makes the compiler print some statistics about permanent memory
6336 allocation before or after interprocedural optimization.
6338 @item -fprofile-report
6339 @opindex fprofile-report
6340 Makes the compiler print some statistics about consistency of the
6341 (estimated) profile and effect of individual passes.
6343 @item -fstack-usage
6344 @opindex fstack-usage
6345 Makes the compiler output stack usage information for the program, on a
6346 per-function basis.  The filename for the dump is made by appending
6347 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
6348 the output file, if explicitly specified and it is not an executable,
6349 otherwise it is the basename of the source file.  An entry is made up
6350 of three fields:
6352 @itemize
6353 @item
6354 The name of the function.
6355 @item
6356 A number of bytes.
6357 @item
6358 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
6359 @end itemize
6361 The qualifier @code{static} means that the function manipulates the stack
6362 statically: a fixed number of bytes are allocated for the frame on function
6363 entry and released on function exit; no stack adjustments are otherwise made
6364 in the function.  The second field is this fixed number of bytes.
6366 The qualifier @code{dynamic} means that the function manipulates the stack
6367 dynamically: in addition to the static allocation described above, stack
6368 adjustments are made in the body of the function, for example to push/pop
6369 arguments around function calls.  If the qualifier @code{bounded} is also
6370 present, the amount of these adjustments is bounded at compile time and
6371 the second field is an upper bound of the total amount of stack used by
6372 the function.  If it is not present, the amount of these adjustments is
6373 not bounded at compile time and the second field only represents the
6374 bounded part.
6376 @item -fprofile-arcs
6377 @opindex fprofile-arcs
6378 Add code so that program flow @dfn{arcs} are instrumented.  During
6379 execution the program records how many times each branch and call is
6380 executed and how many times it is taken or returns.  When the compiled
6381 program exits it saves this data to a file called
6382 @file{@var{auxname}.gcda} for each source file.  The data may be used for
6383 profile-directed optimizations (@option{-fbranch-probabilities}), or for
6384 test coverage analysis (@option{-ftest-coverage}).  Each object file's
6385 @var{auxname} is generated from the name of the output file, if
6386 explicitly specified and it is not the final executable, otherwise it is
6387 the basename of the source file.  In both cases any suffix is removed
6388 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
6389 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
6390 @xref{Cross-profiling}.
6392 @cindex @command{gcov}
6393 @item --coverage
6394 @opindex coverage
6396 This option is used to compile and link code instrumented for coverage
6397 analysis.  The option is a synonym for @option{-fprofile-arcs}
6398 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6399 linking).  See the documentation for those options for more details.
6401 @itemize
6403 @item
6404 Compile the source files with @option{-fprofile-arcs} plus optimization
6405 and code generation options.  For test coverage analysis, use the
6406 additional @option{-ftest-coverage} option.  You do not need to profile
6407 every source file in a program.
6409 @item
6410 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6411 (the latter implies the former).
6413 @item
6414 Run the program on a representative workload to generate the arc profile
6415 information.  This may be repeated any number of times.  You can run
6416 concurrent instances of your program, and provided that the file system
6417 supports locking, the data files will be correctly updated.  Also
6418 @code{fork} calls are detected and correctly handled (double counting
6419 will not happen).
6421 @item
6422 For profile-directed optimizations, compile the source files again with
6423 the same optimization and code generation options plus
6424 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6425 Control Optimization}).
6427 @item
6428 For test coverage analysis, use @command{gcov} to produce human readable
6429 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6430 @command{gcov} documentation for further information.
6432 @end itemize
6434 With @option{-fprofile-arcs}, for each function of your program GCC
6435 creates a program flow graph, then finds a spanning tree for the graph.
6436 Only arcs that are not on the spanning tree have to be instrumented: the
6437 compiler adds code to count the number of times that these arcs are
6438 executed.  When an arc is the only exit or only entrance to a block, the
6439 instrumentation code can be added to the block; otherwise, a new basic
6440 block must be created to hold the instrumentation code.
6442 @need 2000
6443 @item -ftest-coverage
6444 @opindex ftest-coverage
6445 Produce a notes file that the @command{gcov} code-coverage utility
6446 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6447 show program coverage.  Each source file's note file is called
6448 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6449 above for a description of @var{auxname} and instructions on how to
6450 generate test coverage data.  Coverage data matches the source files
6451 more closely if you do not optimize.
6453 @item -fdbg-cnt-list
6454 @opindex fdbg-cnt-list
6455 Print the name and the counter upper bound for all debug counters.
6458 @item -fdbg-cnt=@var{counter-value-list}
6459 @opindex fdbg-cnt
6460 Set the internal debug counter upper bound.  @var{counter-value-list}
6461 is a comma-separated list of @var{name}:@var{value} pairs
6462 which sets the upper bound of each debug counter @var{name} to @var{value}.
6463 All debug counters have the initial upper bound of @code{UINT_MAX};
6464 thus @code{dbg_cnt} returns true always unless the upper bound
6465 is set by this option.
6466 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6467 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6469 @item -fenable-@var{kind}-@var{pass}
6470 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6471 @opindex fdisable-
6472 @opindex fenable-
6474 This is a set of options that are used to explicitly disable/enable
6475 optimization passes.  These options are intended for use for debugging GCC.
6476 Compiler users should use regular options for enabling/disabling
6477 passes instead.
6479 @table @gcctabopt
6481 @item -fdisable-ipa-@var{pass}
6482 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6483 statically invoked in the compiler multiple times, the pass name should be
6484 appended with a sequential number starting from 1.
6486 @item -fdisable-rtl-@var{pass}
6487 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6488 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6489 statically invoked in the compiler multiple times, the pass name should be
6490 appended with a sequential number starting from 1.  @var{range-list} is a 
6491 comma-separated list of function ranges or assembler names.  Each range is a number
6492 pair separated by a colon.  The range is inclusive in both ends.  If the range
6493 is trivial, the number pair can be simplified as a single number.  If the
6494 function's call graph node's @var{uid} falls within one of the specified ranges,
6495 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6496 function header of a dump file, and the pass names can be dumped by using
6497 option @option{-fdump-passes}.
6499 @item -fdisable-tree-@var{pass}
6500 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6501 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6502 option arguments.
6504 @item -fenable-ipa-@var{pass}
6505 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6506 statically invoked in the compiler multiple times, the pass name should be
6507 appended with a sequential number starting from 1.
6509 @item -fenable-rtl-@var{pass}
6510 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6511 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6512 description and examples.
6514 @item -fenable-tree-@var{pass}
6515 @itemx -fenable-tree-@var{pass}=@var{range-list}
6516 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6517 of option arguments.
6519 @end table
6521 Here are some examples showing uses of these options.
6523 @smallexample
6525 # disable ccp1 for all functions
6526    -fdisable-tree-ccp1
6527 # disable complete unroll for function whose cgraph node uid is 1
6528    -fenable-tree-cunroll=1
6529 # disable gcse2 for functions at the following ranges [1,1],
6530 # [300,400], and [400,1000]
6531 # disable gcse2 for functions foo and foo2
6532    -fdisable-rtl-gcse2=foo,foo2
6533 # disable early inlining
6534    -fdisable-tree-einline
6535 # disable ipa inlining
6536    -fdisable-ipa-inline
6537 # enable tree full unroll
6538    -fenable-tree-unroll
6540 @end smallexample
6542 @item -d@var{letters}
6543 @itemx -fdump-rtl-@var{pass}
6544 @itemx -fdump-rtl-@var{pass}=@var{filename}
6545 @opindex d
6546 @opindex fdump-rtl-@var{pass}
6547 Says to make debugging dumps during compilation at times specified by
6548 @var{letters}.  This is used for debugging the RTL-based passes of the
6549 compiler.  The file names for most of the dumps are made by appending
6550 a pass number and a word to the @var{dumpname}, and the files are
6551 created in the directory of the output file. In case of
6552 @option{=@var{filename}} option, the dump is output on the given file
6553 instead of the pass numbered dump files. Note that the pass number is
6554 computed statically as passes get registered into the pass manager.
6555 Thus the numbering is not related to the dynamic order of execution of
6556 passes.  In particular, a pass installed by a plugin could have a
6557 number over 200 even if it executed quite early.  @var{dumpname} is
6558 generated from the name of the output file, if explicitly specified
6559 and it is not an executable, otherwise it is the basename of the
6560 source file. These switches may have different effects when
6561 @option{-E} is used for preprocessing.
6563 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6564 @option{-d} option @var{letters}.  Here are the possible
6565 letters for use in @var{pass} and @var{letters}, and their meanings:
6567 @table @gcctabopt
6569 @item -fdump-rtl-alignments
6570 @opindex fdump-rtl-alignments
6571 Dump after branch alignments have been computed.
6573 @item -fdump-rtl-asmcons
6574 @opindex fdump-rtl-asmcons
6575 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6577 @item -fdump-rtl-auto_inc_dec
6578 @opindex fdump-rtl-auto_inc_dec
6579 Dump after auto-inc-dec discovery.  This pass is only run on
6580 architectures that have auto inc or auto dec instructions.
6582 @item -fdump-rtl-barriers
6583 @opindex fdump-rtl-barriers
6584 Dump after cleaning up the barrier instructions.
6586 @item -fdump-rtl-bbpart
6587 @opindex fdump-rtl-bbpart
6588 Dump after partitioning hot and cold basic blocks.
6590 @item -fdump-rtl-bbro
6591 @opindex fdump-rtl-bbro
6592 Dump after block reordering.
6594 @item -fdump-rtl-btl1
6595 @itemx -fdump-rtl-btl2
6596 @opindex fdump-rtl-btl2
6597 @opindex fdump-rtl-btl2
6598 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6599 after the two branch
6600 target load optimization passes.
6602 @item -fdump-rtl-bypass
6603 @opindex fdump-rtl-bypass
6604 Dump after jump bypassing and control flow optimizations.
6606 @item -fdump-rtl-combine
6607 @opindex fdump-rtl-combine
6608 Dump after the RTL instruction combination pass.
6610 @item -fdump-rtl-compgotos
6611 @opindex fdump-rtl-compgotos
6612 Dump after duplicating the computed gotos.
6614 @item -fdump-rtl-ce1
6615 @itemx -fdump-rtl-ce2
6616 @itemx -fdump-rtl-ce3
6617 @opindex fdump-rtl-ce1
6618 @opindex fdump-rtl-ce2
6619 @opindex fdump-rtl-ce3
6620 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6621 @option{-fdump-rtl-ce3} enable dumping after the three
6622 if conversion passes.
6624 @item -fdump-rtl-cprop_hardreg
6625 @opindex fdump-rtl-cprop_hardreg
6626 Dump after hard register copy propagation.
6628 @item -fdump-rtl-csa
6629 @opindex fdump-rtl-csa
6630 Dump after combining stack adjustments.
6632 @item -fdump-rtl-cse1
6633 @itemx -fdump-rtl-cse2
6634 @opindex fdump-rtl-cse1
6635 @opindex fdump-rtl-cse2
6636 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6637 the two common subexpression elimination passes.
6639 @item -fdump-rtl-dce
6640 @opindex fdump-rtl-dce
6641 Dump after the standalone dead code elimination passes.
6643 @item -fdump-rtl-dbr
6644 @opindex fdump-rtl-dbr
6645 Dump after delayed branch scheduling.
6647 @item -fdump-rtl-dce1
6648 @itemx -fdump-rtl-dce2
6649 @opindex fdump-rtl-dce1
6650 @opindex fdump-rtl-dce2
6651 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6652 the two dead store elimination passes.
6654 @item -fdump-rtl-eh
6655 @opindex fdump-rtl-eh
6656 Dump after finalization of EH handling code.
6658 @item -fdump-rtl-eh_ranges
6659 @opindex fdump-rtl-eh_ranges
6660 Dump after conversion of EH handling range regions.
6662 @item -fdump-rtl-expand
6663 @opindex fdump-rtl-expand
6664 Dump after RTL generation.
6666 @item -fdump-rtl-fwprop1
6667 @itemx -fdump-rtl-fwprop2
6668 @opindex fdump-rtl-fwprop1
6669 @opindex fdump-rtl-fwprop2
6670 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6671 dumping after the two forward propagation passes.
6673 @item -fdump-rtl-gcse1
6674 @itemx -fdump-rtl-gcse2
6675 @opindex fdump-rtl-gcse1
6676 @opindex fdump-rtl-gcse2
6677 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6678 after global common subexpression elimination.
6680 @item -fdump-rtl-init-regs
6681 @opindex fdump-rtl-init-regs
6682 Dump after the initialization of the registers.
6684 @item -fdump-rtl-initvals
6685 @opindex fdump-rtl-initvals
6686 Dump after the computation of the initial value sets.
6688 @item -fdump-rtl-into_cfglayout
6689 @opindex fdump-rtl-into_cfglayout
6690 Dump after converting to cfglayout mode.
6692 @item -fdump-rtl-ira
6693 @opindex fdump-rtl-ira
6694 Dump after iterated register allocation.
6696 @item -fdump-rtl-jump
6697 @opindex fdump-rtl-jump
6698 Dump after the second jump optimization.
6700 @item -fdump-rtl-loop2
6701 @opindex fdump-rtl-loop2
6702 @option{-fdump-rtl-loop2} enables dumping after the rtl
6703 loop optimization passes.
6705 @item -fdump-rtl-mach
6706 @opindex fdump-rtl-mach
6707 Dump after performing the machine dependent reorganization pass, if that
6708 pass exists.
6710 @item -fdump-rtl-mode_sw
6711 @opindex fdump-rtl-mode_sw
6712 Dump after removing redundant mode switches.
6714 @item -fdump-rtl-rnreg
6715 @opindex fdump-rtl-rnreg
6716 Dump after register renumbering.
6718 @item -fdump-rtl-outof_cfglayout
6719 @opindex fdump-rtl-outof_cfglayout
6720 Dump after converting from cfglayout mode.
6722 @item -fdump-rtl-peephole2
6723 @opindex fdump-rtl-peephole2
6724 Dump after the peephole pass.
6726 @item -fdump-rtl-postreload
6727 @opindex fdump-rtl-postreload
6728 Dump after post-reload optimizations.
6730 @item -fdump-rtl-pro_and_epilogue
6731 @opindex fdump-rtl-pro_and_epilogue
6732 Dump after generating the function prologues and epilogues.
6734 @item -fdump-rtl-sched1
6735 @itemx -fdump-rtl-sched2
6736 @opindex fdump-rtl-sched1
6737 @opindex fdump-rtl-sched2
6738 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6739 after the basic block scheduling passes.
6741 @item -fdump-rtl-ree
6742 @opindex fdump-rtl-ree
6743 Dump after sign/zero extension elimination.
6745 @item -fdump-rtl-seqabstr
6746 @opindex fdump-rtl-seqabstr
6747 Dump after common sequence discovery.
6749 @item -fdump-rtl-shorten
6750 @opindex fdump-rtl-shorten
6751 Dump after shortening branches.
6753 @item -fdump-rtl-sibling
6754 @opindex fdump-rtl-sibling
6755 Dump after sibling call optimizations.
6757 @item -fdump-rtl-split1
6758 @itemx -fdump-rtl-split2
6759 @itemx -fdump-rtl-split3
6760 @itemx -fdump-rtl-split4
6761 @itemx -fdump-rtl-split5
6762 @opindex fdump-rtl-split1
6763 @opindex fdump-rtl-split2
6764 @opindex fdump-rtl-split3
6765 @opindex fdump-rtl-split4
6766 @opindex fdump-rtl-split5
6767 These options enable dumping after five rounds of
6768 instruction splitting.
6770 @item -fdump-rtl-sms
6771 @opindex fdump-rtl-sms
6772 Dump after modulo scheduling.  This pass is only run on some
6773 architectures.
6775 @item -fdump-rtl-stack
6776 @opindex fdump-rtl-stack
6777 Dump after conversion from GCC's ``flat register file'' registers to the
6778 x87's stack-like registers.  This pass is only run on x86 variants.
6780 @item -fdump-rtl-subreg1
6781 @itemx -fdump-rtl-subreg2
6782 @opindex fdump-rtl-subreg1
6783 @opindex fdump-rtl-subreg2
6784 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6785 the two subreg expansion passes.
6787 @item -fdump-rtl-unshare
6788 @opindex fdump-rtl-unshare
6789 Dump after all rtl has been unshared.
6791 @item -fdump-rtl-vartrack
6792 @opindex fdump-rtl-vartrack
6793 Dump after variable tracking.
6795 @item -fdump-rtl-vregs
6796 @opindex fdump-rtl-vregs
6797 Dump after converting virtual registers to hard registers.
6799 @item -fdump-rtl-web
6800 @opindex fdump-rtl-web
6801 Dump after live range splitting.
6803 @item -fdump-rtl-regclass
6804 @itemx -fdump-rtl-subregs_of_mode_init
6805 @itemx -fdump-rtl-subregs_of_mode_finish
6806 @itemx -fdump-rtl-dfinit
6807 @itemx -fdump-rtl-dfinish
6808 @opindex fdump-rtl-regclass
6809 @opindex fdump-rtl-subregs_of_mode_init
6810 @opindex fdump-rtl-subregs_of_mode_finish
6811 @opindex fdump-rtl-dfinit
6812 @opindex fdump-rtl-dfinish
6813 These dumps are defined but always produce empty files.
6815 @item -da
6816 @itemx -fdump-rtl-all
6817 @opindex da
6818 @opindex fdump-rtl-all
6819 Produce all the dumps listed above.
6821 @item -dA
6822 @opindex dA
6823 Annotate the assembler output with miscellaneous debugging information.
6825 @item -dD
6826 @opindex dD
6827 Dump all macro definitions, at the end of preprocessing, in addition to
6828 normal output.
6830 @item -dH
6831 @opindex dH
6832 Produce a core dump whenever an error occurs.
6834 @item -dp
6835 @opindex dp
6836 Annotate the assembler output with a comment indicating which
6837 pattern and alternative is used.  The length of each instruction is
6838 also printed.
6840 @item -dP
6841 @opindex dP
6842 Dump the RTL in the assembler output as a comment before each instruction.
6843 Also turns on @option{-dp} annotation.
6845 @item -dx
6846 @opindex dx
6847 Just generate RTL for a function instead of compiling it.  Usually used
6848 with @option{-fdump-rtl-expand}.
6849 @end table
6851 @item -fdump-noaddr
6852 @opindex fdump-noaddr
6853 When doing debugging dumps, suppress address output.  This makes it more
6854 feasible to use diff on debugging dumps for compiler invocations with
6855 different compiler binaries and/or different
6856 text / bss / data / heap / stack / dso start locations.
6858 @item -freport-bug
6859 @opindex freport-bug
6860 Collect and dump debug information into temporary file if ICE in C/C++
6861 compiler occured.
6863 @item -fdump-unnumbered
6864 @opindex fdump-unnumbered
6865 When doing debugging dumps, suppress instruction numbers and address output.
6866 This makes it more feasible to use diff on debugging dumps for compiler
6867 invocations with different options, in particular with and without
6868 @option{-g}.
6870 @item -fdump-unnumbered-links
6871 @opindex fdump-unnumbered-links
6872 When doing debugging dumps (see @option{-d} option above), suppress
6873 instruction numbers for the links to the previous and next instructions
6874 in a sequence.
6876 @item -fdump-translation-unit @r{(C++ only)}
6877 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6878 @opindex fdump-translation-unit
6879 Dump a representation of the tree structure for the entire translation
6880 unit to a file.  The file name is made by appending @file{.tu} to the
6881 source file name, and the file is created in the same directory as the
6882 output file.  If the @samp{-@var{options}} form is used, @var{options}
6883 controls the details of the dump as described for the
6884 @option{-fdump-tree} options.
6886 @item -fdump-class-hierarchy @r{(C++ only)}
6887 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6888 @opindex fdump-class-hierarchy
6889 Dump a representation of each class's hierarchy and virtual function
6890 table layout to a file.  The file name is made by appending
6891 @file{.class} to the source file name, and the file is created in the
6892 same directory as the output file.  If the @samp{-@var{options}} form
6893 is used, @var{options} controls the details of the dump as described
6894 for the @option{-fdump-tree} options.
6896 @item -fdump-ipa-@var{switch}
6897 @opindex fdump-ipa
6898 Control the dumping at various stages of inter-procedural analysis
6899 language tree to a file.  The file name is generated by appending a
6900 switch specific suffix to the source file name, and the file is created
6901 in the same directory as the output file.  The following dumps are
6902 possible:
6904 @table @samp
6905 @item all
6906 Enables all inter-procedural analysis dumps.
6908 @item cgraph
6909 Dumps information about call-graph optimization, unused function removal,
6910 and inlining decisions.
6912 @item inline
6913 Dump after function inlining.
6915 @end table
6917 @item -fdump-passes
6918 @opindex fdump-passes
6919 Dump the list of optimization passes that are turned on and off by
6920 the current command-line options.
6922 @item -fdump-statistics-@var{option}
6923 @opindex fdump-statistics
6924 Enable and control dumping of pass statistics in a separate file.  The
6925 file name is generated by appending a suffix ending in
6926 @samp{.statistics} to the source file name, and the file is created in
6927 the same directory as the output file.  If the @samp{-@var{option}}
6928 form is used, @samp{-stats} causes counters to be summed over the
6929 whole compilation unit while @samp{-details} dumps every event as
6930 the passes generate them.  The default with no option is to sum
6931 counters for each function compiled.
6933 @item -fdump-tree-@var{switch}
6934 @itemx -fdump-tree-@var{switch}-@var{options}
6935 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6936 @opindex fdump-tree
6937 Control the dumping at various stages of processing the intermediate
6938 language tree to a file.  The file name is generated by appending a
6939 switch-specific suffix to the source file name, and the file is
6940 created in the same directory as the output file. In case of
6941 @option{=@var{filename}} option, the dump is output on the given file
6942 instead of the auto named dump files.  If the @samp{-@var{options}}
6943 form is used, @var{options} is a list of @samp{-} separated options
6944 which control the details of the dump.  Not all options are applicable
6945 to all dumps; those that are not meaningful are ignored.  The
6946 following options are available
6948 @table @samp
6949 @item address
6950 Print the address of each node.  Usually this is not meaningful as it
6951 changes according to the environment and source file.  Its primary use
6952 is for tying up a dump file with a debug environment.
6953 @item asmname
6954 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6955 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6956 use working backward from mangled names in the assembly file.
6957 @item slim
6958 When dumping front-end intermediate representations, inhibit dumping
6959 of members of a scope or body of a function merely because that scope
6960 has been reached.  Only dump such items when they are directly reachable
6961 by some other path.
6963 When dumping pretty-printed trees, this option inhibits dumping the
6964 bodies of control structures.
6966 When dumping RTL, print the RTL in slim (condensed) form instead of
6967 the default LISP-like representation.
6968 @item raw
6969 Print a raw representation of the tree.  By default, trees are
6970 pretty-printed into a C-like representation.
6971 @item details
6972 Enable more detailed dumps (not honored by every dump option). Also
6973 include information from the optimization passes.
6974 @item stats
6975 Enable dumping various statistics about the pass (not honored by every dump
6976 option).
6977 @item blocks
6978 Enable showing basic block boundaries (disabled in raw dumps).
6979 @item graph
6980 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6981 dump a representation of the control flow graph suitable for viewing with
6982 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6983 the file is pretty-printed as a subgraph, so that GraphViz can render them
6984 all in a single plot.
6986 This option currently only works for RTL dumps, and the RTL is always
6987 dumped in slim form.
6988 @item vops
6989 Enable showing virtual operands for every statement.
6990 @item lineno
6991 Enable showing line numbers for statements.
6992 @item uid
6993 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6994 @item verbose
6995 Enable showing the tree dump for each statement.
6996 @item eh
6997 Enable showing the EH region number holding each statement.
6998 @item scev
6999 Enable showing scalar evolution analysis details.
7000 @item optimized
7001 Enable showing optimization information (only available in certain
7002 passes).
7003 @item missed
7004 Enable showing missed optimization information (only available in certain
7005 passes).
7006 @item note
7007 Enable other detailed optimization information (only available in
7008 certain passes).
7009 @item =@var{filename}
7010 Instead of an auto named dump file, output into the given file
7011 name. The file names @file{stdout} and @file{stderr} are treated
7012 specially and are considered already open standard streams. For
7013 example,
7015 @smallexample
7016 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
7017      -fdump-tree-pre=stderr file.c
7018 @end smallexample
7020 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
7021 output on to @file{stderr}. If two conflicting dump filenames are
7022 given for the same pass, then the latter option overrides the earlier
7023 one.
7025 @item all
7026 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
7027 and @option{lineno}.
7029 @item optall
7030 Turn on all optimization options, i.e., @option{optimized},
7031 @option{missed}, and @option{note}.
7032 @end table
7034 The following tree dumps are possible:
7035 @table @samp
7037 @item original
7038 @opindex fdump-tree-original
7039 Dump before any tree based optimization, to @file{@var{file}.original}.
7041 @item optimized
7042 @opindex fdump-tree-optimized
7043 Dump after all tree based optimization, to @file{@var{file}.optimized}.
7045 @item gimple
7046 @opindex fdump-tree-gimple
7047 Dump each function before and after the gimplification pass to a file.  The
7048 file name is made by appending @file{.gimple} to the source file name.
7050 @item cfg
7051 @opindex fdump-tree-cfg
7052 Dump the control flow graph of each function to a file.  The file name is
7053 made by appending @file{.cfg} to the source file name.
7055 @item ch
7056 @opindex fdump-tree-ch
7057 Dump each function after copying loop headers.  The file name is made by
7058 appending @file{.ch} to the source file name.
7060 @item ssa
7061 @opindex fdump-tree-ssa
7062 Dump SSA related information to a file.  The file name is made by appending
7063 @file{.ssa} to the source file name.
7065 @item alias
7066 @opindex fdump-tree-alias
7067 Dump aliasing information for each function.  The file name is made by
7068 appending @file{.alias} to the source file name.
7070 @item ccp
7071 @opindex fdump-tree-ccp
7072 Dump each function after CCP@.  The file name is made by appending
7073 @file{.ccp} to the source file name.
7075 @item storeccp
7076 @opindex fdump-tree-storeccp
7077 Dump each function after STORE-CCP@.  The file name is made by appending
7078 @file{.storeccp} to the source file name.
7080 @item pre
7081 @opindex fdump-tree-pre
7082 Dump trees after partial redundancy elimination.  The file name is made
7083 by appending @file{.pre} to the source file name.
7085 @item fre
7086 @opindex fdump-tree-fre
7087 Dump trees after full redundancy elimination.  The file name is made
7088 by appending @file{.fre} to the source file name.
7090 @item copyprop
7091 @opindex fdump-tree-copyprop
7092 Dump trees after copy propagation.  The file name is made
7093 by appending @file{.copyprop} to the source file name.
7095 @item store_copyprop
7096 @opindex fdump-tree-store_copyprop
7097 Dump trees after store copy-propagation.  The file name is made
7098 by appending @file{.store_copyprop} to the source file name.
7100 @item dce
7101 @opindex fdump-tree-dce
7102 Dump each function after dead code elimination.  The file name is made by
7103 appending @file{.dce} to the source file name.
7105 @item sra
7106 @opindex fdump-tree-sra
7107 Dump each function after performing scalar replacement of aggregates.  The
7108 file name is made by appending @file{.sra} to the source file name.
7110 @item sink
7111 @opindex fdump-tree-sink
7112 Dump each function after performing code sinking.  The file name is made
7113 by appending @file{.sink} to the source file name.
7115 @item dom
7116 @opindex fdump-tree-dom
7117 Dump each function after applying dominator tree optimizations.  The file
7118 name is made by appending @file{.dom} to the source file name.
7120 @item dse
7121 @opindex fdump-tree-dse
7122 Dump each function after applying dead store elimination.  The file
7123 name is made by appending @file{.dse} to the source file name.
7125 @item phiopt
7126 @opindex fdump-tree-phiopt
7127 Dump each function after optimizing PHI nodes into straightline code.  The file
7128 name is made by appending @file{.phiopt} to the source file name.
7130 @item forwprop
7131 @opindex fdump-tree-forwprop
7132 Dump each function after forward propagating single use variables.  The file
7133 name is made by appending @file{.forwprop} to the source file name.
7135 @item nrv
7136 @opindex fdump-tree-nrv
7137 Dump each function after applying the named return value optimization on
7138 generic trees.  The file name is made by appending @file{.nrv} to the source
7139 file name.
7141 @item vect
7142 @opindex fdump-tree-vect
7143 Dump each function after applying vectorization of loops.  The file name is
7144 made by appending @file{.vect} to the source file name.
7146 @item slp
7147 @opindex fdump-tree-slp
7148 Dump each function after applying vectorization of basic blocks.  The file name
7149 is made by appending @file{.slp} to the source file name.
7151 @item vrp
7152 @opindex fdump-tree-vrp
7153 Dump each function after Value Range Propagation (VRP).  The file name
7154 is made by appending @file{.vrp} to the source file name.
7156 @item all
7157 @opindex fdump-tree-all
7158 Enable all the available tree dumps with the flags provided in this option.
7159 @end table
7161 @item -fopt-info
7162 @itemx -fopt-info-@var{options}
7163 @itemx -fopt-info-@var{options}=@var{filename}
7164 @opindex fopt-info
7165 Controls optimization dumps from various optimization passes. If the
7166 @samp{-@var{options}} form is used, @var{options} is a list of
7167 @samp{-} separated option keywords to select the dump details and
7168 optimizations.  
7170 The @var{options} can be divided into two groups: options describing the
7171 verbosity of the dump, and options describing which optimizations
7172 should be included. The options from both the groups can be freely
7173 mixed as they are non-overlapping. However, in case of any conflicts,
7174 the later options override the earlier options on the command
7175 line. 
7177 The following options control the dump verbosity:
7179 @table @samp
7180 @item optimized
7181 Print information when an optimization is successfully applied. It is
7182 up to a pass to decide which information is relevant. For example, the
7183 vectorizer passes print the source location of loops which are
7184 successfully vectorized.
7185 @item missed
7186 Print information about missed optimizations. Individual passes
7187 control which information to include in the output. 
7188 @item note
7189 Print verbose information about optimizations, such as certain
7190 transformations, more detailed messages about decisions etc.
7191 @item all
7192 Print detailed optimization information. This includes
7193 @samp{optimized}, @samp{missed}, and @samp{note}.
7194 @end table
7196 One or more of the following option keywords can be used to describe a
7197 group of optimizations:
7199 @table @samp
7200 @item ipa
7201 Enable dumps from all interprocedural optimizations.
7202 @item loop
7203 Enable dumps from all loop optimizations.
7204 @item inline
7205 Enable dumps from all inlining optimizations.
7206 @item vec
7207 Enable dumps from all vectorization optimizations.
7208 @item optall
7209 Enable dumps from all optimizations. This is a superset of
7210 the optimization groups listed above.
7211 @end table
7213 If @var{options} is
7214 omitted, it defaults to @samp{optimized-optall}, which means to dump all
7215 info about successful optimizations from all the passes.  
7217 If the @var{filename} is provided, then the dumps from all the
7218 applicable optimizations are concatenated into the @var{filename}.
7219 Otherwise the dump is output onto @file{stderr}. Though multiple
7220 @option{-fopt-info} options are accepted, only one of them can include
7221 a @var{filename}. If other filenames are provided then all but the
7222 first such option are ignored.
7224 Note that the output @var{filename} is overwritten
7225 in case of multiple translation units. If a combined output from
7226 multiple translation units is desired, @file{stderr} should be used
7227 instead.
7229 In the following example, the optimization info is output to
7230 @file{stderr}:
7232 @smallexample
7233 gcc -O3 -fopt-info
7234 @end smallexample
7236 This example:
7237 @smallexample
7238 gcc -O3 -fopt-info-missed=missed.all
7239 @end smallexample
7241 @noindent
7242 outputs missed optimization report from all the passes into
7243 @file{missed.all}, and this one:
7245 @smallexample
7246 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
7247 @end smallexample
7249 @noindent
7250 prints information about missed optimization opportunities from
7251 vectorization passes on @file{stderr}.  
7252 Note that @option{-fopt-info-vec-missed} is equivalent to 
7253 @option{-fopt-info-missed-vec}.
7255 As another example,
7256 @smallexample
7257 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
7258 @end smallexample
7260 @noindent
7261 outputs information about missed optimizations as well as
7262 optimized locations from all the inlining passes into
7263 @file{inline.txt}.
7265 Finally, consider:
7267 @smallexample
7268 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
7269 @end smallexample
7271 @noindent
7272 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
7273 in conflict since only one output file is allowed. In this case, only
7274 the first option takes effect and the subsequent options are
7275 ignored. Thus only @file{vec.miss} is produced which contains
7276 dumps from the vectorizer about missed opportunities.
7278 @item -frandom-seed=@var{number}
7279 @opindex frandom-seed
7280 This option provides a seed that GCC uses in place of
7281 random numbers in generating certain symbol names
7282 that have to be different in every compiled file.  It is also used to
7283 place unique stamps in coverage data files and the object files that
7284 produce them.  You can use the @option{-frandom-seed} option to produce
7285 reproducibly identical object files.
7287 The @var{number} should be different for every file you compile.
7289 @item -fsched-verbose=@var{n}
7290 @opindex fsched-verbose
7291 On targets that use instruction scheduling, this option controls the
7292 amount of debugging output the scheduler prints.  This information is
7293 written to standard error, unless @option{-fdump-rtl-sched1} or
7294 @option{-fdump-rtl-sched2} is specified, in which case it is output
7295 to the usual dump listing file, @file{.sched1} or @file{.sched2}
7296 respectively.  However for @var{n} greater than nine, the output is
7297 always printed to standard error.
7299 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
7300 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
7301 For @var{n} greater than one, it also output basic block probabilities,
7302 detailed ready list information and unit/insn info.  For @var{n} greater
7303 than two, it includes RTL at abort point, control-flow and regions info.
7304 And for @var{n} over four, @option{-fsched-verbose} also includes
7305 dependence info.
7307 @item -save-temps
7308 @itemx -save-temps=cwd
7309 @opindex save-temps
7310 Store the usual ``temporary'' intermediate files permanently; place them
7311 in the current directory and name them based on the source file.  Thus,
7312 compiling @file{foo.c} with @option{-c -save-temps} produces files
7313 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
7314 preprocessed @file{foo.i} output file even though the compiler now
7315 normally uses an integrated preprocessor.
7317 When used in combination with the @option{-x} command-line option,
7318 @option{-save-temps} is sensible enough to avoid over writing an
7319 input source file with the same extension as an intermediate file.
7320 The corresponding intermediate file may be obtained by renaming the
7321 source file before using @option{-save-temps}.
7323 If you invoke GCC in parallel, compiling several different source
7324 files that share a common base name in different subdirectories or the
7325 same source file compiled for multiple output destinations, it is
7326 likely that the different parallel compilers will interfere with each
7327 other, and overwrite the temporary files.  For instance:
7329 @smallexample
7330 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
7331 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
7332 @end smallexample
7334 may result in @file{foo.i} and @file{foo.o} being written to
7335 simultaneously by both compilers.
7337 @item -save-temps=obj
7338 @opindex save-temps=obj
7339 Store the usual ``temporary'' intermediate files permanently.  If the
7340 @option{-o} option is used, the temporary files are based on the
7341 object file.  If the @option{-o} option is not used, the
7342 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
7344 For example:
7346 @smallexample
7347 gcc -save-temps=obj -c foo.c
7348 gcc -save-temps=obj -c bar.c -o dir/xbar.o
7349 gcc -save-temps=obj foobar.c -o dir2/yfoobar
7350 @end smallexample
7352 @noindent
7353 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
7354 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
7355 @file{dir2/yfoobar.o}.
7357 @item -time@r{[}=@var{file}@r{]}
7358 @opindex time
7359 Report the CPU time taken by each subprocess in the compilation
7360 sequence.  For C source files, this is the compiler proper and assembler
7361 (plus the linker if linking is done).
7363 Without the specification of an output file, the output looks like this:
7365 @smallexample
7366 # cc1 0.12 0.01
7367 # as 0.00 0.01
7368 @end smallexample
7370 The first number on each line is the ``user time'', that is time spent
7371 executing the program itself.  The second number is ``system time'',
7372 time spent executing operating system routines on behalf of the program.
7373 Both numbers are in seconds.
7375 With the specification of an output file, the output is appended to the
7376 named file, and it looks like this:
7378 @smallexample
7379 0.12 0.01 cc1 @var{options}
7380 0.00 0.01 as @var{options}
7381 @end smallexample
7383 The ``user time'' and the ``system time'' are moved before the program
7384 name, and the options passed to the program are displayed, so that one
7385 can later tell what file was being compiled, and with which options.
7387 @item -fvar-tracking
7388 @opindex fvar-tracking
7389 Run variable tracking pass.  It computes where variables are stored at each
7390 position in code.  Better debugging information is then generated
7391 (if the debugging information format supports this information).
7393 It is enabled by default when compiling with optimization (@option{-Os},
7394 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7395 the debug info format supports it.
7397 @item -fvar-tracking-assignments
7398 @opindex fvar-tracking-assignments
7399 @opindex fno-var-tracking-assignments
7400 Annotate assignments to user variables early in the compilation and
7401 attempt to carry the annotations over throughout the compilation all the
7402 way to the end, in an attempt to improve debug information while
7403 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7405 It can be enabled even if var-tracking is disabled, in which case
7406 annotations are created and maintained, but discarded at the end.
7407 By default, this flag is enabled together with @option{-fvar-tracking},
7408 except when selective scheduling is enabled.
7410 @item -fvar-tracking-assignments-toggle
7411 @opindex fvar-tracking-assignments-toggle
7412 @opindex fno-var-tracking-assignments-toggle
7413 Toggle @option{-fvar-tracking-assignments}, in the same way that
7414 @option{-gtoggle} toggles @option{-g}.
7416 @item -print-file-name=@var{library}
7417 @opindex print-file-name
7418 Print the full absolute name of the library file @var{library} that
7419 would be used when linking---and don't do anything else.  With this
7420 option, GCC does not compile or link anything; it just prints the
7421 file name.
7423 @item -print-multi-directory
7424 @opindex print-multi-directory
7425 Print the directory name corresponding to the multilib selected by any
7426 other switches present in the command line.  This directory is supposed
7427 to exist in @env{GCC_EXEC_PREFIX}.
7429 @item -print-multi-lib
7430 @opindex print-multi-lib
7431 Print the mapping from multilib directory names to compiler switches
7432 that enable them.  The directory name is separated from the switches by
7433 @samp{;}, and each switch starts with an @samp{@@} instead of the
7434 @samp{-}, without spaces between multiple switches.  This is supposed to
7435 ease shell processing.
7437 @item -print-multi-os-directory
7438 @opindex print-multi-os-directory
7439 Print the path to OS libraries for the selected
7440 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7441 present in the @file{lib} subdirectory and no multilibs are used, this is
7442 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7443 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7444 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7445 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7447 @item -print-multiarch
7448 @opindex print-multiarch
7449 Print the path to OS libraries for the selected multiarch,
7450 relative to some @file{lib} subdirectory.
7452 @item -print-prog-name=@var{program}
7453 @opindex print-prog-name
7454 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
7456 @item -print-libgcc-file-name
7457 @opindex print-libgcc-file-name
7458 Same as @option{-print-file-name=libgcc.a}.
7460 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7461 but you do want to link with @file{libgcc.a}.  You can do:
7463 @smallexample
7464 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7465 @end smallexample
7467 @item -print-search-dirs
7468 @opindex print-search-dirs
7469 Print the name of the configured installation directory and a list of
7470 program and library directories @command{gcc} searches---and don't do anything else.
7472 This is useful when @command{gcc} prints the error message
7473 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7474 To resolve this you either need to put @file{cpp0} and the other compiler
7475 components where @command{gcc} expects to find them, or you can set the environment
7476 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7477 Don't forget the trailing @samp{/}.
7478 @xref{Environment Variables}.
7480 @item -print-sysroot
7481 @opindex print-sysroot
7482 Print the target sysroot directory that is used during
7483 compilation.  This is the target sysroot specified either at configure
7484 time or using the @option{--sysroot} option, possibly with an extra
7485 suffix that depends on compilation options.  If no target sysroot is
7486 specified, the option prints nothing.
7488 @item -print-sysroot-headers-suffix
7489 @opindex print-sysroot-headers-suffix
7490 Print the suffix added to the target sysroot when searching for
7491 headers, or give an error if the compiler is not configured with such
7492 a suffix---and don't do anything else.
7494 @item -dumpmachine
7495 @opindex dumpmachine
7496 Print the compiler's target machine (for example,
7497 @samp{i686-pc-linux-gnu})---and don't do anything else.
7499 @item -dumpversion
7500 @opindex dumpversion
7501 Print the compiler version (for example, @code{3.0})---and don't do
7502 anything else.
7504 @item -dumpspecs
7505 @opindex dumpspecs
7506 Print the compiler's built-in specs---and don't do anything else.  (This
7507 is used when GCC itself is being built.)  @xref{Spec Files}.
7509 @item -fno-eliminate-unused-debug-types
7510 @opindex feliminate-unused-debug-types
7511 @opindex fno-eliminate-unused-debug-types
7512 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7513 output for types that are nowhere used in the source file being compiled.
7514 Sometimes it is useful to have GCC emit debugging
7515 information for all types declared in a compilation
7516 unit, regardless of whether or not they are actually used
7517 in that compilation unit, for example 
7518 if, in the debugger, you want to cast a value to a type that is
7519 not actually used in your program (but is declared).  More often,
7520 however, this results in a significant amount of wasted space.
7521 @end table
7523 @node Optimize Options
7524 @section Options That Control Optimization
7525 @cindex optimize options
7526 @cindex options, optimization
7528 These options control various sorts of optimizations.
7530 Without any optimization option, the compiler's goal is to reduce the
7531 cost of compilation and to make debugging produce the expected
7532 results.  Statements are independent: if you stop the program with a
7533 breakpoint between statements, you can then assign a new value to any
7534 variable or change the program counter to any other statement in the
7535 function and get exactly the results you expect from the source
7536 code.
7538 Turning on optimization flags makes the compiler attempt to improve
7539 the performance and/or code size at the expense of compilation time
7540 and possibly the ability to debug the program.
7542 The compiler performs optimization based on the knowledge it has of the
7543 program.  Compiling multiple files at once to a single output file mode allows
7544 the compiler to use information gained from all of the files when compiling
7545 each of them.
7547 Not all optimizations are controlled directly by a flag.  Only
7548 optimizations that have a flag are listed in this section.
7550 Most optimizations are only enabled if an @option{-O} level is set on
7551 the command line.  Otherwise they are disabled, even if individual
7552 optimization flags are specified.
7554 Depending on the target and how GCC was configured, a slightly different
7555 set of optimizations may be enabled at each @option{-O} level than
7556 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7557 to find out the exact set of optimizations that are enabled at each level.
7558 @xref{Overall Options}, for examples.
7560 @table @gcctabopt
7561 @item -O
7562 @itemx -O1
7563 @opindex O
7564 @opindex O1
7565 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7566 more memory for a large function.
7568 With @option{-O}, the compiler tries to reduce code size and execution
7569 time, without performing any optimizations that take a great deal of
7570 compilation time.
7572 @option{-O} turns on the following optimization flags:
7573 @gccoptlist{
7574 -fauto-inc-dec @gol
7575 -fbranch-count-reg @gol
7576 -fcombine-stack-adjustments @gol
7577 -fcompare-elim @gol
7578 -fcprop-registers @gol
7579 -fdce @gol
7580 -fdefer-pop @gol
7581 -fdelayed-branch @gol
7582 -fdse @gol
7583 -fforward-propagate @gol
7584 -fguess-branch-probability @gol
7585 -fif-conversion2 @gol
7586 -fif-conversion @gol
7587 -finline-functions-called-once @gol
7588 -fipa-pure-const @gol
7589 -fipa-profile @gol
7590 -fipa-reference @gol
7591 -fmerge-constants @gol
7592 -fmove-loop-invariants @gol
7593 -fshrink-wrap @gol
7594 -fsplit-wide-types @gol
7595 -ftree-bit-ccp @gol
7596 -ftree-ccp @gol
7597 -fssa-phiopt @gol
7598 -ftree-ch @gol
7599 -ftree-coalesce-vars @gol
7600 -ftree-copy-prop @gol
7601 -ftree-dce @gol
7602 -ftree-dominator-opts @gol
7603 -ftree-dse @gol
7604 -ftree-forwprop @gol
7605 -ftree-fre @gol
7606 -ftree-phiprop @gol
7607 -ftree-sink @gol
7608 -ftree-slsr @gol
7609 -ftree-sra @gol
7610 -ftree-pta @gol
7611 -ftree-ter @gol
7612 -funit-at-a-time}
7614 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7615 where doing so does not interfere with debugging.
7617 @item -O2
7618 @opindex O2
7619 Optimize even more.  GCC performs nearly all supported optimizations
7620 that do not involve a space-speed tradeoff.
7621 As compared to @option{-O}, this option increases both compilation time
7622 and the performance of the generated code.
7624 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7625 also turns on the following optimization flags:
7626 @gccoptlist{-fthread-jumps @gol
7627 -falign-functions  -falign-jumps @gol
7628 -falign-loops  -falign-labels @gol
7629 -fcaller-saves @gol
7630 -fcrossjumping @gol
7631 -fcse-follow-jumps  -fcse-skip-blocks @gol
7632 -fdelete-null-pointer-checks @gol
7633 -fdevirtualize -fdevirtualize-speculatively @gol
7634 -fexpensive-optimizations @gol
7635 -fgcse  -fgcse-lm  @gol
7636 -fhoist-adjacent-loads @gol
7637 -finline-small-functions @gol
7638 -findirect-inlining @gol
7639 -fipa-cp @gol
7640 -fipa-cp-alignment @gol
7641 -fipa-sra @gol
7642 -fipa-icf @gol
7643 -fisolate-erroneous-paths-dereference @gol
7644 -flra-remat @gol
7645 -foptimize-sibling-calls @gol
7646 -foptimize-strlen @gol
7647 -fpartial-inlining @gol
7648 -fpeephole2 @gol
7649 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7650 -frerun-cse-after-loop  @gol
7651 -fsched-interblock  -fsched-spec @gol
7652 -fschedule-insns  -fschedule-insns2 @gol
7653 -fstrict-aliasing -fstrict-overflow @gol
7654 -ftree-builtin-call-dce @gol
7655 -ftree-switch-conversion -ftree-tail-merge @gol
7656 -ftree-pre @gol
7657 -ftree-vrp @gol
7658 -fipa-ra}
7660 Please note the warning under @option{-fgcse} about
7661 invoking @option{-O2} on programs that use computed gotos.
7663 @item -O3
7664 @opindex O3
7665 Optimize yet more.  @option{-O3} turns on all optimizations specified
7666 by @option{-O2} and also turns on the @option{-finline-functions},
7667 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7668 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7669 @option{-ftree-loop-distribute-patterns},
7670 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7671 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7673 @item -O0
7674 @opindex O0
7675 Reduce compilation time and make debugging produce the expected
7676 results.  This is the default.
7678 @item -Os
7679 @opindex Os
7680 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7681 do not typically increase code size.  It also performs further
7682 optimizations designed to reduce code size.
7684 @option{-Os} disables the following optimization flags:
7685 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7686 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7687 -fprefetch-loop-arrays}
7689 @item -Ofast
7690 @opindex Ofast
7691 Disregard strict standards compliance.  @option{-Ofast} enables all
7692 @option{-O3} optimizations.  It also enables optimizations that are not
7693 valid for all standard-compliant programs.
7694 It turns on @option{-ffast-math} and the Fortran-specific
7695 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7697 @item -Og
7698 @opindex Og
7699 Optimize debugging experience.  @option{-Og} enables optimizations
7700 that do not interfere with debugging. It should be the optimization
7701 level of choice for the standard edit-compile-debug cycle, offering
7702 a reasonable level of optimization while maintaining fast compilation
7703 and a good debugging experience.
7705 If you use multiple @option{-O} options, with or without level numbers,
7706 the last such option is the one that is effective.
7707 @end table
7709 Options of the form @option{-f@var{flag}} specify machine-independent
7710 flags.  Most flags have both positive and negative forms; the negative
7711 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7712 below, only one of the forms is listed---the one you typically 
7713 use.  You can figure out the other form by either removing @samp{no-}
7714 or adding it.
7716 The following options control specific optimizations.  They are either
7717 activated by @option{-O} options or are related to ones that are.  You
7718 can use the following flags in the rare cases when ``fine-tuning'' of
7719 optimizations to be performed is desired.
7721 @table @gcctabopt
7722 @item -fno-defer-pop
7723 @opindex fno-defer-pop
7724 Always pop the arguments to each function call as soon as that function
7725 returns.  For machines that must pop arguments after a function call,
7726 the compiler normally lets arguments accumulate on the stack for several
7727 function calls and pops them all at once.
7729 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7731 @item -fforward-propagate
7732 @opindex fforward-propagate
7733 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7734 instructions and checks if the result can be simplified.  If loop unrolling
7735 is active, two passes are performed and the second is scheduled after
7736 loop unrolling.
7738 This option is enabled by default at optimization levels @option{-O},
7739 @option{-O2}, @option{-O3}, @option{-Os}.
7741 @item -ffp-contract=@var{style}
7742 @opindex ffp-contract
7743 @option{-ffp-contract=off} disables floating-point expression contraction.
7744 @option{-ffp-contract=fast} enables floating-point expression contraction
7745 such as forming of fused multiply-add operations if the target has
7746 native support for them.
7747 @option{-ffp-contract=on} enables floating-point expression contraction
7748 if allowed by the language standard.  This is currently not implemented
7749 and treated equal to @option{-ffp-contract=off}.
7751 The default is @option{-ffp-contract=fast}.
7753 @item -fomit-frame-pointer
7754 @opindex fomit-frame-pointer
7755 Don't keep the frame pointer in a register for functions that
7756 don't need one.  This avoids the instructions to save, set up and
7757 restore frame pointers; it also makes an extra register available
7758 in many functions.  @strong{It also makes debugging impossible on
7759 some machines.}
7761 On some machines, such as the VAX, this flag has no effect, because
7762 the standard calling sequence automatically handles the frame pointer
7763 and nothing is saved by pretending it doesn't exist.  The
7764 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7765 whether a target machine supports this flag.  @xref{Registers,,Register
7766 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7768 The default setting (when not optimizing for
7769 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7770 @option{-fomit-frame-pointer}.  You can configure GCC with the
7771 @option{--enable-frame-pointer} configure option to change the default.
7773 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7775 @item -foptimize-sibling-calls
7776 @opindex foptimize-sibling-calls
7777 Optimize sibling and tail recursive calls.
7779 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7781 @item -foptimize-strlen
7782 @opindex foptimize-strlen
7783 Optimize various standard C string functions (e.g. @code{strlen},
7784 @code{strchr} or @code{strcpy}) and
7785 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7787 Enabled at levels @option{-O2}, @option{-O3}.
7789 @item -fno-inline
7790 @opindex fno-inline
7791 Do not expand any functions inline apart from those marked with
7792 the @code{always_inline} attribute.  This is the default when not
7793 optimizing.
7795 Single functions can be exempted from inlining by marking them
7796 with the @code{noinline} attribute.
7798 @item -finline-small-functions
7799 @opindex finline-small-functions
7800 Integrate functions into their callers when their body is smaller than expected
7801 function call code (so overall size of program gets smaller).  The compiler
7802 heuristically decides which functions are simple enough to be worth integrating
7803 in this way.  This inlining applies to all functions, even those not declared
7804 inline.
7806 Enabled at level @option{-O2}.
7808 @item -findirect-inlining
7809 @opindex findirect-inlining
7810 Inline also indirect calls that are discovered to be known at compile
7811 time thanks to previous inlining.  This option has any effect only
7812 when inlining itself is turned on by the @option{-finline-functions}
7813 or @option{-finline-small-functions} options.
7815 Enabled at level @option{-O2}.
7817 @item -finline-functions
7818 @opindex finline-functions
7819 Consider all functions for inlining, even if they are not declared inline.
7820 The compiler heuristically decides which functions are worth integrating
7821 in this way.
7823 If all calls to a given function are integrated, and the function is
7824 declared @code{static}, then the function is normally not output as
7825 assembler code in its own right.
7827 Enabled at level @option{-O3}.
7829 @item -finline-functions-called-once
7830 @opindex finline-functions-called-once
7831 Consider all @code{static} functions called once for inlining into their
7832 caller even if they are not marked @code{inline}.  If a call to a given
7833 function is integrated, then the function is not output as assembler code
7834 in its own right.
7836 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7838 @item -fearly-inlining
7839 @opindex fearly-inlining
7840 Inline functions marked by @code{always_inline} and functions whose body seems
7841 smaller than the function call overhead early before doing
7842 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7843 makes profiling significantly cheaper and usually inlining faster on programs
7844 having large chains of nested wrapper functions.
7846 Enabled by default.
7848 @item -fipa-sra
7849 @opindex fipa-sra
7850 Perform interprocedural scalar replacement of aggregates, removal of
7851 unused parameters and replacement of parameters passed by reference
7852 by parameters passed by value.
7854 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7856 @item -finline-limit=@var{n}
7857 @opindex finline-limit
7858 By default, GCC limits the size of functions that can be inlined.  This flag
7859 allows coarse control of this limit.  @var{n} is the size of functions that
7860 can be inlined in number of pseudo instructions.
7862 Inlining is actually controlled by a number of parameters, which may be
7863 specified individually by using @option{--param @var{name}=@var{value}}.
7864 The @option{-finline-limit=@var{n}} option sets some of these parameters
7865 as follows:
7867 @table @gcctabopt
7868 @item max-inline-insns-single
7869 is set to @var{n}/2.
7870 @item max-inline-insns-auto
7871 is set to @var{n}/2.
7872 @end table
7874 See below for a documentation of the individual
7875 parameters controlling inlining and for the defaults of these parameters.
7877 @emph{Note:} there may be no value to @option{-finline-limit} that results
7878 in default behavior.
7880 @emph{Note:} pseudo instruction represents, in this particular context, an
7881 abstract measurement of function's size.  In no way does it represent a count
7882 of assembly instructions and as such its exact meaning might change from one
7883 release to an another.
7885 @item -fno-keep-inline-dllexport
7886 @opindex fno-keep-inline-dllexport
7887 This is a more fine-grained version of @option{-fkeep-inline-functions},
7888 which applies only to functions that are declared using the @code{dllexport}
7889 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7890 Functions}.)
7892 @item -fkeep-inline-functions
7893 @opindex fkeep-inline-functions
7894 In C, emit @code{static} functions that are declared @code{inline}
7895 into the object file, even if the function has been inlined into all
7896 of its callers.  This switch does not affect functions using the
7897 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7898 inline functions into the object file.
7900 @item -fkeep-static-consts
7901 @opindex fkeep-static-consts
7902 Emit variables declared @code{static const} when optimization isn't turned
7903 on, even if the variables aren't referenced.
7905 GCC enables this option by default.  If you want to force the compiler to
7906 check if a variable is referenced, regardless of whether or not
7907 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7909 @item -fmerge-constants
7910 @opindex fmerge-constants
7911 Attempt to merge identical constants (string constants and floating-point
7912 constants) across compilation units.
7914 This option is the default for optimized compilation if the assembler and
7915 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7916 behavior.
7918 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7920 @item -fmerge-all-constants
7921 @opindex fmerge-all-constants
7922 Attempt to merge identical constants and identical variables.
7924 This option implies @option{-fmerge-constants}.  In addition to
7925 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7926 arrays or initialized constant variables with integral or floating-point
7927 types.  Languages like C or C++ require each variable, including multiple
7928 instances of the same variable in recursive calls, to have distinct locations,
7929 so using this option results in non-conforming
7930 behavior.
7932 @item -fmodulo-sched
7933 @opindex fmodulo-sched
7934 Perform swing modulo scheduling immediately before the first scheduling
7935 pass.  This pass looks at innermost loops and reorders their
7936 instructions by overlapping different iterations.
7938 @item -fmodulo-sched-allow-regmoves
7939 @opindex fmodulo-sched-allow-regmoves
7940 Perform more aggressive SMS-based modulo scheduling with register moves
7941 allowed.  By setting this flag certain anti-dependences edges are
7942 deleted, which triggers the generation of reg-moves based on the
7943 life-range analysis.  This option is effective only with
7944 @option{-fmodulo-sched} enabled.
7946 @item -fno-branch-count-reg
7947 @opindex fno-branch-count-reg
7948 Do not use ``decrement and branch'' instructions on a count register,
7949 but instead generate a sequence of instructions that decrement a
7950 register, compare it against zero, then branch based upon the result.
7951 This option is only meaningful on architectures that support such
7952 instructions, which include x86, PowerPC, IA-64 and S/390.
7954 Enabled by default at @option{-O1} and higher.
7956 The default is @option{-fbranch-count-reg}.
7958 @item -fno-function-cse
7959 @opindex fno-function-cse
7960 Do not put function addresses in registers; make each instruction that
7961 calls a constant function contain the function's address explicitly.
7963 This option results in less efficient code, but some strange hacks
7964 that alter the assembler output may be confused by the optimizations
7965 performed when this option is not used.
7967 The default is @option{-ffunction-cse}
7969 @item -fno-zero-initialized-in-bss
7970 @opindex fno-zero-initialized-in-bss
7971 If the target supports a BSS section, GCC by default puts variables that
7972 are initialized to zero into BSS@.  This can save space in the resulting
7973 code.
7975 This option turns off this behavior because some programs explicitly
7976 rely on variables going to the data section---e.g., so that the
7977 resulting executable can find the beginning of that section and/or make
7978 assumptions based on that.
7980 The default is @option{-fzero-initialized-in-bss}.
7982 @item -fthread-jumps
7983 @opindex fthread-jumps
7984 Perform optimizations that check to see if a jump branches to a
7985 location where another comparison subsumed by the first is found.  If
7986 so, the first branch is redirected to either the destination of the
7987 second branch or a point immediately following it, depending on whether
7988 the condition is known to be true or false.
7990 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7992 @item -fsplit-wide-types
7993 @opindex fsplit-wide-types
7994 When using a type that occupies multiple registers, such as @code{long
7995 long} on a 32-bit system, split the registers apart and allocate them
7996 independently.  This normally generates better code for those types,
7997 but may make debugging more difficult.
7999 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
8000 @option{-Os}.
8002 @item -fcse-follow-jumps
8003 @opindex fcse-follow-jumps
8004 In common subexpression elimination (CSE), scan through jump instructions
8005 when the target of the jump is not reached by any other path.  For
8006 example, when CSE encounters an @code{if} statement with an
8007 @code{else} clause, CSE follows the jump when the condition
8008 tested is false.
8010 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8012 @item -fcse-skip-blocks
8013 @opindex fcse-skip-blocks
8014 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8015 follow jumps that conditionally skip over blocks.  When CSE
8016 encounters a simple @code{if} statement with no else clause,
8017 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8018 body of the @code{if}.
8020 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8022 @item -frerun-cse-after-loop
8023 @opindex frerun-cse-after-loop
8024 Re-run common subexpression elimination after loop optimizations are
8025 performed.
8027 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8029 @item -fgcse
8030 @opindex fgcse
8031 Perform a global common subexpression elimination pass.
8032 This pass also performs global constant and copy propagation.
8034 @emph{Note:} When compiling a program using computed gotos, a GCC
8035 extension, you may get better run-time performance if you disable
8036 the global common subexpression elimination pass by adding
8037 @option{-fno-gcse} to the command line.
8039 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8041 @item -fgcse-lm
8042 @opindex fgcse-lm
8043 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8044 attempts to move loads that are only killed by stores into themselves.  This
8045 allows a loop containing a load/store sequence to be changed to a load outside
8046 the loop, and a copy/store within the loop.
8048 Enabled by default when @option{-fgcse} is enabled.
8050 @item -fgcse-sm
8051 @opindex fgcse-sm
8052 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8053 global common subexpression elimination.  This pass attempts to move
8054 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8055 loops containing a load/store sequence can be changed to a load before
8056 the loop and a store after the loop.
8058 Not enabled at any optimization level.
8060 @item -fgcse-las
8061 @opindex fgcse-las
8062 When @option{-fgcse-las} is enabled, the global common subexpression
8063 elimination pass eliminates redundant loads that come after stores to the
8064 same memory location (both partial and full redundancies).
8066 Not enabled at any optimization level.
8068 @item -fgcse-after-reload
8069 @opindex fgcse-after-reload
8070 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8071 pass is performed after reload.  The purpose of this pass is to clean up
8072 redundant spilling.
8074 @item -faggressive-loop-optimizations
8075 @opindex faggressive-loop-optimizations
8076 This option tells the loop optimizer to use language constraints to
8077 derive bounds for the number of iterations of a loop.  This assumes that
8078 loop code does not invoke undefined behavior by for example causing signed
8079 integer overflows or out-of-bound array accesses.  The bounds for the
8080 number of iterations of a loop are used to guide loop unrolling and peeling
8081 and loop exit test optimizations.
8082 This option is enabled by default.
8084 @item -funsafe-loop-optimizations
8085 @opindex funsafe-loop-optimizations
8086 This option tells the loop optimizer to assume that loop indices do not
8087 overflow, and that loops with nontrivial exit condition are not
8088 infinite.  This enables a wider range of loop optimizations even if
8089 the loop optimizer itself cannot prove that these assumptions are valid.
8090 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
8091 if it finds this kind of loop.
8093 @item -fcrossjumping
8094 @opindex fcrossjumping
8095 Perform cross-jumping transformation.
8096 This transformation unifies equivalent code and saves code size.  The
8097 resulting code may or may not perform better than without cross-jumping.
8099 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8101 @item -fauto-inc-dec
8102 @opindex fauto-inc-dec
8103 Combine increments or decrements of addresses with memory accesses.
8104 This pass is always skipped on architectures that do not have
8105 instructions to support this.  Enabled by default at @option{-O} and
8106 higher on architectures that support this.
8108 @item -fdce
8109 @opindex fdce
8110 Perform dead code elimination (DCE) on RTL@.
8111 Enabled by default at @option{-O} and higher.
8113 @item -fdse
8114 @opindex fdse
8115 Perform dead store elimination (DSE) on RTL@.
8116 Enabled by default at @option{-O} and higher.
8118 @item -fif-conversion
8119 @opindex fif-conversion
8120 Attempt to transform conditional jumps into branch-less equivalents.  This
8121 includes use of conditional moves, min, max, set flags and abs instructions, and
8122 some tricks doable by standard arithmetics.  The use of conditional execution
8123 on chips where it is available is controlled by @option{-fif-conversion2}.
8125 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8127 @item -fif-conversion2
8128 @opindex fif-conversion2
8129 Use conditional execution (where available) to transform conditional jumps into
8130 branch-less equivalents.
8132 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8134 @item -fdeclone-ctor-dtor
8135 @opindex fdeclone-ctor-dtor
8136 The C++ ABI requires multiple entry points for constructors and
8137 destructors: one for a base subobject, one for a complete object, and
8138 one for a virtual destructor that calls operator delete afterwards.
8139 For a hierarchy with virtual bases, the base and complete variants are
8140 clones, which means two copies of the function.  With this option, the
8141 base and complete variants are changed to be thunks that call a common
8142 implementation.
8144 Enabled by @option{-Os}.
8146 @item -fdelete-null-pointer-checks
8147 @opindex fdelete-null-pointer-checks
8148 Assume that programs cannot safely dereference null pointers, and that
8149 no code or data element resides at address zero.
8150 This option enables simple constant
8151 folding optimizations at all optimization levels.  In addition, other
8152 optimization passes in GCC use this flag to control global dataflow
8153 analyses that eliminate useless checks for null pointers; these assume
8154 that a memory access to address zero always results in a trap, so
8155 that if a pointer is checked after it has already been dereferenced,
8156 it cannot be null.
8158 Note however that in some environments this assumption is not true.
8159 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8160 for programs that depend on that behavior.
8162 This option is enabled by default on most targets.  On Nios II ELF, it
8163 defaults to off.  On AVR and CR16, this option is completely disabled.  
8165 Passes that use the dataflow information
8166 are enabled independently at different optimization levels.
8168 @item -fdevirtualize
8169 @opindex fdevirtualize
8170 Attempt to convert calls to virtual functions to direct calls.  This
8171 is done both within a procedure and interprocedurally as part of
8172 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8173 propagation (@option{-fipa-cp}).
8174 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8176 @item -fdevirtualize-speculatively
8177 @opindex fdevirtualize-speculatively
8178 Attempt to convert calls to virtual functions to speculative direct calls.
8179 Based on the analysis of the type inheritance graph, determine for a given call
8180 the set of likely targets. If the set is small, preferably of size 1, change
8181 the call into a conditional deciding between direct and indirect calls.  The
8182 speculative calls enable more optimizations, such as inlining.  When they seem
8183 useless after further optimization, they are converted back into original form.
8185 @item -fdevirtualize-at-ltrans
8186 @opindex fdevirtualize-at-ltrans
8187 Stream extra information needed for aggressive devirtualization when running
8188 the link-time optimizer in local transformation mode.  
8189 This option enables more devirtualization but
8190 significantly increases the size of streamed data. For this reason it is
8191 disabled by default.
8193 @item -fexpensive-optimizations
8194 @opindex fexpensive-optimizations
8195 Perform a number of minor optimizations that are relatively expensive.
8197 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8199 @item -free
8200 @opindex free
8201 Attempt to remove redundant extension instructions.  This is especially
8202 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8203 registers after writing to their lower 32-bit half.
8205 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8206 @option{-O3}, @option{-Os}.
8208 @item -fno-lifetime-dse
8209 @opindex fno-lifetime-dse
8210 In C++ the value of an object is only affected by changes within its
8211 lifetime: when the constructor begins, the object has an indeterminate
8212 value, and any changes during the lifetime of the object are dead when
8213 the object is destroyed.  Normally dead store elimination will take
8214 advantage of this; if your code relies on the value of the object
8215 storage persisting beyond the lifetime of the object, you can use this
8216 flag to disable this optimization.
8218 @item -flive-range-shrinkage
8219 @opindex flive-range-shrinkage
8220 Attempt to decrease register pressure through register live range
8221 shrinkage.  This is helpful for fast processors with small or moderate
8222 size register sets.
8224 @item -fira-algorithm=@var{algorithm}
8225 @opindex fira-algorithm
8226 Use the specified coloring algorithm for the integrated register
8227 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8228 specifies Chow's priority coloring, or @samp{CB}, which specifies
8229 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8230 for all architectures, but for those targets that do support it, it is
8231 the default because it generates better code.
8233 @item -fira-region=@var{region}
8234 @opindex fira-region
8235 Use specified regions for the integrated register allocator.  The
8236 @var{region} argument should be one of the following:
8238 @table @samp
8240 @item all
8241 Use all loops as register allocation regions.
8242 This can give the best results for machines with a small and/or
8243 irregular register set.
8245 @item mixed
8246 Use all loops except for loops with small register pressure 
8247 as the regions.  This value usually gives
8248 the best results in most cases and for most architectures,
8249 and is enabled by default when compiling with optimization for speed
8250 (@option{-O}, @option{-O2}, @dots{}).
8252 @item one
8253 Use all functions as a single region.  
8254 This typically results in the smallest code size, and is enabled by default for
8255 @option{-Os} or @option{-O0}.
8257 @end table
8259 @item -fira-hoist-pressure
8260 @opindex fira-hoist-pressure
8261 Use IRA to evaluate register pressure in the code hoisting pass for
8262 decisions to hoist expressions.  This option usually results in smaller
8263 code, but it can slow the compiler down.
8265 This option is enabled at level @option{-Os} for all targets.
8267 @item -fira-loop-pressure
8268 @opindex fira-loop-pressure
8269 Use IRA to evaluate register pressure in loops for decisions to move
8270 loop invariants.  This option usually results in generation
8271 of faster and smaller code on machines with large register files (>= 32
8272 registers), but it can slow the compiler down.
8274 This option is enabled at level @option{-O3} for some targets.
8276 @item -fno-ira-share-save-slots
8277 @opindex fno-ira-share-save-slots
8278 Disable sharing of stack slots used for saving call-used hard
8279 registers living through a call.  Each hard register gets a
8280 separate stack slot, and as a result function stack frames are
8281 larger.
8283 @item -fno-ira-share-spill-slots
8284 @opindex fno-ira-share-spill-slots
8285 Disable sharing of stack slots allocated for pseudo-registers.  Each
8286 pseudo-register that does not get a hard register gets a separate
8287 stack slot, and as a result function stack frames are larger.
8289 @item -fira-verbose=@var{n}
8290 @opindex fira-verbose
8291 Control the verbosity of the dump file for the integrated register allocator.
8292 The default value is 5.  If the value @var{n} is greater or equal to 10,
8293 the dump output is sent to stderr using the same format as @var{n} minus 10.
8295 @item -flra-remat
8296 @opindex flra-remat
8297 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8298 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8299 values if it is profitable.
8301 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8303 @item -fdelayed-branch
8304 @opindex fdelayed-branch
8305 If supported for the target machine, attempt to reorder instructions
8306 to exploit instruction slots available after delayed branch
8307 instructions.
8309 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8311 @item -fschedule-insns
8312 @opindex fschedule-insns
8313 If supported for the target machine, attempt to reorder instructions to
8314 eliminate execution stalls due to required data being unavailable.  This
8315 helps machines that have slow floating point or memory load instructions
8316 by allowing other instructions to be issued until the result of the load
8317 or floating-point instruction is required.
8319 Enabled at levels @option{-O2}, @option{-O3}.
8321 @item -fschedule-insns2
8322 @opindex fschedule-insns2
8323 Similar to @option{-fschedule-insns}, but requests an additional pass of
8324 instruction scheduling after register allocation has been done.  This is
8325 especially useful on machines with a relatively small number of
8326 registers and where memory load instructions take more than one cycle.
8328 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8330 @item -fno-sched-interblock
8331 @opindex fno-sched-interblock
8332 Don't schedule instructions across basic blocks.  This is normally
8333 enabled by default when scheduling before register allocation, i.e.@:
8334 with @option{-fschedule-insns} or at @option{-O2} or higher.
8336 @item -fno-sched-spec
8337 @opindex fno-sched-spec
8338 Don't allow speculative motion of non-load instructions.  This is normally
8339 enabled by default when scheduling before register allocation, i.e.@:
8340 with @option{-fschedule-insns} or at @option{-O2} or higher.
8342 @item -fsched-pressure
8343 @opindex fsched-pressure
8344 Enable register pressure sensitive insn scheduling before register
8345 allocation.  This only makes sense when scheduling before register
8346 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8347 @option{-O2} or higher.  Usage of this option can improve the
8348 generated code and decrease its size by preventing register pressure
8349 increase above the number of available hard registers and subsequent
8350 spills in register allocation.
8352 @item -fsched-spec-load
8353 @opindex fsched-spec-load
8354 Allow speculative motion of some load instructions.  This only makes
8355 sense when scheduling before register allocation, i.e.@: with
8356 @option{-fschedule-insns} or at @option{-O2} or higher.
8358 @item -fsched-spec-load-dangerous
8359 @opindex fsched-spec-load-dangerous
8360 Allow speculative motion of more load instructions.  This only makes
8361 sense when scheduling before register allocation, i.e.@: with
8362 @option{-fschedule-insns} or at @option{-O2} or higher.
8364 @item -fsched-stalled-insns
8365 @itemx -fsched-stalled-insns=@var{n}
8366 @opindex fsched-stalled-insns
8367 Define how many insns (if any) can be moved prematurely from the queue
8368 of stalled insns into the ready list during the second scheduling pass.
8369 @option{-fno-sched-stalled-insns} means that no insns are moved
8370 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8371 on how many queued insns can be moved prematurely.
8372 @option{-fsched-stalled-insns} without a value is equivalent to
8373 @option{-fsched-stalled-insns=1}.
8375 @item -fsched-stalled-insns-dep
8376 @itemx -fsched-stalled-insns-dep=@var{n}
8377 @opindex fsched-stalled-insns-dep
8378 Define how many insn groups (cycles) are examined for a dependency
8379 on a stalled insn that is a candidate for premature removal from the queue
8380 of stalled insns.  This has an effect only during the second scheduling pass,
8381 and only if @option{-fsched-stalled-insns} is used.
8382 @option{-fno-sched-stalled-insns-dep} is equivalent to
8383 @option{-fsched-stalled-insns-dep=0}.
8384 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8385 @option{-fsched-stalled-insns-dep=1}.
8387 @item -fsched2-use-superblocks
8388 @opindex fsched2-use-superblocks
8389 When scheduling after register allocation, use superblock scheduling.
8390 This allows motion across basic block boundaries,
8391 resulting in faster schedules.  This option is experimental, as not all machine
8392 descriptions used by GCC model the CPU closely enough to avoid unreliable
8393 results from the algorithm.
8395 This only makes sense when scheduling after register allocation, i.e.@: with
8396 @option{-fschedule-insns2} or at @option{-O2} or higher.
8398 @item -fsched-group-heuristic
8399 @opindex fsched-group-heuristic
8400 Enable the group heuristic in the scheduler.  This heuristic favors
8401 the instruction that belongs to a schedule group.  This is enabled
8402 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8403 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8405 @item -fsched-critical-path-heuristic
8406 @opindex fsched-critical-path-heuristic
8407 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8408 instructions on the critical path.  This is enabled by default when
8409 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8410 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8412 @item -fsched-spec-insn-heuristic
8413 @opindex fsched-spec-insn-heuristic
8414 Enable the speculative instruction heuristic in the scheduler.  This
8415 heuristic favors speculative instructions with greater dependency weakness.
8416 This is enabled by default when scheduling is enabled, i.e.@:
8417 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8418 or at @option{-O2} or higher.
8420 @item -fsched-rank-heuristic
8421 @opindex fsched-rank-heuristic
8422 Enable the rank heuristic in the scheduler.  This heuristic favors
8423 the instruction belonging to a basic block with greater size or frequency.
8424 This is enabled by default when scheduling is enabled, i.e.@:
8425 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8426 at @option{-O2} or higher.
8428 @item -fsched-last-insn-heuristic
8429 @opindex fsched-last-insn-heuristic
8430 Enable the last-instruction heuristic in the scheduler.  This heuristic
8431 favors the instruction that is less dependent on the last instruction
8432 scheduled.  This is enabled by default when scheduling is enabled,
8433 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8434 at @option{-O2} or higher.
8436 @item -fsched-dep-count-heuristic
8437 @opindex fsched-dep-count-heuristic
8438 Enable the dependent-count heuristic in the scheduler.  This heuristic
8439 favors the instruction that has more instructions depending on it.
8440 This is enabled by default when scheduling is enabled, i.e.@:
8441 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8442 at @option{-O2} or higher.
8444 @item -freschedule-modulo-scheduled-loops
8445 @opindex freschedule-modulo-scheduled-loops
8446 Modulo scheduling is performed before traditional scheduling.  If a loop
8447 is modulo scheduled, later scheduling passes may change its schedule.  
8448 Use this option to control that behavior.
8450 @item -fselective-scheduling
8451 @opindex fselective-scheduling
8452 Schedule instructions using selective scheduling algorithm.  Selective
8453 scheduling runs instead of the first scheduler pass.
8455 @item -fselective-scheduling2
8456 @opindex fselective-scheduling2
8457 Schedule instructions using selective scheduling algorithm.  Selective
8458 scheduling runs instead of the second scheduler pass.
8460 @item -fsel-sched-pipelining
8461 @opindex fsel-sched-pipelining
8462 Enable software pipelining of innermost loops during selective scheduling.
8463 This option has no effect unless one of @option{-fselective-scheduling} or
8464 @option{-fselective-scheduling2} is turned on.
8466 @item -fsel-sched-pipelining-outer-loops
8467 @opindex fsel-sched-pipelining-outer-loops
8468 When pipelining loops during selective scheduling, also pipeline outer loops.
8469 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8471 @item -fsemantic-interposition
8472 @opindex fsemantic-interposition
8473 Some object formats, like ELF, allow interposing of symbols by the 
8474 dynamic linker.
8475 This means that for symbols exported from the DSO, the compiler cannot perform
8476 interprocedural propagation, inlining and other optimizations in anticipation
8477 that the function or variable in question may change. While this feature is
8478 useful, for example, to rewrite memory allocation functions by a debugging
8479 implementation, it is expensive in the terms of code quality.
8480 With @option{-fno-semantic-interposition} the compiler assumes that 
8481 if interposition happens for functions the overwriting function will have 
8482 precisely the same semantics (and side effects). 
8483 Similarly if interposition happens
8484 for variables, the constructor of the variable will be the same. The flag
8485 has no effect for functions explicitly declared inline 
8486 (where it is never allowed for interposition to change semantics) 
8487 and for symbols explicitly declared weak.
8489 @item -fshrink-wrap
8490 @opindex fshrink-wrap
8491 Emit function prologues only before parts of the function that need it,
8492 rather than at the top of the function.  This flag is enabled by default at
8493 @option{-O} and higher.
8495 @item -fcaller-saves
8496 @opindex fcaller-saves
8497 Enable allocation of values to registers that are clobbered by
8498 function calls, by emitting extra instructions to save and restore the
8499 registers around such calls.  Such allocation is done only when it
8500 seems to result in better code.
8502 This option is always enabled by default on certain machines, usually
8503 those which have no call-preserved registers to use instead.
8505 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8507 @item -fcombine-stack-adjustments
8508 @opindex fcombine-stack-adjustments
8509 Tracks stack adjustments (pushes and pops) and stack memory references
8510 and then tries to find ways to combine them.
8512 Enabled by default at @option{-O1} and higher.
8514 @item -fipa-ra
8515 @opindex fipa-ra
8516 Use caller save registers for allocation if those registers are not used by
8517 any called function.  In that case it is not necessary to save and restore
8518 them around calls.  This is only possible if called functions are part of
8519 same compilation unit as current function and they are compiled before it.
8521 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8523 @item -fconserve-stack
8524 @opindex fconserve-stack
8525 Attempt to minimize stack usage.  The compiler attempts to use less
8526 stack space, even if that makes the program slower.  This option
8527 implies setting the @option{large-stack-frame} parameter to 100
8528 and the @option{large-stack-frame-growth} parameter to 400.
8530 @item -ftree-reassoc
8531 @opindex ftree-reassoc
8532 Perform reassociation on trees.  This flag is enabled by default
8533 at @option{-O} and higher.
8535 @item -ftree-pre
8536 @opindex ftree-pre
8537 Perform partial redundancy elimination (PRE) on trees.  This flag is
8538 enabled by default at @option{-O2} and @option{-O3}.
8540 @item -ftree-partial-pre
8541 @opindex ftree-partial-pre
8542 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8543 enabled by default at @option{-O3}.
8545 @item -ftree-forwprop
8546 @opindex ftree-forwprop
8547 Perform forward propagation on trees.  This flag is enabled by default
8548 at @option{-O} and higher.
8550 @item -ftree-fre
8551 @opindex ftree-fre
8552 Perform full redundancy elimination (FRE) on trees.  The difference
8553 between FRE and PRE is that FRE only considers expressions
8554 that are computed on all paths leading to the redundant computation.
8555 This analysis is faster than PRE, though it exposes fewer redundancies.
8556 This flag is enabled by default at @option{-O} and higher.
8558 @item -ftree-phiprop
8559 @opindex ftree-phiprop
8560 Perform hoisting of loads from conditional pointers on trees.  This
8561 pass is enabled by default at @option{-O} and higher.
8563 @item -fhoist-adjacent-loads
8564 @opindex fhoist-adjacent-loads
8565 Speculatively hoist loads from both branches of an if-then-else if the
8566 loads are from adjacent locations in the same structure and the target
8567 architecture has a conditional move instruction.  This flag is enabled
8568 by default at @option{-O2} and higher.
8570 @item -ftree-copy-prop
8571 @opindex ftree-copy-prop
8572 Perform copy propagation on trees.  This pass eliminates unnecessary
8573 copy operations.  This flag is enabled by default at @option{-O} and
8574 higher.
8576 @item -fipa-pure-const
8577 @opindex fipa-pure-const
8578 Discover which functions are pure or constant.
8579 Enabled by default at @option{-O} and higher.
8581 @item -fipa-reference
8582 @opindex fipa-reference
8583 Discover which static variables do not escape the
8584 compilation unit.
8585 Enabled by default at @option{-O} and higher.
8587 @item -fipa-pta
8588 @opindex fipa-pta
8589 Perform interprocedural pointer analysis and interprocedural modification
8590 and reference analysis.  This option can cause excessive memory and
8591 compile-time usage on large compilation units.  It is not enabled by
8592 default at any optimization level.
8594 @item -fipa-profile
8595 @opindex fipa-profile
8596 Perform interprocedural profile propagation.  The functions called only from
8597 cold functions are marked as cold. Also functions executed once (such as
8598 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8599 functions and loop less parts of functions executed once are then optimized for
8600 size.
8601 Enabled by default at @option{-O} and higher.
8603 @item -fipa-cp
8604 @opindex fipa-cp
8605 Perform interprocedural constant propagation.
8606 This optimization analyzes the program to determine when values passed
8607 to functions are constants and then optimizes accordingly.
8608 This optimization can substantially increase performance
8609 if the application has constants passed to functions.
8610 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8612 @item -fipa-cp-clone
8613 @opindex fipa-cp-clone
8614 Perform function cloning to make interprocedural constant propagation stronger.
8615 When enabled, interprocedural constant propagation performs function cloning
8616 when externally visible function can be called with constant arguments.
8617 Because this optimization can create multiple copies of functions,
8618 it may significantly increase code size
8619 (see @option{--param ipcp-unit-growth=@var{value}}).
8620 This flag is enabled by default at @option{-O3}.
8622 @item -fipa-cp-alignment
8623 @opindex -fipa-cp-alignment
8624 When enabled, this optimization propagates alignment of function
8625 parameters to support better vectorization and string operations.
8627 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8628 requires that @option{-fipa-cp} is enabled.
8630 @item -fipa-icf
8631 @opindex fipa-icf
8632 Perform Identical Code Folding for functions and read-only variables.
8633 The optimization reduces code size and may disturb unwind stacks by replacing
8634 a function by equivalent one with a different name. The optimization works
8635 more effectively with link time optimization enabled.
8637 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8638 works on different levels and thus the optimizations are not same - there are
8639 equivalences that are found only by GCC and equivalences found only by Gold.
8641 This flag is enabled by default at @option{-O2} and @option{-Os}.
8643 @item -fisolate-erroneous-paths-dereference
8644 @opindex fisolate-erroneous-paths-dereference
8645 Detect paths that trigger erroneous or undefined behavior due to
8646 dereferencing a null pointer.  Isolate those paths from the main control
8647 flow and turn the statement with erroneous or undefined behavior into a trap.
8648 This flag is enabled by default at @option{-O2} and higher and depends on
8649 @option{-fdelete-null-pointer-checks} also being enabled.
8651 @item -fisolate-erroneous-paths-attribute
8652 @opindex fisolate-erroneous-paths-attribute
8653 Detect paths that trigger erroneous or undefined behavior due a null value
8654 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8655 attribute.  Isolate those paths from the main control flow and turn the
8656 statement with erroneous or undefined behavior into a trap.  This is not
8657 currently enabled, but may be enabled by @option{-O2} in the future.
8659 @item -ftree-sink
8660 @opindex ftree-sink
8661 Perform forward store motion  on trees.  This flag is
8662 enabled by default at @option{-O} and higher.
8664 @item -ftree-bit-ccp
8665 @opindex ftree-bit-ccp
8666 Perform sparse conditional bit constant propagation on trees and propagate
8667 pointer alignment information.
8668 This pass only operates on local scalar variables and is enabled by default
8669 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8671 @item -ftree-ccp
8672 @opindex ftree-ccp
8673 Perform sparse conditional constant propagation (CCP) on trees.  This
8674 pass only operates on local scalar variables and is enabled by default
8675 at @option{-O} and higher.
8677 @item -fssa-phiopt
8678 @opindex fssa-phiopt
8679 Perform pattern matching on SSA PHI nodes to optimize conditional
8680 code.  This pass is enabled by default at @option{-O} and higher.
8682 @item -ftree-switch-conversion
8683 @opindex ftree-switch-conversion
8684 Perform conversion of simple initializations in a switch to
8685 initializations from a scalar array.  This flag is enabled by default
8686 at @option{-O2} and higher.
8688 @item -ftree-tail-merge
8689 @opindex ftree-tail-merge
8690 Look for identical code sequences.  When found, replace one with a jump to the
8691 other.  This optimization is known as tail merging or cross jumping.  This flag
8692 is enabled by default at @option{-O2} and higher.  The compilation time
8693 in this pass can
8694 be limited using @option{max-tail-merge-comparisons} parameter and
8695 @option{max-tail-merge-iterations} parameter.
8697 @item -ftree-dce
8698 @opindex ftree-dce
8699 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8700 default at @option{-O} and higher.
8702 @item -ftree-builtin-call-dce
8703 @opindex ftree-builtin-call-dce
8704 Perform conditional dead code elimination (DCE) for calls to built-in functions
8705 that may set @code{errno} but are otherwise side-effect free.  This flag is
8706 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8707 specified.
8709 @item -ftree-dominator-opts
8710 @opindex ftree-dominator-opts
8711 Perform a variety of simple scalar cleanups (constant/copy
8712 propagation, redundancy elimination, range propagation and expression
8713 simplification) based on a dominator tree traversal.  This also
8714 performs jump threading (to reduce jumps to jumps). This flag is
8715 enabled by default at @option{-O} and higher.
8717 @item -ftree-dse
8718 @opindex ftree-dse
8719 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8720 a memory location that is later overwritten by another store without
8721 any intervening loads.  In this case the earlier store can be deleted.  This
8722 flag is enabled by default at @option{-O} and higher.
8724 @item -ftree-ch
8725 @opindex ftree-ch
8726 Perform loop header copying on trees.  This is beneficial since it increases
8727 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8728 is enabled by default at @option{-O} and higher.  It is not enabled
8729 for @option{-Os}, since it usually increases code size.
8731 @item -ftree-loop-optimize
8732 @opindex ftree-loop-optimize
8733 Perform loop optimizations on trees.  This flag is enabled by default
8734 at @option{-O} and higher.
8736 @item -ftree-loop-linear
8737 @itemx -floop-interchange
8738 @itemx -floop-strip-mine
8739 @itemx -floop-block
8740 @itemx -floop-unroll-and-jam
8741 @opindex ftree-loop-linear
8742 @opindex floop-interchange
8743 @opindex floop-strip-mine
8744 @opindex floop-block
8745 @opindex floop-unroll-and-jam
8746 Perform loop nest optimizations.  Same as
8747 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8748 to be configured with @option{--with-isl} to enable the Graphite loop
8749 transformation infrastructure.
8751 @item -fgraphite-identity
8752 @opindex fgraphite-identity
8753 Enable the identity transformation for graphite.  For every SCoP we generate
8754 the polyhedral representation and transform it back to gimple.  Using
8755 @option{-fgraphite-identity} we can check the costs or benefits of the
8756 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8757 are also performed by the code generator ISL, like index splitting and
8758 dead code elimination in loops.
8760 @item -floop-nest-optimize
8761 @opindex floop-nest-optimize
8762 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8763 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8764 structure optimized for data-locality and parallelism.  This option
8765 is experimental.
8767 @item -floop-parallelize-all
8768 @opindex floop-parallelize-all
8769 Use the Graphite data dependence analysis to identify loops that can
8770 be parallelized.  Parallelize all the loops that can be analyzed to
8771 not contain loop carried dependences without checking that it is
8772 profitable to parallelize the loops.
8774 @item -ftree-coalesce-vars
8775 @opindex ftree-coalesce-vars
8776 Tell the compiler to attempt to combine small user-defined variables
8777 too, instead of just compiler temporaries.  This may severely limit the
8778 ability to debug an optimized program compiled with
8779 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8780 prevents SSA coalescing of user variables.  This option is enabled by
8781 default if optimization is enabled.
8783 @item -ftree-loop-if-convert
8784 @opindex ftree-loop-if-convert
8785 Attempt to transform conditional jumps in the innermost loops to
8786 branch-less equivalents.  The intent is to remove control-flow from
8787 the innermost loops in order to improve the ability of the
8788 vectorization pass to handle these loops.  This is enabled by default
8789 if vectorization is enabled.
8791 @item -ftree-loop-if-convert-stores
8792 @opindex ftree-loop-if-convert-stores
8793 Attempt to also if-convert conditional jumps containing memory writes.
8794 This transformation can be unsafe for multi-threaded programs as it
8795 transforms conditional memory writes into unconditional memory writes.
8796 For example,
8797 @smallexample
8798 for (i = 0; i < N; i++)
8799   if (cond)
8800     A[i] = expr;
8801 @end smallexample
8802 is transformed to
8803 @smallexample
8804 for (i = 0; i < N; i++)
8805   A[i] = cond ? expr : A[i];
8806 @end smallexample
8807 potentially producing data races.
8809 @item -ftree-loop-distribution
8810 @opindex ftree-loop-distribution
8811 Perform loop distribution.  This flag can improve cache performance on
8812 big loop bodies and allow further loop optimizations, like
8813 parallelization or vectorization, to take place.  For example, the loop
8814 @smallexample
8815 DO I = 1, N
8816   A(I) = B(I) + C
8817   D(I) = E(I) * F
8818 ENDDO
8819 @end smallexample
8820 is transformed to
8821 @smallexample
8822 DO I = 1, N
8823    A(I) = B(I) + C
8824 ENDDO
8825 DO I = 1, N
8826    D(I) = E(I) * F
8827 ENDDO
8828 @end smallexample
8830 @item -ftree-loop-distribute-patterns
8831 @opindex ftree-loop-distribute-patterns
8832 Perform loop distribution of patterns that can be code generated with
8833 calls to a library.  This flag is enabled by default at @option{-O3}.
8835 This pass distributes the initialization loops and generates a call to
8836 memset zero.  For example, the loop
8837 @smallexample
8838 DO I = 1, N
8839   A(I) = 0
8840   B(I) = A(I) + I
8841 ENDDO
8842 @end smallexample
8843 is transformed to
8844 @smallexample
8845 DO I = 1, N
8846    A(I) = 0
8847 ENDDO
8848 DO I = 1, N
8849    B(I) = A(I) + I
8850 ENDDO
8851 @end smallexample
8852 and the initialization loop is transformed into a call to memset zero.
8854 @item -ftree-loop-im
8855 @opindex ftree-loop-im
8856 Perform loop invariant motion on trees.  This pass moves only invariants that
8857 are hard to handle at RTL level (function calls, operations that expand to
8858 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8859 operands of conditions that are invariant out of the loop, so that we can use
8860 just trivial invariantness analysis in loop unswitching.  The pass also includes
8861 store motion.
8863 @item -ftree-loop-ivcanon
8864 @opindex ftree-loop-ivcanon
8865 Create a canonical counter for number of iterations in loops for which
8866 determining number of iterations requires complicated analysis.  Later
8867 optimizations then may determine the number easily.  Useful especially
8868 in connection with unrolling.
8870 @item -fivopts
8871 @opindex fivopts
8872 Perform induction variable optimizations (strength reduction, induction
8873 variable merging and induction variable elimination) on trees.
8875 @item -ftree-parallelize-loops=n
8876 @opindex ftree-parallelize-loops
8877 Parallelize loops, i.e., split their iteration space to run in n threads.
8878 This is only possible for loops whose iterations are independent
8879 and can be arbitrarily reordered.  The optimization is only
8880 profitable on multiprocessor machines, for loops that are CPU-intensive,
8881 rather than constrained e.g.@: by memory bandwidth.  This option
8882 implies @option{-pthread}, and thus is only supported on targets
8883 that have support for @option{-pthread}.
8885 @item -ftree-pta
8886 @opindex ftree-pta
8887 Perform function-local points-to analysis on trees.  This flag is
8888 enabled by default at @option{-O} and higher.
8890 @item -ftree-sra
8891 @opindex ftree-sra
8892 Perform scalar replacement of aggregates.  This pass replaces structure
8893 references with scalars to prevent committing structures to memory too
8894 early.  This flag is enabled by default at @option{-O} and higher.
8896 @item -ftree-ter
8897 @opindex ftree-ter
8898 Perform temporary expression replacement during the SSA->normal phase.  Single
8899 use/single def temporaries are replaced at their use location with their
8900 defining expression.  This results in non-GIMPLE code, but gives the expanders
8901 much more complex trees to work on resulting in better RTL generation.  This is
8902 enabled by default at @option{-O} and higher.
8904 @item -ftree-slsr
8905 @opindex ftree-slsr
8906 Perform straight-line strength reduction on trees.  This recognizes related
8907 expressions involving multiplications and replaces them by less expensive
8908 calculations when possible.  This is enabled by default at @option{-O} and
8909 higher.
8911 @item -ftree-vectorize
8912 @opindex ftree-vectorize
8913 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8914 and @option{-ftree-slp-vectorize} if not explicitly specified.
8916 @item -ftree-loop-vectorize
8917 @opindex ftree-loop-vectorize
8918 Perform loop vectorization on trees. This flag is enabled by default at
8919 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8921 @item -ftree-slp-vectorize
8922 @opindex ftree-slp-vectorize
8923 Perform basic block vectorization on trees. This flag is enabled by default at
8924 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8926 @item -fvect-cost-model=@var{model}
8927 @opindex fvect-cost-model
8928 Alter the cost model used for vectorization.  The @var{model} argument
8929 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8930 With the @samp{unlimited} model the vectorized code-path is assumed
8931 to be profitable while with the @samp{dynamic} model a runtime check
8932 guards the vectorized code-path to enable it only for iteration
8933 counts that will likely execute faster than when executing the original
8934 scalar loop.  The @samp{cheap} model disables vectorization of
8935 loops where doing so would be cost prohibitive for example due to
8936 required runtime checks for data dependence or alignment but otherwise
8937 is equal to the @samp{dynamic} model.
8938 The default cost model depends on other optimization flags and is
8939 either @samp{dynamic} or @samp{cheap}.
8941 @item -fsimd-cost-model=@var{model}
8942 @opindex fsimd-cost-model
8943 Alter the cost model used for vectorization of loops marked with the OpenMP
8944 or Cilk Plus simd directive.  The @var{model} argument should be one of
8945 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8946 have the same meaning as described in @option{-fvect-cost-model} and by
8947 default a cost model defined with @option{-fvect-cost-model} is used.
8949 @item -ftree-vrp
8950 @opindex ftree-vrp
8951 Perform Value Range Propagation on trees.  This is similar to the
8952 constant propagation pass, but instead of values, ranges of values are
8953 propagated.  This allows the optimizers to remove unnecessary range
8954 checks like array bound checks and null pointer checks.  This is
8955 enabled by default at @option{-O2} and higher.  Null pointer check
8956 elimination is only done if @option{-fdelete-null-pointer-checks} is
8957 enabled.
8959 @item -fsplit-ivs-in-unroller
8960 @opindex fsplit-ivs-in-unroller
8961 Enables expression of values of induction variables in later iterations
8962 of the unrolled loop using the value in the first iteration.  This breaks
8963 long dependency chains, thus improving efficiency of the scheduling passes.
8965 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8966 same effect.  However, that is not reliable in cases where the loop body
8967 is more complicated than a single basic block.  It also does not work at all
8968 on some architectures due to restrictions in the CSE pass.
8970 This optimization is enabled by default.
8972 @item -fvariable-expansion-in-unroller
8973 @opindex fvariable-expansion-in-unroller
8974 With this option, the compiler creates multiple copies of some
8975 local variables when unrolling a loop, which can result in superior code.
8977 @item -fpartial-inlining
8978 @opindex fpartial-inlining
8979 Inline parts of functions.  This option has any effect only
8980 when inlining itself is turned on by the @option{-finline-functions}
8981 or @option{-finline-small-functions} options.
8983 Enabled at level @option{-O2}.
8985 @item -fpredictive-commoning
8986 @opindex fpredictive-commoning
8987 Perform predictive commoning optimization, i.e., reusing computations
8988 (especially memory loads and stores) performed in previous
8989 iterations of loops.
8991 This option is enabled at level @option{-O3}.
8993 @item -fprefetch-loop-arrays
8994 @opindex fprefetch-loop-arrays
8995 If supported by the target machine, generate instructions to prefetch
8996 memory to improve the performance of loops that access large arrays.
8998 This option may generate better or worse code; results are highly
8999 dependent on the structure of loops within the source code.
9001 Disabled at level @option{-Os}.
9003 @item -fno-peephole
9004 @itemx -fno-peephole2
9005 @opindex fno-peephole
9006 @opindex fno-peephole2
9007 Disable any machine-specific peephole optimizations.  The difference
9008 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9009 are implemented in the compiler; some targets use one, some use the
9010 other, a few use both.
9012 @option{-fpeephole} is enabled by default.
9013 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9015 @item -fno-guess-branch-probability
9016 @opindex fno-guess-branch-probability
9017 Do not guess branch probabilities using heuristics.
9019 GCC uses heuristics to guess branch probabilities if they are
9020 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9021 heuristics are based on the control flow graph.  If some branch probabilities
9022 are specified by @code{__builtin_expect}, then the heuristics are
9023 used to guess branch probabilities for the rest of the control flow graph,
9024 taking the @code{__builtin_expect} info into account.  The interactions
9025 between the heuristics and @code{__builtin_expect} can be complex, and in
9026 some cases, it may be useful to disable the heuristics so that the effects
9027 of @code{__builtin_expect} are easier to understand.
9029 The default is @option{-fguess-branch-probability} at levels
9030 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9032 @item -freorder-blocks
9033 @opindex freorder-blocks
9034 Reorder basic blocks in the compiled function in order to reduce number of
9035 taken branches and improve code locality.
9037 Enabled at levels @option{-O2}, @option{-O3}.
9039 @item -freorder-blocks-and-partition
9040 @opindex freorder-blocks-and-partition
9041 In addition to reordering basic blocks in the compiled function, in order
9042 to reduce number of taken branches, partitions hot and cold basic blocks
9043 into separate sections of the assembly and .o files, to improve
9044 paging and cache locality performance.
9046 This optimization is automatically turned off in the presence of
9047 exception handling, for linkonce sections, for functions with a user-defined
9048 section attribute and on any architecture that does not support named
9049 sections.
9051 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9053 @item -freorder-functions
9054 @opindex freorder-functions
9055 Reorder functions in the object file in order to
9056 improve code locality.  This is implemented by using special
9057 subsections @code{.text.hot} for most frequently executed functions and
9058 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9059 the linker so object file format must support named sections and linker must
9060 place them in a reasonable way.
9062 Also profile feedback must be available to make this option effective.  See
9063 @option{-fprofile-arcs} for details.
9065 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9067 @item -fstrict-aliasing
9068 @opindex fstrict-aliasing
9069 Allow the compiler to assume the strictest aliasing rules applicable to
9070 the language being compiled.  For C (and C++), this activates
9071 optimizations based on the type of expressions.  In particular, an
9072 object of one type is assumed never to reside at the same address as an
9073 object of a different type, unless the types are almost the same.  For
9074 example, an @code{unsigned int} can alias an @code{int}, but not a
9075 @code{void*} or a @code{double}.  A character type may alias any other
9076 type.
9078 @anchor{Type-punning}Pay special attention to code like this:
9079 @smallexample
9080 union a_union @{
9081   int i;
9082   double d;
9085 int f() @{
9086   union a_union t;
9087   t.d = 3.0;
9088   return t.i;
9090 @end smallexample
9091 The practice of reading from a different union member than the one most
9092 recently written to (called ``type-punning'') is common.  Even with
9093 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9094 is accessed through the union type.  So, the code above works as
9095 expected.  @xref{Structures unions enumerations and bit-fields
9096 implementation}.  However, this code might not:
9097 @smallexample
9098 int f() @{
9099   union a_union t;
9100   int* ip;
9101   t.d = 3.0;
9102   ip = &t.i;
9103   return *ip;
9105 @end smallexample
9107 Similarly, access by taking the address, casting the resulting pointer
9108 and dereferencing the result has undefined behavior, even if the cast
9109 uses a union type, e.g.:
9110 @smallexample
9111 int f() @{
9112   double d = 3.0;
9113   return ((union a_union *) &d)->i;
9115 @end smallexample
9117 The @option{-fstrict-aliasing} option is enabled at levels
9118 @option{-O2}, @option{-O3}, @option{-Os}.
9120 @item -fstrict-overflow
9121 @opindex fstrict-overflow
9122 Allow the compiler to assume strict signed overflow rules, depending
9123 on the language being compiled.  For C (and C++) this means that
9124 overflow when doing arithmetic with signed numbers is undefined, which
9125 means that the compiler may assume that it does not happen.  This
9126 permits various optimizations.  For example, the compiler assumes
9127 that an expression like @code{i + 10 > i} is always true for
9128 signed @code{i}.  This assumption is only valid if signed overflow is
9129 undefined, as the expression is false if @code{i + 10} overflows when
9130 using twos complement arithmetic.  When this option is in effect any
9131 attempt to determine whether an operation on signed numbers 
9132 overflows must be written carefully to not actually involve overflow.
9134 This option also allows the compiler to assume strict pointer
9135 semantics: given a pointer to an object, if adding an offset to that
9136 pointer does not produce a pointer to the same object, the addition is
9137 undefined.  This permits the compiler to conclude that @code{p + u >
9138 p} is always true for a pointer @code{p} and unsigned integer
9139 @code{u}.  This assumption is only valid because pointer wraparound is
9140 undefined, as the expression is false if @code{p + u} overflows using
9141 twos complement arithmetic.
9143 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
9144 that integer signed overflow is fully defined: it wraps.  When
9145 @option{-fwrapv} is used, there is no difference between
9146 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
9147 integers.  With @option{-fwrapv} certain types of overflow are
9148 permitted.  For example, if the compiler gets an overflow when doing
9149 arithmetic on constants, the overflowed value can still be used with
9150 @option{-fwrapv}, but not otherwise.
9152 The @option{-fstrict-overflow} option is enabled at levels
9153 @option{-O2}, @option{-O3}, @option{-Os}.
9155 @item -falign-functions
9156 @itemx -falign-functions=@var{n}
9157 @opindex falign-functions
9158 Align the start of functions to the next power-of-two greater than
9159 @var{n}, skipping up to @var{n} bytes.  For instance,
9160 @option{-falign-functions=32} aligns functions to the next 32-byte
9161 boundary, but @option{-falign-functions=24} aligns to the next
9162 32-byte boundary only if this can be done by skipping 23 bytes or less.
9164 @option{-fno-align-functions} and @option{-falign-functions=1} are
9165 equivalent and mean that functions are not aligned.
9167 Some assemblers only support this flag when @var{n} is a power of two;
9168 in that case, it is rounded up.
9170 If @var{n} is not specified or is zero, use a machine-dependent default.
9172 Enabled at levels @option{-O2}, @option{-O3}.
9174 @item -falign-labels
9175 @itemx -falign-labels=@var{n}
9176 @opindex falign-labels
9177 Align all branch targets to a power-of-two boundary, skipping up to
9178 @var{n} bytes like @option{-falign-functions}.  This option can easily
9179 make code slower, because it must insert dummy operations for when the
9180 branch target is reached in the usual flow of the code.
9182 @option{-fno-align-labels} and @option{-falign-labels=1} are
9183 equivalent and mean that labels are not aligned.
9185 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9186 are greater than this value, then their values are used instead.
9188 If @var{n} is not specified or is zero, use a machine-dependent default
9189 which is very likely to be @samp{1}, meaning no alignment.
9191 Enabled at levels @option{-O2}, @option{-O3}.
9193 @item -falign-loops
9194 @itemx -falign-loops=@var{n}
9195 @opindex falign-loops
9196 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9197 like @option{-falign-functions}.  If the loops are
9198 executed many times, this makes up for any execution of the dummy
9199 operations.
9201 @option{-fno-align-loops} and @option{-falign-loops=1} are
9202 equivalent and mean that loops are not aligned.
9204 If @var{n} is not specified or is zero, use a machine-dependent default.
9206 Enabled at levels @option{-O2}, @option{-O3}.
9208 @item -falign-jumps
9209 @itemx -falign-jumps=@var{n}
9210 @opindex falign-jumps
9211 Align branch targets to a power-of-two boundary, for branch targets
9212 where the targets can only be reached by jumping, skipping up to @var{n}
9213 bytes like @option{-falign-functions}.  In this case, no dummy operations
9214 need be executed.
9216 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9217 equivalent and mean that loops are not aligned.
9219 If @var{n} is not specified or is zero, use a machine-dependent default.
9221 Enabled at levels @option{-O2}, @option{-O3}.
9223 @item -funit-at-a-time
9224 @opindex funit-at-a-time
9225 This option is left for compatibility reasons. @option{-funit-at-a-time}
9226 has no effect, while @option{-fno-unit-at-a-time} implies
9227 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9229 Enabled by default.
9231 @item -fno-toplevel-reorder
9232 @opindex fno-toplevel-reorder
9233 Do not reorder top-level functions, variables, and @code{asm}
9234 statements.  Output them in the same order that they appear in the
9235 input file.  When this option is used, unreferenced static variables
9236 are not removed.  This option is intended to support existing code
9237 that relies on a particular ordering.  For new code, it is better to
9238 use attributes when possible.
9240 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9241 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9242 targets.
9244 @item -fweb
9245 @opindex fweb
9246 Constructs webs as commonly used for register allocation purposes and assign
9247 each web individual pseudo register.  This allows the register allocation pass
9248 to operate on pseudos directly, but also strengthens several other optimization
9249 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9250 however, make debugging impossible, since variables no longer stay in a
9251 ``home register''.
9253 Enabled by default with @option{-funroll-loops}.
9255 @item -fwhole-program
9256 @opindex fwhole-program
9257 Assume that the current compilation unit represents the whole program being
9258 compiled.  All public functions and variables with the exception of @code{main}
9259 and those merged by attribute @code{externally_visible} become static functions
9260 and in effect are optimized more aggressively by interprocedural optimizers.
9262 This option should not be used in combination with @option{-flto}.
9263 Instead relying on a linker plugin should provide safer and more precise
9264 information.
9266 @item -flto[=@var{n}]
9267 @opindex flto
9268 This option runs the standard link-time optimizer.  When invoked
9269 with source code, it generates GIMPLE (one of GCC's internal
9270 representations) and writes it to special ELF sections in the object
9271 file.  When the object files are linked together, all the function
9272 bodies are read from these ELF sections and instantiated as if they
9273 had been part of the same translation unit.
9275 To use the link-time optimizer, @option{-flto} and optimization
9276 options should be specified at compile time and during the final link.
9277 For example:
9279 @smallexample
9280 gcc -c -O2 -flto foo.c
9281 gcc -c -O2 -flto bar.c
9282 gcc -o myprog -flto -O2 foo.o bar.o
9283 @end smallexample
9285 The first two invocations to GCC save a bytecode representation
9286 of GIMPLE into special ELF sections inside @file{foo.o} and
9287 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9288 @file{foo.o} and @file{bar.o}, merges the two files into a single
9289 internal image, and compiles the result as usual.  Since both
9290 @file{foo.o} and @file{bar.o} are merged into a single image, this
9291 causes all the interprocedural analyses and optimizations in GCC to
9292 work across the two files as if they were a single one.  This means,
9293 for example, that the inliner is able to inline functions in
9294 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9296 Another (simpler) way to enable link-time optimization is:
9298 @smallexample
9299 gcc -o myprog -flto -O2 foo.c bar.c
9300 @end smallexample
9302 The above generates bytecode for @file{foo.c} and @file{bar.c},
9303 merges them together into a single GIMPLE representation and optimizes
9304 them as usual to produce @file{myprog}.
9306 The only important thing to keep in mind is that to enable link-time
9307 optimizations you need to use the GCC driver to perform the link-step.
9308 GCC then automatically performs link-time optimization if any of the
9309 objects involved were compiled with the @option{-flto} command-line option.  
9310 You generally
9311 should specify the optimization options to be used for link-time
9312 optimization though GCC tries to be clever at guessing an
9313 optimization level to use from the options used at compile-time
9314 if you fail to specify one at link-time.  You can always override
9315 the automatic decision to do link-time optimization at link-time
9316 by passing @option{-fno-lto} to the link command.
9318 To make whole program optimization effective, it is necessary to make
9319 certain whole program assumptions.  The compiler needs to know
9320 what functions and variables can be accessed by libraries and runtime
9321 outside of the link-time optimized unit.  When supported by the linker,
9322 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9323 to the compiler about used and externally visible symbols.  When
9324 the linker plugin is not available, @option{-fwhole-program} should be
9325 used to allow the compiler to make these assumptions, which leads
9326 to more aggressive optimization decisions.
9328 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9329 compiled with @option{-flto}, the generated object file is larger than
9330 a regular object file because it contains GIMPLE bytecodes and the usual
9331 final code (see @option{-ffat-lto-objects}.  This means that
9332 object files with LTO information can be linked as normal object
9333 files; if @option{-fno-lto} is passed to the linker, no
9334 interprocedural optimizations are applied.  Note that when
9335 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9336 but you cannot perform a regular, non-LTO link on them.
9338 Additionally, the optimization flags used to compile individual files
9339 are not necessarily related to those used at link time.  For instance,
9341 @smallexample
9342 gcc -c -O0 -ffat-lto-objects -flto foo.c
9343 gcc -c -O0 -ffat-lto-objects -flto bar.c
9344 gcc -o myprog -O3 foo.o bar.o
9345 @end smallexample
9347 This produces individual object files with unoptimized assembler
9348 code, but the resulting binary @file{myprog} is optimized at
9349 @option{-O3}.  If, instead, the final binary is generated with
9350 @option{-fno-lto}, then @file{myprog} is not optimized.
9352 When producing the final binary, GCC only
9353 applies link-time optimizations to those files that contain bytecode.
9354 Therefore, you can mix and match object files and libraries with
9355 GIMPLE bytecodes and final object code.  GCC automatically selects
9356 which files to optimize in LTO mode and which files to link without
9357 further processing.
9359 There are some code generation flags preserved by GCC when
9360 generating bytecodes, as they need to be used during the final link
9361 stage.  Generally options specified at link-time override those
9362 specified at compile-time.
9364 If you do not specify an optimization level option @option{-O} at
9365 link-time then GCC computes one based on the optimization levels
9366 used when compiling the object files.  The highest optimization
9367 level wins here.
9369 Currently, the following options and their setting are take from
9370 the first object file that explicitely specified it: 
9371 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9372 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9373 and all the @option{-m} target flags.
9375 Certain ABI changing flags are required to match in all compilation-units
9376 and trying to override this at link-time with a conflicting value
9377 is ignored.  This includes options such as @option{-freg-struct-return}
9378 and @option{-fpcc-struct-return}. 
9380 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9381 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9382 are passed through to the link stage and merged conservatively for
9383 conflicting translation units.  Specifically
9384 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9385 precedence and for example @option{-ffp-contract=off} takes precedence
9386 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9388 It is recommended that you compile all the files participating in the
9389 same link with the same options and also specify those options at
9390 link time.
9392 If LTO encounters objects with C linkage declared with incompatible
9393 types in separate translation units to be linked together (undefined
9394 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9395 issued.  The behavior is still undefined at run time.  Similar
9396 diagnostics may be raised for other languages.
9398 Another feature of LTO is that it is possible to apply interprocedural
9399 optimizations on files written in different languages:
9401 @smallexample
9402 gcc -c -flto foo.c
9403 g++ -c -flto bar.cc
9404 gfortran -c -flto baz.f90
9405 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9406 @end smallexample
9408 Notice that the final link is done with @command{g++} to get the C++
9409 runtime libraries and @option{-lgfortran} is added to get the Fortran
9410 runtime libraries.  In general, when mixing languages in LTO mode, you
9411 should use the same link command options as when mixing languages in a
9412 regular (non-LTO) compilation.
9414 If object files containing GIMPLE bytecode are stored in a library archive, say
9415 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9416 are using a linker with plugin support.  To create static libraries suitable
9417 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9418 and @command{ranlib}; 
9419 to show the symbols of object files with GIMPLE bytecode, use
9420 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9421 and @command{nm} have been compiled with plugin support.  At link time, use the the
9422 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9423 the LTO optimization process:
9425 @smallexample
9426 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9427 @end smallexample
9429 With the linker plugin enabled, the linker extracts the needed
9430 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9431 to make them part of the aggregated GIMPLE image to be optimized.
9433 If you are not using a linker with plugin support and/or do not
9434 enable the linker plugin, then the objects inside @file{libfoo.a}
9435 are extracted and linked as usual, but they do not participate
9436 in the LTO optimization process.  In order to make a static library suitable
9437 for both LTO optimization and usual linkage, compile its object files with
9438 @option{-flto} @option{-ffat-lto-objects}.
9440 Link-time optimizations do not require the presence of the whole program to
9441 operate.  If the program does not require any symbols to be exported, it is
9442 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9443 the interprocedural optimizers to use more aggressive assumptions which may
9444 lead to improved optimization opportunities.
9445 Use of @option{-fwhole-program} is not needed when linker plugin is
9446 active (see @option{-fuse-linker-plugin}).
9448 The current implementation of LTO makes no
9449 attempt to generate bytecode that is portable between different
9450 types of hosts.  The bytecode files are versioned and there is a
9451 strict version check, so bytecode files generated in one version of
9452 GCC do not work with an older or newer version of GCC.
9454 Link-time optimization does not work well with generation of debugging
9455 information.  Combining @option{-flto} with
9456 @option{-g} is currently experimental and expected to produce unexpected
9457 results.
9459 If you specify the optional @var{n}, the optimization and code
9460 generation done at link time is executed in parallel using @var{n}
9461 parallel jobs by utilizing an installed @command{make} program.  The
9462 environment variable @env{MAKE} may be used to override the program
9463 used.  The default value for @var{n} is 1.
9465 You can also specify @option{-flto=jobserver} to use GNU make's
9466 job server mode to determine the number of parallel jobs. This
9467 is useful when the Makefile calling GCC is already executing in parallel.
9468 You must prepend a @samp{+} to the command recipe in the parent Makefile
9469 for this to work.  This option likely only works if @env{MAKE} is
9470 GNU make.
9472 @item -flto-partition=@var{alg}
9473 @opindex flto-partition
9474 Specify the partitioning algorithm used by the link-time optimizer.
9475 The value is either @samp{1to1} to specify a partitioning mirroring
9476 the original source files or @samp{balanced} to specify partitioning
9477 into equally sized chunks (whenever possible) or @samp{max} to create
9478 new partition for every symbol where possible.  Specifying @samp{none}
9479 as an algorithm disables partitioning and streaming completely. 
9480 The default value is @samp{balanced}. While @samp{1to1} can be used
9481 as an workaround for various code ordering issues, the @samp{max}
9482 partitioning is intended for internal testing only.
9483 The value @samp{one} specifies that exactly one partition should be
9484 used while the value @samp{none} bypasses partitioning and executes
9485 the link-time optimization step directly from the WPA phase.
9487 @item -flto-odr-type-merging
9488 @opindex flto-odr-type-merging
9489 Enable streaming of mangled types names of C++ types and their unification
9490 at linktime.  This increases size of LTO object files, but enable
9491 diagnostics about One Definition Rule violations.
9493 @item -flto-compression-level=@var{n}
9494 @opindex flto-compression-level
9495 This option specifies the level of compression used for intermediate
9496 language written to LTO object files, and is only meaningful in
9497 conjunction with LTO mode (@option{-flto}).  Valid
9498 values are 0 (no compression) to 9 (maximum compression).  Values
9499 outside this range are clamped to either 0 or 9.  If the option is not
9500 given, a default balanced compression setting is used.
9502 @item -flto-report
9503 @opindex flto-report
9504 Prints a report with internal details on the workings of the link-time
9505 optimizer.  The contents of this report vary from version to version.
9506 It is meant to be useful to GCC developers when processing object
9507 files in LTO mode (via @option{-flto}).
9509 Disabled by default.
9511 @item -flto-report-wpa
9512 @opindex flto-report-wpa
9513 Like @option{-flto-report}, but only print for the WPA phase of Link
9514 Time Optimization.
9516 @item -fuse-linker-plugin
9517 @opindex fuse-linker-plugin
9518 Enables the use of a linker plugin during link-time optimization.  This
9519 option relies on plugin support in the linker, which is available in gold
9520 or in GNU ld 2.21 or newer.
9522 This option enables the extraction of object files with GIMPLE bytecode out
9523 of library archives. This improves the quality of optimization by exposing
9524 more code to the link-time optimizer.  This information specifies what
9525 symbols can be accessed externally (by non-LTO object or during dynamic
9526 linking).  Resulting code quality improvements on binaries (and shared
9527 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9528 See @option{-flto} for a description of the effect of this flag and how to
9529 use it.
9531 This option is enabled by default when LTO support in GCC is enabled
9532 and GCC was configured for use with
9533 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9535 @item -ffat-lto-objects
9536 @opindex ffat-lto-objects
9537 Fat LTO objects are object files that contain both the intermediate language
9538 and the object code. This makes them usable for both LTO linking and normal
9539 linking. This option is effective only when compiling with @option{-flto}
9540 and is ignored at link time.
9542 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9543 requires the complete toolchain to be aware of LTO. It requires a linker with
9544 linker plugin support for basic functionality.  Additionally,
9545 @command{nm}, @command{ar} and @command{ranlib}
9546 need to support linker plugins to allow a full-featured build environment
9547 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9548 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9549 to these tools. With non fat LTO makefiles need to be modified to use them.
9551 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9552 support.
9554 @item -fcompare-elim
9555 @opindex fcompare-elim
9556 After register allocation and post-register allocation instruction splitting,
9557 identify arithmetic instructions that compute processor flags similar to a
9558 comparison operation based on that arithmetic.  If possible, eliminate the
9559 explicit comparison operation.
9561 This pass only applies to certain targets that cannot explicitly represent
9562 the comparison operation before register allocation is complete.
9564 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9566 @item -fcprop-registers
9567 @opindex fcprop-registers
9568 After register allocation and post-register allocation instruction splitting,
9569 perform a copy-propagation pass to try to reduce scheduling dependencies
9570 and occasionally eliminate the copy.
9572 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9574 @item -fprofile-correction
9575 @opindex fprofile-correction
9576 Profiles collected using an instrumented binary for multi-threaded programs may
9577 be inconsistent due to missed counter updates. When this option is specified,
9578 GCC uses heuristics to correct or smooth out such inconsistencies. By
9579 default, GCC emits an error message when an inconsistent profile is detected.
9581 @item -fprofile-dir=@var{path}
9582 @opindex fprofile-dir
9584 Set the directory to search for the profile data files in to @var{path}.
9585 This option affects only the profile data generated by
9586 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9587 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9588 and its related options.  Both absolute and relative paths can be used.
9589 By default, GCC uses the current directory as @var{path}, thus the
9590 profile data file appears in the same directory as the object file.
9592 @item -fprofile-generate
9593 @itemx -fprofile-generate=@var{path}
9594 @opindex fprofile-generate
9596 Enable options usually used for instrumenting application to produce
9597 profile useful for later recompilation with profile feedback based
9598 optimization.  You must use @option{-fprofile-generate} both when
9599 compiling and when linking your program.
9601 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9603 If @var{path} is specified, GCC looks at the @var{path} to find
9604 the profile feedback data files. See @option{-fprofile-dir}.
9606 @item -fprofile-use
9607 @itemx -fprofile-use=@var{path}
9608 @opindex fprofile-use
9609 Enable profile feedback-directed optimizations, 
9610 and the following optimizations
9611 which are generally profitable only with profile feedback available:
9612 @option{-fbranch-probabilities}, @option{-fvpt},
9613 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9614 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9616 By default, GCC emits an error message if the feedback profiles do not
9617 match the source code.  This error can be turned into a warning by using
9618 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9619 code.
9621 If @var{path} is specified, GCC looks at the @var{path} to find
9622 the profile feedback data files. See @option{-fprofile-dir}.
9624 @item -fauto-profile
9625 @itemx -fauto-profile=@var{path}
9626 @opindex fauto-profile
9627 Enable sampling-based feedback-directed optimizations, 
9628 and the following optimizations
9629 which are generally profitable only with profile feedback available:
9630 @option{-fbranch-probabilities}, @option{-fvpt},
9631 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9632 @option{-ftree-vectorize},
9633 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9634 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9635 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9637 @var{path} is the name of a file containing AutoFDO profile information.
9638 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9640 Producing an AutoFDO profile data file requires running your program
9641 with the @command{perf} utility on a supported GNU/Linux target system.
9642 For more information, see @uref{https://perf.wiki.kernel.org/}.
9644 E.g.
9645 @smallexample
9646 perf record -e br_inst_retired:near_taken -b -o perf.data \
9647     -- your_program
9648 @end smallexample
9650 Then use the @command{create_gcov} tool to convert the raw profile data
9651 to a format that can be used by GCC.@  You must also supply the 
9652 unstripped binary for your program to this tool.  
9653 See @uref{https://github.com/google/autofdo}.
9655 E.g.
9656 @smallexample
9657 create_gcov --binary=your_program.unstripped --profile=perf.data \
9658     --gcov=profile.afdo
9659 @end smallexample
9660 @end table
9662 The following options control compiler behavior regarding floating-point 
9663 arithmetic.  These options trade off between speed and
9664 correctness.  All must be specifically enabled.
9666 @table @gcctabopt
9667 @item -ffloat-store
9668 @opindex ffloat-store
9669 Do not store floating-point variables in registers, and inhibit other
9670 options that might change whether a floating-point value is taken from a
9671 register or memory.
9673 @cindex floating-point precision
9674 This option prevents undesirable excess precision on machines such as
9675 the 68000 where the floating registers (of the 68881) keep more
9676 precision than a @code{double} is supposed to have.  Similarly for the
9677 x86 architecture.  For most programs, the excess precision does only
9678 good, but a few programs rely on the precise definition of IEEE floating
9679 point.  Use @option{-ffloat-store} for such programs, after modifying
9680 them to store all pertinent intermediate computations into variables.
9682 @item -fexcess-precision=@var{style}
9683 @opindex fexcess-precision
9684 This option allows further control over excess precision on machines
9685 where floating-point registers have more precision than the IEEE
9686 @code{float} and @code{double} types and the processor does not
9687 support operations rounding to those types.  By default,
9688 @option{-fexcess-precision=fast} is in effect; this means that
9689 operations are carried out in the precision of the registers and that
9690 it is unpredictable when rounding to the types specified in the source
9691 code takes place.  When compiling C, if
9692 @option{-fexcess-precision=standard} is specified then excess
9693 precision follows the rules specified in ISO C99; in particular,
9694 both casts and assignments cause values to be rounded to their
9695 semantic types (whereas @option{-ffloat-store} only affects
9696 assignments).  This option is enabled by default for C if a strict
9697 conformance option such as @option{-std=c99} is used.
9699 @opindex mfpmath
9700 @option{-fexcess-precision=standard} is not implemented for languages
9701 other than C, and has no effect if
9702 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9703 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9704 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9705 semantics apply without excess precision, and in the latter, rounding
9706 is unpredictable.
9708 @item -ffast-math
9709 @opindex ffast-math
9710 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9711 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9712 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9714 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9716 This option is not turned on by any @option{-O} option besides
9717 @option{-Ofast} since it can result in incorrect output for programs
9718 that depend on an exact implementation of IEEE or ISO rules/specifications
9719 for math functions. It may, however, yield faster code for programs
9720 that do not require the guarantees of these specifications.
9722 @item -fno-math-errno
9723 @opindex fno-math-errno
9724 Do not set @code{errno} after calling math functions that are executed
9725 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9726 IEEE exceptions for math error handling may want to use this flag
9727 for speed while maintaining IEEE arithmetic compatibility.
9729 This option is not turned on by any @option{-O} option since
9730 it can result in incorrect output for programs that depend on
9731 an exact implementation of IEEE or ISO rules/specifications for
9732 math functions. It may, however, yield faster code for programs
9733 that do not require the guarantees of these specifications.
9735 The default is @option{-fmath-errno}.
9737 On Darwin systems, the math library never sets @code{errno}.  There is
9738 therefore no reason for the compiler to consider the possibility that
9739 it might, and @option{-fno-math-errno} is the default.
9741 @item -funsafe-math-optimizations
9742 @opindex funsafe-math-optimizations
9744 Allow optimizations for floating-point arithmetic that (a) assume
9745 that arguments and results are valid and (b) may violate IEEE or
9746 ANSI standards.  When used at link-time, it may include libraries
9747 or startup files that change the default FPU control word or other
9748 similar optimizations.
9750 This option is not turned on by any @option{-O} option since
9751 it can result in incorrect output for programs that depend on
9752 an exact implementation of IEEE or ISO rules/specifications for
9753 math functions. It may, however, yield faster code for programs
9754 that do not require the guarantees of these specifications.
9755 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9756 @option{-fassociative-math} and @option{-freciprocal-math}.
9758 The default is @option{-fno-unsafe-math-optimizations}.
9760 @item -fassociative-math
9761 @opindex fassociative-math
9763 Allow re-association of operands in series of floating-point operations.
9764 This violates the ISO C and C++ language standard by possibly changing
9765 computation result.  NOTE: re-ordering may change the sign of zero as
9766 well as ignore NaNs and inhibit or create underflow or overflow (and
9767 thus cannot be used on code that relies on rounding behavior like
9768 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9769 and thus may not be used when ordered comparisons are required.
9770 This option requires that both @option{-fno-signed-zeros} and
9771 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9772 much sense with @option{-frounding-math}. For Fortran the option
9773 is automatically enabled when both @option{-fno-signed-zeros} and
9774 @option{-fno-trapping-math} are in effect.
9776 The default is @option{-fno-associative-math}.
9778 @item -freciprocal-math
9779 @opindex freciprocal-math
9781 Allow the reciprocal of a value to be used instead of dividing by
9782 the value if this enables optimizations.  For example @code{x / y}
9783 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9784 is subject to common subexpression elimination.  Note that this loses
9785 precision and increases the number of flops operating on the value.
9787 The default is @option{-fno-reciprocal-math}.
9789 @item -ffinite-math-only
9790 @opindex ffinite-math-only
9791 Allow optimizations for floating-point arithmetic that assume
9792 that arguments and results are not NaNs or +-Infs.
9794 This option is not turned on by any @option{-O} option since
9795 it can result in incorrect output for programs that depend on
9796 an exact implementation of IEEE or ISO rules/specifications for
9797 math functions. It may, however, yield faster code for programs
9798 that do not require the guarantees of these specifications.
9800 The default is @option{-fno-finite-math-only}.
9802 @item -fno-signed-zeros
9803 @opindex fno-signed-zeros
9804 Allow optimizations for floating-point arithmetic that ignore the
9805 signedness of zero.  IEEE arithmetic specifies the behavior of
9806 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9807 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9808 This option implies that the sign of a zero result isn't significant.
9810 The default is @option{-fsigned-zeros}.
9812 @item -fno-trapping-math
9813 @opindex fno-trapping-math
9814 Compile code assuming that floating-point operations cannot generate
9815 user-visible traps.  These traps include division by zero, overflow,
9816 underflow, inexact result and invalid operation.  This option requires
9817 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9818 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9820 This option should never be turned on by any @option{-O} option since
9821 it can result in incorrect output for programs that depend on
9822 an exact implementation of IEEE or ISO rules/specifications for
9823 math functions.
9825 The default is @option{-ftrapping-math}.
9827 @item -frounding-math
9828 @opindex frounding-math
9829 Disable transformations and optimizations that assume default floating-point
9830 rounding behavior.  This is round-to-zero for all floating point
9831 to integer conversions, and round-to-nearest for all other arithmetic
9832 truncations.  This option should be specified for programs that change
9833 the FP rounding mode dynamically, or that may be executed with a
9834 non-default rounding mode.  This option disables constant folding of
9835 floating-point expressions at compile time (which may be affected by
9836 rounding mode) and arithmetic transformations that are unsafe in the
9837 presence of sign-dependent rounding modes.
9839 The default is @option{-fno-rounding-math}.
9841 This option is experimental and does not currently guarantee to
9842 disable all GCC optimizations that are affected by rounding mode.
9843 Future versions of GCC may provide finer control of this setting
9844 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9845 will be used to specify the default state for @code{FENV_ACCESS}.
9847 @item -fsignaling-nans
9848 @opindex fsignaling-nans
9849 Compile code assuming that IEEE signaling NaNs may generate user-visible
9850 traps during floating-point operations.  Setting this option disables
9851 optimizations that may change the number of exceptions visible with
9852 signaling NaNs.  This option implies @option{-ftrapping-math}.
9854 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9855 be defined.
9857 The default is @option{-fno-signaling-nans}.
9859 This option is experimental and does not currently guarantee to
9860 disable all GCC optimizations that affect signaling NaN behavior.
9862 @item -fsingle-precision-constant
9863 @opindex fsingle-precision-constant
9864 Treat floating-point constants as single precision instead of
9865 implicitly converting them to double-precision constants.
9867 @item -fcx-limited-range
9868 @opindex fcx-limited-range
9869 When enabled, this option states that a range reduction step is not
9870 needed when performing complex division.  Also, there is no checking
9871 whether the result of a complex multiplication or division is @code{NaN
9872 + I*NaN}, with an attempt to rescue the situation in that case.  The
9873 default is @option{-fno-cx-limited-range}, but is enabled by
9874 @option{-ffast-math}.
9876 This option controls the default setting of the ISO C99
9877 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9878 all languages.
9880 @item -fcx-fortran-rules
9881 @opindex fcx-fortran-rules
9882 Complex multiplication and division follow Fortran rules.  Range
9883 reduction is done as part of complex division, but there is no checking
9884 whether the result of a complex multiplication or division is @code{NaN
9885 + I*NaN}, with an attempt to rescue the situation in that case.
9887 The default is @option{-fno-cx-fortran-rules}.
9889 @end table
9891 The following options control optimizations that may improve
9892 performance, but are not enabled by any @option{-O} options.  This
9893 section includes experimental options that may produce broken code.
9895 @table @gcctabopt
9896 @item -fbranch-probabilities
9897 @opindex fbranch-probabilities
9898 After running a program compiled with @option{-fprofile-arcs}
9899 (@pxref{Debugging Options,, Options for Debugging Your Program or
9900 @command{gcc}}), you can compile it a second time using
9901 @option{-fbranch-probabilities}, to improve optimizations based on
9902 the number of times each branch was taken.  When a program
9903 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9904 counts to a file called @file{@var{sourcename}.gcda} for each source
9905 file.  The information in this data file is very dependent on the
9906 structure of the generated code, so you must use the same source code
9907 and the same optimization options for both compilations.
9909 With @option{-fbranch-probabilities}, GCC puts a
9910 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9911 These can be used to improve optimization.  Currently, they are only
9912 used in one place: in @file{reorg.c}, instead of guessing which path a
9913 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9914 exactly determine which path is taken more often.
9916 @item -fprofile-values
9917 @opindex fprofile-values
9918 If combined with @option{-fprofile-arcs}, it adds code so that some
9919 data about values of expressions in the program is gathered.
9921 With @option{-fbranch-probabilities}, it reads back the data gathered
9922 from profiling values of expressions for usage in optimizations.
9924 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9926 @item -fprofile-reorder-functions
9927 @opindex fprofile-reorder-functions
9928 Function reordering based on profile instrumentation collects
9929 first time of execution of a function and orders these functions
9930 in ascending order.
9932 Enabled with @option{-fprofile-use}.
9934 @item -fvpt
9935 @opindex fvpt
9936 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9937 to add code to gather information about values of expressions.
9939 With @option{-fbranch-probabilities}, it reads back the data gathered
9940 and actually performs the optimizations based on them.
9941 Currently the optimizations include specialization of division operations
9942 using the knowledge about the value of the denominator.
9944 @item -frename-registers
9945 @opindex frename-registers
9946 Attempt to avoid false dependencies in scheduled code by making use
9947 of registers left over after register allocation.  This optimization
9948 most benefits processors with lots of registers.  Depending on the
9949 debug information format adopted by the target, however, it can
9950 make debugging impossible, since variables no longer stay in
9951 a ``home register''.
9953 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9955 @item -fschedule-fusion
9956 @opindex fschedule-fusion
9957 Performs a target dependent pass over the instruction stream to schedule
9958 instructions of same type together because target machine can execute them
9959 more efficiently if they are adjacent to each other in the instruction flow.
9961 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9963 @item -ftracer
9964 @opindex ftracer
9965 Perform tail duplication to enlarge superblock size.  This transformation
9966 simplifies the control flow of the function allowing other optimizations to do
9967 a better job.
9969 Enabled with @option{-fprofile-use}.
9971 @item -funroll-loops
9972 @opindex funroll-loops
9973 Unroll loops whose number of iterations can be determined at compile time or
9974 upon entry to the loop.  @option{-funroll-loops} implies
9975 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9976 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9977 a small constant number of iterations).  This option makes code larger, and may
9978 or may not make it run faster.
9980 Enabled with @option{-fprofile-use}.
9982 @item -funroll-all-loops
9983 @opindex funroll-all-loops
9984 Unroll all loops, even if their number of iterations is uncertain when
9985 the loop is entered.  This usually makes programs run more slowly.
9986 @option{-funroll-all-loops} implies the same options as
9987 @option{-funroll-loops}.
9989 @item -fpeel-loops
9990 @opindex fpeel-loops
9991 Peels loops for which there is enough information that they do not
9992 roll much (from profile feedback).  It also turns on complete loop peeling
9993 (i.e.@: complete removal of loops with small constant number of iterations).
9995 Enabled with @option{-fprofile-use}.
9997 @item -fmove-loop-invariants
9998 @opindex fmove-loop-invariants
9999 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10000 at level @option{-O1}
10002 @item -funswitch-loops
10003 @opindex funswitch-loops
10004 Move branches with loop invariant conditions out of the loop, with duplicates
10005 of the loop on both branches (modified according to result of the condition).
10007 @item -ffunction-sections
10008 @itemx -fdata-sections
10009 @opindex ffunction-sections
10010 @opindex fdata-sections
10011 Place each function or data item into its own section in the output
10012 file if the target supports arbitrary sections.  The name of the
10013 function or the name of the data item determines the section's name
10014 in the output file.
10016 Use these options on systems where the linker can perform optimizations
10017 to improve locality of reference in the instruction space.  Most systems
10018 using the ELF object format and SPARC processors running Solaris 2 have
10019 linkers with such optimizations.  AIX may have these optimizations in
10020 the future.
10022 Only use these options when there are significant benefits from doing
10023 so.  When you specify these options, the assembler and linker
10024 create larger object and executable files and are also slower.
10025 You cannot use @command{gprof} on all systems if you
10026 specify this option, and you may have problems with debugging if
10027 you specify both this option and @option{-g}.
10029 @item -fbranch-target-load-optimize
10030 @opindex fbranch-target-load-optimize
10031 Perform branch target register load optimization before prologue / epilogue
10032 threading.
10033 The use of target registers can typically be exposed only during reload,
10034 thus hoisting loads out of loops and doing inter-block scheduling needs
10035 a separate optimization pass.
10037 @item -fbranch-target-load-optimize2
10038 @opindex fbranch-target-load-optimize2
10039 Perform branch target register load optimization after prologue / epilogue
10040 threading.
10042 @item -fbtr-bb-exclusive
10043 @opindex fbtr-bb-exclusive
10044 When performing branch target register load optimization, don't reuse
10045 branch target registers within any basic block.
10047 @item -fstack-protector
10048 @opindex fstack-protector
10049 Emit extra code to check for buffer overflows, such as stack smashing
10050 attacks.  This is done by adding a guard variable to functions with
10051 vulnerable objects.  This includes functions that call @code{alloca}, and
10052 functions with buffers larger than 8 bytes.  The guards are initialized
10053 when a function is entered and then checked when the function exits.
10054 If a guard check fails, an error message is printed and the program exits.
10056 @item -fstack-protector-all
10057 @opindex fstack-protector-all
10058 Like @option{-fstack-protector} except that all functions are protected.
10060 @item -fstack-protector-strong
10061 @opindex fstack-protector-strong
10062 Like @option{-fstack-protector} but includes additional functions to
10063 be protected --- those that have local array definitions, or have
10064 references to local frame addresses.
10066 @item -fstack-protector-explicit
10067 @opindex fstack-protector-explicit
10068 Like @option{-fstack-protector} but only protects those functions which
10069 have the @code{stack_protect} attribute
10071 @item -fstdarg-opt
10072 @opindex fstdarg-opt
10073 Optimize the prologue of variadic argument functions with respect to usage of
10074 those arguments.
10076 @item -fsection-anchors
10077 @opindex fsection-anchors
10078 Try to reduce the number of symbolic address calculations by using
10079 shared ``anchor'' symbols to address nearby objects.  This transformation
10080 can help to reduce the number of GOT entries and GOT accesses on some
10081 targets.
10083 For example, the implementation of the following function @code{foo}:
10085 @smallexample
10086 static int a, b, c;
10087 int foo (void) @{ return a + b + c; @}
10088 @end smallexample
10090 @noindent
10091 usually calculates the addresses of all three variables, but if you
10092 compile it with @option{-fsection-anchors}, it accesses the variables
10093 from a common anchor point instead.  The effect is similar to the
10094 following pseudocode (which isn't valid C):
10096 @smallexample
10097 int foo (void)
10099   register int *xr = &x;
10100   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10102 @end smallexample
10104 Not all targets support this option.
10106 @item --param @var{name}=@var{value}
10107 @opindex param
10108 In some places, GCC uses various constants to control the amount of
10109 optimization that is done.  For example, GCC does not inline functions
10110 that contain more than a certain number of instructions.  You can
10111 control some of these constants on the command line using the
10112 @option{--param} option.
10114 The names of specific parameters, and the meaning of the values, are
10115 tied to the internals of the compiler, and are subject to change
10116 without notice in future releases.
10118 In each case, the @var{value} is an integer.  The allowable choices for
10119 @var{name} are:
10121 @table @gcctabopt
10122 @item predictable-branch-outcome
10123 When branch is predicted to be taken with probability lower than this threshold
10124 (in percent), then it is considered well predictable. The default is 10.
10126 @item max-crossjump-edges
10127 The maximum number of incoming edges to consider for cross-jumping.
10128 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10129 the number of edges incoming to each block.  Increasing values mean
10130 more aggressive optimization, making the compilation time increase with
10131 probably small improvement in executable size.
10133 @item min-crossjump-insns
10134 The minimum number of instructions that must be matched at the end
10135 of two blocks before cross-jumping is performed on them.  This
10136 value is ignored in the case where all instructions in the block being
10137 cross-jumped from are matched.  The default value is 5.
10139 @item max-grow-copy-bb-insns
10140 The maximum code size expansion factor when copying basic blocks
10141 instead of jumping.  The expansion is relative to a jump instruction.
10142 The default value is 8.
10144 @item max-goto-duplication-insns
10145 The maximum number of instructions to duplicate to a block that jumps
10146 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10147 passes, GCC factors computed gotos early in the compilation process,
10148 and unfactors them as late as possible.  Only computed jumps at the
10149 end of a basic blocks with no more than max-goto-duplication-insns are
10150 unfactored.  The default value is 8.
10152 @item max-delay-slot-insn-search
10153 The maximum number of instructions to consider when looking for an
10154 instruction to fill a delay slot.  If more than this arbitrary number of
10155 instructions are searched, the time savings from filling the delay slot
10156 are minimal, so stop searching.  Increasing values mean more
10157 aggressive optimization, making the compilation time increase with probably
10158 small improvement in execution time.
10160 @item max-delay-slot-live-search
10161 When trying to fill delay slots, the maximum number of instructions to
10162 consider when searching for a block with valid live register
10163 information.  Increasing this arbitrarily chosen value means more
10164 aggressive optimization, increasing the compilation time.  This parameter
10165 should be removed when the delay slot code is rewritten to maintain the
10166 control-flow graph.
10168 @item max-gcse-memory
10169 The approximate maximum amount of memory that can be allocated in
10170 order to perform the global common subexpression elimination
10171 optimization.  If more memory than specified is required, the
10172 optimization is not done.
10174 @item max-gcse-insertion-ratio
10175 If the ratio of expression insertions to deletions is larger than this value
10176 for any expression, then RTL PRE inserts or removes the expression and thus
10177 leaves partially redundant computations in the instruction stream.  The default value is 20.
10179 @item max-pending-list-length
10180 The maximum number of pending dependencies scheduling allows
10181 before flushing the current state and starting over.  Large functions
10182 with few branches or calls can create excessively large lists which
10183 needlessly consume memory and resources.
10185 @item max-modulo-backtrack-attempts
10186 The maximum number of backtrack attempts the scheduler should make
10187 when modulo scheduling a loop.  Larger values can exponentially increase
10188 compilation time.
10190 @item max-inline-insns-single
10191 Several parameters control the tree inliner used in GCC@.
10192 This number sets the maximum number of instructions (counted in GCC's
10193 internal representation) in a single function that the tree inliner
10194 considers for inlining.  This only affects functions declared
10195 inline and methods implemented in a class declaration (C++).
10196 The default value is 400.
10198 @item max-inline-insns-auto
10199 When you use @option{-finline-functions} (included in @option{-O3}),
10200 a lot of functions that would otherwise not be considered for inlining
10201 by the compiler are investigated.  To those functions, a different
10202 (more restrictive) limit compared to functions declared inline can
10203 be applied.
10204 The default value is 40.
10206 @item inline-min-speedup
10207 When estimated performance improvement of caller + callee runtime exceeds this
10208 threshold (in precent), the function can be inlined regardless the limit on
10209 @option{--param max-inline-insns-single} and @option{--param
10210 max-inline-insns-auto}.
10212 @item large-function-insns
10213 The limit specifying really large functions.  For functions larger than this
10214 limit after inlining, inlining is constrained by
10215 @option{--param large-function-growth}.  This parameter is useful primarily
10216 to avoid extreme compilation time caused by non-linear algorithms used by the
10217 back end.
10218 The default value is 2700.
10220 @item large-function-growth
10221 Specifies maximal growth of large function caused by inlining in percents.
10222 The default value is 100 which limits large function growth to 2.0 times
10223 the original size.
10225 @item large-unit-insns
10226 The limit specifying large translation unit.  Growth caused by inlining of
10227 units larger than this limit is limited by @option{--param inline-unit-growth}.
10228 For small units this might be too tight.
10229 For example, consider a unit consisting of function A
10230 that is inline and B that just calls A three times.  If B is small relative to
10231 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10232 large units consisting of small inlineable functions, however, the overall unit
10233 growth limit is needed to avoid exponential explosion of code size.  Thus for
10234 smaller units, the size is increased to @option{--param large-unit-insns}
10235 before applying @option{--param inline-unit-growth}.  The default is 10000.
10237 @item inline-unit-growth
10238 Specifies maximal overall growth of the compilation unit caused by inlining.
10239 The default value is 20 which limits unit growth to 1.2 times the original
10240 size. Cold functions (either marked cold via an attribute or by profile
10241 feedback) are not accounted into the unit size.
10243 @item ipcp-unit-growth
10244 Specifies maximal overall growth of the compilation unit caused by
10245 interprocedural constant propagation.  The default value is 10 which limits
10246 unit growth to 1.1 times the original size.
10248 @item large-stack-frame
10249 The limit specifying large stack frames.  While inlining the algorithm is trying
10250 to not grow past this limit too much.  The default value is 256 bytes.
10252 @item large-stack-frame-growth
10253 Specifies maximal growth of large stack frames caused by inlining in percents.
10254 The default value is 1000 which limits large stack frame growth to 11 times
10255 the original size.
10257 @item max-inline-insns-recursive
10258 @itemx max-inline-insns-recursive-auto
10259 Specifies the maximum number of instructions an out-of-line copy of a
10260 self-recursive inline
10261 function can grow into by performing recursive inlining.
10263 @option{--param max-inline-insns-recursive} applies to functions
10264 declared inline.
10265 For functions not declared inline, recursive inlining
10266 happens only when @option{-finline-functions} (included in @option{-O3}) is
10267 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10268 default value is 450.
10270 @item max-inline-recursive-depth
10271 @itemx max-inline-recursive-depth-auto
10272 Specifies the maximum recursion depth used for recursive inlining.
10274 @option{--param max-inline-recursive-depth} applies to functions
10275 declared inline.  For functions not declared inline, recursive inlining
10276 happens only when @option{-finline-functions} (included in @option{-O3}) is
10277 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10278 default value is 8.
10280 @item min-inline-recursive-probability
10281 Recursive inlining is profitable only for function having deep recursion
10282 in average and can hurt for function having little recursion depth by
10283 increasing the prologue size or complexity of function body to other
10284 optimizers.
10286 When profile feedback is available (see @option{-fprofile-generate}) the actual
10287 recursion depth can be guessed from probability that function recurses via a
10288 given call expression.  This parameter limits inlining only to call expressions
10289 whose probability exceeds the given threshold (in percents).
10290 The default value is 10.
10292 @item early-inlining-insns
10293 Specify growth that the early inliner can make.  In effect it increases
10294 the amount of inlining for code having a large abstraction penalty.
10295 The default value is 14.
10297 @item max-early-inliner-iterations
10298 Limit of iterations of the early inliner.  This basically bounds
10299 the number of nested indirect calls the early inliner can resolve.
10300 Deeper chains are still handled by late inlining.
10302 @item comdat-sharing-probability
10303 Probability (in percent) that C++ inline function with comdat visibility
10304 are shared across multiple compilation units.  The default value is 20.
10306 @item profile-func-internal-id
10307 A parameter to control whether to use function internal id in profile
10308 database lookup. If the value is 0, the compiler uses an id that
10309 is based on function assembler name and filename, which makes old profile
10310 data more tolerant to source changes such as function reordering etc.
10311 The default value is 0.
10313 @item min-vect-loop-bound
10314 The minimum number of iterations under which loops are not vectorized
10315 when @option{-ftree-vectorize} is used.  The number of iterations after
10316 vectorization needs to be greater than the value specified by this option
10317 to allow vectorization.  The default value is 0.
10319 @item gcse-cost-distance-ratio
10320 Scaling factor in calculation of maximum distance an expression
10321 can be moved by GCSE optimizations.  This is currently supported only in the
10322 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10323 is with simple expressions, i.e., the expressions that have cost
10324 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10325 hoisting of simple expressions.  The default value is 10.
10327 @item gcse-unrestricted-cost
10328 Cost, roughly measured as the cost of a single typical machine
10329 instruction, at which GCSE optimizations do not constrain
10330 the distance an expression can travel.  This is currently
10331 supported only in the code hoisting pass.  The lesser the cost,
10332 the more aggressive code hoisting is.  Specifying 0 
10333 allows all expressions to travel unrestricted distances.
10334 The default value is 3.
10336 @item max-hoist-depth
10337 The depth of search in the dominator tree for expressions to hoist.
10338 This is used to avoid quadratic behavior in hoisting algorithm.
10339 The value of 0 does not limit on the search, but may slow down compilation
10340 of huge functions.  The default value is 30.
10342 @item max-tail-merge-comparisons
10343 The maximum amount of similar bbs to compare a bb with.  This is used to
10344 avoid quadratic behavior in tree tail merging.  The default value is 10.
10346 @item max-tail-merge-iterations
10347 The maximum amount of iterations of the pass over the function.  This is used to
10348 limit compilation time in tree tail merging.  The default value is 2.
10350 @item max-unrolled-insns
10351 The maximum number of instructions that a loop may have to be unrolled.
10352 If a loop is unrolled, this parameter also determines how many times
10353 the loop code is unrolled.
10355 @item max-average-unrolled-insns
10356 The maximum number of instructions biased by probabilities of their execution
10357 that a loop may have to be unrolled.  If a loop is unrolled,
10358 this parameter also determines how many times the loop code is unrolled.
10360 @item max-unroll-times
10361 The maximum number of unrollings of a single loop.
10363 @item max-peeled-insns
10364 The maximum number of instructions that a loop may have to be peeled.
10365 If a loop is peeled, this parameter also determines how many times
10366 the loop code is peeled.
10368 @item max-peel-times
10369 The maximum number of peelings of a single loop.
10371 @item max-peel-branches
10372 The maximum number of branches on the hot path through the peeled sequence.
10374 @item max-completely-peeled-insns
10375 The maximum number of insns of a completely peeled loop.
10377 @item max-completely-peel-times
10378 The maximum number of iterations of a loop to be suitable for complete peeling.
10380 @item max-completely-peel-loop-nest-depth
10381 The maximum depth of a loop nest suitable for complete peeling.
10383 @item max-unswitch-insns
10384 The maximum number of insns of an unswitched loop.
10386 @item max-unswitch-level
10387 The maximum number of branches unswitched in a single loop.
10389 @item lim-expensive
10390 The minimum cost of an expensive expression in the loop invariant motion.
10392 @item iv-consider-all-candidates-bound
10393 Bound on number of candidates for induction variables, below which
10394 all candidates are considered for each use in induction variable
10395 optimizations.  If there are more candidates than this,
10396 only the most relevant ones are considered to avoid quadratic time complexity.
10398 @item iv-max-considered-uses
10399 The induction variable optimizations give up on loops that contain more
10400 induction variable uses.
10402 @item iv-always-prune-cand-set-bound
10403 If the number of candidates in the set is smaller than this value,
10404 always try to remove unnecessary ivs from the set
10405 when adding a new one.
10407 @item scev-max-expr-size
10408 Bound on size of expressions used in the scalar evolutions analyzer.
10409 Large expressions slow the analyzer.
10411 @item scev-max-expr-complexity
10412 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10413 Complex expressions slow the analyzer.
10415 @item vect-max-version-for-alignment-checks
10416 The maximum number of run-time checks that can be performed when
10417 doing loop versioning for alignment in the vectorizer.
10419 @item vect-max-version-for-alias-checks
10420 The maximum number of run-time checks that can be performed when
10421 doing loop versioning for alias in the vectorizer.
10423 @item vect-max-peeling-for-alignment
10424 The maximum number of loop peels to enhance access alignment
10425 for vectorizer. Value -1 means 'no limit'.
10427 @item max-iterations-to-track
10428 The maximum number of iterations of a loop the brute-force algorithm
10429 for analysis of the number of iterations of the loop tries to evaluate.
10431 @item hot-bb-count-ws-permille
10432 A basic block profile count is considered hot if it contributes to 
10433 the given permillage (i.e. 0...1000) of the entire profiled execution.
10435 @item hot-bb-frequency-fraction
10436 Select fraction of the entry block frequency of executions of basic block in
10437 function given basic block needs to have to be considered hot.
10439 @item max-predicted-iterations
10440 The maximum number of loop iterations we predict statically.  This is useful
10441 in cases where a function contains a single loop with known bound and
10442 another loop with unknown bound.
10443 The known number of iterations is predicted correctly, while
10444 the unknown number of iterations average to roughly 10.  This means that the
10445 loop without bounds appears artificially cold relative to the other one.
10447 @item builtin-expect-probability
10448 Control the probability of the expression having the specified value. This
10449 parameter takes a percentage (i.e. 0 ... 100) as input.
10450 The default probability of 90 is obtained empirically.
10452 @item align-threshold
10454 Select fraction of the maximal frequency of executions of a basic block in
10455 a function to align the basic block.
10457 @item align-loop-iterations
10459 A loop expected to iterate at least the selected number of iterations is
10460 aligned.
10462 @item tracer-dynamic-coverage
10463 @itemx tracer-dynamic-coverage-feedback
10465 This value is used to limit superblock formation once the given percentage of
10466 executed instructions is covered.  This limits unnecessary code size
10467 expansion.
10469 The @option{tracer-dynamic-coverage-feedback} parameter
10470 is used only when profile
10471 feedback is available.  The real profiles (as opposed to statically estimated
10472 ones) are much less balanced allowing the threshold to be larger value.
10474 @item tracer-max-code-growth
10475 Stop tail duplication once code growth has reached given percentage.  This is
10476 a rather artificial limit, as most of the duplicates are eliminated later in
10477 cross jumping, so it may be set to much higher values than is the desired code
10478 growth.
10480 @item tracer-min-branch-ratio
10482 Stop reverse growth when the reverse probability of best edge is less than this
10483 threshold (in percent).
10485 @item tracer-min-branch-ratio
10486 @itemx tracer-min-branch-ratio-feedback
10488 Stop forward growth if the best edge has probability lower than this
10489 threshold.
10491 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10492 compilation for profile feedback and one for compilation without.  The value
10493 for compilation with profile feedback needs to be more conservative (higher) in
10494 order to make tracer effective.
10496 @item max-cse-path-length
10498 The maximum number of basic blocks on path that CSE considers.
10499 The default is 10.
10501 @item max-cse-insns
10502 The maximum number of instructions CSE processes before flushing.
10503 The default is 1000.
10505 @item ggc-min-expand
10507 GCC uses a garbage collector to manage its own memory allocation.  This
10508 parameter specifies the minimum percentage by which the garbage
10509 collector's heap should be allowed to expand between collections.
10510 Tuning this may improve compilation speed; it has no effect on code
10511 generation.
10513 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10514 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10515 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10516 GCC is not able to calculate RAM on a particular platform, the lower
10517 bound of 30% is used.  Setting this parameter and
10518 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10519 every opportunity.  This is extremely slow, but can be useful for
10520 debugging.
10522 @item ggc-min-heapsize
10524 Minimum size of the garbage collector's heap before it begins bothering
10525 to collect garbage.  The first collection occurs after the heap expands
10526 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10527 tuning this may improve compilation speed, and has no effect on code
10528 generation.
10530 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10531 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10532 with a lower bound of 4096 (four megabytes) and an upper bound of
10533 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10534 particular platform, the lower bound is used.  Setting this parameter
10535 very large effectively disables garbage collection.  Setting this
10536 parameter and @option{ggc-min-expand} to zero causes a full collection
10537 to occur at every opportunity.
10539 @item max-reload-search-insns
10540 The maximum number of instruction reload should look backward for equivalent
10541 register.  Increasing values mean more aggressive optimization, making the
10542 compilation time increase with probably slightly better performance.
10543 The default value is 100.
10545 @item max-cselib-memory-locations
10546 The maximum number of memory locations cselib should take into account.
10547 Increasing values mean more aggressive optimization, making the compilation time
10548 increase with probably slightly better performance.  The default value is 500.
10550 @item reorder-blocks-duplicate
10551 @itemx reorder-blocks-duplicate-feedback
10553 Used by the basic block reordering pass to decide whether to use unconditional
10554 branch or duplicate the code on its destination.  Code is duplicated when its
10555 estimated size is smaller than this value multiplied by the estimated size of
10556 unconditional jump in the hot spots of the program.
10558 The @option{reorder-block-duplicate-feedback} parameter
10559 is used only when profile
10560 feedback is available.  It may be set to higher values than
10561 @option{reorder-block-duplicate} since information about the hot spots is more
10562 accurate.
10564 @item max-sched-ready-insns
10565 The maximum number of instructions ready to be issued the scheduler should
10566 consider at any given time during the first scheduling pass.  Increasing
10567 values mean more thorough searches, making the compilation time increase
10568 with probably little benefit.  The default value is 100.
10570 @item max-sched-region-blocks
10571 The maximum number of blocks in a region to be considered for
10572 interblock scheduling.  The default value is 10.
10574 @item max-pipeline-region-blocks
10575 The maximum number of blocks in a region to be considered for
10576 pipelining in the selective scheduler.  The default value is 15.
10578 @item max-sched-region-insns
10579 The maximum number of insns in a region to be considered for
10580 interblock scheduling.  The default value is 100.
10582 @item max-pipeline-region-insns
10583 The maximum number of insns in a region to be considered for
10584 pipelining in the selective scheduler.  The default value is 200.
10586 @item min-spec-prob
10587 The minimum probability (in percents) of reaching a source block
10588 for interblock speculative scheduling.  The default value is 40.
10590 @item max-sched-extend-regions-iters
10591 The maximum number of iterations through CFG to extend regions.
10592 A value of 0 (the default) disables region extensions.
10594 @item max-sched-insn-conflict-delay
10595 The maximum conflict delay for an insn to be considered for speculative motion.
10596 The default value is 3.
10598 @item sched-spec-prob-cutoff
10599 The minimal probability of speculation success (in percents), so that
10600 speculative insns are scheduled.
10601 The default value is 40.
10603 @item sched-spec-state-edge-prob-cutoff
10604 The minimum probability an edge must have for the scheduler to save its
10605 state across it.
10606 The default value is 10.
10608 @item sched-mem-true-dep-cost
10609 Minimal distance (in CPU cycles) between store and load targeting same
10610 memory locations.  The default value is 1.
10612 @item selsched-max-lookahead
10613 The maximum size of the lookahead window of selective scheduling.  It is a
10614 depth of search for available instructions.
10615 The default value is 50.
10617 @item selsched-max-sched-times
10618 The maximum number of times that an instruction is scheduled during
10619 selective scheduling.  This is the limit on the number of iterations
10620 through which the instruction may be pipelined.  The default value is 2.
10622 @item selsched-max-insns-to-rename
10623 The maximum number of best instructions in the ready list that are considered
10624 for renaming in the selective scheduler.  The default value is 2.
10626 @item sms-min-sc
10627 The minimum value of stage count that swing modulo scheduler
10628 generates.  The default value is 2.
10630 @item max-last-value-rtl
10631 The maximum size measured as number of RTLs that can be recorded in an expression
10632 in combiner for a pseudo register as last known value of that register.  The default
10633 is 10000.
10635 @item max-combine-insns
10636 The maximum number of instructions the RTL combiner tries to combine.
10637 The default value is 2 at @option{-Og} and 4 otherwise.
10639 @item integer-share-limit
10640 Small integer constants can use a shared data structure, reducing the
10641 compiler's memory usage and increasing its speed.  This sets the maximum
10642 value of a shared integer constant.  The default value is 256.
10644 @item ssp-buffer-size
10645 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10646 protection when @option{-fstack-protection} is used.
10648 @item min-size-for-stack-sharing
10649 The minimum size of variables taking part in stack slot sharing when not
10650 optimizing. The default value is 32.
10652 @item max-jump-thread-duplication-stmts
10653 Maximum number of statements allowed in a block that needs to be
10654 duplicated when threading jumps.
10656 @item max-fields-for-field-sensitive
10657 Maximum number of fields in a structure treated in
10658 a field sensitive manner during pointer analysis.  The default is zero
10659 for @option{-O0} and @option{-O1},
10660 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10662 @item prefetch-latency
10663 Estimate on average number of instructions that are executed before
10664 prefetch finishes.  The distance prefetched ahead is proportional
10665 to this constant.  Increasing this number may also lead to less
10666 streams being prefetched (see @option{simultaneous-prefetches}).
10668 @item simultaneous-prefetches
10669 Maximum number of prefetches that can run at the same time.
10671 @item l1-cache-line-size
10672 The size of cache line in L1 cache, in bytes.
10674 @item l1-cache-size
10675 The size of L1 cache, in kilobytes.
10677 @item l2-cache-size
10678 The size of L2 cache, in kilobytes.
10680 @item min-insn-to-prefetch-ratio
10681 The minimum ratio between the number of instructions and the
10682 number of prefetches to enable prefetching in a loop.
10684 @item prefetch-min-insn-to-mem-ratio
10685 The minimum ratio between the number of instructions and the
10686 number of memory references to enable prefetching in a loop.
10688 @item use-canonical-types
10689 Whether the compiler should use the ``canonical'' type system.  By
10690 default, this should always be 1, which uses a more efficient internal
10691 mechanism for comparing types in C++ and Objective-C++.  However, if
10692 bugs in the canonical type system are causing compilation failures,
10693 set this value to 0 to disable canonical types.
10695 @item switch-conversion-max-branch-ratio
10696 Switch initialization conversion refuses to create arrays that are
10697 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10698 branches in the switch.
10700 @item max-partial-antic-length
10701 Maximum length of the partial antic set computed during the tree
10702 partial redundancy elimination optimization (@option{-ftree-pre}) when
10703 optimizing at @option{-O3} and above.  For some sorts of source code
10704 the enhanced partial redundancy elimination optimization can run away,
10705 consuming all of the memory available on the host machine.  This
10706 parameter sets a limit on the length of the sets that are computed,
10707 which prevents the runaway behavior.  Setting a value of 0 for
10708 this parameter allows an unlimited set length.
10710 @item sccvn-max-scc-size
10711 Maximum size of a strongly connected component (SCC) during SCCVN
10712 processing.  If this limit is hit, SCCVN processing for the whole
10713 function is not done and optimizations depending on it are
10714 disabled.  The default maximum SCC size is 10000.
10716 @item sccvn-max-alias-queries-per-access
10717 Maximum number of alias-oracle queries we perform when looking for
10718 redundancies for loads and stores.  If this limit is hit the search
10719 is aborted and the load or store is not considered redundant.  The
10720 number of queries is algorithmically limited to the number of
10721 stores on all paths from the load to the function entry.
10722 The default maxmimum number of queries is 1000.
10724 @item ira-max-loops-num
10725 IRA uses regional register allocation by default.  If a function
10726 contains more loops than the number given by this parameter, only at most
10727 the given number of the most frequently-executed loops form regions
10728 for regional register allocation.  The default value of the
10729 parameter is 100.
10731 @item ira-max-conflict-table-size 
10732 Although IRA uses a sophisticated algorithm to compress the conflict
10733 table, the table can still require excessive amounts of memory for
10734 huge functions.  If the conflict table for a function could be more
10735 than the size in MB given by this parameter, the register allocator
10736 instead uses a faster, simpler, and lower-quality
10737 algorithm that does not require building a pseudo-register conflict table.  
10738 The default value of the parameter is 2000.
10740 @item ira-loop-reserved-regs
10741 IRA can be used to evaluate more accurate register pressure in loops
10742 for decisions to move loop invariants (see @option{-O3}).  The number
10743 of available registers reserved for some other purposes is given
10744 by this parameter.  The default value of the parameter is 2, which is
10745 the minimal number of registers needed by typical instructions.
10746 This value is the best found from numerous experiments.
10748 @item lra-inheritance-ebb-probability-cutoff
10749 LRA tries to reuse values reloaded in registers in subsequent insns.
10750 This optimization is called inheritance.  EBB is used as a region to
10751 do this optimization.  The parameter defines a minimal fall-through
10752 edge probability in percentage used to add BB to inheritance EBB in
10753 LRA.  The default value of the parameter is 40.  The value was chosen
10754 from numerous runs of SPEC2000 on x86-64.
10756 @item loop-invariant-max-bbs-in-loop
10757 Loop invariant motion can be very expensive, both in compilation time and
10758 in amount of needed compile-time memory, with very large loops.  Loops
10759 with more basic blocks than this parameter won't have loop invariant
10760 motion optimization performed on them.  The default value of the
10761 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10763 @item loop-max-datarefs-for-datadeps
10764 Building data dapendencies is expensive for very large loops.  This
10765 parameter limits the number of data references in loops that are
10766 considered for data dependence analysis.  These large loops are no
10767 handled by the optimizations using loop data dependencies.
10768 The default value is 1000.
10770 @item max-vartrack-size
10771 Sets a maximum number of hash table slots to use during variable
10772 tracking dataflow analysis of any function.  If this limit is exceeded
10773 with variable tracking at assignments enabled, analysis for that
10774 function is retried without it, after removing all debug insns from
10775 the function.  If the limit is exceeded even without debug insns, var
10776 tracking analysis is completely disabled for the function.  Setting
10777 the parameter to zero makes it unlimited.
10779 @item max-vartrack-expr-depth
10780 Sets a maximum number of recursion levels when attempting to map
10781 variable names or debug temporaries to value expressions.  This trades
10782 compilation time for more complete debug information.  If this is set too
10783 low, value expressions that are available and could be represented in
10784 debug information may end up not being used; setting this higher may
10785 enable the compiler to find more complex debug expressions, but compile
10786 time and memory use may grow.  The default is 12.
10788 @item min-nondebug-insn-uid
10789 Use uids starting at this parameter for nondebug insns.  The range below
10790 the parameter is reserved exclusively for debug insns created by
10791 @option{-fvar-tracking-assignments}, but debug insns may get
10792 (non-overlapping) uids above it if the reserved range is exhausted.
10794 @item ipa-sra-ptr-growth-factor
10795 IPA-SRA replaces a pointer to an aggregate with one or more new
10796 parameters only when their cumulative size is less or equal to
10797 @option{ipa-sra-ptr-growth-factor} times the size of the original
10798 pointer parameter.
10800 @item sra-max-scalarization-size-Ospeed
10801 @item sra-max-scalarization-size-Osize
10802 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10803 replace scalar parts of aggregates with uses of independent scalar
10804 variables.  These parameters control the maximum size, in storage units,
10805 of aggregate which is considered for replacement when compiling for
10806 speed
10807 (@option{sra-max-scalarization-size-Ospeed}) or size
10808 (@option{sra-max-scalarization-size-Osize}) respectively.
10810 @item tm-max-aggregate-size
10811 When making copies of thread-local variables in a transaction, this
10812 parameter specifies the size in bytes after which variables are
10813 saved with the logging functions as opposed to save/restore code
10814 sequence pairs.  This option only applies when using
10815 @option{-fgnu-tm}.
10817 @item graphite-max-nb-scop-params
10818 To avoid exponential effects in the Graphite loop transforms, the
10819 number of parameters in a Static Control Part (SCoP) is bounded.  The
10820 default value is 10 parameters.  A variable whose value is unknown at
10821 compilation time and defined outside a SCoP is a parameter of the SCoP.
10823 @item graphite-max-bbs-per-function
10824 To avoid exponential effects in the detection of SCoPs, the size of
10825 the functions analyzed by Graphite is bounded.  The default value is
10826 100 basic blocks.
10828 @item loop-block-tile-size
10829 Loop blocking or strip mining transforms, enabled with
10830 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10831 loop in the loop nest by a given number of iterations.  The strip
10832 length can be changed using the @option{loop-block-tile-size}
10833 parameter.  The default value is 51 iterations.
10835 @item loop-unroll-jam-size
10836 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10837 default value is 4.
10839 @item loop-unroll-jam-depth
10840 Specify the dimension to be unrolled (counting from the most inner loop)
10841 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10843 @item ipa-cp-value-list-size
10844 IPA-CP attempts to track all possible values and types passed to a function's
10845 parameter in order to propagate them and perform devirtualization.
10846 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10847 stores per one formal parameter of a function.
10849 @item ipa-cp-eval-threshold
10850 IPA-CP calculates its own score of cloning profitability heuristics
10851 and performs those cloning opportunities with scores that exceed
10852 @option{ipa-cp-eval-threshold}.
10854 @item ipa-cp-recursion-penalty
10855 Percentage penalty the recursive functions will receive when they
10856 are evaluated for cloning.
10858 @item ipa-cp-single-call-penalty
10859 Percentage penalty functions containg a single call to another
10860 function will receive when they are evaluated for cloning.
10863 @item ipa-max-agg-items
10864 IPA-CP is also capable to propagate a number of scalar values passed
10865 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10866 number of such values per one parameter.
10868 @item ipa-cp-loop-hint-bonus
10869 When IPA-CP determines that a cloning candidate would make the number
10870 of iterations of a loop known, it adds a bonus of
10871 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10872 the candidate.
10874 @item ipa-cp-array-index-hint-bonus
10875 When IPA-CP determines that a cloning candidate would make the index of
10876 an array access known, it adds a bonus of
10877 @option{ipa-cp-array-index-hint-bonus} to the profitability
10878 score of the candidate.
10880 @item ipa-max-aa-steps
10881 During its analysis of function bodies, IPA-CP employs alias analysis
10882 in order to track values pointed to by function parameters.  In order
10883 not spend too much time analyzing huge functions, it gives up and
10884 consider all memory clobbered after examining
10885 @option{ipa-max-aa-steps} statements modifying memory.
10887 @item lto-partitions
10888 Specify desired number of partitions produced during WHOPR compilation.
10889 The number of partitions should exceed the number of CPUs used for compilation.
10890 The default value is 32.
10892 @item lto-minpartition
10893 Size of minimal partition for WHOPR (in estimated instructions).
10894 This prevents expenses of splitting very small programs into too many
10895 partitions.
10897 @item cxx-max-namespaces-for-diagnostic-help
10898 The maximum number of namespaces to consult for suggestions when C++
10899 name lookup fails for an identifier.  The default is 1000.
10901 @item sink-frequency-threshold
10902 The maximum relative execution frequency (in percents) of the target block
10903 relative to a statement's original block to allow statement sinking of a
10904 statement.  Larger numbers result in more aggressive statement sinking.
10905 The default value is 75.  A small positive adjustment is applied for
10906 statements with memory operands as those are even more profitable so sink.
10908 @item max-stores-to-sink
10909 The maximum number of conditional stores paires that can be sunk.  Set to 0
10910 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10911 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10913 @item allow-store-data-races
10914 Allow optimizers to introduce new data races on stores.
10915 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10916 at optimization level @option{-Ofast}.
10918 @item case-values-threshold
10919 The smallest number of different values for which it is best to use a
10920 jump-table instead of a tree of conditional branches.  If the value is
10921 0, use the default for the machine.  The default is 0.
10923 @item tree-reassoc-width
10924 Set the maximum number of instructions executed in parallel in
10925 reassociated tree. This parameter overrides target dependent
10926 heuristics used by default if has non zero value.
10928 @item sched-pressure-algorithm
10929 Choose between the two available implementations of
10930 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10931 and is the more likely to prevent instructions from being reordered.
10932 Algorithm 2 was designed to be a compromise between the relatively
10933 conservative approach taken by algorithm 1 and the rather aggressive
10934 approach taken by the default scheduler.  It relies more heavily on
10935 having a regular register file and accurate register pressure classes.
10936 See @file{haifa-sched.c} in the GCC sources for more details.
10938 The default choice depends on the target.
10940 @item max-slsr-cand-scan
10941 Set the maximum number of existing candidates that are considered when
10942 seeking a basis for a new straight-line strength reduction candidate.
10944 @item asan-globals
10945 Enable buffer overflow detection for global objects.  This kind
10946 of protection is enabled by default if you are using
10947 @option{-fsanitize=address} option.
10948 To disable global objects protection use @option{--param asan-globals=0}.
10950 @item asan-stack
10951 Enable buffer overflow detection for stack objects.  This kind of
10952 protection is enabled by default when using@option{-fsanitize=address}.
10953 To disable stack protection use @option{--param asan-stack=0} option.
10955 @item asan-instrument-reads
10956 Enable buffer overflow detection for memory reads.  This kind of
10957 protection is enabled by default when using @option{-fsanitize=address}.
10958 To disable memory reads protection use
10959 @option{--param asan-instrument-reads=0}.
10961 @item asan-instrument-writes
10962 Enable buffer overflow detection for memory writes.  This kind of
10963 protection is enabled by default when using @option{-fsanitize=address}.
10964 To disable memory writes protection use
10965 @option{--param asan-instrument-writes=0} option.
10967 @item asan-memintrin
10968 Enable detection for built-in functions.  This kind of protection
10969 is enabled by default when using @option{-fsanitize=address}.
10970 To disable built-in functions protection use
10971 @option{--param asan-memintrin=0}.
10973 @item asan-use-after-return
10974 Enable detection of use-after-return.  This kind of protection
10975 is enabled by default when using @option{-fsanitize=address} option.
10976 To disable use-after-return detection use 
10977 @option{--param asan-use-after-return=0}.
10979 @item asan-instrumentation-with-call-threshold
10980 If number of memory accesses in function being instrumented
10981 is greater or equal to this number, use callbacks instead of inline checks.
10982 E.g. to disable inline code use
10983 @option{--param asan-instrumentation-with-call-threshold=0}.
10985 @item chkp-max-ctor-size
10986 Static constructors generated by Pointer Bounds Checker may become very
10987 large and significantly increase compile time at optimization level
10988 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10989 in a single generated constructor.  Default value is 5000.
10991 @item max-fsm-thread-path-insns
10992 Maximum number of instructions to copy when duplicating blocks on a
10993 finite state automaton jump thread path.  The default is 100.
10995 @item max-fsm-thread-length
10996 Maximum number of basic blocks on a finite state automaton jump thread
10997 path.  The default is 10.
10999 @item max-fsm-thread-paths
11000 Maximum number of new jump thread paths to create for a finite state
11001 automaton.  The default is 50.
11003 @end table
11004 @end table
11006 @node Preprocessor Options
11007 @section Options Controlling the Preprocessor
11008 @cindex preprocessor options
11009 @cindex options, preprocessor
11011 These options control the C preprocessor, which is run on each C source
11012 file before actual compilation.
11014 If you use the @option{-E} option, nothing is done except preprocessing.
11015 Some of these options make sense only together with @option{-E} because
11016 they cause the preprocessor output to be unsuitable for actual
11017 compilation.
11019 @table @gcctabopt
11020 @item -Wp,@var{option}
11021 @opindex Wp
11022 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11023 and pass @var{option} directly through to the preprocessor.  If
11024 @var{option} contains commas, it is split into multiple options at the
11025 commas.  However, many options are modified, translated or interpreted
11026 by the compiler driver before being passed to the preprocessor, and
11027 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11028 interface is undocumented and subject to change, so whenever possible
11029 you should avoid using @option{-Wp} and let the driver handle the
11030 options instead.
11032 @item -Xpreprocessor @var{option}
11033 @opindex Xpreprocessor
11034 Pass @var{option} as an option to the preprocessor.  You can use this to
11035 supply system-specific preprocessor options that GCC does not 
11036 recognize.
11038 If you want to pass an option that takes an argument, you must use
11039 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11041 @item -no-integrated-cpp
11042 @opindex no-integrated-cpp
11043 Perform preprocessing as a separate pass before compilation.
11044 By default, GCC performs preprocessing as an integrated part of
11045 input tokenization and parsing.
11046 If this option is provided, the appropriate language front end
11047 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11048 and Objective-C, respectively) is instead invoked twice,
11049 once for preprocessing only and once for actual compilation
11050 of the preprocessed input.
11051 This option may be useful in conjunction with the @option{-B} or
11052 @option{-wrapper} options to specify an alternate preprocessor or
11053 perform additional processing of the program source between
11054 normal preprocessing and compilation.
11055 @end table
11057 @include cppopts.texi
11059 @node Assembler Options
11060 @section Passing Options to the Assembler
11062 @c prevent bad page break with this line
11063 You can pass options to the assembler.
11065 @table @gcctabopt
11066 @item -Wa,@var{option}
11067 @opindex Wa
11068 Pass @var{option} as an option to the assembler.  If @var{option}
11069 contains commas, it is split into multiple options at the commas.
11071 @item -Xassembler @var{option}
11072 @opindex Xassembler
11073 Pass @var{option} as an option to the assembler.  You can use this to
11074 supply system-specific assembler options that GCC does not
11075 recognize.
11077 If you want to pass an option that takes an argument, you must use
11078 @option{-Xassembler} twice, once for the option and once for the argument.
11080 @end table
11082 @node Link Options
11083 @section Options for Linking
11084 @cindex link options
11085 @cindex options, linking
11087 These options come into play when the compiler links object files into
11088 an executable output file.  They are meaningless if the compiler is
11089 not doing a link step.
11091 @table @gcctabopt
11092 @cindex file names
11093 @item @var{object-file-name}
11094 A file name that does not end in a special recognized suffix is
11095 considered to name an object file or library.  (Object files are
11096 distinguished from libraries by the linker according to the file
11097 contents.)  If linking is done, these object files are used as input
11098 to the linker.
11100 @item -c
11101 @itemx -S
11102 @itemx -E
11103 @opindex c
11104 @opindex S
11105 @opindex E
11106 If any of these options is used, then the linker is not run, and
11107 object file names should not be used as arguments.  @xref{Overall
11108 Options}.
11110 @item -fuse-ld=bfd
11111 @opindex fuse-ld=bfd
11112 Use the @command{bfd} linker instead of the default linker.
11114 @item -fuse-ld=gold
11115 @opindex fuse-ld=gold
11116 Use the @command{gold} linker instead of the default linker.
11118 @cindex Libraries
11119 @item -l@var{library}
11120 @itemx -l @var{library}
11121 @opindex l
11122 Search the library named @var{library} when linking.  (The second
11123 alternative with the library as a separate argument is only for
11124 POSIX compliance and is not recommended.)
11126 It makes a difference where in the command you write this option; the
11127 linker searches and processes libraries and object files in the order they
11128 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11129 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11130 to functions in @samp{z}, those functions may not be loaded.
11132 The linker searches a standard list of directories for the library,
11133 which is actually a file named @file{lib@var{library}.a}.  The linker
11134 then uses this file as if it had been specified precisely by name.
11136 The directories searched include several standard system directories
11137 plus any that you specify with @option{-L}.
11139 Normally the files found this way are library files---archive files
11140 whose members are object files.  The linker handles an archive file by
11141 scanning through it for members which define symbols that have so far
11142 been referenced but not defined.  But if the file that is found is an
11143 ordinary object file, it is linked in the usual fashion.  The only
11144 difference between using an @option{-l} option and specifying a file name
11145 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11146 and searches several directories.
11148 @item -lobjc
11149 @opindex lobjc
11150 You need this special case of the @option{-l} option in order to
11151 link an Objective-C or Objective-C++ program.
11153 @item -nostartfiles
11154 @opindex nostartfiles
11155 Do not use the standard system startup files when linking.
11156 The standard system libraries are used normally, unless @option{-nostdlib}
11157 or @option{-nodefaultlibs} is used.
11159 @item -nodefaultlibs
11160 @opindex nodefaultlibs
11161 Do not use the standard system libraries when linking.
11162 Only the libraries you specify are passed to the linker, and options
11163 specifying linkage of the system libraries, such as @option{-static-libgcc}
11164 or @option{-shared-libgcc}, are ignored.  
11165 The standard startup files are used normally, unless @option{-nostartfiles}
11166 is used.  
11168 The compiler may generate calls to @code{memcmp},
11169 @code{memset}, @code{memcpy} and @code{memmove}.
11170 These entries are usually resolved by entries in
11171 libc.  These entry points should be supplied through some other
11172 mechanism when this option is specified.
11174 @item -nostdlib
11175 @opindex nostdlib
11176 Do not use the standard system startup files or libraries when linking.
11177 No startup files and only the libraries you specify are passed to
11178 the linker, and options specifying linkage of the system libraries, such as
11179 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11181 The compiler may generate calls to @code{memcmp}, @code{memset},
11182 @code{memcpy} and @code{memmove}.
11183 These entries are usually resolved by entries in
11184 libc.  These entry points should be supplied through some other
11185 mechanism when this option is specified.
11187 @cindex @option{-lgcc}, use with @option{-nostdlib}
11188 @cindex @option{-nostdlib} and unresolved references
11189 @cindex unresolved references and @option{-nostdlib}
11190 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11191 @cindex @option{-nodefaultlibs} and unresolved references
11192 @cindex unresolved references and @option{-nodefaultlibs}
11193 One of the standard libraries bypassed by @option{-nostdlib} and
11194 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11195 which GCC uses to overcome shortcomings of particular machines, or special
11196 needs for some languages.
11197 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11198 Collection (GCC) Internals},
11199 for more discussion of @file{libgcc.a}.)
11200 In most cases, you need @file{libgcc.a} even when you want to avoid
11201 other standard libraries.  In other words, when you specify @option{-nostdlib}
11202 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11203 This ensures that you have no unresolved references to internal GCC
11204 library subroutines.
11205 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11206 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11207 GNU Compiler Collection (GCC) Internals}.)
11209 @item -pie
11210 @opindex pie
11211 Produce a position independent executable on targets that support it.
11212 For predictable results, you must also specify the same set of options
11213 used for compilation (@option{-fpie}, @option{-fPIE},
11214 or model suboptions) when you specify this linker option.
11216 @item -no-pie
11217 @opindex no-pie
11218 Don't produce a position independent executable.
11220 @item -rdynamic
11221 @opindex rdynamic
11222 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11223 that support it. This instructs the linker to add all symbols, not
11224 only used ones, to the dynamic symbol table. This option is needed
11225 for some uses of @code{dlopen} or to allow obtaining backtraces
11226 from within a program.
11228 @item -s
11229 @opindex s
11230 Remove all symbol table and relocation information from the executable.
11232 @item -static
11233 @opindex static
11234 On systems that support dynamic linking, this prevents linking with the shared
11235 libraries.  On other systems, this option has no effect.
11237 @item -shared
11238 @opindex shared
11239 Produce a shared object which can then be linked with other objects to
11240 form an executable.  Not all systems support this option.  For predictable
11241 results, you must also specify the same set of options used for compilation
11242 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11243 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11244 needs to build supplementary stub code for constructors to work.  On
11245 multi-libbed systems, @samp{gcc -shared} must select the correct support
11246 libraries to link against.  Failing to supply the correct flags may lead
11247 to subtle defects.  Supplying them in cases where they are not necessary
11248 is innocuous.}
11250 @item -shared-libgcc
11251 @itemx -static-libgcc
11252 @opindex shared-libgcc
11253 @opindex static-libgcc
11254 On systems that provide @file{libgcc} as a shared library, these options
11255 force the use of either the shared or static version, respectively.
11256 If no shared version of @file{libgcc} was built when the compiler was
11257 configured, these options have no effect.
11259 There are several situations in which an application should use the
11260 shared @file{libgcc} instead of the static version.  The most common
11261 of these is when the application wishes to throw and catch exceptions
11262 across different shared libraries.  In that case, each of the libraries
11263 as well as the application itself should use the shared @file{libgcc}.
11265 Therefore, the G++ and GCJ drivers automatically add
11266 @option{-shared-libgcc} whenever you build a shared library or a main
11267 executable, because C++ and Java programs typically use exceptions, so
11268 this is the right thing to do.
11270 If, instead, you use the GCC driver to create shared libraries, you may
11271 find that they are not always linked with the shared @file{libgcc}.
11272 If GCC finds, at its configuration time, that you have a non-GNU linker
11273 or a GNU linker that does not support option @option{--eh-frame-hdr},
11274 it links the shared version of @file{libgcc} into shared libraries
11275 by default.  Otherwise, it takes advantage of the linker and optimizes
11276 away the linking with the shared version of @file{libgcc}, linking with
11277 the static version of libgcc by default.  This allows exceptions to
11278 propagate through such shared libraries, without incurring relocation
11279 costs at library load time.
11281 However, if a library or main executable is supposed to throw or catch
11282 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11283 for the languages used in the program, or using the option
11284 @option{-shared-libgcc}, such that it is linked with the shared
11285 @file{libgcc}.
11287 @item -static-libasan
11288 @opindex static-libasan
11289 When the @option{-fsanitize=address} option is used to link a program,
11290 the GCC driver automatically links against @option{libasan}.  If
11291 @file{libasan} is available as a shared library, and the @option{-static}
11292 option is not used, then this links against the shared version of
11293 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11294 driver to link @file{libasan} statically, without necessarily linking
11295 other libraries statically.
11297 @item -static-libtsan
11298 @opindex static-libtsan
11299 When the @option{-fsanitize=thread} option is used to link a program,
11300 the GCC driver automatically links against @option{libtsan}.  If
11301 @file{libtsan} is available as a shared library, and the @option{-static}
11302 option is not used, then this links against the shared version of
11303 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11304 driver to link @file{libtsan} statically, without necessarily linking
11305 other libraries statically.
11307 @item -static-liblsan
11308 @opindex static-liblsan
11309 When the @option{-fsanitize=leak} option is used to link a program,
11310 the GCC driver automatically links against @option{liblsan}.  If
11311 @file{liblsan} is available as a shared library, and the @option{-static}
11312 option is not used, then this links against the shared version of
11313 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11314 driver to link @file{liblsan} statically, without necessarily linking
11315 other libraries statically.
11317 @item -static-libubsan
11318 @opindex static-libubsan
11319 When the @option{-fsanitize=undefined} option is used to link a program,
11320 the GCC driver automatically links against @option{libubsan}.  If
11321 @file{libubsan} is available as a shared library, and the @option{-static}
11322 option is not used, then this links against the shared version of
11323 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11324 driver to link @file{libubsan} statically, without necessarily linking
11325 other libraries statically.
11327 @item -static-libmpx
11328 @opindex static-libmpx
11329 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11330 used to link a program, the GCC driver automatically links against
11331 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11332 and the @option{-static} option is not used, then this links against
11333 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11334 option directs the GCC driver to link @file{libmpx} statically,
11335 without necessarily linking other libraries statically.
11337 @item -static-libmpxwrappers
11338 @opindex static-libmpxwrappers
11339 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11340 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11341 GCC driver automatically links against @file{libmpxwrappers}.  If
11342 @file{libmpxwrappers} is available as a shared library, and the
11343 @option{-static} option is not used, then this links against the shared
11344 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11345 option directs the GCC driver to link @file{libmpxwrappers} statically,
11346 without necessarily linking other libraries statically.
11348 @item -static-libstdc++
11349 @opindex static-libstdc++
11350 When the @command{g++} program is used to link a C++ program, it
11351 normally automatically links against @option{libstdc++}.  If
11352 @file{libstdc++} is available as a shared library, and the
11353 @option{-static} option is not used, then this links against the
11354 shared version of @file{libstdc++}.  That is normally fine.  However, it
11355 is sometimes useful to freeze the version of @file{libstdc++} used by
11356 the program without going all the way to a fully static link.  The
11357 @option{-static-libstdc++} option directs the @command{g++} driver to
11358 link @file{libstdc++} statically, without necessarily linking other
11359 libraries statically.
11361 @item -symbolic
11362 @opindex symbolic
11363 Bind references to global symbols when building a shared object.  Warn
11364 about any unresolved references (unless overridden by the link editor
11365 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11366 this option.
11368 @item -T @var{script}
11369 @opindex T
11370 @cindex linker script
11371 Use @var{script} as the linker script.  This option is supported by most
11372 systems using the GNU linker.  On some targets, such as bare-board
11373 targets without an operating system, the @option{-T} option may be required
11374 when linking to avoid references to undefined symbols.
11376 @item -Xlinker @var{option}
11377 @opindex Xlinker
11378 Pass @var{option} as an option to the linker.  You can use this to
11379 supply system-specific linker options that GCC does not recognize.
11381 If you want to pass an option that takes a separate argument, you must use
11382 @option{-Xlinker} twice, once for the option and once for the argument.
11383 For example, to pass @option{-assert definitions}, you must write
11384 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11385 @option{-Xlinker "-assert definitions"}, because this passes the entire
11386 string as a single argument, which is not what the linker expects.
11388 When using the GNU linker, it is usually more convenient to pass
11389 arguments to linker options using the @option{@var{option}=@var{value}}
11390 syntax than as separate arguments.  For example, you can specify
11391 @option{-Xlinker -Map=output.map} rather than
11392 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11393 this syntax for command-line options.
11395 @item -Wl,@var{option}
11396 @opindex Wl
11397 Pass @var{option} as an option to the linker.  If @var{option} contains
11398 commas, it is split into multiple options at the commas.  You can use this
11399 syntax to pass an argument to the option.
11400 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11401 linker.  When using the GNU linker, you can also get the same effect with
11402 @option{-Wl,-Map=output.map}.
11404 @item -u @var{symbol}
11405 @opindex u
11406 Pretend the symbol @var{symbol} is undefined, to force linking of
11407 library modules to define it.  You can use @option{-u} multiple times with
11408 different symbols to force loading of additional library modules.
11410 @item -z @var{keyword}
11411 @opindex z
11412 @option{-z} is passed directly on to the linker along with the keyword
11413 @var{keyword}. See the section in the documentation of your linker for
11414 permitted values and their meanings.
11415 @end table
11417 @node Directory Options
11418 @section Options for Directory Search
11419 @cindex directory options
11420 @cindex options, directory search
11421 @cindex search path
11423 These options specify directories to search for header files, for
11424 libraries and for parts of the compiler:
11426 @table @gcctabopt
11427 @item -I@var{dir}
11428 @opindex I
11429 Add the directory @var{dir} to the head of the list of directories to be
11430 searched for header files.  This can be used to override a system header
11431 file, substituting your own version, since these directories are
11432 searched before the system header file directories.  However, you should
11433 not use this option to add directories that contain vendor-supplied
11434 system header files (use @option{-isystem} for that).  If you use more than
11435 one @option{-I} option, the directories are scanned in left-to-right
11436 order; the standard system directories come after.
11438 If a standard system include directory, or a directory specified with
11439 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11440 option is ignored.  The directory is still searched but as a
11441 system directory at its normal position in the system include chain.
11442 This is to ensure that GCC's procedure to fix buggy system headers and
11443 the ordering for the @code{include_next} directive are not inadvertently changed.
11444 If you really need to change the search order for system directories,
11445 use the @option{-nostdinc} and/or @option{-isystem} options.
11447 @item -iplugindir=@var{dir}
11448 @opindex iplugindir=
11449 Set the directory to search for plugins that are passed
11450 by @option{-fplugin=@var{name}} instead of
11451 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11452 to be used by the user, but only passed by the driver.
11454 @item -iquote@var{dir}
11455 @opindex iquote
11456 Add the directory @var{dir} to the head of the list of directories to
11457 be searched for header files only for the case of @code{#include
11458 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11459 otherwise just like @option{-I}.
11461 @item -L@var{dir}
11462 @opindex L
11463 Add directory @var{dir} to the list of directories to be searched
11464 for @option{-l}.
11466 @item -B@var{prefix}
11467 @opindex B
11468 This option specifies where to find the executables, libraries,
11469 include files, and data files of the compiler itself.
11471 The compiler driver program runs one or more of the subprograms
11472 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11473 @var{prefix} as a prefix for each program it tries to run, both with and
11474 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11476 For each subprogram to be run, the compiler driver first tries the
11477 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11478 is not specified, the driver tries two standard prefixes, 
11479 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11480 those results in a file name that is found, the unmodified program
11481 name is searched for using the directories specified in your
11482 @env{PATH} environment variable.
11484 The compiler checks to see if the path provided by @option{-B}
11485 refers to a directory, and if necessary it adds a directory
11486 separator character at the end of the path.
11488 @option{-B} prefixes that effectively specify directory names also apply
11489 to libraries in the linker, because the compiler translates these
11490 options into @option{-L} options for the linker.  They also apply to
11491 include files in the preprocessor, because the compiler translates these
11492 options into @option{-isystem} options for the preprocessor.  In this case,
11493 the compiler appends @samp{include} to the prefix.
11495 The runtime support file @file{libgcc.a} can also be searched for using
11496 the @option{-B} prefix, if needed.  If it is not found there, the two
11497 standard prefixes above are tried, and that is all.  The file is left
11498 out of the link if it is not found by those means.
11500 Another way to specify a prefix much like the @option{-B} prefix is to use
11501 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11502 Variables}.
11504 As a special kludge, if the path provided by @option{-B} is
11505 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11506 9, then it is replaced by @file{[dir/]include}.  This is to help
11507 with boot-strapping the compiler.
11509 @item -specs=@var{file}
11510 @opindex specs
11511 Process @var{file} after the compiler reads in the standard @file{specs}
11512 file, in order to override the defaults which the @command{gcc} driver
11513 program uses when determining what switches to pass to @command{cc1},
11514 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11515 @option{-specs=@var{file}} can be specified on the command line, and they
11516 are processed in order, from left to right.
11518 @item --sysroot=@var{dir}
11519 @opindex sysroot
11520 Use @var{dir} as the logical root directory for headers and libraries.
11521 For example, if the compiler normally searches for headers in
11522 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11523 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11525 If you use both this option and the @option{-isysroot} option, then
11526 the @option{--sysroot} option applies to libraries, but the
11527 @option{-isysroot} option applies to header files.
11529 The GNU linker (beginning with version 2.16) has the necessary support
11530 for this option.  If your linker does not support this option, the
11531 header file aspect of @option{--sysroot} still works, but the
11532 library aspect does not.
11534 @item --no-sysroot-suffix
11535 @opindex no-sysroot-suffix
11536 For some targets, a suffix is added to the root directory specified
11537 with @option{--sysroot}, depending on the other options used, so that
11538 headers may for example be found in
11539 @file{@var{dir}/@var{suffix}/usr/include} instead of
11540 @file{@var{dir}/usr/include}.  This option disables the addition of
11541 such a suffix.
11543 @item -I-
11544 @opindex I-
11545 This option has been deprecated.  Please use @option{-iquote} instead for
11546 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11547 option.
11548 Any directories you specify with @option{-I} options before the @option{-I-}
11549 option are searched only for the case of @code{#include "@var{file}"};
11550 they are not searched for @code{#include <@var{file}>}.
11552 If additional directories are specified with @option{-I} options after
11553 the @option{-I-} option, these directories are searched for all @code{#include}
11554 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11555 this way.)
11557 In addition, the @option{-I-} option inhibits the use of the current
11558 directory (where the current input file came from) as the first search
11559 directory for @code{#include "@var{file}"}.  There is no way to
11560 override this effect of @option{-I-}.  With @option{-I.} you can specify
11561 searching the directory that is current when the compiler is
11562 invoked.  That is not exactly the same as what the preprocessor does
11563 by default, but it is often satisfactory.
11565 @option{-I-} does not inhibit the use of the standard system directories
11566 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11567 independent.
11568 @end table
11570 @c man end
11572 @node Spec Files
11573 @section Specifying Subprocesses and the Switches to Pass to Them
11574 @cindex Spec Files
11576 @command{gcc} is a driver program.  It performs its job by invoking a
11577 sequence of other programs to do the work of compiling, assembling and
11578 linking.  GCC interprets its command-line parameters and uses these to
11579 deduce which programs it should invoke, and which command-line options
11580 it ought to place on their command lines.  This behavior is controlled
11581 by @dfn{spec strings}.  In most cases there is one spec string for each
11582 program that GCC can invoke, but a few programs have multiple spec
11583 strings to control their behavior.  The spec strings built into GCC can
11584 be overridden by using the @option{-specs=} command-line switch to specify
11585 a spec file.
11587 @dfn{Spec files} are plaintext files that are used to construct spec
11588 strings.  They consist of a sequence of directives separated by blank
11589 lines.  The type of directive is determined by the first non-whitespace
11590 character on the line, which can be one of the following:
11592 @table @code
11593 @item %@var{command}
11594 Issues a @var{command} to the spec file processor.  The commands that can
11595 appear here are:
11597 @table @code
11598 @item %include <@var{file}>
11599 @cindex @code{%include}
11600 Search for @var{file} and insert its text at the current point in the
11601 specs file.
11603 @item %include_noerr <@var{file}>
11604 @cindex @code{%include_noerr}
11605 Just like @samp{%include}, but do not generate an error message if the include
11606 file cannot be found.
11608 @item %rename @var{old_name} @var{new_name}
11609 @cindex @code{%rename}
11610 Rename the spec string @var{old_name} to @var{new_name}.
11612 @end table
11614 @item *[@var{spec_name}]:
11615 This tells the compiler to create, override or delete the named spec
11616 string.  All lines after this directive up to the next directive or
11617 blank line are considered to be the text for the spec string.  If this
11618 results in an empty string then the spec is deleted.  (Or, if the
11619 spec did not exist, then nothing happens.)  Otherwise, if the spec
11620 does not currently exist a new spec is created.  If the spec does
11621 exist then its contents are overridden by the text of this
11622 directive, unless the first character of that text is the @samp{+}
11623 character, in which case the text is appended to the spec.
11625 @item [@var{suffix}]:
11626 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11627 and up to the next directive or blank line are considered to make up the
11628 spec string for the indicated suffix.  When the compiler encounters an
11629 input file with the named suffix, it processes the spec string in
11630 order to work out how to compile that file.  For example:
11632 @smallexample
11633 .ZZ:
11634 z-compile -input %i
11635 @end smallexample
11637 This says that any input file whose name ends in @samp{.ZZ} should be
11638 passed to the program @samp{z-compile}, which should be invoked with the
11639 command-line switch @option{-input} and with the result of performing the
11640 @samp{%i} substitution.  (See below.)
11642 As an alternative to providing a spec string, the text following a
11643 suffix directive can be one of the following:
11645 @table @code
11646 @item @@@var{language}
11647 This says that the suffix is an alias for a known @var{language}.  This is
11648 similar to using the @option{-x} command-line switch to GCC to specify a
11649 language explicitly.  For example:
11651 @smallexample
11652 .ZZ:
11653 @@c++
11654 @end smallexample
11656 Says that .ZZ files are, in fact, C++ source files.
11658 @item #@var{name}
11659 This causes an error messages saying:
11661 @smallexample
11662 @var{name} compiler not installed on this system.
11663 @end smallexample
11664 @end table
11666 GCC already has an extensive list of suffixes built into it.
11667 This directive adds an entry to the end of the list of suffixes, but
11668 since the list is searched from the end backwards, it is effectively
11669 possible to override earlier entries using this technique.
11671 @end table
11673 GCC has the following spec strings built into it.  Spec files can
11674 override these strings or create their own.  Note that individual
11675 targets can also add their own spec strings to this list.
11677 @smallexample
11678 asm          Options to pass to the assembler
11679 asm_final    Options to pass to the assembler post-processor
11680 cpp          Options to pass to the C preprocessor
11681 cc1          Options to pass to the C compiler
11682 cc1plus      Options to pass to the C++ compiler
11683 endfile      Object files to include at the end of the link
11684 link         Options to pass to the linker
11685 lib          Libraries to include on the command line to the linker
11686 libgcc       Decides which GCC support library to pass to the linker
11687 linker       Sets the name of the linker
11688 predefines   Defines to be passed to the C preprocessor
11689 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11690              by default
11691 startfile    Object files to include at the start of the link
11692 @end smallexample
11694 Here is a small example of a spec file:
11696 @smallexample
11697 %rename lib                 old_lib
11699 *lib:
11700 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11701 @end smallexample
11703 This example renames the spec called @samp{lib} to @samp{old_lib} and
11704 then overrides the previous definition of @samp{lib} with a new one.
11705 The new definition adds in some extra command-line options before
11706 including the text of the old definition.
11708 @dfn{Spec strings} are a list of command-line options to be passed to their
11709 corresponding program.  In addition, the spec strings can contain
11710 @samp{%}-prefixed sequences to substitute variable text or to
11711 conditionally insert text into the command line.  Using these constructs
11712 it is possible to generate quite complex command lines.
11714 Here is a table of all defined @samp{%}-sequences for spec
11715 strings.  Note that spaces are not generated automatically around the
11716 results of expanding these sequences.  Therefore you can concatenate them
11717 together or combine them with constant text in a single argument.
11719 @table @code
11720 @item %%
11721 Substitute one @samp{%} into the program name or argument.
11723 @item %i
11724 Substitute the name of the input file being processed.
11726 @item %b
11727 Substitute the basename of the input file being processed.
11728 This is the substring up to (and not including) the last period
11729 and not including the directory.
11731 @item %B
11732 This is the same as @samp{%b}, but include the file suffix (text after
11733 the last period).
11735 @item %d
11736 Marks the argument containing or following the @samp{%d} as a
11737 temporary file name, so that that file is deleted if GCC exits
11738 successfully.  Unlike @samp{%g}, this contributes no text to the
11739 argument.
11741 @item %g@var{suffix}
11742 Substitute a file name that has suffix @var{suffix} and is chosen
11743 once per compilation, and mark the argument in the same way as
11744 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11745 name is now chosen in a way that is hard to predict even when previously
11746 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11747 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11748 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11749 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11750 was simply substituted with a file name chosen once per compilation,
11751 without regard to any appended suffix (which was therefore treated
11752 just like ordinary text), making such attacks more likely to succeed.
11754 @item %u@var{suffix}
11755 Like @samp{%g}, but generates a new temporary file name
11756 each time it appears instead of once per compilation.
11758 @item %U@var{suffix}
11759 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11760 new one if there is no such last file name.  In the absence of any
11761 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11762 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11763 involves the generation of two distinct file names, one
11764 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11765 simply substituted with a file name chosen for the previous @samp{%u},
11766 without regard to any appended suffix.
11768 @item %j@var{suffix}
11769 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11770 writable, and if @option{-save-temps} is not used; 
11771 otherwise, substitute the name
11772 of a temporary file, just like @samp{%u}.  This temporary file is not
11773 meant for communication between processes, but rather as a junk
11774 disposal mechanism.
11776 @item %|@var{suffix}
11777 @itemx %m@var{suffix}
11778 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11779 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11780 all.  These are the two most common ways to instruct a program that it
11781 should read from standard input or write to standard output.  If you
11782 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11783 construct: see for example @file{f/lang-specs.h}.
11785 @item %.@var{SUFFIX}
11786 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11787 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11788 terminated by the next space or %.
11790 @item %w
11791 Marks the argument containing or following the @samp{%w} as the
11792 designated output file of this compilation.  This puts the argument
11793 into the sequence of arguments that @samp{%o} substitutes.
11795 @item %o
11796 Substitutes the names of all the output files, with spaces
11797 automatically placed around them.  You should write spaces
11798 around the @samp{%o} as well or the results are undefined.
11799 @samp{%o} is for use in the specs for running the linker.
11800 Input files whose names have no recognized suffix are not compiled
11801 at all, but they are included among the output files, so they are
11802 linked.
11804 @item %O
11805 Substitutes the suffix for object files.  Note that this is
11806 handled specially when it immediately follows @samp{%g, %u, or %U},
11807 because of the need for those to form complete file names.  The
11808 handling is such that @samp{%O} is treated exactly as if it had already
11809 been substituted, except that @samp{%g, %u, and %U} do not currently
11810 support additional @var{suffix} characters following @samp{%O} as they do
11811 following, for example, @samp{.o}.
11813 @item %p
11814 Substitutes the standard macro predefinitions for the
11815 current target machine.  Use this when running @command{cpp}.
11817 @item %P
11818 Like @samp{%p}, but puts @samp{__} before and after the name of each
11819 predefined macro, except for macros that start with @samp{__} or with
11820 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11823 @item %I
11824 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11825 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11826 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11827 and @option{-imultilib} as necessary.
11829 @item %s
11830 Current argument is the name of a library or startup file of some sort.
11831 Search for that file in a standard list of directories and substitute
11832 the full name found.  The current working directory is included in the
11833 list of directories scanned.
11835 @item %T
11836 Current argument is the name of a linker script.  Search for that file
11837 in the current list of directories to scan for libraries. If the file
11838 is located insert a @option{--script} option into the command line
11839 followed by the full path name found.  If the file is not found then
11840 generate an error message.  Note: the current working directory is not
11841 searched.
11843 @item %e@var{str}
11844 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11845 Use this when inconsistent options are detected.
11847 @item %(@var{name})
11848 Substitute the contents of spec string @var{name} at this point.
11850 @item %x@{@var{option}@}
11851 Accumulate an option for @samp{%X}.
11853 @item %X
11854 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11855 spec string.
11857 @item %Y
11858 Output the accumulated assembler options specified by @option{-Wa}.
11860 @item %Z
11861 Output the accumulated preprocessor options specified by @option{-Wp}.
11863 @item %a
11864 Process the @code{asm} spec.  This is used to compute the
11865 switches to be passed to the assembler.
11867 @item %A
11868 Process the @code{asm_final} spec.  This is a spec string for
11869 passing switches to an assembler post-processor, if such a program is
11870 needed.
11872 @item %l
11873 Process the @code{link} spec.  This is the spec for computing the
11874 command line passed to the linker.  Typically it makes use of the
11875 @samp{%L %G %S %D and %E} sequences.
11877 @item %D
11878 Dump out a @option{-L} option for each directory that GCC believes might
11879 contain startup files.  If the target supports multilibs then the
11880 current multilib directory is prepended to each of these paths.
11882 @item %L
11883 Process the @code{lib} spec.  This is a spec string for deciding which
11884 libraries are included on the command line to the linker.
11886 @item %G
11887 Process the @code{libgcc} spec.  This is a spec string for deciding
11888 which GCC support library is included on the command line to the linker.
11890 @item %S
11891 Process the @code{startfile} spec.  This is a spec for deciding which
11892 object files are the first ones passed to the linker.  Typically
11893 this might be a file named @file{crt0.o}.
11895 @item %E
11896 Process the @code{endfile} spec.  This is a spec string that specifies
11897 the last object files that are passed to the linker.
11899 @item %C
11900 Process the @code{cpp} spec.  This is used to construct the arguments
11901 to be passed to the C preprocessor.
11903 @item %1
11904 Process the @code{cc1} spec.  This is used to construct the options to be
11905 passed to the actual C compiler (@command{cc1}).
11907 @item %2
11908 Process the @code{cc1plus} spec.  This is used to construct the options to be
11909 passed to the actual C++ compiler (@command{cc1plus}).
11911 @item %*
11912 Substitute the variable part of a matched option.  See below.
11913 Note that each comma in the substituted string is replaced by
11914 a single space.
11916 @item %<@code{S}
11917 Remove all occurrences of @code{-S} from the command line.  Note---this
11918 command is position dependent.  @samp{%} commands in the spec string
11919 before this one see @code{-S}, @samp{%} commands in the spec string
11920 after this one do not.
11922 @item %:@var{function}(@var{args})
11923 Call the named function @var{function}, passing it @var{args}.
11924 @var{args} is first processed as a nested spec string, then split
11925 into an argument vector in the usual fashion.  The function returns
11926 a string which is processed as if it had appeared literally as part
11927 of the current spec.
11929 The following built-in spec functions are provided:
11931 @table @code
11932 @item @code{getenv}
11933 The @code{getenv} spec function takes two arguments: an environment
11934 variable name and a string.  If the environment variable is not
11935 defined, a fatal error is issued.  Otherwise, the return value is the
11936 value of the environment variable concatenated with the string.  For
11937 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11939 @smallexample
11940 %:getenv(TOPDIR /include)
11941 @end smallexample
11943 expands to @file{/path/to/top/include}.
11945 @item @code{if-exists}
11946 The @code{if-exists} spec function takes one argument, an absolute
11947 pathname to a file.  If the file exists, @code{if-exists} returns the
11948 pathname.  Here is a small example of its usage:
11950 @smallexample
11951 *startfile:
11952 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11953 @end smallexample
11955 @item @code{if-exists-else}
11956 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11957 spec function, except that it takes two arguments.  The first argument is
11958 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11959 returns the pathname.  If it does not exist, it returns the second argument.
11960 This way, @code{if-exists-else} can be used to select one file or another,
11961 based on the existence of the first.  Here is a small example of its usage:
11963 @smallexample
11964 *startfile:
11965 crt0%O%s %:if-exists(crti%O%s) \
11966 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11967 @end smallexample
11969 @item @code{replace-outfile}
11970 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11971 first argument in the outfiles array and replaces it with the second argument.  Here
11972 is a small example of its usage:
11974 @smallexample
11975 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11976 @end smallexample
11978 @item @code{remove-outfile}
11979 The @code{remove-outfile} spec function takes one argument.  It looks for the
11980 first argument in the outfiles array and removes it.  Here is a small example
11981 its usage:
11983 @smallexample
11984 %:remove-outfile(-lm)
11985 @end smallexample
11987 @item @code{pass-through-libs}
11988 The @code{pass-through-libs} spec function takes any number of arguments.  It
11989 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11990 assumes are the names of linker input library archive files) and returns a
11991 result containing all the found arguments each prepended by
11992 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11993 intended to be passed to the LTO linker plugin.
11995 @smallexample
11996 %:pass-through-libs(%G %L %G)
11997 @end smallexample
11999 @item @code{print-asm-header}
12000 The @code{print-asm-header} function takes no arguments and simply
12001 prints a banner like:
12003 @smallexample
12004 Assembler options
12005 =================
12007 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
12008 @end smallexample
12010 It is used to separate compiler options from assembler options
12011 in the @option{--target-help} output.
12012 @end table
12014 @item %@{@code{S}@}
12015 Substitutes the @code{-S} switch, if that switch is given to GCC@.
12016 If that switch is not specified, this substitutes nothing.  Note that
12017 the leading dash is omitted when specifying this option, and it is
12018 automatically inserted if the substitution is performed.  Thus the spec
12019 string @samp{%@{foo@}} matches the command-line option @option{-foo}
12020 and outputs the command-line option @option{-foo}.
12022 @item %W@{@code{S}@}
12023 Like %@{@code{S}@} but mark last argument supplied within as a file to be
12024 deleted on failure.
12026 @item %@{@code{S}*@}
12027 Substitutes all the switches specified to GCC whose names start
12028 with @code{-S}, but which also take an argument.  This is used for
12029 switches like @option{-o}, @option{-D}, @option{-I}, etc.
12030 GCC considers @option{-o foo} as being
12031 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
12032 text, including the space.  Thus two arguments are generated.
12034 @item %@{@code{S}*&@code{T}*@}
12035 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
12036 (the order of @code{S} and @code{T} in the spec is not significant).
12037 There can be any number of ampersand-separated variables; for each the
12038 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
12040 @item %@{@code{S}:@code{X}@}
12041 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
12043 @item %@{!@code{S}:@code{X}@}
12044 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
12046 @item %@{@code{S}*:@code{X}@}
12047 Substitutes @code{X} if one or more switches whose names start with
12048 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
12049 once, no matter how many such switches appeared.  However, if @code{%*}
12050 appears somewhere in @code{X}, then @code{X} is substituted once
12051 for each matching switch, with the @code{%*} replaced by the part of
12052 that switch matching the @code{*}.
12054 If @code{%*} appears as the last part of a spec sequence then a space
12055 is added after the end of the last substitution.  If there is more
12056 text in the sequence, however, then a space is not generated.  This
12057 allows the @code{%*} substitution to be used as part of a larger
12058 string.  For example, a spec string like this:
12060 @smallexample
12061 %@{mcu=*:--script=%*/memory.ld@}
12062 @end smallexample
12064 @noindent
12065 when matching an option like @option{-mcu=newchip} produces:
12067 @smallexample
12068 --script=newchip/memory.ld
12069 @end smallexample
12071 @item %@{.@code{S}:@code{X}@}
12072 Substitutes @code{X}, if processing a file with suffix @code{S}.
12074 @item %@{!.@code{S}:@code{X}@}
12075 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
12077 @item %@{,@code{S}:@code{X}@}
12078 Substitutes @code{X}, if processing a file for language @code{S}.
12080 @item %@{!,@code{S}:@code{X}@}
12081 Substitutes @code{X}, if not processing a file for language @code{S}.
12083 @item %@{@code{S}|@code{P}:@code{X}@}
12084 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
12085 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
12086 @code{*} sequences as well, although they have a stronger binding than
12087 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
12088 alternatives must be starred, and only the first matching alternative
12089 is substituted.
12091 For example, a spec string like this:
12093 @smallexample
12094 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
12095 @end smallexample
12097 @noindent
12098 outputs the following command-line options from the following input
12099 command-line options:
12101 @smallexample
12102 fred.c        -foo -baz
12103 jim.d         -bar -boggle
12104 -d fred.c     -foo -baz -boggle
12105 -d jim.d      -bar -baz -boggle
12106 @end smallexample
12108 @item %@{S:X; T:Y; :D@}
12110 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
12111 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
12112 be as many clauses as you need.  This may be combined with @code{.},
12113 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
12116 @end table
12118 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
12119 construct may contain other nested @samp{%} constructs or spaces, or
12120 even newlines.  They are processed as usual, as described above.
12121 Trailing white space in @code{X} is ignored.  White space may also
12122 appear anywhere on the left side of the colon in these constructs,
12123 except between @code{.} or @code{*} and the corresponding word.
12125 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
12126 handled specifically in these constructs.  If another value of
12127 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
12128 @option{-W} switch is found later in the command line, the earlier
12129 switch value is ignored, except with @{@code{S}*@} where @code{S} is
12130 just one letter, which passes all matching options.
12132 The character @samp{|} at the beginning of the predicate text is used to
12133 indicate that a command should be piped to the following command, but
12134 only if @option{-pipe} is specified.
12136 It is built into GCC which switches take arguments and which do not.
12137 (You might think it would be useful to generalize this to allow each
12138 compiler's spec to say which switches take arguments.  But this cannot
12139 be done in a consistent fashion.  GCC cannot even decide which input
12140 files have been specified without knowing which switches take arguments,
12141 and it must know which input files to compile in order to tell which
12142 compilers to run).
12144 GCC also knows implicitly that arguments starting in @option{-l} are to be
12145 treated as compiler output files, and passed to the linker in their
12146 proper position among the other output files.
12148 @c man begin OPTIONS
12150 @node Target Options
12151 @section Specifying Target Machine and Compiler Version
12152 @cindex target options
12153 @cindex cross compiling
12154 @cindex specifying machine version
12155 @cindex specifying compiler version and target machine
12156 @cindex compiler version, specifying
12157 @cindex target machine, specifying
12159 The usual way to run GCC is to run the executable called @command{gcc}, or
12160 @command{@var{machine}-gcc} when cross-compiling, or
12161 @command{@var{machine}-gcc-@var{version}} to run a version other than the
12162 one that was installed last.
12164 @node Submodel Options
12165 @section Hardware Models and Configurations
12166 @cindex submodel options
12167 @cindex specifying hardware config
12168 @cindex hardware models and configurations, specifying
12169 @cindex machine dependent options
12171 Each target machine types can have its own
12172 special options, starting with @samp{-m}, to choose among various
12173 hardware models or configurations---for example, 68010 vs 68020,
12174 floating coprocessor or none.  A single installed version of the
12175 compiler can compile for any model or configuration, according to the
12176 options specified.
12178 Some configurations of the compiler also support additional special
12179 options, usually for compatibility with other compilers on the same
12180 platform.
12182 @c This list is ordered alphanumerically by subsection name.
12183 @c It should be the same order and spelling as these options are listed
12184 @c in Machine Dependent Options
12186 @menu
12187 * AArch64 Options::
12188 * Adapteva Epiphany Options::
12189 * ARC Options::
12190 * ARM Options::
12191 * AVR Options::
12192 * Blackfin Options::
12193 * C6X Options::
12194 * CRIS Options::
12195 * CR16 Options::
12196 * Darwin Options::
12197 * DEC Alpha Options::
12198 * FR30 Options::
12199 * FT32 Options::
12200 * FRV Options::
12201 * GNU/Linux Options::
12202 * H8/300 Options::
12203 * HPPA Options::
12204 * IA-64 Options::
12205 * LM32 Options::
12206 * M32C Options::
12207 * M32R/D Options::
12208 * M680x0 Options::
12209 * MCore Options::
12210 * MeP Options::
12211 * MicroBlaze Options::
12212 * MIPS Options::
12213 * MMIX Options::
12214 * MN10300 Options::
12215 * Moxie Options::
12216 * MSP430 Options::
12217 * NDS32 Options::
12218 * Nios II Options::
12219 * Nvidia PTX Options::
12220 * PDP-11 Options::
12221 * picoChip Options::
12222 * PowerPC Options::
12223 * RL78 Options::
12224 * RS/6000 and PowerPC Options::
12225 * RX Options::
12226 * S/390 and zSeries Options::
12227 * Score Options::
12228 * SH Options::
12229 * Solaris 2 Options::
12230 * SPARC Options::
12231 * SPU Options::
12232 * System V Options::
12233 * TILE-Gx Options::
12234 * TILEPro Options::
12235 * V850 Options::
12236 * VAX Options::
12237 * Visium Options::
12238 * VMS Options::
12239 * VxWorks Options::
12240 * x86 Options::
12241 * x86 Windows Options::
12242 * Xstormy16 Options::
12243 * Xtensa Options::
12244 * zSeries Options::
12245 @end menu
12247 @node AArch64 Options
12248 @subsection AArch64 Options
12249 @cindex AArch64 Options
12251 These options are defined for AArch64 implementations:
12253 @table @gcctabopt
12255 @item -mabi=@var{name}
12256 @opindex mabi
12257 Generate code for the specified data model.  Permissible values
12258 are @samp{ilp32} for SysV-like data model where int, long int and pointer
12259 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
12260 but long int and pointer are 64-bit.
12262 The default depends on the specific target configuration.  Note that
12263 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
12264 entire program with the same ABI, and link with a compatible set of libraries.
12266 @item -mbig-endian
12267 @opindex mbig-endian
12268 Generate big-endian code.  This is the default when GCC is configured for an
12269 @samp{aarch64_be-*-*} target.
12271 @item -mgeneral-regs-only
12272 @opindex mgeneral-regs-only
12273 Generate code which uses only the general-purpose registers.  This is equivalent
12274 to feature modifier @option{nofp} of @option{-march} or @option{-mcpu}, except
12275 that @option{-mgeneral-regs-only} takes precedence over any conflicting feature
12276 modifier regardless of sequence.
12278 @item -mlittle-endian
12279 @opindex mlittle-endian
12280 Generate little-endian code.  This is the default when GCC is configured for an
12281 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12283 @item -mcmodel=tiny
12284 @opindex mcmodel=tiny
12285 Generate code for the tiny code model.  The program and its statically defined
12286 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
12287 be statically or dynamically linked.  This model is not fully implemented and
12288 mostly treated as @samp{small}.
12290 @item -mcmodel=small
12291 @opindex mcmodel=small
12292 Generate code for the small code model.  The program and its statically defined
12293 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
12294 be statically or dynamically linked.  This is the default code model.
12296 @item -mcmodel=large
12297 @opindex mcmodel=large
12298 Generate code for the large code model.  This makes no assumptions about
12299 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
12300 statically linked only.
12302 @item -mstrict-align
12303 @opindex mstrict-align
12304 Do not assume that unaligned memory references are handled by the system.
12306 @item -momit-leaf-frame-pointer
12307 @itemx -mno-omit-leaf-frame-pointer
12308 @opindex momit-leaf-frame-pointer
12309 @opindex mno-omit-leaf-frame-pointer
12310 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
12311 default.
12313 @item -mtls-dialect=desc
12314 @opindex mtls-dialect=desc
12315 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12316 of TLS variables.  This is the default.
12318 @item -mtls-dialect=traditional
12319 @opindex mtls-dialect=traditional
12320 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12321 of TLS variables.
12323 @item -mtls-size=@var{size}
12324 @opindex mtls-size
12325 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
12326 This option depends on binutils higher than 2.25.
12328 @item -mfix-cortex-a53-835769
12329 @itemx -mno-fix-cortex-a53-835769
12330 @opindex mfix-cortex-a53-835769
12331 @opindex mno-fix-cortex-a53-835769
12332 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12333 This involves inserting a NOP instruction between memory instructions and
12334 64-bit integer multiply-accumulate instructions.
12336 @item -mfix-cortex-a53-843419
12337 @itemx -mno-fix-cortex-a53-843419
12338 @opindex mfix-cortex-a53-843419
12339 @opindex mno-fix-cortex-a53-843419
12340 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
12341 This erratum workaround is made at link time and this will only pass the
12342 corresponding flag to the linker.
12344 @item -march=@var{name}
12345 @opindex march
12346 Specify the name of the target architecture, optionally suffixed by one or
12347 more feature modifiers.  This option has the form
12348 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
12350 The permissible values for @var{arch} are @samp{armv8-a} or
12351 @samp{armv8.1-a}.
12353 For the permissible values for @var{feature}, see the sub-section on
12354 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12355 Feature Modifiers}.  Where conflicting feature modifiers are
12356 specified, the right-most feature is used.
12358 Additionally on native AArch64 GNU/Linux systems the value
12359 @samp{native} is available.  This option causes the compiler to pick the
12360 architecture of the host system.  If the compiler is unable to recognize the
12361 architecture of the host system this option has no effect.
12363 GCC uses @var{name} to determine what kind of instructions it can emit
12364 when generating assembly code.  If @option{-march} is specified
12365 without either of @option{-mtune} or @option{-mcpu} also being
12366 specified, the code is tuned to perform well across a range of target
12367 processors implementing the target architecture.
12369 @item -mtune=@var{name}
12370 @opindex mtune
12371 Specify the name of the target processor for which GCC should tune the
12372 performance of the code.  Permissible values for this option are:
12373 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
12374 @samp{exynos-m1}, @samp{thunderx}, @samp{xgene1}.
12376 Additionally, this option can specify that GCC should tune the performance
12377 of the code for a big.LITTLE system.  Permissible values for this
12378 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
12380 Additionally on native AArch64 GNU/Linux systems the value
12381 @samp{native} is available.  This option causes the compiler to pick
12382 the architecture of and tune the performance of the code for the
12383 processor of the host system.  If the compiler is unable to recognize
12384 the processor of the host system this option has no effect.
12386 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12387 are specified, the code is tuned to perform well across a range
12388 of target processors.
12390 This option cannot be suffixed by feature modifiers.
12392 @item -mcpu=@var{name}
12393 @opindex mcpu
12394 Specify the name of the target processor, optionally suffixed by one
12395 or more feature modifiers.  This option has the form
12396 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
12397 the permissible values for @var{cpu} are the same as those available
12398 for @option{-mtune}.  The permissible values for @var{feature} are
12399 documented in the sub-section on
12400 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12401 Feature Modifiers}.  Where conflicting feature modifiers are
12402 specified, the right-most feature is used.
12404 Additionally on native AArch64 GNU/Linux systems the value
12405 @samp{native} is available.  This option causes the compiler to tune
12406 the performance of the code for the processor of the host system.  If
12407 the compiler is unable to recognize the processor of the host system
12408 this option has no effect.
12410 GCC uses @var{name} to determine what kind of instructions it can emit when
12411 generating assembly code (as if by @option{-march}) and to determine
12412 the target processor for which to tune for performance (as if
12413 by @option{-mtune}).  Where this option is used in conjunction
12414 with @option{-march} or @option{-mtune}, those options take precedence
12415 over the appropriate part of this option.
12417 @item -moverride=@var{string}
12418 @opindex moverride
12419 Override tuning decisions made by the back-end in response to a
12420 @option{-mtune=} switch.  The syntax, semantics, and accepted values
12421 for @var{string} in this option are not guaranteed to be consistent
12422 across releases.
12424 This option is only intended to be useful when developing GCC.
12425 @end table
12427 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
12428 @anchor{aarch64-feature-modifiers}
12429 @cindex @option{-march} feature modifiers
12430 @cindex @option{-mcpu} feature modifiers
12431 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
12432 the following and their inverses @option{no@var{feature}}:
12434 @table @samp
12435 @item crc
12436 Enable CRC extension.
12437 @item crypto
12438 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
12439 instructions.
12440 @item fp
12441 Enable floating-point instructions.  This is on by default for all possible
12442 values for options @option{-march} and @option{-mcpu}.
12443 @item simd
12444 Enable Advanced SIMD instructions.  This also enables floating-point
12445 instructions.  This is on by default for all possible values for options
12446 @option{-march} and @option{-mcpu}.
12447 @item lse
12448 Enable Large System Extension instructions.
12449 @item pan
12450 Enable Privileged Access Never support.
12451 @item lor
12452 Enable Limited Ordering Regions support.
12453 @item rdma
12454 Enable ARMv8.1 Advanced SIMD instructions.  This implies Advanced SIMD
12455 is enabled.
12457 @end table
12459 That is, @option{crypto} implies @option{simd} implies @option{fp}.
12460 Conversely, @option{nofp} (or equivalently, @option{-mgeneral-regs-only})
12461 implies @option{nosimd} implies @option{nocrypto}.
12463 @node Adapteva Epiphany Options
12464 @subsection Adapteva Epiphany Options
12466 These @samp{-m} options are defined for Adapteva Epiphany:
12468 @table @gcctabopt
12469 @item -mhalf-reg-file
12470 @opindex mhalf-reg-file
12471 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12472 That allows code to run on hardware variants that lack these registers.
12474 @item -mprefer-short-insn-regs
12475 @opindex mprefer-short-insn-regs
12476 Preferrentially allocate registers that allow short instruction generation.
12477 This can result in increased instruction count, so this may either reduce or
12478 increase overall code size.
12480 @item -mbranch-cost=@var{num}
12481 @opindex mbranch-cost
12482 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12483 This cost is only a heuristic and is not guaranteed to produce
12484 consistent results across releases.
12486 @item -mcmove
12487 @opindex mcmove
12488 Enable the generation of conditional moves.
12490 @item -mnops=@var{num}
12491 @opindex mnops
12492 Emit @var{num} NOPs before every other generated instruction.
12494 @item -mno-soft-cmpsf
12495 @opindex mno-soft-cmpsf
12496 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12497 and test the flags.  This is faster than a software comparison, but can
12498 get incorrect results in the presence of NaNs, or when two different small
12499 numbers are compared such that their difference is calculated as zero.
12500 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12501 software comparisons.
12503 @item -mstack-offset=@var{num}
12504 @opindex mstack-offset
12505 Set the offset between the top of the stack and the stack pointer.
12506 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12507 can be used by leaf functions without stack allocation.
12508 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12509 Note also that this option changes the ABI; compiling a program with a
12510 different stack offset than the libraries have been compiled with
12511 generally does not work.
12512 This option can be useful if you want to evaluate if a different stack
12513 offset would give you better code, but to actually use a different stack
12514 offset to build working programs, it is recommended to configure the
12515 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12517 @item -mno-round-nearest
12518 @opindex mno-round-nearest
12519 Make the scheduler assume that the rounding mode has been set to
12520 truncating.  The default is @option{-mround-nearest}.
12522 @item -mlong-calls
12523 @opindex mlong-calls
12524 If not otherwise specified by an attribute, assume all calls might be beyond
12525 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12526 function address into a register before performing a (otherwise direct) call.
12527 This is the default.
12529 @item -mshort-calls
12530 @opindex short-calls
12531 If not otherwise specified by an attribute, assume all direct calls are
12532 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12533 for direct calls.  The default is @option{-mlong-calls}.
12535 @item -msmall16
12536 @opindex msmall16
12537 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12538 apply to function addresses for which @option{-mlong-calls} semantics
12539 are in effect.
12541 @item -mfp-mode=@var{mode}
12542 @opindex mfp-mode
12543 Set the prevailing mode of the floating-point unit.
12544 This determines the floating-point mode that is provided and expected
12545 at function call and return time.  Making this mode match the mode you
12546 predominantly need at function start can make your programs smaller and
12547 faster by avoiding unnecessary mode switches.
12549 @var{mode} can be set to one the following values:
12551 @table @samp
12552 @item caller
12553 Any mode at function entry is valid, and retained or restored when
12554 the function returns, and when it calls other functions.
12555 This mode is useful for compiling libraries or other compilation units
12556 you might want to incorporate into different programs with different
12557 prevailing FPU modes, and the convenience of being able to use a single
12558 object file outweighs the size and speed overhead for any extra
12559 mode switching that might be needed, compared with what would be needed
12560 with a more specific choice of prevailing FPU mode.
12562 @item truncate
12563 This is the mode used for floating-point calculations with
12564 truncating (i.e.@: round towards zero) rounding mode.  That includes
12565 conversion from floating point to integer.
12567 @item round-nearest
12568 This is the mode used for floating-point calculations with
12569 round-to-nearest-or-even rounding mode.
12571 @item int
12572 This is the mode used to perform integer calculations in the FPU, e.g.@:
12573 integer multiply, or integer multiply-and-accumulate.
12574 @end table
12576 The default is @option{-mfp-mode=caller}
12578 @item -mnosplit-lohi
12579 @itemx -mno-postinc
12580 @itemx -mno-postmodify
12581 @opindex mnosplit-lohi
12582 @opindex mno-postinc
12583 @opindex mno-postmodify
12584 Code generation tweaks that disable, respectively, splitting of 32-bit
12585 loads, generation of post-increment addresses, and generation of
12586 post-modify addresses.  The defaults are @option{msplit-lohi},
12587 @option{-mpost-inc}, and @option{-mpost-modify}.
12589 @item -mnovect-double
12590 @opindex mno-vect-double
12591 Change the preferred SIMD mode to SImode.  The default is
12592 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12594 @item -max-vect-align=@var{num}
12595 @opindex max-vect-align
12596 The maximum alignment for SIMD vector mode types.
12597 @var{num} may be 4 or 8.  The default is 8.
12598 Note that this is an ABI change, even though many library function
12599 interfaces are unaffected if they don't use SIMD vector modes
12600 in places that affect size and/or alignment of relevant types.
12602 @item -msplit-vecmove-early
12603 @opindex msplit-vecmove-early
12604 Split vector moves into single word moves before reload.  In theory this
12605 can give better register allocation, but so far the reverse seems to be
12606 generally the case.
12608 @item -m1reg-@var{reg}
12609 @opindex m1reg-
12610 Specify a register to hold the constant @minus{}1, which makes loading small negative
12611 constants and certain bitmasks faster.
12612 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12613 which specify use of that register as a fixed register,
12614 and @samp{none}, which means that no register is used for this
12615 purpose.  The default is @option{-m1reg-none}.
12617 @end table
12619 @node ARC Options
12620 @subsection ARC Options
12621 @cindex ARC options
12623 The following options control the architecture variant for which code
12624 is being compiled:
12626 @c architecture variants
12627 @table @gcctabopt
12629 @item -mbarrel-shifter
12630 @opindex mbarrel-shifter
12631 Generate instructions supported by barrel shifter.  This is the default
12632 unless @option{-mcpu=ARC601} is in effect.
12634 @item -mcpu=@var{cpu}
12635 @opindex mcpu
12636 Set architecture type, register usage, and instruction scheduling
12637 parameters for @var{cpu}.  There are also shortcut alias options
12638 available for backward compatibility and convenience.  Supported
12639 values for @var{cpu} are
12641 @table @samp
12642 @opindex mA6
12643 @opindex mARC600
12644 @item ARC600
12645 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12647 @item ARC601
12648 @opindex mARC601
12649 Compile for ARC601.  Alias: @option{-mARC601}.
12651 @item ARC700
12652 @opindex mA7
12653 @opindex mARC700
12654 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12655 This is the default when configured with @option{--with-cpu=arc700}@.
12656 @end table
12658 @item -mdpfp
12659 @opindex mdpfp
12660 @itemx -mdpfp-compact
12661 @opindex mdpfp-compact
12662 FPX: Generate Double Precision FPX instructions, tuned for the compact
12663 implementation.
12665 @item -mdpfp-fast
12666 @opindex mdpfp-fast
12667 FPX: Generate Double Precision FPX instructions, tuned for the fast
12668 implementation.
12670 @item -mno-dpfp-lrsr
12671 @opindex mno-dpfp-lrsr
12672 Disable LR and SR instructions from using FPX extension aux registers.
12674 @item -mea
12675 @opindex mea
12676 Generate Extended arithmetic instructions.  Currently only
12677 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12678 supported.  This is always enabled for @option{-mcpu=ARC700}.
12680 @item -mno-mpy
12681 @opindex mno-mpy
12682 Do not generate mpy instructions for ARC700.
12684 @item -mmul32x16
12685 @opindex mmul32x16
12686 Generate 32x16 bit multiply and mac instructions.
12688 @item -mmul64
12689 @opindex mmul64
12690 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
12692 @item -mnorm
12693 @opindex mnorm
12694 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
12695 is in effect.
12697 @item -mspfp
12698 @opindex mspfp
12699 @itemx -mspfp-compact
12700 @opindex mspfp-compact
12701 FPX: Generate Single Precision FPX instructions, tuned for the compact
12702 implementation.
12704 @item -mspfp-fast
12705 @opindex mspfp-fast
12706 FPX: Generate Single Precision FPX instructions, tuned for the fast
12707 implementation.
12709 @item -msimd
12710 @opindex msimd
12711 Enable generation of ARC SIMD instructions via target-specific
12712 builtins.  Only valid for @option{-mcpu=ARC700}.
12714 @item -msoft-float
12715 @opindex msoft-float
12716 This option ignored; it is provided for compatibility purposes only.
12717 Software floating point code is emitted by default, and this default
12718 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12719 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12720 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12722 @item -mswap
12723 @opindex mswap
12724 Generate swap instructions.
12726 @end table
12728 The following options are passed through to the assembler, and also
12729 define preprocessor macro symbols.
12731 @c Flags used by the assembler, but for which we define preprocessor
12732 @c macro symbols as well.
12733 @table @gcctabopt
12734 @item -mdsp-packa
12735 @opindex mdsp-packa
12736 Passed down to the assembler to enable the DSP Pack A extensions.
12737 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12739 @item -mdvbf
12740 @opindex mdvbf
12741 Passed down to the assembler to enable the dual viterbi butterfly
12742 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12744 @c ARC700 4.10 extension instruction
12745 @item -mlock
12746 @opindex mlock
12747 Passed down to the assembler to enable the Locked Load/Store
12748 Conditional extension.  Also sets the preprocessor symbol
12749 @code{__Xlock}.
12751 @item -mmac-d16
12752 @opindex mmac-d16
12753 Passed down to the assembler.  Also sets the preprocessor symbol
12754 @code{__Xxmac_d16}.
12756 @item -mmac-24
12757 @opindex mmac-24
12758 Passed down to the assembler.  Also sets the preprocessor symbol
12759 @code{__Xxmac_24}.
12761 @c ARC700 4.10 extension instruction
12762 @item -mrtsc
12763 @opindex mrtsc
12764 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12765 extension instruction.  Also sets the preprocessor symbol
12766 @code{__Xrtsc}.
12768 @c ARC700 4.10 extension instruction
12769 @item -mswape
12770 @opindex mswape
12771 Passed down to the assembler to enable the swap byte ordering
12772 extension instruction.  Also sets the preprocessor symbol
12773 @code{__Xswape}.
12775 @item -mtelephony
12776 @opindex mtelephony
12777 Passed down to the assembler to enable dual and single operand
12778 instructions for telephony.  Also sets the preprocessor symbol
12779 @code{__Xtelephony}.
12781 @item -mxy
12782 @opindex mxy
12783 Passed down to the assembler to enable the XY Memory extension.  Also
12784 sets the preprocessor symbol @code{__Xxy}.
12786 @end table
12788 The following options control how the assembly code is annotated:
12790 @c Assembly annotation options
12791 @table @gcctabopt
12792 @item -misize
12793 @opindex misize
12794 Annotate assembler instructions with estimated addresses.
12796 @item -mannotate-align
12797 @opindex mannotate-align
12798 Explain what alignment considerations lead to the decision to make an
12799 instruction short or long.
12801 @end table
12803 The following options are passed through to the linker:
12805 @c options passed through to the linker
12806 @table @gcctabopt
12807 @item -marclinux
12808 @opindex marclinux
12809 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12810 This option is enabled by default in tool chains built for
12811 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12812 when profiling is not requested.
12814 @item -marclinux_prof
12815 @opindex marclinux_prof
12816 Passed through to the linker, to specify use of the
12817 @code{arclinux_prof} emulation.  This option is enabled by default in
12818 tool chains built for @w{@code{arc-linux-uclibc}} and
12819 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12821 @end table
12823 The following options control the semantics of generated code:
12825 @c semantically relevant code generation options
12826 @table @gcctabopt
12827 @item -mepilogue-cfi
12828 @opindex mepilogue-cfi
12829 Enable generation of call frame information for epilogues.
12831 @item -mno-epilogue-cfi
12832 @opindex mno-epilogue-cfi
12833 Disable generation of call frame information for epilogues.
12835 @item -mlong-calls
12836 @opindex mlong-calls
12837 Generate call insns as register indirect calls, thus providing access
12838 to the full 32-bit address range.
12840 @item -mmedium-calls
12841 @opindex mmedium-calls
12842 Don't use less than 25 bit addressing range for calls, which is the
12843 offset available for an unconditional branch-and-link
12844 instruction.  Conditional execution of function calls is suppressed, to
12845 allow use of the 25-bit range, rather than the 21-bit range with
12846 conditional branch-and-link.  This is the default for tool chains built
12847 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12849 @item -mno-sdata
12850 @opindex mno-sdata
12851 Do not generate sdata references.  This is the default for tool chains
12852 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12853 targets.
12855 @item -mucb-mcount
12856 @opindex mucb-mcount
12857 Instrument with mcount calls as used in UCB code.  I.e. do the
12858 counting in the callee, not the caller.  By default ARC instrumentation
12859 counts in the caller.
12861 @item -mvolatile-cache
12862 @opindex mvolatile-cache
12863 Use ordinarily cached memory accesses for volatile references.  This is the
12864 default.
12866 @item -mno-volatile-cache
12867 @opindex mno-volatile-cache
12868 Enable cache bypass for volatile references.
12870 @end table
12872 The following options fine tune code generation:
12873 @c code generation tuning options
12874 @table @gcctabopt
12875 @item -malign-call
12876 @opindex malign-call
12877 Do alignment optimizations for call instructions.
12879 @item -mauto-modify-reg
12880 @opindex mauto-modify-reg
12881 Enable the use of pre/post modify with register displacement.
12883 @item -mbbit-peephole
12884 @opindex mbbit-peephole
12885 Enable bbit peephole2.
12887 @item -mno-brcc
12888 @opindex mno-brcc
12889 This option disables a target-specific pass in @file{arc_reorg} to
12890 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12891 generation driven by the combiner pass.
12893 @item -mcase-vector-pcrel
12894 @opindex mcase-vector-pcrel
12895 Use pc-relative switch case tables - this enables case table shortening.
12896 This is the default for @option{-Os}.
12898 @item -mcompact-casesi
12899 @opindex mcompact-casesi
12900 Enable compact casesi pattern.
12901 This is the default for @option{-Os}.
12903 @item -mno-cond-exec
12904 @opindex mno-cond-exec
12905 Disable ARCompact specific pass to generate conditional execution instructions.
12906 Due to delay slot scheduling and interactions between operand numbers,
12907 literal sizes, instruction lengths, and the support for conditional execution,
12908 the target-independent pass to generate conditional execution is often lacking,
12909 so the ARC port has kept a special pass around that tries to find more
12910 conditional execution generating opportunities after register allocation,
12911 branch shortening, and delay slot scheduling have been done.  This pass
12912 generally, but not always, improves performance and code size, at the cost of
12913 extra compilation time, which is why there is an option to switch it off.
12914 If you have a problem with call instructions exceeding their allowable
12915 offset range because they are conditionalized, you should consider using
12916 @option{-mmedium-calls} instead.
12918 @item -mearly-cbranchsi
12919 @opindex mearly-cbranchsi
12920 Enable pre-reload use of the cbranchsi pattern.
12922 @item -mexpand-adddi
12923 @opindex mexpand-adddi
12924 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12925 @code{add.f}, @code{adc} etc.
12927 @item -mindexed-loads
12928 @opindex mindexed-loads
12929 Enable the use of indexed loads.  This can be problematic because some
12930 optimizers then assume that indexed stores exist, which is not
12931 the case.
12933 @item -mlra
12934 @opindex mlra
12935 Enable Local Register Allocation.  This is still experimental for ARC,
12936 so by default the compiler uses standard reload
12937 (i.e. @option{-mno-lra}).
12939 @item -mlra-priority-none
12940 @opindex mlra-priority-none
12941 Don't indicate any priority for target registers.
12943 @item -mlra-priority-compact
12944 @opindex mlra-priority-compact
12945 Indicate target register priority for r0..r3 / r12..r15.
12947 @item -mlra-priority-noncompact
12948 @opindex mlra-priority-noncompact
12949 Reduce target regsiter priority for r0..r3 / r12..r15.
12951 @item -mno-millicode
12952 @opindex mno-millicode
12953 When optimizing for size (using @option{-Os}), prologues and epilogues
12954 that have to save or restore a large number of registers are often
12955 shortened by using call to a special function in libgcc; this is
12956 referred to as a @emph{millicode} call.  As these calls can pose
12957 performance issues, and/or cause linking issues when linking in a
12958 nonstandard way, this option is provided to turn off millicode call
12959 generation.
12961 @item -mmixed-code
12962 @opindex mmixed-code
12963 Tweak register allocation to help 16-bit instruction generation.
12964 This generally has the effect of decreasing the average instruction size
12965 while increasing the instruction count.
12967 @item -mq-class
12968 @opindex mq-class
12969 Enable 'q' instruction alternatives.
12970 This is the default for @option{-Os}.
12972 @item -mRcq
12973 @opindex mRcq
12974 Enable Rcq constraint handling - most short code generation depends on this.
12975 This is the default.
12977 @item -mRcw
12978 @opindex mRcw
12979 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12980 This is the default.
12982 @item -msize-level=@var{level}
12983 @opindex msize-level
12984 Fine-tune size optimization with regards to instruction lengths and alignment.
12985 The recognized values for @var{level} are:
12986 @table @samp
12987 @item 0
12988 No size optimization.  This level is deprecated and treated like @samp{1}.
12990 @item 1
12991 Short instructions are used opportunistically.
12993 @item 2
12994 In addition, alignment of loops and of code after barriers are dropped.
12996 @item 3
12997 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12999 @end table
13001 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
13002 the behavior when this is not set is equivalent to level @samp{1}.
13004 @item -mtune=@var{cpu}
13005 @opindex mtune
13006 Set instruction scheduling parameters for @var{cpu}, overriding any implied
13007 by @option{-mcpu=}.
13009 Supported values for @var{cpu} are
13011 @table @samp
13012 @item ARC600
13013 Tune for ARC600 cpu.
13015 @item ARC601
13016 Tune for ARC601 cpu.
13018 @item ARC700
13019 Tune for ARC700 cpu with standard multiplier block.
13021 @item ARC700-xmac
13022 Tune for ARC700 cpu with XMAC block.
13024 @item ARC725D
13025 Tune for ARC725D cpu.
13027 @item ARC750D
13028 Tune for ARC750D cpu.
13030 @end table
13032 @item -mmultcost=@var{num}
13033 @opindex mmultcost
13034 Cost to assume for a multiply instruction, with @samp{4} being equal to a
13035 normal instruction.
13037 @item -munalign-prob-threshold=@var{probability}
13038 @opindex munalign-prob-threshold
13039 Set probability threshold for unaligning branches.
13040 When tuning for @samp{ARC700} and optimizing for speed, branches without
13041 filled delay slot are preferably emitted unaligned and long, unless
13042 profiling indicates that the probability for the branch to be taken
13043 is below @var{probability}.  @xref{Cross-profiling}.
13044 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13046 @end table
13048 The following options are maintained for backward compatibility, but
13049 are now deprecated and will be removed in a future release:
13051 @c Deprecated options
13052 @table @gcctabopt
13054 @item -margonaut
13055 @opindex margonaut
13056 Obsolete FPX.
13058 @item -mbig-endian
13059 @opindex mbig-endian
13060 @itemx -EB
13061 @opindex EB
13062 Compile code for big endian targets.  Use of these options is now
13063 deprecated.  Users wanting big-endian code, should use the
13064 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13065 building the tool chain, for which big-endian is the default.
13067 @item -mlittle-endian
13068 @opindex mlittle-endian
13069 @itemx -EL
13070 @opindex EL
13071 Compile code for little endian targets.  Use of these options is now
13072 deprecated.  Users wanting little-endian code should use the
13073 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13074 building the tool chain, for which little-endian is the default.
13076 @item -mbarrel_shifter
13077 @opindex mbarrel_shifter
13078 Replaced by @option{-mbarrel-shifter}.
13080 @item -mdpfp_compact
13081 @opindex mdpfp_compact
13082 Replaced by @option{-mdpfp-compact}.
13084 @item -mdpfp_fast
13085 @opindex mdpfp_fast
13086 Replaced by @option{-mdpfp-fast}.
13088 @item -mdsp_packa
13089 @opindex mdsp_packa
13090 Replaced by @option{-mdsp-packa}.
13092 @item -mEA
13093 @opindex mEA
13094 Replaced by @option{-mea}.
13096 @item -mmac_24
13097 @opindex mmac_24
13098 Replaced by @option{-mmac-24}.
13100 @item -mmac_d16
13101 @opindex mmac_d16
13102 Replaced by @option{-mmac-d16}.
13104 @item -mspfp_compact
13105 @opindex mspfp_compact
13106 Replaced by @option{-mspfp-compact}.
13108 @item -mspfp_fast
13109 @opindex mspfp_fast
13110 Replaced by @option{-mspfp-fast}.
13112 @item -mtune=@var{cpu}
13113 @opindex mtune
13114 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13115 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13116 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13118 @item -multcost=@var{num}
13119 @opindex multcost
13120 Replaced by @option{-mmultcost}.
13122 @end table
13124 @node ARM Options
13125 @subsection ARM Options
13126 @cindex ARM options
13128 These @samp{-m} options are defined for the ARM port:
13130 @table @gcctabopt
13131 @item -mabi=@var{name}
13132 @opindex mabi
13133 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13134 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13136 @item -mapcs-frame
13137 @opindex mapcs-frame
13138 Generate a stack frame that is compliant with the ARM Procedure Call
13139 Standard for all functions, even if this is not strictly necessary for
13140 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13141 with this option causes the stack frames not to be generated for
13142 leaf functions.  The default is @option{-mno-apcs-frame}.
13143 This option is deprecated.
13145 @item -mapcs
13146 @opindex mapcs
13147 This is a synonym for @option{-mapcs-frame} and is deprecated.
13149 @ignore
13150 @c not currently implemented
13151 @item -mapcs-stack-check
13152 @opindex mapcs-stack-check
13153 Generate code to check the amount of stack space available upon entry to
13154 every function (that actually uses some stack space).  If there is
13155 insufficient space available then either the function
13156 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13157 called, depending upon the amount of stack space required.  The runtime
13158 system is required to provide these functions.  The default is
13159 @option{-mno-apcs-stack-check}, since this produces smaller code.
13161 @c not currently implemented
13162 @item -mapcs-float
13163 @opindex mapcs-float
13164 Pass floating-point arguments using the floating-point registers.  This is
13165 one of the variants of the APCS@.  This option is recommended if the
13166 target hardware has a floating-point unit or if a lot of floating-point
13167 arithmetic is going to be performed by the code.  The default is
13168 @option{-mno-apcs-float}, since the size of integer-only code is 
13169 slightly increased if @option{-mapcs-float} is used.
13171 @c not currently implemented
13172 @item -mapcs-reentrant
13173 @opindex mapcs-reentrant
13174 Generate reentrant, position-independent code.  The default is
13175 @option{-mno-apcs-reentrant}.
13176 @end ignore
13178 @item -mthumb-interwork
13179 @opindex mthumb-interwork
13180 Generate code that supports calling between the ARM and Thumb
13181 instruction sets.  Without this option, on pre-v5 architectures, the
13182 two instruction sets cannot be reliably used inside one program.  The
13183 default is @option{-mno-thumb-interwork}, since slightly larger code
13184 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13185 configurations this option is meaningless.
13187 @item -mno-sched-prolog
13188 @opindex mno-sched-prolog
13189 Prevent the reordering of instructions in the function prologue, or the
13190 merging of those instruction with the instructions in the function's
13191 body.  This means that all functions start with a recognizable set
13192 of instructions (or in fact one of a choice from a small set of
13193 different function prologues), and this information can be used to
13194 locate the start of functions inside an executable piece of code.  The
13195 default is @option{-msched-prolog}.
13197 @item -mfloat-abi=@var{name}
13198 @opindex mfloat-abi
13199 Specifies which floating-point ABI to use.  Permissible values
13200 are: @samp{soft}, @samp{softfp} and @samp{hard}.
13202 Specifying @samp{soft} causes GCC to generate output containing
13203 library calls for floating-point operations.
13204 @samp{softfp} allows the generation of code using hardware floating-point
13205 instructions, but still uses the soft-float calling conventions.
13206 @samp{hard} allows generation of floating-point instructions
13207 and uses FPU-specific calling conventions.
13209 The default depends on the specific target configuration.  Note that
13210 the hard-float and soft-float ABIs are not link-compatible; you must
13211 compile your entire program with the same ABI, and link with a
13212 compatible set of libraries.
13214 @item -mlittle-endian
13215 @opindex mlittle-endian
13216 Generate code for a processor running in little-endian mode.  This is
13217 the default for all standard configurations.
13219 @item -mbig-endian
13220 @opindex mbig-endian
13221 Generate code for a processor running in big-endian mode; the default is
13222 to compile code for a little-endian processor.
13224 @item -march=@var{name}
13225 @opindex march
13226 This specifies the name of the target ARM architecture.  GCC uses this
13227 name to determine what kind of instructions it can emit when generating
13228 assembly code.  This option can be used in conjunction with or instead
13229 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
13230 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
13231 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
13232 @samp{armv6}, @samp{armv6j},
13233 @samp{armv6t2}, @samp{armv6z}, @samp{armv6kz}, @samp{armv6-m},
13234 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
13235 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
13236 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
13238 @option{-march=armv7ve} is the armv7-a architecture with virtualization
13239 extensions.
13241 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
13242 architecture together with the optional CRC32 extensions.
13244 @option{-march=native} causes the compiler to auto-detect the architecture
13245 of the build computer.  At present, this feature is only supported on
13246 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13247 is unsuccessful the option has no effect.
13249 @item -mtune=@var{name}
13250 @opindex mtune
13251 This option specifies the name of the target ARM processor for
13252 which GCC should tune the performance of the code.
13253 For some ARM implementations better performance can be obtained by using
13254 this option.
13255 Permissible names are: @samp{arm2}, @samp{arm250},
13256 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
13257 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
13258 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
13259 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
13260 @samp{arm720},
13261 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
13262 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
13263 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
13264 @samp{strongarm1110},
13265 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
13266 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
13267 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
13268 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
13269 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
13270 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
13271 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
13272 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
13273 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
13274 @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
13275 @samp{cortex-r4},
13276 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
13277 @samp{cortex-m4},
13278 @samp{cortex-m3},
13279 @samp{cortex-m1},
13280 @samp{cortex-m0},
13281 @samp{cortex-m0plus},
13282 @samp{cortex-m1.small-multiply},
13283 @samp{cortex-m0.small-multiply},
13284 @samp{cortex-m0plus.small-multiply},
13285 @samp{exynos-m1},
13286 @samp{marvell-pj4},
13287 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
13288 @samp{fa526}, @samp{fa626},
13289 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
13290 @samp{xgene1}.
13292 Additionally, this option can specify that GCC should tune the performance
13293 of the code for a big.LITTLE system.  Permissible names are:
13294 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
13295 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
13297 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
13298 performance for a blend of processors within architecture @var{arch}.
13299 The aim is to generate code that run well on the current most popular
13300 processors, balancing between optimizations that benefit some CPUs in the
13301 range, and avoiding performance pitfalls of other CPUs.  The effects of
13302 this option may change in future GCC versions as CPU models come and go.
13304 @option{-mtune=native} causes the compiler to auto-detect the CPU
13305 of the build computer.  At present, this feature is only supported on
13306 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
13307 unsuccessful the option has no effect.
13309 @item -mcpu=@var{name}
13310 @opindex mcpu
13311 This specifies the name of the target ARM processor.  GCC uses this name
13312 to derive the name of the target ARM architecture (as if specified
13313 by @option{-march}) and the ARM processor type for which to tune for
13314 performance (as if specified by @option{-mtune}).  Where this option
13315 is used in conjunction with @option{-march} or @option{-mtune},
13316 those options take precedence over the appropriate part of this option.
13318 Permissible names for this option are the same as those for
13319 @option{-mtune}.
13321 @option{-mcpu=generic-@var{arch}} is also permissible, and is
13322 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
13323 See @option{-mtune} for more information.
13325 @option{-mcpu=native} causes the compiler to auto-detect the CPU
13326 of the build computer.  At present, this feature is only supported on
13327 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13328 is unsuccessful the option has no effect.
13330 @item -mfpu=@var{name}
13331 @opindex mfpu
13332 This specifies what floating-point hardware (or hardware emulation) is
13333 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
13334 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
13335 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
13336 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
13337 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
13338 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
13340 If @option{-msoft-float} is specified this specifies the format of
13341 floating-point values.
13343 If the selected floating-point hardware includes the NEON extension
13344 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
13345 operations are not generated by GCC's auto-vectorization pass unless
13346 @option{-funsafe-math-optimizations} is also specified.  This is
13347 because NEON hardware does not fully implement the IEEE 754 standard for
13348 floating-point arithmetic (in particular denormal values are treated as
13349 zero), so the use of NEON instructions may lead to a loss of precision.
13351 @item -mfp16-format=@var{name}
13352 @opindex mfp16-format
13353 Specify the format of the @code{__fp16} half-precision floating-point type.
13354 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
13355 the default is @samp{none}, in which case the @code{__fp16} type is not
13356 defined.  @xref{Half-Precision}, for more information.
13358 @item -mstructure-size-boundary=@var{n}
13359 @opindex mstructure-size-boundary
13360 The sizes of all structures and unions are rounded up to a multiple
13361 of the number of bits set by this option.  Permissible values are 8, 32
13362 and 64.  The default value varies for different toolchains.  For the COFF
13363 targeted toolchain the default value is 8.  A value of 64 is only allowed
13364 if the underlying ABI supports it.
13366 Specifying a larger number can produce faster, more efficient code, but
13367 can also increase the size of the program.  Different values are potentially
13368 incompatible.  Code compiled with one value cannot necessarily expect to
13369 work with code or libraries compiled with another value, if they exchange
13370 information using structures or unions.
13372 @item -mabort-on-noreturn
13373 @opindex mabort-on-noreturn
13374 Generate a call to the function @code{abort} at the end of a
13375 @code{noreturn} function.  It is executed if the function tries to
13376 return.
13378 @item -mlong-calls
13379 @itemx -mno-long-calls
13380 @opindex mlong-calls
13381 @opindex mno-long-calls
13382 Tells the compiler to perform function calls by first loading the
13383 address of the function into a register and then performing a subroutine
13384 call on this register.  This switch is needed if the target function
13385 lies outside of the 64-megabyte addressing range of the offset-based
13386 version of subroutine call instruction.
13388 Even if this switch is enabled, not all function calls are turned
13389 into long calls.  The heuristic is that static functions, functions
13390 that have the @code{short_call} attribute, functions that are inside
13391 the scope of a @code{#pragma no_long_calls} directive, and functions whose
13392 definitions have already been compiled within the current compilation
13393 unit are not turned into long calls.  The exceptions to this rule are
13394 that weak function definitions, functions with the @code{long_call}
13395 attribute or the @code{section} attribute, and functions that are within
13396 the scope of a @code{#pragma long_calls} directive are always
13397 turned into long calls.
13399 This feature is not enabled by default.  Specifying
13400 @option{-mno-long-calls} restores the default behavior, as does
13401 placing the function calls within the scope of a @code{#pragma
13402 long_calls_off} directive.  Note these switches have no effect on how
13403 the compiler generates code to handle function calls via function
13404 pointers.
13406 @item -msingle-pic-base
13407 @opindex msingle-pic-base
13408 Treat the register used for PIC addressing as read-only, rather than
13409 loading it in the prologue for each function.  The runtime system is
13410 responsible for initializing this register with an appropriate value
13411 before execution begins.
13413 @item -mpic-register=@var{reg}
13414 @opindex mpic-register
13415 Specify the register to be used for PIC addressing.
13416 For standard PIC base case, the default is any suitable register
13417 determined by compiler.  For single PIC base case, the default is
13418 @samp{R9} if target is EABI based or stack-checking is enabled,
13419 otherwise the default is @samp{R10}.
13421 @item -mpic-data-is-text-relative
13422 @opindex mpic-data-is-text-relative
13423 Assume that each data segments are relative to text segment at load time.
13424 Therefore, it permits addressing data using PC-relative operations.
13425 This option is on by default for targets other than VxWorks RTP.
13427 @item -mpoke-function-name
13428 @opindex mpoke-function-name
13429 Write the name of each function into the text section, directly
13430 preceding the function prologue.  The generated code is similar to this:
13432 @smallexample
13433      t0
13434          .ascii "arm_poke_function_name", 0
13435          .align
13436      t1
13437          .word 0xff000000 + (t1 - t0)
13438      arm_poke_function_name
13439          mov     ip, sp
13440          stmfd   sp!, @{fp, ip, lr, pc@}
13441          sub     fp, ip, #4
13442 @end smallexample
13444 When performing a stack backtrace, code can inspect the value of
13445 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13446 location @code{pc - 12} and the top 8 bits are set, then we know that
13447 there is a function name embedded immediately preceding this location
13448 and has length @code{((pc[-3]) & 0xff000000)}.
13450 @item -mthumb
13451 @itemx -marm
13452 @opindex marm
13453 @opindex mthumb
13455 Select between generating code that executes in ARM and Thumb
13456 states.  The default for most configurations is to generate code
13457 that executes in ARM state, but the default can be changed by
13458 configuring GCC with the @option{--with-mode=}@var{state}
13459 configure option.
13461 You can also override the ARM and Thumb mode for each function
13462 by using the @code{target("thumb")} and @code{target("arm")} function attributes
13463 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
13465 @item -mtpcs-frame
13466 @opindex mtpcs-frame
13467 Generate a stack frame that is compliant with the Thumb Procedure Call
13468 Standard for all non-leaf functions.  (A leaf function is one that does
13469 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13471 @item -mtpcs-leaf-frame
13472 @opindex mtpcs-leaf-frame
13473 Generate a stack frame that is compliant with the Thumb Procedure Call
13474 Standard for all leaf functions.  (A leaf function is one that does
13475 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13477 @item -mcallee-super-interworking
13478 @opindex mcallee-super-interworking
13479 Gives all externally visible functions in the file being compiled an ARM
13480 instruction set header which switches to Thumb mode before executing the
13481 rest of the function.  This allows these functions to be called from
13482 non-interworking code.  This option is not valid in AAPCS configurations
13483 because interworking is enabled by default.
13485 @item -mcaller-super-interworking
13486 @opindex mcaller-super-interworking
13487 Allows calls via function pointers (including virtual functions) to
13488 execute correctly regardless of whether the target code has been
13489 compiled for interworking or not.  There is a small overhead in the cost
13490 of executing a function pointer if this option is enabled.  This option
13491 is not valid in AAPCS configurations because interworking is enabled
13492 by default.
13494 @item -mtp=@var{name}
13495 @opindex mtp
13496 Specify the access model for the thread local storage pointer.  The valid
13497 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
13498 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
13499 (supported in the arm6k architecture), and @samp{auto}, which uses the
13500 best available method for the selected processor.  The default setting is
13501 @samp{auto}.
13503 @item -mtls-dialect=@var{dialect}
13504 @opindex mtls-dialect
13505 Specify the dialect to use for accessing thread local storage.  Two
13506 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13507 @samp{gnu} dialect selects the original GNU scheme for supporting
13508 local and global dynamic TLS models.  The @samp{gnu2} dialect
13509 selects the GNU descriptor scheme, which provides better performance
13510 for shared libraries.  The GNU descriptor scheme is compatible with
13511 the original scheme, but does require new assembler, linker and
13512 library support.  Initial and local exec TLS models are unaffected by
13513 this option and always use the original scheme.
13515 @item -mword-relocations
13516 @opindex mword-relocations
13517 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13518 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13519 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13520 is specified.
13522 @item -mfix-cortex-m3-ldrd
13523 @opindex mfix-cortex-m3-ldrd
13524 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13525 with overlapping destination and base registers are used.  This option avoids
13526 generating these instructions.  This option is enabled by default when
13527 @option{-mcpu=cortex-m3} is specified.
13529 @item -munaligned-access
13530 @itemx -mno-unaligned-access
13531 @opindex munaligned-access
13532 @opindex mno-unaligned-access
13533 Enables (or disables) reading and writing of 16- and 32- bit values
13534 from addresses that are not 16- or 32- bit aligned.  By default
13535 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13536 architectures, and enabled for all other architectures.  If unaligned
13537 access is not enabled then words in packed data structures are
13538 accessed a byte at a time.
13540 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
13541 generated object file to either true or false, depending upon the
13542 setting of this option.  If unaligned access is enabled then the
13543 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
13544 defined.
13546 @item -mneon-for-64bits
13547 @opindex mneon-for-64bits
13548 Enables using Neon to handle scalar 64-bits operations. This is
13549 disabled by default since the cost of moving data from core registers
13550 to Neon is high.
13552 @item -mslow-flash-data
13553 @opindex mslow-flash-data
13554 Assume loading data from flash is slower than fetching instruction.
13555 Therefore literal load is minimized for better performance.
13556 This option is only supported when compiling for ARMv7 M-profile and
13557 off by default.
13559 @item -masm-syntax-unified
13560 @opindex masm-syntax-unified
13561 Assume inline assembler is using unified asm syntax.  The default is
13562 currently off which implies divided syntax.  Currently this option is
13563 available only for Thumb1 and has no effect on ARM state and Thumb2.
13564 However, this may change in future releases of GCC.  Divided syntax
13565 should be considered deprecated.
13567 @item -mrestrict-it
13568 @opindex mrestrict-it
13569 Restricts generation of IT blocks to conform to the rules of ARMv8.
13570 IT blocks can only contain a single 16-bit instruction from a select
13571 set of instructions. This option is on by default for ARMv8 Thumb mode.
13573 @item -mprint-tune-info
13574 @opindex mprint-tune-info
13575 Print CPU tuning information as comment in assembler file.  This is
13576 an option used only for regression testing of the compiler and not
13577 intended for ordinary use in compiling code.  This option is disabled
13578 by default.
13579 @end table
13581 @node AVR Options
13582 @subsection AVR Options
13583 @cindex AVR Options
13585 These options are defined for AVR implementations:
13587 @table @gcctabopt
13588 @item -mmcu=@var{mcu}
13589 @opindex mmcu
13590 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13592 The default for this option is@tie{}@samp{avr2}.
13594 GCC supports the following AVR devices and ISAs:
13596 @include avr-mmcu.texi
13598 @item -maccumulate-args
13599 @opindex maccumulate-args
13600 Accumulate outgoing function arguments and acquire/release the needed
13601 stack space for outgoing function arguments once in function
13602 prologue/epilogue.  Without this option, outgoing arguments are pushed
13603 before calling a function and popped afterwards.
13605 Popping the arguments after the function call can be expensive on
13606 AVR so that accumulating the stack space might lead to smaller
13607 executables because arguments need not to be removed from the
13608 stack after such a function call.
13610 This option can lead to reduced code size for functions that perform
13611 several calls to functions that get their arguments on the stack like
13612 calls to printf-like functions.
13614 @item -mbranch-cost=@var{cost}
13615 @opindex mbranch-cost
13616 Set the branch costs for conditional branch instructions to
13617 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13618 integers. The default branch cost is 0.
13620 @item -mcall-prologues
13621 @opindex mcall-prologues
13622 Functions prologues/epilogues are expanded as calls to appropriate
13623 subroutines.  Code size is smaller.
13625 @item -mint8
13626 @opindex mint8
13627 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13628 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13629 and @code{long long} is 4 bytes.  Please note that this option does not
13630 conform to the C standards, but it results in smaller code
13631 size.
13633 @item -mn-flash=@var{num}
13634 @opindex mn-flash
13635 Assume that the flash memory has a size of 
13636 @var{num} times 64@tie{}KiB.
13638 @item -mno-interrupts
13639 @opindex mno-interrupts
13640 Generated code is not compatible with hardware interrupts.
13641 Code size is smaller.
13643 @item -mrelax
13644 @opindex mrelax
13645 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13646 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13647 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
13648 the assembler's command line and the @option{--relax} option to the
13649 linker's command line.
13651 Jump relaxing is performed by the linker because jump offsets are not
13652 known before code is located. Therefore, the assembler code generated by the
13653 compiler is the same, but the instructions in the executable may
13654 differ from instructions in the assembler code.
13656 Relaxing must be turned on if linker stubs are needed, see the
13657 section on @code{EIND} and linker stubs below.
13659 @item -mrmw
13660 @opindex mrmw
13661 Assume that the device supports the Read-Modify-Write
13662 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
13664 @item -msp8
13665 @opindex msp8
13666 Treat the stack pointer register as an 8-bit register,
13667 i.e.@: assume the high byte of the stack pointer is zero.
13668 In general, you don't need to set this option by hand.
13670 This option is used internally by the compiler to select and
13671 build multilibs for architectures @code{avr2} and @code{avr25}.
13672 These architectures mix devices with and without @code{SPH}.
13673 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
13674 the compiler driver adds or removes this option from the compiler
13675 proper's command line, because the compiler then knows if the device
13676 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13677 register or not.
13679 @item -mstrict-X
13680 @opindex mstrict-X
13681 Use address register @code{X} in a way proposed by the hardware.  This means
13682 that @code{X} is only used in indirect, post-increment or
13683 pre-decrement addressing.
13685 Without this option, the @code{X} register may be used in the same way
13686 as @code{Y} or @code{Z} which then is emulated by additional
13687 instructions.  
13688 For example, loading a value with @code{X+const} addressing with a
13689 small non-negative @code{const < 64} to a register @var{Rn} is
13690 performed as
13692 @example
13693 adiw r26, const   ; X += const
13694 ld   @var{Rn}, X        ; @var{Rn} = *X
13695 sbiw r26, const   ; X -= const
13696 @end example
13698 @item -mtiny-stack
13699 @opindex mtiny-stack
13700 Only change the lower 8@tie{}bits of the stack pointer.
13702 @item -nodevicelib
13703 @opindex nodevicelib
13704 Don't link against AVR-LibC's device specific library @code{libdev.a}.
13706 @item -Waddr-space-convert
13707 @opindex Waddr-space-convert
13708 Warn about conversions between address spaces in the case where the
13709 resulting address space is not contained in the incoming address space.
13710 @end table
13712 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
13713 @cindex @code{EIND}
13714 Pointers in the implementation are 16@tie{}bits wide.
13715 The address of a function or label is represented as word address so
13716 that indirect jumps and calls can target any code address in the
13717 range of 64@tie{}Ki words.
13719 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13720 bytes of program memory space, there is a special function register called
13721 @code{EIND} that serves as most significant part of the target address
13722 when @code{EICALL} or @code{EIJMP} instructions are used.
13724 Indirect jumps and calls on these devices are handled as follows by
13725 the compiler and are subject to some limitations:
13727 @itemize @bullet
13729 @item
13730 The compiler never sets @code{EIND}.
13732 @item
13733 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13734 instructions or might read @code{EIND} directly in order to emulate an
13735 indirect call/jump by means of a @code{RET} instruction.
13737 @item
13738 The compiler assumes that @code{EIND} never changes during the startup
13739 code or during the application. In particular, @code{EIND} is not
13740 saved/restored in function or interrupt service routine
13741 prologue/epilogue.
13743 @item
13744 For indirect calls to functions and computed goto, the linker
13745 generates @emph{stubs}. Stubs are jump pads sometimes also called
13746 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13747 The stub contains a direct jump to the desired address.
13749 @item
13750 Linker relaxation must be turned on so that the linker generates
13751 the stubs correctly in all situations. See the compiler option
13752 @option{-mrelax} and the linker option @option{--relax}.
13753 There are corner cases where the linker is supposed to generate stubs
13754 but aborts without relaxation and without a helpful error message.
13756 @item
13757 The default linker script is arranged for code with @code{EIND = 0}.
13758 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13759 linker script has to be used in order to place the sections whose
13760 name start with @code{.trampolines} into the segment where @code{EIND}
13761 points to.
13763 @item
13764 The startup code from libgcc never sets @code{EIND}.
13765 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13766 For the impact of AVR-LibC on @code{EIND}, see the
13767 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13769 @item
13770 It is legitimate for user-specific startup code to set up @code{EIND}
13771 early, for example by means of initialization code located in
13772 section @code{.init3}. Such code runs prior to general startup code
13773 that initializes RAM and calls constructors, but after the bit
13774 of startup code from AVR-LibC that sets @code{EIND} to the segment
13775 where the vector table is located.
13776 @example
13777 #include <avr/io.h>
13779 static void
13780 __attribute__((section(".init3"),naked,used,no_instrument_function))
13781 init3_set_eind (void)
13783   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13784                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13786 @end example
13788 @noindent
13789 The @code{__trampolines_start} symbol is defined in the linker script.
13791 @item
13792 Stubs are generated automatically by the linker if
13793 the following two conditions are met:
13794 @itemize @minus
13796 @item The address of a label is taken by means of the @code{gs} modifier
13797 (short for @emph{generate stubs}) like so:
13798 @example
13799 LDI r24, lo8(gs(@var{func}))
13800 LDI r25, hi8(gs(@var{func}))
13801 @end example
13802 @item The final location of that label is in a code segment
13803 @emph{outside} the segment where the stubs are located.
13804 @end itemize
13806 @item
13807 The compiler emits such @code{gs} modifiers for code labels in the
13808 following situations:
13809 @itemize @minus
13810 @item Taking address of a function or code label.
13811 @item Computed goto.
13812 @item If prologue-save function is used, see @option{-mcall-prologues}
13813 command-line option.
13814 @item Switch/case dispatch tables. If you do not want such dispatch
13815 tables you can specify the @option{-fno-jump-tables} command-line option.
13816 @item C and C++ constructors/destructors called during startup/shutdown.
13817 @item If the tools hit a @code{gs()} modifier explained above.
13818 @end itemize
13820 @item
13821 Jumping to non-symbolic addresses like so is @emph{not} supported:
13823 @example
13824 int main (void)
13826     /* Call function at word address 0x2 */
13827     return ((int(*)(void)) 0x2)();
13829 @end example
13831 Instead, a stub has to be set up, i.e.@: the function has to be called
13832 through a symbol (@code{func_4} in the example):
13834 @example
13835 int main (void)
13837     extern int func_4 (void);
13839     /* Call function at byte address 0x4 */
13840     return func_4();
13842 @end example
13844 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
13845 Alternatively, @code{func_4} can be defined in the linker script.
13846 @end itemize
13848 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13849 @cindex @code{RAMPD}
13850 @cindex @code{RAMPX}
13851 @cindex @code{RAMPY}
13852 @cindex @code{RAMPZ}
13853 Some AVR devices support memories larger than the 64@tie{}KiB range
13854 that can be accessed with 16-bit pointers.  To access memory locations
13855 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13856 register is used as high part of the address:
13857 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13858 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13859 register, respectively, to get a wide address. Similarly,
13860 @code{RAMPD} is used together with direct addressing.
13862 @itemize
13863 @item
13864 The startup code initializes the @code{RAMP} special function
13865 registers with zero.
13867 @item
13868 If a @ref{AVR Named Address Spaces,named address space} other than
13869 generic or @code{__flash} is used, then @code{RAMPZ} is set
13870 as needed before the operation.
13872 @item
13873 If the device supports RAM larger than 64@tie{}KiB and the compiler
13874 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13875 is reset to zero after the operation.
13877 @item
13878 If the device comes with a specific @code{RAMP} register, the ISR
13879 prologue/epilogue saves/restores that SFR and initializes it with
13880 zero in case the ISR code might (implicitly) use it.
13882 @item
13883 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13884 If you use inline assembler to read from locations outside the
13885 16-bit address range and change one of the @code{RAMP} registers,
13886 you must reset it to zero after the access.
13888 @end itemize
13890 @subsubsection AVR Built-in Macros
13892 GCC defines several built-in macros so that the user code can test
13893 for the presence or absence of features.  Almost any of the following
13894 built-in macros are deduced from device capabilities and thus
13895 triggered by the @option{-mmcu=} command-line option.
13897 For even more AVR-specific built-in macros see
13898 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13900 @table @code
13902 @item __AVR_ARCH__
13903 Build-in macro that resolves to a decimal number that identifies the
13904 architecture and depends on the @option{-mmcu=@var{mcu}} option.
13905 Possible values are:
13907 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13908 @code{4}, @code{5}, @code{51}, @code{6}
13910 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
13911 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
13913 respectively and
13915 @code{100}, @code{102}, @code{104},
13916 @code{105}, @code{106}, @code{107}
13918 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
13919 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
13920 If @var{mcu} specifies a device, this built-in macro is set
13921 accordingly. For example, with @option{-mmcu=atmega8} the macro is
13922 defined to @code{4}.
13924 @item __AVR_@var{Device}__
13925 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
13926 the device's name. For example, @option{-mmcu=atmega8} defines the
13927 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
13928 @code{__AVR_ATtiny261A__}, etc.
13930 The built-in macros' names follow
13931 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13932 the device name as from the AVR user manual. The difference between
13933 @var{Device} in the built-in macro and @var{device} in
13934 @option{-mmcu=@var{device}} is that the latter is always lowercase.
13936 If @var{device} is not a device but only a core architecture like
13937 @samp{avr51}, this macro is not defined.
13939 @item __AVR_DEVICE_NAME__
13940 Setting @option{-mmcu=@var{device}} defines this built-in macro to
13941 the device's name. For example, with @option{-mmcu=atmega8} the macro
13942 is defined to @code{atmega8}.
13944 If @var{device} is not a device but only a core architecture like
13945 @samp{avr51}, this macro is not defined.
13947 @item __AVR_XMEGA__
13948 The device / architecture belongs to the XMEGA family of devices.
13950 @item __AVR_HAVE_ELPM__
13951 The device has the @code{ELPM} instruction.
13953 @item __AVR_HAVE_ELPMX__
13954 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13955 R@var{n},Z+} instructions.
13957 @item __AVR_HAVE_MOVW__
13958 The device has the @code{MOVW} instruction to perform 16-bit
13959 register-register moves.
13961 @item __AVR_HAVE_LPMX__
13962 The device has the @code{LPM R@var{n},Z} and
13963 @code{LPM R@var{n},Z+} instructions.
13965 @item __AVR_HAVE_MUL__
13966 The device has a hardware multiplier. 
13968 @item __AVR_HAVE_JMP_CALL__
13969 The device has the @code{JMP} and @code{CALL} instructions.
13970 This is the case for devices with at least 16@tie{}KiB of program
13971 memory.
13973 @item __AVR_HAVE_EIJMP_EICALL__
13974 @itemx __AVR_3_BYTE_PC__
13975 The device has the @code{EIJMP} and @code{EICALL} instructions.
13976 This is the case for devices with more than 128@tie{}KiB of program memory.
13977 This also means that the program counter
13978 (PC) is 3@tie{}bytes wide.
13980 @item __AVR_2_BYTE_PC__
13981 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13982 with up to 128@tie{}KiB of program memory.
13984 @item __AVR_HAVE_8BIT_SP__
13985 @itemx __AVR_HAVE_16BIT_SP__
13986 The stack pointer (SP) register is treated as 8-bit respectively
13987 16-bit register by the compiler.
13988 The definition of these macros is affected by @option{-mtiny-stack}.
13990 @item __AVR_HAVE_SPH__
13991 @itemx __AVR_SP8__
13992 The device has the SPH (high part of stack pointer) special function
13993 register or has an 8-bit stack pointer, respectively.
13994 The definition of these macros is affected by @option{-mmcu=} and
13995 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
13996 by @option{-msp8}.
13998 @item __AVR_HAVE_RAMPD__
13999 @itemx __AVR_HAVE_RAMPX__
14000 @itemx __AVR_HAVE_RAMPY__
14001 @itemx __AVR_HAVE_RAMPZ__
14002 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
14003 @code{RAMPZ} special function register, respectively.
14005 @item __NO_INTERRUPTS__
14006 This macro reflects the @option{-mno-interrupts} command-line option.
14008 @item __AVR_ERRATA_SKIP__
14009 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
14010 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
14011 instructions because of a hardware erratum.  Skip instructions are
14012 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
14013 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
14014 set.
14016 @item __AVR_ISA_RMW__
14017 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
14019 @item __AVR_SFR_OFFSET__=@var{offset}
14020 Instructions that can address I/O special function registers directly
14021 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
14022 address as if addressed by an instruction to access RAM like @code{LD}
14023 or @code{STS}. This offset depends on the device architecture and has
14024 to be subtracted from the RAM address in order to get the
14025 respective I/O@tie{}address.
14027 @item __WITH_AVRLIBC__
14028 The compiler is configured to be used together with AVR-Libc.
14029 See the @option{--with-avrlibc} configure option.
14031 @end table
14033 @node Blackfin Options
14034 @subsection Blackfin Options
14035 @cindex Blackfin Options
14037 @table @gcctabopt
14038 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
14039 @opindex mcpu=
14040 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
14041 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14042 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14043 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14044 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14045 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14046 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14047 @samp{bf561}, @samp{bf592}.
14049 The optional @var{sirevision} specifies the silicon revision of the target
14050 Blackfin processor.  Any workarounds available for the targeted silicon revision
14051 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14052 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14053 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14054 hexadecimal digits representing the major and minor numbers in the silicon
14055 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14056 is not defined.  If @var{sirevision} is @samp{any}, the
14057 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14058 If this optional @var{sirevision} is not used, GCC assumes the latest known
14059 silicon revision of the targeted Blackfin processor.
14061 GCC defines a preprocessor macro for the specified @var{cpu}.
14062 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14063 provided by libgloss to be linked in if @option{-msim} is not given.
14065 Without this option, @samp{bf532} is used as the processor by default.
14067 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14068 only the preprocessor macro is defined.
14070 @item -msim
14071 @opindex msim
14072 Specifies that the program will be run on the simulator.  This causes
14073 the simulator BSP provided by libgloss to be linked in.  This option
14074 has effect only for @samp{bfin-elf} toolchain.
14075 Certain other options, such as @option{-mid-shared-library} and
14076 @option{-mfdpic}, imply @option{-msim}.
14078 @item -momit-leaf-frame-pointer
14079 @opindex momit-leaf-frame-pointer
14080 Don't keep the frame pointer in a register for leaf functions.  This
14081 avoids the instructions to save, set up and restore frame pointers and
14082 makes an extra register available in leaf functions.  The option
14083 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14084 which might make debugging harder.
14086 @item -mspecld-anomaly
14087 @opindex mspecld-anomaly
14088 When enabled, the compiler ensures that the generated code does not
14089 contain speculative loads after jump instructions. If this option is used,
14090 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14092 @item -mno-specld-anomaly
14093 @opindex mno-specld-anomaly
14094 Don't generate extra code to prevent speculative loads from occurring.
14096 @item -mcsync-anomaly
14097 @opindex mcsync-anomaly
14098 When enabled, the compiler ensures that the generated code does not
14099 contain CSYNC or SSYNC instructions too soon after conditional branches.
14100 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14102 @item -mno-csync-anomaly
14103 @opindex mno-csync-anomaly
14104 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14105 occurring too soon after a conditional branch.
14107 @item -mlow-64k
14108 @opindex mlow-64k
14109 When enabled, the compiler is free to take advantage of the knowledge that
14110 the entire program fits into the low 64k of memory.
14112 @item -mno-low-64k
14113 @opindex mno-low-64k
14114 Assume that the program is arbitrarily large.  This is the default.
14116 @item -mstack-check-l1
14117 @opindex mstack-check-l1
14118 Do stack checking using information placed into L1 scratchpad memory by the
14119 uClinux kernel.
14121 @item -mid-shared-library
14122 @opindex mid-shared-library
14123 Generate code that supports shared libraries via the library ID method.
14124 This allows for execute in place and shared libraries in an environment
14125 without virtual memory management.  This option implies @option{-fPIC}.
14126 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14128 @item -mno-id-shared-library
14129 @opindex mno-id-shared-library
14130 Generate code that doesn't assume ID-based shared libraries are being used.
14131 This is the default.
14133 @item -mleaf-id-shared-library
14134 @opindex mleaf-id-shared-library
14135 Generate code that supports shared libraries via the library ID method,
14136 but assumes that this library or executable won't link against any other
14137 ID shared libraries.  That allows the compiler to use faster code for jumps
14138 and calls.
14140 @item -mno-leaf-id-shared-library
14141 @opindex mno-leaf-id-shared-library
14142 Do not assume that the code being compiled won't link against any ID shared
14143 libraries.  Slower code is generated for jump and call insns.
14145 @item -mshared-library-id=n
14146 @opindex mshared-library-id
14147 Specifies the identification number of the ID-based shared library being
14148 compiled.  Specifying a value of 0 generates more compact code; specifying
14149 other values forces the allocation of that number to the current
14150 library but is no more space- or time-efficient than omitting this option.
14152 @item -msep-data
14153 @opindex msep-data
14154 Generate code that allows the data segment to be located in a different
14155 area of memory from the text segment.  This allows for execute in place in
14156 an environment without virtual memory management by eliminating relocations
14157 against the text section.
14159 @item -mno-sep-data
14160 @opindex mno-sep-data
14161 Generate code that assumes that the data segment follows the text segment.
14162 This is the default.
14164 @item -mlong-calls
14165 @itemx -mno-long-calls
14166 @opindex mlong-calls
14167 @opindex mno-long-calls
14168 Tells the compiler to perform function calls by first loading the
14169 address of the function into a register and then performing a subroutine
14170 call on this register.  This switch is needed if the target function
14171 lies outside of the 24-bit addressing range of the offset-based
14172 version of subroutine call instruction.
14174 This feature is not enabled by default.  Specifying
14175 @option{-mno-long-calls} restores the default behavior.  Note these
14176 switches have no effect on how the compiler generates code to handle
14177 function calls via function pointers.
14179 @item -mfast-fp
14180 @opindex mfast-fp
14181 Link with the fast floating-point library. This library relaxes some of
14182 the IEEE floating-point standard's rules for checking inputs against
14183 Not-a-Number (NAN), in the interest of performance.
14185 @item -minline-plt
14186 @opindex minline-plt
14187 Enable inlining of PLT entries in function calls to functions that are
14188 not known to bind locally.  It has no effect without @option{-mfdpic}.
14190 @item -mmulticore
14191 @opindex mmulticore
14192 Build a standalone application for multicore Blackfin processors. 
14193 This option causes proper start files and link scripts supporting 
14194 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
14195 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
14197 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
14198 selects the one-application-per-core programming model.  Without
14199 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
14200 programming model is used. In this model, the main function of Core B
14201 should be named as @code{coreb_main}.
14203 If this option is not used, the single-core application programming
14204 model is used.
14206 @item -mcorea
14207 @opindex mcorea
14208 Build a standalone application for Core A of BF561 when using
14209 the one-application-per-core programming model. Proper start files
14210 and link scripts are used to support Core A, and the macro
14211 @code{__BFIN_COREA} is defined.
14212 This option can only be used in conjunction with @option{-mmulticore}.
14214 @item -mcoreb
14215 @opindex mcoreb
14216 Build a standalone application for Core B of BF561 when using
14217 the one-application-per-core programming model. Proper start files
14218 and link scripts are used to support Core B, and the macro
14219 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
14220 should be used instead of @code{main}. 
14221 This option can only be used in conjunction with @option{-mmulticore}.
14223 @item -msdram
14224 @opindex msdram
14225 Build a standalone application for SDRAM. Proper start files and
14226 link scripts are used to put the application into SDRAM, and the macro
14227 @code{__BFIN_SDRAM} is defined.
14228 The loader should initialize SDRAM before loading the application.
14230 @item -micplb
14231 @opindex micplb
14232 Assume that ICPLBs are enabled at run time.  This has an effect on certain
14233 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
14234 are enabled; for standalone applications the default is off.
14235 @end table
14237 @node C6X Options
14238 @subsection C6X Options
14239 @cindex C6X Options
14241 @table @gcctabopt
14242 @item -march=@var{name}
14243 @opindex march
14244 This specifies the name of the target architecture.  GCC uses this
14245 name to determine what kind of instructions it can emit when generating
14246 assembly code.  Permissible names are: @samp{c62x},
14247 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
14249 @item -mbig-endian
14250 @opindex mbig-endian
14251 Generate code for a big-endian target.
14253 @item -mlittle-endian
14254 @opindex mlittle-endian
14255 Generate code for a little-endian target.  This is the default.
14257 @item -msim
14258 @opindex msim
14259 Choose startup files and linker script suitable for the simulator.
14261 @item -msdata=default
14262 @opindex msdata=default
14263 Put small global and static data in the @code{.neardata} section,
14264 which is pointed to by register @code{B14}.  Put small uninitialized
14265 global and static data in the @code{.bss} section, which is adjacent
14266 to the @code{.neardata} section.  Put small read-only data into the
14267 @code{.rodata} section.  The corresponding sections used for large
14268 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
14270 @item -msdata=all
14271 @opindex msdata=all
14272 Put all data, not just small objects, into the sections reserved for
14273 small data, and use addressing relative to the @code{B14} register to
14274 access them.
14276 @item -msdata=none
14277 @opindex msdata=none
14278 Make no use of the sections reserved for small data, and use absolute
14279 addresses to access all data.  Put all initialized global and static
14280 data in the @code{.fardata} section, and all uninitialized data in the
14281 @code{.far} section.  Put all constant data into the @code{.const}
14282 section.
14283 @end table
14285 @node CRIS Options
14286 @subsection CRIS Options
14287 @cindex CRIS Options
14289 These options are defined specifically for the CRIS ports.
14291 @table @gcctabopt
14292 @item -march=@var{architecture-type}
14293 @itemx -mcpu=@var{architecture-type}
14294 @opindex march
14295 @opindex mcpu
14296 Generate code for the specified architecture.  The choices for
14297 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
14298 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
14299 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
14300 @samp{v10}.
14302 @item -mtune=@var{architecture-type}
14303 @opindex mtune
14304 Tune to @var{architecture-type} everything applicable about the generated
14305 code, except for the ABI and the set of available instructions.  The
14306 choices for @var{architecture-type} are the same as for
14307 @option{-march=@var{architecture-type}}.
14309 @item -mmax-stack-frame=@var{n}
14310 @opindex mmax-stack-frame
14311 Warn when the stack frame of a function exceeds @var{n} bytes.
14313 @item -metrax4
14314 @itemx -metrax100
14315 @opindex metrax4
14316 @opindex metrax100
14317 The options @option{-metrax4} and @option{-metrax100} are synonyms for
14318 @option{-march=v3} and @option{-march=v8} respectively.
14320 @item -mmul-bug-workaround
14321 @itemx -mno-mul-bug-workaround
14322 @opindex mmul-bug-workaround
14323 @opindex mno-mul-bug-workaround
14324 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
14325 models where it applies.  This option is active by default.
14327 @item -mpdebug
14328 @opindex mpdebug
14329 Enable CRIS-specific verbose debug-related information in the assembly
14330 code.  This option also has the effect of turning off the @samp{#NO_APP}
14331 formatted-code indicator to the assembler at the beginning of the
14332 assembly file.
14334 @item -mcc-init
14335 @opindex mcc-init
14336 Do not use condition-code results from previous instruction; always emit
14337 compare and test instructions before use of condition codes.
14339 @item -mno-side-effects
14340 @opindex mno-side-effects
14341 Do not emit instructions with side effects in addressing modes other than
14342 post-increment.
14344 @item -mstack-align
14345 @itemx -mno-stack-align
14346 @itemx -mdata-align
14347 @itemx -mno-data-align
14348 @itemx -mconst-align
14349 @itemx -mno-const-align
14350 @opindex mstack-align
14351 @opindex mno-stack-align
14352 @opindex mdata-align
14353 @opindex mno-data-align
14354 @opindex mconst-align
14355 @opindex mno-const-align
14356 These options (@samp{no-} options) arrange (eliminate arrangements) for the
14357 stack frame, individual data and constants to be aligned for the maximum
14358 single data access size for the chosen CPU model.  The default is to
14359 arrange for 32-bit alignment.  ABI details such as structure layout are
14360 not affected by these options.
14362 @item -m32-bit
14363 @itemx -m16-bit
14364 @itemx -m8-bit
14365 @opindex m32-bit
14366 @opindex m16-bit
14367 @opindex m8-bit
14368 Similar to the stack- data- and const-align options above, these options
14369 arrange for stack frame, writable data and constants to all be 32-bit,
14370 16-bit or 8-bit aligned.  The default is 32-bit alignment.
14372 @item -mno-prologue-epilogue
14373 @itemx -mprologue-epilogue
14374 @opindex mno-prologue-epilogue
14375 @opindex mprologue-epilogue
14376 With @option{-mno-prologue-epilogue}, the normal function prologue and
14377 epilogue which set up the stack frame are omitted and no return
14378 instructions or return sequences are generated in the code.  Use this
14379 option only together with visual inspection of the compiled code: no
14380 warnings or errors are generated when call-saved registers must be saved,
14381 or storage for local variables needs to be allocated.
14383 @item -mno-gotplt
14384 @itemx -mgotplt
14385 @opindex mno-gotplt
14386 @opindex mgotplt
14387 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
14388 instruction sequences that load addresses for functions from the PLT part
14389 of the GOT rather than (traditional on other architectures) calls to the
14390 PLT@.  The default is @option{-mgotplt}.
14392 @item -melf
14393 @opindex melf
14394 Legacy no-op option only recognized with the cris-axis-elf and
14395 cris-axis-linux-gnu targets.
14397 @item -mlinux
14398 @opindex mlinux
14399 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
14401 @item -sim
14402 @opindex sim
14403 This option, recognized for the cris-axis-elf, arranges
14404 to link with input-output functions from a simulator library.  Code,
14405 initialized data and zero-initialized data are allocated consecutively.
14407 @item -sim2
14408 @opindex sim2
14409 Like @option{-sim}, but pass linker options to locate initialized data at
14410 0x40000000 and zero-initialized data at 0x80000000.
14411 @end table
14413 @node CR16 Options
14414 @subsection CR16 Options
14415 @cindex CR16 Options
14417 These options are defined specifically for the CR16 ports.
14419 @table @gcctabopt
14421 @item -mmac
14422 @opindex mmac
14423 Enable the use of multiply-accumulate instructions. Disabled by default.
14425 @item -mcr16cplus
14426 @itemx -mcr16c
14427 @opindex mcr16cplus
14428 @opindex mcr16c
14429 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14430 is default.
14432 @item -msim
14433 @opindex msim
14434 Links the library libsim.a which is in compatible with simulator. Applicable
14435 to ELF compiler only.
14437 @item -mint32
14438 @opindex mint32
14439 Choose integer type as 32-bit wide.
14441 @item -mbit-ops
14442 @opindex mbit-ops
14443 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14445 @item -mdata-model=@var{model}
14446 @opindex mdata-model
14447 Choose a data model. The choices for @var{model} are @samp{near},
14448 @samp{far} or @samp{medium}. @samp{medium} is default.
14449 However, @samp{far} is not valid with @option{-mcr16c}, as the
14450 CR16C architecture does not support the far data model.
14451 @end table
14453 @node Darwin Options
14454 @subsection Darwin Options
14455 @cindex Darwin options
14457 These options are defined for all architectures running the Darwin operating
14458 system.
14460 FSF GCC on Darwin does not create ``fat'' object files; it creates
14461 an object file for the single architecture that GCC was built to
14462 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14463 @option{-arch} options are used; it does so by running the compiler or
14464 linker multiple times and joining the results together with
14465 @file{lipo}.
14467 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14468 @samp{i686}) is determined by the flags that specify the ISA
14469 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14470 @option{-force_cpusubtype_ALL} option can be used to override this.
14472 The Darwin tools vary in their behavior when presented with an ISA
14473 mismatch.  The assembler, @file{as}, only permits instructions to
14474 be used that are valid for the subtype of the file it is generating,
14475 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14476 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14477 and prints an error if asked to create a shared library with a less
14478 restrictive subtype than its input files (for instance, trying to put
14479 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14480 for executables, @command{ld}, quietly gives the executable the most
14481 restrictive subtype of any of its input files.
14483 @table @gcctabopt
14484 @item -F@var{dir}
14485 @opindex F
14486 Add the framework directory @var{dir} to the head of the list of
14487 directories to be searched for header files.  These directories are
14488 interleaved with those specified by @option{-I} options and are
14489 scanned in a left-to-right order.
14491 A framework directory is a directory with frameworks in it.  A
14492 framework is a directory with a @file{Headers} and/or
14493 @file{PrivateHeaders} directory contained directly in it that ends
14494 in @file{.framework}.  The name of a framework is the name of this
14495 directory excluding the @file{.framework}.  Headers associated with
14496 the framework are found in one of those two directories, with
14497 @file{Headers} being searched first.  A subframework is a framework
14498 directory that is in a framework's @file{Frameworks} directory.
14499 Includes of subframework headers can only appear in a header of a
14500 framework that contains the subframework, or in a sibling subframework
14501 header.  Two subframeworks are siblings if they occur in the same
14502 framework.  A subframework should not have the same name as a
14503 framework; a warning is issued if this is violated.  Currently a
14504 subframework cannot have subframeworks; in the future, the mechanism
14505 may be extended to support this.  The standard frameworks can be found
14506 in @file{/System/Library/Frameworks} and
14507 @file{/Library/Frameworks}.  An example include looks like
14508 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14509 the name of the framework and @file{header.h} is found in the
14510 @file{PrivateHeaders} or @file{Headers} directory.
14512 @item -iframework@var{dir}
14513 @opindex iframework
14514 Like @option{-F} except the directory is a treated as a system
14515 directory.  The main difference between this @option{-iframework} and
14516 @option{-F} is that with @option{-iframework} the compiler does not
14517 warn about constructs contained within header files found via
14518 @var{dir}.  This option is valid only for the C family of languages.
14520 @item -gused
14521 @opindex gused
14522 Emit debugging information for symbols that are used.  For stabs
14523 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14524 This is by default ON@.
14526 @item -gfull
14527 @opindex gfull
14528 Emit debugging information for all symbols and types.
14530 @item -mmacosx-version-min=@var{version}
14531 The earliest version of MacOS X that this executable will run on
14532 is @var{version}.  Typical values of @var{version} include @code{10.1},
14533 @code{10.2}, and @code{10.3.9}.
14535 If the compiler was built to use the system's headers by default,
14536 then the default for this option is the system version on which the
14537 compiler is running, otherwise the default is to make choices that
14538 are compatible with as many systems and code bases as possible.
14540 @item -mkernel
14541 @opindex mkernel
14542 Enable kernel development mode.  The @option{-mkernel} option sets
14543 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14544 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14545 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14546 applicable.  This mode also sets @option{-mno-altivec},
14547 @option{-msoft-float}, @option{-fno-builtin} and
14548 @option{-mlong-branch} for PowerPC targets.
14550 @item -mone-byte-bool
14551 @opindex mone-byte-bool
14552 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
14553 By default @code{sizeof(bool)} is @code{4} when compiling for
14554 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
14555 option has no effect on x86.
14557 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14558 to generate code that is not binary compatible with code generated
14559 without that switch.  Using this switch may require recompiling all
14560 other modules in a program, including system libraries.  Use this
14561 switch to conform to a non-default data model.
14563 @item -mfix-and-continue
14564 @itemx -ffix-and-continue
14565 @itemx -findirect-data
14566 @opindex mfix-and-continue
14567 @opindex ffix-and-continue
14568 @opindex findirect-data
14569 Generate code suitable for fast turnaround development, such as to
14570 allow GDB to dynamically load @file{.o} files into already-running
14571 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14572 are provided for backwards compatibility.
14574 @item -all_load
14575 @opindex all_load
14576 Loads all members of static archive libraries.
14577 See man ld(1) for more information.
14579 @item -arch_errors_fatal
14580 @opindex arch_errors_fatal
14581 Cause the errors having to do with files that have the wrong architecture
14582 to be fatal.
14584 @item -bind_at_load
14585 @opindex bind_at_load
14586 Causes the output file to be marked such that the dynamic linker will
14587 bind all undefined references when the file is loaded or launched.
14589 @item -bundle
14590 @opindex bundle
14591 Produce a Mach-o bundle format file.
14592 See man ld(1) for more information.
14594 @item -bundle_loader @var{executable}
14595 @opindex bundle_loader
14596 This option specifies the @var{executable} that will load the build
14597 output file being linked.  See man ld(1) for more information.
14599 @item -dynamiclib
14600 @opindex dynamiclib
14601 When passed this option, GCC produces a dynamic library instead of
14602 an executable when linking, using the Darwin @file{libtool} command.
14604 @item -force_cpusubtype_ALL
14605 @opindex force_cpusubtype_ALL
14606 This causes GCC's output file to have the @samp{ALL} subtype, instead of
14607 one controlled by the @option{-mcpu} or @option{-march} option.
14609 @item -allowable_client  @var{client_name}
14610 @itemx -client_name
14611 @itemx -compatibility_version
14612 @itemx -current_version
14613 @itemx -dead_strip
14614 @itemx -dependency-file
14615 @itemx -dylib_file
14616 @itemx -dylinker_install_name
14617 @itemx -dynamic
14618 @itemx -exported_symbols_list
14619 @itemx -filelist
14620 @need 800
14621 @itemx -flat_namespace
14622 @itemx -force_flat_namespace
14623 @itemx -headerpad_max_install_names
14624 @itemx -image_base
14625 @itemx -init
14626 @itemx -install_name
14627 @itemx -keep_private_externs
14628 @itemx -multi_module
14629 @itemx -multiply_defined
14630 @itemx -multiply_defined_unused
14631 @need 800
14632 @itemx -noall_load
14633 @itemx -no_dead_strip_inits_and_terms
14634 @itemx -nofixprebinding
14635 @itemx -nomultidefs
14636 @itemx -noprebind
14637 @itemx -noseglinkedit
14638 @itemx -pagezero_size
14639 @itemx -prebind
14640 @itemx -prebind_all_twolevel_modules
14641 @itemx -private_bundle
14642 @need 800
14643 @itemx -read_only_relocs
14644 @itemx -sectalign
14645 @itemx -sectobjectsymbols
14646 @itemx -whyload
14647 @itemx -seg1addr
14648 @itemx -sectcreate
14649 @itemx -sectobjectsymbols
14650 @itemx -sectorder
14651 @itemx -segaddr
14652 @itemx -segs_read_only_addr
14653 @need 800
14654 @itemx -segs_read_write_addr
14655 @itemx -seg_addr_table
14656 @itemx -seg_addr_table_filename
14657 @itemx -seglinkedit
14658 @itemx -segprot
14659 @itemx -segs_read_only_addr
14660 @itemx -segs_read_write_addr
14661 @itemx -single_module
14662 @itemx -static
14663 @itemx -sub_library
14664 @need 800
14665 @itemx -sub_umbrella
14666 @itemx -twolevel_namespace
14667 @itemx -umbrella
14668 @itemx -undefined
14669 @itemx -unexported_symbols_list
14670 @itemx -weak_reference_mismatches
14671 @itemx -whatsloaded
14672 @opindex allowable_client
14673 @opindex client_name
14674 @opindex compatibility_version
14675 @opindex current_version
14676 @opindex dead_strip
14677 @opindex dependency-file
14678 @opindex dylib_file
14679 @opindex dylinker_install_name
14680 @opindex dynamic
14681 @opindex exported_symbols_list
14682 @opindex filelist
14683 @opindex flat_namespace
14684 @opindex force_flat_namespace
14685 @opindex headerpad_max_install_names
14686 @opindex image_base
14687 @opindex init
14688 @opindex install_name
14689 @opindex keep_private_externs
14690 @opindex multi_module
14691 @opindex multiply_defined
14692 @opindex multiply_defined_unused
14693 @opindex noall_load
14694 @opindex no_dead_strip_inits_and_terms
14695 @opindex nofixprebinding
14696 @opindex nomultidefs
14697 @opindex noprebind
14698 @opindex noseglinkedit
14699 @opindex pagezero_size
14700 @opindex prebind
14701 @opindex prebind_all_twolevel_modules
14702 @opindex private_bundle
14703 @opindex read_only_relocs
14704 @opindex sectalign
14705 @opindex sectobjectsymbols
14706 @opindex whyload
14707 @opindex seg1addr
14708 @opindex sectcreate
14709 @opindex sectobjectsymbols
14710 @opindex sectorder
14711 @opindex segaddr
14712 @opindex segs_read_only_addr
14713 @opindex segs_read_write_addr
14714 @opindex seg_addr_table
14715 @opindex seg_addr_table_filename
14716 @opindex seglinkedit
14717 @opindex segprot
14718 @opindex segs_read_only_addr
14719 @opindex segs_read_write_addr
14720 @opindex single_module
14721 @opindex static
14722 @opindex sub_library
14723 @opindex sub_umbrella
14724 @opindex twolevel_namespace
14725 @opindex umbrella
14726 @opindex undefined
14727 @opindex unexported_symbols_list
14728 @opindex weak_reference_mismatches
14729 @opindex whatsloaded
14730 These options are passed to the Darwin linker.  The Darwin linker man page
14731 describes them in detail.
14732 @end table
14734 @node DEC Alpha Options
14735 @subsection DEC Alpha Options
14737 These @samp{-m} options are defined for the DEC Alpha implementations:
14739 @table @gcctabopt
14740 @item -mno-soft-float
14741 @itemx -msoft-float
14742 @opindex mno-soft-float
14743 @opindex msoft-float
14744 Use (do not use) the hardware floating-point instructions for
14745 floating-point operations.  When @option{-msoft-float} is specified,
14746 functions in @file{libgcc.a} are used to perform floating-point
14747 operations.  Unless they are replaced by routines that emulate the
14748 floating-point operations, or compiled in such a way as to call such
14749 emulations routines, these routines issue floating-point
14750 operations.   If you are compiling for an Alpha without floating-point
14751 operations, you must ensure that the library is built so as not to call
14752 them.
14754 Note that Alpha implementations without floating-point operations are
14755 required to have floating-point registers.
14757 @item -mfp-reg
14758 @itemx -mno-fp-regs
14759 @opindex mfp-reg
14760 @opindex mno-fp-regs
14761 Generate code that uses (does not use) the floating-point register set.
14762 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14763 register set is not used, floating-point operands are passed in integer
14764 registers as if they were integers and floating-point results are passed
14765 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14766 so any function with a floating-point argument or return value called by code
14767 compiled with @option{-mno-fp-regs} must also be compiled with that
14768 option.
14770 A typical use of this option is building a kernel that does not use,
14771 and hence need not save and restore, any floating-point registers.
14773 @item -mieee
14774 @opindex mieee
14775 The Alpha architecture implements floating-point hardware optimized for
14776 maximum performance.  It is mostly compliant with the IEEE floating-point
14777 standard.  However, for full compliance, software assistance is
14778 required.  This option generates code fully IEEE-compliant code
14779 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14780 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14781 defined during compilation.  The resulting code is less efficient but is
14782 able to correctly support denormalized numbers and exceptional IEEE
14783 values such as not-a-number and plus/minus infinity.  Other Alpha
14784 compilers call this option @option{-ieee_with_no_inexact}.
14786 @item -mieee-with-inexact
14787 @opindex mieee-with-inexact
14788 This is like @option{-mieee} except the generated code also maintains
14789 the IEEE @var{inexact-flag}.  Turning on this option causes the
14790 generated code to implement fully-compliant IEEE math.  In addition to
14791 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14792 macro.  On some Alpha implementations the resulting code may execute
14793 significantly slower than the code generated by default.  Since there is
14794 very little code that depends on the @var{inexact-flag}, you should
14795 normally not specify this option.  Other Alpha compilers call this
14796 option @option{-ieee_with_inexact}.
14798 @item -mfp-trap-mode=@var{trap-mode}
14799 @opindex mfp-trap-mode
14800 This option controls what floating-point related traps are enabled.
14801 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14802 The trap mode can be set to one of four values:
14804 @table @samp
14805 @item n
14806 This is the default (normal) setting.  The only traps that are enabled
14807 are the ones that cannot be disabled in software (e.g., division by zero
14808 trap).
14810 @item u
14811 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14812 as well.
14814 @item su
14815 Like @samp{u}, but the instructions are marked to be safe for software
14816 completion (see Alpha architecture manual for details).
14818 @item sui
14819 Like @samp{su}, but inexact traps are enabled as well.
14820 @end table
14822 @item -mfp-rounding-mode=@var{rounding-mode}
14823 @opindex mfp-rounding-mode
14824 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14825 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14828 @table @samp
14829 @item n
14830 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14831 the nearest machine number or towards the even machine number in case
14832 of a tie.
14834 @item m
14835 Round towards minus infinity.
14837 @item c
14838 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14840 @item d
14841 Dynamic rounding mode.  A field in the floating-point control register
14842 (@var{fpcr}, see Alpha architecture reference manual) controls the
14843 rounding mode in effect.  The C library initializes this register for
14844 rounding towards plus infinity.  Thus, unless your program modifies the
14845 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14846 @end table
14848 @item -mtrap-precision=@var{trap-precision}
14849 @opindex mtrap-precision
14850 In the Alpha architecture, floating-point traps are imprecise.  This
14851 means without software assistance it is impossible to recover from a
14852 floating trap and program execution normally needs to be terminated.
14853 GCC can generate code that can assist operating system trap handlers
14854 in determining the exact location that caused a floating-point trap.
14855 Depending on the requirements of an application, different levels of
14856 precisions can be selected:
14858 @table @samp
14859 @item p
14860 Program precision.  This option is the default and means a trap handler
14861 can only identify which program caused a floating-point exception.
14863 @item f
14864 Function precision.  The trap handler can determine the function that
14865 caused a floating-point exception.
14867 @item i
14868 Instruction precision.  The trap handler can determine the exact
14869 instruction that caused a floating-point exception.
14870 @end table
14872 Other Alpha compilers provide the equivalent options called
14873 @option{-scope_safe} and @option{-resumption_safe}.
14875 @item -mieee-conformant
14876 @opindex mieee-conformant
14877 This option marks the generated code as IEEE conformant.  You must not
14878 use this option unless you also specify @option{-mtrap-precision=i} and either
14879 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14880 is to emit the line @samp{.eflag 48} in the function prologue of the
14881 generated assembly file.
14883 @item -mbuild-constants
14884 @opindex mbuild-constants
14885 Normally GCC examines a 32- or 64-bit integer constant to
14886 see if it can construct it from smaller constants in two or three
14887 instructions.  If it cannot, it outputs the constant as a literal and
14888 generates code to load it from the data segment at run time.
14890 Use this option to require GCC to construct @emph{all} integer constants
14891 using code, even if it takes more instructions (the maximum is six).
14893 You typically use this option to build a shared library dynamic
14894 loader.  Itself a shared library, it must relocate itself in memory
14895 before it can find the variables and constants in its own data segment.
14897 @item -mbwx
14898 @itemx -mno-bwx
14899 @itemx -mcix
14900 @itemx -mno-cix
14901 @itemx -mfix
14902 @itemx -mno-fix
14903 @itemx -mmax
14904 @itemx -mno-max
14905 @opindex mbwx
14906 @opindex mno-bwx
14907 @opindex mcix
14908 @opindex mno-cix
14909 @opindex mfix
14910 @opindex mno-fix
14911 @opindex mmax
14912 @opindex mno-max
14913 Indicate whether GCC should generate code to use the optional BWX,
14914 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14915 sets supported by the CPU type specified via @option{-mcpu=} option or that
14916 of the CPU on which GCC was built if none is specified.
14918 @item -mfloat-vax
14919 @itemx -mfloat-ieee
14920 @opindex mfloat-vax
14921 @opindex mfloat-ieee
14922 Generate code that uses (does not use) VAX F and G floating-point
14923 arithmetic instead of IEEE single and double precision.
14925 @item -mexplicit-relocs
14926 @itemx -mno-explicit-relocs
14927 @opindex mexplicit-relocs
14928 @opindex mno-explicit-relocs
14929 Older Alpha assemblers provided no way to generate symbol relocations
14930 except via assembler macros.  Use of these macros does not allow
14931 optimal instruction scheduling.  GNU binutils as of version 2.12
14932 supports a new syntax that allows the compiler to explicitly mark
14933 which relocations should apply to which instructions.  This option
14934 is mostly useful for debugging, as GCC detects the capabilities of
14935 the assembler when it is built and sets the default accordingly.
14937 @item -msmall-data
14938 @itemx -mlarge-data
14939 @opindex msmall-data
14940 @opindex mlarge-data
14941 When @option{-mexplicit-relocs} is in effect, static data is
14942 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14943 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14944 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14945 16-bit relocations off of the @code{$gp} register.  This limits the
14946 size of the small data area to 64KB, but allows the variables to be
14947 directly accessed via a single instruction.
14949 The default is @option{-mlarge-data}.  With this option the data area
14950 is limited to just below 2GB@.  Programs that require more than 2GB of
14951 data must use @code{malloc} or @code{mmap} to allocate the data in the
14952 heap instead of in the program's data segment.
14954 When generating code for shared libraries, @option{-fpic} implies
14955 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14957 @item -msmall-text
14958 @itemx -mlarge-text
14959 @opindex msmall-text
14960 @opindex mlarge-text
14961 When @option{-msmall-text} is used, the compiler assumes that the
14962 code of the entire program (or shared library) fits in 4MB, and is
14963 thus reachable with a branch instruction.  When @option{-msmall-data}
14964 is used, the compiler can assume that all local symbols share the
14965 same @code{$gp} value, and thus reduce the number of instructions
14966 required for a function call from 4 to 1.
14968 The default is @option{-mlarge-text}.
14970 @item -mcpu=@var{cpu_type}
14971 @opindex mcpu
14972 Set the instruction set and instruction scheduling parameters for
14973 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14974 style name or the corresponding chip number.  GCC supports scheduling
14975 parameters for the EV4, EV5 and EV6 family of processors and
14976 chooses the default values for the instruction set from the processor
14977 you specify.  If you do not specify a processor type, GCC defaults
14978 to the processor on which the compiler was built.
14980 Supported values for @var{cpu_type} are
14982 @table @samp
14983 @item ev4
14984 @itemx ev45
14985 @itemx 21064
14986 Schedules as an EV4 and has no instruction set extensions.
14988 @item ev5
14989 @itemx 21164
14990 Schedules as an EV5 and has no instruction set extensions.
14992 @item ev56
14993 @itemx 21164a
14994 Schedules as an EV5 and supports the BWX extension.
14996 @item pca56
14997 @itemx 21164pc
14998 @itemx 21164PC
14999 Schedules as an EV5 and supports the BWX and MAX extensions.
15001 @item ev6
15002 @itemx 21264
15003 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
15005 @item ev67
15006 @itemx 21264a
15007 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
15008 @end table
15010 Native toolchains also support the value @samp{native},
15011 which selects the best architecture option for the host processor.
15012 @option{-mcpu=native} has no effect if GCC does not recognize
15013 the processor.
15015 @item -mtune=@var{cpu_type}
15016 @opindex mtune
15017 Set only the instruction scheduling parameters for machine type
15018 @var{cpu_type}.  The instruction set is not changed.
15020 Native toolchains also support the value @samp{native},
15021 which selects the best architecture option for the host processor.
15022 @option{-mtune=native} has no effect if GCC does not recognize
15023 the processor.
15025 @item -mmemory-latency=@var{time}
15026 @opindex mmemory-latency
15027 Sets the latency the scheduler should assume for typical memory
15028 references as seen by the application.  This number is highly
15029 dependent on the memory access patterns used by the application
15030 and the size of the external cache on the machine.
15032 Valid options for @var{time} are
15034 @table @samp
15035 @item @var{number}
15036 A decimal number representing clock cycles.
15038 @item L1
15039 @itemx L2
15040 @itemx L3
15041 @itemx main
15042 The compiler contains estimates of the number of clock cycles for
15043 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15044 (also called Dcache, Scache, and Bcache), as well as to main memory.
15045 Note that L3 is only valid for EV5.
15047 @end table
15048 @end table
15050 @node FR30 Options
15051 @subsection FR30 Options
15052 @cindex FR30 Options
15054 These options are defined specifically for the FR30 port.
15056 @table @gcctabopt
15058 @item -msmall-model
15059 @opindex msmall-model
15060 Use the small address space model.  This can produce smaller code, but
15061 it does assume that all symbolic values and addresses fit into a
15062 20-bit range.
15064 @item -mno-lsim
15065 @opindex mno-lsim
15066 Assume that runtime support has been provided and so there is no need
15067 to include the simulator library (@file{libsim.a}) on the linker
15068 command line.
15070 @end table
15072 @node FT32 Options
15073 @subsection FT32 Options
15074 @cindex FT32 Options
15076 These options are defined specifically for the FT32 port.
15078 @table @gcctabopt
15080 @item -msim
15081 @opindex msim
15082 Specifies that the program will be run on the simulator.  This causes
15083 an alternate runtime startup and library to be linked.
15084 You must not use this option when generating programs that will run on
15085 real hardware; you must provide your own runtime library for whatever
15086 I/O functions are needed.
15088 @item -mlra
15089 @opindex mlra
15090 Enable Local Register Allocation.  This is still experimental for FT32,
15091 so by default the compiler uses standard reload.
15093 @end table
15095 @node FRV Options
15096 @subsection FRV Options
15097 @cindex FRV Options
15099 @table @gcctabopt
15100 @item -mgpr-32
15101 @opindex mgpr-32
15103 Only use the first 32 general-purpose registers.
15105 @item -mgpr-64
15106 @opindex mgpr-64
15108 Use all 64 general-purpose registers.
15110 @item -mfpr-32
15111 @opindex mfpr-32
15113 Use only the first 32 floating-point registers.
15115 @item -mfpr-64
15116 @opindex mfpr-64
15118 Use all 64 floating-point registers.
15120 @item -mhard-float
15121 @opindex mhard-float
15123 Use hardware instructions for floating-point operations.
15125 @item -msoft-float
15126 @opindex msoft-float
15128 Use library routines for floating-point operations.
15130 @item -malloc-cc
15131 @opindex malloc-cc
15133 Dynamically allocate condition code registers.
15135 @item -mfixed-cc
15136 @opindex mfixed-cc
15138 Do not try to dynamically allocate condition code registers, only
15139 use @code{icc0} and @code{fcc0}.
15141 @item -mdword
15142 @opindex mdword
15144 Change ABI to use double word insns.
15146 @item -mno-dword
15147 @opindex mno-dword
15149 Do not use double word instructions.
15151 @item -mdouble
15152 @opindex mdouble
15154 Use floating-point double instructions.
15156 @item -mno-double
15157 @opindex mno-double
15159 Do not use floating-point double instructions.
15161 @item -mmedia
15162 @opindex mmedia
15164 Use media instructions.
15166 @item -mno-media
15167 @opindex mno-media
15169 Do not use media instructions.
15171 @item -mmuladd
15172 @opindex mmuladd
15174 Use multiply and add/subtract instructions.
15176 @item -mno-muladd
15177 @opindex mno-muladd
15179 Do not use multiply and add/subtract instructions.
15181 @item -mfdpic
15182 @opindex mfdpic
15184 Select the FDPIC ABI, which uses function descriptors to represent
15185 pointers to functions.  Without any PIC/PIE-related options, it
15186 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
15187 assumes GOT entries and small data are within a 12-bit range from the
15188 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
15189 are computed with 32 bits.
15190 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15192 @item -minline-plt
15193 @opindex minline-plt
15195 Enable inlining of PLT entries in function calls to functions that are
15196 not known to bind locally.  It has no effect without @option{-mfdpic}.
15197 It's enabled by default if optimizing for speed and compiling for
15198 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
15199 optimization option such as @option{-O3} or above is present in the
15200 command line.
15202 @item -mTLS
15203 @opindex mTLS
15205 Assume a large TLS segment when generating thread-local code.
15207 @item -mtls
15208 @opindex mtls
15210 Do not assume a large TLS segment when generating thread-local code.
15212 @item -mgprel-ro
15213 @opindex mgprel-ro
15215 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
15216 that is known to be in read-only sections.  It's enabled by default,
15217 except for @option{-fpic} or @option{-fpie}: even though it may help
15218 make the global offset table smaller, it trades 1 instruction for 4.
15219 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
15220 one of which may be shared by multiple symbols, and it avoids the need
15221 for a GOT entry for the referenced symbol, so it's more likely to be a
15222 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
15224 @item -multilib-library-pic
15225 @opindex multilib-library-pic
15227 Link with the (library, not FD) pic libraries.  It's implied by
15228 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
15229 @option{-fpic} without @option{-mfdpic}.  You should never have to use
15230 it explicitly.
15232 @item -mlinked-fp
15233 @opindex mlinked-fp
15235 Follow the EABI requirement of always creating a frame pointer whenever
15236 a stack frame is allocated.  This option is enabled by default and can
15237 be disabled with @option{-mno-linked-fp}.
15239 @item -mlong-calls
15240 @opindex mlong-calls
15242 Use indirect addressing to call functions outside the current
15243 compilation unit.  This allows the functions to be placed anywhere
15244 within the 32-bit address space.
15246 @item -malign-labels
15247 @opindex malign-labels
15249 Try to align labels to an 8-byte boundary by inserting NOPs into the
15250 previous packet.  This option only has an effect when VLIW packing
15251 is enabled.  It doesn't create new packets; it merely adds NOPs to
15252 existing ones.
15254 @item -mlibrary-pic
15255 @opindex mlibrary-pic
15257 Generate position-independent EABI code.
15259 @item -macc-4
15260 @opindex macc-4
15262 Use only the first four media accumulator registers.
15264 @item -macc-8
15265 @opindex macc-8
15267 Use all eight media accumulator registers.
15269 @item -mpack
15270 @opindex mpack
15272 Pack VLIW instructions.
15274 @item -mno-pack
15275 @opindex mno-pack
15277 Do not pack VLIW instructions.
15279 @item -mno-eflags
15280 @opindex mno-eflags
15282 Do not mark ABI switches in e_flags.
15284 @item -mcond-move
15285 @opindex mcond-move
15287 Enable the use of conditional-move instructions (default).
15289 This switch is mainly for debugging the compiler and will likely be removed
15290 in a future version.
15292 @item -mno-cond-move
15293 @opindex mno-cond-move
15295 Disable the use of conditional-move instructions.
15297 This switch is mainly for debugging the compiler and will likely be removed
15298 in a future version.
15300 @item -mscc
15301 @opindex mscc
15303 Enable the use of conditional set instructions (default).
15305 This switch is mainly for debugging the compiler and will likely be removed
15306 in a future version.
15308 @item -mno-scc
15309 @opindex mno-scc
15311 Disable the use of conditional set instructions.
15313 This switch is mainly for debugging the compiler and will likely be removed
15314 in a future version.
15316 @item -mcond-exec
15317 @opindex mcond-exec
15319 Enable the use of conditional execution (default).
15321 This switch is mainly for debugging the compiler and will likely be removed
15322 in a future version.
15324 @item -mno-cond-exec
15325 @opindex mno-cond-exec
15327 Disable the use of conditional execution.
15329 This switch is mainly for debugging the compiler and will likely be removed
15330 in a future version.
15332 @item -mvliw-branch
15333 @opindex mvliw-branch
15335 Run a pass to pack branches into VLIW instructions (default).
15337 This switch is mainly for debugging the compiler and will likely be removed
15338 in a future version.
15340 @item -mno-vliw-branch
15341 @opindex mno-vliw-branch
15343 Do not run a pass to pack branches into VLIW instructions.
15345 This switch is mainly for debugging the compiler and will likely be removed
15346 in a future version.
15348 @item -mmulti-cond-exec
15349 @opindex mmulti-cond-exec
15351 Enable optimization of @code{&&} and @code{||} in conditional execution
15352 (default).
15354 This switch is mainly for debugging the compiler and will likely be removed
15355 in a future version.
15357 @item -mno-multi-cond-exec
15358 @opindex mno-multi-cond-exec
15360 Disable optimization of @code{&&} and @code{||} in conditional execution.
15362 This switch is mainly for debugging the compiler and will likely be removed
15363 in a future version.
15365 @item -mnested-cond-exec
15366 @opindex mnested-cond-exec
15368 Enable nested conditional execution optimizations (default).
15370 This switch is mainly for debugging the compiler and will likely be removed
15371 in a future version.
15373 @item -mno-nested-cond-exec
15374 @opindex mno-nested-cond-exec
15376 Disable nested conditional execution optimizations.
15378 This switch is mainly for debugging the compiler and will likely be removed
15379 in a future version.
15381 @item -moptimize-membar
15382 @opindex moptimize-membar
15384 This switch removes redundant @code{membar} instructions from the
15385 compiler-generated code.  It is enabled by default.
15387 @item -mno-optimize-membar
15388 @opindex mno-optimize-membar
15390 This switch disables the automatic removal of redundant @code{membar}
15391 instructions from the generated code.
15393 @item -mtomcat-stats
15394 @opindex mtomcat-stats
15396 Cause gas to print out tomcat statistics.
15398 @item -mcpu=@var{cpu}
15399 @opindex mcpu
15401 Select the processor type for which to generate code.  Possible values are
15402 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
15403 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
15405 @end table
15407 @node GNU/Linux Options
15408 @subsection GNU/Linux Options
15410 These @samp{-m} options are defined for GNU/Linux targets:
15412 @table @gcctabopt
15413 @item -mglibc
15414 @opindex mglibc
15415 Use the GNU C library.  This is the default except
15416 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
15417 @samp{*-*-linux-*android*} targets.
15419 @item -muclibc
15420 @opindex muclibc
15421 Use uClibc C library.  This is the default on
15422 @samp{*-*-linux-*uclibc*} targets.
15424 @item -mmusl
15425 @opindex mmusl
15426 Use the musl C library.  This is the default on
15427 @samp{*-*-linux-*musl*} targets.
15429 @item -mbionic
15430 @opindex mbionic
15431 Use Bionic C library.  This is the default on
15432 @samp{*-*-linux-*android*} targets.
15434 @item -mandroid
15435 @opindex mandroid
15436 Compile code compatible with Android platform.  This is the default on
15437 @samp{*-*-linux-*android*} targets.
15439 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15440 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15441 this option makes the GCC driver pass Android-specific options to the linker.
15442 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15443 to be defined.
15445 @item -tno-android-cc
15446 @opindex tno-android-cc
15447 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15448 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15449 @option{-fno-rtti} by default.
15451 @item -tno-android-ld
15452 @opindex tno-android-ld
15453 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15454 linking options to the linker.
15456 @end table
15458 @node H8/300 Options
15459 @subsection H8/300 Options
15461 These @samp{-m} options are defined for the H8/300 implementations:
15463 @table @gcctabopt
15464 @item -mrelax
15465 @opindex mrelax
15466 Shorten some address references at link time, when possible; uses the
15467 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15468 ld, Using ld}, for a fuller description.
15470 @item -mh
15471 @opindex mh
15472 Generate code for the H8/300H@.
15474 @item -ms
15475 @opindex ms
15476 Generate code for the H8S@.
15478 @item -mn
15479 @opindex mn
15480 Generate code for the H8S and H8/300H in the normal mode.  This switch
15481 must be used either with @option{-mh} or @option{-ms}.
15483 @item -ms2600
15484 @opindex ms2600
15485 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15487 @item -mexr
15488 @opindex mexr
15489 Extended registers are stored on stack before execution of function
15490 with monitor attribute. Default option is @option{-mexr}.
15491 This option is valid only for H8S targets.
15493 @item -mno-exr
15494 @opindex mno-exr
15495 Extended registers are not stored on stack before execution of function 
15496 with monitor attribute. Default option is @option{-mno-exr}. 
15497 This option is valid only for H8S targets.
15499 @item -mint32
15500 @opindex mint32
15501 Make @code{int} data 32 bits by default.
15503 @item -malign-300
15504 @opindex malign-300
15505 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15506 The default for the H8/300H and H8S is to align longs and floats on
15507 4-byte boundaries.
15508 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15509 This option has no effect on the H8/300.
15510 @end table
15512 @node HPPA Options
15513 @subsection HPPA Options
15514 @cindex HPPA Options
15516 These @samp{-m} options are defined for the HPPA family of computers:
15518 @table @gcctabopt
15519 @item -march=@var{architecture-type}
15520 @opindex march
15521 Generate code for the specified architecture.  The choices for
15522 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15523 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15524 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15525 architecture option for your machine.  Code compiled for lower numbered
15526 architectures runs on higher numbered architectures, but not the
15527 other way around.
15529 @item -mpa-risc-1-0
15530 @itemx -mpa-risc-1-1
15531 @itemx -mpa-risc-2-0
15532 @opindex mpa-risc-1-0
15533 @opindex mpa-risc-1-1
15534 @opindex mpa-risc-2-0
15535 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15537 @item -mjump-in-delay
15538 @opindex mjump-in-delay
15539 This option is ignored and provided for compatibility purposes only.
15541 @item -mdisable-fpregs
15542 @opindex mdisable-fpregs
15543 Prevent floating-point registers from being used in any manner.  This is
15544 necessary for compiling kernels that perform lazy context switching of
15545 floating-point registers.  If you use this option and attempt to perform
15546 floating-point operations, the compiler aborts.
15548 @item -mdisable-indexing
15549 @opindex mdisable-indexing
15550 Prevent the compiler from using indexing address modes.  This avoids some
15551 rather obscure problems when compiling MIG generated code under MACH@.
15553 @item -mno-space-regs
15554 @opindex mno-space-regs
15555 Generate code that assumes the target has no space registers.  This allows
15556 GCC to generate faster indirect calls and use unscaled index address modes.
15558 Such code is suitable for level 0 PA systems and kernels.
15560 @item -mfast-indirect-calls
15561 @opindex mfast-indirect-calls
15562 Generate code that assumes calls never cross space boundaries.  This
15563 allows GCC to emit code that performs faster indirect calls.
15565 This option does not work in the presence of shared libraries or nested
15566 functions.
15568 @item -mfixed-range=@var{register-range}
15569 @opindex mfixed-range
15570 Generate code treating the given register range as fixed registers.
15571 A fixed register is one that the register allocator cannot use.  This is
15572 useful when compiling kernel code.  A register range is specified as
15573 two registers separated by a dash.  Multiple register ranges can be
15574 specified separated by a comma.
15576 @item -mlong-load-store
15577 @opindex mlong-load-store
15578 Generate 3-instruction load and store sequences as sometimes required by
15579 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15580 the HP compilers.
15582 @item -mportable-runtime
15583 @opindex mportable-runtime
15584 Use the portable calling conventions proposed by HP for ELF systems.
15586 @item -mgas
15587 @opindex mgas
15588 Enable the use of assembler directives only GAS understands.
15590 @item -mschedule=@var{cpu-type}
15591 @opindex mschedule
15592 Schedule code according to the constraints for the machine type
15593 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15594 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15595 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15596 proper scheduling option for your machine.  The default scheduling is
15597 @samp{8000}.
15599 @item -mlinker-opt
15600 @opindex mlinker-opt
15601 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15602 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15603 linkers in which they give bogus error messages when linking some programs.
15605 @item -msoft-float
15606 @opindex msoft-float
15607 Generate output containing library calls for floating point.
15608 @strong{Warning:} the requisite libraries are not available for all HPPA
15609 targets.  Normally the facilities of the machine's usual C compiler are
15610 used, but this cannot be done directly in cross-compilation.  You must make
15611 your own arrangements to provide suitable library functions for
15612 cross-compilation.
15614 @option{-msoft-float} changes the calling convention in the output file;
15615 therefore, it is only useful if you compile @emph{all} of a program with
15616 this option.  In particular, you need to compile @file{libgcc.a}, the
15617 library that comes with GCC, with @option{-msoft-float} in order for
15618 this to work.
15620 @item -msio
15621 @opindex msio
15622 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15623 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15624 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15625 options are available under HP-UX and HI-UX@.
15627 @item -mgnu-ld
15628 @opindex mgnu-ld
15629 Use options specific to GNU @command{ld}.
15630 This passes @option{-shared} to @command{ld} when
15631 building a shared library.  It is the default when GCC is configured,
15632 explicitly or implicitly, with the GNU linker.  This option does not
15633 affect which @command{ld} is called; it only changes what parameters
15634 are passed to that @command{ld}.
15635 The @command{ld} that is called is determined by the
15636 @option{--with-ld} configure option, GCC's program search path, and
15637 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15638 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15639 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15641 @item -mhp-ld
15642 @opindex mhp-ld
15643 Use options specific to HP @command{ld}.
15644 This passes @option{-b} to @command{ld} when building
15645 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15646 links.  It is the default when GCC is configured, explicitly or
15647 implicitly, with the HP linker.  This option does not affect
15648 which @command{ld} is called; it only changes what parameters are passed to that
15649 @command{ld}.
15650 The @command{ld} that is called is determined by the @option{--with-ld}
15651 configure option, GCC's program search path, and finally by the user's
15652 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15653 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15654 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15656 @item -mlong-calls
15657 @opindex mno-long-calls
15658 Generate code that uses long call sequences.  This ensures that a call
15659 is always able to reach linker generated stubs.  The default is to generate
15660 long calls only when the distance from the call site to the beginning
15661 of the function or translation unit, as the case may be, exceeds a
15662 predefined limit set by the branch type being used.  The limits for
15663 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15664 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15665 240,000 bytes.
15667 Distances are measured from the beginning of functions when using the
15668 @option{-ffunction-sections} option, or when using the @option{-mgas}
15669 and @option{-mno-portable-runtime} options together under HP-UX with
15670 the SOM linker.
15672 It is normally not desirable to use this option as it degrades
15673 performance.  However, it may be useful in large applications,
15674 particularly when partial linking is used to build the application.
15676 The types of long calls used depends on the capabilities of the
15677 assembler and linker, and the type of code being generated.  The
15678 impact on systems that support long absolute calls, and long pic
15679 symbol-difference or pc-relative calls should be relatively small.
15680 However, an indirect call is used on 32-bit ELF systems in pic code
15681 and it is quite long.
15683 @item -munix=@var{unix-std}
15684 @opindex march
15685 Generate compiler predefines and select a startfile for the specified
15686 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15687 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15688 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15689 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15690 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15691 and later.
15693 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15694 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15695 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15696 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15697 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15698 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15700 It is @emph{important} to note that this option changes the interfaces
15701 for various library routines.  It also affects the operational behavior
15702 of the C library.  Thus, @emph{extreme} care is needed in using this
15703 option.
15705 Library code that is intended to operate with more than one UNIX
15706 standard must test, set and restore the variable @code{__xpg4_extended_mask}
15707 as appropriate.  Most GNU software doesn't provide this capability.
15709 @item -nolibdld
15710 @opindex nolibdld
15711 Suppress the generation of link options to search libdld.sl when the
15712 @option{-static} option is specified on HP-UX 10 and later.
15714 @item -static
15715 @opindex static
15716 The HP-UX implementation of setlocale in libc has a dependency on
15717 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15718 when the @option{-static} option is specified, special link options
15719 are needed to resolve this dependency.
15721 On HP-UX 10 and later, the GCC driver adds the necessary options to
15722 link with libdld.sl when the @option{-static} option is specified.
15723 This causes the resulting binary to be dynamic.  On the 64-bit port,
15724 the linkers generate dynamic binaries by default in any case.  The
15725 @option{-nolibdld} option can be used to prevent the GCC driver from
15726 adding these link options.
15728 @item -threads
15729 @opindex threads
15730 Add support for multithreading with the @dfn{dce thread} library
15731 under HP-UX@.  This option sets flags for both the preprocessor and
15732 linker.
15733 @end table
15735 @node IA-64 Options
15736 @subsection IA-64 Options
15737 @cindex IA-64 Options
15739 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15741 @table @gcctabopt
15742 @item -mbig-endian
15743 @opindex mbig-endian
15744 Generate code for a big-endian target.  This is the default for HP-UX@.
15746 @item -mlittle-endian
15747 @opindex mlittle-endian
15748 Generate code for a little-endian target.  This is the default for AIX5
15749 and GNU/Linux.
15751 @item -mgnu-as
15752 @itemx -mno-gnu-as
15753 @opindex mgnu-as
15754 @opindex mno-gnu-as
15755 Generate (or don't) code for the GNU assembler.  This is the default.
15756 @c Also, this is the default if the configure option @option{--with-gnu-as}
15757 @c is used.
15759 @item -mgnu-ld
15760 @itemx -mno-gnu-ld
15761 @opindex mgnu-ld
15762 @opindex mno-gnu-ld
15763 Generate (or don't) code for the GNU linker.  This is the default.
15764 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15765 @c is used.
15767 @item -mno-pic
15768 @opindex mno-pic
15769 Generate code that does not use a global pointer register.  The result
15770 is not position independent code, and violates the IA-64 ABI@.
15772 @item -mvolatile-asm-stop
15773 @itemx -mno-volatile-asm-stop
15774 @opindex mvolatile-asm-stop
15775 @opindex mno-volatile-asm-stop
15776 Generate (or don't) a stop bit immediately before and after volatile asm
15777 statements.
15779 @item -mregister-names
15780 @itemx -mno-register-names
15781 @opindex mregister-names
15782 @opindex mno-register-names
15783 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15784 the stacked registers.  This may make assembler output more readable.
15786 @item -mno-sdata
15787 @itemx -msdata
15788 @opindex mno-sdata
15789 @opindex msdata
15790 Disable (or enable) optimizations that use the small data section.  This may
15791 be useful for working around optimizer bugs.
15793 @item -mconstant-gp
15794 @opindex mconstant-gp
15795 Generate code that uses a single constant global pointer value.  This is
15796 useful when compiling kernel code.
15798 @item -mauto-pic
15799 @opindex mauto-pic
15800 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15801 This is useful when compiling firmware code.
15803 @item -minline-float-divide-min-latency
15804 @opindex minline-float-divide-min-latency
15805 Generate code for inline divides of floating-point values
15806 using the minimum latency algorithm.
15808 @item -minline-float-divide-max-throughput
15809 @opindex minline-float-divide-max-throughput
15810 Generate code for inline divides of floating-point values
15811 using the maximum throughput algorithm.
15813 @item -mno-inline-float-divide
15814 @opindex mno-inline-float-divide
15815 Do not generate inline code for divides of floating-point values.
15817 @item -minline-int-divide-min-latency
15818 @opindex minline-int-divide-min-latency
15819 Generate code for inline divides of integer values
15820 using the minimum latency algorithm.
15822 @item -minline-int-divide-max-throughput
15823 @opindex minline-int-divide-max-throughput
15824 Generate code for inline divides of integer values
15825 using the maximum throughput algorithm.
15827 @item -mno-inline-int-divide
15828 @opindex mno-inline-int-divide
15829 Do not generate inline code for divides of integer values.
15831 @item -minline-sqrt-min-latency
15832 @opindex minline-sqrt-min-latency
15833 Generate code for inline square roots
15834 using the minimum latency algorithm.
15836 @item -minline-sqrt-max-throughput
15837 @opindex minline-sqrt-max-throughput
15838 Generate code for inline square roots
15839 using the maximum throughput algorithm.
15841 @item -mno-inline-sqrt
15842 @opindex mno-inline-sqrt
15843 Do not generate inline code for @code{sqrt}.
15845 @item -mfused-madd
15846 @itemx -mno-fused-madd
15847 @opindex mfused-madd
15848 @opindex mno-fused-madd
15849 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
15850 instructions.  The default is to use these instructions.
15852 @item -mno-dwarf2-asm
15853 @itemx -mdwarf2-asm
15854 @opindex mno-dwarf2-asm
15855 @opindex mdwarf2-asm
15856 Don't (or do) generate assembler code for the DWARF 2 line number debugging
15857 info.  This may be useful when not using the GNU assembler.
15859 @item -mearly-stop-bits
15860 @itemx -mno-early-stop-bits
15861 @opindex mearly-stop-bits
15862 @opindex mno-early-stop-bits
15863 Allow stop bits to be placed earlier than immediately preceding the
15864 instruction that triggered the stop bit.  This can improve instruction
15865 scheduling, but does not always do so.
15867 @item -mfixed-range=@var{register-range}
15868 @opindex mfixed-range
15869 Generate code treating the given register range as fixed registers.
15870 A fixed register is one that the register allocator cannot use.  This is
15871 useful when compiling kernel code.  A register range is specified as
15872 two registers separated by a dash.  Multiple register ranges can be
15873 specified separated by a comma.
15875 @item -mtls-size=@var{tls-size}
15876 @opindex mtls-size
15877 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
15880 @item -mtune=@var{cpu-type}
15881 @opindex mtune
15882 Tune the instruction scheduling for a particular CPU, Valid values are
15883 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15884 and @samp{mckinley}.
15886 @item -milp32
15887 @itemx -mlp64
15888 @opindex milp32
15889 @opindex mlp64
15890 Generate code for a 32-bit or 64-bit environment.
15891 The 32-bit environment sets int, long and pointer to 32 bits.
15892 The 64-bit environment sets int to 32 bits and long and pointer
15893 to 64 bits.  These are HP-UX specific flags.
15895 @item -mno-sched-br-data-spec
15896 @itemx -msched-br-data-spec
15897 @opindex mno-sched-br-data-spec
15898 @opindex msched-br-data-spec
15899 (Dis/En)able data speculative scheduling before reload.
15900 This results in generation of @code{ld.a} instructions and
15901 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15902 The default is 'disable'.
15904 @item -msched-ar-data-spec
15905 @itemx -mno-sched-ar-data-spec
15906 @opindex msched-ar-data-spec
15907 @opindex mno-sched-ar-data-spec
15908 (En/Dis)able data speculative scheduling after reload.
15909 This results in generation of @code{ld.a} instructions and
15910 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15911 The default is 'enable'.
15913 @item -mno-sched-control-spec
15914 @itemx -msched-control-spec
15915 @opindex mno-sched-control-spec
15916 @opindex msched-control-spec
15917 (Dis/En)able control speculative scheduling.  This feature is
15918 available only during region scheduling (i.e.@: before reload).
15919 This results in generation of the @code{ld.s} instructions and
15920 the corresponding check instructions @code{chk.s}.
15921 The default is 'disable'.
15923 @item -msched-br-in-data-spec
15924 @itemx -mno-sched-br-in-data-spec
15925 @opindex msched-br-in-data-spec
15926 @opindex mno-sched-br-in-data-spec
15927 (En/Dis)able speculative scheduling of the instructions that
15928 are dependent on the data speculative loads before reload.
15929 This is effective only with @option{-msched-br-data-spec} enabled.
15930 The default is 'enable'.
15932 @item -msched-ar-in-data-spec
15933 @itemx -mno-sched-ar-in-data-spec
15934 @opindex msched-ar-in-data-spec
15935 @opindex mno-sched-ar-in-data-spec
15936 (En/Dis)able speculative scheduling of the instructions that
15937 are dependent on the data speculative loads after reload.
15938 This is effective only with @option{-msched-ar-data-spec} enabled.
15939 The default is 'enable'.
15941 @item -msched-in-control-spec
15942 @itemx -mno-sched-in-control-spec
15943 @opindex msched-in-control-spec
15944 @opindex mno-sched-in-control-spec
15945 (En/Dis)able speculative scheduling of the instructions that
15946 are dependent on the control speculative loads.
15947 This is effective only with @option{-msched-control-spec} enabled.
15948 The default is 'enable'.
15950 @item -mno-sched-prefer-non-data-spec-insns
15951 @itemx -msched-prefer-non-data-spec-insns
15952 @opindex mno-sched-prefer-non-data-spec-insns
15953 @opindex msched-prefer-non-data-spec-insns
15954 If enabled, data-speculative instructions are chosen for schedule
15955 only if there are no other choices at the moment.  This makes
15956 the use of the data speculation much more conservative.
15957 The default is 'disable'.
15959 @item -mno-sched-prefer-non-control-spec-insns
15960 @itemx -msched-prefer-non-control-spec-insns
15961 @opindex mno-sched-prefer-non-control-spec-insns
15962 @opindex msched-prefer-non-control-spec-insns
15963 If enabled, control-speculative instructions are chosen for schedule
15964 only if there are no other choices at the moment.  This makes
15965 the use of the control speculation much more conservative.
15966 The default is 'disable'.
15968 @item -mno-sched-count-spec-in-critical-path
15969 @itemx -msched-count-spec-in-critical-path
15970 @opindex mno-sched-count-spec-in-critical-path
15971 @opindex msched-count-spec-in-critical-path
15972 If enabled, speculative dependencies are considered during
15973 computation of the instructions priorities.  This makes the use of the
15974 speculation a bit more conservative.
15975 The default is 'disable'.
15977 @item -msched-spec-ldc
15978 @opindex msched-spec-ldc
15979 Use a simple data speculation check.  This option is on by default.
15981 @item -msched-control-spec-ldc
15982 @opindex msched-spec-ldc
15983 Use a simple check for control speculation.  This option is on by default.
15985 @item -msched-stop-bits-after-every-cycle
15986 @opindex msched-stop-bits-after-every-cycle
15987 Place a stop bit after every cycle when scheduling.  This option is on
15988 by default.
15990 @item -msched-fp-mem-deps-zero-cost
15991 @opindex msched-fp-mem-deps-zero-cost
15992 Assume that floating-point stores and loads are not likely to cause a conflict
15993 when placed into the same instruction group.  This option is disabled by
15994 default.
15996 @item -msel-sched-dont-check-control-spec
15997 @opindex msel-sched-dont-check-control-spec
15998 Generate checks for control speculation in selective scheduling.
15999 This flag is disabled by default.
16001 @item -msched-max-memory-insns=@var{max-insns}
16002 @opindex msched-max-memory-insns
16003 Limit on the number of memory insns per instruction group, giving lower
16004 priority to subsequent memory insns attempting to schedule in the same
16005 instruction group. Frequently useful to prevent cache bank conflicts.
16006 The default value is 1.
16008 @item -msched-max-memory-insns-hard-limit
16009 @opindex msched-max-memory-insns-hard-limit
16010 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16011 disallowing more than that number in an instruction group.
16012 Otherwise, the limit is ``soft'', meaning that non-memory operations
16013 are preferred when the limit is reached, but memory operations may still
16014 be scheduled.
16016 @end table
16018 @node LM32 Options
16019 @subsection LM32 Options
16020 @cindex LM32 options
16022 These @option{-m} options are defined for the LatticeMico32 architecture:
16024 @table @gcctabopt
16025 @item -mbarrel-shift-enabled
16026 @opindex mbarrel-shift-enabled
16027 Enable barrel-shift instructions.
16029 @item -mdivide-enabled
16030 @opindex mdivide-enabled
16031 Enable divide and modulus instructions.
16033 @item -mmultiply-enabled
16034 @opindex multiply-enabled
16035 Enable multiply instructions.
16037 @item -msign-extend-enabled
16038 @opindex msign-extend-enabled
16039 Enable sign extend instructions.
16041 @item -muser-enabled
16042 @opindex muser-enabled
16043 Enable user-defined instructions.
16045 @end table
16047 @node M32C Options
16048 @subsection M32C Options
16049 @cindex M32C options
16051 @table @gcctabopt
16052 @item -mcpu=@var{name}
16053 @opindex mcpu=
16054 Select the CPU for which code is generated.  @var{name} may be one of
16055 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16056 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16057 the M32C/80 series.
16059 @item -msim
16060 @opindex msim
16061 Specifies that the program will be run on the simulator.  This causes
16062 an alternate runtime library to be linked in which supports, for
16063 example, file I/O@.  You must not use this option when generating
16064 programs that will run on real hardware; you must provide your own
16065 runtime library for whatever I/O functions are needed.
16067 @item -memregs=@var{number}
16068 @opindex memregs=
16069 Specifies the number of memory-based pseudo-registers GCC uses
16070 during code generation.  These pseudo-registers are used like real
16071 registers, so there is a tradeoff between GCC's ability to fit the
16072 code into available registers, and the performance penalty of using
16073 memory instead of registers.  Note that all modules in a program must
16074 be compiled with the same value for this option.  Because of that, you
16075 must not use this option with GCC's default runtime libraries.
16077 @end table
16079 @node M32R/D Options
16080 @subsection M32R/D Options
16081 @cindex M32R/D options
16083 These @option{-m} options are defined for Renesas M32R/D architectures:
16085 @table @gcctabopt
16086 @item -m32r2
16087 @opindex m32r2
16088 Generate code for the M32R/2@.
16090 @item -m32rx
16091 @opindex m32rx
16092 Generate code for the M32R/X@.
16094 @item -m32r
16095 @opindex m32r
16096 Generate code for the M32R@.  This is the default.
16098 @item -mmodel=small
16099 @opindex mmodel=small
16100 Assume all objects live in the lower 16MB of memory (so that their addresses
16101 can be loaded with the @code{ld24} instruction), and assume all subroutines
16102 are reachable with the @code{bl} instruction.
16103 This is the default.
16105 The addressability of a particular object can be set with the
16106 @code{model} attribute.
16108 @item -mmodel=medium
16109 @opindex mmodel=medium
16110 Assume objects may be anywhere in the 32-bit address space (the compiler
16111 generates @code{seth/add3} instructions to load their addresses), and
16112 assume all subroutines are reachable with the @code{bl} instruction.
16114 @item -mmodel=large
16115 @opindex mmodel=large
16116 Assume objects may be anywhere in the 32-bit address space (the compiler
16117 generates @code{seth/add3} instructions to load their addresses), and
16118 assume subroutines may not be reachable with the @code{bl} instruction
16119 (the compiler generates the much slower @code{seth/add3/jl}
16120 instruction sequence).
16122 @item -msdata=none
16123 @opindex msdata=none
16124 Disable use of the small data area.  Variables are put into
16125 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16126 @code{section} attribute has been specified).
16127 This is the default.
16129 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16130 Objects may be explicitly put in the small data area with the
16131 @code{section} attribute using one of these sections.
16133 @item -msdata=sdata
16134 @opindex msdata=sdata
16135 Put small global and static data in the small data area, but do not
16136 generate special code to reference them.
16138 @item -msdata=use
16139 @opindex msdata=use
16140 Put small global and static data in the small data area, and generate
16141 special instructions to reference them.
16143 @item -G @var{num}
16144 @opindex G
16145 @cindex smaller data references
16146 Put global and static objects less than or equal to @var{num} bytes
16147 into the small data or BSS sections instead of the normal data or BSS
16148 sections.  The default value of @var{num} is 8.
16149 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16150 for this option to have any effect.
16152 All modules should be compiled with the same @option{-G @var{num}} value.
16153 Compiling with different values of @var{num} may or may not work; if it
16154 doesn't the linker gives an error message---incorrect code is not
16155 generated.
16157 @item -mdebug
16158 @opindex mdebug
16159 Makes the M32R-specific code in the compiler display some statistics
16160 that might help in debugging programs.
16162 @item -malign-loops
16163 @opindex malign-loops
16164 Align all loops to a 32-byte boundary.
16166 @item -mno-align-loops
16167 @opindex mno-align-loops
16168 Do not enforce a 32-byte alignment for loops.  This is the default.
16170 @item -missue-rate=@var{number}
16171 @opindex missue-rate=@var{number}
16172 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16173 or 2.
16175 @item -mbranch-cost=@var{number}
16176 @opindex mbranch-cost=@var{number}
16177 @var{number} can only be 1 or 2.  If it is 1 then branches are
16178 preferred over conditional code, if it is 2, then the opposite applies.
16180 @item -mflush-trap=@var{number}
16181 @opindex mflush-trap=@var{number}
16182 Specifies the trap number to use to flush the cache.  The default is
16183 12.  Valid numbers are between 0 and 15 inclusive.
16185 @item -mno-flush-trap
16186 @opindex mno-flush-trap
16187 Specifies that the cache cannot be flushed by using a trap.
16189 @item -mflush-func=@var{name}
16190 @opindex mflush-func=@var{name}
16191 Specifies the name of the operating system function to call to flush
16192 the cache.  The default is @samp{_flush_cache}, but a function call
16193 is only used if a trap is not available.
16195 @item -mno-flush-func
16196 @opindex mno-flush-func
16197 Indicates that there is no OS function for flushing the cache.
16199 @end table
16201 @node M680x0 Options
16202 @subsection M680x0 Options
16203 @cindex M680x0 options
16205 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16206 The default settings depend on which architecture was selected when
16207 the compiler was configured; the defaults for the most common choices
16208 are given below.
16210 @table @gcctabopt
16211 @item -march=@var{arch}
16212 @opindex march
16213 Generate code for a specific M680x0 or ColdFire instruction set
16214 architecture.  Permissible values of @var{arch} for M680x0
16215 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16216 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16217 architectures are selected according to Freescale's ISA classification
16218 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16219 @samp{isab} and @samp{isac}.
16221 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
16222 code for a ColdFire target.  The @var{arch} in this macro is one of the
16223 @option{-march} arguments given above.
16225 When used together, @option{-march} and @option{-mtune} select code
16226 that runs on a family of similar processors but that is optimized
16227 for a particular microarchitecture.
16229 @item -mcpu=@var{cpu}
16230 @opindex mcpu
16231 Generate code for a specific M680x0 or ColdFire processor.
16232 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16233 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16234 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16235 below, which also classifies the CPUs into families:
16237 @multitable @columnfractions 0.20 0.80
16238 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16239 @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}
16240 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16241 @item @samp{5206e} @tab @samp{5206e}
16242 @item @samp{5208} @tab @samp{5207} @samp{5208}
16243 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16244 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16245 @item @samp{5216} @tab @samp{5214} @samp{5216}
16246 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16247 @item @samp{5225} @tab @samp{5224} @samp{5225}
16248 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16249 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16250 @item @samp{5249} @tab @samp{5249}
16251 @item @samp{5250} @tab @samp{5250}
16252 @item @samp{5271} @tab @samp{5270} @samp{5271}
16253 @item @samp{5272} @tab @samp{5272}
16254 @item @samp{5275} @tab @samp{5274} @samp{5275}
16255 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16256 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16257 @item @samp{5307} @tab @samp{5307}
16258 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16259 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16260 @item @samp{5407} @tab @samp{5407}
16261 @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}
16262 @end multitable
16264 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16265 @var{arch} is compatible with @var{cpu}.  Other combinations of
16266 @option{-mcpu} and @option{-march} are rejected.
16268 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
16269 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
16270 where the value of @var{family} is given by the table above.
16272 @item -mtune=@var{tune}
16273 @opindex mtune
16274 Tune the code for a particular microarchitecture within the
16275 constraints set by @option{-march} and @option{-mcpu}.
16276 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16277 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16278 and @samp{cpu32}.  The ColdFire microarchitectures
16279 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16281 You can also use @option{-mtune=68020-40} for code that needs
16282 to run relatively well on 68020, 68030 and 68040 targets.
16283 @option{-mtune=68020-60} is similar but includes 68060 targets
16284 as well.  These two options select the same tuning decisions as
16285 @option{-m68020-40} and @option{-m68020-60} respectively.
16287 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
16288 when tuning for 680x0 architecture @var{arch}.  It also defines
16289 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16290 option is used.  If GCC is tuning for a range of architectures,
16291 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16292 it defines the macros for every architecture in the range.
16294 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
16295 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16296 of the arguments given above.
16298 @item -m68000
16299 @itemx -mc68000
16300 @opindex m68000
16301 @opindex mc68000
16302 Generate output for a 68000.  This is the default
16303 when the compiler is configured for 68000-based systems.
16304 It is equivalent to @option{-march=68000}.
16306 Use this option for microcontrollers with a 68000 or EC000 core,
16307 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16309 @item -m68010
16310 @opindex m68010
16311 Generate output for a 68010.  This is the default
16312 when the compiler is configured for 68010-based systems.
16313 It is equivalent to @option{-march=68010}.
16315 @item -m68020
16316 @itemx -mc68020
16317 @opindex m68020
16318 @opindex mc68020
16319 Generate output for a 68020.  This is the default
16320 when the compiler is configured for 68020-based systems.
16321 It is equivalent to @option{-march=68020}.
16323 @item -m68030
16324 @opindex m68030
16325 Generate output for a 68030.  This is the default when the compiler is
16326 configured for 68030-based systems.  It is equivalent to
16327 @option{-march=68030}.
16329 @item -m68040
16330 @opindex m68040
16331 Generate output for a 68040.  This is the default when the compiler is
16332 configured for 68040-based systems.  It is equivalent to
16333 @option{-march=68040}.
16335 This option inhibits the use of 68881/68882 instructions that have to be
16336 emulated by software on the 68040.  Use this option if your 68040 does not
16337 have code to emulate those instructions.
16339 @item -m68060
16340 @opindex m68060
16341 Generate output for a 68060.  This is the default when the compiler is
16342 configured for 68060-based systems.  It is equivalent to
16343 @option{-march=68060}.
16345 This option inhibits the use of 68020 and 68881/68882 instructions that
16346 have to be emulated by software on the 68060.  Use this option if your 68060
16347 does not have code to emulate those instructions.
16349 @item -mcpu32
16350 @opindex mcpu32
16351 Generate output for a CPU32.  This is the default
16352 when the compiler is configured for CPU32-based systems.
16353 It is equivalent to @option{-march=cpu32}.
16355 Use this option for microcontrollers with a
16356 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16357 68336, 68340, 68341, 68349 and 68360.
16359 @item -m5200
16360 @opindex m5200
16361 Generate output for a 520X ColdFire CPU@.  This is the default
16362 when the compiler is configured for 520X-based systems.
16363 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16364 in favor of that option.
16366 Use this option for microcontroller with a 5200 core, including
16367 the MCF5202, MCF5203, MCF5204 and MCF5206.
16369 @item -m5206e
16370 @opindex m5206e
16371 Generate output for a 5206e ColdFire CPU@.  The option is now
16372 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16374 @item -m528x
16375 @opindex m528x
16376 Generate output for a member of the ColdFire 528X family.
16377 The option is now deprecated in favor of the equivalent
16378 @option{-mcpu=528x}.
16380 @item -m5307
16381 @opindex m5307
16382 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16383 in favor of the equivalent @option{-mcpu=5307}.
16385 @item -m5407
16386 @opindex m5407
16387 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16388 in favor of the equivalent @option{-mcpu=5407}.
16390 @item -mcfv4e
16391 @opindex mcfv4e
16392 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16393 This includes use of hardware floating-point instructions.
16394 The option is equivalent to @option{-mcpu=547x}, and is now
16395 deprecated in favor of that option.
16397 @item -m68020-40
16398 @opindex m68020-40
16399 Generate output for a 68040, without using any of the new instructions.
16400 This results in code that can run relatively efficiently on either a
16401 68020/68881 or a 68030 or a 68040.  The generated code does use the
16402 68881 instructions that are emulated on the 68040.
16404 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16406 @item -m68020-60
16407 @opindex m68020-60
16408 Generate output for a 68060, without using any of the new instructions.
16409 This results in code that can run relatively efficiently on either a
16410 68020/68881 or a 68030 or a 68040.  The generated code does use the
16411 68881 instructions that are emulated on the 68060.
16413 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16415 @item -mhard-float
16416 @itemx -m68881
16417 @opindex mhard-float
16418 @opindex m68881
16419 Generate floating-point instructions.  This is the default for 68020
16420 and above, and for ColdFire devices that have an FPU@.  It defines the
16421 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
16422 on ColdFire targets.
16424 @item -msoft-float
16425 @opindex msoft-float
16426 Do not generate floating-point instructions; use library calls instead.
16427 This is the default for 68000, 68010, and 68832 targets.  It is also
16428 the default for ColdFire devices that have no FPU.
16430 @item -mdiv
16431 @itemx -mno-div
16432 @opindex mdiv
16433 @opindex mno-div
16434 Generate (do not generate) ColdFire hardware divide and remainder
16435 instructions.  If @option{-march} is used without @option{-mcpu},
16436 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16437 architectures.  Otherwise, the default is taken from the target CPU
16438 (either the default CPU, or the one specified by @option{-mcpu}).  For
16439 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16440 @option{-mcpu=5206e}.
16442 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
16444 @item -mshort
16445 @opindex mshort
16446 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16447 Additionally, parameters passed on the stack are also aligned to a
16448 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16450 @item -mno-short
16451 @opindex mno-short
16452 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16454 @item -mnobitfield
16455 @itemx -mno-bitfield
16456 @opindex mnobitfield
16457 @opindex mno-bitfield
16458 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16459 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16461 @item -mbitfield
16462 @opindex mbitfield
16463 Do use the bit-field instructions.  The @option{-m68020} option implies
16464 @option{-mbitfield}.  This is the default if you use a configuration
16465 designed for a 68020.
16467 @item -mrtd
16468 @opindex mrtd
16469 Use a different function-calling convention, in which functions
16470 that take a fixed number of arguments return with the @code{rtd}
16471 instruction, which pops their arguments while returning.  This
16472 saves one instruction in the caller since there is no need to pop
16473 the arguments there.
16475 This calling convention is incompatible with the one normally
16476 used on Unix, so you cannot use it if you need to call libraries
16477 compiled with the Unix compiler.
16479 Also, you must provide function prototypes for all functions that
16480 take variable numbers of arguments (including @code{printf});
16481 otherwise incorrect code is generated for calls to those
16482 functions.
16484 In addition, seriously incorrect code results if you call a
16485 function with too many arguments.  (Normally, extra arguments are
16486 harmlessly ignored.)
16488 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16489 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16491 @item -mno-rtd
16492 @opindex mno-rtd
16493 Do not use the calling conventions selected by @option{-mrtd}.
16494 This is the default.
16496 @item -malign-int
16497 @itemx -mno-align-int
16498 @opindex malign-int
16499 @opindex mno-align-int
16500 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16501 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16502 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16503 Aligning variables on 32-bit boundaries produces code that runs somewhat
16504 faster on processors with 32-bit busses at the expense of more memory.
16506 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16507 aligns structures containing the above types differently than
16508 most published application binary interface specifications for the m68k.
16510 @item -mpcrel
16511 @opindex mpcrel
16512 Use the pc-relative addressing mode of the 68000 directly, instead of
16513 using a global offset table.  At present, this option implies @option{-fpic},
16514 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16515 not presently supported with @option{-mpcrel}, though this could be supported for
16516 68020 and higher processors.
16518 @item -mno-strict-align
16519 @itemx -mstrict-align
16520 @opindex mno-strict-align
16521 @opindex mstrict-align
16522 Do not (do) assume that unaligned memory references are handled by
16523 the system.
16525 @item -msep-data
16526 Generate code that allows the data segment to be located in a different
16527 area of memory from the text segment.  This allows for execute-in-place in
16528 an environment without virtual memory management.  This option implies
16529 @option{-fPIC}.
16531 @item -mno-sep-data
16532 Generate code that assumes that the data segment follows the text segment.
16533 This is the default.
16535 @item -mid-shared-library
16536 Generate code that supports shared libraries via the library ID method.
16537 This allows for execute-in-place and shared libraries in an environment
16538 without virtual memory management.  This option implies @option{-fPIC}.
16540 @item -mno-id-shared-library
16541 Generate code that doesn't assume ID-based shared libraries are being used.
16542 This is the default.
16544 @item -mshared-library-id=n
16545 Specifies the identification number of the ID-based shared library being
16546 compiled.  Specifying a value of 0 generates more compact code; specifying
16547 other values forces the allocation of that number to the current
16548 library, but is no more space- or time-efficient than omitting this option.
16550 @item -mxgot
16551 @itemx -mno-xgot
16552 @opindex mxgot
16553 @opindex mno-xgot
16554 When generating position-independent code for ColdFire, generate code
16555 that works if the GOT has more than 8192 entries.  This code is
16556 larger and slower than code generated without this option.  On M680x0
16557 processors, this option is not needed; @option{-fPIC} suffices.
16559 GCC normally uses a single instruction to load values from the GOT@.
16560 While this is relatively efficient, it only works if the GOT
16561 is smaller than about 64k.  Anything larger causes the linker
16562 to report an error such as:
16564 @cindex relocation truncated to fit (ColdFire)
16565 @smallexample
16566 relocation truncated to fit: R_68K_GOT16O foobar
16567 @end smallexample
16569 If this happens, you should recompile your code with @option{-mxgot}.
16570 It should then work with very large GOTs.  However, code generated with
16571 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16572 the value of a global symbol.
16574 Note that some linkers, including newer versions of the GNU linker,
16575 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16576 you should only need to use @option{-mxgot} when compiling a single
16577 object file that accesses more than 8192 GOT entries.  Very few do.
16579 These options have no effect unless GCC is generating
16580 position-independent code.
16582 @end table
16584 @node MCore Options
16585 @subsection MCore Options
16586 @cindex MCore options
16588 These are the @samp{-m} options defined for the Motorola M*Core
16589 processors.
16591 @table @gcctabopt
16593 @item -mhardlit
16594 @itemx -mno-hardlit
16595 @opindex mhardlit
16596 @opindex mno-hardlit
16597 Inline constants into the code stream if it can be done in two
16598 instructions or less.
16600 @item -mdiv
16601 @itemx -mno-div
16602 @opindex mdiv
16603 @opindex mno-div
16604 Use the divide instruction.  (Enabled by default).
16606 @item -mrelax-immediate
16607 @itemx -mno-relax-immediate
16608 @opindex mrelax-immediate
16609 @opindex mno-relax-immediate
16610 Allow arbitrary-sized immediates in bit operations.
16612 @item -mwide-bitfields
16613 @itemx -mno-wide-bitfields
16614 @opindex mwide-bitfields
16615 @opindex mno-wide-bitfields
16616 Always treat bit-fields as @code{int}-sized.
16618 @item -m4byte-functions
16619 @itemx -mno-4byte-functions
16620 @opindex m4byte-functions
16621 @opindex mno-4byte-functions
16622 Force all functions to be aligned to a 4-byte boundary.
16624 @item -mcallgraph-data
16625 @itemx -mno-callgraph-data
16626 @opindex mcallgraph-data
16627 @opindex mno-callgraph-data
16628 Emit callgraph information.
16630 @item -mslow-bytes
16631 @itemx -mno-slow-bytes
16632 @opindex mslow-bytes
16633 @opindex mno-slow-bytes
16634 Prefer word access when reading byte quantities.
16636 @item -mlittle-endian
16637 @itemx -mbig-endian
16638 @opindex mlittle-endian
16639 @opindex mbig-endian
16640 Generate code for a little-endian target.
16642 @item -m210
16643 @itemx -m340
16644 @opindex m210
16645 @opindex m340
16646 Generate code for the 210 processor.
16648 @item -mno-lsim
16649 @opindex mno-lsim
16650 Assume that runtime support has been provided and so omit the
16651 simulator library (@file{libsim.a)} from the linker command line.
16653 @item -mstack-increment=@var{size}
16654 @opindex mstack-increment
16655 Set the maximum amount for a single stack increment operation.  Large
16656 values can increase the speed of programs that contain functions
16657 that need a large amount of stack space, but they can also trigger a
16658 segmentation fault if the stack is extended too much.  The default
16659 value is 0x1000.
16661 @end table
16663 @node MeP Options
16664 @subsection MeP Options
16665 @cindex MeP options
16667 @table @gcctabopt
16669 @item -mabsdiff
16670 @opindex mabsdiff
16671 Enables the @code{abs} instruction, which is the absolute difference
16672 between two registers.
16674 @item -mall-opts
16675 @opindex mall-opts
16676 Enables all the optional instructions---average, multiply, divide, bit
16677 operations, leading zero, absolute difference, min/max, clip, and
16678 saturation.
16681 @item -maverage
16682 @opindex maverage
16683 Enables the @code{ave} instruction, which computes the average of two
16684 registers.
16686 @item -mbased=@var{n}
16687 @opindex mbased=
16688 Variables of size @var{n} bytes or smaller are placed in the
16689 @code{.based} section by default.  Based variables use the @code{$tp}
16690 register as a base register, and there is a 128-byte limit to the
16691 @code{.based} section.
16693 @item -mbitops
16694 @opindex mbitops
16695 Enables the bit operation instructions---bit test (@code{btstm}), set
16696 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16697 test-and-set (@code{tas}).
16699 @item -mc=@var{name}
16700 @opindex mc=
16701 Selects which section constant data is placed in.  @var{name} may
16702 be @samp{tiny}, @samp{near}, or @samp{far}.
16704 @item -mclip
16705 @opindex mclip
16706 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
16707 useful unless you also provide @option{-mminmax}.
16709 @item -mconfig=@var{name}
16710 @opindex mconfig=
16711 Selects one of the built-in core configurations.  Each MeP chip has
16712 one or more modules in it; each module has a core CPU and a variety of
16713 coprocessors, optional instructions, and peripherals.  The
16714 @code{MeP-Integrator} tool, not part of GCC, provides these
16715 configurations through this option; using this option is the same as
16716 using all the corresponding command-line options.  The default
16717 configuration is @samp{default}.
16719 @item -mcop
16720 @opindex mcop
16721 Enables the coprocessor instructions.  By default, this is a 32-bit
16722 coprocessor.  Note that the coprocessor is normally enabled via the
16723 @option{-mconfig=} option.
16725 @item -mcop32
16726 @opindex mcop32
16727 Enables the 32-bit coprocessor's instructions.
16729 @item -mcop64
16730 @opindex mcop64
16731 Enables the 64-bit coprocessor's instructions.
16733 @item -mivc2
16734 @opindex mivc2
16735 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16737 @item -mdc
16738 @opindex mdc
16739 Causes constant variables to be placed in the @code{.near} section.
16741 @item -mdiv
16742 @opindex mdiv
16743 Enables the @code{div} and @code{divu} instructions.
16745 @item -meb
16746 @opindex meb
16747 Generate big-endian code.
16749 @item -mel
16750 @opindex mel
16751 Generate little-endian code.
16753 @item -mio-volatile
16754 @opindex mio-volatile
16755 Tells the compiler that any variable marked with the @code{io}
16756 attribute is to be considered volatile.
16758 @item -ml
16759 @opindex ml
16760 Causes variables to be assigned to the @code{.far} section by default.
16762 @item -mleadz
16763 @opindex mleadz
16764 Enables the @code{leadz} (leading zero) instruction.
16766 @item -mm
16767 @opindex mm
16768 Causes variables to be assigned to the @code{.near} section by default.
16770 @item -mminmax
16771 @opindex mminmax
16772 Enables the @code{min} and @code{max} instructions.
16774 @item -mmult
16775 @opindex mmult
16776 Enables the multiplication and multiply-accumulate instructions.
16778 @item -mno-opts
16779 @opindex mno-opts
16780 Disables all the optional instructions enabled by @option{-mall-opts}.
16782 @item -mrepeat
16783 @opindex mrepeat
16784 Enables the @code{repeat} and @code{erepeat} instructions, used for
16785 low-overhead looping.
16787 @item -ms
16788 @opindex ms
16789 Causes all variables to default to the @code{.tiny} section.  Note
16790 that there is a 65536-byte limit to this section.  Accesses to these
16791 variables use the @code{%gp} base register.
16793 @item -msatur
16794 @opindex msatur
16795 Enables the saturation instructions.  Note that the compiler does not
16796 currently generate these itself, but this option is included for
16797 compatibility with other tools, like @code{as}.
16799 @item -msdram
16800 @opindex msdram
16801 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16803 @item -msim
16804 @opindex msim
16805 Link the simulator run-time libraries.
16807 @item -msimnovec
16808 @opindex msimnovec
16809 Link the simulator runtime libraries, excluding built-in support
16810 for reset and exception vectors and tables.
16812 @item -mtf
16813 @opindex mtf
16814 Causes all functions to default to the @code{.far} section.  Without
16815 this option, functions default to the @code{.near} section.
16817 @item -mtiny=@var{n}
16818 @opindex mtiny=
16819 Variables that are @var{n} bytes or smaller are allocated to the
16820 @code{.tiny} section.  These variables use the @code{$gp} base
16821 register.  The default for this option is 4, but note that there's a
16822 65536-byte limit to the @code{.tiny} section.
16824 @end table
16826 @node MicroBlaze Options
16827 @subsection MicroBlaze Options
16828 @cindex MicroBlaze Options
16830 @table @gcctabopt
16832 @item -msoft-float
16833 @opindex msoft-float
16834 Use software emulation for floating point (default).
16836 @item -mhard-float
16837 @opindex mhard-float
16838 Use hardware floating-point instructions.
16840 @item -mmemcpy
16841 @opindex mmemcpy
16842 Do not optimize block moves, use @code{memcpy}.
16844 @item -mno-clearbss
16845 @opindex mno-clearbss
16846 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
16848 @item -mcpu=@var{cpu-type}
16849 @opindex mcpu=
16850 Use features of, and schedule code for, the given CPU.
16851 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
16852 where @var{X} is a major version, @var{YY} is the minor version, and
16853 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
16854 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
16856 @item -mxl-soft-mul
16857 @opindex mxl-soft-mul
16858 Use software multiply emulation (default).
16860 @item -mxl-soft-div
16861 @opindex mxl-soft-div
16862 Use software emulation for divides (default).
16864 @item -mxl-barrel-shift
16865 @opindex mxl-barrel-shift
16866 Use the hardware barrel shifter.
16868 @item -mxl-pattern-compare
16869 @opindex mxl-pattern-compare
16870 Use pattern compare instructions.
16872 @item -msmall-divides
16873 @opindex msmall-divides
16874 Use table lookup optimization for small signed integer divisions.
16876 @item -mxl-stack-check
16877 @opindex mxl-stack-check
16878 This option is deprecated.  Use @option{-fstack-check} instead.
16880 @item -mxl-gp-opt
16881 @opindex mxl-gp-opt
16882 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16884 @item -mxl-multiply-high
16885 @opindex mxl-multiply-high
16886 Use multiply high instructions for high part of 32x32 multiply.
16888 @item -mxl-float-convert
16889 @opindex mxl-float-convert
16890 Use hardware floating-point conversion instructions.
16892 @item -mxl-float-sqrt
16893 @opindex mxl-float-sqrt
16894 Use hardware floating-point square root instruction.
16896 @item -mbig-endian
16897 @opindex mbig-endian
16898 Generate code for a big-endian target.
16900 @item -mlittle-endian
16901 @opindex mlittle-endian
16902 Generate code for a little-endian target.
16904 @item -mxl-reorder
16905 @opindex mxl-reorder
16906 Use reorder instructions (swap and byte reversed load/store).
16908 @item -mxl-mode-@var{app-model}
16909 Select application model @var{app-model}.  Valid models are
16910 @table @samp
16911 @item executable
16912 normal executable (default), uses startup code @file{crt0.o}.
16914 @item xmdstub
16915 for use with Xilinx Microprocessor Debugger (XMD) based
16916 software intrusive debug agent called xmdstub. This uses startup file
16917 @file{crt1.o} and sets the start address of the program to 0x800.
16919 @item bootstrap
16920 for applications that are loaded using a bootloader.
16921 This model uses startup file @file{crt2.o} which does not contain a processor
16922 reset vector handler. This is suitable for transferring control on a
16923 processor reset to the bootloader rather than the application.
16925 @item novectors
16926 for applications that do not require any of the
16927 MicroBlaze vectors. This option may be useful for applications running
16928 within a monitoring application. This model uses @file{crt3.o} as a startup file.
16929 @end table
16931 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
16932 @option{-mxl-mode-@var{app-model}}.
16934 @end table
16936 @node MIPS Options
16937 @subsection MIPS Options
16938 @cindex MIPS options
16940 @table @gcctabopt
16942 @item -EB
16943 @opindex EB
16944 Generate big-endian code.
16946 @item -EL
16947 @opindex EL
16948 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
16949 configurations.
16951 @item -march=@var{arch}
16952 @opindex march
16953 Generate code that runs on @var{arch}, which can be the name of a
16954 generic MIPS ISA, or the name of a particular processor.
16955 The ISA names are:
16956 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
16957 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
16958 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
16959 @samp{mips64r5} and @samp{mips64r6}.
16960 The processor names are:
16961 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
16962 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
16963 @samp{5kc}, @samp{5kf},
16964 @samp{20kc},
16965 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
16966 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
16967 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
16968 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
16969 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
16970 @samp{i6400},
16971 @samp{interaptiv},
16972 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
16973 @samp{m4k},
16974 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
16975 @samp{m5100}, @samp{m5101},
16976 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
16977 @samp{orion},
16978 @samp{p5600},
16979 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
16980 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
16981 @samp{rm7000}, @samp{rm9000},
16982 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
16983 @samp{sb1},
16984 @samp{sr71000},
16985 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
16986 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
16987 @samp{xlr} and @samp{xlp}.
16988 The special value @samp{from-abi} selects the
16989 most compatible architecture for the selected ABI (that is,
16990 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
16992 The native Linux/GNU toolchain also supports the value @samp{native},
16993 which selects the best architecture option for the host processor.
16994 @option{-march=native} has no effect if GCC does not recognize
16995 the processor.
16997 In processor names, a final @samp{000} can be abbreviated as @samp{k}
16998 (for example, @option{-march=r2k}).  Prefixes are optional, and
16999 @samp{vr} may be written @samp{r}.
17001 Names of the form @samp{@var{n}f2_1} refer to processors with
17002 FPUs clocked at half the rate of the core, names of the form
17003 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17004 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17005 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17006 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17007 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17008 accepted as synonyms for @samp{@var{n}f1_1}.
17010 GCC defines two macros based on the value of this option.  The first
17011 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
17012 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
17013 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
17014 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
17015 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
17017 Note that the @code{_MIPS_ARCH} macro uses the processor names given
17018 above.  In other words, it has the full prefix and does not
17019 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17020 the macro names the resolved architecture (either @code{"mips1"} or
17021 @code{"mips3"}).  It names the default architecture when no
17022 @option{-march} option is given.
17024 @item -mtune=@var{arch}
17025 @opindex mtune
17026 Optimize for @var{arch}.  Among other things, this option controls
17027 the way instructions are scheduled, and the perceived cost of arithmetic
17028 operations.  The list of @var{arch} values is the same as for
17029 @option{-march}.
17031 When this option is not used, GCC optimizes for the processor
17032 specified by @option{-march}.  By using @option{-march} and
17033 @option{-mtune} together, it is possible to generate code that
17034 runs on a family of processors, but optimize the code for one
17035 particular member of that family.
17037 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
17038 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17039 @option{-march} ones described above.
17041 @item -mips1
17042 @opindex mips1
17043 Equivalent to @option{-march=mips1}.
17045 @item -mips2
17046 @opindex mips2
17047 Equivalent to @option{-march=mips2}.
17049 @item -mips3
17050 @opindex mips3
17051 Equivalent to @option{-march=mips3}.
17053 @item -mips4
17054 @opindex mips4
17055 Equivalent to @option{-march=mips4}.
17057 @item -mips32
17058 @opindex mips32
17059 Equivalent to @option{-march=mips32}.
17061 @item -mips32r3
17062 @opindex mips32r3
17063 Equivalent to @option{-march=mips32r3}.
17065 @item -mips32r5
17066 @opindex mips32r5
17067 Equivalent to @option{-march=mips32r5}.
17069 @item -mips32r6
17070 @opindex mips32r6
17071 Equivalent to @option{-march=mips32r6}.
17073 @item -mips64
17074 @opindex mips64
17075 Equivalent to @option{-march=mips64}.
17077 @item -mips64r2
17078 @opindex mips64r2
17079 Equivalent to @option{-march=mips64r2}.
17081 @item -mips64r3
17082 @opindex mips64r3
17083 Equivalent to @option{-march=mips64r3}.
17085 @item -mips64r5
17086 @opindex mips64r5
17087 Equivalent to @option{-march=mips64r5}.
17089 @item -mips64r6
17090 @opindex mips64r6
17091 Equivalent to @option{-march=mips64r6}.
17093 @item -mips16
17094 @itemx -mno-mips16
17095 @opindex mips16
17096 @opindex mno-mips16
17097 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17098 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17100 MIPS16 code generation can also be controlled on a per-function basis
17101 by means of @code{mips16} and @code{nomips16} attributes.
17102 @xref{Function Attributes}, for more information.
17104 @item -mflip-mips16
17105 @opindex mflip-mips16
17106 Generate MIPS16 code on alternating functions.  This option is provided
17107 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17108 not intended for ordinary use in compiling user code.
17110 @item -minterlink-compressed
17111 @item -mno-interlink-compressed
17112 @opindex minterlink-compressed
17113 @opindex mno-interlink-compressed
17114 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17115 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17117 For example, code using the standard ISA encoding cannot jump directly
17118 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17119 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17120 knows that the target of the jump is not compressed.
17122 @item -minterlink-mips16
17123 @itemx -mno-interlink-mips16
17124 @opindex minterlink-mips16
17125 @opindex mno-interlink-mips16
17126 Aliases of @option{-minterlink-compressed} and
17127 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17128 and are retained for backwards compatibility.
17130 @item -mabi=32
17131 @itemx -mabi=o64
17132 @itemx -mabi=n32
17133 @itemx -mabi=64
17134 @itemx -mabi=eabi
17135 @opindex mabi=32
17136 @opindex mabi=o64
17137 @opindex mabi=n32
17138 @opindex mabi=64
17139 @opindex mabi=eabi
17140 Generate code for the given ABI@.
17142 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17143 generates 64-bit code when you select a 64-bit architecture, but you
17144 can use @option{-mgp32} to get 32-bit code instead.
17146 For information about the O64 ABI, see
17147 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17149 GCC supports a variant of the o32 ABI in which floating-point registers
17150 are 64 rather than 32 bits wide.  You can select this combination with
17151 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17152 and @code{mfhc1} instructions and is therefore only supported for
17153 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17155 The register assignments for arguments and return values remain the
17156 same, but each scalar value is passed in a single 64-bit register
17157 rather than a pair of 32-bit registers.  For example, scalar
17158 floating-point values are returned in @samp{$f0} only, not a
17159 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17160 remains the same in that the even-numbered double-precision registers
17161 are saved.
17163 Two additional variants of the o32 ABI are supported to enable
17164 a transition from 32-bit to 64-bit registers.  These are FPXX
17165 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17166 The FPXX extension mandates that all code must execute correctly
17167 when run using 32-bit or 64-bit registers.  The code can be interlinked
17168 with either FP32 or FP64, but not both.
17169 The FP64A extension is similar to the FP64 extension but forbids the
17170 use of odd-numbered single-precision registers.  This can be used
17171 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17172 processors and allows both FP32 and FP64A code to interlink and
17173 run in the same process without changing FPU modes.
17175 @item -mabicalls
17176 @itemx -mno-abicalls
17177 @opindex mabicalls
17178 @opindex mno-abicalls
17179 Generate (do not generate) code that is suitable for SVR4-style
17180 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17181 systems.
17183 @item -mshared
17184 @itemx -mno-shared
17185 Generate (do not generate) code that is fully position-independent,
17186 and that can therefore be linked into shared libraries.  This option
17187 only affects @option{-mabicalls}.
17189 All @option{-mabicalls} code has traditionally been position-independent,
17190 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17191 as an extension, the GNU toolchain allows executables to use absolute
17192 accesses for locally-binding symbols.  It can also use shorter GP
17193 initialization sequences and generate direct calls to locally-defined
17194 functions.  This mode is selected by @option{-mno-shared}.
17196 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17197 objects that can only be linked by the GNU linker.  However, the option
17198 does not affect the ABI of the final executable; it only affects the ABI
17199 of relocatable objects.  Using @option{-mno-shared} generally makes
17200 executables both smaller and quicker.
17202 @option{-mshared} is the default.
17204 @item -mplt
17205 @itemx -mno-plt
17206 @opindex mplt
17207 @opindex mno-plt
17208 Assume (do not assume) that the static and dynamic linkers
17209 support PLTs and copy relocations.  This option only affects
17210 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17211 has no effect without @option{-msym32}.
17213 You can make @option{-mplt} the default by configuring
17214 GCC with @option{--with-mips-plt}.  The default is
17215 @option{-mno-plt} otherwise.
17217 @item -mxgot
17218 @itemx -mno-xgot
17219 @opindex mxgot
17220 @opindex mno-xgot
17221 Lift (do not lift) the usual restrictions on the size of the global
17222 offset table.
17224 GCC normally uses a single instruction to load values from the GOT@.
17225 While this is relatively efficient, it only works if the GOT
17226 is smaller than about 64k.  Anything larger causes the linker
17227 to report an error such as:
17229 @cindex relocation truncated to fit (MIPS)
17230 @smallexample
17231 relocation truncated to fit: R_MIPS_GOT16 foobar
17232 @end smallexample
17234 If this happens, you should recompile your code with @option{-mxgot}.
17235 This works with very large GOTs, although the code is also
17236 less efficient, since it takes three instructions to fetch the
17237 value of a global symbol.
17239 Note that some linkers can create multiple GOTs.  If you have such a
17240 linker, you should only need to use @option{-mxgot} when a single object
17241 file accesses more than 64k's worth of GOT entries.  Very few do.
17243 These options have no effect unless GCC is generating position
17244 independent code.
17246 @item -mgp32
17247 @opindex mgp32
17248 Assume that general-purpose registers are 32 bits wide.
17250 @item -mgp64
17251 @opindex mgp64
17252 Assume that general-purpose registers are 64 bits wide.
17254 @item -mfp32
17255 @opindex mfp32
17256 Assume that floating-point registers are 32 bits wide.
17258 @item -mfp64
17259 @opindex mfp64
17260 Assume that floating-point registers are 64 bits wide.
17262 @item -mfpxx
17263 @opindex mfpxx
17264 Do not assume the width of floating-point registers.
17266 @item -mhard-float
17267 @opindex mhard-float
17268 Use floating-point coprocessor instructions.
17270 @item -msoft-float
17271 @opindex msoft-float
17272 Do not use floating-point coprocessor instructions.  Implement
17273 floating-point calculations using library calls instead.
17275 @item -mno-float
17276 @opindex mno-float
17277 Equivalent to @option{-msoft-float}, but additionally asserts that the
17278 program being compiled does not perform any floating-point operations.
17279 This option is presently supported only by some bare-metal MIPS
17280 configurations, where it may select a special set of libraries
17281 that lack all floating-point support (including, for example, the
17282 floating-point @code{printf} formats).  
17283 If code compiled with @option{-mno-float} accidentally contains
17284 floating-point operations, it is likely to suffer a link-time
17285 or run-time failure.
17287 @item -msingle-float
17288 @opindex msingle-float
17289 Assume that the floating-point coprocessor only supports single-precision
17290 operations.
17292 @item -mdouble-float
17293 @opindex mdouble-float
17294 Assume that the floating-point coprocessor supports double-precision
17295 operations.  This is the default.
17297 @item -modd-spreg
17298 @itemx -mno-odd-spreg
17299 @opindex modd-spreg
17300 @opindex mno-odd-spreg
17301 Enable the use of odd-numbered single-precision floating-point registers
17302 for the o32 ABI.  This is the default for processors that are known to
17303 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
17304 is set by default.
17306 @item -mabs=2008
17307 @itemx -mabs=legacy
17308 @opindex mabs=2008
17309 @opindex mabs=legacy
17310 These options control the treatment of the special not-a-number (NaN)
17311 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17312 @code{neg.@i{fmt}} machine instructions.
17314 By default or when @option{-mabs=legacy} is used the legacy
17315 treatment is selected.  In this case these instructions are considered
17316 arithmetic and avoided where correct operation is required and the
17317 input operand might be a NaN.  A longer sequence of instructions that
17318 manipulate the sign bit of floating-point datum manually is used
17319 instead unless the @option{-ffinite-math-only} option has also been
17320 specified.
17322 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17323 this case these instructions are considered non-arithmetic and therefore
17324 operating correctly in all cases, including in particular where the
17325 input operand is a NaN.  These instructions are therefore always used
17326 for the respective operations.
17328 @item -mnan=2008
17329 @itemx -mnan=legacy
17330 @opindex mnan=2008
17331 @opindex mnan=legacy
17332 These options control the encoding of the special not-a-number (NaN)
17333 IEEE 754 floating-point data.
17335 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17336 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17337 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17338 by the first bit of their trailing significand field being 1.
17340 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17341 this case qNaNs are denoted by the first bit of their trailing
17342 significand field being 1, whereas sNaNs are denoted by the first bit of
17343 their trailing significand field being 0.
17345 The default is @option{-mnan=legacy} unless GCC has been configured with
17346 @option{--with-nan=2008}.
17348 @item -mllsc
17349 @itemx -mno-llsc
17350 @opindex mllsc
17351 @opindex mno-llsc
17352 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17353 implement atomic memory built-in functions.  When neither option is
17354 specified, GCC uses the instructions if the target architecture
17355 supports them.
17357 @option{-mllsc} is useful if the runtime environment can emulate the
17358 instructions and @option{-mno-llsc} can be useful when compiling for
17359 nonstandard ISAs.  You can make either option the default by
17360 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17361 respectively.  @option{--with-llsc} is the default for some
17362 configurations; see the installation documentation for details.
17364 @item -mdsp
17365 @itemx -mno-dsp
17366 @opindex mdsp
17367 @opindex mno-dsp
17368 Use (do not use) revision 1 of the MIPS DSP ASE@.
17369 @xref{MIPS DSP Built-in Functions}.  This option defines the
17370 preprocessor macro @code{__mips_dsp}.  It also defines
17371 @code{__mips_dsp_rev} to 1.
17373 @item -mdspr2
17374 @itemx -mno-dspr2
17375 @opindex mdspr2
17376 @opindex mno-dspr2
17377 Use (do not use) revision 2 of the MIPS DSP ASE@.
17378 @xref{MIPS DSP Built-in Functions}.  This option defines the
17379 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
17380 It also defines @code{__mips_dsp_rev} to 2.
17382 @item -msmartmips
17383 @itemx -mno-smartmips
17384 @opindex msmartmips
17385 @opindex mno-smartmips
17386 Use (do not use) the MIPS SmartMIPS ASE.
17388 @item -mpaired-single
17389 @itemx -mno-paired-single
17390 @opindex mpaired-single
17391 @opindex mno-paired-single
17392 Use (do not use) paired-single floating-point instructions.
17393 @xref{MIPS Paired-Single Support}.  This option requires
17394 hardware floating-point support to be enabled.
17396 @item -mdmx
17397 @itemx -mno-mdmx
17398 @opindex mdmx
17399 @opindex mno-mdmx
17400 Use (do not use) MIPS Digital Media Extension instructions.
17401 This option can only be used when generating 64-bit code and requires
17402 hardware floating-point support to be enabled.
17404 @item -mips3d
17405 @itemx -mno-mips3d
17406 @opindex mips3d
17407 @opindex mno-mips3d
17408 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17409 The option @option{-mips3d} implies @option{-mpaired-single}.
17411 @item -mmicromips
17412 @itemx -mno-micromips
17413 @opindex mmicromips
17414 @opindex mno-mmicromips
17415 Generate (do not generate) microMIPS code.
17417 MicroMIPS code generation can also be controlled on a per-function basis
17418 by means of @code{micromips} and @code{nomicromips} attributes.
17419 @xref{Function Attributes}, for more information.
17421 @item -mmt
17422 @itemx -mno-mt
17423 @opindex mmt
17424 @opindex mno-mt
17425 Use (do not use) MT Multithreading instructions.
17427 @item -mmcu
17428 @itemx -mno-mcu
17429 @opindex mmcu
17430 @opindex mno-mcu
17431 Use (do not use) the MIPS MCU ASE instructions.
17433 @item -meva
17434 @itemx -mno-eva
17435 @opindex meva
17436 @opindex mno-eva
17437 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17439 @item -mvirt
17440 @itemx -mno-virt
17441 @opindex mvirt
17442 @opindex mno-virt
17443 Use (do not use) the MIPS Virtualization Application Specific instructions.
17445 @item -mxpa
17446 @itemx -mno-xpa
17447 @opindex mxpa
17448 @opindex mno-xpa
17449 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17451 @item -mlong64
17452 @opindex mlong64
17453 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17454 an explanation of the default and the way that the pointer size is
17455 determined.
17457 @item -mlong32
17458 @opindex mlong32
17459 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17461 The default size of @code{int}s, @code{long}s and pointers depends on
17462 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17463 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17464 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17465 or the same size as integer registers, whichever is smaller.
17467 @item -msym32
17468 @itemx -mno-sym32
17469 @opindex msym32
17470 @opindex mno-sym32
17471 Assume (do not assume) that all symbols have 32-bit values, regardless
17472 of the selected ABI@.  This option is useful in combination with
17473 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17474 to generate shorter and faster references to symbolic addresses.
17476 @item -G @var{num}
17477 @opindex G
17478 Put definitions of externally-visible data in a small data section
17479 if that data is no bigger than @var{num} bytes.  GCC can then generate
17480 more efficient accesses to the data; see @option{-mgpopt} for details.
17482 The default @option{-G} option depends on the configuration.
17484 @item -mlocal-sdata
17485 @itemx -mno-local-sdata
17486 @opindex mlocal-sdata
17487 @opindex mno-local-sdata
17488 Extend (do not extend) the @option{-G} behavior to local data too,
17489 such as to static variables in C@.  @option{-mlocal-sdata} is the
17490 default for all configurations.
17492 If the linker complains that an application is using too much small data,
17493 you might want to try rebuilding the less performance-critical parts with
17494 @option{-mno-local-sdata}.  You might also want to build large
17495 libraries with @option{-mno-local-sdata}, so that the libraries leave
17496 more room for the main program.
17498 @item -mextern-sdata
17499 @itemx -mno-extern-sdata
17500 @opindex mextern-sdata
17501 @opindex mno-extern-sdata
17502 Assume (do not assume) that externally-defined data is in
17503 a small data section if the size of that data is within the @option{-G} limit.
17504 @option{-mextern-sdata} is the default for all configurations.
17506 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17507 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17508 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17509 is placed in a small data section.  If @var{Var} is defined by another
17510 module, you must either compile that module with a high-enough
17511 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17512 definition.  If @var{Var} is common, you must link the application
17513 with a high-enough @option{-G} setting.
17515 The easiest way of satisfying these restrictions is to compile
17516 and link every module with the same @option{-G} option.  However,
17517 you may wish to build a library that supports several different
17518 small data limits.  You can do this by compiling the library with
17519 the highest supported @option{-G} setting and additionally using
17520 @option{-mno-extern-sdata} to stop the library from making assumptions
17521 about externally-defined data.
17523 @item -mgpopt
17524 @itemx -mno-gpopt
17525 @opindex mgpopt
17526 @opindex mno-gpopt
17527 Use (do not use) GP-relative accesses for symbols that are known to be
17528 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17529 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17530 configurations.
17532 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17533 might not hold the value of @code{_gp}.  For example, if the code is
17534 part of a library that might be used in a boot monitor, programs that
17535 call boot monitor routines pass an unknown value in @code{$gp}.
17536 (In such situations, the boot monitor itself is usually compiled
17537 with @option{-G0}.)
17539 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17540 @option{-mno-extern-sdata}.
17542 @item -membedded-data
17543 @itemx -mno-embedded-data
17544 @opindex membedded-data
17545 @opindex mno-embedded-data
17546 Allocate variables to the read-only data section first if possible, then
17547 next in the small data section if possible, otherwise in data.  This gives
17548 slightly slower code than the default, but reduces the amount of RAM required
17549 when executing, and thus may be preferred for some embedded systems.
17551 @item -muninit-const-in-rodata
17552 @itemx -mno-uninit-const-in-rodata
17553 @opindex muninit-const-in-rodata
17554 @opindex mno-uninit-const-in-rodata
17555 Put uninitialized @code{const} variables in the read-only data section.
17556 This option is only meaningful in conjunction with @option{-membedded-data}.
17558 @item -mcode-readable=@var{setting}
17559 @opindex mcode-readable
17560 Specify whether GCC may generate code that reads from executable sections.
17561 There are three possible settings:
17563 @table @gcctabopt
17564 @item -mcode-readable=yes
17565 Instructions may freely access executable sections.  This is the
17566 default setting.
17568 @item -mcode-readable=pcrel
17569 MIPS16 PC-relative load instructions can access executable sections,
17570 but other instructions must not do so.  This option is useful on 4KSc
17571 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17572 It is also useful on processors that can be configured to have a dual
17573 instruction/data SRAM interface and that, like the M4K, automatically
17574 redirect PC-relative loads to the instruction RAM.
17576 @item -mcode-readable=no
17577 Instructions must not access executable sections.  This option can be
17578 useful on targets that are configured to have a dual instruction/data
17579 SRAM interface but that (unlike the M4K) do not automatically redirect
17580 PC-relative loads to the instruction RAM.
17581 @end table
17583 @item -msplit-addresses
17584 @itemx -mno-split-addresses
17585 @opindex msplit-addresses
17586 @opindex mno-split-addresses
17587 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17588 relocation operators.  This option has been superseded by
17589 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17591 @item -mexplicit-relocs
17592 @itemx -mno-explicit-relocs
17593 @opindex mexplicit-relocs
17594 @opindex mno-explicit-relocs
17595 Use (do not use) assembler relocation operators when dealing with symbolic
17596 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17597 is to use assembler macros instead.
17599 @option{-mexplicit-relocs} is the default if GCC was configured
17600 to use an assembler that supports relocation operators.
17602 @item -mcheck-zero-division
17603 @itemx -mno-check-zero-division
17604 @opindex mcheck-zero-division
17605 @opindex mno-check-zero-division
17606 Trap (do not trap) on integer division by zero.
17608 The default is @option{-mcheck-zero-division}.
17610 @item -mdivide-traps
17611 @itemx -mdivide-breaks
17612 @opindex mdivide-traps
17613 @opindex mdivide-breaks
17614 MIPS systems check for division by zero by generating either a
17615 conditional trap or a break instruction.  Using traps results in
17616 smaller code, but is only supported on MIPS II and later.  Also, some
17617 versions of the Linux kernel have a bug that prevents trap from
17618 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17619 allow conditional traps on architectures that support them and
17620 @option{-mdivide-breaks} to force the use of breaks.
17622 The default is usually @option{-mdivide-traps}, but this can be
17623 overridden at configure time using @option{--with-divide=breaks}.
17624 Divide-by-zero checks can be completely disabled using
17625 @option{-mno-check-zero-division}.
17627 @item -mmemcpy
17628 @itemx -mno-memcpy
17629 @opindex mmemcpy
17630 @opindex mno-memcpy
17631 Force (do not force) the use of @code{memcpy} for non-trivial block
17632 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17633 most constant-sized copies.
17635 @item -mlong-calls
17636 @itemx -mno-long-calls
17637 @opindex mlong-calls
17638 @opindex mno-long-calls
17639 Disable (do not disable) use of the @code{jal} instruction.  Calling
17640 functions using @code{jal} is more efficient but requires the caller
17641 and callee to be in the same 256 megabyte segment.
17643 This option has no effect on abicalls code.  The default is
17644 @option{-mno-long-calls}.
17646 @item -mmad
17647 @itemx -mno-mad
17648 @opindex mmad
17649 @opindex mno-mad
17650 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17651 instructions, as provided by the R4650 ISA@.
17653 @item -mimadd
17654 @itemx -mno-imadd
17655 @opindex mimadd
17656 @opindex mno-imadd
17657 Enable (disable) use of the @code{madd} and @code{msub} integer
17658 instructions.  The default is @option{-mimadd} on architectures
17659 that support @code{madd} and @code{msub} except for the 74k 
17660 architecture where it was found to generate slower code.
17662 @item -mfused-madd
17663 @itemx -mno-fused-madd
17664 @opindex mfused-madd
17665 @opindex mno-fused-madd
17666 Enable (disable) use of the floating-point multiply-accumulate
17667 instructions, when they are available.  The default is
17668 @option{-mfused-madd}.
17670 On the R8000 CPU when multiply-accumulate instructions are used,
17671 the intermediate product is calculated to infinite precision
17672 and is not subject to the FCSR Flush to Zero bit.  This may be
17673 undesirable in some circumstances.  On other processors the result
17674 is numerically identical to the equivalent computation using
17675 separate multiply, add, subtract and negate instructions.
17677 @item -nocpp
17678 @opindex nocpp
17679 Tell the MIPS assembler to not run its preprocessor over user
17680 assembler files (with a @samp{.s} suffix) when assembling them.
17682 @item -mfix-24k
17683 @item -mno-fix-24k
17684 @opindex mfix-24k
17685 @opindex mno-fix-24k
17686 Work around the 24K E48 (lost data on stores during refill) errata.
17687 The workarounds are implemented by the assembler rather than by GCC@.
17689 @item -mfix-r4000
17690 @itemx -mno-fix-r4000
17691 @opindex mfix-r4000
17692 @opindex mno-fix-r4000
17693 Work around certain R4000 CPU errata:
17694 @itemize @minus
17695 @item
17696 A double-word or a variable shift may give an incorrect result if executed
17697 immediately after starting an integer division.
17698 @item
17699 A double-word or a variable shift may give an incorrect result if executed
17700 while an integer multiplication is in progress.
17701 @item
17702 An integer division may give an incorrect result if started in a delay slot
17703 of a taken branch or a jump.
17704 @end itemize
17706 @item -mfix-r4400
17707 @itemx -mno-fix-r4400
17708 @opindex mfix-r4400
17709 @opindex mno-fix-r4400
17710 Work around certain R4400 CPU errata:
17711 @itemize @minus
17712 @item
17713 A double-word or a variable shift may give an incorrect result if executed
17714 immediately after starting an integer division.
17715 @end itemize
17717 @item -mfix-r10000
17718 @itemx -mno-fix-r10000
17719 @opindex mfix-r10000
17720 @opindex mno-fix-r10000
17721 Work around certain R10000 errata:
17722 @itemize @minus
17723 @item
17724 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17725 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17726 @end itemize
17728 This option can only be used if the target architecture supports
17729 branch-likely instructions.  @option{-mfix-r10000} is the default when
17730 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17731 otherwise.
17733 @item -mfix-rm7000
17734 @itemx -mno-fix-rm7000
17735 @opindex mfix-rm7000
17736 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17737 workarounds are implemented by the assembler rather than by GCC@.
17739 @item -mfix-vr4120
17740 @itemx -mno-fix-vr4120
17741 @opindex mfix-vr4120
17742 Work around certain VR4120 errata:
17743 @itemize @minus
17744 @item
17745 @code{dmultu} does not always produce the correct result.
17746 @item
17747 @code{div} and @code{ddiv} do not always produce the correct result if one
17748 of the operands is negative.
17749 @end itemize
17750 The workarounds for the division errata rely on special functions in
17751 @file{libgcc.a}.  At present, these functions are only provided by
17752 the @code{mips64vr*-elf} configurations.
17754 Other VR4120 errata require a NOP to be inserted between certain pairs of
17755 instructions.  These errata are handled by the assembler, not by GCC itself.
17757 @item -mfix-vr4130
17758 @opindex mfix-vr4130
17759 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17760 workarounds are implemented by the assembler rather than by GCC,
17761 although GCC avoids using @code{mflo} and @code{mfhi} if the
17762 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17763 instructions are available instead.
17765 @item -mfix-sb1
17766 @itemx -mno-fix-sb1
17767 @opindex mfix-sb1
17768 Work around certain SB-1 CPU core errata.
17769 (This flag currently works around the SB-1 revision 2
17770 ``F1'' and ``F2'' floating-point errata.)
17772 @item -mr10k-cache-barrier=@var{setting}
17773 @opindex mr10k-cache-barrier
17774 Specify whether GCC should insert cache barriers to avoid the
17775 side-effects of speculation on R10K processors.
17777 In common with many processors, the R10K tries to predict the outcome
17778 of a conditional branch and speculatively executes instructions from
17779 the ``taken'' branch.  It later aborts these instructions if the
17780 predicted outcome is wrong.  However, on the R10K, even aborted
17781 instructions can have side effects.
17783 This problem only affects kernel stores and, depending on the system,
17784 kernel loads.  As an example, a speculatively-executed store may load
17785 the target memory into cache and mark the cache line as dirty, even if
17786 the store itself is later aborted.  If a DMA operation writes to the
17787 same area of memory before the ``dirty'' line is flushed, the cached
17788 data overwrites the DMA-ed data.  See the R10K processor manual
17789 for a full description, including other potential problems.
17791 One workaround is to insert cache barrier instructions before every memory
17792 access that might be speculatively executed and that might have side
17793 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17794 controls GCC's implementation of this workaround.  It assumes that
17795 aborted accesses to any byte in the following regions does not have
17796 side effects:
17798 @enumerate
17799 @item
17800 the memory occupied by the current function's stack frame;
17802 @item
17803 the memory occupied by an incoming stack argument;
17805 @item
17806 the memory occupied by an object with a link-time-constant address.
17807 @end enumerate
17809 It is the kernel's responsibility to ensure that speculative
17810 accesses to these regions are indeed safe.
17812 If the input program contains a function declaration such as:
17814 @smallexample
17815 void foo (void);
17816 @end smallexample
17818 then the implementation of @code{foo} must allow @code{j foo} and
17819 @code{jal foo} to be executed speculatively.  GCC honors this
17820 restriction for functions it compiles itself.  It expects non-GCC
17821 functions (such as hand-written assembly code) to do the same.
17823 The option has three forms:
17825 @table @gcctabopt
17826 @item -mr10k-cache-barrier=load-store
17827 Insert a cache barrier before a load or store that might be
17828 speculatively executed and that might have side effects even
17829 if aborted.
17831 @item -mr10k-cache-barrier=store
17832 Insert a cache barrier before a store that might be speculatively
17833 executed and that might have side effects even if aborted.
17835 @item -mr10k-cache-barrier=none
17836 Disable the insertion of cache barriers.  This is the default setting.
17837 @end table
17839 @item -mflush-func=@var{func}
17840 @itemx -mno-flush-func
17841 @opindex mflush-func
17842 Specifies the function to call to flush the I and D caches, or to not
17843 call any such function.  If called, the function must take the same
17844 arguments as the common @code{_flush_func}, that is, the address of the
17845 memory range for which the cache is being flushed, the size of the
17846 memory range, and the number 3 (to flush both caches).  The default
17847 depends on the target GCC was configured for, but commonly is either
17848 @code{_flush_func} or @code{__cpu_flush}.
17850 @item mbranch-cost=@var{num}
17851 @opindex mbranch-cost
17852 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17853 This cost is only a heuristic and is not guaranteed to produce
17854 consistent results across releases.  A zero cost redundantly selects
17855 the default, which is based on the @option{-mtune} setting.
17857 @item -mbranch-likely
17858 @itemx -mno-branch-likely
17859 @opindex mbranch-likely
17860 @opindex mno-branch-likely
17861 Enable or disable use of Branch Likely instructions, regardless of the
17862 default for the selected architecture.  By default, Branch Likely
17863 instructions may be generated if they are supported by the selected
17864 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17865 and processors that implement those architectures; for those, Branch
17866 Likely instructions are not be generated by default because the MIPS32
17867 and MIPS64 architectures specifically deprecate their use.
17869 @item -mfp-exceptions
17870 @itemx -mno-fp-exceptions
17871 @opindex mfp-exceptions
17872 Specifies whether FP exceptions are enabled.  This affects how
17873 FP instructions are scheduled for some processors.
17874 The default is that FP exceptions are
17875 enabled.
17877 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17878 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17879 FP pipe.
17881 @item -mvr4130-align
17882 @itemx -mno-vr4130-align
17883 @opindex mvr4130-align
17884 The VR4130 pipeline is two-way superscalar, but can only issue two
17885 instructions together if the first one is 8-byte aligned.  When this
17886 option is enabled, GCC aligns pairs of instructions that it
17887 thinks should execute in parallel.
17889 This option only has an effect when optimizing for the VR4130.
17890 It normally makes code faster, but at the expense of making it bigger.
17891 It is enabled by default at optimization level @option{-O3}.
17893 @item -msynci
17894 @itemx -mno-synci
17895 @opindex msynci
17896 Enable (disable) generation of @code{synci} instructions on
17897 architectures that support it.  The @code{synci} instructions (if
17898 enabled) are generated when @code{__builtin___clear_cache} is
17899 compiled.
17901 This option defaults to @option{-mno-synci}, but the default can be
17902 overridden by configuring GCC with @option{--with-synci}.
17904 When compiling code for single processor systems, it is generally safe
17905 to use @code{synci}.  However, on many multi-core (SMP) systems, it
17906 does not invalidate the instruction caches on all cores and may lead
17907 to undefined behavior.
17909 @item -mrelax-pic-calls
17910 @itemx -mno-relax-pic-calls
17911 @opindex mrelax-pic-calls
17912 Try to turn PIC calls that are normally dispatched via register
17913 @code{$25} into direct calls.  This is only possible if the linker can
17914 resolve the destination at link-time and if the destination is within
17915 range for a direct call.
17917 @option{-mrelax-pic-calls} is the default if GCC was configured to use
17918 an assembler and a linker that support the @code{.reloc} assembly
17919 directive and @option{-mexplicit-relocs} is in effect.  With
17920 @option{-mno-explicit-relocs}, this optimization can be performed by the
17921 assembler and the linker alone without help from the compiler.
17923 @item -mmcount-ra-address
17924 @itemx -mno-mcount-ra-address
17925 @opindex mmcount-ra-address
17926 @opindex mno-mcount-ra-address
17927 Emit (do not emit) code that allows @code{_mcount} to modify the
17928 calling function's return address.  When enabled, this option extends
17929 the usual @code{_mcount} interface with a new @var{ra-address}
17930 parameter, which has type @code{intptr_t *} and is passed in register
17931 @code{$12}.  @code{_mcount} can then modify the return address by
17932 doing both of the following:
17933 @itemize
17934 @item
17935 Returning the new address in register @code{$31}.
17936 @item
17937 Storing the new address in @code{*@var{ra-address}},
17938 if @var{ra-address} is nonnull.
17939 @end itemize
17941 The default is @option{-mno-mcount-ra-address}.
17943 @end table
17945 @node MMIX Options
17946 @subsection MMIX Options
17947 @cindex MMIX Options
17949 These options are defined for the MMIX:
17951 @table @gcctabopt
17952 @item -mlibfuncs
17953 @itemx -mno-libfuncs
17954 @opindex mlibfuncs
17955 @opindex mno-libfuncs
17956 Specify that intrinsic library functions are being compiled, passing all
17957 values in registers, no matter the size.
17959 @item -mepsilon
17960 @itemx -mno-epsilon
17961 @opindex mepsilon
17962 @opindex mno-epsilon
17963 Generate floating-point comparison instructions that compare with respect
17964 to the @code{rE} epsilon register.
17966 @item -mabi=mmixware
17967 @itemx -mabi=gnu
17968 @opindex mabi=mmixware
17969 @opindex mabi=gnu
17970 Generate code that passes function parameters and return values that (in
17971 the called function) are seen as registers @code{$0} and up, as opposed to
17972 the GNU ABI which uses global registers @code{$231} and up.
17974 @item -mzero-extend
17975 @itemx -mno-zero-extend
17976 @opindex mzero-extend
17977 @opindex mno-zero-extend
17978 When reading data from memory in sizes shorter than 64 bits, use (do not
17979 use) zero-extending load instructions by default, rather than
17980 sign-extending ones.
17982 @item -mknuthdiv
17983 @itemx -mno-knuthdiv
17984 @opindex mknuthdiv
17985 @opindex mno-knuthdiv
17986 Make the result of a division yielding a remainder have the same sign as
17987 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
17988 remainder follows the sign of the dividend.  Both methods are
17989 arithmetically valid, the latter being almost exclusively used.
17991 @item -mtoplevel-symbols
17992 @itemx -mno-toplevel-symbols
17993 @opindex mtoplevel-symbols
17994 @opindex mno-toplevel-symbols
17995 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
17996 code can be used with the @code{PREFIX} assembly directive.
17998 @item -melf
17999 @opindex melf
18000 Generate an executable in the ELF format, rather than the default
18001 @samp{mmo} format used by the @command{mmix} simulator.
18003 @item -mbranch-predict
18004 @itemx -mno-branch-predict
18005 @opindex mbranch-predict
18006 @opindex mno-branch-predict
18007 Use (do not use) the probable-branch instructions, when static branch
18008 prediction indicates a probable branch.
18010 @item -mbase-addresses
18011 @itemx -mno-base-addresses
18012 @opindex mbase-addresses
18013 @opindex mno-base-addresses
18014 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18015 base address automatically generates a request (handled by the assembler
18016 and the linker) for a constant to be set up in a global register.  The
18017 register is used for one or more base address requests within the range 0
18018 to 255 from the value held in the register.  The generally leads to short
18019 and fast code, but the number of different data items that can be
18020 addressed is limited.  This means that a program that uses lots of static
18021 data may require @option{-mno-base-addresses}.
18023 @item -msingle-exit
18024 @itemx -mno-single-exit
18025 @opindex msingle-exit
18026 @opindex mno-single-exit
18027 Force (do not force) generated code to have a single exit point in each
18028 function.
18029 @end table
18031 @node MN10300 Options
18032 @subsection MN10300 Options
18033 @cindex MN10300 options
18035 These @option{-m} options are defined for Matsushita MN10300 architectures:
18037 @table @gcctabopt
18038 @item -mmult-bug
18039 @opindex mmult-bug
18040 Generate code to avoid bugs in the multiply instructions for the MN10300
18041 processors.  This is the default.
18043 @item -mno-mult-bug
18044 @opindex mno-mult-bug
18045 Do not generate code to avoid bugs in the multiply instructions for the
18046 MN10300 processors.
18048 @item -mam33
18049 @opindex mam33
18050 Generate code using features specific to the AM33 processor.
18052 @item -mno-am33
18053 @opindex mno-am33
18054 Do not generate code using features specific to the AM33 processor.  This
18055 is the default.
18057 @item -mam33-2
18058 @opindex mam33-2
18059 Generate code using features specific to the AM33/2.0 processor.
18061 @item -mam34
18062 @opindex mam34
18063 Generate code using features specific to the AM34 processor.
18065 @item -mtune=@var{cpu-type}
18066 @opindex mtune
18067 Use the timing characteristics of the indicated CPU type when
18068 scheduling instructions.  This does not change the targeted processor
18069 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18070 @samp{am33-2} or @samp{am34}.
18072 @item -mreturn-pointer-on-d0
18073 @opindex mreturn-pointer-on-d0
18074 When generating a function that returns a pointer, return the pointer
18075 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18076 only in @code{a0}, and attempts to call such functions without a prototype
18077 result in errors.  Note that this option is on by default; use
18078 @option{-mno-return-pointer-on-d0} to disable it.
18080 @item -mno-crt0
18081 @opindex mno-crt0
18082 Do not link in the C run-time initialization object file.
18084 @item -mrelax
18085 @opindex mrelax
18086 Indicate to the linker that it should perform a relaxation optimization pass
18087 to shorten branches, calls and absolute memory addresses.  This option only
18088 has an effect when used on the command line for the final link step.
18090 This option makes symbolic debugging impossible.
18092 @item -mliw
18093 @opindex mliw
18094 Allow the compiler to generate @emph{Long Instruction Word}
18095 instructions if the target is the @samp{AM33} or later.  This is the
18096 default.  This option defines the preprocessor macro @code{__LIW__}.
18098 @item -mnoliw
18099 @opindex mnoliw
18100 Do not allow the compiler to generate @emph{Long Instruction Word}
18101 instructions.  This option defines the preprocessor macro
18102 @code{__NO_LIW__}.
18104 @item -msetlb
18105 @opindex msetlb
18106 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18107 instructions if the target is the @samp{AM33} or later.  This is the
18108 default.  This option defines the preprocessor macro @code{__SETLB__}.
18110 @item -mnosetlb
18111 @opindex mnosetlb
18112 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18113 instructions.  This option defines the preprocessor macro
18114 @code{__NO_SETLB__}.
18116 @end table
18118 @node Moxie Options
18119 @subsection Moxie Options
18120 @cindex Moxie Options
18122 @table @gcctabopt
18124 @item -meb
18125 @opindex meb
18126 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18127 configurations.
18129 @item -mel
18130 @opindex mel
18131 Generate little-endian code.
18133 @item -mmul.x
18134 @opindex mmul.x
18135 Generate mul.x and umul.x instructions.  This is the default for
18136 @samp{moxiebox-*-*} configurations.
18138 @item -mno-crt0
18139 @opindex mno-crt0
18140 Do not link in the C run-time initialization object file.
18142 @end table
18144 @node MSP430 Options
18145 @subsection MSP430 Options
18146 @cindex MSP430 Options
18148 These options are defined for the MSP430:
18150 @table @gcctabopt
18152 @item -masm-hex
18153 @opindex masm-hex
18154 Force assembly output to always use hex constants.  Normally such
18155 constants are signed decimals, but this option is available for
18156 testsuite and/or aesthetic purposes.
18158 @item -mmcu=
18159 @opindex mmcu=
18160 Select the MCU to target.  This is used to create a C preprocessor
18161 symbol based upon the MCU name, converted to upper case and pre- and
18162 post-fixed with @samp{__}.  This in turn is used by the
18163 @file{msp430.h} header file to select an MCU-specific supplementary
18164 header file.
18166 The option also sets the ISA to use.  If the MCU name is one that is
18167 known to only support the 430 ISA then that is selected, otherwise the
18168 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
18169 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
18170 name selects the 430X ISA.
18172 In addition an MCU-specific linker script is added to the linker
18173 command line.  The script's name is the name of the MCU with
18174 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
18175 command line defines the C preprocessor symbol @code{__XXX__} and
18176 cause the linker to search for a script called @file{xxx.ld}.
18178 This option is also passed on to the assembler.
18180 @item -mcpu=
18181 @opindex mcpu=
18182 Specifies the ISA to use.  Accepted values are @samp{msp430},
18183 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
18184 @option{-mmcu=} option should be used to select the ISA.
18186 @item -msim
18187 @opindex msim
18188 Link to the simulator runtime libraries and linker script.  Overrides
18189 any scripts that would be selected by the @option{-mmcu=} option.
18191 @item -mlarge
18192 @opindex mlarge
18193 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18195 @item -msmall
18196 @opindex msmall
18197 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18199 @item -mrelax
18200 @opindex mrelax
18201 This option is passed to the assembler and linker, and allows the
18202 linker to perform certain optimizations that cannot be done until
18203 the final link.
18205 @item mhwmult=
18206 @opindex mhwmult=
18207 Describes the type of hardware multiply supported by the target.
18208 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
18209 for the original 16-bit-only multiply supported by early MCUs.
18210 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
18211 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18212 A value of @samp{auto} can also be given.  This tells GCC to deduce
18213 the hardware multiply support based upon the MCU name provided by the
18214 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18215 @samp{32bit} hardware multiply support is assumed.  @samp{auto} is the
18216 default setting.
18218 Hardware multiplies are normally performed by calling a library
18219 routine.  This saves space in the generated code.  When compiling at
18220 @option{-O3} or higher however the hardware multiplier is invoked
18221 inline.  This makes for bigger, but faster code.
18223 The hardware multiply routines disable interrupts whilst running and
18224 restore the previous interrupt state when they finish.  This makes
18225 them safe to use inside interrupt handlers as well as in normal code.
18227 @item -minrt
18228 @opindex minrt
18229 Enable the use of a minimum runtime environment - no static
18230 initializers or constructors.  This is intended for memory-constrained
18231 devices.  The compiler includes special symbols in some objects
18232 that tell the linker and runtime which code fragments are required.
18234 @item -mcode-region=
18235 @itemx -mdata-region=
18236 @opindex mcode-region
18237 @opindex mdata-region
18238 These options tell the compiler where to place functions and data that
18239 do not have one of the @code{lower}, @code{upper}, @code{either} or
18240 @code{section} attributes.  Possible values are @code{lower},
18241 @code{upper}, @code{either} or @code{any}.  The first three behave
18242 like the corresponding attribute.  The fourth possible value -
18243 @code{any} - is the default.  It leaves placement entirely up to the
18244 linker script and how it assigns the standard sections (.text, .data
18245 etc) to the memory regions.
18247 @end table
18249 @node NDS32 Options
18250 @subsection NDS32 Options
18251 @cindex NDS32 Options
18253 These options are defined for NDS32 implementations:
18255 @table @gcctabopt
18257 @item -mbig-endian
18258 @opindex mbig-endian
18259 Generate code in big-endian mode.
18261 @item -mlittle-endian
18262 @opindex mlittle-endian
18263 Generate code in little-endian mode.
18265 @item -mreduced-regs
18266 @opindex mreduced-regs
18267 Use reduced-set registers for register allocation.
18269 @item -mfull-regs
18270 @opindex mfull-regs
18271 Use full-set registers for register allocation.
18273 @item -mcmov
18274 @opindex mcmov
18275 Generate conditional move instructions.
18277 @item -mno-cmov
18278 @opindex mno-cmov
18279 Do not generate conditional move instructions.
18281 @item -mperf-ext
18282 @opindex mperf-ext
18283 Generate performance extension instructions.
18285 @item -mno-perf-ext
18286 @opindex mno-perf-ext
18287 Do not generate performance extension instructions.
18289 @item -mv3push
18290 @opindex mv3push
18291 Generate v3 push25/pop25 instructions.
18293 @item -mno-v3push
18294 @opindex mno-v3push
18295 Do not generate v3 push25/pop25 instructions.
18297 @item -m16-bit
18298 @opindex m16-bit
18299 Generate 16-bit instructions.
18301 @item -mno-16-bit
18302 @opindex mno-16-bit
18303 Do not generate 16-bit instructions.
18305 @item -misr-vector-size=@var{num}
18306 @opindex misr-vector-size
18307 Specify the size of each interrupt vector, which must be 4 or 16.
18309 @item -mcache-block-size=@var{num}
18310 @opindex mcache-block-size
18311 Specify the size of each cache block,
18312 which must be a power of 2 between 4 and 512.
18314 @item -march=@var{arch}
18315 @opindex march
18316 Specify the name of the target architecture.
18318 @item -mcmodel=@var{code-model}
18319 @opindex mcmodel
18320 Set the code model to one of
18321 @table @asis
18322 @item @samp{small}
18323 All the data and read-only data segments must be within 512KB addressing space.
18324 The text segment must be within 16MB addressing space.
18325 @item @samp{medium}
18326 The data segment must be within 512KB while the read-only data segment can be
18327 within 4GB addressing space.  The text segment should be still within 16MB
18328 addressing space.
18329 @item @samp{large}
18330 All the text and data segments can be within 4GB addressing space.
18331 @end table
18333 @item -mctor-dtor
18334 @opindex mctor-dtor
18335 Enable constructor/destructor feature.
18337 @item -mrelax
18338 @opindex mrelax
18339 Guide linker to relax instructions.
18341 @end table
18343 @node Nios II Options
18344 @subsection Nios II Options
18345 @cindex Nios II options
18346 @cindex Altera Nios II options
18348 These are the options defined for the Altera Nios II processor.
18350 @table @gcctabopt
18352 @item -G @var{num}
18353 @opindex G
18354 @cindex smaller data references
18355 Put global and static objects less than or equal to @var{num} bytes
18356 into the small data or BSS sections instead of the normal data or BSS
18357 sections.  The default value of @var{num} is 8.
18359 @item -mgpopt=@var{option}
18360 @item -mgpopt
18361 @itemx -mno-gpopt
18362 @opindex mgpopt
18363 @opindex mno-gpopt
18364 Generate (do not generate) GP-relative accesses.  The following 
18365 @var{option} names are recognized:
18367 @table @samp
18369 @item none
18370 Do not generate GP-relative accesses.
18372 @item local
18373 Generate GP-relative accesses for small data objects that are not 
18374 external or weak.  Also use GP-relative addressing for objects that
18375 have been explicitly placed in a small data section via a @code{section}
18376 attribute.
18378 @item global
18379 As for @samp{local}, but also generate GP-relative accesses for
18380 small data objects that are external or weak.  If you use this option,
18381 you must ensure that all parts of your program (including libraries) are
18382 compiled with the same @option{-G} setting.
18384 @item data
18385 Generate GP-relative accesses for all data objects in the program.  If you
18386 use this option, the entire data and BSS segments
18387 of your program must fit in 64K of memory and you must use an appropriate
18388 linker script to allocate them within the addressible range of the
18389 global pointer.
18391 @item all
18392 Generate GP-relative addresses for function pointers as well as data
18393 pointers.  If you use this option, the entire text, data, and BSS segments
18394 of your program must fit in 64K of memory and you must use an appropriate
18395 linker script to allocate them within the addressible range of the
18396 global pointer.
18398 @end table
18400 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
18401 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
18403 The default is @option{-mgpopt} except when @option{-fpic} or
18404 @option{-fPIC} is specified to generate position-independent code.
18405 Note that the Nios II ABI does not permit GP-relative accesses from
18406 shared libraries.
18408 You may need to specify @option{-mno-gpopt} explicitly when building
18409 programs that include large amounts of small data, including large
18410 GOT data sections.  In this case, the 16-bit offset for GP-relative
18411 addressing may not be large enough to allow access to the entire 
18412 small data section.
18414 @item -mel
18415 @itemx -meb
18416 @opindex mel
18417 @opindex meb
18418 Generate little-endian (default) or big-endian (experimental) code,
18419 respectively.
18421 @item -march=@var{arch}
18422 @opindex march
18423 This specifies the name of the target Nios II architecture.  GCC uses this
18424 name to determine what kind of instructions it can emit when generating
18425 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
18427 The preprocessor macro @code{__nios2_arch__} is available to programs,
18428 with value 1 or 2, indicating the targeted ISA level.
18430 @item -mbypass-cache
18431 @itemx -mno-bypass-cache
18432 @opindex mno-bypass-cache
18433 @opindex mbypass-cache
18434 Force all load and store instructions to always bypass cache by 
18435 using I/O variants of the instructions. The default is not to
18436 bypass the cache.
18438 @item -mno-cache-volatile 
18439 @itemx -mcache-volatile       
18440 @opindex mcache-volatile 
18441 @opindex mno-cache-volatile
18442 Volatile memory access bypass the cache using the I/O variants of 
18443 the load and store instructions. The default is not to bypass the cache.
18445 @item -mno-fast-sw-div
18446 @itemx -mfast-sw-div
18447 @opindex mno-fast-sw-div
18448 @opindex mfast-sw-div
18449 Do not use table-based fast divide for small numbers. The default 
18450 is to use the fast divide at @option{-O3} and above.
18452 @item -mno-hw-mul
18453 @itemx -mhw-mul
18454 @itemx -mno-hw-mulx
18455 @itemx -mhw-mulx
18456 @itemx -mno-hw-div
18457 @itemx -mhw-div
18458 @opindex mno-hw-mul
18459 @opindex mhw-mul
18460 @opindex mno-hw-mulx
18461 @opindex mhw-mulx
18462 @opindex mno-hw-div
18463 @opindex mhw-div
18464 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18465 instructions by the compiler. The default is to emit @code{mul}
18466 and not emit @code{div} and @code{mulx}.
18468 @item -mbmx
18469 @itemx -mno-bmx
18470 @itemx -mcdx
18471 @itemx -mno-cdx
18472 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
18473 CDX (code density) instructions.  Enabling these instructions also
18474 requires @option{-march=r2}.  Since these instructions are optional
18475 extensions to the R2 architecture, the default is not to emit them.
18477 @item -mcustom-@var{insn}=@var{N}
18478 @itemx -mno-custom-@var{insn}
18479 @opindex mcustom-@var{insn}
18480 @opindex mno-custom-@var{insn}
18481 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18482 custom instruction with encoding @var{N} when generating code that uses 
18483 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
18484 instruction 253 for single-precision floating-point add operations instead
18485 of the default behavior of using a library call.
18487 The following values of @var{insn} are supported.  Except as otherwise
18488 noted, floating-point operations are expected to be implemented with
18489 normal IEEE 754 semantics and correspond directly to the C operators or the
18490 equivalent GCC built-in functions (@pxref{Other Builtins}).
18492 Single-precision floating point:
18493 @table @asis
18495 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18496 Binary arithmetic operations.
18498 @item @samp{fnegs}
18499 Unary negation.
18501 @item @samp{fabss}
18502 Unary absolute value.
18504 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18505 Comparison operations.
18507 @item @samp{fmins}, @samp{fmaxs}
18508 Floating-point minimum and maximum.  These instructions are only
18509 generated if @option{-ffinite-math-only} is specified.
18511 @item @samp{fsqrts}
18512 Unary square root operation.
18514 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18515 Floating-point trigonometric and exponential functions.  These instructions
18516 are only generated if @option{-funsafe-math-optimizations} is also specified.
18518 @end table
18520 Double-precision floating point:
18521 @table @asis
18523 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18524 Binary arithmetic operations.
18526 @item @samp{fnegd}
18527 Unary negation.
18529 @item @samp{fabsd}
18530 Unary absolute value.
18532 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18533 Comparison operations.
18535 @item @samp{fmind}, @samp{fmaxd}
18536 Double-precision minimum and maximum.  These instructions are only
18537 generated if @option{-ffinite-math-only} is specified.
18539 @item @samp{fsqrtd}
18540 Unary square root operation.
18542 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18543 Double-precision trigonometric and exponential functions.  These instructions
18544 are only generated if @option{-funsafe-math-optimizations} is also specified.
18546 @end table
18548 Conversions:
18549 @table @asis
18550 @item @samp{fextsd}
18551 Conversion from single precision to double precision.
18553 @item @samp{ftruncds}
18554 Conversion from double precision to single precision.
18556 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18557 Conversion from floating point to signed or unsigned integer types, with
18558 truncation towards zero.
18560 @item @samp{round}
18561 Conversion from single-precision floating point to signed integer,
18562 rounding to the nearest integer and ties away from zero.
18563 This corresponds to the @code{__builtin_lroundf} function when
18564 @option{-fno-math-errno} is used.
18566 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18567 Conversion from signed or unsigned integer types to floating-point types.
18569 @end table
18571 In addition, all of the following transfer instructions for internal
18572 registers X and Y must be provided to use any of the double-precision
18573 floating-point instructions.  Custom instructions taking two
18574 double-precision source operands expect the first operand in the
18575 64-bit register X.  The other operand (or only operand of a unary
18576 operation) is given to the custom arithmetic instruction with the
18577 least significant half in source register @var{src1} and the most
18578 significant half in @var{src2}.  A custom instruction that returns a
18579 double-precision result returns the most significant 32 bits in the
18580 destination register and the other half in 32-bit register Y.  
18581 GCC automatically generates the necessary code sequences to write
18582 register X and/or read register Y when double-precision floating-point
18583 instructions are used.
18585 @table @asis
18587 @item @samp{fwrx}
18588 Write @var{src1} into the least significant half of X and @var{src2} into
18589 the most significant half of X.
18591 @item @samp{fwry}
18592 Write @var{src1} into Y.
18594 @item @samp{frdxhi}, @samp{frdxlo}
18595 Read the most or least (respectively) significant half of X and store it in
18596 @var{dest}.
18598 @item @samp{frdy}
18599 Read the value of Y and store it into @var{dest}.
18600 @end table
18602 Note that you can gain more local control over generation of Nios II custom
18603 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18604 and @code{target("no-custom-@var{insn}")} function attributes
18605 (@pxref{Function Attributes})
18606 or pragmas (@pxref{Function Specific Option Pragmas}).
18608 @item -mcustom-fpu-cfg=@var{name}
18609 @opindex mcustom-fpu-cfg
18611 This option enables a predefined, named set of custom instruction encodings
18612 (see @option{-mcustom-@var{insn}} above).  
18613 Currently, the following sets are defined:
18615 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18616 @gccoptlist{-mcustom-fmuls=252 @gol
18617 -mcustom-fadds=253 @gol
18618 -mcustom-fsubs=254 @gol
18619 -fsingle-precision-constant}
18621 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18622 @gccoptlist{-mcustom-fmuls=252 @gol
18623 -mcustom-fadds=253 @gol
18624 -mcustom-fsubs=254 @gol
18625 -mcustom-fdivs=255 @gol
18626 -fsingle-precision-constant}
18628 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18629 @gccoptlist{-mcustom-floatus=243 @gol
18630 -mcustom-fixsi=244 @gol
18631 -mcustom-floatis=245 @gol
18632 -mcustom-fcmpgts=246 @gol
18633 -mcustom-fcmples=249 @gol
18634 -mcustom-fcmpeqs=250 @gol
18635 -mcustom-fcmpnes=251 @gol
18636 -mcustom-fmuls=252 @gol
18637 -mcustom-fadds=253 @gol
18638 -mcustom-fsubs=254 @gol
18639 -mcustom-fdivs=255 @gol
18640 -fsingle-precision-constant}
18642 Custom instruction assignments given by individual
18643 @option{-mcustom-@var{insn}=} options override those given by
18644 @option{-mcustom-fpu-cfg=}, regardless of the
18645 order of the options on the command line.
18647 Note that you can gain more local control over selection of a FPU
18648 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18649 function attribute (@pxref{Function Attributes})
18650 or pragma (@pxref{Function Specific Option Pragmas}).
18652 @end table
18654 These additional @samp{-m} options are available for the Altera Nios II
18655 ELF (bare-metal) target:
18657 @table @gcctabopt
18659 @item -mhal
18660 @opindex mhal
18661 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18662 startup and termination code, and is typically used in conjunction with
18663 @option{-msys-crt0=} to specify the location of the alternate startup code
18664 provided by the HAL BSP.
18666 @item -msmallc
18667 @opindex msmallc
18668 Link with a limited version of the C library, @option{-lsmallc}, rather than
18669 Newlib.
18671 @item -msys-crt0=@var{startfile}
18672 @opindex msys-crt0
18673 @var{startfile} is the file name of the startfile (crt0) to use 
18674 when linking.  This option is only useful in conjunction with @option{-mhal}.
18676 @item -msys-lib=@var{systemlib}
18677 @opindex msys-lib
18678 @var{systemlib} is the library name of the library that provides
18679 low-level system calls required by the C library,
18680 e.g. @code{read} and @code{write}.
18681 This option is typically used to link with a library provided by a HAL BSP.
18683 @end table
18685 @node Nvidia PTX Options
18686 @subsection Nvidia PTX Options
18687 @cindex Nvidia PTX options
18688 @cindex nvptx options
18690 These options are defined for Nvidia PTX:
18692 @table @gcctabopt
18694 @item -m32
18695 @itemx -m64
18696 @opindex m32
18697 @opindex m64
18698 Generate code for 32-bit or 64-bit ABI.
18700 @item -mmainkernel
18701 @opindex mmainkernel
18702 Link in code for a __main kernel.  This is for stand-alone instead of
18703 offloading execution.
18705 @end table
18707 @node PDP-11 Options
18708 @subsection PDP-11 Options
18709 @cindex PDP-11 Options
18711 These options are defined for the PDP-11:
18713 @table @gcctabopt
18714 @item -mfpu
18715 @opindex mfpu
18716 Use hardware FPP floating point.  This is the default.  (FIS floating
18717 point on the PDP-11/40 is not supported.)
18719 @item -msoft-float
18720 @opindex msoft-float
18721 Do not use hardware floating point.
18723 @item -mac0
18724 @opindex mac0
18725 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18727 @item -mno-ac0
18728 @opindex mno-ac0
18729 Return floating-point results in memory.  This is the default.
18731 @item -m40
18732 @opindex m40
18733 Generate code for a PDP-11/40.
18735 @item -m45
18736 @opindex m45
18737 Generate code for a PDP-11/45.  This is the default.
18739 @item -m10
18740 @opindex m10
18741 Generate code for a PDP-11/10.
18743 @item -mbcopy-builtin
18744 @opindex mbcopy-builtin
18745 Use inline @code{movmemhi} patterns for copying memory.  This is the
18746 default.
18748 @item -mbcopy
18749 @opindex mbcopy
18750 Do not use inline @code{movmemhi} patterns for copying memory.
18752 @item -mint16
18753 @itemx -mno-int32
18754 @opindex mint16
18755 @opindex mno-int32
18756 Use 16-bit @code{int}.  This is the default.
18758 @item -mint32
18759 @itemx -mno-int16
18760 @opindex mint32
18761 @opindex mno-int16
18762 Use 32-bit @code{int}.
18764 @item -mfloat64
18765 @itemx -mno-float32
18766 @opindex mfloat64
18767 @opindex mno-float32
18768 Use 64-bit @code{float}.  This is the default.
18770 @item -mfloat32
18771 @itemx -mno-float64
18772 @opindex mfloat32
18773 @opindex mno-float64
18774 Use 32-bit @code{float}.
18776 @item -mabshi
18777 @opindex mabshi
18778 Use @code{abshi2} pattern.  This is the default.
18780 @item -mno-abshi
18781 @opindex mno-abshi
18782 Do not use @code{abshi2} pattern.
18784 @item -mbranch-expensive
18785 @opindex mbranch-expensive
18786 Pretend that branches are expensive.  This is for experimenting with
18787 code generation only.
18789 @item -mbranch-cheap
18790 @opindex mbranch-cheap
18791 Do not pretend that branches are expensive.  This is the default.
18793 @item -munix-asm
18794 @opindex munix-asm
18795 Use Unix assembler syntax.  This is the default when configured for
18796 @samp{pdp11-*-bsd}.
18798 @item -mdec-asm
18799 @opindex mdec-asm
18800 Use DEC assembler syntax.  This is the default when configured for any
18801 PDP-11 target other than @samp{pdp11-*-bsd}.
18802 @end table
18804 @node picoChip Options
18805 @subsection picoChip Options
18806 @cindex picoChip options
18808 These @samp{-m} options are defined for picoChip implementations:
18810 @table @gcctabopt
18812 @item -mae=@var{ae_type}
18813 @opindex mcpu
18814 Set the instruction set, register set, and instruction scheduling
18815 parameters for array element type @var{ae_type}.  Supported values
18816 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18818 @option{-mae=ANY} selects a completely generic AE type.  Code
18819 generated with this option runs on any of the other AE types.  The
18820 code is not as efficient as it would be if compiled for a specific
18821 AE type, and some types of operation (e.g., multiplication) do not
18822 work properly on all types of AE.
18824 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18825 for compiled code, and is the default.
18827 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18828 option may suffer from poor performance of byte (char) manipulation,
18829 since the DSP AE does not provide hardware support for byte load/stores.
18831 @item -msymbol-as-address
18832 Enable the compiler to directly use a symbol name as an address in a
18833 load/store instruction, without first loading it into a
18834 register.  Typically, the use of this option generates larger
18835 programs, which run faster than when the option isn't used.  However, the
18836 results vary from program to program, so it is left as a user option,
18837 rather than being permanently enabled.
18839 @item -mno-inefficient-warnings
18840 Disables warnings about the generation of inefficient code.  These
18841 warnings can be generated, for example, when compiling code that
18842 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18843 no hardware support for byte-level memory operations, so all byte
18844 load/stores must be synthesized from word load/store operations.  This is
18845 inefficient and a warning is generated to indicate
18846 that you should rewrite the code to avoid byte operations, or to target
18847 an AE type that has the necessary hardware support.  This option disables
18848 these warnings.
18850 @end table
18852 @node PowerPC Options
18853 @subsection PowerPC Options
18854 @cindex PowerPC options
18856 These are listed under @xref{RS/6000 and PowerPC Options}.
18858 @node RL78 Options
18859 @subsection RL78 Options
18860 @cindex RL78 Options
18862 @table @gcctabopt
18864 @item -msim
18865 @opindex msim
18866 Links in additional target libraries to support operation within a
18867 simulator.
18869 @item -mmul=none
18870 @itemx -mmul=g10
18871 @itemx -mmul=g13
18872 @itemx -mmul=g14
18873 @itemx -mmul=rl78
18874 @opindex mmul
18875 Specifies the type of hardware multiplication and division support to
18876 be used.  The simplest is @code{none}, which uses software for both
18877 multiplication and division.  This is the default.  The @code{g13}
18878 value is for the hardware multiply/divide peripheral found on the
18879 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
18880 the multiplication and division instructions supported by the RL78/G14
18881 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
18882 the value @code{mg10} is an alias for @code{none}.
18884 In addition a C preprocessor macro is defined, based upon the setting
18885 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
18886 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
18888 @item -mcpu=g10
18889 @itemx -mcpu=g13
18890 @itemx -mcpu=g14
18891 @itemx -mcpu=rl78
18892 @opindex mcpu
18893 Specifies the RL78 core to target.  The default is the G14 core, also
18894 known as an S3 core or just RL78.  The G13 or S2 core does not have
18895 multiply or divide instructions, instead it uses a hardware peripheral
18896 for these operations.  The G10 or S1 core does not have register
18897 banks, so it uses a different calling convention.
18899 If this option is set it also selects the type of hardware multiply
18900 support to use, unless this is overridden by an explicit
18901 @option{-mmul=none} option on the command line.  Thus specifying
18902 @option{-mcpu=g13} enables the use of the G13 hardware multiply
18903 peripheral and specifying @option{-mcpu=g10} disables the use of
18904 hardware multipications altogether.
18906 Note, although the RL78/G14 core is the default target, specifying
18907 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
18908 change the behaviour of the toolchain since it also enables G14
18909 hardware multiply support.  If these options are not specified on the
18910 command line then software multiplication routines will be used even
18911 though the code targets the RL78 core.  This is for backwards
18912 compatibility with older toolchains which did not have hardware
18913 multiply and divide support.
18915 In addition a C preprocessor macro is defined, based upon the setting
18916 of this option.  Possible values are: @code{__RL78_G10__},
18917 @code{__RL78_G13__} or @code{__RL78_G14__}.
18919 @item -mg10
18920 @itemx -mg13
18921 @itemx -mg14
18922 @itemx -mrl78
18923 @opindex mg10
18924 @opindex mg13
18925 @opindex mg14
18926 @opindex mrl78
18927 These are aliases for the corresponding @option{-mcpu=} option.  They
18928 are provided for backwards compatibility.
18930 @item -mallregs
18931 @opindex mallregs
18932 Allow the compiler to use all of the available registers.  By default
18933 registers @code{r24..r31} are reserved for use in interrupt handlers.
18934 With this option enabled these registers can be used in ordinary
18935 functions as well.
18937 @item -m64bit-doubles
18938 @itemx -m32bit-doubles
18939 @opindex m64bit-doubles
18940 @opindex m32bit-doubles
18941 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18942 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18943 @option{-m32bit-doubles}.
18945 @end table
18947 @node RS/6000 and PowerPC Options
18948 @subsection IBM RS/6000 and PowerPC Options
18949 @cindex RS/6000 and PowerPC Options
18950 @cindex IBM RS/6000 and PowerPC Options
18952 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18953 @table @gcctabopt
18954 @item -mpowerpc-gpopt
18955 @itemx -mno-powerpc-gpopt
18956 @itemx -mpowerpc-gfxopt
18957 @itemx -mno-powerpc-gfxopt
18958 @need 800
18959 @itemx -mpowerpc64
18960 @itemx -mno-powerpc64
18961 @itemx -mmfcrf
18962 @itemx -mno-mfcrf
18963 @itemx -mpopcntb
18964 @itemx -mno-popcntb
18965 @itemx -mpopcntd
18966 @itemx -mno-popcntd
18967 @itemx -mfprnd
18968 @itemx -mno-fprnd
18969 @need 800
18970 @itemx -mcmpb
18971 @itemx -mno-cmpb
18972 @itemx -mmfpgpr
18973 @itemx -mno-mfpgpr
18974 @itemx -mhard-dfp
18975 @itemx -mno-hard-dfp
18976 @opindex mpowerpc-gpopt
18977 @opindex mno-powerpc-gpopt
18978 @opindex mpowerpc-gfxopt
18979 @opindex mno-powerpc-gfxopt
18980 @opindex mpowerpc64
18981 @opindex mno-powerpc64
18982 @opindex mmfcrf
18983 @opindex mno-mfcrf
18984 @opindex mpopcntb
18985 @opindex mno-popcntb
18986 @opindex mpopcntd
18987 @opindex mno-popcntd
18988 @opindex mfprnd
18989 @opindex mno-fprnd
18990 @opindex mcmpb
18991 @opindex mno-cmpb
18992 @opindex mmfpgpr
18993 @opindex mno-mfpgpr
18994 @opindex mhard-dfp
18995 @opindex mno-hard-dfp
18996 You use these options to specify which instructions are available on the
18997 processor you are using.  The default value of these options is
18998 determined when configuring GCC@.  Specifying the
18999 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19000 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19001 rather than the options listed above.
19003 Specifying @option{-mpowerpc-gpopt} allows
19004 GCC to use the optional PowerPC architecture instructions in the
19005 General Purpose group, including floating-point square root.  Specifying
19006 @option{-mpowerpc-gfxopt} allows GCC to
19007 use the optional PowerPC architecture instructions in the Graphics
19008 group, including floating-point select.
19010 The @option{-mmfcrf} option allows GCC to generate the move from
19011 condition register field instruction implemented on the POWER4
19012 processor and other processors that support the PowerPC V2.01
19013 architecture.
19014 The @option{-mpopcntb} option allows GCC to generate the popcount and
19015 double-precision FP reciprocal estimate instruction implemented on the
19016 POWER5 processor and other processors that support the PowerPC V2.02
19017 architecture.
19018 The @option{-mpopcntd} option allows GCC to generate the popcount
19019 instruction implemented on the POWER7 processor and other processors
19020 that support the PowerPC V2.06 architecture.
19021 The @option{-mfprnd} option allows GCC to generate the FP round to
19022 integer instructions implemented on the POWER5+ processor and other
19023 processors that support the PowerPC V2.03 architecture.
19024 The @option{-mcmpb} option allows GCC to generate the compare bytes
19025 instruction implemented on the POWER6 processor and other processors
19026 that support the PowerPC V2.05 architecture.
19027 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19028 general-purpose register instructions implemented on the POWER6X
19029 processor and other processors that support the extended PowerPC V2.05
19030 architecture.
19031 The @option{-mhard-dfp} option allows GCC to generate the decimal
19032 floating-point instructions implemented on some POWER processors.
19034 The @option{-mpowerpc64} option allows GCC to generate the additional
19035 64-bit instructions that are found in the full PowerPC64 architecture
19036 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19037 @option{-mno-powerpc64}.
19039 @item -mcpu=@var{cpu_type}
19040 @opindex mcpu
19041 Set architecture type, register usage, and
19042 instruction scheduling parameters for machine type @var{cpu_type}.
19043 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19044 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19045 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19046 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19047 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19048 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19049 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19050 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19051 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19052 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19053 @samp{powerpc64}, @samp{powerpc64le}, and @samp{rs64}.
19055 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
19056 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
19057 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
19058 architecture machine types, with an appropriate, generic processor
19059 model assumed for scheduling purposes.
19061 The other options specify a specific processor.  Code generated under
19062 those options runs best on that processor, and may not run at all on
19063 others.
19065 The @option{-mcpu} options automatically enable or disable the
19066 following options:
19068 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19069 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19070 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19071 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19072 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19073 -mquad-memory -mquad-memory-atomic}
19075 The particular options set for any particular CPU varies between
19076 compiler versions, depending on what setting seems to produce optimal
19077 code for that CPU; it doesn't necessarily reflect the actual hardware's
19078 capabilities.  If you wish to set an individual option to a particular
19079 value, you may specify it after the @option{-mcpu} option, like
19080 @option{-mcpu=970 -mno-altivec}.
19082 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19083 not enabled or disabled by the @option{-mcpu} option at present because
19084 AIX does not have full support for these options.  You may still
19085 enable or disable them individually if you're sure it'll work in your
19086 environment.
19088 @item -mtune=@var{cpu_type}
19089 @opindex mtune
19090 Set the instruction scheduling parameters for machine type
19091 @var{cpu_type}, but do not set the architecture type or register usage,
19092 as @option{-mcpu=@var{cpu_type}} does.  The same
19093 values for @var{cpu_type} are used for @option{-mtune} as for
19094 @option{-mcpu}.  If both are specified, the code generated uses the
19095 architecture and registers set by @option{-mcpu}, but the
19096 scheduling parameters set by @option{-mtune}.
19098 @item -mcmodel=small
19099 @opindex mcmodel=small
19100 Generate PowerPC64 code for the small model: The TOC is limited to
19101 64k.
19103 @item -mcmodel=medium
19104 @opindex mcmodel=medium
19105 Generate PowerPC64 code for the medium model: The TOC and other static
19106 data may be up to a total of 4G in size.
19108 @item -mcmodel=large
19109 @opindex mcmodel=large
19110 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19111 in size.  Other data and code is only limited by the 64-bit address
19112 space.
19114 @item -maltivec
19115 @itemx -mno-altivec
19116 @opindex maltivec
19117 @opindex mno-altivec
19118 Generate code that uses (does not use) AltiVec instructions, and also
19119 enable the use of built-in functions that allow more direct access to
19120 the AltiVec instruction set.  You may also need to set
19121 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19122 enhancements.
19124 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19125 @option{-maltivec=be}, the element order for Altivec intrinsics such
19126 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
19127 match array element order corresponding to the endianness of the
19128 target.  That is, element zero identifies the leftmost element in a
19129 vector register when targeting a big-endian platform, and identifies
19130 the rightmost element in a vector register when targeting a
19131 little-endian platform.
19133 @item -maltivec=be
19134 @opindex maltivec=be
19135 Generate Altivec instructions using big-endian element order,
19136 regardless of whether the target is big- or little-endian.  This is
19137 the default when targeting a big-endian platform.
19139 The element order is used to interpret element numbers in Altivec
19140 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19141 @code{vec_insert}.  By default, these match array element order
19142 corresponding to the endianness for the target.
19144 @item -maltivec=le
19145 @opindex maltivec=le
19146 Generate Altivec instructions using little-endian element order,
19147 regardless of whether the target is big- or little-endian.  This is
19148 the default when targeting a little-endian platform.  This option is
19149 currently ignored when targeting a big-endian platform.
19151 The element order is used to interpret element numbers in Altivec
19152 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19153 @code{vec_insert}.  By default, these match array element order
19154 corresponding to the endianness for the target.
19156 @item -mvrsave
19157 @itemx -mno-vrsave
19158 @opindex mvrsave
19159 @opindex mno-vrsave
19160 Generate VRSAVE instructions when generating AltiVec code.
19162 @item -mgen-cell-microcode
19163 @opindex mgen-cell-microcode
19164 Generate Cell microcode instructions.
19166 @item -mwarn-cell-microcode
19167 @opindex mwarn-cell-microcode
19168 Warn when a Cell microcode instruction is emitted.  An example
19169 of a Cell microcode instruction is a variable shift.
19171 @item -msecure-plt
19172 @opindex msecure-plt
19173 Generate code that allows @command{ld} and @command{ld.so}
19174 to build executables and shared
19175 libraries with non-executable @code{.plt} and @code{.got} sections.
19176 This is a PowerPC
19177 32-bit SYSV ABI option.
19179 @item -mbss-plt
19180 @opindex mbss-plt
19181 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19182 fills in, and
19183 requires @code{.plt} and @code{.got}
19184 sections that are both writable and executable.
19185 This is a PowerPC 32-bit SYSV ABI option.
19187 @item -misel
19188 @itemx -mno-isel
19189 @opindex misel
19190 @opindex mno-isel
19191 This switch enables or disables the generation of ISEL instructions.
19193 @item -misel=@var{yes/no}
19194 This switch has been deprecated.  Use @option{-misel} and
19195 @option{-mno-isel} instead.
19197 @item -mspe
19198 @itemx -mno-spe
19199 @opindex mspe
19200 @opindex mno-spe
19201 This switch enables or disables the generation of SPE simd
19202 instructions.
19204 @item -mpaired
19205 @itemx -mno-paired
19206 @opindex mpaired
19207 @opindex mno-paired
19208 This switch enables or disables the generation of PAIRED simd
19209 instructions.
19211 @item -mspe=@var{yes/no}
19212 This option has been deprecated.  Use @option{-mspe} and
19213 @option{-mno-spe} instead.
19215 @item -mvsx
19216 @itemx -mno-vsx
19217 @opindex mvsx
19218 @opindex mno-vsx
19219 Generate code that uses (does not use) vector/scalar (VSX)
19220 instructions, and also enable the use of built-in functions that allow
19221 more direct access to the VSX instruction set.
19223 @item -mcrypto
19224 @itemx -mno-crypto
19225 @opindex mcrypto
19226 @opindex mno-crypto
19227 Enable the use (disable) of the built-in functions that allow direct
19228 access to the cryptographic instructions that were added in version
19229 2.07 of the PowerPC ISA.
19231 @item -mdirect-move
19232 @itemx -mno-direct-move
19233 @opindex mdirect-move
19234 @opindex mno-direct-move
19235 Generate code that uses (does not use) the instructions to move data
19236 between the general purpose registers and the vector/scalar (VSX)
19237 registers that were added in version 2.07 of the PowerPC ISA.
19239 @item -mpower8-fusion
19240 @itemx -mno-power8-fusion
19241 @opindex mpower8-fusion
19242 @opindex mno-power8-fusion
19243 Generate code that keeps (does not keeps) some integer operations
19244 adjacent so that the instructions can be fused together on power8 and
19245 later processors.
19247 @item -mpower8-vector
19248 @itemx -mno-power8-vector
19249 @opindex mpower8-vector
19250 @opindex mno-power8-vector
19251 Generate code that uses (does not use) the vector and scalar
19252 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19253 enable the use of built-in functions that allow more direct access to
19254 the vector instructions.
19256 @item -mquad-memory
19257 @itemx -mno-quad-memory
19258 @opindex mquad-memory
19259 @opindex mno-quad-memory
19260 Generate code that uses (does not use) the non-atomic quad word memory
19261 instructions.  The @option{-mquad-memory} option requires use of
19262 64-bit mode.
19264 @item -mquad-memory-atomic
19265 @itemx -mno-quad-memory-atomic
19266 @opindex mquad-memory-atomic
19267 @opindex mno-quad-memory-atomic
19268 Generate code that uses (does not use) the atomic quad word memory
19269 instructions.  The @option{-mquad-memory-atomic} option requires use of
19270 64-bit mode.
19272 @item -mupper-regs-df
19273 @itemx -mno-upper-regs-df
19274 @opindex mupper-regs-df
19275 @opindex mno-upper-regs-df
19276 Generate code that uses (does not use) the scalar double precision
19277 instructions that target all 64 registers in the vector/scalar
19278 floating point register set that were added in version 2.06 of the
19279 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
19280 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19281 @option{-mvsx} options.
19283 @item -mupper-regs-sf
19284 @itemx -mno-upper-regs-sf
19285 @opindex mupper-regs-sf
19286 @opindex mno-upper-regs-sf
19287 Generate code that uses (does not use) the scalar single precision
19288 instructions that target all 64 registers in the vector/scalar
19289 floating point register set that were added in version 2.07 of the
19290 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
19291 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
19292 options.
19294 @item -mupper-regs
19295 @itemx -mno-upper-regs
19296 @opindex mupper-regs
19297 @opindex mno-upper-regs
19298 Generate code that uses (does not use) the scalar
19299 instructions that target all 64 registers in the vector/scalar
19300 floating point register set, depending on the model of the machine.
19302 If the @option{-mno-upper-regs} option is used, it turns off both
19303 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19305 @item -mfloat-gprs=@var{yes/single/double/no}
19306 @itemx -mfloat-gprs
19307 @opindex mfloat-gprs
19308 This switch enables or disables the generation of floating-point
19309 operations on the general-purpose registers for architectures that
19310 support it.
19312 The argument @samp{yes} or @samp{single} enables the use of
19313 single-precision floating-point operations.
19315 The argument @samp{double} enables the use of single and
19316 double-precision floating-point operations.
19318 The argument @samp{no} disables floating-point operations on the
19319 general-purpose registers.
19321 This option is currently only available on the MPC854x.
19323 @item -m32
19324 @itemx -m64
19325 @opindex m32
19326 @opindex m64
19327 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19328 targets (including GNU/Linux).  The 32-bit environment sets int, long
19329 and pointer to 32 bits and generates code that runs on any PowerPC
19330 variant.  The 64-bit environment sets int to 32 bits and long and
19331 pointer to 64 bits, and generates code for PowerPC64, as for
19332 @option{-mpowerpc64}.
19334 @item -mfull-toc
19335 @itemx -mno-fp-in-toc
19336 @itemx -mno-sum-in-toc
19337 @itemx -mminimal-toc
19338 @opindex mfull-toc
19339 @opindex mno-fp-in-toc
19340 @opindex mno-sum-in-toc
19341 @opindex mminimal-toc
19342 Modify generation of the TOC (Table Of Contents), which is created for
19343 every executable file.  The @option{-mfull-toc} option is selected by
19344 default.  In that case, GCC allocates at least one TOC entry for
19345 each unique non-automatic variable reference in your program.  GCC
19346 also places floating-point constants in the TOC@.  However, only
19347 16,384 entries are available in the TOC@.
19349 If you receive a linker error message that saying you have overflowed
19350 the available TOC space, you can reduce the amount of TOC space used
19351 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19352 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19353 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19354 generate code to calculate the sum of an address and a constant at
19355 run time instead of putting that sum into the TOC@.  You may specify one
19356 or both of these options.  Each causes GCC to produce very slightly
19357 slower and larger code at the expense of conserving TOC space.
19359 If you still run out of space in the TOC even when you specify both of
19360 these options, specify @option{-mminimal-toc} instead.  This option causes
19361 GCC to make only one TOC entry for every file.  When you specify this
19362 option, GCC produces code that is slower and larger but which
19363 uses extremely little TOC space.  You may wish to use this option
19364 only on files that contain less frequently-executed code.
19366 @item -maix64
19367 @itemx -maix32
19368 @opindex maix64
19369 @opindex maix32
19370 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19371 @code{long} type, and the infrastructure needed to support them.
19372 Specifying @option{-maix64} implies @option{-mpowerpc64},
19373 while @option{-maix32} disables the 64-bit ABI and
19374 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19376 @item -mxl-compat
19377 @itemx -mno-xl-compat
19378 @opindex mxl-compat
19379 @opindex mno-xl-compat
19380 Produce code that conforms more closely to IBM XL compiler semantics
19381 when using AIX-compatible ABI@.  Pass floating-point arguments to
19382 prototyped functions beyond the register save area (RSA) on the stack
19383 in addition to argument FPRs.  Do not assume that most significant
19384 double in 128-bit long double value is properly rounded when comparing
19385 values and converting to double.  Use XL symbol names for long double
19386 support routines.
19388 The AIX calling convention was extended but not initially documented to
19389 handle an obscure K&R C case of calling a function that takes the
19390 address of its arguments with fewer arguments than declared.  IBM XL
19391 compilers access floating-point arguments that do not fit in the
19392 RSA from the stack when a subroutine is compiled without
19393 optimization.  Because always storing floating-point arguments on the
19394 stack is inefficient and rarely needed, this option is not enabled by
19395 default and only is necessary when calling subroutines compiled by IBM
19396 XL compilers without optimization.
19398 @item -mpe
19399 @opindex mpe
19400 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19401 application written to use message passing with special startup code to
19402 enable the application to run.  The system must have PE installed in the
19403 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19404 must be overridden with the @option{-specs=} option to specify the
19405 appropriate directory location.  The Parallel Environment does not
19406 support threads, so the @option{-mpe} option and the @option{-pthread}
19407 option are incompatible.
19409 @item -malign-natural
19410 @itemx -malign-power
19411 @opindex malign-natural
19412 @opindex malign-power
19413 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19414 @option{-malign-natural} overrides the ABI-defined alignment of larger
19415 types, such as floating-point doubles, on their natural size-based boundary.
19416 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19417 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19419 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19420 is not supported.
19422 @item -msoft-float
19423 @itemx -mhard-float
19424 @opindex msoft-float
19425 @opindex mhard-float
19426 Generate code that does not use (uses) the floating-point register set.
19427 Software floating-point emulation is provided if you use the
19428 @option{-msoft-float} option, and pass the option to GCC when linking.
19430 @item -msingle-float
19431 @itemx -mdouble-float
19432 @opindex msingle-float
19433 @opindex mdouble-float
19434 Generate code for single- or double-precision floating-point operations.
19435 @option{-mdouble-float} implies @option{-msingle-float}.
19437 @item -msimple-fpu
19438 @opindex msimple-fpu
19439 Do not generate @code{sqrt} and @code{div} instructions for hardware
19440 floating-point unit.
19442 @item -mfpu=@var{name}
19443 @opindex mfpu
19444 Specify type of floating-point unit.  Valid values for @var{name} are
19445 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19446 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19447 @samp{sp_full} (equivalent to @option{-msingle-float}),
19448 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19450 @item -mxilinx-fpu
19451 @opindex mxilinx-fpu
19452 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19454 @item -mmultiple
19455 @itemx -mno-multiple
19456 @opindex mmultiple
19457 @opindex mno-multiple
19458 Generate code that uses (does not use) the load multiple word
19459 instructions and the store multiple word instructions.  These
19460 instructions are generated by default on POWER systems, and not
19461 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19462 PowerPC systems, since those instructions do not work when the
19463 processor is in little-endian mode.  The exceptions are PPC740 and
19464 PPC750 which permit these instructions in little-endian mode.
19466 @item -mstring
19467 @itemx -mno-string
19468 @opindex mstring
19469 @opindex mno-string
19470 Generate code that uses (does not use) the load string instructions
19471 and the store string word instructions to save multiple registers and
19472 do small block moves.  These instructions are generated by default on
19473 POWER systems, and not generated on PowerPC systems.  Do not use
19474 @option{-mstring} on little-endian PowerPC systems, since those
19475 instructions do not work when the processor is in little-endian mode.
19476 The exceptions are PPC740 and PPC750 which permit these instructions
19477 in little-endian mode.
19479 @item -mupdate
19480 @itemx -mno-update
19481 @opindex mupdate
19482 @opindex mno-update
19483 Generate code that uses (does not use) the load or store instructions
19484 that update the base register to the address of the calculated memory
19485 location.  These instructions are generated by default.  If you use
19486 @option{-mno-update}, there is a small window between the time that the
19487 stack pointer is updated and the address of the previous frame is
19488 stored, which means code that walks the stack frame across interrupts or
19489 signals may get corrupted data.
19491 @item -mavoid-indexed-addresses
19492 @itemx -mno-avoid-indexed-addresses
19493 @opindex mavoid-indexed-addresses
19494 @opindex mno-avoid-indexed-addresses
19495 Generate code that tries to avoid (not avoid) the use of indexed load
19496 or store instructions. These instructions can incur a performance
19497 penalty on Power6 processors in certain situations, such as when
19498 stepping through large arrays that cross a 16M boundary.  This option
19499 is enabled by default when targeting Power6 and disabled otherwise.
19501 @item -mfused-madd
19502 @itemx -mno-fused-madd
19503 @opindex mfused-madd
19504 @opindex mno-fused-madd
19505 Generate code that uses (does not use) the floating-point multiply and
19506 accumulate instructions.  These instructions are generated by default
19507 if hardware floating point is used.  The machine-dependent
19508 @option{-mfused-madd} option is now mapped to the machine-independent
19509 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19510 mapped to @option{-ffp-contract=off}.
19512 @item -mmulhw
19513 @itemx -mno-mulhw
19514 @opindex mmulhw
19515 @opindex mno-mulhw
19516 Generate code that uses (does not use) the half-word multiply and
19517 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19518 These instructions are generated by default when targeting those
19519 processors.
19521 @item -mdlmzb
19522 @itemx -mno-dlmzb
19523 @opindex mdlmzb
19524 @opindex mno-dlmzb
19525 Generate code that uses (does not use) the string-search @samp{dlmzb}
19526 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19527 generated by default when targeting those processors.
19529 @item -mno-bit-align
19530 @itemx -mbit-align
19531 @opindex mno-bit-align
19532 @opindex mbit-align
19533 On System V.4 and embedded PowerPC systems do not (do) force structures
19534 and unions that contain bit-fields to be aligned to the base type of the
19535 bit-field.
19537 For example, by default a structure containing nothing but 8
19538 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19539 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19540 the structure is aligned to a 1-byte boundary and is 1 byte in
19541 size.
19543 @item -mno-strict-align
19544 @itemx -mstrict-align
19545 @opindex mno-strict-align
19546 @opindex mstrict-align
19547 On System V.4 and embedded PowerPC systems do not (do) assume that
19548 unaligned memory references are handled by the system.
19550 @item -mrelocatable
19551 @itemx -mno-relocatable
19552 @opindex mrelocatable
19553 @opindex mno-relocatable
19554 Generate code that allows (does not allow) a static executable to be
19555 relocated to a different address at run time.  A simple embedded
19556 PowerPC system loader should relocate the entire contents of
19557 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19558 a table of 32-bit addresses generated by this option.  For this to
19559 work, all objects linked together must be compiled with
19560 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19561 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19563 @item -mrelocatable-lib
19564 @itemx -mno-relocatable-lib
19565 @opindex mrelocatable-lib
19566 @opindex mno-relocatable-lib
19567 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19568 @code{.fixup} section to allow static executables to be relocated at
19569 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19570 alignment of @option{-mrelocatable}.  Objects compiled with
19571 @option{-mrelocatable-lib} may be linked with objects compiled with
19572 any combination of the @option{-mrelocatable} options.
19574 @item -mno-toc
19575 @itemx -mtoc
19576 @opindex mno-toc
19577 @opindex mtoc
19578 On System V.4 and embedded PowerPC systems do not (do) assume that
19579 register 2 contains a pointer to a global area pointing to the addresses
19580 used in the program.
19582 @item -mlittle
19583 @itemx -mlittle-endian
19584 @opindex mlittle
19585 @opindex mlittle-endian
19586 On System V.4 and embedded PowerPC systems compile code for the
19587 processor in little-endian mode.  The @option{-mlittle-endian} option is
19588 the same as @option{-mlittle}.
19590 @item -mbig
19591 @itemx -mbig-endian
19592 @opindex mbig
19593 @opindex mbig-endian
19594 On System V.4 and embedded PowerPC systems compile code for the
19595 processor in big-endian mode.  The @option{-mbig-endian} option is
19596 the same as @option{-mbig}.
19598 @item -mdynamic-no-pic
19599 @opindex mdynamic-no-pic
19600 On Darwin and Mac OS X systems, compile code so that it is not
19601 relocatable, but that its external references are relocatable.  The
19602 resulting code is suitable for applications, but not shared
19603 libraries.
19605 @item -msingle-pic-base
19606 @opindex msingle-pic-base
19607 Treat the register used for PIC addressing as read-only, rather than
19608 loading it in the prologue for each function.  The runtime system is
19609 responsible for initializing this register with an appropriate value
19610 before execution begins.
19612 @item -mprioritize-restricted-insns=@var{priority}
19613 @opindex mprioritize-restricted-insns
19614 This option controls the priority that is assigned to
19615 dispatch-slot restricted instructions during the second scheduling
19616 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19617 or @samp{2} to assign no, highest, or second-highest (respectively) 
19618 priority to dispatch-slot restricted
19619 instructions.
19621 @item -msched-costly-dep=@var{dependence_type}
19622 @opindex msched-costly-dep
19623 This option controls which dependences are considered costly
19624 by the target during instruction scheduling.  The argument
19625 @var{dependence_type} takes one of the following values:
19627 @table @asis
19628 @item @samp{no}
19629 No dependence is costly.
19631 @item @samp{all}
19632 All dependences are costly.
19634 @item @samp{true_store_to_load}
19635 A true dependence from store to load is costly.
19637 @item @samp{store_to_load}
19638 Any dependence from store to load is costly.
19640 @item @var{number}
19641 Any dependence for which the latency is greater than or equal to 
19642 @var{number} is costly.
19643 @end table
19645 @item -minsert-sched-nops=@var{scheme}
19646 @opindex minsert-sched-nops
19647 This option controls which NOP insertion scheme is used during
19648 the second scheduling pass.  The argument @var{scheme} takes one of the
19649 following values:
19651 @table @asis
19652 @item @samp{no}
19653 Don't insert NOPs.
19655 @item @samp{pad}
19656 Pad with NOPs any dispatch group that has vacant issue slots,
19657 according to the scheduler's grouping.
19659 @item @samp{regroup_exact}
19660 Insert NOPs to force costly dependent insns into
19661 separate groups.  Insert exactly as many NOPs as needed to force an insn
19662 to a new group, according to the estimated processor grouping.
19664 @item @var{number}
19665 Insert NOPs to force costly dependent insns into
19666 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19667 @end table
19669 @item -mcall-sysv
19670 @opindex mcall-sysv
19671 On System V.4 and embedded PowerPC systems compile code using calling
19672 conventions that adhere to the March 1995 draft of the System V
19673 Application Binary Interface, PowerPC processor supplement.  This is the
19674 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19676 @item -mcall-sysv-eabi
19677 @itemx -mcall-eabi
19678 @opindex mcall-sysv-eabi
19679 @opindex mcall-eabi
19680 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19682 @item -mcall-sysv-noeabi
19683 @opindex mcall-sysv-noeabi
19684 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19686 @item -mcall-aixdesc
19687 @opindex m
19688 On System V.4 and embedded PowerPC systems compile code for the AIX
19689 operating system.
19691 @item -mcall-linux
19692 @opindex mcall-linux
19693 On System V.4 and embedded PowerPC systems compile code for the
19694 Linux-based GNU system.
19696 @item -mcall-freebsd
19697 @opindex mcall-freebsd
19698 On System V.4 and embedded PowerPC systems compile code for the
19699 FreeBSD operating system.
19701 @item -mcall-netbsd
19702 @opindex mcall-netbsd
19703 On System V.4 and embedded PowerPC systems compile code for the
19704 NetBSD operating system.
19706 @item -mcall-openbsd
19707 @opindex mcall-netbsd
19708 On System V.4 and embedded PowerPC systems compile code for the
19709 OpenBSD operating system.
19711 @item -maix-struct-return
19712 @opindex maix-struct-return
19713 Return all structures in memory (as specified by the AIX ABI)@.
19715 @item -msvr4-struct-return
19716 @opindex msvr4-struct-return
19717 Return structures smaller than 8 bytes in registers (as specified by the
19718 SVR4 ABI)@.
19720 @item -mabi=@var{abi-type}
19721 @opindex mabi
19722 Extend the current ABI with a particular extension, or remove such extension.
19723 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
19724 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
19725 @samp{elfv1}, @samp{elfv2}@.
19727 @item -mabi=spe
19728 @opindex mabi=spe
19729 Extend the current ABI with SPE ABI extensions.  This does not change
19730 the default ABI, instead it adds the SPE ABI extensions to the current
19731 ABI@.
19733 @item -mabi=no-spe
19734 @opindex mabi=no-spe
19735 Disable Book-E SPE ABI extensions for the current ABI@.
19737 @item -mabi=ibmlongdouble
19738 @opindex mabi=ibmlongdouble
19739 Change the current ABI to use IBM extended-precision long double.
19740 This is a PowerPC 32-bit SYSV ABI option.
19742 @item -mabi=ieeelongdouble
19743 @opindex mabi=ieeelongdouble
19744 Change the current ABI to use IEEE extended-precision long double.
19745 This is a PowerPC 32-bit Linux ABI option.
19747 @item -mabi=elfv1
19748 @opindex mabi=elfv1
19749 Change the current ABI to use the ELFv1 ABI.
19750 This is the default ABI for big-endian PowerPC 64-bit Linux.
19751 Overriding the default ABI requires special system support and is
19752 likely to fail in spectacular ways.
19754 @item -mabi=elfv2
19755 @opindex mabi=elfv2
19756 Change the current ABI to use the ELFv2 ABI.
19757 This is the default ABI for little-endian PowerPC 64-bit Linux.
19758 Overriding the default ABI requires special system support and is
19759 likely to fail in spectacular ways.
19761 @item -mprototype
19762 @itemx -mno-prototype
19763 @opindex mprototype
19764 @opindex mno-prototype
19765 On System V.4 and embedded PowerPC systems assume that all calls to
19766 variable argument functions are properly prototyped.  Otherwise, the
19767 compiler must insert an instruction before every non-prototyped call to
19768 set or clear bit 6 of the condition code register (@code{CR}) to
19769 indicate whether floating-point values are passed in the floating-point
19770 registers in case the function takes variable arguments.  With
19771 @option{-mprototype}, only calls to prototyped variable argument functions
19772 set or clear the bit.
19774 @item -msim
19775 @opindex msim
19776 On embedded PowerPC systems, assume that the startup module is called
19777 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19778 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19779 configurations.
19781 @item -mmvme
19782 @opindex mmvme
19783 On embedded PowerPC systems, assume that the startup module is called
19784 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19785 @file{libc.a}.
19787 @item -mads
19788 @opindex mads
19789 On embedded PowerPC systems, assume that the startup module is called
19790 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19791 @file{libc.a}.
19793 @item -myellowknife
19794 @opindex myellowknife
19795 On embedded PowerPC systems, assume that the startup module is called
19796 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19797 @file{libc.a}.
19799 @item -mvxworks
19800 @opindex mvxworks
19801 On System V.4 and embedded PowerPC systems, specify that you are
19802 compiling for a VxWorks system.
19804 @item -memb
19805 @opindex memb
19806 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
19807 header to indicate that @samp{eabi} extended relocations are used.
19809 @item -meabi
19810 @itemx -mno-eabi
19811 @opindex meabi
19812 @opindex mno-eabi
19813 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19814 Embedded Applications Binary Interface (EABI), which is a set of
19815 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19816 means that the stack is aligned to an 8-byte boundary, a function
19817 @code{__eabi} is called from @code{main} to set up the EABI
19818 environment, and the @option{-msdata} option can use both @code{r2} and
19819 @code{r13} to point to two separate small data areas.  Selecting
19820 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19821 no EABI initialization function is called from @code{main}, and the
19822 @option{-msdata} option only uses @code{r13} to point to a single
19823 small data area.  The @option{-meabi} option is on by default if you
19824 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19826 @item -msdata=eabi
19827 @opindex msdata=eabi
19828 On System V.4 and embedded PowerPC systems, put small initialized
19829 @code{const} global and static data in the @code{.sdata2} section, which
19830 is pointed to by register @code{r2}.  Put small initialized
19831 non-@code{const} global and static data in the @code{.sdata} section,
19832 which is pointed to by register @code{r13}.  Put small uninitialized
19833 global and static data in the @code{.sbss} section, which is adjacent to
19834 the @code{.sdata} section.  The @option{-msdata=eabi} option is
19835 incompatible with the @option{-mrelocatable} option.  The
19836 @option{-msdata=eabi} option also sets the @option{-memb} option.
19838 @item -msdata=sysv
19839 @opindex msdata=sysv
19840 On System V.4 and embedded PowerPC systems, put small global and static
19841 data in the @code{.sdata} section, which is pointed to by register
19842 @code{r13}.  Put small uninitialized global and static data in the
19843 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
19844 The @option{-msdata=sysv} option is incompatible with the
19845 @option{-mrelocatable} option.
19847 @item -msdata=default
19848 @itemx -msdata
19849 @opindex msdata=default
19850 @opindex msdata
19851 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19852 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19853 same as @option{-msdata=sysv}.
19855 @item -msdata=data
19856 @opindex msdata=data
19857 On System V.4 and embedded PowerPC systems, put small global
19858 data in the @code{.sdata} section.  Put small uninitialized global
19859 data in the @code{.sbss} section.  Do not use register @code{r13}
19860 to address small data however.  This is the default behavior unless
19861 other @option{-msdata} options are used.
19863 @item -msdata=none
19864 @itemx -mno-sdata
19865 @opindex msdata=none
19866 @opindex mno-sdata
19867 On embedded PowerPC systems, put all initialized global and static data
19868 in the @code{.data} section, and all uninitialized data in the
19869 @code{.bss} section.
19871 @item -mblock-move-inline-limit=@var{num}
19872 @opindex mblock-move-inline-limit
19873 Inline all block moves (such as calls to @code{memcpy} or structure
19874 copies) less than or equal to @var{num} bytes.  The minimum value for
19875 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19876 targets.  The default value is target-specific.
19878 @item -G @var{num}
19879 @opindex G
19880 @cindex smaller data references (PowerPC)
19881 @cindex .sdata/.sdata2 references (PowerPC)
19882 On embedded PowerPC systems, put global and static items less than or
19883 equal to @var{num} bytes into the small data or BSS sections instead of
19884 the normal data or BSS section.  By default, @var{num} is 8.  The
19885 @option{-G @var{num}} switch is also passed to the linker.
19886 All modules should be compiled with the same @option{-G @var{num}} value.
19888 @item -mregnames
19889 @itemx -mno-regnames
19890 @opindex mregnames
19891 @opindex mno-regnames
19892 On System V.4 and embedded PowerPC systems do (do not) emit register
19893 names in the assembly language output using symbolic forms.
19895 @item -mlongcall
19896 @itemx -mno-longcall
19897 @opindex mlongcall
19898 @opindex mno-longcall
19899 By default assume that all calls are far away so that a longer and more
19900 expensive calling sequence is required.  This is required for calls
19901 farther than 32 megabytes (33,554,432 bytes) from the current location.
19902 A short call is generated if the compiler knows
19903 the call cannot be that far away.  This setting can be overridden by
19904 the @code{shortcall} function attribute, or by @code{#pragma
19905 longcall(0)}.
19907 Some linkers are capable of detecting out-of-range calls and generating
19908 glue code on the fly.  On these systems, long calls are unnecessary and
19909 generate slower code.  As of this writing, the AIX linker can do this,
19910 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19911 to the GNU linker for 32-bit PowerPC systems as well.
19913 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19914 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19915 addresses represent the callee and the branch island.  The
19916 Darwin/PPC linker prefers the first address and generates a @code{bl
19917 callee} if the PPC @code{bl} instruction reaches the callee directly;
19918 otherwise, the linker generates @code{bl L42} to call the branch
19919 island.  The branch island is appended to the body of the
19920 calling function; it computes the full 32-bit address of the callee
19921 and jumps to it.
19923 On Mach-O (Darwin) systems, this option directs the compiler emit to
19924 the glue for every direct call, and the Darwin linker decides whether
19925 to use or discard it.
19927 In the future, GCC may ignore all longcall specifications
19928 when the linker is known to generate glue.
19930 @item -mtls-markers
19931 @itemx -mno-tls-markers
19932 @opindex mtls-markers
19933 @opindex mno-tls-markers
19934 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19935 specifying the function argument.  The relocation allows the linker to
19936 reliably associate function call with argument setup instructions for
19937 TLS optimization, which in turn allows GCC to better schedule the
19938 sequence.
19940 @item -pthread
19941 @opindex pthread
19942 Adds support for multithreading with the @dfn{pthreads} library.
19943 This option sets flags for both the preprocessor and linker.
19945 @item -mrecip
19946 @itemx -mno-recip
19947 @opindex mrecip
19948 This option enables use of the reciprocal estimate and
19949 reciprocal square root estimate instructions with additional
19950 Newton-Raphson steps to increase precision instead of doing a divide or
19951 square root and divide for floating-point arguments.  You should use
19952 the @option{-ffast-math} option when using @option{-mrecip} (or at
19953 least @option{-funsafe-math-optimizations},
19954 @option{-finite-math-only}, @option{-freciprocal-math} and
19955 @option{-fno-trapping-math}).  Note that while the throughput of the
19956 sequence is generally higher than the throughput of the non-reciprocal
19957 instruction, the precision of the sequence can be decreased by up to 2
19958 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19959 roots.
19961 @item -mrecip=@var{opt}
19962 @opindex mrecip=opt
19963 This option controls which reciprocal estimate instructions
19964 may be used.  @var{opt} is a comma-separated list of options, which may
19965 be preceded by a @code{!} to invert the option:
19967 @table @samp
19969 @item all
19970 Enable all estimate instructions.
19972 @item default 
19973 Enable the default instructions, equivalent to @option{-mrecip}.
19975 @item none 
19976 Disable all estimate instructions, equivalent to @option{-mno-recip}.
19978 @item div 
19979 Enable the reciprocal approximation instructions for both 
19980 single and double precision.
19982 @item divf 
19983 Enable the single-precision reciprocal approximation instructions.
19985 @item divd 
19986 Enable the double-precision reciprocal approximation instructions.
19988 @item rsqrt 
19989 Enable the reciprocal square root approximation instructions for both
19990 single and double precision.
19992 @item rsqrtf 
19993 Enable the single-precision reciprocal square root approximation instructions.
19995 @item rsqrtd 
19996 Enable the double-precision reciprocal square root approximation instructions.
19998 @end table
20000 So, for example, @option{-mrecip=all,!rsqrtd} enables
20001 all of the reciprocal estimate instructions, except for the
20002 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20003 which handle the double-precision reciprocal square root calculations.
20005 @item -mrecip-precision
20006 @itemx -mno-recip-precision
20007 @opindex mrecip-precision
20008 Assume (do not assume) that the reciprocal estimate instructions
20009 provide higher-precision estimates than is mandated by the PowerPC
20010 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20011 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20012 The double-precision square root estimate instructions are not generated by
20013 default on low-precision machines, since they do not provide an
20014 estimate that converges after three steps.
20016 @item -mveclibabi=@var{type}
20017 @opindex mveclibabi
20018 Specifies the ABI type to use for vectorizing intrinsics using an
20019 external library.  The only type supported at present is @samp{mass},
20020 which specifies to use IBM's Mathematical Acceleration Subsystem
20021 (MASS) libraries for vectorizing intrinsics using external libraries.
20022 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20023 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20024 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20025 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20026 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20027 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20028 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20029 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20030 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20031 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20032 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20033 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20034 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20035 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20036 for power7.  Both @option{-ftree-vectorize} and
20037 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20038 libraries must be specified at link time.
20040 @item -mfriz
20041 @itemx -mno-friz
20042 @opindex mfriz
20043 Generate (do not generate) the @code{friz} instruction when the
20044 @option{-funsafe-math-optimizations} option is used to optimize
20045 rounding of floating-point values to 64-bit integer and back to floating
20046 point.  The @code{friz} instruction does not return the same value if
20047 the floating-point number is too large to fit in an integer.
20049 @item -mpointers-to-nested-functions
20050 @itemx -mno-pointers-to-nested-functions
20051 @opindex mpointers-to-nested-functions
20052 Generate (do not generate) code to load up the static chain register
20053 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
20054 systems where a function pointer points to a 3-word descriptor giving
20055 the function address, TOC value to be loaded in register @code{r2}, and
20056 static chain value to be loaded in register @code{r11}.  The
20057 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20058 call through pointers to nested functions or pointers
20059 to functions compiled in other languages that use the static chain if
20060 you use @option{-mno-pointers-to-nested-functions}.
20062 @item -msave-toc-indirect
20063 @itemx -mno-save-toc-indirect
20064 @opindex msave-toc-indirect
20065 Generate (do not generate) code to save the TOC value in the reserved
20066 stack location in the function prologue if the function calls through
20067 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20068 saved in the prologue, it is saved just before the call through the
20069 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20071 @item -mcompat-align-parm
20072 @itemx -mno-compat-align-parm
20073 @opindex mcompat-align-parm
20074 Generate (do not generate) code to pass structure parameters with a
20075 maximum alignment of 64 bits, for compatibility with older versions
20076 of GCC.
20078 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20079 structure parameter on a 128-bit boundary when that structure contained
20080 a member requiring 128-bit alignment.  This is corrected in more
20081 recent versions of GCC.  This option may be used to generate code
20082 that is compatible with functions compiled with older versions of
20083 GCC.
20085 The @option{-mno-compat-align-parm} option is the default.
20086 @end table
20088 @node RX Options
20089 @subsection RX Options
20090 @cindex RX Options
20092 These command-line options are defined for RX targets:
20094 @table @gcctabopt
20095 @item -m64bit-doubles
20096 @itemx -m32bit-doubles
20097 @opindex m64bit-doubles
20098 @opindex m32bit-doubles
20099 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20100 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20101 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20102 works on 32-bit values, which is why the default is
20103 @option{-m32bit-doubles}.
20105 @item -fpu
20106 @itemx -nofpu
20107 @opindex fpu
20108 @opindex nofpu
20109 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20110 floating-point hardware.  The default is enabled for the RX600
20111 series and disabled for the RX200 series.
20113 Floating-point instructions are only generated for 32-bit floating-point 
20114 values, however, so the FPU hardware is not used for doubles if the
20115 @option{-m64bit-doubles} option is used.
20117 @emph{Note} If the @option{-fpu} option is enabled then
20118 @option{-funsafe-math-optimizations} is also enabled automatically.
20119 This is because the RX FPU instructions are themselves unsafe.
20121 @item -mcpu=@var{name}
20122 @opindex mcpu
20123 Selects the type of RX CPU to be targeted.  Currently three types are
20124 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
20125 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
20127 The only difference between @samp{RX600} and @samp{RX610} is that the
20128 @samp{RX610} does not support the @code{MVTIPL} instruction.
20130 The @samp{RX200} series does not have a hardware floating-point unit
20131 and so @option{-nofpu} is enabled by default when this type is
20132 selected.
20134 @item -mbig-endian-data
20135 @itemx -mlittle-endian-data
20136 @opindex mbig-endian-data
20137 @opindex mlittle-endian-data
20138 Store data (but not code) in the big-endian format.  The default is
20139 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20140 format.
20142 @item -msmall-data-limit=@var{N}
20143 @opindex msmall-data-limit
20144 Specifies the maximum size in bytes of global and static variables
20145 which can be placed into the small data area.  Using the small data
20146 area can lead to smaller and faster code, but the size of area is
20147 limited and it is up to the programmer to ensure that the area does
20148 not overflow.  Also when the small data area is used one of the RX's
20149 registers (usually @code{r13}) is reserved for use pointing to this
20150 area, so it is no longer available for use by the compiler.  This
20151 could result in slower and/or larger code if variables are pushed onto
20152 the stack instead of being held in this register.
20154 Note, common variables (variables that have not been initialized) and
20155 constants are not placed into the small data area as they are assigned
20156 to other sections in the output executable.
20158 The default value is zero, which disables this feature.  Note, this
20159 feature is not enabled by default with higher optimization levels
20160 (@option{-O2} etc) because of the potentially detrimental effects of
20161 reserving a register.  It is up to the programmer to experiment and
20162 discover whether this feature is of benefit to their program.  See the
20163 description of the @option{-mpid} option for a description of how the
20164 actual register to hold the small data area pointer is chosen.
20166 @item -msim
20167 @itemx -mno-sim
20168 @opindex msim
20169 @opindex mno-sim
20170 Use the simulator runtime.  The default is to use the libgloss
20171 board-specific runtime.
20173 @item -mas100-syntax
20174 @itemx -mno-as100-syntax
20175 @opindex mas100-syntax
20176 @opindex mno-as100-syntax
20177 When generating assembler output use a syntax that is compatible with
20178 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20179 assembler, but it has some restrictions so it is not generated by default.
20181 @item -mmax-constant-size=@var{N}
20182 @opindex mmax-constant-size
20183 Specifies the maximum size, in bytes, of a constant that can be used as
20184 an operand in a RX instruction.  Although the RX instruction set does
20185 allow constants of up to 4 bytes in length to be used in instructions,
20186 a longer value equates to a longer instruction.  Thus in some
20187 circumstances it can be beneficial to restrict the size of constants
20188 that are used in instructions.  Constants that are too big are instead
20189 placed into a constant pool and referenced via register indirection.
20191 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20192 or 4 means that constants of any size are allowed.
20194 @item -mrelax
20195 @opindex mrelax
20196 Enable linker relaxation.  Linker relaxation is a process whereby the
20197 linker attempts to reduce the size of a program by finding shorter
20198 versions of various instructions.  Disabled by default.
20200 @item -mint-register=@var{N}
20201 @opindex mint-register
20202 Specify the number of registers to reserve for fast interrupt handler
20203 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20204 means that register @code{r13} is reserved for the exclusive use
20205 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20206 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20207 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20208 A value of 0, the default, does not reserve any registers.
20210 @item -msave-acc-in-interrupts
20211 @opindex msave-acc-in-interrupts
20212 Specifies that interrupt handler functions should preserve the
20213 accumulator register.  This is only necessary if normal code might use
20214 the accumulator register, for example because it performs 64-bit
20215 multiplications.  The default is to ignore the accumulator as this
20216 makes the interrupt handlers faster.
20218 @item -mpid
20219 @itemx -mno-pid
20220 @opindex mpid
20221 @opindex mno-pid
20222 Enables the generation of position independent data.  When enabled any
20223 access to constant data is done via an offset from a base address
20224 held in a register.  This allows the location of constant data to be
20225 determined at run time without requiring the executable to be
20226 relocated, which is a benefit to embedded applications with tight
20227 memory constraints.  Data that can be modified is not affected by this
20228 option.
20230 Note, using this feature reserves a register, usually @code{r13}, for
20231 the constant data base address.  This can result in slower and/or
20232 larger code, especially in complicated functions.
20234 The actual register chosen to hold the constant data base address
20235 depends upon whether the @option{-msmall-data-limit} and/or the
20236 @option{-mint-register} command-line options are enabled.  Starting
20237 with register @code{r13} and proceeding downwards, registers are
20238 allocated first to satisfy the requirements of @option{-mint-register},
20239 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20240 is possible for the small data area register to be @code{r8} if both
20241 @option{-mint-register=4} and @option{-mpid} are specified on the
20242 command line.
20244 By default this feature is not enabled.  The default can be restored
20245 via the @option{-mno-pid} command-line option.
20247 @item -mno-warn-multiple-fast-interrupts
20248 @itemx -mwarn-multiple-fast-interrupts
20249 @opindex mno-warn-multiple-fast-interrupts
20250 @opindex mwarn-multiple-fast-interrupts
20251 Prevents GCC from issuing a warning message if it finds more than one
20252 fast interrupt handler when it is compiling a file.  The default is to
20253 issue a warning for each extra fast interrupt handler found, as the RX
20254 only supports one such interrupt.
20256 @item -mallow-string-insns
20257 @itemx -mno-allow-string-insns
20258 @opindex mallow-string-insns
20259 @opindex mno-allow-string-insns
20260 Enables or disables the use of the string manipulation instructions
20261 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
20262 @code{SWHILE} and also the @code{RMPA} instruction.  These
20263 instructions may prefetch data, which is not safe to do if accessing
20264 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
20265 for more information).
20267 The default is to allow these instructions, but it is not possible for
20268 GCC to reliably detect all circumstances where a string instruction
20269 might be used to access an I/O register, so their use cannot be
20270 disabled automatically.  Instead it is reliant upon the programmer to
20271 use the @option{-mno-allow-string-insns} option if their program
20272 accesses I/O space.
20274 When the instructions are enabled GCC defines the C preprocessor
20275 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
20276 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
20277 @end table
20279 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20280 has special significance to the RX port when used with the
20281 @code{interrupt} function attribute.  This attribute indicates a
20282 function intended to process fast interrupts.  GCC ensures
20283 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20284 and/or @code{r13} and only provided that the normal use of the
20285 corresponding registers have been restricted via the
20286 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20287 options.
20289 @node S/390 and zSeries Options
20290 @subsection S/390 and zSeries Options
20291 @cindex S/390 and zSeries Options
20293 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20295 @table @gcctabopt
20296 @item -mhard-float
20297 @itemx -msoft-float
20298 @opindex mhard-float
20299 @opindex msoft-float
20300 Use (do not use) the hardware floating-point instructions and registers
20301 for floating-point operations.  When @option{-msoft-float} is specified,
20302 functions in @file{libgcc.a} are used to perform floating-point
20303 operations.  When @option{-mhard-float} is specified, the compiler
20304 generates IEEE floating-point instructions.  This is the default.
20306 @item -mhard-dfp
20307 @itemx -mno-hard-dfp
20308 @opindex mhard-dfp
20309 @opindex mno-hard-dfp
20310 Use (do not use) the hardware decimal-floating-point instructions for
20311 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20312 specified, functions in @file{libgcc.a} are used to perform
20313 decimal-floating-point operations.  When @option{-mhard-dfp} is
20314 specified, the compiler generates decimal-floating-point hardware
20315 instructions.  This is the default for @option{-march=z9-ec} or higher.
20317 @item -mlong-double-64
20318 @itemx -mlong-double-128
20319 @opindex mlong-double-64
20320 @opindex mlong-double-128
20321 These switches control the size of @code{long double} type. A size
20322 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20323 type. This is the default.
20325 @item -mbackchain
20326 @itemx -mno-backchain
20327 @opindex mbackchain
20328 @opindex mno-backchain
20329 Store (do not store) the address of the caller's frame as backchain pointer
20330 into the callee's stack frame.
20331 A backchain may be needed to allow debugging using tools that do not understand
20332 DWARF 2 call frame information.
20333 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20334 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20335 the backchain is placed into the topmost word of the 96/160 byte register
20336 save area.
20338 In general, code compiled with @option{-mbackchain} is call-compatible with
20339 code compiled with @option{-mmo-backchain}; however, use of the backchain
20340 for debugging purposes usually requires that the whole binary is built with
20341 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20342 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20343 to build a linux kernel use @option{-msoft-float}.
20345 The default is to not maintain the backchain.
20347 @item -mpacked-stack
20348 @itemx -mno-packed-stack
20349 @opindex mpacked-stack
20350 @opindex mno-packed-stack
20351 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20352 specified, the compiler uses the all fields of the 96/160 byte register save
20353 area only for their default purpose; unused fields still take up stack space.
20354 When @option{-mpacked-stack} is specified, register save slots are densely
20355 packed at the top of the register save area; unused space is reused for other
20356 purposes, allowing for more efficient use of the available stack space.
20357 However, when @option{-mbackchain} is also in effect, the topmost word of
20358 the save area is always used to store the backchain, and the return address
20359 register is always saved two words below the backchain.
20361 As long as the stack frame backchain is not used, code generated with
20362 @option{-mpacked-stack} is call-compatible with code generated with
20363 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20364 S/390 or zSeries generated code that uses the stack frame backchain at run
20365 time, not just for debugging purposes.  Such code is not call-compatible
20366 with code compiled with @option{-mpacked-stack}.  Also, note that the
20367 combination of @option{-mbackchain},
20368 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20369 to build a linux kernel use @option{-msoft-float}.
20371 The default is to not use the packed stack layout.
20373 @item -msmall-exec
20374 @itemx -mno-small-exec
20375 @opindex msmall-exec
20376 @opindex mno-small-exec
20377 Generate (or do not generate) code using the @code{bras} instruction
20378 to do subroutine calls.
20379 This only works reliably if the total executable size does not
20380 exceed 64k.  The default is to use the @code{basr} instruction instead,
20381 which does not have this limitation.
20383 @item -m64
20384 @itemx -m31
20385 @opindex m64
20386 @opindex m31
20387 When @option{-m31} is specified, generate code compliant to the
20388 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20389 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20390 particular to generate 64-bit instructions.  For the @samp{s390}
20391 targets, the default is @option{-m31}, while the @samp{s390x}
20392 targets default to @option{-m64}.
20394 @item -mzarch
20395 @itemx -mesa
20396 @opindex mzarch
20397 @opindex mesa
20398 When @option{-mzarch} is specified, generate code using the
20399 instructions available on z/Architecture.
20400 When @option{-mesa} is specified, generate code using the
20401 instructions available on ESA/390.  Note that @option{-mesa} is
20402 not possible with @option{-m64}.
20403 When generating code compliant to the GNU/Linux for S/390 ABI,
20404 the default is @option{-mesa}.  When generating code compliant
20405 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20407 @item -mhtm
20408 @itemx -mno-htm
20409 @opindex mhtm
20410 @opindex mno-htm
20411 The @option{-mhtm} option enables a set of builtins making use of
20412 instructions available with the transactional execution facility
20413 introduced with the IBM zEnterprise EC12 machine generation
20414 @ref{S/390 System z Built-in Functions}.
20415 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
20417 @item -mvx
20418 @itemx -mno-vx
20419 @opindex mvx
20420 @opindex mno-vx
20421 When @option{-mvx} is specified, generate code using the instructions
20422 available with the vector extension facility introduced with the IBM
20423 z13 machine generation.
20424 This option changes the ABI for some vector type values with regard to
20425 alignment and calling conventions.  In case vector type values are
20426 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
20427 command will be added to mark the resulting binary with the ABI used.
20428 @option{-mvx} is enabled by default when using @option{-march=z13}.
20430 @item -mzvector
20431 @itemx -mno-zvector
20432 @opindex mzvector
20433 @opindex mno-zvector
20434 The @option{-mzvector} option enables vector language extensions and
20435 builtins using instructions available with the vector extension
20436 facility introduced with the IBM z13 machine generation.
20437 This option adds support for @samp{vector} to be used as a keyword to
20438 define vector type variables and arguments.  @samp{vector} is only
20439 available when GNU extensions are enabled.  It will not be expanded
20440 when requesting strict standard compliance e.g. with @option{-std=c99}.
20441 In addition to the GCC low-level builtins @option{-mzvector} enables
20442 a set of builtins added for compatibility with Altivec-style
20443 implementations like Power and Cell.  In order to make use of these
20444 builtins the header file @file{vecintrin.h} needs to be included.
20445 @option{-mzvector} is disabled by default.
20447 @item -mmvcle
20448 @itemx -mno-mvcle
20449 @opindex mmvcle
20450 @opindex mno-mvcle
20451 Generate (or do not generate) code using the @code{mvcle} instruction
20452 to perform block moves.  When @option{-mno-mvcle} is specified,
20453 use a @code{mvc} loop instead.  This is the default unless optimizing for
20454 size.
20456 @item -mdebug
20457 @itemx -mno-debug
20458 @opindex mdebug
20459 @opindex mno-debug
20460 Print (or do not print) additional debug information when compiling.
20461 The default is to not print debug information.
20463 @item -march=@var{cpu-type}
20464 @opindex march
20465 Generate code that runs on @var{cpu-type}, which is the name of a system
20466 representing a certain processor type.  Possible values for
20467 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20468 @samp{z9-109}, @samp{z9-ec}, @samp{z10},  @samp{z196}, @samp{zEC12},
20469 and @samp{z13}.
20470 When generating code using the instructions available on z/Architecture,
20471 the default is @option{-march=z900}.  Otherwise, the default is
20472 @option{-march=g5}.
20474 @item -mtune=@var{cpu-type}
20475 @opindex mtune
20476 Tune to @var{cpu-type} everything applicable about the generated code,
20477 except for the ABI and the set of available instructions.
20478 The list of @var{cpu-type} values is the same as for @option{-march}.
20479 The default is the value used for @option{-march}.
20481 @item -mtpf-trace
20482 @itemx -mno-tpf-trace
20483 @opindex mtpf-trace
20484 @opindex mno-tpf-trace
20485 Generate code that adds (does not add) in TPF OS specific branches to trace
20486 routines in the operating system.  This option is off by default, even
20487 when compiling for the TPF OS@.
20489 @item -mfused-madd
20490 @itemx -mno-fused-madd
20491 @opindex mfused-madd
20492 @opindex mno-fused-madd
20493 Generate code that uses (does not use) the floating-point multiply and
20494 accumulate instructions.  These instructions are generated by default if
20495 hardware floating point is used.
20497 @item -mwarn-framesize=@var{framesize}
20498 @opindex mwarn-framesize
20499 Emit a warning if the current function exceeds the given frame size.  Because
20500 this is a compile-time check it doesn't need to be a real problem when the program
20501 runs.  It is intended to identify functions that most probably cause
20502 a stack overflow.  It is useful to be used in an environment with limited stack
20503 size e.g.@: the linux kernel.
20505 @item -mwarn-dynamicstack
20506 @opindex mwarn-dynamicstack
20507 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20508 arrays.  This is generally a bad idea with a limited stack size.
20510 @item -mstack-guard=@var{stack-guard}
20511 @itemx -mstack-size=@var{stack-size}
20512 @opindex mstack-guard
20513 @opindex mstack-size
20514 If these options are provided the S/390 back end emits additional instructions in
20515 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20516 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20517 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20518 the frame size of the compiled function is chosen.
20519 These options are intended to be used to help debugging stack overflow problems.
20520 The additionally emitted code causes only little overhead and hence can also be
20521 used in production-like systems without greater performance degradation.  The given
20522 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20523 @var{stack-guard} without exceeding 64k.
20524 In order to be efficient the extra code makes the assumption that the stack starts
20525 at an address aligned to the value given by @var{stack-size}.
20526 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20528 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20529 @opindex mhotpatch
20530 If the hotpatch option is enabled, a ``hot-patching'' function
20531 prologue is generated for all functions in the compilation unit.
20532 The funtion label is prepended with the given number of two-byte
20533 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20534 the label, 2 * @var{post-halfwords} bytes are appended, using the
20535 largest NOP like instructions the architecture allows (maximum
20536 1000000).
20538 If both arguments are zero, hotpatching is disabled.
20540 This option can be overridden for individual functions with the
20541 @code{hotpatch} attribute.
20542 @end table
20544 @node Score Options
20545 @subsection Score Options
20546 @cindex Score Options
20548 These options are defined for Score implementations:
20550 @table @gcctabopt
20551 @item -meb
20552 @opindex meb
20553 Compile code for big-endian mode.  This is the default.
20555 @item -mel
20556 @opindex mel
20557 Compile code for little-endian mode.
20559 @item -mnhwloop
20560 @opindex mnhwloop
20561 Disable generation of @code{bcnz} instructions.
20563 @item -muls
20564 @opindex muls
20565 Enable generation of unaligned load and store instructions.
20567 @item -mmac
20568 @opindex mmac
20569 Enable the use of multiply-accumulate instructions. Disabled by default.
20571 @item -mscore5
20572 @opindex mscore5
20573 Specify the SCORE5 as the target architecture.
20575 @item -mscore5u
20576 @opindex mscore5u
20577 Specify the SCORE5U of the target architecture.
20579 @item -mscore7
20580 @opindex mscore7
20581 Specify the SCORE7 as the target architecture. This is the default.
20583 @item -mscore7d
20584 @opindex mscore7d
20585 Specify the SCORE7D as the target architecture.
20586 @end table
20588 @node SH Options
20589 @subsection SH Options
20591 These @samp{-m} options are defined for the SH implementations:
20593 @table @gcctabopt
20594 @item -m1
20595 @opindex m1
20596 Generate code for the SH1.
20598 @item -m2
20599 @opindex m2
20600 Generate code for the SH2.
20602 @item -m2e
20603 Generate code for the SH2e.
20605 @item -m2a-nofpu
20606 @opindex m2a-nofpu
20607 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20608 that the floating-point unit is not used.
20610 @item -m2a-single-only
20611 @opindex m2a-single-only
20612 Generate code for the SH2a-FPU, in such a way that no double-precision
20613 floating-point operations are used.
20615 @item -m2a-single
20616 @opindex m2a-single
20617 Generate code for the SH2a-FPU assuming the floating-point unit is in
20618 single-precision mode by default.
20620 @item -m2a
20621 @opindex m2a
20622 Generate code for the SH2a-FPU assuming the floating-point unit is in
20623 double-precision mode by default.
20625 @item -m3
20626 @opindex m3
20627 Generate code for the SH3.
20629 @item -m3e
20630 @opindex m3e
20631 Generate code for the SH3e.
20633 @item -m4-nofpu
20634 @opindex m4-nofpu
20635 Generate code for the SH4 without a floating-point unit.
20637 @item -m4-single-only
20638 @opindex m4-single-only
20639 Generate code for the SH4 with a floating-point unit that only
20640 supports single-precision arithmetic.
20642 @item -m4-single
20643 @opindex m4-single
20644 Generate code for the SH4 assuming the floating-point unit is in
20645 single-precision mode by default.
20647 @item -m4
20648 @opindex m4
20649 Generate code for the SH4.
20651 @item -m4-100
20652 @opindex m4-100
20653 Generate code for SH4-100.
20655 @item -m4-100-nofpu
20656 @opindex m4-100-nofpu
20657 Generate code for SH4-100 in such a way that the
20658 floating-point unit is not used.
20660 @item -m4-100-single
20661 @opindex m4-100-single
20662 Generate code for SH4-100 assuming the floating-point unit is in
20663 single-precision mode by default.
20665 @item -m4-100-single-only
20666 @opindex m4-100-single-only
20667 Generate code for SH4-100 in such a way that no double-precision
20668 floating-point operations are used.
20670 @item -m4-200
20671 @opindex m4-200
20672 Generate code for SH4-200.
20674 @item -m4-200-nofpu
20675 @opindex m4-200-nofpu
20676 Generate code for SH4-200 without in such a way that the
20677 floating-point unit is not used.
20679 @item -m4-200-single
20680 @opindex m4-200-single
20681 Generate code for SH4-200 assuming the floating-point unit is in
20682 single-precision mode by default.
20684 @item -m4-200-single-only
20685 @opindex m4-200-single-only
20686 Generate code for SH4-200 in such a way that no double-precision
20687 floating-point operations are used.
20689 @item -m4-300
20690 @opindex m4-300
20691 Generate code for SH4-300.
20693 @item -m4-300-nofpu
20694 @opindex m4-300-nofpu
20695 Generate code for SH4-300 without in such a way that the
20696 floating-point unit is not used.
20698 @item -m4-300-single
20699 @opindex m4-300-single
20700 Generate code for SH4-300 in such a way that no double-precision
20701 floating-point operations are used.
20703 @item -m4-300-single-only
20704 @opindex m4-300-single-only
20705 Generate code for SH4-300 in such a way that no double-precision
20706 floating-point operations are used.
20708 @item -m4-340
20709 @opindex m4-340
20710 Generate code for SH4-340 (no MMU, no FPU).
20712 @item -m4-500
20713 @opindex m4-500
20714 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20715 assembler.
20717 @item -m4a-nofpu
20718 @opindex m4a-nofpu
20719 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20720 floating-point unit is not used.
20722 @item -m4a-single-only
20723 @opindex m4a-single-only
20724 Generate code for the SH4a, in such a way that no double-precision
20725 floating-point operations are used.
20727 @item -m4a-single
20728 @opindex m4a-single
20729 Generate code for the SH4a assuming the floating-point unit is in
20730 single-precision mode by default.
20732 @item -m4a
20733 @opindex m4a
20734 Generate code for the SH4a.
20736 @item -m4al
20737 @opindex m4al
20738 Same as @option{-m4a-nofpu}, except that it implicitly passes
20739 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20740 instructions at the moment.
20742 @item -m5-32media
20743 @opindex m5-32media
20744 Generate 32-bit code for SHmedia.
20746 @item -m5-32media-nofpu
20747 @opindex m5-32media-nofpu
20748 Generate 32-bit code for SHmedia in such a way that the
20749 floating-point unit is not used.
20751 @item -m5-64media
20752 @opindex m5-64media
20753 Generate 64-bit code for SHmedia.
20755 @item -m5-64media-nofpu
20756 @opindex m5-64media-nofpu
20757 Generate 64-bit code for SHmedia in such a way that the
20758 floating-point unit is not used.
20760 @item -m5-compact
20761 @opindex m5-compact
20762 Generate code for SHcompact.
20764 @item -m5-compact-nofpu
20765 @opindex m5-compact-nofpu
20766 Generate code for SHcompact in such a way that the
20767 floating-point unit is not used.
20769 @item -mb
20770 @opindex mb
20771 Compile code for the processor in big-endian mode.
20773 @item -ml
20774 @opindex ml
20775 Compile code for the processor in little-endian mode.
20777 @item -mdalign
20778 @opindex mdalign
20779 Align doubles at 64-bit boundaries.  Note that this changes the calling
20780 conventions, and thus some functions from the standard C library do
20781 not work unless you recompile it first with @option{-mdalign}.
20783 @item -mrelax
20784 @opindex mrelax
20785 Shorten some address references at link time, when possible; uses the
20786 linker option @option{-relax}.
20788 @item -mbigtable
20789 @opindex mbigtable
20790 Use 32-bit offsets in @code{switch} tables.  The default is to use
20791 16-bit offsets.
20793 @item -mbitops
20794 @opindex mbitops
20795 Enable the use of bit manipulation instructions on SH2A.
20797 @item -mfmovd
20798 @opindex mfmovd
20799 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20800 alignment constraints.
20802 @item -mrenesas
20803 @opindex mrenesas
20804 Comply with the calling conventions defined by Renesas.
20806 @item -mno-renesas
20807 @opindex mno-renesas
20808 Comply with the calling conventions defined for GCC before the Renesas
20809 conventions were available.  This option is the default for all
20810 targets of the SH toolchain.
20812 @item -mnomacsave
20813 @opindex mnomacsave
20814 Mark the @code{MAC} register as call-clobbered, even if
20815 @option{-mrenesas} is given.
20817 @item -mieee
20818 @itemx -mno-ieee
20819 @opindex mieee
20820 @opindex mno-ieee
20821 Control the IEEE compliance of floating-point comparisons, which affects the
20822 handling of cases where the result of a comparison is unordered.  By default
20823 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20824 enabled @option{-mno-ieee} is implicitly set, which results in faster
20825 floating-point greater-equal and less-equal comparisons.  The implcit settings
20826 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20828 @item -minline-ic_invalidate
20829 @opindex minline-ic_invalidate
20830 Inline code to invalidate instruction cache entries after setting up
20831 nested function trampolines.
20832 This option has no effect if @option{-musermode} is in effect and the selected
20833 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20834 instruction.
20835 If the selected code generation option does not allow the use of the @code{icbi}
20836 instruction, and @option{-musermode} is not in effect, the inlined code
20837 manipulates the instruction cache address array directly with an associative
20838 write.  This not only requires privileged mode at run time, but it also
20839 fails if the cache line had been mapped via the TLB and has become unmapped.
20841 @item -misize
20842 @opindex misize
20843 Dump instruction size and location in the assembly code.
20845 @item -mpadstruct
20846 @opindex mpadstruct
20847 This option is deprecated.  It pads structures to multiple of 4 bytes,
20848 which is incompatible with the SH ABI@.
20850 @item -matomic-model=@var{model}
20851 @opindex matomic-model=@var{model}
20852 Sets the model of atomic operations and additional parameters as a comma
20853 separated list.  For details on the atomic built-in functions see
20854 @ref{__atomic Builtins}.  The following models and parameters are supported:
20856 @table @samp
20858 @item none
20859 Disable compiler generated atomic sequences and emit library calls for atomic
20860 operations.  This is the default if the target is not @code{sh*-*-linux*}.
20862 @item soft-gusa
20863 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20864 built-in functions.  The generated atomic sequences require additional support
20865 from the interrupt/exception handling code of the system and are only suitable
20866 for SH3* and SH4* single-core systems.  This option is enabled by default when
20867 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20868 this option also partially utilizes the hardware atomic instructions
20869 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20870 @samp{strict} is specified.  
20872 @item soft-tcb
20873 Generate software atomic sequences that use a variable in the thread control
20874 block.  This is a variation of the gUSA sequences which can also be used on
20875 SH1* and SH2* targets.  The generated atomic sequences require additional
20876 support from the interrupt/exception handling code of the system and are only
20877 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20878 parameter has to be specified as well.
20880 @item soft-imask
20881 Generate software atomic sequences that temporarily disable interrupts by
20882 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20883 in privileged mode and is only suitable for single-core systems.  Additional
20884 support from the interrupt/exception handling code of the system is not
20885 required.  This model is enabled by default when the target is
20886 @code{sh*-*-linux*} and SH1* or SH2*.
20888 @item hard-llcs
20889 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20890 instructions only.  This is only available on SH4A and is suitable for
20891 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20892 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20893 Code compiled with this option is also compatible with other software
20894 atomic model interrupt/exception handling systems if executed on an SH4A
20895 system.  Additional support from the interrupt/exception handling code of the
20896 system is not required for this model.
20898 @item gbr-offset=
20899 This parameter specifies the offset in bytes of the variable in the thread
20900 control block structure that should be used by the generated atomic sequences
20901 when the @samp{soft-tcb} model has been selected.  For other models this
20902 parameter is ignored.  The specified value must be an integer multiple of four
20903 and in the range 0-1020.
20905 @item strict
20906 This parameter prevents mixed usage of multiple atomic models, even if they
20907 are compatible, and makes the compiler generate atomic sequences of the
20908 specified model only.
20910 @end table
20912 @item -mtas
20913 @opindex mtas
20914 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20915 Notice that depending on the particular hardware and software configuration
20916 this can degrade overall performance due to the operand cache line flushes
20917 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20918 processors the @code{tas.b} instruction must be used with caution since it
20919 can result in data corruption for certain cache configurations.
20921 @item -mprefergot
20922 @opindex mprefergot
20923 When generating position-independent code, emit function calls using
20924 the Global Offset Table instead of the Procedure Linkage Table.
20926 @item -musermode
20927 @itemx -mno-usermode
20928 @opindex musermode
20929 @opindex mno-usermode
20930 Don't allow (allow) the compiler generating privileged mode code.  Specifying
20931 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
20932 inlined code would not work in user mode.  @option{-musermode} is the default
20933 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
20934 @option{-musermode} has no effect, since there is no user mode.
20936 @item -multcost=@var{number}
20937 @opindex multcost=@var{number}
20938 Set the cost to assume for a multiply insn.
20940 @item -mdiv=@var{strategy}
20941 @opindex mdiv=@var{strategy}
20942 Set the division strategy to be used for integer division operations.
20943 For SHmedia @var{strategy} can be one of: 
20945 @table @samp
20947 @item fp 
20948 Performs the operation in floating point.  This has a very high latency,
20949 but needs only a few instructions, so it might be a good choice if
20950 your code has enough easily-exploitable ILP to allow the compiler to
20951 schedule the floating-point instructions together with other instructions.
20952 Division by zero causes a floating-point exception.
20954 @item inv
20955 Uses integer operations to calculate the inverse of the divisor,
20956 and then multiplies the dividend with the inverse.  This strategy allows
20957 CSE and hoisting of the inverse calculation.  Division by zero calculates
20958 an unspecified result, but does not trap.
20960 @item inv:minlat
20961 A variant of @samp{inv} where, if no CSE or hoisting opportunities
20962 have been found, or if the entire operation has been hoisted to the same
20963 place, the last stages of the inverse calculation are intertwined with the
20964 final multiply to reduce the overall latency, at the expense of using a few
20965 more instructions, and thus offering fewer scheduling opportunities with
20966 other code.
20968 @item call
20969 Calls a library function that usually implements the @samp{inv:minlat}
20970 strategy.
20971 This gives high code density for @code{m5-*media-nofpu} compilations.
20973 @item call2
20974 Uses a different entry point of the same library function, where it
20975 assumes that a pointer to a lookup table has already been set up, which
20976 exposes the pointer load to CSE and code hoisting optimizations.
20978 @item inv:call
20979 @itemx inv:call2
20980 @itemx inv:fp
20981 Use the @samp{inv} algorithm for initial
20982 code generation, but if the code stays unoptimized, revert to the @samp{call},
20983 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
20984 potentially-trapping side effect of division by zero is carried by a
20985 separate instruction, so it is possible that all the integer instructions
20986 are hoisted out, but the marker for the side effect stays where it is.
20987 A recombination to floating-point operations or a call is not possible
20988 in that case.
20990 @item inv20u
20991 @itemx inv20l
20992 Variants of the @samp{inv:minlat} strategy.  In the case
20993 that the inverse calculation is not separated from the multiply, they speed
20994 up division where the dividend fits into 20 bits (plus sign where applicable)
20995 by inserting a test to skip a number of operations in this case; this test
20996 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
20997 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
20999 @end table
21001 For targets other than SHmedia @var{strategy} can be one of:
21003 @table @samp
21005 @item call-div1
21006 Calls a library function that uses the single-step division instruction
21007 @code{div1} to perform the operation.  Division by zero calculates an
21008 unspecified result and does not trap.  This is the default except for SH4,
21009 SH2A and SHcompact.
21011 @item call-fp
21012 Calls a library function that performs the operation in double precision
21013 floating point.  Division by zero causes a floating-point exception.  This is
21014 the default for SHcompact with FPU.  Specifying this for targets that do not
21015 have a double precision FPU defaults to @code{call-div1}.
21017 @item call-table
21018 Calls a library function that uses a lookup table for small divisors and
21019 the @code{div1} instruction with case distinction for larger divisors.  Division
21020 by zero calculates an unspecified result and does not trap.  This is the default
21021 for SH4.  Specifying this for targets that do not have dynamic shift
21022 instructions defaults to @code{call-div1}.
21024 @end table
21026 When a division strategy has not been specified the default strategy is
21027 selected based on the current target.  For SH2A the default strategy is to
21028 use the @code{divs} and @code{divu} instructions instead of library function
21029 calls.
21031 @item -maccumulate-outgoing-args
21032 @opindex maccumulate-outgoing-args
21033 Reserve space once for outgoing arguments in the function prologue rather
21034 than around each call.  Generally beneficial for performance and size.  Also
21035 needed for unwinding to avoid changing the stack frame around conditional code.
21037 @item -mdivsi3_libfunc=@var{name}
21038 @opindex mdivsi3_libfunc=@var{name}
21039 Set the name of the library function used for 32-bit signed division to
21040 @var{name}.
21041 This only affects the name used in the @samp{call} and @samp{inv:call}
21042 division strategies, and the compiler still expects the same
21043 sets of input/output/clobbered registers as if this option were not present.
21045 @item -mfixed-range=@var{register-range}
21046 @opindex mfixed-range
21047 Generate code treating the given register range as fixed registers.
21048 A fixed register is one that the register allocator can not use.  This is
21049 useful when compiling kernel code.  A register range is specified as
21050 two registers separated by a dash.  Multiple register ranges can be
21051 specified separated by a comma.
21053 @item -mindexed-addressing
21054 @opindex mindexed-addressing
21055 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21056 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21057 semantics for the indexed addressing mode.  The architecture allows the
21058 implementation of processors with 64-bit MMU, which the OS could use to
21059 get 32-bit addressing, but since no current hardware implementation supports
21060 this or any other way to make the indexed addressing mode safe to use in
21061 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21063 @item -mgettrcost=@var{number}
21064 @opindex mgettrcost=@var{number}
21065 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21066 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21068 @item -mpt-fixed
21069 @opindex mpt-fixed
21070 Assume @code{pt*} instructions won't trap.  This generally generates
21071 better-scheduled code, but is unsafe on current hardware.
21072 The current architecture
21073 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21074 anded with 3 is 3.
21075 This has the unintentional effect of making it unsafe to schedule these
21076 instructions before a branch, or hoist them out of a loop.  For example,
21077 @code{__do_global_ctors}, a part of @file{libgcc}
21078 that runs constructors at program
21079 startup, calls functions in a list which is delimited by @minus{}1.  With the
21080 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21081 That means that all the constructors run a bit more quickly, but when
21082 the loop comes to the end of the list, the program crashes because @code{ptabs}
21083 loads @minus{}1 into a target register.  
21085 Since this option is unsafe for any
21086 hardware implementing the current architecture specification, the default
21087 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21088 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21089 this deters register allocation from using target registers for storing
21090 ordinary integers.
21092 @item -minvalid-symbols
21093 @opindex minvalid-symbols
21094 Assume symbols might be invalid.  Ordinary function symbols generated by
21095 the compiler are always valid to load with
21096 @code{movi}/@code{shori}/@code{ptabs} or
21097 @code{movi}/@code{shori}/@code{ptrel},
21098 but with assembler and/or linker tricks it is possible
21099 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21100 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21101 It prevents cross-basic-block CSE, hoisting and most scheduling
21102 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21104 @item -mbranch-cost=@var{num}
21105 @opindex mbranch-cost=@var{num}
21106 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21107 make the compiler try to generate more branch-free code if possible.  
21108 If not specified the value is selected depending on the processor type that
21109 is being compiled for.
21111 @item -mzdcbranch
21112 @itemx -mno-zdcbranch
21113 @opindex mzdcbranch
21114 @opindex mno-zdcbranch
21115 Assume (do not assume) that zero displacement conditional branch instructions
21116 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21117 compiler prefers zero displacement branch code sequences.  This is
21118 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21119 disabled by specifying @option{-mno-zdcbranch}.
21121 @item -mcbranch-force-delay-slot
21122 @opindex mcbranch-force-delay-slot
21123 Force the usage of delay slots for conditional branches, which stuffs the delay
21124 slot with a @code{nop} if a suitable instruction can't be found.  By default
21125 this option is disabled.  It can be enabled to work around hardware bugs as
21126 found in the original SH7055.
21128 @item -mfused-madd
21129 @itemx -mno-fused-madd
21130 @opindex mfused-madd
21131 @opindex mno-fused-madd
21132 Generate code that uses (does not use) the floating-point multiply and
21133 accumulate instructions.  These instructions are generated by default
21134 if hardware floating point is used.  The machine-dependent
21135 @option{-mfused-madd} option is now mapped to the machine-independent
21136 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21137 mapped to @option{-ffp-contract=off}.
21139 @item -mfsca
21140 @itemx -mno-fsca
21141 @opindex mfsca
21142 @opindex mno-fsca
21143 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21144 and cosine approximations.  The option @option{-mfsca} must be used in
21145 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21146 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21147 approximations even if @option{-funsafe-math-optimizations} is in effect.
21149 @item -mfsrra
21150 @itemx -mno-fsrra
21151 @opindex mfsrra
21152 @opindex mno-fsrra
21153 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21154 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21155 in combination with @option{-funsafe-math-optimizations} and
21156 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21157 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21158 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21159 in effect.
21161 @item -mpretend-cmove
21162 @opindex mpretend-cmove
21163 Prefer zero-displacement conditional branches for conditional move instruction
21164 patterns.  This can result in faster code on the SH4 processor.
21166 @end table
21168 @node Solaris 2 Options
21169 @subsection Solaris 2 Options
21170 @cindex Solaris 2 options
21172 These @samp{-m} options are supported on Solaris 2:
21174 @table @gcctabopt
21175 @item -mclear-hwcap
21176 @opindex mclear-hwcap
21177 @option{-mclear-hwcap} tells the compiler to remove the hardware
21178 capabilities generated by the Solaris assembler.  This is only necessary
21179 when object files use ISA extensions not supported by the current
21180 machine, but check at runtime whether or not to use them.
21182 @item -mimpure-text
21183 @opindex mimpure-text
21184 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21185 the compiler to not pass @option{-z text} to the linker when linking a
21186 shared object.  Using this option, you can link position-dependent
21187 code into a shared object.
21189 @option{-mimpure-text} suppresses the ``relocations remain against
21190 allocatable but non-writable sections'' linker error message.
21191 However, the necessary relocations trigger copy-on-write, and the
21192 shared object is not actually shared across processes.  Instead of
21193 using @option{-mimpure-text}, you should compile all source code with
21194 @option{-fpic} or @option{-fPIC}.
21196 @end table
21198 These switches are supported in addition to the above on Solaris 2:
21200 @table @gcctabopt
21201 @item -pthreads
21202 @opindex pthreads
21203 Add support for multithreading using the POSIX threads library.  This
21204 option sets flags for both the preprocessor and linker.  This option does
21205 not affect the thread safety of object code produced  by the compiler or
21206 that of libraries supplied with it.
21208 @item -pthread
21209 @opindex pthread
21210 This is a synonym for @option{-pthreads}.
21211 @end table
21213 @node SPARC Options
21214 @subsection SPARC Options
21215 @cindex SPARC options
21217 These @samp{-m} options are supported on the SPARC:
21219 @table @gcctabopt
21220 @item -mno-app-regs
21221 @itemx -mapp-regs
21222 @opindex mno-app-regs
21223 @opindex mapp-regs
21224 Specify @option{-mapp-regs} to generate output using the global registers
21225 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21226 global register 1, each global register 2 through 4 is then treated as an
21227 allocable register that is clobbered by function calls.  This is the default.
21229 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21230 specify @option{-mno-app-regs}.  You should compile libraries and system
21231 software with this option.
21233 @item -mflat
21234 @itemx -mno-flat
21235 @opindex mflat
21236 @opindex mno-flat
21237 With @option{-mflat}, the compiler does not generate save/restore instructions
21238 and uses a ``flat'' or single register window model.  This model is compatible
21239 with the regular register window model.  The local registers and the input
21240 registers (0--5) are still treated as ``call-saved'' registers and are
21241 saved on the stack as needed.
21243 With @option{-mno-flat} (the default), the compiler generates save/restore
21244 instructions (except for leaf functions).  This is the normal operating mode.
21246 @item -mfpu
21247 @itemx -mhard-float
21248 @opindex mfpu
21249 @opindex mhard-float
21250 Generate output containing floating-point instructions.  This is the
21251 default.
21253 @item -mno-fpu
21254 @itemx -msoft-float
21255 @opindex mno-fpu
21256 @opindex msoft-float
21257 Generate output containing library calls for floating point.
21258 @strong{Warning:} the requisite libraries are not available for all SPARC
21259 targets.  Normally the facilities of the machine's usual C compiler are
21260 used, but this cannot be done directly in cross-compilation.  You must make
21261 your own arrangements to provide suitable library functions for
21262 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21263 @samp{sparclite-*-*} do provide software floating-point support.
21265 @option{-msoft-float} changes the calling convention in the output file;
21266 therefore, it is only useful if you compile @emph{all} of a program with
21267 this option.  In particular, you need to compile @file{libgcc.a}, the
21268 library that comes with GCC, with @option{-msoft-float} in order for
21269 this to work.
21271 @item -mhard-quad-float
21272 @opindex mhard-quad-float
21273 Generate output containing quad-word (long double) floating-point
21274 instructions.
21276 @item -msoft-quad-float
21277 @opindex msoft-quad-float
21278 Generate output containing library calls for quad-word (long double)
21279 floating-point instructions.  The functions called are those specified
21280 in the SPARC ABI@.  This is the default.
21282 As of this writing, there are no SPARC implementations that have hardware
21283 support for the quad-word floating-point instructions.  They all invoke
21284 a trap handler for one of these instructions, and then the trap handler
21285 emulates the effect of the instruction.  Because of the trap handler overhead,
21286 this is much slower than calling the ABI library routines.  Thus the
21287 @option{-msoft-quad-float} option is the default.
21289 @item -mno-unaligned-doubles
21290 @itemx -munaligned-doubles
21291 @opindex mno-unaligned-doubles
21292 @opindex munaligned-doubles
21293 Assume that doubles have 8-byte alignment.  This is the default.
21295 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21296 alignment only if they are contained in another type, or if they have an
21297 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21298 Specifying this option avoids some rare compatibility problems with code
21299 generated by other compilers.  It is not the default because it results
21300 in a performance loss, especially for floating-point code.
21302 @item -muser-mode
21303 @itemx -mno-user-mode
21304 @opindex muser-mode
21305 @opindex mno-user-mode
21306 Do not generate code that can only run in supervisor mode.  This is relevant
21307 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21308 default is @option{-mno-user-mode}.
21310 @item -mno-faster-structs
21311 @itemx -mfaster-structs
21312 @opindex mno-faster-structs
21313 @opindex mfaster-structs
21314 With @option{-mfaster-structs}, the compiler assumes that structures
21315 should have 8-byte alignment.  This enables the use of pairs of
21316 @code{ldd} and @code{std} instructions for copies in structure
21317 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21318 However, the use of this changed alignment directly violates the SPARC
21319 ABI@.  Thus, it's intended only for use on targets where the developer
21320 acknowledges that their resulting code is not directly in line with
21321 the rules of the ABI@.
21323 @item -mcpu=@var{cpu_type}
21324 @opindex mcpu
21325 Set the instruction set, register set, and instruction scheduling parameters
21326 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21327 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21328 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21329 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21330 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21331 @samp{niagara3} and @samp{niagara4}.
21333 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21334 which selects the best architecture option for the host processor.
21335 @option{-mcpu=native} has no effect if GCC does not recognize
21336 the processor.
21338 Default instruction scheduling parameters are used for values that select
21339 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21340 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21342 Here is a list of each supported architecture and their supported
21343 implementations.
21345 @table @asis
21346 @item v7
21347 cypress, leon3v7
21349 @item v8
21350 supersparc, hypersparc, leon, leon3
21352 @item sparclite
21353 f930, f934, sparclite86x
21355 @item sparclet
21356 tsc701
21358 @item v9
21359 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21360 @end table
21362 By default (unless configured otherwise), GCC generates code for the V7
21363 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21364 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21365 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21366 SPARCStation 1, 2, IPX etc.
21368 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21369 architecture.  The only difference from V7 code is that the compiler emits
21370 the integer multiply and integer divide instructions which exist in SPARC-V8
21371 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21372 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21373 2000 series.
21375 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21376 the SPARC architecture.  This adds the integer multiply, integer divide step
21377 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21378 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21379 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21380 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21381 MB86934 chip, which is the more recent SPARClite with FPU@.
21383 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21384 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21385 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21386 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21387 optimizes it for the TEMIC SPARClet chip.
21389 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21390 architecture.  This adds 64-bit integer and floating-point move instructions,
21391 3 additional floating-point condition code registers and conditional move
21392 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21393 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21394 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21395 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21396 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21397 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21398 additionally optimizes it for Sun UltraSPARC T2 chips. With
21399 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21400 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21401 additionally optimizes it for Sun UltraSPARC T4 chips.
21403 @item -mtune=@var{cpu_type}
21404 @opindex mtune
21405 Set the instruction scheduling parameters for machine type
21406 @var{cpu_type}, but do not set the instruction set or register set that the
21407 option @option{-mcpu=@var{cpu_type}} does.
21409 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21410 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21411 that select a particular CPU implementation.  Those are @samp{cypress},
21412 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21413 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21414 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21415 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21416 toolchains, @samp{native} can also be used.
21418 @item -mv8plus
21419 @itemx -mno-v8plus
21420 @opindex mv8plus
21421 @opindex mno-v8plus
21422 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21423 difference from the V8 ABI is that the global and out registers are
21424 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21425 mode for all SPARC-V9 processors.
21427 @item -mvis
21428 @itemx -mno-vis
21429 @opindex mvis
21430 @opindex mno-vis
21431 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21432 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21434 @item -mvis2
21435 @itemx -mno-vis2
21436 @opindex mvis2
21437 @opindex mno-vis2
21438 With @option{-mvis2}, GCC generates code that takes advantage of
21439 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21440 default is @option{-mvis2} when targeting a cpu that supports such
21441 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21442 also sets @option{-mvis}.
21444 @item -mvis3
21445 @itemx -mno-vis3
21446 @opindex mvis3
21447 @opindex mno-vis3
21448 With @option{-mvis3}, GCC generates code that takes advantage of
21449 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21450 default is @option{-mvis3} when targeting a cpu that supports such
21451 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21452 also sets @option{-mvis2} and @option{-mvis}.
21454 @item -mcbcond
21455 @itemx -mno-cbcond
21456 @opindex mcbcond
21457 @opindex mno-cbcond
21458 With @option{-mcbcond}, GCC generates code that takes advantage of
21459 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21460 The default is @option{-mcbcond} when targeting a cpu that supports such
21461 instructions, such as niagara-4 and later.
21463 @item -mpopc
21464 @itemx -mno-popc
21465 @opindex mpopc
21466 @opindex mno-popc
21467 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21468 population count instruction.  The default is @option{-mpopc}
21469 when targeting a cpu that supports such instructions, such as Niagara-2 and
21470 later.
21472 @item -mfmaf
21473 @itemx -mno-fmaf
21474 @opindex mfmaf
21475 @opindex mno-fmaf
21476 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21477 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21478 when targeting a cpu that supports such instructions, such as Niagara-3 and
21479 later.
21481 @item -mfix-at697f
21482 @opindex mfix-at697f
21483 Enable the documented workaround for the single erratum of the Atmel AT697F
21484 processor (which corresponds to erratum #13 of the AT697E processor).
21486 @item -mfix-ut699
21487 @opindex mfix-ut699
21488 Enable the documented workarounds for the floating-point errata and the data
21489 cache nullify errata of the UT699 processor.
21490 @end table
21492 These @samp{-m} options are supported in addition to the above
21493 on SPARC-V9 processors in 64-bit environments:
21495 @table @gcctabopt
21496 @item -m32
21497 @itemx -m64
21498 @opindex m32
21499 @opindex m64
21500 Generate code for a 32-bit or 64-bit environment.
21501 The 32-bit environment sets int, long and pointer to 32 bits.
21502 The 64-bit environment sets int to 32 bits and long and pointer
21503 to 64 bits.
21505 @item -mcmodel=@var{which}
21506 @opindex mcmodel
21507 Set the code model to one of
21509 @table @samp
21510 @item medlow
21511 The Medium/Low code model: 64-bit addresses, programs
21512 must be linked in the low 32 bits of memory.  Programs can be statically
21513 or dynamically linked.
21515 @item medmid
21516 The Medium/Middle code model: 64-bit addresses, programs
21517 must be linked in the low 44 bits of memory, the text and data segments must
21518 be less than 2GB in size and the data segment must be located within 2GB of
21519 the text segment.
21521 @item medany
21522 The Medium/Anywhere code model: 64-bit addresses, programs
21523 may be linked anywhere in memory, the text and data segments must be less
21524 than 2GB in size and the data segment must be located within 2GB of the
21525 text segment.
21527 @item embmedany
21528 The Medium/Anywhere code model for embedded systems:
21529 64-bit addresses, the text and data segments must be less than 2GB in
21530 size, both starting anywhere in memory (determined at link time).  The
21531 global register %g4 points to the base of the data segment.  Programs
21532 are statically linked and PIC is not supported.
21533 @end table
21535 @item -mmemory-model=@var{mem-model}
21536 @opindex mmemory-model
21537 Set the memory model in force on the processor to one of
21539 @table @samp
21540 @item default
21541 The default memory model for the processor and operating system.
21543 @item rmo
21544 Relaxed Memory Order
21546 @item pso
21547 Partial Store Order
21549 @item tso
21550 Total Store Order
21552 @item sc
21553 Sequential Consistency
21554 @end table
21556 These memory models are formally defined in Appendix D of the Sparc V9
21557 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21559 @item -mstack-bias
21560 @itemx -mno-stack-bias
21561 @opindex mstack-bias
21562 @opindex mno-stack-bias
21563 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21564 frame pointer if present, are offset by @minus{}2047 which must be added back
21565 when making stack frame references.  This is the default in 64-bit mode.
21566 Otherwise, assume no such offset is present.
21567 @end table
21569 @node SPU Options
21570 @subsection SPU Options
21571 @cindex SPU options
21573 These @samp{-m} options are supported on the SPU:
21575 @table @gcctabopt
21576 @item -mwarn-reloc
21577 @itemx -merror-reloc
21578 @opindex mwarn-reloc
21579 @opindex merror-reloc
21581 The loader for SPU does not handle dynamic relocations.  By default, GCC
21582 gives an error when it generates code that requires a dynamic
21583 relocation.  @option{-mno-error-reloc} disables the error,
21584 @option{-mwarn-reloc} generates a warning instead.
21586 @item -msafe-dma
21587 @itemx -munsafe-dma
21588 @opindex msafe-dma
21589 @opindex munsafe-dma
21591 Instructions that initiate or test completion of DMA must not be
21592 reordered with respect to loads and stores of the memory that is being
21593 accessed.
21594 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21595 memory accesses, but that can lead to inefficient code in places where the
21596 memory is known to not change.  Rather than mark the memory as volatile,
21597 you can use @option{-msafe-dma} to tell the compiler to treat
21598 the DMA instructions as potentially affecting all memory.  
21600 @item -mbranch-hints
21601 @opindex mbranch-hints
21603 By default, GCC generates a branch hint instruction to avoid
21604 pipeline stalls for always-taken or probably-taken branches.  A hint
21605 is not generated closer than 8 instructions away from its branch.
21606 There is little reason to disable them, except for debugging purposes,
21607 or to make an object a little bit smaller.
21609 @item -msmall-mem
21610 @itemx -mlarge-mem
21611 @opindex msmall-mem
21612 @opindex mlarge-mem
21614 By default, GCC generates code assuming that addresses are never larger
21615 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21616 a full 32-bit address.
21618 @item -mstdmain
21619 @opindex mstdmain
21621 By default, GCC links against startup code that assumes the SPU-style
21622 main function interface (which has an unconventional parameter list).
21623 With @option{-mstdmain}, GCC links your program against startup
21624 code that assumes a C99-style interface to @code{main}, including a
21625 local copy of @code{argv} strings.
21627 @item -mfixed-range=@var{register-range}
21628 @opindex mfixed-range
21629 Generate code treating the given register range as fixed registers.
21630 A fixed register is one that the register allocator cannot use.  This is
21631 useful when compiling kernel code.  A register range is specified as
21632 two registers separated by a dash.  Multiple register ranges can be
21633 specified separated by a comma.
21635 @item -mea32
21636 @itemx -mea64
21637 @opindex mea32
21638 @opindex mea64
21639 Compile code assuming that pointers to the PPU address space accessed
21640 via the @code{__ea} named address space qualifier are either 32 or 64
21641 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21642 all object code in an executable must be compiled with the same setting.
21644 @item -maddress-space-conversion
21645 @itemx -mno-address-space-conversion
21646 @opindex maddress-space-conversion
21647 @opindex mno-address-space-conversion
21648 Allow/disallow treating the @code{__ea} address space as superset
21649 of the generic address space.  This enables explicit type casts
21650 between @code{__ea} and generic pointer as well as implicit
21651 conversions of generic pointers to @code{__ea} pointers.  The
21652 default is to allow address space pointer conversions.
21654 @item -mcache-size=@var{cache-size}
21655 @opindex mcache-size
21656 This option controls the version of libgcc that the compiler links to an
21657 executable and selects a software-managed cache for accessing variables
21658 in the @code{__ea} address space with a particular cache size.  Possible
21659 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21660 and @samp{128}.  The default cache size is 64KB.
21662 @item -matomic-updates
21663 @itemx -mno-atomic-updates
21664 @opindex matomic-updates
21665 @opindex mno-atomic-updates
21666 This option controls the version of libgcc that the compiler links to an
21667 executable and selects whether atomic updates to the software-managed
21668 cache of PPU-side variables are used.  If you use atomic updates, changes
21669 to a PPU variable from SPU code using the @code{__ea} named address space
21670 qualifier do not interfere with changes to other PPU variables residing
21671 in the same cache line from PPU code.  If you do not use atomic updates,
21672 such interference may occur; however, writing back cache lines is
21673 more efficient.  The default behavior is to use atomic updates.
21675 @item -mdual-nops
21676 @itemx -mdual-nops=@var{n}
21677 @opindex mdual-nops
21678 By default, GCC inserts nops to increase dual issue when it expects
21679 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21680 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21681 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21683 @item -mhint-max-nops=@var{n}
21684 @opindex mhint-max-nops
21685 Maximum number of nops to insert for a branch hint.  A branch hint must
21686 be at least 8 instructions away from the branch it is affecting.  GCC
21687 inserts up to @var{n} nops to enforce this, otherwise it does not
21688 generate the branch hint.
21690 @item -mhint-max-distance=@var{n}
21691 @opindex mhint-max-distance
21692 The encoding of the branch hint instruction limits the hint to be within
21693 256 instructions of the branch it is affecting.  By default, GCC makes
21694 sure it is within 125.
21696 @item -msafe-hints
21697 @opindex msafe-hints
21698 Work around a hardware bug that causes the SPU to stall indefinitely.
21699 By default, GCC inserts the @code{hbrp} instruction to make sure
21700 this stall won't happen.
21702 @end table
21704 @node System V Options
21705 @subsection Options for System V
21707 These additional options are available on System V Release 4 for
21708 compatibility with other compilers on those systems:
21710 @table @gcctabopt
21711 @item -G
21712 @opindex G
21713 Create a shared object.
21714 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21716 @item -Qy
21717 @opindex Qy
21718 Identify the versions of each tool used by the compiler, in a
21719 @code{.ident} assembler directive in the output.
21721 @item -Qn
21722 @opindex Qn
21723 Refrain from adding @code{.ident} directives to the output file (this is
21724 the default).
21726 @item -YP,@var{dirs}
21727 @opindex YP
21728 Search the directories @var{dirs}, and no others, for libraries
21729 specified with @option{-l}.
21731 @item -Ym,@var{dir}
21732 @opindex Ym
21733 Look in the directory @var{dir} to find the M4 preprocessor.
21734 The assembler uses this option.
21735 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21736 @c the generic assembler that comes with Solaris takes just -Ym.
21737 @end table
21739 @node TILE-Gx Options
21740 @subsection TILE-Gx Options
21741 @cindex TILE-Gx options
21743 These @samp{-m} options are supported on the TILE-Gx:
21745 @table @gcctabopt
21746 @item -mcmodel=small
21747 @opindex mcmodel=small
21748 Generate code for the small model.  The distance for direct calls is
21749 limited to 500M in either direction.  PC-relative addresses are 32
21750 bits.  Absolute addresses support the full address range.
21752 @item -mcmodel=large
21753 @opindex mcmodel=large
21754 Generate code for the large model.  There is no limitation on call
21755 distance, pc-relative addresses, or absolute addresses.
21757 @item -mcpu=@var{name}
21758 @opindex mcpu
21759 Selects the type of CPU to be targeted.  Currently the only supported
21760 type is @samp{tilegx}.
21762 @item -m32
21763 @itemx -m64
21764 @opindex m32
21765 @opindex m64
21766 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21767 environment sets int, long, and pointer to 32 bits.  The 64-bit
21768 environment sets int to 32 bits and long and pointer to 64 bits.
21770 @item -mbig-endian
21771 @itemx -mlittle-endian
21772 @opindex mbig-endian
21773 @opindex mlittle-endian
21774 Generate code in big/little endian mode, respectively.
21775 @end table
21777 @node TILEPro Options
21778 @subsection TILEPro Options
21779 @cindex TILEPro options
21781 These @samp{-m} options are supported on the TILEPro:
21783 @table @gcctabopt
21784 @item -mcpu=@var{name}
21785 @opindex mcpu
21786 Selects the type of CPU to be targeted.  Currently the only supported
21787 type is @samp{tilepro}.
21789 @item -m32
21790 @opindex m32
21791 Generate code for a 32-bit environment, which sets int, long, and
21792 pointer to 32 bits.  This is the only supported behavior so the flag
21793 is essentially ignored.
21794 @end table
21796 @node V850 Options
21797 @subsection V850 Options
21798 @cindex V850 Options
21800 These @samp{-m} options are defined for V850 implementations:
21802 @table @gcctabopt
21803 @item -mlong-calls
21804 @itemx -mno-long-calls
21805 @opindex mlong-calls
21806 @opindex mno-long-calls
21807 Treat all calls as being far away (near).  If calls are assumed to be
21808 far away, the compiler always loads the function's address into a
21809 register, and calls indirect through the pointer.
21811 @item -mno-ep
21812 @itemx -mep
21813 @opindex mno-ep
21814 @opindex mep
21815 Do not optimize (do optimize) basic blocks that use the same index
21816 pointer 4 or more times to copy pointer into the @code{ep} register, and
21817 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21818 option is on by default if you optimize.
21820 @item -mno-prolog-function
21821 @itemx -mprolog-function
21822 @opindex mno-prolog-function
21823 @opindex mprolog-function
21824 Do not use (do use) external functions to save and restore registers
21825 at the prologue and epilogue of a function.  The external functions
21826 are slower, but use less code space if more than one function saves
21827 the same number of registers.  The @option{-mprolog-function} option
21828 is on by default if you optimize.
21830 @item -mspace
21831 @opindex mspace
21832 Try to make the code as small as possible.  At present, this just turns
21833 on the @option{-mep} and @option{-mprolog-function} options.
21835 @item -mtda=@var{n}
21836 @opindex mtda
21837 Put static or global variables whose size is @var{n} bytes or less into
21838 the tiny data area that register @code{ep} points to.  The tiny data
21839 area can hold up to 256 bytes in total (128 bytes for byte references).
21841 @item -msda=@var{n}
21842 @opindex msda
21843 Put static or global variables whose size is @var{n} bytes or less into
21844 the small data area that register @code{gp} points to.  The small data
21845 area can hold up to 64 kilobytes.
21847 @item -mzda=@var{n}
21848 @opindex mzda
21849 Put static or global variables whose size is @var{n} bytes or less into
21850 the first 32 kilobytes of memory.
21852 @item -mv850
21853 @opindex mv850
21854 Specify that the target processor is the V850.
21856 @item -mv850e3v5
21857 @opindex mv850e3v5
21858 Specify that the target processor is the V850E3V5.  The preprocessor
21859 constant @code{__v850e3v5__} is defined if this option is used.
21861 @item -mv850e2v4
21862 @opindex mv850e2v4
21863 Specify that the target processor is the V850E3V5.  This is an alias for
21864 the @option{-mv850e3v5} option.
21866 @item -mv850e2v3
21867 @opindex mv850e2v3
21868 Specify that the target processor is the V850E2V3.  The preprocessor
21869 constant @code{__v850e2v3__} is defined if this option is used.
21871 @item -mv850e2
21872 @opindex mv850e2
21873 Specify that the target processor is the V850E2.  The preprocessor
21874 constant @code{__v850e2__} is defined if this option is used.
21876 @item -mv850e1
21877 @opindex mv850e1
21878 Specify that the target processor is the V850E1.  The preprocessor
21879 constants @code{__v850e1__} and @code{__v850e__} are defined if
21880 this option is used.
21882 @item -mv850es
21883 @opindex mv850es
21884 Specify that the target processor is the V850ES.  This is an alias for
21885 the @option{-mv850e1} option.
21887 @item -mv850e
21888 @opindex mv850e
21889 Specify that the target processor is the V850E@.  The preprocessor
21890 constant @code{__v850e__} is defined if this option is used.
21892 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21893 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21894 are defined then a default target processor is chosen and the
21895 relevant @samp{__v850*__} preprocessor constant is defined.
21897 The preprocessor constants @code{__v850} and @code{__v851__} are always
21898 defined, regardless of which processor variant is the target.
21900 @item -mdisable-callt
21901 @itemx -mno-disable-callt
21902 @opindex mdisable-callt
21903 @opindex mno-disable-callt
21904 This option suppresses generation of the @code{CALLT} instruction for the
21905 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21906 architecture.
21908 This option is enabled by default when the RH850 ABI is
21909 in use (see @option{-mrh850-abi}), and disabled by default when the
21910 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21911 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
21913 @item -mrelax
21914 @itemx -mno-relax
21915 @opindex mrelax
21916 @opindex mno-relax
21917 Pass on (or do not pass on) the @option{-mrelax} command-line option
21918 to the assembler.
21920 @item -mlong-jumps
21921 @itemx -mno-long-jumps
21922 @opindex mlong-jumps
21923 @opindex mno-long-jumps
21924 Disable (or re-enable) the generation of PC-relative jump instructions.
21926 @item -msoft-float
21927 @itemx -mhard-float
21928 @opindex msoft-float
21929 @opindex mhard-float
21930 Disable (or re-enable) the generation of hardware floating point
21931 instructions.  This option is only significant when the target
21932 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21933 instructions are being generated then the C preprocessor symbol
21934 @code{__FPU_OK__} is defined, otherwise the symbol
21935 @code{__NO_FPU__} is defined.
21937 @item -mloop
21938 @opindex mloop
21939 Enables the use of the e3v5 LOOP instruction.  The use of this
21940 instruction is not enabled by default when the e3v5 architecture is
21941 selected because its use is still experimental.
21943 @item -mrh850-abi
21944 @itemx -mghs
21945 @opindex mrh850-abi
21946 @opindex mghs
21947 Enables support for the RH850 version of the V850 ABI.  This is the
21948 default.  With this version of the ABI the following rules apply:
21950 @itemize
21951 @item
21952 Integer sized structures and unions are returned via a memory pointer
21953 rather than a register.
21955 @item
21956 Large structures and unions (more than 8 bytes in size) are passed by
21957 value.
21959 @item
21960 Functions are aligned to 16-bit boundaries.
21962 @item
21963 The @option{-m8byte-align} command-line option is supported.
21965 @item
21966 The @option{-mdisable-callt} command-line option is enabled by
21967 default.  The @option{-mno-disable-callt} command-line option is not
21968 supported.
21969 @end itemize
21971 When this version of the ABI is enabled the C preprocessor symbol
21972 @code{__V850_RH850_ABI__} is defined.
21974 @item -mgcc-abi
21975 @opindex mgcc-abi
21976 Enables support for the old GCC version of the V850 ABI.  With this
21977 version of the ABI the following rules apply:
21979 @itemize
21980 @item
21981 Integer sized structures and unions are returned in register @code{r10}.
21983 @item
21984 Large structures and unions (more than 8 bytes in size) are passed by
21985 reference.
21987 @item
21988 Functions are aligned to 32-bit boundaries, unless optimizing for
21989 size.
21991 @item
21992 The @option{-m8byte-align} command-line option is not supported.
21994 @item
21995 The @option{-mdisable-callt} command-line option is supported but not
21996 enabled by default.
21997 @end itemize
21999 When this version of the ABI is enabled the C preprocessor symbol
22000 @code{__V850_GCC_ABI__} is defined.
22002 @item -m8byte-align
22003 @itemx -mno-8byte-align
22004 @opindex m8byte-align
22005 @opindex mno-8byte-align
22006 Enables support for @code{double} and @code{long long} types to be
22007 aligned on 8-byte boundaries.  The default is to restrict the
22008 alignment of all objects to at most 4-bytes.  When
22009 @option{-m8byte-align} is in effect the C preprocessor symbol
22010 @code{__V850_8BYTE_ALIGN__} is defined.
22012 @item -mbig-switch
22013 @opindex mbig-switch
22014 Generate code suitable for big switch tables.  Use this option only if
22015 the assembler/linker complain about out of range branches within a switch
22016 table.
22018 @item -mapp-regs
22019 @opindex mapp-regs
22020 This option causes r2 and r5 to be used in the code generated by
22021 the compiler.  This setting is the default.
22023 @item -mno-app-regs
22024 @opindex mno-app-regs
22025 This option causes r2 and r5 to be treated as fixed registers.
22027 @end table
22029 @node VAX Options
22030 @subsection VAX Options
22031 @cindex VAX options
22033 These @samp{-m} options are defined for the VAX:
22035 @table @gcctabopt
22036 @item -munix
22037 @opindex munix
22038 Do not output certain jump instructions (@code{aobleq} and so on)
22039 that the Unix assembler for the VAX cannot handle across long
22040 ranges.
22042 @item -mgnu
22043 @opindex mgnu
22044 Do output those jump instructions, on the assumption that the
22045 GNU assembler is being used.
22047 @item -mg
22048 @opindex mg
22049 Output code for G-format floating-point numbers instead of D-format.
22050 @end table
22052 @node Visium Options
22053 @subsection Visium Options
22054 @cindex Visium options
22056 @table @gcctabopt
22058 @item -mdebug
22059 @opindex mdebug
22060 A program which performs file I/O and is destined to run on an MCM target
22061 should be linked with this option.  It causes the libraries libc.a and
22062 libdebug.a to be linked.  The program should be run on the target under
22063 the control of the GDB remote debugging stub.
22065 @item -msim
22066 @opindex msim
22067 A program which performs file I/O and is destined to run on the simulator
22068 should be linked with option.  This causes libraries libc.a and libsim.a to
22069 be linked.
22071 @item -mfpu
22072 @itemx -mhard-float
22073 @opindex mfpu
22074 @opindex mhard-float
22075 Generate code containing floating-point instructions.  This is the
22076 default.
22078 @item -mno-fpu
22079 @itemx -msoft-float
22080 @opindex mno-fpu
22081 @opindex msoft-float
22082 Generate code containing library calls for floating-point.
22084 @option{-msoft-float} changes the calling convention in the output file;
22085 therefore, it is only useful if you compile @emph{all} of a program with
22086 this option.  In particular, you need to compile @file{libgcc.a}, the
22087 library that comes with GCC, with @option{-msoft-float} in order for
22088 this to work.
22090 @item -mcpu=@var{cpu_type}
22091 @opindex mcpu
22092 Set the instruction set, register set, and instruction scheduling parameters
22093 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22094 @samp{mcm}, @samp{gr5} and @samp{gr6}.
22096 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
22098 By default (unless configured otherwise), GCC generates code for the GR5
22099 variant of the Visium architecture.  
22101 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
22102 architecture.  The only difference from GR5 code is that the compiler will
22103 generate block move instructions.
22105 @item -mtune=@var{cpu_type}
22106 @opindex mtune
22107 Set the instruction scheduling parameters for machine type @var{cpu_type},
22108 but do not set the instruction set or register set that the option
22109 @option{-mcpu=@var{cpu_type}} would.
22111 @item -msv-mode
22112 @opindex msv-mode
22113 Generate code for the supervisor mode, where there are no restrictions on
22114 the access to general registers.  This is the default.
22116 @item -muser-mode
22117 @opindex muser-mode
22118 Generate code for the user mode, where the access to some general registers
22119 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
22120 mode; on the GR6, only registers r29 to r31 are affected.
22121 @end table
22123 @node VMS Options
22124 @subsection VMS Options
22126 These @samp{-m} options are defined for the VMS implementations:
22128 @table @gcctabopt
22129 @item -mvms-return-codes
22130 @opindex mvms-return-codes
22131 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22132 condition (e.g.@ error) codes.
22134 @item -mdebug-main=@var{prefix}
22135 @opindex mdebug-main=@var{prefix}
22136 Flag the first routine whose name starts with @var{prefix} as the main
22137 routine for the debugger.
22139 @item -mmalloc64
22140 @opindex mmalloc64
22141 Default to 64-bit memory allocation routines.
22143 @item -mpointer-size=@var{size}
22144 @opindex mpointer-size=@var{size}
22145 Set the default size of pointers. Possible options for @var{size} are
22146 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22147 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22148 The later option disables @code{pragma pointer_size}.
22149 @end table
22151 @node VxWorks Options
22152 @subsection VxWorks Options
22153 @cindex VxWorks Options
22155 The options in this section are defined for all VxWorks targets.
22156 Options specific to the target hardware are listed with the other
22157 options for that target.
22159 @table @gcctabopt
22160 @item -mrtp
22161 @opindex mrtp
22162 GCC can generate code for both VxWorks kernels and real time processes
22163 (RTPs).  This option switches from the former to the latter.  It also
22164 defines the preprocessor macro @code{__RTP__}.
22166 @item -non-static
22167 @opindex non-static
22168 Link an RTP executable against shared libraries rather than static
22169 libraries.  The options @option{-static} and @option{-shared} can
22170 also be used for RTPs (@pxref{Link Options}); @option{-static}
22171 is the default.
22173 @item -Bstatic
22174 @itemx -Bdynamic
22175 @opindex Bstatic
22176 @opindex Bdynamic
22177 These options are passed down to the linker.  They are defined for
22178 compatibility with Diab.
22180 @item -Xbind-lazy
22181 @opindex Xbind-lazy
22182 Enable lazy binding of function calls.  This option is equivalent to
22183 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22185 @item -Xbind-now
22186 @opindex Xbind-now
22187 Disable lazy binding of function calls.  This option is the default and
22188 is defined for compatibility with Diab.
22189 @end table
22191 @node x86 Options
22192 @subsection x86 Options
22193 @cindex x86 Options
22195 These @samp{-m} options are defined for the x86 family of computers.
22197 @table @gcctabopt
22199 @item -march=@var{cpu-type}
22200 @opindex march
22201 Generate instructions for the machine type @var{cpu-type}.  In contrast to
22202 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
22203 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
22204 to generate code that may not run at all on processors other than the one
22205 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
22206 @option{-mtune=@var{cpu-type}}.
22208 The choices for @var{cpu-type} are:
22210 @table @samp
22211 @item native
22212 This selects the CPU to generate code for at compilation time by determining
22213 the processor type of the compiling machine.  Using @option{-march=native}
22214 enables all instruction subsets supported by the local machine (hence
22215 the result might not run on different machines).  Using @option{-mtune=native}
22216 produces code optimized for the local machine under the constraints
22217 of the selected instruction set.  
22219 @item i386
22220 Original Intel i386 CPU@.
22222 @item i486
22223 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
22225 @item i586
22226 @itemx pentium
22227 Intel Pentium CPU with no MMX support.
22229 @item iamcu
22230 Intel MCU, based on Intel Pentium CPU.
22232 @item pentium-mmx
22233 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
22235 @item pentiumpro
22236 Intel Pentium Pro CPU@.
22238 @item i686
22239 When used with @option{-march}, the Pentium Pro
22240 instruction set is used, so the code runs on all i686 family chips.
22241 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
22243 @item pentium2
22244 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
22245 support.
22247 @item pentium3
22248 @itemx pentium3m
22249 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
22250 set support.
22252 @item pentium-m
22253 Intel Pentium M; low-power version of Intel Pentium III CPU
22254 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
22256 @item pentium4
22257 @itemx pentium4m
22258 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
22260 @item prescott
22261 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
22262 set support.
22264 @item nocona
22265 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
22266 SSE2 and SSE3 instruction set support.
22268 @item core2
22269 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
22270 instruction set support.
22272 @item nehalem
22273 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22274 SSE4.1, SSE4.2 and POPCNT instruction set support.
22276 @item westmere
22277 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22278 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
22280 @item sandybridge
22281 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22282 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
22284 @item ivybridge
22285 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22286 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
22287 instruction set support.
22289 @item haswell
22290 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22291 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22292 BMI, BMI2 and F16C instruction set support.
22294 @item broadwell
22295 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22296 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22297 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
22299 @item skylake
22300 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22301 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22302 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
22303 XSAVES instruction set support.
22305 @item bonnell
22306 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
22307 instruction set support.
22309 @item silvermont
22310 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22311 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
22313 @item knl
22314 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22315 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22316 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
22317 AVX512CD instruction set support.
22319 @item k6
22320 AMD K6 CPU with MMX instruction set support.
22322 @item k6-2
22323 @itemx k6-3
22324 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
22326 @item athlon
22327 @itemx athlon-tbird
22328 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
22329 support.
22331 @item athlon-4
22332 @itemx athlon-xp
22333 @itemx athlon-mp
22334 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
22335 instruction set support.
22337 @item k8
22338 @itemx opteron
22339 @itemx athlon64
22340 @itemx athlon-fx
22341 Processors based on the AMD K8 core with x86-64 instruction set support,
22342 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
22343 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
22344 instruction set extensions.)
22346 @item k8-sse3
22347 @itemx opteron-sse3
22348 @itemx athlon64-sse3
22349 Improved versions of AMD K8 cores with SSE3 instruction set support.
22351 @item amdfam10
22352 @itemx barcelona
22353 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
22354 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
22355 instruction set extensions.)
22357 @item bdver1
22358 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
22359 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
22360 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
22361 @item bdver2
22362 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22363 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
22364 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
22365 extensions.)
22366 @item bdver3
22367 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22368 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
22369 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
22370 64-bit instruction set extensions.
22371 @item bdver4
22372 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22373 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
22374 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
22375 SSE4.2, ABM and 64-bit instruction set extensions.
22377 @item btver1
22378 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
22379 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
22380 instruction set extensions.)
22382 @item btver2
22383 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
22384 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
22385 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
22387 @item winchip-c6
22388 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
22389 set support.
22391 @item winchip2
22392 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
22393 instruction set support.
22395 @item c3
22396 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
22397 implemented for this chip.)
22399 @item c3-2
22400 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
22401 (No scheduling is
22402 implemented for this chip.)
22404 @item geode
22405 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
22406 @end table
22408 @item -mtune=@var{cpu-type}
22409 @opindex mtune
22410 Tune to @var{cpu-type} everything applicable about the generated code, except
22411 for the ABI and the set of available instructions.  
22412 While picking a specific @var{cpu-type} schedules things appropriately
22413 for that particular chip, the compiler does not generate any code that
22414 cannot run on the default machine type unless you use a
22415 @option{-march=@var{cpu-type}} option.
22416 For example, if GCC is configured for i686-pc-linux-gnu
22417 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
22418 but still runs on i686 machines.
22420 The choices for @var{cpu-type} are the same as for @option{-march}.
22421 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
22423 @table @samp
22424 @item generic
22425 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
22426 If you know the CPU on which your code will run, then you should use
22427 the corresponding @option{-mtune} or @option{-march} option instead of
22428 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
22429 of your application will have, then you should use this option.
22431 As new processors are deployed in the marketplace, the behavior of this
22432 option will change.  Therefore, if you upgrade to a newer version of
22433 GCC, code generation controlled by this option will change to reflect
22434 the processors
22435 that are most common at the time that version of GCC is released.
22437 There is no @option{-march=generic} option because @option{-march}
22438 indicates the instruction set the compiler can use, and there is no
22439 generic instruction set applicable to all processors.  In contrast,
22440 @option{-mtune} indicates the processor (or, in this case, collection of
22441 processors) for which the code is optimized.
22443 @item intel
22444 Produce code optimized for the most current Intel processors, which are
22445 Haswell and Silvermont for this version of GCC.  If you know the CPU
22446 on which your code will run, then you should use the corresponding
22447 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
22448 But, if you want your application performs better on both Haswell and
22449 Silvermont, then you should use this option.
22451 As new Intel processors are deployed in the marketplace, the behavior of
22452 this option will change.  Therefore, if you upgrade to a newer version of
22453 GCC, code generation controlled by this option will change to reflect
22454 the most current Intel processors at the time that version of GCC is
22455 released.
22457 There is no @option{-march=intel} option because @option{-march} indicates
22458 the instruction set the compiler can use, and there is no common
22459 instruction set applicable to all processors.  In contrast,
22460 @option{-mtune} indicates the processor (or, in this case, collection of
22461 processors) for which the code is optimized.
22462 @end table
22464 @item -mcpu=@var{cpu-type}
22465 @opindex mcpu
22466 A deprecated synonym for @option{-mtune}.
22468 @item -mfpmath=@var{unit}
22469 @opindex mfpmath
22470 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
22471 for @var{unit} are:
22473 @table @samp
22474 @item 387
22475 Use the standard 387 floating-point coprocessor present on the majority of chips and
22476 emulated otherwise.  Code compiled with this option runs almost everywhere.
22477 The temporary results are computed in 80-bit precision instead of the precision
22478 specified by the type, resulting in slightly different results compared to most
22479 of other chips.  See @option{-ffloat-store} for more detailed description.
22481 This is the default choice for x86-32 targets.
22483 @item sse
22484 Use scalar floating-point instructions present in the SSE instruction set.
22485 This instruction set is supported by Pentium III and newer chips,
22486 and in the AMD line
22487 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
22488 instruction set supports only single-precision arithmetic, thus the double and
22489 extended-precision arithmetic are still done using 387.  A later version, present
22490 only in Pentium 4 and AMD x86-64 chips, supports double-precision
22491 arithmetic too.
22493 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
22494 or @option{-msse2} switches to enable SSE extensions and make this option
22495 effective.  For the x86-64 compiler, these extensions are enabled by default.
22497 The resulting code should be considerably faster in the majority of cases and avoid
22498 the numerical instability problems of 387 code, but may break some existing
22499 code that expects temporaries to be 80 bits.
22501 This is the default choice for the x86-64 compiler.
22503 @item sse,387
22504 @itemx sse+387
22505 @itemx both
22506 Attempt to utilize both instruction sets at once.  This effectively doubles the
22507 amount of available registers, and on chips with separate execution units for
22508 387 and SSE the execution resources too.  Use this option with care, as it is
22509 still experimental, because the GCC register allocator does not model separate
22510 functional units well, resulting in unstable performance.
22511 @end table
22513 @item -masm=@var{dialect}
22514 @opindex masm=@var{dialect}
22515 Output assembly instructions using selected @var{dialect}.  Also affects
22516 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
22517 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
22518 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
22519 not support @samp{intel}.
22521 @item -mieee-fp
22522 @itemx -mno-ieee-fp
22523 @opindex mieee-fp
22524 @opindex mno-ieee-fp
22525 Control whether or not the compiler uses IEEE floating-point
22526 comparisons.  These correctly handle the case where the result of a
22527 comparison is unordered.
22529 @item -msoft-float
22530 @opindex msoft-float
22531 Generate output containing library calls for floating point.
22533 @strong{Warning:} the requisite libraries are not part of GCC@.
22534 Normally the facilities of the machine's usual C compiler are used, but
22535 this can't be done directly in cross-compilation.  You must make your
22536 own arrangements to provide suitable library functions for
22537 cross-compilation.
22539 On machines where a function returns floating-point results in the 80387
22540 register stack, some floating-point opcodes may be emitted even if
22541 @option{-msoft-float} is used.
22543 @item -mno-fp-ret-in-387
22544 @opindex mno-fp-ret-in-387
22545 Do not use the FPU registers for return values of functions.
22547 The usual calling convention has functions return values of types
22548 @code{float} and @code{double} in an FPU register, even if there
22549 is no FPU@.  The idea is that the operating system should emulate
22550 an FPU@.
22552 The option @option{-mno-fp-ret-in-387} causes such values to be returned
22553 in ordinary CPU registers instead.
22555 @item -mno-fancy-math-387
22556 @opindex mno-fancy-math-387
22557 Some 387 emulators do not support the @code{sin}, @code{cos} and
22558 @code{sqrt} instructions for the 387.  Specify this option to avoid
22559 generating those instructions.  This option is the default on
22560 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
22561 indicates that the target CPU always has an FPU and so the
22562 instruction does not need emulation.  These
22563 instructions are not generated unless you also use the
22564 @option{-funsafe-math-optimizations} switch.
22566 @item -malign-double
22567 @itemx -mno-align-double
22568 @opindex malign-double
22569 @opindex mno-align-double
22570 Control whether GCC aligns @code{double}, @code{long double}, and
22571 @code{long long} variables on a two-word boundary or a one-word
22572 boundary.  Aligning @code{double} variables on a two-word boundary
22573 produces code that runs somewhat faster on a Pentium at the
22574 expense of more memory.
22576 On x86-64, @option{-malign-double} is enabled by default.
22578 @strong{Warning:} if you use the @option{-malign-double} switch,
22579 structures containing the above types are aligned differently than
22580 the published application binary interface specifications for the x86-32
22581 and are not binary compatible with structures in code compiled
22582 without that switch.
22584 @item -m96bit-long-double
22585 @itemx -m128bit-long-double
22586 @opindex m96bit-long-double
22587 @opindex m128bit-long-double
22588 These switches control the size of @code{long double} type.  The x86-32
22589 application binary interface specifies the size to be 96 bits,
22590 so @option{-m96bit-long-double} is the default in 32-bit mode.
22592 Modern architectures (Pentium and newer) prefer @code{long double}
22593 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
22594 conforming to the ABI, this is not possible.  So specifying
22595 @option{-m128bit-long-double} aligns @code{long double}
22596 to a 16-byte boundary by padding the @code{long double} with an additional
22597 32-bit zero.
22599 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
22600 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
22602 Notice that neither of these options enable any extra precision over the x87
22603 standard of 80 bits for a @code{long double}.
22605 @strong{Warning:} if you override the default value for your target ABI, this
22606 changes the size of 
22607 structures and arrays containing @code{long double} variables,
22608 as well as modifying the function calling convention for functions taking
22609 @code{long double}.  Hence they are not binary-compatible
22610 with code compiled without that switch.
22612 @item -mlong-double-64
22613 @itemx -mlong-double-80
22614 @itemx -mlong-double-128
22615 @opindex mlong-double-64
22616 @opindex mlong-double-80
22617 @opindex mlong-double-128
22618 These switches control the size of @code{long double} type. A size
22619 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22620 type. This is the default for 32-bit Bionic C library.  A size
22621 of 128 bits makes the @code{long double} type equivalent to the
22622 @code{__float128} type. This is the default for 64-bit Bionic C library.
22624 @strong{Warning:} if you override the default value for your target ABI, this
22625 changes the size of
22626 structures and arrays containing @code{long double} variables,
22627 as well as modifying the function calling convention for functions taking
22628 @code{long double}.  Hence they are not binary-compatible
22629 with code compiled without that switch.
22631 @item -malign-data=@var{type}
22632 @opindex malign-data
22633 Control how GCC aligns variables.  Supported values for @var{type} are
22634 @samp{compat} uses increased alignment value compatible uses GCC 4.8
22635 and earlier, @samp{abi} uses alignment value as specified by the
22636 psABI, and @samp{cacheline} uses increased alignment value to match
22637 the cache line size.  @samp{compat} is the default.
22639 @item -mlarge-data-threshold=@var{threshold}
22640 @opindex mlarge-data-threshold
22641 When @option{-mcmodel=medium} is specified, data objects larger than
22642 @var{threshold} are placed in the large data section.  This value must be the
22643 same across all objects linked into the binary, and defaults to 65535.
22645 @item -mrtd
22646 @opindex mrtd
22647 Use a different function-calling convention, in which functions that
22648 take a fixed number of arguments return with the @code{ret @var{num}}
22649 instruction, which pops their arguments while returning.  This saves one
22650 instruction in the caller since there is no need to pop the arguments
22651 there.
22653 You can specify that an individual function is called with this calling
22654 sequence with the function attribute @code{stdcall}.  You can also
22655 override the @option{-mrtd} option by using the function attribute
22656 @code{cdecl}.  @xref{Function Attributes}.
22658 @strong{Warning:} this calling convention is incompatible with the one
22659 normally used on Unix, so you cannot use it if you need to call
22660 libraries compiled with the Unix compiler.
22662 Also, you must provide function prototypes for all functions that
22663 take variable numbers of arguments (including @code{printf});
22664 otherwise incorrect code is generated for calls to those
22665 functions.
22667 In addition, seriously incorrect code results if you call a
22668 function with too many arguments.  (Normally, extra arguments are
22669 harmlessly ignored.)
22671 @item -mregparm=@var{num}
22672 @opindex mregparm
22673 Control how many registers are used to pass integer arguments.  By
22674 default, no registers are used to pass arguments, and at most 3
22675 registers can be used.  You can control this behavior for a specific
22676 function by using the function attribute @code{regparm}.
22677 @xref{Function Attributes}.
22679 @strong{Warning:} if you use this switch, and
22680 @var{num} is nonzero, then you must build all modules with the same
22681 value, including any libraries.  This includes the system libraries and
22682 startup modules.
22684 @item -msseregparm
22685 @opindex msseregparm
22686 Use SSE register passing conventions for float and double arguments
22687 and return values.  You can control this behavior for a specific
22688 function by using the function attribute @code{sseregparm}.
22689 @xref{Function Attributes}.
22691 @strong{Warning:} if you use this switch then you must build all
22692 modules with the same value, including any libraries.  This includes
22693 the system libraries and startup modules.
22695 @item -mvect8-ret-in-mem
22696 @opindex mvect8-ret-in-mem
22697 Return 8-byte vectors in memory instead of MMX registers.  This is the
22698 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
22699 Studio compilers until version 12.  Later compiler versions (starting
22700 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
22701 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
22702 you need to remain compatible with existing code produced by those
22703 previous compiler versions or older versions of GCC@.
22705 @item -mpc32
22706 @itemx -mpc64
22707 @itemx -mpc80
22708 @opindex mpc32
22709 @opindex mpc64
22710 @opindex mpc80
22712 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
22713 is specified, the significands of results of floating-point operations are
22714 rounded to 24 bits (single precision); @option{-mpc64} rounds the
22715 significands of results of floating-point operations to 53 bits (double
22716 precision) and @option{-mpc80} rounds the significands of results of
22717 floating-point operations to 64 bits (extended double precision), which is
22718 the default.  When this option is used, floating-point operations in higher
22719 precisions are not available to the programmer without setting the FPU
22720 control word explicitly.
22722 Setting the rounding of floating-point operations to less than the default
22723 80 bits can speed some programs by 2% or more.  Note that some mathematical
22724 libraries assume that extended-precision (80-bit) floating-point operations
22725 are enabled by default; routines in such libraries could suffer significant
22726 loss of accuracy, typically through so-called ``catastrophic cancellation'',
22727 when this option is used to set the precision to less than extended precision.
22729 @item -mstackrealign
22730 @opindex mstackrealign
22731 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
22732 option generates an alternate prologue and epilogue that realigns the
22733 run-time stack if necessary.  This supports mixing legacy codes that keep
22734 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
22735 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
22736 applicable to individual functions.
22738 @item -mpreferred-stack-boundary=@var{num}
22739 @opindex mpreferred-stack-boundary
22740 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
22741 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
22742 the default is 4 (16 bytes or 128 bits).
22744 @strong{Warning:} When generating code for the x86-64 architecture with
22745 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
22746 used to keep the stack boundary aligned to 8 byte boundary.  Since
22747 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
22748 intended to be used in controlled environment where stack space is
22749 important limitation.  This option leads to wrong code when functions
22750 compiled with 16 byte stack alignment (such as functions from a standard
22751 library) are called with misaligned stack.  In this case, SSE
22752 instructions may lead to misaligned memory access traps.  In addition,
22753 variable arguments are handled incorrectly for 16 byte aligned
22754 objects (including x87 long double and __int128), leading to wrong
22755 results.  You must build all modules with
22756 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
22757 includes the system libraries and startup modules.
22759 @item -mincoming-stack-boundary=@var{num}
22760 @opindex mincoming-stack-boundary
22761 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
22762 boundary.  If @option{-mincoming-stack-boundary} is not specified,
22763 the one specified by @option{-mpreferred-stack-boundary} is used.
22765 On Pentium and Pentium Pro, @code{double} and @code{long double} values
22766 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
22767 suffer significant run time performance penalties.  On Pentium III, the
22768 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
22769 properly if it is not 16-byte aligned.
22771 To ensure proper alignment of this values on the stack, the stack boundary
22772 must be as aligned as that required by any value stored on the stack.
22773 Further, every function must be generated such that it keeps the stack
22774 aligned.  Thus calling a function compiled with a higher preferred
22775 stack boundary from a function compiled with a lower preferred stack
22776 boundary most likely misaligns the stack.  It is recommended that
22777 libraries that use callbacks always use the default setting.
22779 This extra alignment does consume extra stack space, and generally
22780 increases code size.  Code that is sensitive to stack space usage, such
22781 as embedded systems and operating system kernels, may want to reduce the
22782 preferred alignment to @option{-mpreferred-stack-boundary=2}.
22784 @need 200
22785 @item -mmmx
22786 @opindex mmmx
22787 @need 200
22788 @itemx -msse
22789 @opindex msse
22790 @need 200
22791 @itemx -msse2
22792 @need 200
22793 @itemx -msse3
22794 @need 200
22795 @itemx -mssse3
22796 @need 200
22797 @itemx -msse4
22798 @need 200
22799 @itemx -msse4a
22800 @need 200
22801 @itemx -msse4.1
22802 @need 200
22803 @itemx -msse4.2
22804 @need 200
22805 @itemx -mavx
22806 @opindex mavx
22807 @need 200
22808 @itemx -mavx2
22809 @need 200
22810 @itemx -mavx512f
22811 @need 200
22812 @itemx -mavx512pf
22813 @need 200
22814 @itemx -mavx512er
22815 @need 200
22816 @itemx -mavx512cd
22817 @need 200
22818 @itemx -msha
22819 @opindex msha
22820 @need 200
22821 @itemx -maes
22822 @opindex maes
22823 @need 200
22824 @itemx -mpclmul
22825 @opindex mpclmul
22826 @need 200
22827 @itemx -mclfushopt
22828 @opindex mclfushopt
22829 @need 200
22830 @itemx -mfsgsbase
22831 @opindex mfsgsbase
22832 @need 200
22833 @itemx -mrdrnd
22834 @opindex mrdrnd
22835 @need 200
22836 @itemx -mf16c
22837 @opindex mf16c
22838 @need 200
22839 @itemx -mfma
22840 @opindex mfma
22841 @need 200
22842 @itemx -mfma4
22843 @need 200
22844 @itemx -mno-fma4
22845 @need 200
22846 @itemx -mprefetchwt1
22847 @opindex mprefetchwt1
22848 @need 200
22849 @itemx -mxop
22850 @opindex mxop
22851 @need 200
22852 @itemx -mlwp
22853 @opindex mlwp
22854 @need 200
22855 @itemx -m3dnow
22856 @opindex m3dnow
22857 @need 200
22858 @itemx -mpopcnt
22859 @opindex mpopcnt
22860 @need 200
22861 @itemx -mabm
22862 @opindex mabm
22863 @need 200
22864 @itemx -mbmi
22865 @opindex mbmi
22866 @need 200
22867 @itemx -mbmi2
22868 @need 200
22869 @itemx -mlzcnt
22870 @opindex mlzcnt
22871 @need 200
22872 @itemx -mfxsr
22873 @opindex mfxsr
22874 @need 200
22875 @itemx -mxsave
22876 @opindex mxsave
22877 @need 200
22878 @itemx -mxsaveopt
22879 @opindex mxsaveopt
22880 @need 200
22881 @itemx -mxsavec
22882 @opindex mxsavec
22883 @need 200
22884 @itemx -mxsaves
22885 @opindex mxsaves
22886 @need 200
22887 @itemx -mrtm
22888 @opindex mrtm
22889 @need 200
22890 @itemx -mtbm
22891 @opindex mtbm
22892 @need 200
22893 @itemx -mmpx
22894 @opindex mmpx
22895 @need 200
22896 @itemx -mmwaitx
22897 @opindex mmwaitx
22898 These switches enable the use of instructions in the MMX, SSE,
22899 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
22900 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
22901 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX or 3DNow!@:
22902 extended instruction sets.  Each has a corresponding @option{-mno-} option
22903 to disable use of these instructions.
22905 These extensions are also available as built-in functions: see
22906 @ref{x86 Built-in Functions}, for details of the functions enabled and
22907 disabled by these switches.
22909 To generate SSE/SSE2 instructions automatically from floating-point
22910 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
22912 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
22913 generates new AVX instructions or AVX equivalence for all SSEx instructions
22914 when needed.
22916 These options enable GCC to use these extended instructions in
22917 generated code, even without @option{-mfpmath=sse}.  Applications that
22918 perform run-time CPU detection must compile separate files for each
22919 supported architecture, using the appropriate flags.  In particular,
22920 the file containing the CPU detection code should be compiled without
22921 these options.
22923 @item -mdump-tune-features
22924 @opindex mdump-tune-features
22925 This option instructs GCC to dump the names of the x86 performance 
22926 tuning features and default settings. The names can be used in 
22927 @option{-mtune-ctrl=@var{feature-list}}.
22929 @item -mtune-ctrl=@var{feature-list}
22930 @opindex mtune-ctrl=@var{feature-list}
22931 This option is used to do fine grain control of x86 code generation features.
22932 @var{feature-list} is a comma separated list of @var{feature} names. See also
22933 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
22934 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
22935 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
22936 developers. Using it may lead to code paths not covered by testing and can
22937 potentially result in compiler ICEs or runtime errors.
22939 @item -mno-default
22940 @opindex mno-default
22941 This option instructs GCC to turn off all tunable features. See also 
22942 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
22944 @item -mcld
22945 @opindex mcld
22946 This option instructs GCC to emit a @code{cld} instruction in the prologue
22947 of functions that use string instructions.  String instructions depend on
22948 the DF flag to select between autoincrement or autodecrement mode.  While the
22949 ABI specifies the DF flag to be cleared on function entry, some operating
22950 systems violate this specification by not clearing the DF flag in their
22951 exception dispatchers.  The exception handler can be invoked with the DF flag
22952 set, which leads to wrong direction mode when string instructions are used.
22953 This option can be enabled by default on 32-bit x86 targets by configuring
22954 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
22955 instructions can be suppressed with the @option{-mno-cld} compiler option
22956 in this case.
22958 @item -mvzeroupper
22959 @opindex mvzeroupper
22960 This option instructs GCC to emit a @code{vzeroupper} instruction
22961 before a transfer of control flow out of the function to minimize
22962 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
22963 intrinsics.
22965 @item -mprefer-avx128
22966 @opindex mprefer-avx128
22967 This option instructs GCC to use 128-bit AVX instructions instead of
22968 256-bit AVX instructions in the auto-vectorizer.
22970 @item -mcx16
22971 @opindex mcx16
22972 This option enables GCC to generate @code{CMPXCHG16B} instructions.
22973 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
22974 (or oword) data types.  
22975 This is useful for high-resolution counters that can be updated
22976 by multiple processors (or cores).  This instruction is generated as part of
22977 atomic built-in functions: see @ref{__sync Builtins} or
22978 @ref{__atomic Builtins} for details.
22980 @item -msahf
22981 @opindex msahf
22982 This option enables generation of @code{SAHF} instructions in 64-bit code.
22983 Early Intel Pentium 4 CPUs with Intel 64 support,
22984 prior to the introduction of Pentium 4 G1 step in December 2005,
22985 lacked the @code{LAHF} and @code{SAHF} instructions
22986 which are supported by AMD64.
22987 These are load and store instructions, respectively, for certain status flags.
22988 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
22989 @code{drem}, and @code{remainder} built-in functions;
22990 see @ref{Other Builtins} for details.
22992 @item -mmovbe
22993 @opindex mmovbe
22994 This option enables use of the @code{movbe} instruction to implement
22995 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
22997 @item -mcrc32
22998 @opindex mcrc32
22999 This option enables built-in functions @code{__builtin_ia32_crc32qi},
23000 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
23001 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
23003 @item -mrecip
23004 @opindex mrecip
23005 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
23006 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
23007 with an additional Newton-Raphson step
23008 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
23009 (and their vectorized
23010 variants) for single-precision floating-point arguments.  These instructions
23011 are generated only when @option{-funsafe-math-optimizations} is enabled
23012 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
23013 Note that while the throughput of the sequence is higher than the throughput
23014 of the non-reciprocal instruction, the precision of the sequence can be
23015 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
23017 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
23018 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
23019 combination), and doesn't need @option{-mrecip}.
23021 Also note that GCC emits the above sequence with additional Newton-Raphson step
23022 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
23023 already with @option{-ffast-math} (or the above option combination), and
23024 doesn't need @option{-mrecip}.
23026 @item -mrecip=@var{opt}
23027 @opindex mrecip=opt
23028 This option controls which reciprocal estimate instructions
23029 may be used.  @var{opt} is a comma-separated list of options, which may
23030 be preceded by a @samp{!} to invert the option:
23032 @table @samp
23033 @item all
23034 Enable all estimate instructions.
23036 @item default
23037 Enable the default instructions, equivalent to @option{-mrecip}.
23039 @item none
23040 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23042 @item div
23043 Enable the approximation for scalar division.
23045 @item vec-div
23046 Enable the approximation for vectorized division.
23048 @item sqrt
23049 Enable the approximation for scalar square root.
23051 @item vec-sqrt
23052 Enable the approximation for vectorized square root.
23053 @end table
23055 So, for example, @option{-mrecip=all,!sqrt} enables
23056 all of the reciprocal approximations, except for square root.
23058 @item -mveclibabi=@var{type}
23059 @opindex mveclibabi
23060 Specifies the ABI type to use for vectorizing intrinsics using an
23061 external library.  Supported values for @var{type} are @samp{svml} 
23062 for the Intel short
23063 vector math library and @samp{acml} for the AMD math core library.
23064 To use this option, both @option{-ftree-vectorize} and
23065 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
23066 ABI-compatible library must be specified at link time.
23068 GCC currently emits calls to @code{vmldExp2},
23069 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
23070 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
23071 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
23072 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
23073 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
23074 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
23075 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
23076 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
23077 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
23078 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
23079 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
23080 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
23081 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
23082 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
23083 when @option{-mveclibabi=acml} is used.  
23085 @item -mabi=@var{name}
23086 @opindex mabi
23087 Generate code for the specified calling convention.  Permissible values
23088 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
23089 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
23090 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
23091 You can control this behavior for specific functions by
23092 using the function attributes @code{ms_abi} and @code{sysv_abi}.
23093 @xref{Function Attributes}.
23095 @item -mtls-dialect=@var{type}
23096 @opindex mtls-dialect
23097 Generate code to access thread-local storage using the @samp{gnu} or
23098 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
23099 @samp{gnu2} is more efficient, but it may add compile- and run-time
23100 requirements that cannot be satisfied on all systems.
23102 @item -mpush-args
23103 @itemx -mno-push-args
23104 @opindex mpush-args
23105 @opindex mno-push-args
23106 Use PUSH operations to store outgoing parameters.  This method is shorter
23107 and usually equally fast as method using SUB/MOV operations and is enabled
23108 by default.  In some cases disabling it may improve performance because of
23109 improved scheduling and reduced dependencies.
23111 @item -maccumulate-outgoing-args
23112 @opindex maccumulate-outgoing-args
23113 If enabled, the maximum amount of space required for outgoing arguments is
23114 computed in the function prologue.  This is faster on most modern CPUs
23115 because of reduced dependencies, improved scheduling and reduced stack usage
23116 when the preferred stack boundary is not equal to 2.  The drawback is a notable
23117 increase in code size.  This switch implies @option{-mno-push-args}.
23119 @item -mthreads
23120 @opindex mthreads
23121 Support thread-safe exception handling on MinGW.  Programs that rely
23122 on thread-safe exception handling must compile and link all code with the
23123 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
23124 @option{-D_MT}; when linking, it links in a special thread helper library
23125 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
23127 @item -mno-align-stringops
23128 @opindex mno-align-stringops
23129 Do not align the destination of inlined string operations.  This switch reduces
23130 code size and improves performance in case the destination is already aligned,
23131 but GCC doesn't know about it.
23133 @item -minline-all-stringops
23134 @opindex minline-all-stringops
23135 By default GCC inlines string operations only when the destination is 
23136 known to be aligned to least a 4-byte boundary.  
23137 This enables more inlining and increases code
23138 size, but may improve performance of code that depends on fast
23139 @code{memcpy}, @code{strlen},
23140 and @code{memset} for short lengths.
23142 @item -minline-stringops-dynamically
23143 @opindex minline-stringops-dynamically
23144 For string operations of unknown size, use run-time checks with
23145 inline code for small blocks and a library call for large blocks.
23147 @item -mstringop-strategy=@var{alg}
23148 @opindex mstringop-strategy=@var{alg}
23149 Override the internal decision heuristic for the particular algorithm to use
23150 for inlining string operations.  The allowed values for @var{alg} are:
23152 @table @samp
23153 @item rep_byte
23154 @itemx rep_4byte
23155 @itemx rep_8byte
23156 Expand using i386 @code{rep} prefix of the specified size.
23158 @item byte_loop
23159 @itemx loop
23160 @itemx unrolled_loop
23161 Expand into an inline loop.
23163 @item libcall
23164 Always use a library call.
23165 @end table
23167 @item -mmemcpy-strategy=@var{strategy}
23168 @opindex mmemcpy-strategy=@var{strategy}
23169 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
23170 should be inlined and what inline algorithm to use when the expected size
23171 of the copy operation is known. @var{strategy} 
23172 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
23173 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
23174 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
23175 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
23176 in the list must be specified in increasing order.  The minimal byte size for 
23177 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
23178 preceding range.
23180 @item -mmemset-strategy=@var{strategy}
23181 @opindex mmemset-strategy=@var{strategy}
23182 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
23183 @code{__builtin_memset} expansion.
23185 @item -momit-leaf-frame-pointer
23186 @opindex momit-leaf-frame-pointer
23187 Don't keep the frame pointer in a register for leaf functions.  This
23188 avoids the instructions to save, set up, and restore frame pointers and
23189 makes an extra register available in leaf functions.  The option
23190 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
23191 which might make debugging harder.
23193 @item -mtls-direct-seg-refs
23194 @itemx -mno-tls-direct-seg-refs
23195 @opindex mtls-direct-seg-refs
23196 Controls whether TLS variables may be accessed with offsets from the
23197 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
23198 or whether the thread base pointer must be added.  Whether or not this
23199 is valid depends on the operating system, and whether it maps the
23200 segment to cover the entire TLS area.
23202 For systems that use the GNU C Library, the default is on.
23204 @item -msse2avx
23205 @itemx -mno-sse2avx
23206 @opindex msse2avx
23207 Specify that the assembler should encode SSE instructions with VEX
23208 prefix.  The option @option{-mavx} turns this on by default.
23210 @item -mfentry
23211 @itemx -mno-fentry
23212 @opindex mfentry
23213 If profiling is active (@option{-pg}), put the profiling
23214 counter call before the prologue.
23215 Note: On x86 architectures the attribute @code{ms_hook_prologue}
23216 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
23218 @item -mrecord-mcount
23219 @itemx -mno-record-mcount
23220 @opindex mrecord-mcount
23221 If profiling is active (@option{-pg}), generate a __mcount_loc section
23222 that contains pointers to each profiling call. This is useful for
23223 automatically patching and out calls.
23225 @item -mnop-mcount
23226 @itemx -mno-nop-mcount
23227 @opindex mnop-mcount
23228 If profiling is active (@option{-pg}), generate the calls to
23229 the profiling functions as nops. This is useful when they
23230 should be patched in later dynamically. This is likely only
23231 useful together with @option{-mrecord-mcount}.
23233 @item -mskip-rax-setup
23234 @itemx -mno-skip-rax-setup
23235 @opindex mskip-rax-setup
23236 When generating code for the x86-64 architecture with SSE extensions
23237 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
23238 register when there are no variable arguments passed in vector registers.
23240 @strong{Warning:} Since RAX register is used to avoid unnecessarily
23241 saving vector registers on stack when passing variable arguments, the
23242 impacts of this option are callees may waste some stack space,
23243 misbehave or jump to a random location.  GCC 4.4 or newer don't have
23244 those issues, regardless the RAX register value.
23246 @item -m8bit-idiv
23247 @itemx -mno-8bit-idiv
23248 @opindex m8bit-idiv
23249 On some processors, like Intel Atom, 8-bit unsigned integer divide is
23250 much faster than 32-bit/64-bit integer divide.  This option generates a
23251 run-time check.  If both dividend and divisor are within range of 0
23252 to 255, 8-bit unsigned integer divide is used instead of
23253 32-bit/64-bit integer divide.
23255 @item -mavx256-split-unaligned-load
23256 @itemx -mavx256-split-unaligned-store
23257 @opindex mavx256-split-unaligned-load
23258 @opindex mavx256-split-unaligned-store
23259 Split 32-byte AVX unaligned load and store.
23261 @item -mstack-protector-guard=@var{guard}
23262 @opindex mstack-protector-guard=@var{guard}
23263 Generate stack protection code using canary at @var{guard}.  Supported
23264 locations are @samp{global} for global canary or @samp{tls} for per-thread
23265 canary in the TLS block (the default).  This option has effect only when
23266 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
23268 @end table
23270 These @samp{-m} switches are supported in addition to the above
23271 on x86-64 processors in 64-bit environments.
23273 @table @gcctabopt
23274 @item -m32
23275 @itemx -m64
23276 @itemx -mx32
23277 @itemx -m16
23278 @itemx -miamcu
23279 @opindex m32
23280 @opindex m64
23281 @opindex mx32
23282 @opindex m16
23283 @opindex miamcu
23284 Generate code for a 16-bit, 32-bit or 64-bit environment.
23285 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
23286 to 32 bits, and
23287 generates code that runs on any i386 system.
23289 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
23290 types to 64 bits, and generates code for the x86-64 architecture.
23291 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
23292 and @option{-mdynamic-no-pic} options.
23294 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
23295 to 32 bits, and
23296 generates code for the x86-64 architecture.
23298 The @option{-m16} option is the same as @option{-m32}, except for that
23299 it outputs the @code{.code16gcc} assembly directive at the beginning of
23300 the assembly output so that the binary can run in 16-bit mode.
23302 The @option{-miamcu} option generates code which conforms to Intel MCU
23303 psABI.  It requires the @option{-m32} option to be turned on.
23305 @item -mno-red-zone
23306 @opindex mno-red-zone
23307 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
23308 by the x86-64 ABI; it is a 128-byte area beyond the location of the
23309 stack pointer that is not modified by signal or interrupt handlers
23310 and therefore can be used for temporary data without adjusting the stack
23311 pointer.  The flag @option{-mno-red-zone} disables this red zone.
23313 @item -mcmodel=small
23314 @opindex mcmodel=small
23315 Generate code for the small code model: the program and its symbols must
23316 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
23317 Programs can be statically or dynamically linked.  This is the default
23318 code model.
23320 @item -mcmodel=kernel
23321 @opindex mcmodel=kernel
23322 Generate code for the kernel code model.  The kernel runs in the
23323 negative 2 GB of the address space.
23324 This model has to be used for Linux kernel code.
23326 @item -mcmodel=medium
23327 @opindex mcmodel=medium
23328 Generate code for the medium model: the program is linked in the lower 2
23329 GB of the address space.  Small symbols are also placed there.  Symbols
23330 with sizes larger than @option{-mlarge-data-threshold} are put into
23331 large data or BSS sections and can be located above 2GB.  Programs can
23332 be statically or dynamically linked.
23334 @item -mcmodel=large
23335 @opindex mcmodel=large
23336 Generate code for the large model.  This model makes no assumptions
23337 about addresses and sizes of sections.
23339 @item -maddress-mode=long
23340 @opindex maddress-mode=long
23341 Generate code for long address mode.  This is only supported for 64-bit
23342 and x32 environments.  It is the default address mode for 64-bit
23343 environments.
23345 @item -maddress-mode=short
23346 @opindex maddress-mode=short
23347 Generate code for short address mode.  This is only supported for 32-bit
23348 and x32 environments.  It is the default address mode for 32-bit and
23349 x32 environments.
23350 @end table
23352 @node x86 Windows Options
23353 @subsection x86 Windows Options
23354 @cindex x86 Windows Options
23355 @cindex Windows Options for x86
23357 These additional options are available for Microsoft Windows targets:
23359 @table @gcctabopt
23360 @item -mconsole
23361 @opindex mconsole
23362 This option
23363 specifies that a console application is to be generated, by
23364 instructing the linker to set the PE header subsystem type
23365 required for console applications.
23366 This option is available for Cygwin and MinGW targets and is
23367 enabled by default on those targets.
23369 @item -mdll
23370 @opindex mdll
23371 This option is available for Cygwin and MinGW targets.  It
23372 specifies that a DLL---a dynamic link library---is to be
23373 generated, enabling the selection of the required runtime
23374 startup object and entry point.
23376 @item -mnop-fun-dllimport
23377 @opindex mnop-fun-dllimport
23378 This option is available for Cygwin and MinGW targets.  It
23379 specifies that the @code{dllimport} attribute should be ignored.
23381 @item -mthread
23382 @opindex mthread
23383 This option is available for MinGW targets. It specifies
23384 that MinGW-specific thread support is to be used.
23386 @item -municode
23387 @opindex municode
23388 This option is available for MinGW-w64 targets.  It causes
23389 the @code{UNICODE} preprocessor macro to be predefined, and
23390 chooses Unicode-capable runtime startup code.
23392 @item -mwin32
23393 @opindex mwin32
23394 This option is available for Cygwin and MinGW targets.  It
23395 specifies that the typical Microsoft Windows predefined macros are to
23396 be set in the pre-processor, but does not influence the choice
23397 of runtime library/startup code.
23399 @item -mwindows
23400 @opindex mwindows
23401 This option is available for Cygwin and MinGW targets.  It
23402 specifies that a GUI application is to be generated by
23403 instructing the linker to set the PE header subsystem type
23404 appropriately.
23406 @item -fno-set-stack-executable
23407 @opindex fno-set-stack-executable
23408 This option is available for MinGW targets. It specifies that
23409 the executable flag for the stack used by nested functions isn't
23410 set. This is necessary for binaries running in kernel mode of
23411 Microsoft Windows, as there the User32 API, which is used to set executable
23412 privileges, isn't available.
23414 @item -fwritable-relocated-rdata
23415 @opindex fno-writable-relocated-rdata
23416 This option is available for MinGW and Cygwin targets.  It specifies
23417 that relocated-data in read-only section is put into .data
23418 section.  This is a necessary for older runtimes not supporting
23419 modification of .rdata sections for pseudo-relocation.
23421 @item -mpe-aligned-commons
23422 @opindex mpe-aligned-commons
23423 This option is available for Cygwin and MinGW targets.  It
23424 specifies that the GNU extension to the PE file format that
23425 permits the correct alignment of COMMON variables should be
23426 used when generating code.  It is enabled by default if
23427 GCC detects that the target assembler found during configuration
23428 supports the feature.
23429 @end table
23431 See also under @ref{x86 Options} for standard options.
23433 @node Xstormy16 Options
23434 @subsection Xstormy16 Options
23435 @cindex Xstormy16 Options
23437 These options are defined for Xstormy16:
23439 @table @gcctabopt
23440 @item -msim
23441 @opindex msim
23442 Choose startup files and linker script suitable for the simulator.
23443 @end table
23445 @node Xtensa Options
23446 @subsection Xtensa Options
23447 @cindex Xtensa Options
23449 These options are supported for Xtensa targets:
23451 @table @gcctabopt
23452 @item -mconst16
23453 @itemx -mno-const16
23454 @opindex mconst16
23455 @opindex mno-const16
23456 Enable or disable use of @code{CONST16} instructions for loading
23457 constant values.  The @code{CONST16} instruction is currently not a
23458 standard option from Tensilica.  When enabled, @code{CONST16}
23459 instructions are always used in place of the standard @code{L32R}
23460 instructions.  The use of @code{CONST16} is enabled by default only if
23461 the @code{L32R} instruction is not available.
23463 @item -mfused-madd
23464 @itemx -mno-fused-madd
23465 @opindex mfused-madd
23466 @opindex mno-fused-madd
23467 Enable or disable use of fused multiply/add and multiply/subtract
23468 instructions in the floating-point option.  This has no effect if the
23469 floating-point option is not also enabled.  Disabling fused multiply/add
23470 and multiply/subtract instructions forces the compiler to use separate
23471 instructions for the multiply and add/subtract operations.  This may be
23472 desirable in some cases where strict IEEE 754-compliant results are
23473 required: the fused multiply add/subtract instructions do not round the
23474 intermediate result, thereby producing results with @emph{more} bits of
23475 precision than specified by the IEEE standard.  Disabling fused multiply
23476 add/subtract instructions also ensures that the program output is not
23477 sensitive to the compiler's ability to combine multiply and add/subtract
23478 operations.
23480 @item -mserialize-volatile
23481 @itemx -mno-serialize-volatile
23482 @opindex mserialize-volatile
23483 @opindex mno-serialize-volatile
23484 When this option is enabled, GCC inserts @code{MEMW} instructions before
23485 @code{volatile} memory references to guarantee sequential consistency.
23486 The default is @option{-mserialize-volatile}.  Use
23487 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
23489 @item -mforce-no-pic
23490 @opindex mforce-no-pic
23491 For targets, like GNU/Linux, where all user-mode Xtensa code must be
23492 position-independent code (PIC), this option disables PIC for compiling
23493 kernel code.
23495 @item -mtext-section-literals
23496 @itemx -mno-text-section-literals
23497 @opindex mtext-section-literals
23498 @opindex mno-text-section-literals
23499 These options control the treatment of literal pools.  The default is
23500 @option{-mno-text-section-literals}, which places literals in a separate
23501 section in the output file.  This allows the literal pool to be placed
23502 in a data RAM/ROM, and it also allows the linker to combine literal
23503 pools from separate object files to remove redundant literals and
23504 improve code size.  With @option{-mtext-section-literals}, the literals
23505 are interspersed in the text section in order to keep them as close as
23506 possible to their references.  This may be necessary for large assembly
23507 files.  Literals for each function are placed right before that function.
23509 @item -mauto-litpools
23510 @itemx -mno-auto-litpools
23511 @opindex mauto-litpools
23512 @opindex mno-auto-litpools
23513 These options control the treatment of literal pools.  The default is
23514 @option{-mno-auto-litpools}, which places literals in a separate
23515 section in the output file unless @option{-mtext-section-literals} is
23516 used.  With @option{-mauto-litpools} the literals are interspersed in
23517 the text section by the assembler.  Compiler does not produce explicit
23518 @code{.literal} directives and loads literals into registers with
23519 @code{MOVI} instructions instead of @code{L32R} to let the assembler
23520 do relaxation and place literals as necessary.  This option allows
23521 assembler to create several literal pools per function and assemble
23522 very big functions, which may not be possible with
23523 @option{-mtext-section-literals}.
23525 @item -mtarget-align
23526 @itemx -mno-target-align
23527 @opindex mtarget-align
23528 @opindex mno-target-align
23529 When this option is enabled, GCC instructs the assembler to
23530 automatically align instructions to reduce branch penalties at the
23531 expense of some code density.  The assembler attempts to widen density
23532 instructions to align branch targets and the instructions following call
23533 instructions.  If there are not enough preceding safe density
23534 instructions to align a target, no widening is performed.  The
23535 default is @option{-mtarget-align}.  These options do not affect the
23536 treatment of auto-aligned instructions like @code{LOOP}, which the
23537 assembler always aligns, either by widening density instructions or
23538 by inserting NOP instructions.
23540 @item -mlongcalls
23541 @itemx -mno-longcalls
23542 @opindex mlongcalls
23543 @opindex mno-longcalls
23544 When this option is enabled, GCC instructs the assembler to translate
23545 direct calls to indirect calls unless it can determine that the target
23546 of a direct call is in the range allowed by the call instruction.  This
23547 translation typically occurs for calls to functions in other source
23548 files.  Specifically, the assembler translates a direct @code{CALL}
23549 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
23550 The default is @option{-mno-longcalls}.  This option should be used in
23551 programs where the call target can potentially be out of range.  This
23552 option is implemented in the assembler, not the compiler, so the
23553 assembly code generated by GCC still shows direct call
23554 instructions---look at the disassembled object code to see the actual
23555 instructions.  Note that the assembler uses an indirect call for
23556 every cross-file call, not just those that really are out of range.
23557 @end table
23559 @node zSeries Options
23560 @subsection zSeries Options
23561 @cindex zSeries options
23563 These are listed under @xref{S/390 and zSeries Options}.
23565 @node Code Gen Options
23566 @section Options for Code Generation Conventions
23567 @cindex code generation conventions
23568 @cindex options, code generation
23569 @cindex run-time options
23571 These machine-independent options control the interface conventions
23572 used in code generation.
23574 Most of them have both positive and negative forms; the negative form
23575 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
23576 one of the forms is listed---the one that is not the default.  You
23577 can figure out the other form by either removing @samp{no-} or adding
23580 @table @gcctabopt
23581 @item -fbounds-check
23582 @opindex fbounds-check
23583 For front ends that support it, generate additional code to check that
23584 indices used to access arrays are within the declared range.  This is
23585 currently only supported by the Java and Fortran front ends, where
23586 this option defaults to true and false respectively.
23588 @item -fstack-reuse=@var{reuse-level}
23589 @opindex fstack_reuse
23590 This option controls stack space reuse for user declared local/auto variables
23591 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
23592 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
23593 local variables and temporaries, @samp{named_vars} enables the reuse only for
23594 user defined local variables with names, and @samp{none} disables stack reuse
23595 completely. The default value is @samp{all}. The option is needed when the
23596 program extends the lifetime of a scoped local variable or a compiler generated
23597 temporary beyond the end point defined by the language.  When a lifetime of
23598 a variable ends, and if the variable lives in memory, the optimizing compiler
23599 has the freedom to reuse its stack space with other temporaries or scoped
23600 local variables whose live range does not overlap with it. Legacy code extending
23601 local lifetime is likely to break with the stack reuse optimization.
23603 For example,
23605 @smallexample
23606    int *p;
23607    @{
23608      int local1;
23610      p = &local1;
23611      local1 = 10;
23612      ....
23613    @}
23614    @{
23615       int local2;
23616       local2 = 20;
23617       ...
23618    @}
23620    if (*p == 10)  // out of scope use of local1
23621      @{
23623      @}
23624 @end smallexample
23626 Another example:
23627 @smallexample
23629    struct A
23630    @{
23631        A(int k) : i(k), j(k) @{ @}
23632        int i;
23633        int j;
23634    @};
23636    A *ap;
23638    void foo(const A& ar)
23639    @{
23640       ap = &ar;
23641    @}
23643    void bar()
23644    @{
23645       foo(A(10)); // temp object's lifetime ends when foo returns
23647       @{
23648         A a(20);
23649         ....
23650       @}
23651       ap->i+= 10;  // ap references out of scope temp whose space
23652                    // is reused with a. What is the value of ap->i?
23653    @}
23655 @end smallexample
23657 The lifetime of a compiler generated temporary is well defined by the C++
23658 standard. When a lifetime of a temporary ends, and if the temporary lives
23659 in memory, the optimizing compiler has the freedom to reuse its stack
23660 space with other temporaries or scoped local variables whose live range
23661 does not overlap with it. However some of the legacy code relies on
23662 the behavior of older compilers in which temporaries' stack space is
23663 not reused, the aggressive stack reuse can lead to runtime errors. This
23664 option is used to control the temporary stack reuse optimization.
23666 @item -ftrapv
23667 @opindex ftrapv
23668 This option generates traps for signed overflow on addition, subtraction,
23669 multiplication operations.
23671 @item -fwrapv
23672 @opindex fwrapv
23673 This option instructs the compiler to assume that signed arithmetic
23674 overflow of addition, subtraction and multiplication wraps around
23675 using twos-complement representation.  This flag enables some optimizations
23676 and disables others.  This option is enabled by default for the Java
23677 front end, as required by the Java language specification.
23679 @item -fexceptions
23680 @opindex fexceptions
23681 Enable exception handling.  Generates extra code needed to propagate
23682 exceptions.  For some targets, this implies GCC generates frame
23683 unwind information for all functions, which can produce significant data
23684 size overhead, although it does not affect execution.  If you do not
23685 specify this option, GCC enables it by default for languages like
23686 C++ that normally require exception handling, and disables it for
23687 languages like C that do not normally require it.  However, you may need
23688 to enable this option when compiling C code that needs to interoperate
23689 properly with exception handlers written in C++.  You may also wish to
23690 disable this option if you are compiling older C++ programs that don't
23691 use exception handling.
23693 @item -fnon-call-exceptions
23694 @opindex fnon-call-exceptions
23695 Generate code that allows trapping instructions to throw exceptions.
23696 Note that this requires platform-specific runtime support that does
23697 not exist everywhere.  Moreover, it only allows @emph{trapping}
23698 instructions to throw exceptions, i.e.@: memory references or floating-point
23699 instructions.  It does not allow exceptions to be thrown from
23700 arbitrary signal handlers such as @code{SIGALRM}.
23702 @item -fdelete-dead-exceptions
23703 @opindex fdelete-dead-exceptions
23704 Consider that instructions that may throw exceptions but don't otherwise
23705 contribute to the execution of the program can be optimized away.
23706 This option is enabled by default for the Ada front end, as permitted by
23707 the Ada language specification.
23708 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
23710 @item -funwind-tables
23711 @opindex funwind-tables
23712 Similar to @option{-fexceptions}, except that it just generates any needed
23713 static data, but does not affect the generated code in any other way.
23714 You normally do not need to enable this option; instead, a language processor
23715 that needs this handling enables it on your behalf.
23717 @item -fasynchronous-unwind-tables
23718 @opindex fasynchronous-unwind-tables
23719 Generate unwind table in DWARF 2 format, if supported by target machine.  The
23720 table is exact at each instruction boundary, so it can be used for stack
23721 unwinding from asynchronous events (such as debugger or garbage collector).
23723 @item -fno-gnu-unique
23724 @opindex fno-gnu-unique
23725 On systems with recent GNU assembler and C library, the C++ compiler
23726 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
23727 of template static data members and static local variables in inline
23728 functions are unique even in the presence of @code{RTLD_LOCAL}; this
23729 is necessary to avoid problems with a library used by two different
23730 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
23731 therefore disagreeing with the other one about the binding of the
23732 symbol.  But this causes @code{dlclose} to be ignored for affected
23733 DSOs; if your program relies on reinitialization of a DSO via
23734 @code{dlclose} and @code{dlopen}, you can use
23735 @option{-fno-gnu-unique}.
23737 @item -fpcc-struct-return
23738 @opindex fpcc-struct-return
23739 Return ``short'' @code{struct} and @code{union} values in memory like
23740 longer ones, rather than in registers.  This convention is less
23741 efficient, but it has the advantage of allowing intercallability between
23742 GCC-compiled files and files compiled with other compilers, particularly
23743 the Portable C Compiler (pcc).
23745 The precise convention for returning structures in memory depends
23746 on the target configuration macros.
23748 Short structures and unions are those whose size and alignment match
23749 that of some integer type.
23751 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
23752 switch is not binary compatible with code compiled with the
23753 @option{-freg-struct-return} switch.
23754 Use it to conform to a non-default application binary interface.
23756 @item -freg-struct-return
23757 @opindex freg-struct-return
23758 Return @code{struct} and @code{union} values in registers when possible.
23759 This is more efficient for small structures than
23760 @option{-fpcc-struct-return}.
23762 If you specify neither @option{-fpcc-struct-return} nor
23763 @option{-freg-struct-return}, GCC defaults to whichever convention is
23764 standard for the target.  If there is no standard convention, GCC
23765 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
23766 the principal compiler.  In those cases, we can choose the standard, and
23767 we chose the more efficient register return alternative.
23769 @strong{Warning:} code compiled with the @option{-freg-struct-return}
23770 switch is not binary compatible with code compiled with the
23771 @option{-fpcc-struct-return} switch.
23772 Use it to conform to a non-default application binary interface.
23774 @item -fshort-enums
23775 @opindex fshort-enums
23776 Allocate to an @code{enum} type only as many bytes as it needs for the
23777 declared range of possible values.  Specifically, the @code{enum} type
23778 is equivalent to the smallest integer type that has enough room.
23780 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
23781 code that is not binary compatible with code generated without that switch.
23782 Use it to conform to a non-default application binary interface.
23784 @item -fshort-double
23785 @opindex fshort-double
23786 Use the same size for @code{double} as for @code{float}.
23788 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
23789 code that is not binary compatible with code generated without that switch.
23790 Use it to conform to a non-default application binary interface.
23792 @item -fshort-wchar
23793 @opindex fshort-wchar
23794 Override the underlying type for @code{wchar_t} to be @code{short
23795 unsigned int} instead of the default for the target.  This option is
23796 useful for building programs to run under WINE@.
23798 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
23799 code that is not binary compatible with code generated without that switch.
23800 Use it to conform to a non-default application binary interface.
23802 @item -fno-common
23803 @opindex fno-common
23804 In C code, controls the placement of uninitialized global variables.
23805 Unix C compilers have traditionally permitted multiple definitions of
23806 such variables in different compilation units by placing the variables
23807 in a common block.
23808 This is the behavior specified by @option{-fcommon}, and is the default
23809 for GCC on most targets.
23810 On the other hand, this behavior is not required by ISO C, and on some
23811 targets may carry a speed or code size penalty on variable references.
23812 The @option{-fno-common} option specifies that the compiler should place
23813 uninitialized global variables in the data section of the object file,
23814 rather than generating them as common blocks.
23815 This has the effect that if the same variable is declared
23816 (without @code{extern}) in two different compilations,
23817 you get a multiple-definition error when you link them.
23818 In this case, you must compile with @option{-fcommon} instead.
23819 Compiling with @option{-fno-common} is useful on targets for which
23820 it provides better performance, or if you wish to verify that the
23821 program will work on other systems that always treat uninitialized
23822 variable declarations this way.
23824 @item -fno-ident
23825 @opindex fno-ident
23826 Ignore the @code{#ident} directive.
23828 @item -finhibit-size-directive
23829 @opindex finhibit-size-directive
23830 Don't output a @code{.size} assembler directive, or anything else that
23831 would cause trouble if the function is split in the middle, and the
23832 two halves are placed at locations far apart in memory.  This option is
23833 used when compiling @file{crtstuff.c}; you should not need to use it
23834 for anything else.
23836 @item -fverbose-asm
23837 @opindex fverbose-asm
23838 Put extra commentary information in the generated assembly code to
23839 make it more readable.  This option is generally only of use to those
23840 who actually need to read the generated assembly code (perhaps while
23841 debugging the compiler itself).
23843 @option{-fno-verbose-asm}, the default, causes the
23844 extra information to be omitted and is useful when comparing two assembler
23845 files.
23847 @item -frecord-gcc-switches
23848 @opindex frecord-gcc-switches
23849 This switch causes the command line used to invoke the
23850 compiler to be recorded into the object file that is being created.
23851 This switch is only implemented on some targets and the exact format
23852 of the recording is target and binary file format dependent, but it
23853 usually takes the form of a section containing ASCII text.  This
23854 switch is related to the @option{-fverbose-asm} switch, but that
23855 switch only records information in the assembler output file as
23856 comments, so it never reaches the object file.
23857 See also @option{-grecord-gcc-switches} for another
23858 way of storing compiler options into the object file.
23860 @item -fpic
23861 @opindex fpic
23862 @cindex global offset table
23863 @cindex PIC
23864 Generate position-independent code (PIC) suitable for use in a shared
23865 library, if supported for the target machine.  Such code accesses all
23866 constant addresses through a global offset table (GOT)@.  The dynamic
23867 loader resolves the GOT entries when the program starts (the dynamic
23868 loader is not part of GCC; it is part of the operating system).  If
23869 the GOT size for the linked executable exceeds a machine-specific
23870 maximum size, you get an error message from the linker indicating that
23871 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23872 instead.  (These maximums are 8k on the SPARC and 32k
23873 on the m68k and RS/6000.  The x86 has no such limit.)
23875 Position-independent code requires special support, and therefore works
23876 only on certain machines.  For the x86, GCC supports PIC for System V
23877 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23878 position-independent.
23880 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23881 are defined to 1.
23883 @item -fPIC
23884 @opindex fPIC
23885 If supported for the target machine, emit position-independent code,
23886 suitable for dynamic linking and avoiding any limit on the size of the
23887 global offset table.  This option makes a difference on the m68k,
23888 PowerPC and SPARC@.
23890 Position-independent code requires special support, and therefore works
23891 only on certain machines.
23893 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23894 are defined to 2.
23896 @item -fpie
23897 @itemx -fPIE
23898 @opindex fpie
23899 @opindex fPIE
23900 These options are similar to @option{-fpic} and @option{-fPIC}, but
23901 generated position independent code can be only linked into executables.
23902 Usually these options are used when @option{-pie} GCC option is
23903 used during linking.
23905 @option{-fpie} and @option{-fPIE} both define the macros
23906 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23907 for @option{-fpie} and 2 for @option{-fPIE}.
23909 @item -fno-plt
23910 @opindex fno-plt
23911 Do not use PLT for external function calls in position-independent code.
23912 Instead, load callee address at call site from GOT and branch to it.
23913 This leads to more efficient code by eliminating PLT stubs and exposing
23914 GOT load to optimizations.  On architectures such as 32-bit x86 where
23915 PLT stubs expect GOT pointer in a specific register, this gives more
23916 register allocation freedom to the compiler.  Lazy binding requires PLT:
23917 with @option{-fno-plt} all external symbols are resolved at load time.
23919 Alternatively, function attribute @code{noplt} can be used to avoid PLT
23920 for calls to specific external functions by marking those functions with
23921 this attribute.
23923 Additionally, a few targets also convert calls to those functions that are
23924 marked to not use the PLT to use the GOT instead for non-position independent
23925 code.
23927 @item -fno-jump-tables
23928 @opindex fno-jump-tables
23929 Do not use jump tables for switch statements even where it would be
23930 more efficient than other code generation strategies.  This option is
23931 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23932 building code that forms part of a dynamic linker and cannot
23933 reference the address of a jump table.  On some targets, jump tables
23934 do not require a GOT and this option is not needed.
23936 @item -ffixed-@var{reg}
23937 @opindex ffixed
23938 Treat the register named @var{reg} as a fixed register; generated code
23939 should never refer to it (except perhaps as a stack pointer, frame
23940 pointer or in some other fixed role).
23942 @var{reg} must be the name of a register.  The register names accepted
23943 are machine-specific and are defined in the @code{REGISTER_NAMES}
23944 macro in the machine description macro file.
23946 This flag does not have a negative form, because it specifies a
23947 three-way choice.
23949 @item -fcall-used-@var{reg}
23950 @opindex fcall-used
23951 Treat the register named @var{reg} as an allocable register that is
23952 clobbered by function calls.  It may be allocated for temporaries or
23953 variables that do not live across a call.  Functions compiled this way
23954 do not save and restore the register @var{reg}.
23956 It is an error to use this flag with the frame pointer or stack pointer.
23957 Use of this flag for other registers that have fixed pervasive roles in
23958 the machine's execution model produces disastrous results.
23960 This flag does not have a negative form, because it specifies a
23961 three-way choice.
23963 @item -fcall-saved-@var{reg}
23964 @opindex fcall-saved
23965 Treat the register named @var{reg} as an allocable register saved by
23966 functions.  It may be allocated even for temporaries or variables that
23967 live across a call.  Functions compiled this way save and restore
23968 the register @var{reg} if they use it.
23970 It is an error to use this flag with the frame pointer or stack pointer.
23971 Use of this flag for other registers that have fixed pervasive roles in
23972 the machine's execution model produces disastrous results.
23974 A different sort of disaster results from the use of this flag for
23975 a register in which function values may be returned.
23977 This flag does not have a negative form, because it specifies a
23978 three-way choice.
23980 @item -fpack-struct[=@var{n}]
23981 @opindex fpack-struct
23982 Without a value specified, pack all structure members together without
23983 holes.  When a value is specified (which must be a small power of two), pack
23984 structure members according to this value, representing the maximum
23985 alignment (that is, objects with default alignment requirements larger than
23986 this are output potentially unaligned at the next fitting location.
23988 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23989 code that is not binary compatible with code generated without that switch.
23990 Additionally, it makes the code suboptimal.
23991 Use it to conform to a non-default application binary interface.
23993 @item -finstrument-functions
23994 @opindex finstrument-functions
23995 Generate instrumentation calls for entry and exit to functions.  Just
23996 after function entry and just before function exit, the following
23997 profiling functions are called with the address of the current
23998 function and its call site.  (On some platforms,
23999 @code{__builtin_return_address} does not work beyond the current
24000 function, so the call site information may not be available to the
24001 profiling functions otherwise.)
24003 @smallexample
24004 void __cyg_profile_func_enter (void *this_fn,
24005                                void *call_site);
24006 void __cyg_profile_func_exit  (void *this_fn,
24007                                void *call_site);
24008 @end smallexample
24010 The first argument is the address of the start of the current function,
24011 which may be looked up exactly in the symbol table.
24013 This instrumentation is also done for functions expanded inline in other
24014 functions.  The profiling calls indicate where, conceptually, the
24015 inline function is entered and exited.  This means that addressable
24016 versions of such functions must be available.  If all your uses of a
24017 function are expanded inline, this may mean an additional expansion of
24018 code size.  If you use @code{extern inline} in your C code, an
24019 addressable version of such functions must be provided.  (This is
24020 normally the case anyway, but if you get lucky and the optimizer always
24021 expands the functions inline, you might have gotten away without
24022 providing static copies.)
24024 A function may be given the attribute @code{no_instrument_function}, in
24025 which case this instrumentation is not done.  This can be used, for
24026 example, for the profiling functions listed above, high-priority
24027 interrupt routines, and any functions from which the profiling functions
24028 cannot safely be called (perhaps signal handlers, if the profiling
24029 routines generate output or allocate memory).
24031 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
24032 @opindex finstrument-functions-exclude-file-list
24034 Set the list of functions that are excluded from instrumentation (see
24035 the description of @option{-finstrument-functions}).  If the file that
24036 contains a function definition matches with one of @var{file}, then
24037 that function is not instrumented.  The match is done on substrings:
24038 if the @var{file} parameter is a substring of the file name, it is
24039 considered to be a match.
24041 For example:
24043 @smallexample
24044 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
24045 @end smallexample
24047 @noindent
24048 excludes any inline function defined in files whose pathnames
24049 contain @file{/bits/stl} or @file{include/sys}.
24051 If, for some reason, you want to include letter @samp{,} in one of
24052 @var{sym}, write @samp{\,}. For example,
24053 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
24054 (note the single quote surrounding the option).
24056 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
24057 @opindex finstrument-functions-exclude-function-list
24059 This is similar to @option{-finstrument-functions-exclude-file-list},
24060 but this option sets the list of function names to be excluded from
24061 instrumentation.  The function name to be matched is its user-visible
24062 name, such as @code{vector<int> blah(const vector<int> &)}, not the
24063 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
24064 match is done on substrings: if the @var{sym} parameter is a substring
24065 of the function name, it is considered to be a match.  For C99 and C++
24066 extended identifiers, the function name must be given in UTF-8, not
24067 using universal character names.
24069 @item -fstack-check
24070 @opindex fstack-check
24071 Generate code to verify that you do not go beyond the boundary of the
24072 stack.  You should specify this flag if you are running in an
24073 environment with multiple threads, but you only rarely need to specify it in
24074 a single-threaded environment since stack overflow is automatically
24075 detected on nearly all systems if there is only one stack.
24077 Note that this switch does not actually cause checking to be done; the
24078 operating system or the language runtime must do that.  The switch causes
24079 generation of code to ensure that they see the stack being extended.
24081 You can additionally specify a string parameter: @samp{no} means no
24082 checking, @samp{generic} means force the use of old-style checking,
24083 @samp{specific} means use the best checking method and is equivalent
24084 to bare @option{-fstack-check}.
24086 Old-style checking is a generic mechanism that requires no specific
24087 target support in the compiler but comes with the following drawbacks:
24089 @enumerate
24090 @item
24091 Modified allocation strategy for large objects: they are always
24092 allocated dynamically if their size exceeds a fixed threshold.
24094 @item
24095 Fixed limit on the size of the static frame of functions: when it is
24096 topped by a particular function, stack checking is not reliable and
24097 a warning is issued by the compiler.
24099 @item
24100 Inefficiency: because of both the modified allocation strategy and the
24101 generic implementation, code performance is hampered.
24102 @end enumerate
24104 Note that old-style stack checking is also the fallback method for
24105 @samp{specific} if no target support has been added in the compiler.
24107 @item -fstack-limit-register=@var{reg}
24108 @itemx -fstack-limit-symbol=@var{sym}
24109 @itemx -fno-stack-limit
24110 @opindex fstack-limit-register
24111 @opindex fstack-limit-symbol
24112 @opindex fno-stack-limit
24113 Generate code to ensure that the stack does not grow beyond a certain value,
24114 either the value of a register or the address of a symbol.  If a larger
24115 stack is required, a signal is raised at run time.  For most targets,
24116 the signal is raised before the stack overruns the boundary, so
24117 it is possible to catch the signal without taking special precautions.
24119 For instance, if the stack starts at absolute address @samp{0x80000000}
24120 and grows downwards, you can use the flags
24121 @option{-fstack-limit-symbol=__stack_limit} and
24122 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
24123 of 128KB@.  Note that this may only work with the GNU linker.
24125 @item -fsplit-stack
24126 @opindex fsplit-stack
24127 Generate code to automatically split the stack before it overflows.
24128 The resulting program has a discontiguous stack which can only
24129 overflow if the program is unable to allocate any more memory.  This
24130 is most useful when running threaded programs, as it is no longer
24131 necessary to calculate a good stack size to use for each thread.  This
24132 is currently only implemented for the x86 targets running
24133 GNU/Linux.
24135 When code compiled with @option{-fsplit-stack} calls code compiled
24136 without @option{-fsplit-stack}, there may not be much stack space
24137 available for the latter code to run.  If compiling all code,
24138 including library code, with @option{-fsplit-stack} is not an option,
24139 then the linker can fix up these calls so that the code compiled
24140 without @option{-fsplit-stack} always has a large stack.  Support for
24141 this is implemented in the gold linker in GNU binutils release 2.21
24142 and later.
24144 @item -fleading-underscore
24145 @opindex fleading-underscore
24146 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
24147 change the way C symbols are represented in the object file.  One use
24148 is to help link with legacy assembly code.
24150 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
24151 generate code that is not binary compatible with code generated without that
24152 switch.  Use it to conform to a non-default application binary interface.
24153 Not all targets provide complete support for this switch.
24155 @item -ftls-model=@var{model}
24156 @opindex ftls-model
24157 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
24158 The @var{model} argument should be one of @samp{global-dynamic},
24159 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
24160 Note that the choice is subject to optimization: the compiler may use
24161 a more efficient model for symbols not visible outside of the translation
24162 unit, or if @option{-fpic} is not given on the command line.
24164 The default without @option{-fpic} is @samp{initial-exec}; with
24165 @option{-fpic} the default is @samp{global-dynamic}.
24167 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
24168 @opindex fvisibility
24169 Set the default ELF image symbol visibility to the specified option---all
24170 symbols are marked with this unless overridden within the code.
24171 Using this feature can very substantially improve linking and
24172 load times of shared object libraries, produce more optimized
24173 code, provide near-perfect API export and prevent symbol clashes.
24174 It is @strong{strongly} recommended that you use this in any shared objects
24175 you distribute.
24177 Despite the nomenclature, @samp{default} always means public; i.e.,
24178 available to be linked against from outside the shared object.
24179 @samp{protected} and @samp{internal} are pretty useless in real-world
24180 usage so the only other commonly used option is @samp{hidden}.
24181 The default if @option{-fvisibility} isn't specified is
24182 @samp{default}, i.e., make every symbol public.
24184 A good explanation of the benefits offered by ensuring ELF
24185 symbols have the correct visibility is given by ``How To Write
24186 Shared Libraries'' by Ulrich Drepper (which can be found at
24187 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
24188 solution made possible by this option to marking things hidden when
24189 the default is public is to make the default hidden and mark things
24190 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
24191 and @code{__attribute__ ((visibility("default")))} instead of
24192 @code{__declspec(dllexport)} you get almost identical semantics with
24193 identical syntax.  This is a great boon to those working with
24194 cross-platform projects.
24196 For those adding visibility support to existing code, you may find
24197 @code{#pragma GCC visibility} of use.  This works by you enclosing
24198 the declarations you wish to set visibility for with (for example)
24199 @code{#pragma GCC visibility push(hidden)} and
24200 @code{#pragma GCC visibility pop}.
24201 Bear in mind that symbol visibility should be viewed @strong{as
24202 part of the API interface contract} and thus all new code should
24203 always specify visibility when it is not the default; i.e., declarations
24204 only for use within the local DSO should @strong{always} be marked explicitly
24205 as hidden as so to avoid PLT indirection overheads---making this
24206 abundantly clear also aids readability and self-documentation of the code.
24207 Note that due to ISO C++ specification requirements, @code{operator new} and
24208 @code{operator delete} must always be of default visibility.
24210 Be aware that headers from outside your project, in particular system
24211 headers and headers from any other library you use, may not be
24212 expecting to be compiled with visibility other than the default.  You
24213 may need to explicitly say @code{#pragma GCC visibility push(default)}
24214 before including any such headers.
24216 @code{extern} declarations are not affected by @option{-fvisibility}, so
24217 a lot of code can be recompiled with @option{-fvisibility=hidden} with
24218 no modifications.  However, this means that calls to @code{extern}
24219 functions with no explicit visibility use the PLT, so it is more
24220 effective to use @code{__attribute ((visibility))} and/or
24221 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
24222 declarations should be treated as hidden.
24224 Note that @option{-fvisibility} does affect C++ vague linkage
24225 entities. This means that, for instance, an exception class that is
24226 be thrown between DSOs must be explicitly marked with default
24227 visibility so that the @samp{type_info} nodes are unified between
24228 the DSOs.
24230 An overview of these techniques, their benefits and how to use them
24231 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
24233 @item -fstrict-volatile-bitfields
24234 @opindex fstrict-volatile-bitfields
24235 This option should be used if accesses to volatile bit-fields (or other
24236 structure fields, although the compiler usually honors those types
24237 anyway) should use a single access of the width of the
24238 field's type, aligned to a natural alignment if possible.  For
24239 example, targets with memory-mapped peripheral registers might require
24240 all such accesses to be 16 bits wide; with this flag you can
24241 declare all peripheral bit-fields as @code{unsigned short} (assuming short
24242 is 16 bits on these targets) to force GCC to use 16-bit accesses
24243 instead of, perhaps, a more efficient 32-bit access.
24245 If this option is disabled, the compiler uses the most efficient
24246 instruction.  In the previous example, that might be a 32-bit load
24247 instruction, even though that accesses bytes that do not contain
24248 any portion of the bit-field, or memory-mapped registers unrelated to
24249 the one being updated.
24251 In some cases, such as when the @code{packed} attribute is applied to a 
24252 structure field, it may not be possible to access the field with a single
24253 read or write that is correctly aligned for the target machine.  In this
24254 case GCC falls back to generating multiple accesses rather than code that 
24255 will fault or truncate the result at run time.
24257 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
24258 not allowed to touch non bit-field members.  It is therefore recommended
24259 to define all bits of the field's type as bit-field members.
24261 The default value of this option is determined by the application binary
24262 interface for the target processor.
24264 @item -fsync-libcalls
24265 @opindex fsync-libcalls
24266 This option controls whether any out-of-line instance of the @code{__sync}
24267 family of functions may be used to implement the C++11 @code{__atomic}
24268 family of functions.
24270 The default value of this option is enabled, thus the only useful form
24271 of the option is @option{-fno-sync-libcalls}.  This option is used in
24272 the implementation of the @file{libatomic} runtime library.
24274 @end table
24276 @c man end
24278 @node Environment Variables
24279 @section Environment Variables Affecting GCC
24280 @cindex environment variables
24282 @c man begin ENVIRONMENT
24283 This section describes several environment variables that affect how GCC
24284 operates.  Some of them work by specifying directories or prefixes to use
24285 when searching for various kinds of files.  Some are used to specify other
24286 aspects of the compilation environment.
24288 Note that you can also specify places to search using options such as
24289 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
24290 take precedence over places specified using environment variables, which
24291 in turn take precedence over those specified by the configuration of GCC@.
24292 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
24293 GNU Compiler Collection (GCC) Internals}.
24295 @table @env
24296 @item LANG
24297 @itemx LC_CTYPE
24298 @c @itemx LC_COLLATE
24299 @itemx LC_MESSAGES
24300 @c @itemx LC_MONETARY
24301 @c @itemx LC_NUMERIC
24302 @c @itemx LC_TIME
24303 @itemx LC_ALL
24304 @findex LANG
24305 @findex LC_CTYPE
24306 @c @findex LC_COLLATE
24307 @findex LC_MESSAGES
24308 @c @findex LC_MONETARY
24309 @c @findex LC_NUMERIC
24310 @c @findex LC_TIME
24311 @findex LC_ALL
24312 @cindex locale
24313 These environment variables control the way that GCC uses
24314 localization information which allows GCC to work with different
24315 national conventions.  GCC inspects the locale categories
24316 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
24317 so.  These locale categories can be set to any value supported by your
24318 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
24319 Kingdom encoded in UTF-8.
24321 The @env{LC_CTYPE} environment variable specifies character
24322 classification.  GCC uses it to determine the character boundaries in
24323 a string; this is needed for some multibyte encodings that contain quote
24324 and escape characters that are otherwise interpreted as a string
24325 end or escape.
24327 The @env{LC_MESSAGES} environment variable specifies the language to
24328 use in diagnostic messages.
24330 If the @env{LC_ALL} environment variable is set, it overrides the value
24331 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
24332 and @env{LC_MESSAGES} default to the value of the @env{LANG}
24333 environment variable.  If none of these variables are set, GCC
24334 defaults to traditional C English behavior.
24336 @item TMPDIR
24337 @findex TMPDIR
24338 If @env{TMPDIR} is set, it specifies the directory to use for temporary
24339 files.  GCC uses temporary files to hold the output of one stage of
24340 compilation which is to be used as input to the next stage: for example,
24341 the output of the preprocessor, which is the input to the compiler
24342 proper.
24344 @item GCC_COMPARE_DEBUG
24345 @findex GCC_COMPARE_DEBUG
24346 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
24347 @option{-fcompare-debug} to the compiler driver.  See the documentation
24348 of this option for more details.
24350 @item GCC_EXEC_PREFIX
24351 @findex GCC_EXEC_PREFIX
24352 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
24353 names of the subprograms executed by the compiler.  No slash is added
24354 when this prefix is combined with the name of a subprogram, but you can
24355 specify a prefix that ends with a slash if you wish.
24357 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
24358 an appropriate prefix to use based on the pathname it is invoked with.
24360 If GCC cannot find the subprogram using the specified prefix, it
24361 tries looking in the usual places for the subprogram.
24363 The default value of @env{GCC_EXEC_PREFIX} is
24364 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
24365 the installed compiler. In many cases @var{prefix} is the value
24366 of @code{prefix} when you ran the @file{configure} script.
24368 Other prefixes specified with @option{-B} take precedence over this prefix.
24370 This prefix is also used for finding files such as @file{crt0.o} that are
24371 used for linking.
24373 In addition, the prefix is used in an unusual way in finding the
24374 directories to search for header files.  For each of the standard
24375 directories whose name normally begins with @samp{/usr/local/lib/gcc}
24376 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
24377 replacing that beginning with the specified prefix to produce an
24378 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
24379 @file{foo/bar} just before it searches the standard directory 
24380 @file{/usr/local/lib/bar}.
24381 If a standard directory begins with the configured
24382 @var{prefix} then the value of @var{prefix} is replaced by
24383 @env{GCC_EXEC_PREFIX} when looking for header files.
24385 @item COMPILER_PATH
24386 @findex COMPILER_PATH
24387 The value of @env{COMPILER_PATH} is a colon-separated list of
24388 directories, much like @env{PATH}.  GCC tries the directories thus
24389 specified when searching for subprograms, if it can't find the
24390 subprograms using @env{GCC_EXEC_PREFIX}.
24392 @item LIBRARY_PATH
24393 @findex LIBRARY_PATH
24394 The value of @env{LIBRARY_PATH} is a colon-separated list of
24395 directories, much like @env{PATH}.  When configured as a native compiler,
24396 GCC tries the directories thus specified when searching for special
24397 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
24398 using GCC also uses these directories when searching for ordinary
24399 libraries for the @option{-l} option (but directories specified with
24400 @option{-L} come first).
24402 @item LANG
24403 @findex LANG
24404 @cindex locale definition
24405 This variable is used to pass locale information to the compiler.  One way in
24406 which this information is used is to determine the character set to be used
24407 when character literals, string literals and comments are parsed in C and C++.
24408 When the compiler is configured to allow multibyte characters,
24409 the following values for @env{LANG} are recognized:
24411 @table @samp
24412 @item C-JIS
24413 Recognize JIS characters.
24414 @item C-SJIS
24415 Recognize SJIS characters.
24416 @item C-EUCJP
24417 Recognize EUCJP characters.
24418 @end table
24420 If @env{LANG} is not defined, or if it has some other value, then the
24421 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
24422 recognize and translate multibyte characters.
24423 @end table
24425 @noindent
24426 Some additional environment variables affect the behavior of the
24427 preprocessor.
24429 @include cppenv.texi
24431 @c man end
24433 @node Precompiled Headers
24434 @section Using Precompiled Headers
24435 @cindex precompiled headers
24436 @cindex speed of compilation
24438 Often large projects have many header files that are included in every
24439 source file.  The time the compiler takes to process these header files
24440 over and over again can account for nearly all of the time required to
24441 build the project.  To make builds faster, GCC allows you to
24442 @dfn{precompile} a header file.
24444 To create a precompiled header file, simply compile it as you would any
24445 other file, if necessary using the @option{-x} option to make the driver
24446 treat it as a C or C++ header file.  You may want to use a
24447 tool like @command{make} to keep the precompiled header up-to-date when
24448 the headers it contains change.
24450 A precompiled header file is searched for when @code{#include} is
24451 seen in the compilation.  As it searches for the included file
24452 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
24453 compiler looks for a precompiled header in each directory just before it
24454 looks for the include file in that directory.  The name searched for is
24455 the name specified in the @code{#include} with @samp{.gch} appended.  If
24456 the precompiled header file can't be used, it is ignored.
24458 For instance, if you have @code{#include "all.h"}, and you have
24459 @file{all.h.gch} in the same directory as @file{all.h}, then the
24460 precompiled header file is used if possible, and the original
24461 header is used otherwise.
24463 Alternatively, you might decide to put the precompiled header file in a
24464 directory and use @option{-I} to ensure that directory is searched
24465 before (or instead of) the directory containing the original header.
24466 Then, if you want to check that the precompiled header file is always
24467 used, you can put a file of the same name as the original header in this
24468 directory containing an @code{#error} command.
24470 This also works with @option{-include}.  So yet another way to use
24471 precompiled headers, good for projects not designed with precompiled
24472 header files in mind, is to simply take most of the header files used by
24473 a project, include them from another header file, precompile that header
24474 file, and @option{-include} the precompiled header.  If the header files
24475 have guards against multiple inclusion, they are skipped because
24476 they've already been included (in the precompiled header).
24478 If you need to precompile the same header file for different
24479 languages, targets, or compiler options, you can instead make a
24480 @emph{directory} named like @file{all.h.gch}, and put each precompiled
24481 header in the directory, perhaps using @option{-o}.  It doesn't matter
24482 what you call the files in the directory; every precompiled header in
24483 the directory is considered.  The first precompiled header
24484 encountered in the directory that is valid for this compilation is
24485 used; they're searched in no particular order.
24487 There are many other possibilities, limited only by your imagination,
24488 good sense, and the constraints of your build system.
24490 A precompiled header file can be used only when these conditions apply:
24492 @itemize
24493 @item
24494 Only one precompiled header can be used in a particular compilation.
24496 @item
24497 A precompiled header can't be used once the first C token is seen.  You
24498 can have preprocessor directives before a precompiled header; you cannot
24499 include a precompiled header from inside another header.
24501 @item
24502 The precompiled header file must be produced for the same language as
24503 the current compilation.  You can't use a C precompiled header for a C++
24504 compilation.
24506 @item
24507 The precompiled header file must have been produced by the same compiler
24508 binary as the current compilation is using.
24510 @item
24511 Any macros defined before the precompiled header is included must
24512 either be defined in the same way as when the precompiled header was
24513 generated, or must not affect the precompiled header, which usually
24514 means that they don't appear in the precompiled header at all.
24516 The @option{-D} option is one way to define a macro before a
24517 precompiled header is included; using a @code{#define} can also do it.
24518 There are also some options that define macros implicitly, like
24519 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
24520 defined this way.
24522 @item If debugging information is output when using the precompiled
24523 header, using @option{-g} or similar, the same kind of debugging information
24524 must have been output when building the precompiled header.  However,
24525 a precompiled header built using @option{-g} can be used in a compilation
24526 when no debugging information is being output.
24528 @item The same @option{-m} options must generally be used when building
24529 and using the precompiled header.  @xref{Submodel Options},
24530 for any cases where this rule is relaxed.
24532 @item Each of the following options must be the same when building and using
24533 the precompiled header:
24535 @gccoptlist{-fexceptions}
24537 @item
24538 Some other command-line options starting with @option{-f},
24539 @option{-p}, or @option{-O} must be defined in the same way as when
24540 the precompiled header was generated.  At present, it's not clear
24541 which options are safe to change and which are not; the safest choice
24542 is to use exactly the same options when generating and using the
24543 precompiled header.  The following are known to be safe:
24545 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
24546 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
24547 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
24548 -pedantic-errors}
24550 @end itemize
24552 For all of these except the last, the compiler automatically
24553 ignores the precompiled header if the conditions aren't met.  If you
24554 find an option combination that doesn't work and doesn't cause the
24555 precompiled header to be ignored, please consider filing a bug report,
24556 see @ref{Bugs}.
24558 If you do use differing options when generating and using the
24559 precompiled header, the actual behavior is a mixture of the
24560 behavior for the options.  For instance, if you use @option{-g} to
24561 generate the precompiled header but not when using it, you may or may
24562 not get debugging information for routines in the precompiled header.