2015-07-14 Sandra Loosemore <sandra@codesourcery.com>
[official-gcc.git] / gcc / doc / invoke.texi
blob522e924f03b1298de475e186a546a2f364cecaaa
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 * Language Independent Options:: Controlling how diagnostics should be
129                         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 Language Independent Options
232 @xref{Language Independent 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 @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 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
264 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
265 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args @gol
266 -Wmisleading-indentation -Wmissing-braces @gol
267 -Wmissing-field-initializers -Wmissing-include-dirs @gol
268 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
269 -Wodr  -Wno-overflow  -Wopenmp-simd @gol
270 -Woverride-init-side-effects @gol
271 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
272 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
273 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
274 -Wredundant-decls  -Wno-return-local-addr @gol
275 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
276 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
277 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
278 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
279 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
280 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
281 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
282 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
283 -Wmissing-format-attribute @gol
284 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
285 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
286 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
287 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
288 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
289 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
290 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
291 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
292 -Wvla -Wvolatile-register-var  -Wwrite-strings @gol
293 -Wzero-as-null-pointer-constant}
295 @item C and Objective-C-only Warning Options
296 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
297 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
298 -Wold-style-declaration  -Wold-style-definition @gol
299 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
300 -Wdeclaration-after-statement -Wpointer-sign}
302 @item Debugging Options
303 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
304 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
305 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
306 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
307 -fsanitize-undefined-trap-on-error @gol
308 -fcheck-pointer-bounds -fchkp-check-incomplete-type @gol
309 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
310 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
311 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
312 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
313 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
314 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
315 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
316 -fchkp-use-wrappers @gol
317 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
318 -fdisable-ipa-@var{pass_name} @gol
319 -fdisable-rtl-@var{pass_name} @gol
320 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
321 -fdisable-tree-@var{pass_name} @gol
322 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
323 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
324 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
325 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
326 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
327 -fdump-passes @gol
328 -fdump-statistics @gol
329 -fdump-tree-all @gol
330 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
331 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
332 -fdump-tree-cfg -fdump-tree-alias @gol
333 -fdump-tree-ch @gol
334 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
335 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
336 -fdump-tree-gimple@r{[}-raw@r{]} @gol
337 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
338 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
339 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
340 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
341 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
342 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
343 -fdump-tree-nrv -fdump-tree-vect @gol
344 -fdump-tree-sink @gol
345 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
346 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
347 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
348 -fdump-tree-vtable-verify @gol
349 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
350 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
351 -fdump-final-insns=@var{file} @gol
352 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
353 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
354 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
355 -fenable-@var{kind}-@var{pass} @gol
356 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
357 -fdebug-types-section -fmem-report-wpa @gol
358 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
359 -fopt-info @gol
360 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
361 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
362 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
363 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
364 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
365 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
366 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
367 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
368 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
369 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
370 -fdebug-prefix-map=@var{old}=@var{new} @gol
371 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
372 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
373 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
374 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
375 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
376 -print-sysroot -print-sysroot-headers-suffix @gol
377 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
379 @item Optimization Options
380 @xref{Optimize Options,,Options that Control Optimization}.
381 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
382 -falign-jumps[=@var{n}] @gol
383 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
384 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
385 -fauto-inc-dec -fbranch-probabilities @gol
386 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
387 -fbtr-bb-exclusive -fcaller-saves @gol
388 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
389 -fcompare-elim -fcprop-registers -fcrossjumping @gol
390 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
391 -fcx-limited-range @gol
392 -fdata-sections -fdce -fdelayed-branch @gol
393 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
394 -fdevirtualize-at-ltrans -fdse @gol
395 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
396 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
397 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
398 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
399 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
400 -fif-conversion2 -findirect-inlining @gol
401 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
402 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment @gol
403 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
404 -fira-algorithm=@var{algorithm} @gol
405 -fira-region=@var{region} -fira-hoist-pressure @gol
406 -fira-loop-pressure -fno-ira-share-save-slots @gol
407 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
408 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
409 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
410 -flive-range-shrinkage @gol
411 -floop-block -floop-interchange -floop-strip-mine @gol
412 -floop-unroll-and-jam -floop-nest-optimize @gol
413 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
414 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
415 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
416 -fmove-loop-invariants -fno-branch-count-reg @gol
417 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
418 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
419 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
420 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
421 -fomit-frame-pointer -foptimize-sibling-calls @gol
422 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
423 -fprefetch-loop-arrays -fprofile-report @gol
424 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
425 -fprofile-generate=@var{path} @gol
426 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
427 -fprofile-reorder-functions @gol
428 -freciprocal-math -free -frename-registers -freorder-blocks @gol
429 -freorder-blocks-and-partition -freorder-functions @gol
430 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
431 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
432 -fsched-spec-load -fsched-spec-load-dangerous @gol
433 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
434 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
435 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
436 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
437 -fschedule-fusion @gol
438 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
439 -fselective-scheduling -fselective-scheduling2 @gol
440 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
441 -fsemantic-interposition @gol
442 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
443 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt @gol
444 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
445 -fstack-protector-explicit -fstdarg-opt -fstrict-aliasing @gol
446 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
447 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
448 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
449 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
450 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
451 -ftree-loop-if-convert-stores -ftree-loop-im @gol
452 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
453 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
454 -ftree-loop-vectorize @gol
455 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
456 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
457 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
458 -ftree-vectorize -ftree-vrp @gol
459 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
460 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
461 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
462 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
463 --param @var{name}=@var{value}
464 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
466 @item Preprocessor Options
467 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
468 @gccoptlist{-A@var{question}=@var{answer} @gol
469 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
470 -C  -dD  -dI  -dM  -dN @gol
471 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
472 -idirafter @var{dir} @gol
473 -include @var{file}  -imacros @var{file} @gol
474 -iprefix @var{file}  -iwithprefix @var{dir} @gol
475 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
476 -imultilib @var{dir} -isysroot @var{dir} @gol
477 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
478 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
479 -remap -trigraphs  -undef  -U@var{macro}  @gol
480 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
482 @item Assembler Option
483 @xref{Assembler Options,,Passing Options to the Assembler}.
484 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
486 @item Linker Options
487 @xref{Link Options,,Options for Linking}.
488 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
489 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
490 -s  -static -static-libgcc -static-libstdc++ @gol
491 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
492 -static-libmpx -static-libmpxwrappers @gol
493 -shared -shared-libgcc  -symbolic @gol
494 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
495 -u @var{symbol} -z @var{keyword}}
497 @item Directory Options
498 @xref{Directory Options,,Options for Directory Search}.
499 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
500 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
501 --sysroot=@var{dir} --no-sysroot-suffix}
503 @item Machine Dependent Options
504 @xref{Submodel Options,,Hardware Models and Configurations}.
505 @c This list is ordered alphanumerically by subsection name.
506 @c Try and put the significant identifier (CPU or system) first,
507 @c so users have a clue at guessing where the ones they want will be.
509 @emph{AArch64 Options}
510 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
511 -mgeneral-regs-only @gol
512 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
513 -mstrict-align @gol
514 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
515 -mtls-dialect=desc  -mtls-dialect=traditional @gol
516 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
517 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
518 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
520 @emph{Adapteva Epiphany Options}
521 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
522 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
523 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
524 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
525 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
526 -msplit-vecmove-early -m1reg-@var{reg}}
528 @emph{ARC Options}
529 @gccoptlist{-mbarrel-shifter @gol
530 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
531 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
532 -mea -mno-mpy -mmul32x16 -mmul64 @gol
533 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
534 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
535 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
536 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
537 -mucb-mcount -mvolatile-cache @gol
538 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
539 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
540 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
541 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
542 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
543 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
545 @emph{ARM Options}
546 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
547 -mabi=@var{name} @gol
548 -mapcs-stack-check  -mno-apcs-stack-check @gol
549 -mapcs-float  -mno-apcs-float @gol
550 -mapcs-reentrant  -mno-apcs-reentrant @gol
551 -msched-prolog  -mno-sched-prolog @gol
552 -mlittle-endian  -mbig-endian @gol
553 -mfloat-abi=@var{name} @gol
554 -mfp16-format=@var{name}
555 -mthumb-interwork  -mno-thumb-interwork @gol
556 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
557 -mtune=@var{name} -mprint-tune-info @gol
558 -mstructure-size-boundary=@var{n} @gol
559 -mabort-on-noreturn @gol
560 -mlong-calls  -mno-long-calls @gol
561 -msingle-pic-base  -mno-single-pic-base @gol
562 -mpic-register=@var{reg} @gol
563 -mnop-fun-dllimport @gol
564 -mpoke-function-name @gol
565 -mthumb  -marm @gol
566 -mtpcs-frame  -mtpcs-leaf-frame @gol
567 -mcaller-super-interworking  -mcallee-super-interworking @gol
568 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
569 -mword-relocations @gol
570 -mfix-cortex-m3-ldrd @gol
571 -munaligned-access @gol
572 -mneon-for-64bits @gol
573 -mslow-flash-data @gol
574 -masm-syntax-unified @gol
575 -mrestrict-it}
577 @emph{AVR Options}
578 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
579 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
580 -mrelax -mrmw -mstrict-X -mtiny-stack -nodevicelib -Waddr-space-convert}
582 @emph{Blackfin Options}
583 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
584 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
585 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
586 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
587 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
588 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
589 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
590 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
591 -micplb}
593 @emph{C6X Options}
594 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
595 -msim -msdata=@var{sdata-type}}
597 @emph{CRIS Options}
598 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
599 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
600 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
601 -mstack-align  -mdata-align  -mconst-align @gol
602 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
603 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
604 -mmul-bug-workaround  -mno-mul-bug-workaround}
606 @emph{CR16 Options}
607 @gccoptlist{-mmac @gol
608 -mcr16cplus -mcr16c @gol
609 -msim -mint32 -mbit-ops
610 -mdata-model=@var{model}}
612 @emph{Darwin Options}
613 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
614 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
615 -client_name  -compatibility_version  -current_version @gol
616 -dead_strip @gol
617 -dependency-file  -dylib_file  -dylinker_install_name @gol
618 -dynamic  -dynamiclib  -exported_symbols_list @gol
619 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
620 -force_flat_namespace  -headerpad_max_install_names @gol
621 -iframework @gol
622 -image_base  -init  -install_name  -keep_private_externs @gol
623 -multi_module  -multiply_defined  -multiply_defined_unused @gol
624 -noall_load   -no_dead_strip_inits_and_terms @gol
625 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
626 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
627 -private_bundle  -read_only_relocs  -sectalign @gol
628 -sectobjectsymbols  -whyload  -seg1addr @gol
629 -sectcreate  -sectobjectsymbols  -sectorder @gol
630 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
631 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
632 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
633 -single_module  -static  -sub_library  -sub_umbrella @gol
634 -twolevel_namespace  -umbrella  -undefined @gol
635 -unexported_symbols_list  -weak_reference_mismatches @gol
636 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
637 -mkernel -mone-byte-bool}
639 @emph{DEC Alpha Options}
640 @gccoptlist{-mno-fp-regs  -msoft-float @gol
641 -mieee  -mieee-with-inexact  -mieee-conformant @gol
642 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
643 -mtrap-precision=@var{mode}  -mbuild-constants @gol
644 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
645 -mbwx  -mmax  -mfix  -mcix @gol
646 -mfloat-vax  -mfloat-ieee @gol
647 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
648 -msmall-text  -mlarge-text @gol
649 -mmemory-latency=@var{time}}
651 @emph{FR30 Options}
652 @gccoptlist{-msmall-model -mno-lsim}
654 @emph{FT32 Options}
655 @gccoptlist{-msim -mlra}
657 @emph{FRV Options}
658 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
659 -mhard-float  -msoft-float @gol
660 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
661 -mdouble  -mno-double @gol
662 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
663 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
664 -mlinked-fp  -mlong-calls  -malign-labels @gol
665 -mlibrary-pic  -macc-4  -macc-8 @gol
666 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
667 -moptimize-membar -mno-optimize-membar @gol
668 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
669 -mvliw-branch  -mno-vliw-branch @gol
670 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
671 -mno-nested-cond-exec  -mtomcat-stats @gol
672 -mTLS -mtls @gol
673 -mcpu=@var{cpu}}
675 @emph{GNU/Linux Options}
676 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
677 -tno-android-cc -tno-android-ld}
679 @emph{H8/300 Options}
680 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
682 @emph{HPPA Options}
683 @gccoptlist{-march=@var{architecture-type} @gol
684 -mdisable-fpregs  -mdisable-indexing @gol
685 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
686 -mfixed-range=@var{register-range} @gol
687 -mjump-in-delay -mlinker-opt -mlong-calls @gol
688 -mlong-load-store  -mno-disable-fpregs @gol
689 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
690 -mno-jump-in-delay  -mno-long-load-store @gol
691 -mno-portable-runtime  -mno-soft-float @gol
692 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
693 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
694 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
695 -munix=@var{unix-std}  -nolibdld  -static  -threads}
697 @emph{IA-64 Options}
698 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
699 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
700 -mconstant-gp  -mauto-pic  -mfused-madd @gol
701 -minline-float-divide-min-latency @gol
702 -minline-float-divide-max-throughput @gol
703 -mno-inline-float-divide @gol
704 -minline-int-divide-min-latency @gol
705 -minline-int-divide-max-throughput  @gol
706 -mno-inline-int-divide @gol
707 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
708 -mno-inline-sqrt @gol
709 -mdwarf2-asm -mearly-stop-bits @gol
710 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
711 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
712 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
713 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
714 -msched-spec-ldc -msched-spec-control-ldc @gol
715 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
716 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
717 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
718 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
720 @emph{LM32 Options}
721 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
722 -msign-extend-enabled -muser-enabled}
724 @emph{M32R/D Options}
725 @gccoptlist{-m32r2 -m32rx -m32r @gol
726 -mdebug @gol
727 -malign-loops -mno-align-loops @gol
728 -missue-rate=@var{number} @gol
729 -mbranch-cost=@var{number} @gol
730 -mmodel=@var{code-size-model-type} @gol
731 -msdata=@var{sdata-type} @gol
732 -mno-flush-func -mflush-func=@var{name} @gol
733 -mno-flush-trap -mflush-trap=@var{number} @gol
734 -G @var{num}}
736 @emph{M32C Options}
737 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
739 @emph{M680x0 Options}
740 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
741 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
742 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
743 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
744 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
745 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
746 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
747 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
748 -mxgot -mno-xgot}
750 @emph{MCore Options}
751 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
752 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
753 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
754 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
755 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
757 @emph{MeP Options}
758 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
759 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
760 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
761 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
762 -mtiny=@var{n}}
764 @emph{MicroBlaze Options}
765 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
766 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
767 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
768 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
769 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
771 @emph{MIPS Options}
772 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
773 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
774 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
775 -mips16  -mno-mips16  -mflip-mips16 @gol
776 -minterlink-compressed -mno-interlink-compressed @gol
777 -minterlink-mips16  -mno-interlink-mips16 @gol
778 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
779 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
780 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
781 -mno-float  -msingle-float  -mdouble-float @gol
782 -modd-spreg -mno-odd-spreg @gol
783 -mabs=@var{mode}  -mnan=@var{encoding} @gol
784 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
785 -mmcu -mmno-mcu @gol
786 -meva -mno-eva @gol
787 -mvirt -mno-virt @gol
788 -mxpa -mno-xpa @gol
789 -mmicromips -mno-micromips @gol
790 -mfpu=@var{fpu-type} @gol
791 -msmartmips  -mno-smartmips @gol
792 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
793 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
794 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
795 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
796 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
797 -membedded-data  -mno-embedded-data @gol
798 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
799 -mcode-readable=@var{setting} @gol
800 -msplit-addresses  -mno-split-addresses @gol
801 -mexplicit-relocs  -mno-explicit-relocs @gol
802 -mcheck-zero-division  -mno-check-zero-division @gol
803 -mdivide-traps  -mdivide-breaks @gol
804 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
805 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
806 -mfix-24k -mno-fix-24k @gol
807 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
808 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
809 -mfix-vr4120  -mno-fix-vr4120 @gol
810 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
811 -mflush-func=@var{func}  -mno-flush-func @gol
812 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
813 -mfp-exceptions -mno-fp-exceptions @gol
814 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
815 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
817 @emph{MMIX Options}
818 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
819 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
820 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
821 -mno-base-addresses  -msingle-exit  -mno-single-exit}
823 @emph{MN10300 Options}
824 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
825 -mno-am33 -mam33 -mam33-2 -mam34 @gol
826 -mtune=@var{cpu-type} @gol
827 -mreturn-pointer-on-d0 @gol
828 -mno-crt0  -mrelax -mliw -msetlb}
830 @emph{Moxie Options}
831 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
833 @emph{MSP430 Options}
834 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
835 -mcode-region= -mdata-region= @gol
836 -mhwmult= -minrt}
838 @emph{NDS32 Options}
839 @gccoptlist{-mbig-endian -mlittle-endian @gol
840 -mreduced-regs -mfull-regs @gol
841 -mcmov -mno-cmov @gol
842 -mperf-ext -mno-perf-ext @gol
843 -mv3push -mno-v3push @gol
844 -m16bit -mno-16bit @gol
845 -misr-vector-size=@var{num} @gol
846 -mcache-block-size=@var{num} @gol
847 -march=@var{arch} @gol
848 -mcmodel=@var{code-model} @gol
849 -mctor-dtor -mrelax}
851 @emph{Nios II Options}
852 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
853 -mel -meb @gol
854 -mno-bypass-cache -mbypass-cache @gol
855 -mno-cache-volatile -mcache-volatile @gol
856 -mno-fast-sw-div -mfast-sw-div @gol
857 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
858 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
859 -mcustom-fpu-cfg=@var{name} @gol
860 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
861 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
863 @emph{Nvidia PTX Options}
864 @gccoptlist{-m32 -m64 -mmainkernel}
866 @emph{PDP-11 Options}
867 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
868 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
869 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
870 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
871 -mbranch-expensive  -mbranch-cheap @gol
872 -munix-asm  -mdec-asm}
874 @emph{picoChip Options}
875 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
876 -msymbol-as-address -mno-inefficient-warnings}
878 @emph{PowerPC Options}
879 See RS/6000 and PowerPC Options.
881 @emph{RL78 Options}
882 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
883 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
884 -m64bit-doubles -m32bit-doubles}
886 @emph{RS/6000 and PowerPC Options}
887 @gccoptlist{-mcpu=@var{cpu-type} @gol
888 -mtune=@var{cpu-type} @gol
889 -mcmodel=@var{code-model} @gol
890 -mpowerpc64 @gol
891 -maltivec  -mno-altivec @gol
892 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
893 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
894 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
895 -mfprnd  -mno-fprnd @gol
896 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
897 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
898 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
899 -malign-power  -malign-natural @gol
900 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
901 -msingle-float -mdouble-float -msimple-fpu @gol
902 -mstring  -mno-string  -mupdate  -mno-update @gol
903 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
904 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
905 -mstrict-align  -mno-strict-align  -mrelocatable @gol
906 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
907 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
908 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
909 -mprioritize-restricted-insns=@var{priority} @gol
910 -msched-costly-dep=@var{dependence_type} @gol
911 -minsert-sched-nops=@var{scheme} @gol
912 -mcall-sysv  -mcall-netbsd @gol
913 -maix-struct-return  -msvr4-struct-return @gol
914 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
915 -mblock-move-inline-limit=@var{num} @gol
916 -misel -mno-isel @gol
917 -misel=yes  -misel=no @gol
918 -mspe -mno-spe @gol
919 -mspe=yes  -mspe=no @gol
920 -mpaired @gol
921 -mgen-cell-microcode -mwarn-cell-microcode @gol
922 -mvrsave -mno-vrsave @gol
923 -mmulhw -mno-mulhw @gol
924 -mdlmzb -mno-dlmzb @gol
925 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
926 -mprototype  -mno-prototype @gol
927 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
928 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
929 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
930 -mno-recip-precision @gol
931 -mveclibabi=@var{type} -mfriz -mno-friz @gol
932 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
933 -msave-toc-indirect -mno-save-toc-indirect @gol
934 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
935 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
936 -mquad-memory -mno-quad-memory @gol
937 -mquad-memory-atomic -mno-quad-memory-atomic @gol
938 -mcompat-align-parm -mno-compat-align-parm @gol
939 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
940 -mupper-regs -mno-upper-regs}
942 @emph{RX Options}
943 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
944 -mcpu=@gol
945 -mbig-endian-data -mlittle-endian-data @gol
946 -msmall-data @gol
947 -msim  -mno-sim@gol
948 -mas100-syntax -mno-as100-syntax@gol
949 -mrelax@gol
950 -mmax-constant-size=@gol
951 -mint-register=@gol
952 -mpid@gol
953 -mallow-string-insns -mno-allow-string-insns@gol
954 -mno-warn-multiple-fast-interrupts@gol
955 -msave-acc-in-interrupts}
957 @emph{S/390 and zSeries Options}
958 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
959 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
960 -mlong-double-64 -mlong-double-128 @gol
961 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
962 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
963 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
964 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
965 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
966 -mhotpatch=@var{halfwords},@var{halfwords}}
968 @emph{Score Options}
969 @gccoptlist{-meb -mel @gol
970 -mnhwloop @gol
971 -muls @gol
972 -mmac @gol
973 -mscore5 -mscore5u -mscore7 -mscore7d}
975 @emph{SH Options}
976 @gccoptlist{-m1  -m2  -m2e @gol
977 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
978 -m3  -m3e @gol
979 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
980 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
981 -m5-64media  -m5-64media-nofpu @gol
982 -m5-32media  -m5-32media-nofpu @gol
983 -m5-compact  -m5-compact-nofpu @gol
984 -mb  -ml  -mdalign  -mrelax @gol
985 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
986 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
987 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
988 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
989 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
990 -maccumulate-outgoing-args -minvalid-symbols @gol
991 -matomic-model=@var{atomic-model} @gol
992 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
993 -mcbranch-force-delay-slot @gol
994 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
995 -mpretend-cmove -mtas}
997 @emph{Solaris 2 Options}
998 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
999 -pthreads -pthread}
1001 @emph{SPARC Options}
1002 @gccoptlist{-mcpu=@var{cpu-type} @gol
1003 -mtune=@var{cpu-type} @gol
1004 -mcmodel=@var{code-model} @gol
1005 -mmemory-model=@var{mem-model} @gol
1006 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1007 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1008 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1009 -mhard-quad-float  -msoft-quad-float @gol
1010 -mstack-bias  -mno-stack-bias @gol
1011 -munaligned-doubles  -mno-unaligned-doubles @gol
1012 -muser-mode  -mno-user-mode @gol
1013 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1014 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1015 -mcbcond -mno-cbcond @gol
1016 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1017 -mfix-at697f -mfix-ut699}
1019 @emph{SPU Options}
1020 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1021 -msafe-dma -munsafe-dma @gol
1022 -mbranch-hints @gol
1023 -msmall-mem -mlarge-mem -mstdmain @gol
1024 -mfixed-range=@var{register-range} @gol
1025 -mea32 -mea64 @gol
1026 -maddress-space-conversion -mno-address-space-conversion @gol
1027 -mcache-size=@var{cache-size} @gol
1028 -matomic-updates -mno-atomic-updates}
1030 @emph{System V Options}
1031 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1033 @emph{TILE-Gx Options}
1034 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1035 -mcmodel=@var{code-model}}
1037 @emph{TILEPro Options}
1038 @gccoptlist{-mcpu=@var{cpu} -m32}
1040 @emph{V850 Options}
1041 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1042 -mprolog-function  -mno-prolog-function  -mspace @gol
1043 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1044 -mapp-regs  -mno-app-regs @gol
1045 -mdisable-callt  -mno-disable-callt @gol
1046 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1047 -mv850e -mv850 -mv850e3v5 @gol
1048 -mloop @gol
1049 -mrelax @gol
1050 -mlong-jumps @gol
1051 -msoft-float @gol
1052 -mhard-float @gol
1053 -mgcc-abi @gol
1054 -mrh850-abi @gol
1055 -mbig-switch}
1057 @emph{VAX Options}
1058 @gccoptlist{-mg  -mgnu  -munix}
1060 @emph{Visium Options}
1061 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1062 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1064 @emph{VMS Options}
1065 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1066 -mpointer-size=@var{size}}
1068 @emph{VxWorks Options}
1069 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1070 -Xbind-lazy  -Xbind-now}
1072 @emph{x86 Options}
1073 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1074 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1075 -mfpmath=@var{unit} @gol
1076 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1077 -mno-fp-ret-in-387  -msoft-float @gol
1078 -mno-wide-multiply  -mrtd  -malign-double @gol
1079 -mpreferred-stack-boundary=@var{num} @gol
1080 -mincoming-stack-boundary=@var{num} @gol
1081 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1082 -mrecip -mrecip=@var{opt} @gol
1083 -mvzeroupper -mprefer-avx128 @gol
1084 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1085 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
1086 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
1087 -mclflushopt -mxsavec -mxsaves @gol
1088 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1089 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mthreads @gol
1090 -mno-align-stringops  -minline-all-stringops @gol
1091 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1092 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1093 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1094 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1095 -mregparm=@var{num}  -msseregparm @gol
1096 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1097 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1098 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1099 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1100 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1101 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1102 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1103 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
1105 @emph{x86 Windows Options}
1106 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1107 -mnop-fun-dllimport -mthread @gol
1108 -municode -mwin32 -mwindows -fno-set-stack-executable}
1110 @emph{Xstormy16 Options}
1111 @gccoptlist{-msim}
1113 @emph{Xtensa Options}
1114 @gccoptlist{-mconst16 -mno-const16 @gol
1115 -mfused-madd  -mno-fused-madd @gol
1116 -mforce-no-pic @gol
1117 -mserialize-volatile  -mno-serialize-volatile @gol
1118 -mtext-section-literals  -mno-text-section-literals @gol
1119 -mtarget-align  -mno-target-align @gol
1120 -mlongcalls  -mno-longcalls}
1122 @emph{zSeries Options}
1123 See S/390 and zSeries Options.
1125 @item Code Generation Options
1126 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1127 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1128 -ffixed-@var{reg}  -fexceptions @gol
1129 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1130 -fasynchronous-unwind-tables @gol
1131 -fno-gnu-unique @gol
1132 -finhibit-size-directive  -finstrument-functions @gol
1133 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1134 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1135 -fno-common  -fno-ident @gol
1136 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
1137 -fno-jump-tables @gol
1138 -frecord-gcc-switches @gol
1139 -freg-struct-return  -fshort-enums @gol
1140 -fshort-double  -fshort-wchar @gol
1141 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1142 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1143 -fno-stack-limit -fsplit-stack @gol
1144 -fleading-underscore  -ftls-model=@var{model} @gol
1145 -fstack-reuse=@var{reuse_level} @gol
1146 -ftrapv  -fwrapv  -fbounds-check @gol
1147 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
1148 -fstrict-volatile-bitfields -fsync-libcalls}
1149 @end table
1152 @node Overall Options
1153 @section Options Controlling the Kind of Output
1155 Compilation can involve up to four stages: preprocessing, compilation
1156 proper, assembly and linking, always in that order.  GCC is capable of
1157 preprocessing and compiling several files either into several
1158 assembler input files, or into one assembler input file; then each
1159 assembler input file produces an object file, and linking combines all
1160 the object files (those newly compiled, and those specified as input)
1161 into an executable file.
1163 @cindex file name suffix
1164 For any given input file, the file name suffix determines what kind of
1165 compilation is done:
1167 @table @gcctabopt
1168 @item @var{file}.c
1169 C source code that must be preprocessed.
1171 @item @var{file}.i
1172 C source code that should not be preprocessed.
1174 @item @var{file}.ii
1175 C++ source code that should not be preprocessed.
1177 @item @var{file}.m
1178 Objective-C source code.  Note that you must link with the @file{libobjc}
1179 library to make an Objective-C program work.
1181 @item @var{file}.mi
1182 Objective-C source code that should not be preprocessed.
1184 @item @var{file}.mm
1185 @itemx @var{file}.M
1186 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1187 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1188 to a literal capital M@.
1190 @item @var{file}.mii
1191 Objective-C++ source code that should not be preprocessed.
1193 @item @var{file}.h
1194 C, C++, Objective-C or Objective-C++ header file to be turned into a
1195 precompiled header (default), or C, C++ header file to be turned into an
1196 Ada spec (via the @option{-fdump-ada-spec} switch).
1198 @item @var{file}.cc
1199 @itemx @var{file}.cp
1200 @itemx @var{file}.cxx
1201 @itemx @var{file}.cpp
1202 @itemx @var{file}.CPP
1203 @itemx @var{file}.c++
1204 @itemx @var{file}.C
1205 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1206 the last two letters must both be literally @samp{x}.  Likewise,
1207 @samp{.C} refers to a literal capital C@.
1209 @item @var{file}.mm
1210 @itemx @var{file}.M
1211 Objective-C++ source code that must be preprocessed.
1213 @item @var{file}.mii
1214 Objective-C++ source code that should not be preprocessed.
1216 @item @var{file}.hh
1217 @itemx @var{file}.H
1218 @itemx @var{file}.hp
1219 @itemx @var{file}.hxx
1220 @itemx @var{file}.hpp
1221 @itemx @var{file}.HPP
1222 @itemx @var{file}.h++
1223 @itemx @var{file}.tcc
1224 C++ header file to be turned into a precompiled header or Ada spec.
1226 @item @var{file}.f
1227 @itemx @var{file}.for
1228 @itemx @var{file}.ftn
1229 Fixed form Fortran source code that should not be preprocessed.
1231 @item @var{file}.F
1232 @itemx @var{file}.FOR
1233 @itemx @var{file}.fpp
1234 @itemx @var{file}.FPP
1235 @itemx @var{file}.FTN
1236 Fixed form Fortran source code that must be preprocessed (with the traditional
1237 preprocessor).
1239 @item @var{file}.f90
1240 @itemx @var{file}.f95
1241 @itemx @var{file}.f03
1242 @itemx @var{file}.f08
1243 Free form Fortran source code that should not be preprocessed.
1245 @item @var{file}.F90
1246 @itemx @var{file}.F95
1247 @itemx @var{file}.F03
1248 @itemx @var{file}.F08
1249 Free form Fortran source code that must be preprocessed (with the
1250 traditional preprocessor).
1252 @item @var{file}.go
1253 Go source code.
1255 @c FIXME: Descriptions of Java file types.
1256 @c @var{file}.java
1257 @c @var{file}.class
1258 @c @var{file}.zip
1259 @c @var{file}.jar
1261 @item @var{file}.ads
1262 Ada source code file that contains a library unit declaration (a
1263 declaration of a package, subprogram, or generic, or a generic
1264 instantiation), or a library unit renaming declaration (a package,
1265 generic, or subprogram renaming declaration).  Such files are also
1266 called @dfn{specs}.
1268 @item @var{file}.adb
1269 Ada source code file containing a library unit body (a subprogram or
1270 package body).  Such files are also called @dfn{bodies}.
1272 @c GCC also knows about some suffixes for languages not yet included:
1273 @c Pascal:
1274 @c @var{file}.p
1275 @c @var{file}.pas
1276 @c Ratfor:
1277 @c @var{file}.r
1279 @item @var{file}.s
1280 Assembler code.
1282 @item @var{file}.S
1283 @itemx @var{file}.sx
1284 Assembler code that must be preprocessed.
1286 @item @var{other}
1287 An object file to be fed straight into linking.
1288 Any file name with no recognized suffix is treated this way.
1289 @end table
1291 @opindex x
1292 You can specify the input language explicitly with the @option{-x} option:
1294 @table @gcctabopt
1295 @item -x @var{language}
1296 Specify explicitly the @var{language} for the following input files
1297 (rather than letting the compiler choose a default based on the file
1298 name suffix).  This option applies to all following input files until
1299 the next @option{-x} option.  Possible values for @var{language} are:
1300 @smallexample
1301 c  c-header  cpp-output
1302 c++  c++-header  c++-cpp-output
1303 objective-c  objective-c-header  objective-c-cpp-output
1304 objective-c++ objective-c++-header objective-c++-cpp-output
1305 assembler  assembler-with-cpp
1307 f77  f77-cpp-input f95  f95-cpp-input
1309 java
1310 @end smallexample
1312 @item -x none
1313 Turn off any specification of a language, so that subsequent files are
1314 handled according to their file name suffixes (as they are if @option{-x}
1315 has not been used at all).
1317 @item -pass-exit-codes
1318 @opindex pass-exit-codes
1319 Normally the @command{gcc} program exits with the code of 1 if any
1320 phase of the compiler returns a non-success return code.  If you specify
1321 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1322 the numerically highest error produced by any phase returning an error
1323 indication.  The C, C++, and Fortran front ends return 4 if an internal
1324 compiler error is encountered.
1325 @end table
1327 If you only want some of the stages of compilation, you can use
1328 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1329 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1330 @command{gcc} is to stop.  Note that some combinations (for example,
1331 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1333 @table @gcctabopt
1334 @item -c
1335 @opindex c
1336 Compile or assemble the source files, but do not link.  The linking
1337 stage simply is not done.  The ultimate output is in the form of an
1338 object file for each source file.
1340 By default, the object file name for a source file is made by replacing
1341 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1343 Unrecognized input files, not requiring compilation or assembly, are
1344 ignored.
1346 @item -S
1347 @opindex S
1348 Stop after the stage of compilation proper; do not assemble.  The output
1349 is in the form of an assembler code file for each non-assembler input
1350 file specified.
1352 By default, the assembler file name for a source file is made by
1353 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1355 Input files that don't require compilation are ignored.
1357 @item -E
1358 @opindex E
1359 Stop after the preprocessing stage; do not run the compiler proper.  The
1360 output is in the form of preprocessed source code, which is sent to the
1361 standard output.
1363 Input files that don't require preprocessing are ignored.
1365 @cindex output file option
1366 @item -o @var{file}
1367 @opindex o
1368 Place output in file @var{file}.  This applies to whatever
1369 sort of output is being produced, whether it be an executable file,
1370 an object file, an assembler file or preprocessed C code.
1372 If @option{-o} is not specified, the default is to put an executable
1373 file in @file{a.out}, the object file for
1374 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1375 assembler file in @file{@var{source}.s}, a precompiled header file in
1376 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1377 standard output.
1379 @item -v
1380 @opindex v
1381 Print (on standard error output) the commands executed to run the stages
1382 of compilation.  Also print the version number of the compiler driver
1383 program and of the preprocessor and the compiler proper.
1385 @item -###
1386 @opindex ###
1387 Like @option{-v} except the commands are not executed and arguments
1388 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1389 This is useful for shell scripts to capture the driver-generated command lines.
1391 @item -pipe
1392 @opindex pipe
1393 Use pipes rather than temporary files for communication between the
1394 various stages of compilation.  This fails to work on some systems where
1395 the assembler is unable to read from a pipe; but the GNU assembler has
1396 no trouble.
1398 @item --help
1399 @opindex help
1400 Print (on the standard output) a description of the command-line options
1401 understood by @command{gcc}.  If the @option{-v} option is also specified
1402 then @option{--help} is also passed on to the various processes
1403 invoked by @command{gcc}, so that they can display the command-line options
1404 they accept.  If the @option{-Wextra} option has also been specified
1405 (prior to the @option{--help} option), then command-line options that
1406 have no documentation associated with them are also displayed.
1408 @item --target-help
1409 @opindex target-help
1410 Print (on the standard output) a description of target-specific command-line
1411 options for each tool.  For some targets extra target-specific
1412 information may also be printed.
1414 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1415 Print (on the standard output) a description of the command-line
1416 options understood by the compiler that fit into all specified classes
1417 and qualifiers.  These are the supported classes:
1419 @table @asis
1420 @item @samp{optimizers}
1421 Display all of the optimization options supported by the
1422 compiler.
1424 @item @samp{warnings}
1425 Display all of the options controlling warning messages
1426 produced by the compiler.
1428 @item @samp{target}
1429 Display target-specific options.  Unlike the
1430 @option{--target-help} option however, target-specific options of the
1431 linker and assembler are not displayed.  This is because those
1432 tools do not currently support the extended @option{--help=} syntax.
1434 @item @samp{params}
1435 Display the values recognized by the @option{--param}
1436 option.
1438 @item @var{language}
1439 Display the options supported for @var{language}, where
1440 @var{language} is the name of one of the languages supported in this
1441 version of GCC@.
1443 @item @samp{common}
1444 Display the options that are common to all languages.
1445 @end table
1447 These are the supported qualifiers:
1449 @table @asis
1450 @item @samp{undocumented}
1451 Display only those options that are undocumented.
1453 @item @samp{joined}
1454 Display options taking an argument that appears after an equal
1455 sign in the same continuous piece of text, such as:
1456 @samp{--help=target}.
1458 @item @samp{separate}
1459 Display options taking an argument that appears as a separate word
1460 following the original option, such as: @samp{-o output-file}.
1461 @end table
1463 Thus for example to display all the undocumented target-specific
1464 switches supported by the compiler, use:
1466 @smallexample
1467 --help=target,undocumented
1468 @end smallexample
1470 The sense of a qualifier can be inverted by prefixing it with the
1471 @samp{^} character, so for example to display all binary warning
1472 options (i.e., ones that are either on or off and that do not take an
1473 argument) that have a description, use:
1475 @smallexample
1476 --help=warnings,^joined,^undocumented
1477 @end smallexample
1479 The argument to @option{--help=} should not consist solely of inverted
1480 qualifiers.
1482 Combining several classes is possible, although this usually
1483 restricts the output so much that there is nothing to display.  One
1484 case where it does work, however, is when one of the classes is
1485 @var{target}.  For example, to display all the target-specific
1486 optimization options, use:
1488 @smallexample
1489 --help=target,optimizers
1490 @end smallexample
1492 The @option{--help=} option can be repeated on the command line.  Each
1493 successive use displays its requested class of options, skipping
1494 those that have already been displayed.
1496 If the @option{-Q} option appears on the command line before the
1497 @option{--help=} option, then the descriptive text displayed by
1498 @option{--help=} is changed.  Instead of describing the displayed
1499 options, an indication is given as to whether the option is enabled,
1500 disabled or set to a specific value (assuming that the compiler
1501 knows this at the point where the @option{--help=} option is used).
1503 Here is a truncated example from the ARM port of @command{gcc}:
1505 @smallexample
1506   % gcc -Q -mabi=2 --help=target -c
1507   The following options are target specific:
1508   -mabi=                                2
1509   -mabort-on-noreturn                   [disabled]
1510   -mapcs                                [disabled]
1511 @end smallexample
1513 The output is sensitive to the effects of previous command-line
1514 options, so for example it is possible to find out which optimizations
1515 are enabled at @option{-O2} by using:
1517 @smallexample
1518 -Q -O2 --help=optimizers
1519 @end smallexample
1521 Alternatively you can discover which binary optimizations are enabled
1522 by @option{-O3} by using:
1524 @smallexample
1525 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1526 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1527 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1528 @end smallexample
1530 @item -no-canonical-prefixes
1531 @opindex no-canonical-prefixes
1532 Do not expand any symbolic links, resolve references to @samp{/../}
1533 or @samp{/./}, or make the path absolute when generating a relative
1534 prefix.
1536 @item --version
1537 @opindex version
1538 Display the version number and copyrights of the invoked GCC@.
1540 @item -wrapper
1541 @opindex wrapper
1542 Invoke all subcommands under a wrapper program.  The name of the
1543 wrapper program and its parameters are passed as a comma separated
1544 list.
1546 @smallexample
1547 gcc -c t.c -wrapper gdb,--args
1548 @end smallexample
1550 @noindent
1551 This invokes all subprograms of @command{gcc} under
1552 @samp{gdb --args}, thus the invocation of @command{cc1} is
1553 @samp{gdb --args cc1 @dots{}}.
1555 @item -fplugin=@var{name}.so
1556 @opindex fplugin
1557 Load the plugin code in file @var{name}.so, assumed to be a
1558 shared object to be dlopen'd by the compiler.  The base name of
1559 the shared object file is used to identify the plugin for the
1560 purposes of argument parsing (See
1561 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1562 Each plugin should define the callback functions specified in the
1563 Plugins API.
1565 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1566 @opindex fplugin-arg
1567 Define an argument called @var{key} with a value of @var{value}
1568 for the plugin called @var{name}.
1570 @item -fdump-ada-spec@r{[}-slim@r{]}
1571 @opindex fdump-ada-spec
1572 For C and C++ source and include files, generate corresponding Ada specs.
1573 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1574 GNAT User's Guide}, which provides detailed documentation on this feature.
1576 @item -fada-spec-parent=@var{unit}
1577 @opindex fada-spec-parent
1578 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1579 Ada specs as child units of parent @var{unit}.
1581 @item -fdump-go-spec=@var{file}
1582 @opindex fdump-go-spec
1583 For input files in any language, generate corresponding Go
1584 declarations in @var{file}.  This generates Go @code{const},
1585 @code{type}, @code{var}, and @code{func} declarations which may be a
1586 useful way to start writing a Go interface to code written in some
1587 other language.
1589 @include @value{srcdir}/../libiberty/at-file.texi
1590 @end table
1592 @node Invoking G++
1593 @section Compiling C++ Programs
1595 @cindex suffixes for C++ source
1596 @cindex C++ source file suffixes
1597 C++ source files conventionally use one of the suffixes @samp{.C},
1598 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1599 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1600 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1601 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1602 files with these names and compiles them as C++ programs even if you
1603 call the compiler the same way as for compiling C programs (usually
1604 with the name @command{gcc}).
1606 @findex g++
1607 @findex c++
1608 However, the use of @command{gcc} does not add the C++ library.
1609 @command{g++} is a program that calls GCC and automatically specifies linking
1610 against the C++ library.  It treats @samp{.c},
1611 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1612 files unless @option{-x} is used.  This program is also useful when
1613 precompiling a C header file with a @samp{.h} extension for use in C++
1614 compilations.  On many systems, @command{g++} is also installed with
1615 the name @command{c++}.
1617 @cindex invoking @command{g++}
1618 When you compile C++ programs, you may specify many of the same
1619 command-line options that you use for compiling programs in any
1620 language; or command-line options meaningful for C and related
1621 languages; or options that are meaningful only for C++ programs.
1622 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1623 explanations of options for languages related to C@.
1624 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1625 explanations of options that are meaningful only for C++ programs.
1627 @node C Dialect Options
1628 @section Options Controlling C Dialect
1629 @cindex dialect options
1630 @cindex language dialect options
1631 @cindex options, dialect
1633 The following options control the dialect of C (or languages derived
1634 from C, such as C++, Objective-C and Objective-C++) that the compiler
1635 accepts:
1637 @table @gcctabopt
1638 @cindex ANSI support
1639 @cindex ISO support
1640 @item -ansi
1641 @opindex ansi
1642 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1643 equivalent to @option{-std=c++98}.
1645 This turns off certain features of GCC that are incompatible with ISO
1646 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1647 such as the @code{asm} and @code{typeof} keywords, and
1648 predefined macros such as @code{unix} and @code{vax} that identify the
1649 type of system you are using.  It also enables the undesirable and
1650 rarely used ISO trigraph feature.  For the C compiler,
1651 it disables recognition of C++ style @samp{//} comments as well as
1652 the @code{inline} keyword.
1654 The alternate keywords @code{__asm__}, @code{__extension__},
1655 @code{__inline__} and @code{__typeof__} continue to work despite
1656 @option{-ansi}.  You would not want to use them in an ISO C program, of
1657 course, but it is useful to put them in header files that might be included
1658 in compilations done with @option{-ansi}.  Alternate predefined macros
1659 such as @code{__unix__} and @code{__vax__} are also available, with or
1660 without @option{-ansi}.
1662 The @option{-ansi} option does not cause non-ISO programs to be
1663 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1664 addition to @option{-ansi}.  @xref{Warning Options}.
1666 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1667 option is used.  Some header files may notice this macro and refrain
1668 from declaring certain functions or defining certain macros that the
1669 ISO standard doesn't call for; this is to avoid interfering with any
1670 programs that might use these names for other things.
1672 Functions that are normally built in but do not have semantics
1673 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1674 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1675 built-in functions provided by GCC}, for details of the functions
1676 affected.
1678 @item -std=
1679 @opindex std
1680 Determine the language standard. @xref{Standards,,Language Standards
1681 Supported by GCC}, for details of these standard versions.  This option
1682 is currently only supported when compiling C or C++.
1684 The compiler can accept several base standards, such as @samp{c90} or
1685 @samp{c++98}, and GNU dialects of those standards, such as
1686 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1687 compiler accepts all programs following that standard plus those
1688 using GNU extensions that do not contradict it.  For example,
1689 @option{-std=c90} turns off certain features of GCC that are
1690 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1691 keywords, but not other GNU extensions that do not have a meaning in
1692 ISO C90, such as omitting the middle term of a @code{?:}
1693 expression. On the other hand, when a GNU dialect of a standard is
1694 specified, all features supported by the compiler are enabled, even when
1695 those features change the meaning of the base standard.  As a result, some
1696 strict-conforming programs may be rejected.  The particular standard
1697 is used by @option{-Wpedantic} to identify which features are GNU
1698 extensions given that version of the standard. For example
1699 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1700 comments, while @option{-std=gnu99 -Wpedantic} does not.
1702 A value for this option must be provided; possible values are
1704 @table @samp
1705 @item c90
1706 @itemx c89
1707 @itemx iso9899:1990
1708 Support all ISO C90 programs (certain GNU extensions that conflict
1709 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1711 @item iso9899:199409
1712 ISO C90 as modified in amendment 1.
1714 @item c99
1715 @itemx c9x
1716 @itemx iso9899:1999
1717 @itemx iso9899:199x
1718 ISO C99.  This standard is substantially completely supported, modulo
1719 bugs and floating-point issues
1720 (mainly but not entirely relating to optional C99 features from
1721 Annexes F and G).  See
1722 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1723 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1725 @item c11
1726 @itemx c1x
1727 @itemx iso9899:2011
1728 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1729 substantially completely supported, modulo bugs, floating-point issues
1730 (mainly but not entirely relating to optional C11 features from
1731 Annexes F and G) and the optional Annexes K (Bounds-checking
1732 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1734 @item gnu90
1735 @itemx gnu89
1736 GNU dialect of ISO C90 (including some C99 features).
1738 @item gnu99
1739 @itemx gnu9x
1740 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1742 @item gnu11
1743 @itemx gnu1x
1744 GNU dialect of ISO C11.  This is the default for C code.
1745 The name @samp{gnu1x} is deprecated.
1747 @item c++98
1748 @itemx c++03
1749 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1750 additional defect reports. Same as @option{-ansi} for C++ code.
1752 @item gnu++98
1753 @itemx gnu++03
1754 GNU dialect of @option{-std=c++98}.  This is the default for
1755 C++ code.
1757 @item c++11
1758 @itemx c++0x
1759 The 2011 ISO C++ standard plus amendments.
1760 The name @samp{c++0x} is deprecated.
1762 @item gnu++11
1763 @itemx gnu++0x
1764 GNU dialect of @option{-std=c++11}.
1765 The name @samp{gnu++0x} is deprecated.
1767 @item c++14
1768 @itemx c++1y
1769 The 2014 ISO C++ standard plus amendments.
1770 The name @samp{c++1y} is deprecated.
1772 @item gnu++14
1773 @itemx gnu++1y
1774 GNU dialect of @option{-std=c++14}.
1775 The name @samp{gnu++1y} is deprecated.
1777 @item c++1z
1778 The next revision of the ISO C++ standard, tentatively planned for
1779 2017.  Support is highly experimental, and will almost certainly
1780 change in incompatible ways in future releases.
1782 @item gnu++1z
1783 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1784 and will almost certainly change in incompatible ways in future
1785 releases.
1786 @end table
1788 @item -fgnu89-inline
1789 @opindex fgnu89-inline
1790 The option @option{-fgnu89-inline} tells GCC to use the traditional
1791 GNU semantics for @code{inline} functions when in C99 mode.
1792 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1793 Using this option is roughly equivalent to adding the
1794 @code{gnu_inline} function attribute to all inline functions
1795 (@pxref{Function Attributes}).
1797 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1798 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1799 specifies the default behavior).
1800 This option is not supported in @option{-std=c90} or
1801 @option{-std=gnu90} mode.
1803 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1804 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1805 in effect for @code{inline} functions.  @xref{Common Predefined
1806 Macros,,,cpp,The C Preprocessor}.
1808 @item -aux-info @var{filename}
1809 @opindex aux-info
1810 Output to the given filename prototyped declarations for all functions
1811 declared and/or defined in a translation unit, including those in header
1812 files.  This option is silently ignored in any language other than C@.
1814 Besides declarations, the file indicates, in comments, the origin of
1815 each declaration (source file and line), whether the declaration was
1816 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1817 @samp{O} for old, respectively, in the first character after the line
1818 number and the colon), and whether it came from a declaration or a
1819 definition (@samp{C} or @samp{F}, respectively, in the following
1820 character).  In the case of function definitions, a K&R-style list of
1821 arguments followed by their declarations is also provided, inside
1822 comments, after the declaration.
1824 @item -fallow-parameterless-variadic-functions
1825 @opindex fallow-parameterless-variadic-functions
1826 Accept variadic functions without named parameters.
1828 Although it is possible to define such a function, this is not very
1829 useful as it is not possible to read the arguments.  This is only
1830 supported for C as this construct is allowed by C++.
1832 @item -fno-asm
1833 @opindex fno-asm
1834 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1835 keyword, so that code can use these words as identifiers.  You can use
1836 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1837 instead.  @option{-ansi} implies @option{-fno-asm}.
1839 In C++, this switch only affects the @code{typeof} keyword, since
1840 @code{asm} and @code{inline} are standard keywords.  You may want to
1841 use the @option{-fno-gnu-keywords} flag instead, which has the same
1842 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1843 switch only affects the @code{asm} and @code{typeof} keywords, since
1844 @code{inline} is a standard keyword in ISO C99.
1846 @item -fno-builtin
1847 @itemx -fno-builtin-@var{function}
1848 @opindex fno-builtin
1849 @cindex built-in functions
1850 Don't recognize built-in functions that do not begin with
1851 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1852 functions provided by GCC}, for details of the functions affected,
1853 including those which are not built-in functions when @option{-ansi} or
1854 @option{-std} options for strict ISO C conformance are used because they
1855 do not have an ISO standard meaning.
1857 GCC normally generates special code to handle certain built-in functions
1858 more efficiently; for instance, calls to @code{alloca} may become single
1859 instructions which adjust the stack directly, and calls to @code{memcpy}
1860 may become inline copy loops.  The resulting code is often both smaller
1861 and faster, but since the function calls no longer appear as such, you
1862 cannot set a breakpoint on those calls, nor can you change the behavior
1863 of the functions by linking with a different library.  In addition,
1864 when a function is recognized as a built-in function, GCC may use
1865 information about that function to warn about problems with calls to
1866 that function, or to generate more efficient code, even if the
1867 resulting code still contains calls to that function.  For example,
1868 warnings are given with @option{-Wformat} for bad calls to
1869 @code{printf} when @code{printf} is built in and @code{strlen} is
1870 known not to modify global memory.
1872 With the @option{-fno-builtin-@var{function}} option
1873 only the built-in function @var{function} is
1874 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1875 function is named that is not built-in in this version of GCC, this
1876 option is ignored.  There is no corresponding
1877 @option{-fbuiltin-@var{function}} option; if you wish to enable
1878 built-in functions selectively when using @option{-fno-builtin} or
1879 @option{-ffreestanding}, you may define macros such as:
1881 @smallexample
1882 #define abs(n)          __builtin_abs ((n))
1883 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1884 @end smallexample
1886 @item -fhosted
1887 @opindex fhosted
1888 @cindex hosted environment
1890 Assert that compilation targets a hosted environment.  This implies
1891 @option{-fbuiltin}.  A hosted environment is one in which the
1892 entire standard library is available, and in which @code{main} has a return
1893 type of @code{int}.  Examples are nearly everything except a kernel.
1894 This is equivalent to @option{-fno-freestanding}.
1896 @item -ffreestanding
1897 @opindex ffreestanding
1898 @cindex hosted environment
1900 Assert that compilation targets a freestanding environment.  This
1901 implies @option{-fno-builtin}.  A freestanding environment
1902 is one in which the standard library may not exist, and program startup may
1903 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1904 This is equivalent to @option{-fno-hosted}.
1906 @xref{Standards,,Language Standards Supported by GCC}, for details of
1907 freestanding and hosted environments.
1909 @item -fopenacc
1910 @opindex fopenacc
1911 @cindex OpenACC accelerator programming
1912 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1913 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1914 compiler generates accelerated code according to the OpenACC Application
1915 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1916 implies @option{-pthread}, and thus is only supported on targets that
1917 have support for @option{-pthread}.
1919 Note that this is an experimental feature, incomplete, and subject to
1920 change in future versions of GCC.  See
1921 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
1923 @item -fopenmp
1924 @opindex fopenmp
1925 @cindex OpenMP parallel
1926 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1927 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1928 compiler generates parallel code according to the OpenMP Application
1929 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1930 implies @option{-pthread}, and thus is only supported on targets that
1931 have support for @option{-pthread}. @option{-fopenmp} implies
1932 @option{-fopenmp-simd}.
1934 @item -fopenmp-simd
1935 @opindex fopenmp-simd
1936 @cindex OpenMP SIMD
1937 @cindex SIMD
1938 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1939 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1940 are ignored.
1942 @item -fcilkplus
1943 @opindex fcilkplus
1944 @cindex Enable Cilk Plus
1945 Enable the usage of Cilk Plus language extension features for C/C++.
1946 When the option @option{-fcilkplus} is specified, enable the usage of
1947 the Cilk Plus Language extension features for C/C++.  The present
1948 implementation follows ABI version 1.2.  This is an experimental
1949 feature that is only partially complete, and whose interface may
1950 change in future versions of GCC as the official specification
1951 changes.  Currently, all features but @code{_Cilk_for} have been
1952 implemented.
1954 @item -fgnu-tm
1955 @opindex fgnu-tm
1956 When the option @option{-fgnu-tm} is specified, the compiler
1957 generates code for the Linux variant of Intel's current Transactional
1958 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1959 an experimental feature whose interface may change in future versions
1960 of GCC, as the official specification changes.  Please note that not
1961 all architectures are supported for this feature.
1963 For more information on GCC's support for transactional memory,
1964 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1965 Transactional Memory Library}.
1967 Note that the transactional memory feature is not supported with
1968 non-call exceptions (@option{-fnon-call-exceptions}).
1970 @item -fms-extensions
1971 @opindex fms-extensions
1972 Accept some non-standard constructs used in Microsoft header files.
1974 In C++ code, this allows member names in structures to be similar
1975 to previous types declarations.
1977 @smallexample
1978 typedef int UOW;
1979 struct ABC @{
1980   UOW UOW;
1982 @end smallexample
1984 Some cases of unnamed fields in structures and unions are only
1985 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1986 fields within structs/unions}, for details.
1988 Note that this option is off for all targets but x86 
1989 targets using ms-abi.
1991 @item -fplan9-extensions
1992 @opindex fplan9-extensions
1993 Accept some non-standard constructs used in Plan 9 code.
1995 This enables @option{-fms-extensions}, permits passing pointers to
1996 structures with anonymous fields to functions that expect pointers to
1997 elements of the type of the field, and permits referring to anonymous
1998 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1999 struct/union fields within structs/unions}, for details.  This is only
2000 supported for C, not C++.
2002 @item -trigraphs
2003 @opindex trigraphs
2004 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2005 options for strict ISO C conformance) implies @option{-trigraphs}.
2007 @cindex traditional C language
2008 @cindex C language, traditional
2009 @item -traditional
2010 @itemx -traditional-cpp
2011 @opindex traditional-cpp
2012 @opindex traditional
2013 Formerly, these options caused GCC to attempt to emulate a pre-standard
2014 C compiler.  They are now only supported with the @option{-E} switch.
2015 The preprocessor continues to support a pre-standard mode.  See the GNU
2016 CPP manual for details.
2018 @item -fcond-mismatch
2019 @opindex fcond-mismatch
2020 Allow conditional expressions with mismatched types in the second and
2021 third arguments.  The value of such an expression is void.  This option
2022 is not supported for C++.
2024 @item -flax-vector-conversions
2025 @opindex flax-vector-conversions
2026 Allow implicit conversions between vectors with differing numbers of
2027 elements and/or incompatible element types.  This option should not be
2028 used for new code.
2030 @item -funsigned-char
2031 @opindex funsigned-char
2032 Let the type @code{char} be unsigned, like @code{unsigned char}.
2034 Each kind of machine has a default for what @code{char} should
2035 be.  It is either like @code{unsigned char} by default or like
2036 @code{signed char} by default.
2038 Ideally, a portable program should always use @code{signed char} or
2039 @code{unsigned char} when it depends on the signedness of an object.
2040 But many programs have been written to use plain @code{char} and
2041 expect it to be signed, or expect it to be unsigned, depending on the
2042 machines they were written for.  This option, and its inverse, let you
2043 make such a program work with the opposite default.
2045 The type @code{char} is always a distinct type from each of
2046 @code{signed char} or @code{unsigned char}, even though its behavior
2047 is always just like one of those two.
2049 @item -fsigned-char
2050 @opindex fsigned-char
2051 Let the type @code{char} be signed, like @code{signed char}.
2053 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2054 the negative form of @option{-funsigned-char}.  Likewise, the option
2055 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2057 @item -fsigned-bitfields
2058 @itemx -funsigned-bitfields
2059 @itemx -fno-signed-bitfields
2060 @itemx -fno-unsigned-bitfields
2061 @opindex fsigned-bitfields
2062 @opindex funsigned-bitfields
2063 @opindex fno-signed-bitfields
2064 @opindex fno-unsigned-bitfields
2065 These options control whether a bit-field is signed or unsigned, when the
2066 declaration does not use either @code{signed} or @code{unsigned}.  By
2067 default, such a bit-field is signed, because this is consistent: the
2068 basic integer types such as @code{int} are signed types.
2069 @end table
2071 @node C++ Dialect Options
2072 @section Options Controlling C++ Dialect
2074 @cindex compiler options, C++
2075 @cindex C++ options, command-line
2076 @cindex options, C++
2077 This section describes the command-line options that are only meaningful
2078 for C++ programs.  You can also use most of the GNU compiler options
2079 regardless of what language your program is in.  For example, you
2080 might compile a file @file{firstClass.C} like this:
2082 @smallexample
2083 g++ -g -frepo -O -c firstClass.C
2084 @end smallexample
2086 @noindent
2087 In this example, only @option{-frepo} is an option meant
2088 only for C++ programs; you can use the other options with any
2089 language supported by GCC@.
2091 Here is a list of options that are @emph{only} for compiling C++ programs:
2093 @table @gcctabopt
2095 @item -fabi-version=@var{n}
2096 @opindex fabi-version
2097 Use version @var{n} of the C++ ABI@.  The default is version 0.
2099 Version 0 refers to the version conforming most closely to
2100 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2101 will change in different versions of G++ as ABI bugs are fixed.
2103 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2105 Version 2 is the version of the C++ ABI that first appeared in G++
2106 3.4, and was the default through G++ 4.9.
2108 Version 3 corrects an error in mangling a constant address as a
2109 template argument.
2111 Version 4, which first appeared in G++ 4.5, implements a standard
2112 mangling for vector types.
2114 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2115 attribute const/volatile on function pointer types, decltype of a
2116 plain decl, and use of a function parameter in the declaration of
2117 another parameter.
2119 Version 6, which first appeared in G++ 4.7, corrects the promotion
2120 behavior of C++11 scoped enums and the mangling of template argument
2121 packs, const/static_cast, prefix ++ and --, and a class scope function
2122 used as a template argument.
2124 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2125 builtin type and corrects the mangling of lambdas in default argument
2126 scope.
2128 Version 8, which first appeared in G++ 4.9, corrects the substitution
2129 behavior of function types with function-cv-qualifiers.
2131 See also @option{-Wabi}.
2133 @item -fabi-compat-version=@var{n}
2134 @opindex fabi-compat-version
2135 On targets that support strong aliases, G++
2136 works around mangling changes by creating an alias with the correct
2137 mangled name when defining a symbol with an incorrect mangled name.
2138 This switch specifies which ABI version to use for the alias.
2140 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2141 another ABI version is explicitly selected, this defaults to 0.
2143 The compatibility version is also set by @option{-Wabi=@var{n}}.
2145 @item -fno-access-control
2146 @opindex fno-access-control
2147 Turn off all access checking.  This switch is mainly useful for working
2148 around bugs in the access control code.
2150 @item -fcheck-new
2151 @opindex fcheck-new
2152 Check that the pointer returned by @code{operator new} is non-null
2153 before attempting to modify the storage allocated.  This check is
2154 normally unnecessary because the C++ standard specifies that
2155 @code{operator new} only returns @code{0} if it is declared
2156 @code{throw()}, in which case the compiler always checks the
2157 return value even without this option.  In all other cases, when
2158 @code{operator new} has a non-empty exception specification, memory
2159 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2160 @samp{new (nothrow)}.
2162 @item -fconstexpr-depth=@var{n}
2163 @opindex fconstexpr-depth
2164 Set the maximum nested evaluation depth for C++11 constexpr functions
2165 to @var{n}.  A limit is needed to detect endless recursion during
2166 constant expression evaluation.  The minimum specified by the standard
2167 is 512.
2169 @item -fdeduce-init-list
2170 @opindex fdeduce-init-list
2171 Enable deduction of a template type parameter as
2172 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2174 @smallexample
2175 template <class T> auto forward(T t) -> decltype (realfn (t))
2177   return realfn (t);
2180 void f()
2182   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2184 @end smallexample
2186 This deduction was implemented as a possible extension to the
2187 originally proposed semantics for the C++11 standard, but was not part
2188 of the final standard, so it is disabled by default.  This option is
2189 deprecated, and may be removed in a future version of G++.
2191 @item -ffriend-injection
2192 @opindex ffriend-injection
2193 Inject friend functions into the enclosing namespace, so that they are
2194 visible outside the scope of the class in which they are declared.
2195 Friend functions were documented to work this way in the old Annotated
2196 C++ Reference Manual.  
2197 However, in ISO C++ a friend function that is not declared
2198 in an enclosing scope can only be found using argument dependent
2199 lookup.  GCC defaults to the standard behavior.
2201 This option is for compatibility, and may be removed in a future
2202 release of G++.
2204 @item -fno-elide-constructors
2205 @opindex fno-elide-constructors
2206 The C++ standard allows an implementation to omit creating a temporary
2207 that is only used to initialize another object of the same type.
2208 Specifying this option disables that optimization, and forces G++ to
2209 call the copy constructor in all cases.
2211 @item -fno-enforce-eh-specs
2212 @opindex fno-enforce-eh-specs
2213 Don't generate code to check for violation of exception specifications
2214 at run time.  This option violates the C++ standard, but may be useful
2215 for reducing code size in production builds, much like defining
2216 @code{NDEBUG}.  This does not give user code permission to throw
2217 exceptions in violation of the exception specifications; the compiler
2218 still optimizes based on the specifications, so throwing an
2219 unexpected exception results in undefined behavior at run time.
2221 @item -fextern-tls-init
2222 @itemx -fno-extern-tls-init
2223 @opindex fextern-tls-init
2224 @opindex fno-extern-tls-init
2225 The C++11 and OpenMP standards allow @code{thread_local} and
2226 @code{threadprivate} variables to have dynamic (runtime)
2227 initialization.  To support this, any use of such a variable goes
2228 through a wrapper function that performs any necessary initialization.
2229 When the use and definition of the variable are in the same
2230 translation unit, this overhead can be optimized away, but when the
2231 use is in a different translation unit there is significant overhead
2232 even if the variable doesn't actually need dynamic initialization.  If
2233 the programmer can be sure that no use of the variable in a
2234 non-defining TU needs to trigger dynamic initialization (either
2235 because the variable is statically initialized, or a use of the
2236 variable in the defining TU will be executed before any uses in
2237 another TU), they can avoid this overhead with the
2238 @option{-fno-extern-tls-init} option.
2240 On targets that support symbol aliases, the default is
2241 @option{-fextern-tls-init}.  On targets that do not support symbol
2242 aliases, the default is @option{-fno-extern-tls-init}.
2244 @item -ffor-scope
2245 @itemx -fno-for-scope
2246 @opindex ffor-scope
2247 @opindex fno-for-scope
2248 If @option{-ffor-scope} is specified, the scope of variables declared in
2249 a @i{for-init-statement} is limited to the @code{for} loop itself,
2250 as specified by the C++ standard.
2251 If @option{-fno-for-scope} is specified, the scope of variables declared in
2252 a @i{for-init-statement} extends to the end of the enclosing scope,
2253 as was the case in old versions of G++, and other (traditional)
2254 implementations of C++.
2256 If neither flag is given, the default is to follow the standard,
2257 but to allow and give a warning for old-style code that would
2258 otherwise be invalid, or have different behavior.
2260 @item -fno-gnu-keywords
2261 @opindex fno-gnu-keywords
2262 Do not recognize @code{typeof} as a keyword, so that code can use this
2263 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2264 @option{-ansi} implies @option{-fno-gnu-keywords}.
2266 @item -fno-implicit-templates
2267 @opindex fno-implicit-templates
2268 Never emit code for non-inline templates that are instantiated
2269 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2270 @xref{Template Instantiation}, for more information.
2272 @item -fno-implicit-inline-templates
2273 @opindex fno-implicit-inline-templates
2274 Don't emit code for implicit instantiations of inline templates, either.
2275 The default is to handle inlines differently so that compiles with and
2276 without optimization need the same set of explicit instantiations.
2278 @item -fno-implement-inlines
2279 @opindex fno-implement-inlines
2280 To save space, do not emit out-of-line copies of inline functions
2281 controlled by @code{#pragma implementation}.  This causes linker
2282 errors if these functions are not inlined everywhere they are called.
2284 @item -fms-extensions
2285 @opindex fms-extensions
2286 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2287 int and getting a pointer to member function via non-standard syntax.
2289 @item -fno-nonansi-builtins
2290 @opindex fno-nonansi-builtins
2291 Disable built-in declarations of functions that are not mandated by
2292 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2293 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2295 @item -fnothrow-opt
2296 @opindex fnothrow-opt
2297 Treat a @code{throw()} exception specification as if it were a
2298 @code{noexcept} specification to reduce or eliminate the text size
2299 overhead relative to a function with no exception specification.  If
2300 the function has local variables of types with non-trivial
2301 destructors, the exception specification actually makes the
2302 function smaller because the EH cleanups for those variables can be
2303 optimized away.  The semantic effect is that an exception thrown out of
2304 a function with such an exception specification results in a call
2305 to @code{terminate} rather than @code{unexpected}.
2307 @item -fno-operator-names
2308 @opindex fno-operator-names
2309 Do not treat the operator name keywords @code{and}, @code{bitand},
2310 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2311 synonyms as keywords.
2313 @item -fno-optional-diags
2314 @opindex fno-optional-diags
2315 Disable diagnostics that the standard says a compiler does not need to
2316 issue.  Currently, the only such diagnostic issued by G++ is the one for
2317 a name having multiple meanings within a class.
2319 @item -fpermissive
2320 @opindex fpermissive
2321 Downgrade some diagnostics about nonconformant code from errors to
2322 warnings.  Thus, using @option{-fpermissive} allows some
2323 nonconforming code to compile.
2325 @item -fno-pretty-templates
2326 @opindex fno-pretty-templates
2327 When an error message refers to a specialization of a function
2328 template, the compiler normally prints the signature of the
2329 template followed by the template arguments and any typedefs or
2330 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2331 rather than @code{void f(int)}) so that it's clear which template is
2332 involved.  When an error message refers to a specialization of a class
2333 template, the compiler omits any template arguments that match
2334 the default template arguments for that template.  If either of these
2335 behaviors make it harder to understand the error message rather than
2336 easier, you can use @option{-fno-pretty-templates} to disable them.
2338 @item -frepo
2339 @opindex frepo
2340 Enable automatic template instantiation at link time.  This option also
2341 implies @option{-fno-implicit-templates}.  @xref{Template
2342 Instantiation}, for more information.
2344 @item -fno-rtti
2345 @opindex fno-rtti
2346 Disable generation of information about every class with virtual
2347 functions for use by the C++ run-time type identification features
2348 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2349 of the language, you can save some space by using this flag.  Note that
2350 exception handling uses the same information, but G++ generates it as
2351 needed. The @code{dynamic_cast} operator can still be used for casts that
2352 do not require run-time type information, i.e.@: casts to @code{void *} or to
2353 unambiguous base classes.
2355 @item -fsized-deallocation
2356 @opindex fsized-deallocation
2357 Enable the built-in global declarations
2358 @smallexample
2359 void operator delete (void *, std::size_t) noexcept;
2360 void operator delete[] (void *, std::size_t) noexcept;
2361 @end smallexample
2362 as introduced in C++14.  This is useful for user-defined replacement
2363 deallocation functions that, for example, use the size of the object
2364 to make deallocation faster.  Enabled by default under
2365 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2366 warns about places that might want to add a definition.
2368 @item -fstats
2369 @opindex fstats
2370 Emit statistics about front-end processing at the end of the compilation.
2371 This information is generally only useful to the G++ development team.
2373 @item -fstrict-enums
2374 @opindex fstrict-enums
2375 Allow the compiler to optimize using the assumption that a value of
2376 enumerated type can only be one of the values of the enumeration (as
2377 defined in the C++ standard; basically, a value that can be
2378 represented in the minimum number of bits needed to represent all the
2379 enumerators).  This assumption may not be valid if the program uses a
2380 cast to convert an arbitrary integer value to the enumerated type.
2382 @item -ftemplate-backtrace-limit=@var{n}
2383 @opindex ftemplate-backtrace-limit
2384 Set the maximum number of template instantiation notes for a single
2385 warning or error to @var{n}.  The default value is 10.
2387 @item -ftemplate-depth=@var{n}
2388 @opindex ftemplate-depth
2389 Set the maximum instantiation depth for template classes to @var{n}.
2390 A limit on the template instantiation depth is needed to detect
2391 endless recursions during template class instantiation.  ANSI/ISO C++
2392 conforming programs must not rely on a maximum depth greater than 17
2393 (changed to 1024 in C++11).  The default value is 900, as the compiler
2394 can run out of stack space before hitting 1024 in some situations.
2396 @item -fno-threadsafe-statics
2397 @opindex fno-threadsafe-statics
2398 Do not emit the extra code to use the routines specified in the C++
2399 ABI for thread-safe initialization of local statics.  You can use this
2400 option to reduce code size slightly in code that doesn't need to be
2401 thread-safe.
2403 @item -fuse-cxa-atexit
2404 @opindex fuse-cxa-atexit
2405 Register destructors for objects with static storage duration with the
2406 @code{__cxa_atexit} function rather than the @code{atexit} function.
2407 This option is required for fully standards-compliant handling of static
2408 destructors, but only works if your C library supports
2409 @code{__cxa_atexit}.
2411 @item -fno-use-cxa-get-exception-ptr
2412 @opindex fno-use-cxa-get-exception-ptr
2413 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2414 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2415 if the runtime routine is not available.
2417 @item -fvisibility-inlines-hidden
2418 @opindex fvisibility-inlines-hidden
2419 This switch declares that the user does not attempt to compare
2420 pointers to inline functions or methods where the addresses of the two functions
2421 are taken in different shared objects.
2423 The effect of this is that GCC may, effectively, mark inline methods with
2424 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2425 appear in the export table of a DSO and do not require a PLT indirection
2426 when used within the DSO@.  Enabling this option can have a dramatic effect
2427 on load and link times of a DSO as it massively reduces the size of the
2428 dynamic export table when the library makes heavy use of templates.
2430 The behavior of this switch is not quite the same as marking the
2431 methods as hidden directly, because it does not affect static variables
2432 local to the function or cause the compiler to deduce that
2433 the function is defined in only one shared object.
2435 You may mark a method as having a visibility explicitly to negate the
2436 effect of the switch for that method.  For example, if you do want to
2437 compare pointers to a particular inline method, you might mark it as
2438 having default visibility.  Marking the enclosing class with explicit
2439 visibility has no effect.
2441 Explicitly instantiated inline methods are unaffected by this option
2442 as their linkage might otherwise cross a shared library boundary.
2443 @xref{Template Instantiation}.
2445 @item -fvisibility-ms-compat
2446 @opindex fvisibility-ms-compat
2447 This flag attempts to use visibility settings to make GCC's C++
2448 linkage model compatible with that of Microsoft Visual Studio.
2450 The flag makes these changes to GCC's linkage model:
2452 @enumerate
2453 @item
2454 It sets the default visibility to @code{hidden}, like
2455 @option{-fvisibility=hidden}.
2457 @item
2458 Types, but not their members, are not hidden by default.
2460 @item
2461 The One Definition Rule is relaxed for types without explicit
2462 visibility specifications that are defined in more than one
2463 shared object: those declarations are permitted if they are
2464 permitted when this option is not used.
2465 @end enumerate
2467 In new code it is better to use @option{-fvisibility=hidden} and
2468 export those classes that are intended to be externally visible.
2469 Unfortunately it is possible for code to rely, perhaps accidentally,
2470 on the Visual Studio behavior.
2472 Among the consequences of these changes are that static data members
2473 of the same type with the same name but defined in different shared
2474 objects are different, so changing one does not change the other;
2475 and that pointers to function members defined in different shared
2476 objects may not compare equal.  When this flag is given, it is a
2477 violation of the ODR to define types with the same name differently.
2479 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
2480 @opindex fvtable-verify
2481 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2482 feature that verifies at run time, for every virtual call, that
2483 the vtable pointer through which the call is made is valid for the type of
2484 the object, and has not been corrupted or overwritten.  If an invalid vtable
2485 pointer is detected at run time, an error is reported and execution of the
2486 program is immediately halted.
2488 This option causes run-time data structures to be built at program startup,
2489 which are used for verifying the vtable pointers.  
2490 The options @samp{std} and @samp{preinit}
2491 control the timing of when these data structures are built.  In both cases the
2492 data structures are built before execution reaches @code{main}.  Using
2493 @option{-fvtable-verify=std} causes the data structures to be built after
2494 shared libraries have been loaded and initialized.
2495 @option{-fvtable-verify=preinit} causes them to be built before shared
2496 libraries have been loaded and initialized.
2498 If this option appears multiple times in the command line with different
2499 values specified, @samp{none} takes highest priority over both @samp{std} and
2500 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
2502 @item -fvtv-debug
2503 @opindex fvtv-debug
2504 When used in conjunction with @option{-fvtable-verify=std} or 
2505 @option{-fvtable-verify=preinit}, causes debug versions of the 
2506 runtime functions for the vtable verification feature to be called.  
2507 This flag also causes the compiler to log information about which 
2508 vtable pointers it finds for each class.
2509 This information is written to a file named @file{vtv_set_ptr_data.log} 
2510 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
2511 if that is defined or the current working directory otherwise.
2513 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
2514 file, be sure to delete any existing one.
2516 @item -fvtv-counts
2517 @opindex fvtv-counts
2518 This is a debugging flag.  When used in conjunction with
2519 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2520 causes the compiler to keep track of the total number of virtual calls
2521 it encounters and the number of verifications it inserts.  It also
2522 counts the number of calls to certain run-time library functions
2523 that it inserts and logs this information for each compilation unit.
2524 The compiler writes this information to a file named
2525 @file{vtv_count_data.log} in the directory named by the environment
2526 variable @env{VTV_LOGS_DIR} if that is defined or the current working
2527 directory otherwise.  It also counts the size of the vtable pointer sets
2528 for each class, and writes this information to @file{vtv_class_set_sizes.log}
2529 in the same directory.
2531 Note:  This feature @emph{appends} data to the log files.  To get fresh log
2532 files, be sure to delete any existing ones.
2534 @item -fno-weak
2535 @opindex fno-weak
2536 Do not use weak symbol support, even if it is provided by the linker.
2537 By default, G++ uses weak symbols if they are available.  This
2538 option exists only for testing, and should not be used by end-users;
2539 it results in inferior code and has no benefits.  This option may
2540 be removed in a future release of G++.
2542 @item -nostdinc++
2543 @opindex nostdinc++
2544 Do not search for header files in the standard directories specific to
2545 C++, but do still search the other standard directories.  (This option
2546 is used when building the C++ library.)
2547 @end table
2549 In addition, these optimization, warning, and code generation options
2550 have meanings only for C++ programs:
2552 @table @gcctabopt
2553 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2554 @opindex Wabi
2555 @opindex Wno-abi
2556 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2557 G++ to warn when it generates code that is probably not compatible with the
2558 vendor-neutral C++ ABI@.  Since G++ now defaults to
2559 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2560 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2561 or an older compatibility version is selected (with
2562 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2564 Although an effort has been made to warn about
2565 all such cases, there are probably some cases that are not warned about,
2566 even though G++ is generating incompatible code.  There may also be
2567 cases where warnings are emitted even though the code that is generated
2568 is compatible.
2570 You should rewrite your code to avoid these warnings if you are
2571 concerned about the fact that code generated by G++ may not be binary
2572 compatible with code generated by other compilers.
2574 @option{-Wabi} can also be used with an explicit version number to
2575 warn about compatibility with a particular @option{-fabi-version}
2576 level, e.g. @option{-Wabi=2} to warn about changes relative to
2577 @option{-fabi-version=2}.  Specifying a version number also sets
2578 @option{-fabi-compat-version=@var{n}}.
2580 The known incompatibilities in @option{-fabi-version=2} (which was the
2581 default from GCC 3.4 to 4.9) include:
2583 @itemize @bullet
2585 @item
2586 A template with a non-type template parameter of reference type was
2587 mangled incorrectly:
2588 @smallexample
2589 extern int N;
2590 template <int &> struct S @{@};
2591 void n (S<N>) @{2@}
2592 @end smallexample
2594 This was fixed in @option{-fabi-version=3}.
2596 @item
2597 SIMD vector types declared using @code{__attribute ((vector_size))} were
2598 mangled in a non-standard way that does not allow for overloading of
2599 functions taking vectors of different sizes.
2601 The mangling was changed in @option{-fabi-version=4}.
2603 @item
2604 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2605 qualifiers, and @code{decltype} of a plain declaration was folded away.
2607 These mangling issues were fixed in @option{-fabi-version=5}.
2609 @item
2610 Scoped enumerators passed as arguments to a variadic function are
2611 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2612 On most targets this does not actually affect the parameter passing
2613 ABI, as there is no way to pass an argument smaller than @code{int}.
2615 Also, the ABI changed the mangling of template argument packs,
2616 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2617 a class scope function used as a template argument.
2619 These issues were corrected in @option{-fabi-version=6}.
2621 @item
2622 Lambdas in default argument scope were mangled incorrectly, and the
2623 ABI changed the mangling of @code{nullptr_t}.
2625 These issues were corrected in @option{-fabi-version=7}.
2627 @item
2628 When mangling a function type with function-cv-qualifiers, the
2629 un-qualified function type was incorrectly treated as a substitution
2630 candidate.
2632 This was fixed in @option{-fabi-version=8}.
2633 @end itemize
2635 It also warns about psABI-related changes.  The known psABI changes at this
2636 point include:
2638 @itemize @bullet
2640 @item
2641 For SysV/x86-64, unions with @code{long double} members are 
2642 passed in memory as specified in psABI.  For example:
2644 @smallexample
2645 union U @{
2646   long double ld;
2647   int i;
2649 @end smallexample
2651 @noindent
2652 @code{union U} is always passed in memory.
2654 @end itemize
2656 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2657 @opindex Wabi-tag
2658 @opindex -Wabi-tag
2659 Warn when a type with an ABI tag is used in a context that does not
2660 have that ABI tag.  See @ref{C++ Attributes} for more information
2661 about ABI tags.
2663 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2664 @opindex Wctor-dtor-privacy
2665 @opindex Wno-ctor-dtor-privacy
2666 Warn when a class seems unusable because all the constructors or
2667 destructors in that class are private, and it has neither friends nor
2668 public static member functions.  Also warn if there are no non-private
2669 methods, and there's at least one private member function that isn't
2670 a constructor or destructor.
2672 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2673 @opindex Wdelete-non-virtual-dtor
2674 @opindex Wno-delete-non-virtual-dtor
2675 Warn when @code{delete} is used to destroy an instance of a class that
2676 has virtual functions and non-virtual destructor. It is unsafe to delete
2677 an instance of a derived class through a pointer to a base class if the
2678 base class does not have a virtual destructor.  This warning is enabled
2679 by @option{-Wall}.
2681 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2682 @opindex Wliteral-suffix
2683 @opindex Wno-literal-suffix
2684 Warn when a string or character literal is followed by a ud-suffix which does
2685 not begin with an underscore.  As a conforming extension, GCC treats such
2686 suffixes as separate preprocessing tokens in order to maintain backwards
2687 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2688 For example:
2690 @smallexample
2691 #define __STDC_FORMAT_MACROS
2692 #include <inttypes.h>
2693 #include <stdio.h>
2695 int main() @{
2696   int64_t i64 = 123;
2697   printf("My int64: %" PRId64"\n", i64);
2699 @end smallexample
2701 In this case, @code{PRId64} is treated as a separate preprocessing token.
2703 This warning is enabled by default.
2705 @item -Wlto-type-mismatch
2706 @opindex Wlto-type-mismatch
2707 @opindex Wno-lto-type-mistmach
2709 During the link-time optimization warn about type mismatches in between
2710 global declarations from different compilation units.
2711 Requires @option{-flto} to be enabled.  Enabled by default.
2713 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2714 @opindex Wnarrowing
2715 @opindex Wno-narrowing
2716 Warn when a narrowing conversion prohibited by C++11 occurs within
2717 @samp{@{ @}}, e.g.
2719 @smallexample
2720 int i = @{ 2.2 @}; // error: narrowing from double to int
2721 @end smallexample
2723 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2725 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2726 required by the standard.  Note that this does not affect the meaning
2727 of well-formed code; narrowing conversions are still considered
2728 ill-formed in SFINAE context.
2730 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2731 @opindex Wnoexcept
2732 @opindex Wno-noexcept
2733 Warn when a noexcept-expression evaluates to false because of a call
2734 to a function that does not have a non-throwing exception
2735 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2736 the compiler to never throw an exception.
2738 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2739 @opindex Wnon-virtual-dtor
2740 @opindex Wno-non-virtual-dtor
2741 Warn when a class has virtual functions and an accessible non-virtual
2742 destructor itself or in an accessible polymorphic base class, in which
2743 case it is possible but unsafe to delete an instance of a derived
2744 class through a pointer to the class itself or base class.  This
2745 warning is automatically enabled if @option{-Weffc++} is specified.
2747 @item -Wreorder @r{(C++ and Objective-C++ only)}
2748 @opindex Wreorder
2749 @opindex Wno-reorder
2750 @cindex reordering, warning
2751 @cindex warning for reordering of member initializers
2752 Warn when the order of member initializers given in the code does not
2753 match the order in which they must be executed.  For instance:
2755 @smallexample
2756 struct A @{
2757   int i;
2758   int j;
2759   A(): j (0), i (1) @{ @}
2761 @end smallexample
2763 @noindent
2764 The compiler rearranges the member initializers for @code{i}
2765 and @code{j} to match the declaration order of the members, emitting
2766 a warning to that effect.  This warning is enabled by @option{-Wall}.
2768 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2769 @opindex fext-numeric-literals
2770 @opindex fno-ext-numeric-literals
2771 Accept imaginary, fixed-point, or machine-defined
2772 literal number suffixes as GNU extensions.
2773 When this option is turned off these suffixes are treated
2774 as C++11 user-defined literal numeric suffixes.
2775 This is on by default for all pre-C++11 dialects and all GNU dialects:
2776 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2777 @option{-std=gnu++14}.
2778 This option is off by default
2779 for ISO C++11 onwards (@option{-std=c++11}, ...).
2780 @end table
2782 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2784 @table @gcctabopt
2785 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2786 @opindex Weffc++
2787 @opindex Wno-effc++
2788 Warn about violations of the following style guidelines from Scott Meyers'
2789 @cite{Effective C++} series of books:
2791 @itemize @bullet
2792 @item
2793 Define a copy constructor and an assignment operator for classes
2794 with dynamically-allocated memory.
2796 @item
2797 Prefer initialization to assignment in constructors.
2799 @item
2800 Have @code{operator=} return a reference to @code{*this}.
2802 @item
2803 Don't try to return a reference when you must return an object.
2805 @item
2806 Distinguish between prefix and postfix forms of increment and
2807 decrement operators.
2809 @item
2810 Never overload @code{&&}, @code{||}, or @code{,}.
2812 @end itemize
2814 This option also enables @option{-Wnon-virtual-dtor}, which is also
2815 one of the effective C++ recommendations.  However, the check is
2816 extended to warn about the lack of virtual destructor in accessible
2817 non-polymorphic bases classes too.
2819 When selecting this option, be aware that the standard library
2820 headers do not obey all of these guidelines; use @samp{grep -v}
2821 to filter out those warnings.
2823 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2824 @opindex Wstrict-null-sentinel
2825 @opindex Wno-strict-null-sentinel
2826 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2827 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2828 to @code{__null}.  Although it is a null pointer constant rather than a
2829 null pointer, it is guaranteed to be of the same size as a pointer.
2830 But this use is not portable across different compilers.
2832 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2833 @opindex Wno-non-template-friend
2834 @opindex Wnon-template-friend
2835 Disable warnings when non-templatized friend functions are declared
2836 within a template.  Since the advent of explicit template specification
2837 support in G++, if the name of the friend is an unqualified-id (i.e.,
2838 @samp{friend foo(int)}), the C++ language specification demands that the
2839 friend declare or define an ordinary, nontemplate function.  (Section
2840 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2841 could be interpreted as a particular specialization of a templatized
2842 function.  Because this non-conforming behavior is no longer the default
2843 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2844 check existing code for potential trouble spots and is on by default.
2845 This new compiler behavior can be turned off with
2846 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2847 but disables the helpful warning.
2849 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2850 @opindex Wold-style-cast
2851 @opindex Wno-old-style-cast
2852 Warn if an old-style (C-style) cast to a non-void type is used within
2853 a C++ program.  The new-style casts (@code{dynamic_cast},
2854 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2855 less vulnerable to unintended effects and much easier to search for.
2857 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2858 @opindex Woverloaded-virtual
2859 @opindex Wno-overloaded-virtual
2860 @cindex overloaded virtual function, warning
2861 @cindex warning for overloaded virtual function
2862 Warn when a function declaration hides virtual functions from a
2863 base class.  For example, in:
2865 @smallexample
2866 struct A @{
2867   virtual void f();
2870 struct B: public A @{
2871   void f(int);
2873 @end smallexample
2875 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2876 like:
2878 @smallexample
2879 B* b;
2880 b->f();
2881 @end smallexample
2883 @noindent
2884 fails to compile.
2886 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2887 @opindex Wno-pmf-conversions
2888 @opindex Wpmf-conversions
2889 Disable the diagnostic for converting a bound pointer to member function
2890 to a plain pointer.
2892 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2893 @opindex Wsign-promo
2894 @opindex Wno-sign-promo
2895 Warn when overload resolution chooses a promotion from unsigned or
2896 enumerated type to a signed type, over a conversion to an unsigned type of
2897 the same size.  Previous versions of G++ tried to preserve
2898 unsignedness, but the standard mandates the current behavior.
2900 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
2901 @opindex Wterminate
2902 @opindex Wno-terminate
2903 Disable the warning about a throw-expression that will immediately
2904 result in a call to @code{terminate}.
2905 @end table
2907 @node Objective-C and Objective-C++ Dialect Options
2908 @section Options Controlling Objective-C and Objective-C++ Dialects
2910 @cindex compiler options, Objective-C and Objective-C++
2911 @cindex Objective-C and Objective-C++ options, command-line
2912 @cindex options, Objective-C and Objective-C++
2913 (NOTE: This manual does not describe the Objective-C and Objective-C++
2914 languages themselves.  @xref{Standards,,Language Standards
2915 Supported by GCC}, for references.)
2917 This section describes the command-line options that are only meaningful
2918 for Objective-C and Objective-C++ programs.  You can also use most of
2919 the language-independent GNU compiler options.
2920 For example, you might compile a file @file{some_class.m} like this:
2922 @smallexample
2923 gcc -g -fgnu-runtime -O -c some_class.m
2924 @end smallexample
2926 @noindent
2927 In this example, @option{-fgnu-runtime} is an option meant only for
2928 Objective-C and Objective-C++ programs; you can use the other options with
2929 any language supported by GCC@.
2931 Note that since Objective-C is an extension of the C language, Objective-C
2932 compilations may also use options specific to the C front-end (e.g.,
2933 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2934 C++-specific options (e.g., @option{-Wabi}).
2936 Here is a list of options that are @emph{only} for compiling Objective-C
2937 and Objective-C++ programs:
2939 @table @gcctabopt
2940 @item -fconstant-string-class=@var{class-name}
2941 @opindex fconstant-string-class
2942 Use @var{class-name} as the name of the class to instantiate for each
2943 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2944 class name is @code{NXConstantString} if the GNU runtime is being used, and
2945 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2946 @option{-fconstant-cfstrings} option, if also present, overrides the
2947 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2948 to be laid out as constant CoreFoundation strings.
2950 @item -fgnu-runtime
2951 @opindex fgnu-runtime
2952 Generate object code compatible with the standard GNU Objective-C
2953 runtime.  This is the default for most types of systems.
2955 @item -fnext-runtime
2956 @opindex fnext-runtime
2957 Generate output compatible with the NeXT runtime.  This is the default
2958 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2959 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2960 used.
2962 @item -fno-nil-receivers
2963 @opindex fno-nil-receivers
2964 Assume that all Objective-C message dispatches (@code{[receiver
2965 message:arg]}) in this translation unit ensure that the receiver is
2966 not @code{nil}.  This allows for more efficient entry points in the
2967 runtime to be used.  This option is only available in conjunction with
2968 the NeXT runtime and ABI version 0 or 1.
2970 @item -fobjc-abi-version=@var{n}
2971 @opindex fobjc-abi-version
2972 Use version @var{n} of the Objective-C ABI for the selected runtime.
2973 This option is currently supported only for the NeXT runtime.  In that
2974 case, Version 0 is the traditional (32-bit) ABI without support for
2975 properties and other Objective-C 2.0 additions.  Version 1 is the
2976 traditional (32-bit) ABI with support for properties and other
2977 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2978 nothing is specified, the default is Version 0 on 32-bit target
2979 machines, and Version 2 on 64-bit target machines.
2981 @item -fobjc-call-cxx-cdtors
2982 @opindex fobjc-call-cxx-cdtors
2983 For each Objective-C class, check if any of its instance variables is a
2984 C++ object with a non-trivial default constructor.  If so, synthesize a
2985 special @code{- (id) .cxx_construct} instance method which runs
2986 non-trivial default constructors on any such instance variables, in order,
2987 and then return @code{self}.  Similarly, check if any instance variable
2988 is a C++ object with a non-trivial destructor, and if so, synthesize a
2989 special @code{- (void) .cxx_destruct} method which runs
2990 all such default destructors, in reverse order.
2992 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2993 methods thusly generated only operate on instance variables
2994 declared in the current Objective-C class, and not those inherited
2995 from superclasses.  It is the responsibility of the Objective-C
2996 runtime to invoke all such methods in an object's inheritance
2997 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2998 by the runtime immediately after a new object instance is allocated;
2999 the @code{- (void) .cxx_destruct} methods are invoked immediately
3000 before the runtime deallocates an object instance.
3002 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3003 support for invoking the @code{- (id) .cxx_construct} and
3004 @code{- (void) .cxx_destruct} methods.
3006 @item -fobjc-direct-dispatch
3007 @opindex fobjc-direct-dispatch
3008 Allow fast jumps to the message dispatcher.  On Darwin this is
3009 accomplished via the comm page.
3011 @item -fobjc-exceptions
3012 @opindex fobjc-exceptions
3013 Enable syntactic support for structured exception handling in
3014 Objective-C, similar to what is offered by C++ and Java.  This option
3015 is required to use the Objective-C keywords @code{@@try},
3016 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3017 @code{@@synchronized}.  This option is available with both the GNU
3018 runtime and the NeXT runtime (but not available in conjunction with
3019 the NeXT runtime on Mac OS X 10.2 and earlier).
3021 @item -fobjc-gc
3022 @opindex fobjc-gc
3023 Enable garbage collection (GC) in Objective-C and Objective-C++
3024 programs.  This option is only available with the NeXT runtime; the
3025 GNU runtime has a different garbage collection implementation that
3026 does not require special compiler flags.
3028 @item -fobjc-nilcheck
3029 @opindex fobjc-nilcheck
3030 For the NeXT runtime with version 2 of the ABI, check for a nil
3031 receiver in method invocations before doing the actual method call.
3032 This is the default and can be disabled using
3033 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3034 checked for nil in this way no matter what this flag is set to.
3035 Currently this flag does nothing when the GNU runtime, or an older
3036 version of the NeXT runtime ABI, is used.
3038 @item -fobjc-std=objc1
3039 @opindex fobjc-std
3040 Conform to the language syntax of Objective-C 1.0, the language
3041 recognized by GCC 4.0.  This only affects the Objective-C additions to
3042 the C/C++ language; it does not affect conformance to C/C++ standards,
3043 which is controlled by the separate C/C++ dialect option flags.  When
3044 this option is used with the Objective-C or Objective-C++ compiler,
3045 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3046 This is useful if you need to make sure that your Objective-C code can
3047 be compiled with older versions of GCC@.
3049 @item -freplace-objc-classes
3050 @opindex freplace-objc-classes
3051 Emit a special marker instructing @command{ld(1)} not to statically link in
3052 the resulting object file, and allow @command{dyld(1)} to load it in at
3053 run time instead.  This is used in conjunction with the Fix-and-Continue
3054 debugging mode, where the object file in question may be recompiled and
3055 dynamically reloaded in the course of program execution, without the need
3056 to restart the program itself.  Currently, Fix-and-Continue functionality
3057 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3058 and later.
3060 @item -fzero-link
3061 @opindex fzero-link
3062 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3063 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3064 compile time) with static class references that get initialized at load time,
3065 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3066 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3067 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3068 for individual class implementations to be modified during program execution.
3069 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3070 regardless of command-line options.
3072 @item -fno-local-ivars
3073 @opindex fno-local-ivars
3074 @opindex flocal-ivars
3075 By default instance variables in Objective-C can be accessed as if
3076 they were local variables from within the methods of the class they're
3077 declared in.  This can lead to shadowing between instance variables
3078 and other variables declared either locally inside a class method or
3079 globally with the same name.  Specifying the @option{-fno-local-ivars}
3080 flag disables this behavior thus avoiding variable shadowing issues.
3082 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3083 @opindex fivar-visibility
3084 Set the default instance variable visibility to the specified option
3085 so that instance variables declared outside the scope of any access
3086 modifier directives default to the specified visibility.
3088 @item -gen-decls
3089 @opindex gen-decls
3090 Dump interface declarations for all classes seen in the source file to a
3091 file named @file{@var{sourcename}.decl}.
3093 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3094 @opindex Wassign-intercept
3095 @opindex Wno-assign-intercept
3096 Warn whenever an Objective-C assignment is being intercepted by the
3097 garbage collector.
3099 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3100 @opindex Wno-protocol
3101 @opindex Wprotocol
3102 If a class is declared to implement a protocol, a warning is issued for
3103 every method in the protocol that is not implemented by the class.  The
3104 default behavior is to issue a warning for every method not explicitly
3105 implemented in the class, even if a method implementation is inherited
3106 from the superclass.  If you use the @option{-Wno-protocol} option, then
3107 methods inherited from the superclass are considered to be implemented,
3108 and no warning is issued for them.
3110 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3111 @opindex Wselector
3112 @opindex Wno-selector
3113 Warn if multiple methods of different types for the same selector are
3114 found during compilation.  The check is performed on the list of methods
3115 in the final stage of compilation.  Additionally, a check is performed
3116 for each selector appearing in a @code{@@selector(@dots{})}
3117 expression, and a corresponding method for that selector has been found
3118 during compilation.  Because these checks scan the method table only at
3119 the end of compilation, these warnings are not produced if the final
3120 stage of compilation is not reached, for example because an error is
3121 found during compilation, or because the @option{-fsyntax-only} option is
3122 being used.
3124 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3125 @opindex Wstrict-selector-match
3126 @opindex Wno-strict-selector-match
3127 Warn if multiple methods with differing argument and/or return types are
3128 found for a given selector when attempting to send a message using this
3129 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3130 is off (which is the default behavior), the compiler omits such warnings
3131 if any differences found are confined to types that share the same size
3132 and alignment.
3134 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3135 @opindex Wundeclared-selector
3136 @opindex Wno-undeclared-selector
3137 Warn if a @code{@@selector(@dots{})} expression referring to an
3138 undeclared selector is found.  A selector is considered undeclared if no
3139 method with that name has been declared before the
3140 @code{@@selector(@dots{})} expression, either explicitly in an
3141 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3142 an @code{@@implementation} section.  This option always performs its
3143 checks as soon as a @code{@@selector(@dots{})} expression is found,
3144 while @option{-Wselector} only performs its checks in the final stage of
3145 compilation.  This also enforces the coding style convention
3146 that methods and selectors must be declared before being used.
3148 @item -print-objc-runtime-info
3149 @opindex print-objc-runtime-info
3150 Generate C header describing the largest structure that is passed by
3151 value, if any.
3153 @end table
3155 @node Language Independent Options
3156 @section Options to Control Diagnostic Messages Formatting
3157 @cindex options to control diagnostics formatting
3158 @cindex diagnostic messages
3159 @cindex message formatting
3161 Traditionally, diagnostic messages have been formatted irrespective of
3162 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3163 options described below
3164 to control the formatting algorithm for diagnostic messages, 
3165 e.g.@: how many characters per line, how often source location
3166 information should be reported.  Note that some language front ends may not
3167 honor these options.
3169 @table @gcctabopt
3170 @item -fmessage-length=@var{n}
3171 @opindex fmessage-length
3172 Try to format error messages so that they fit on lines of about
3173 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3174 done; each error message appears on a single line.  This is the
3175 default for all front ends.
3177 @item -fdiagnostics-show-location=once
3178 @opindex fdiagnostics-show-location
3179 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3180 reporter to emit source location information @emph{once}; that is, in
3181 case the message is too long to fit on a single physical line and has to
3182 be wrapped, the source location won't be emitted (as prefix) again,
3183 over and over, in subsequent continuation lines.  This is the default
3184 behavior.
3186 @item -fdiagnostics-show-location=every-line
3187 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3188 messages reporter to emit the same source location information (as
3189 prefix) for physical lines that result from the process of breaking
3190 a message which is too long to fit on a single line.
3192 @item -fdiagnostics-color[=@var{WHEN}]
3193 @itemx -fno-diagnostics-color
3194 @opindex fdiagnostics-color
3195 @cindex highlight, color, colour
3196 @vindex GCC_COLORS @r{environment variable}
3197 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3198 or @samp{auto}.  The default depends on how the compiler has been configured,
3199 it can be any of the above @var{WHEN} options or also @samp{never}
3200 if @env{GCC_COLORS} environment variable isn't present in the environment,
3201 and @samp{auto} otherwise.
3202 @samp{auto} means to use color only when the standard error is a terminal.
3203 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3204 aliases for @option{-fdiagnostics-color=always} and
3205 @option{-fdiagnostics-color=never}, respectively.
3207 The colors are defined by the environment variable @env{GCC_COLORS}.
3208 Its value is a colon-separated list of capabilities and Select Graphic
3209 Rendition (SGR) substrings. SGR commands are interpreted by the
3210 terminal or terminal emulator.  (See the section in the documentation
3211 of your text terminal for permitted values and their meanings as
3212 character attributes.)  These substring values are integers in decimal
3213 representation and can be concatenated with semicolons.
3214 Common values to concatenate include
3215 @samp{1} for bold,
3216 @samp{4} for underline,
3217 @samp{5} for blink,
3218 @samp{7} for inverse,
3219 @samp{39} for default foreground color,
3220 @samp{30} to @samp{37} for foreground colors,
3221 @samp{90} to @samp{97} for 16-color mode foreground colors,
3222 @samp{38;5;0} to @samp{38;5;255}
3223 for 88-color and 256-color modes foreground colors,
3224 @samp{49} for default background color,
3225 @samp{40} to @samp{47} for background colors,
3226 @samp{100} to @samp{107} for 16-color mode background colors,
3227 and @samp{48;5;0} to @samp{48;5;255}
3228 for 88-color and 256-color modes background colors.
3230 The default @env{GCC_COLORS} is
3231 @smallexample
3232 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3233 @end smallexample
3234 @noindent
3235 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3236 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3237 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3238 string disables colors.
3239 Supported capabilities are as follows.
3241 @table @code
3242 @item error=
3243 @vindex error GCC_COLORS @r{capability}
3244 SGR substring for error: markers.
3246 @item warning=
3247 @vindex warning GCC_COLORS @r{capability}
3248 SGR substring for warning: markers.
3250 @item note=
3251 @vindex note GCC_COLORS @r{capability}
3252 SGR substring for note: markers.
3254 @item caret=
3255 @vindex caret GCC_COLORS @r{capability}
3256 SGR substring for caret line.
3258 @item locus=
3259 @vindex locus GCC_COLORS @r{capability}
3260 SGR substring for location information, @samp{file:line} or
3261 @samp{file:line:column} etc.
3263 @item quote=
3264 @vindex quote GCC_COLORS @r{capability}
3265 SGR substring for information printed within quotes.
3266 @end table
3268 @item -fno-diagnostics-show-option
3269 @opindex fno-diagnostics-show-option
3270 @opindex fdiagnostics-show-option
3271 By default, each diagnostic emitted includes text indicating the
3272 command-line option that directly controls the diagnostic (if such an
3273 option is known to the diagnostic machinery).  Specifying the
3274 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3276 @item -fno-diagnostics-show-caret
3277 @opindex fno-diagnostics-show-caret
3278 @opindex fdiagnostics-show-caret
3279 By default, each diagnostic emitted includes the original source line
3280 and a caret '^' indicating the column.  This option suppresses this
3281 information.  The source line is truncated to @var{n} characters, if
3282 the @option{-fmessage-length=n} option is given.  When the output is done
3283 to the terminal, the width is limited to the width given by the
3284 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3286 @end table
3288 @node Warning Options
3289 @section Options to Request or Suppress Warnings
3290 @cindex options to control warnings
3291 @cindex warning messages
3292 @cindex messages, warning
3293 @cindex suppressing warnings
3295 Warnings are diagnostic messages that report constructions that
3296 are not inherently erroneous but that are risky or suggest there
3297 may have been an error.
3299 The following language-independent options do not enable specific
3300 warnings but control the kinds of diagnostics produced by GCC@.
3302 @table @gcctabopt
3303 @cindex syntax checking
3304 @item -fsyntax-only
3305 @opindex fsyntax-only
3306 Check the code for syntax errors, but don't do anything beyond that.
3308 @item -fmax-errors=@var{n}
3309 @opindex fmax-errors
3310 Limits the maximum number of error messages to @var{n}, at which point
3311 GCC bails out rather than attempting to continue processing the source
3312 code.  If @var{n} is 0 (the default), there is no limit on the number
3313 of error messages produced.  If @option{-Wfatal-errors} is also
3314 specified, then @option{-Wfatal-errors} takes precedence over this
3315 option.
3317 @item -w
3318 @opindex w
3319 Inhibit all warning messages.
3321 @item -Werror
3322 @opindex Werror
3323 @opindex Wno-error
3324 Make all warnings into errors.
3326 @item -Werror=
3327 @opindex Werror=
3328 @opindex Wno-error=
3329 Make the specified warning into an error.  The specifier for a warning
3330 is appended; for example @option{-Werror=switch} turns the warnings
3331 controlled by @option{-Wswitch} into errors.  This switch takes a
3332 negative form, to be used to negate @option{-Werror} for specific
3333 warnings; for example @option{-Wno-error=switch} makes
3334 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3335 is in effect.
3337 The warning message for each controllable warning includes the
3338 option that controls the warning.  That option can then be used with
3339 @option{-Werror=} and @option{-Wno-error=} as described above.
3340 (Printing of the option in the warning message can be disabled using the
3341 @option{-fno-diagnostics-show-option} flag.)
3343 Note that specifying @option{-Werror=}@var{foo} automatically implies
3344 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3345 imply anything.
3347 @item -Wfatal-errors
3348 @opindex Wfatal-errors
3349 @opindex Wno-fatal-errors
3350 This option causes the compiler to abort compilation on the first error
3351 occurred rather than trying to keep going and printing further error
3352 messages.
3354 @end table
3356 You can request many specific warnings with options beginning with
3357 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3358 implicit declarations.  Each of these specific warning options also
3359 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3360 example, @option{-Wno-implicit}.  This manual lists only one of the
3361 two forms, whichever is not the default.  For further
3362 language-specific options also refer to @ref{C++ Dialect Options} and
3363 @ref{Objective-C and Objective-C++ Dialect Options}.
3365 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3366 options, such as @option{-Wunused}, which may turn on further options,
3367 such as @option{-Wunused-value}. The combined effect of positive and
3368 negative forms is that more specific options have priority over less
3369 specific ones, independently of their position in the command-line. For
3370 options of the same specificity, the last one takes effect. Options
3371 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3372 as if they appeared at the end of the command-line.
3374 When an unrecognized warning option is requested (e.g.,
3375 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3376 that the option is not recognized.  However, if the @option{-Wno-} form
3377 is used, the behavior is slightly different: no diagnostic is
3378 produced for @option{-Wno-unknown-warning} unless other diagnostics
3379 are being produced.  This allows the use of new @option{-Wno-} options
3380 with old compilers, but if something goes wrong, the compiler
3381 warns that an unrecognized option is present.
3383 @table @gcctabopt
3384 @item -Wpedantic
3385 @itemx -pedantic
3386 @opindex pedantic
3387 @opindex Wpedantic
3388 Issue all the warnings demanded by strict ISO C and ISO C++;
3389 reject all programs that use forbidden extensions, and some other
3390 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3391 version of the ISO C standard specified by any @option{-std} option used.
3393 Valid ISO C and ISO C++ programs should compile properly with or without
3394 this option (though a rare few require @option{-ansi} or a
3395 @option{-std} option specifying the required version of ISO C)@.  However,
3396 without this option, certain GNU extensions and traditional C and C++
3397 features are supported as well.  With this option, they are rejected.
3399 @option{-Wpedantic} does not cause warning messages for use of the
3400 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3401 warnings are also disabled in the expression that follows
3402 @code{__extension__}.  However, only system header files should use
3403 these escape routes; application programs should avoid them.
3404 @xref{Alternate Keywords}.
3406 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3407 C conformance.  They soon find that it does not do quite what they want:
3408 it finds some non-ISO practices, but not all---only those for which
3409 ISO C @emph{requires} a diagnostic, and some others for which
3410 diagnostics have been added.
3412 A feature to report any failure to conform to ISO C might be useful in
3413 some instances, but would require considerable additional work and would
3414 be quite different from @option{-Wpedantic}.  We don't have plans to
3415 support such a feature in the near future.
3417 Where the standard specified with @option{-std} represents a GNU
3418 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3419 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3420 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3421 where they are required by the base standard.  (It does not make sense
3422 for such warnings to be given only for features not in the specified GNU
3423 C dialect, since by definition the GNU dialects of C include all
3424 features the compiler supports with the given option, and there would be
3425 nothing to warn about.)
3427 @item -pedantic-errors
3428 @opindex pedantic-errors
3429 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3430 requires a diagnostic, in some cases where there is undefined behavior
3431 at compile-time and in some other cases that do not prevent compilation
3432 of programs that are valid according to the standard. This is not
3433 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3434 by this option and not enabled by the latter and vice versa.
3436 @item -Wall
3437 @opindex Wall
3438 @opindex Wno-all
3439 This enables all the warnings about constructions that some users
3440 consider questionable, and that are easy to avoid (or modify to
3441 prevent the warning), even in conjunction with macros.  This also
3442 enables some language-specific warnings described in @ref{C++ Dialect
3443 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3445 @option{-Wall} turns on the following warning flags:
3447 @gccoptlist{-Waddress   @gol
3448 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3449 -Wc++11-compat  -Wc++14-compat@gol
3450 -Wchar-subscripts  @gol
3451 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3452 -Wimplicit-int @r{(C and Objective-C only)} @gol
3453 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3454 -Wcomment  @gol
3455 -Wformat   @gol
3456 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3457 -Wmaybe-uninitialized @gol
3458 -Wmissing-braces @r{(only for C/ObjC)} @gol
3459 -Wnonnull  @gol
3460 -Wopenmp-simd @gol
3461 -Wparentheses  @gol
3462 -Wpointer-sign  @gol
3463 -Wreorder   @gol
3464 -Wreturn-type  @gol
3465 -Wsequence-point  @gol
3466 -Wsign-compare @r{(only in C++)}  @gol
3467 -Wstrict-aliasing  @gol
3468 -Wstrict-overflow=1  @gol
3469 -Wswitch  @gol
3470 -Wtrigraphs  @gol
3471 -Wuninitialized  @gol
3472 -Wunknown-pragmas  @gol
3473 -Wunused-function  @gol
3474 -Wunused-label     @gol
3475 -Wunused-value     @gol
3476 -Wunused-variable  @gol
3477 -Wvolatile-register-var @gol
3480 Note that some warning flags are not implied by @option{-Wall}.  Some of
3481 them warn about constructions that users generally do not consider
3482 questionable, but which occasionally you might wish to check for;
3483 others warn about constructions that are necessary or hard to avoid in
3484 some cases, and there is no simple way to modify the code to suppress
3485 the warning. Some of them are enabled by @option{-Wextra} but many of
3486 them must be enabled individually.
3488 @item -Wextra
3489 @opindex W
3490 @opindex Wextra
3491 @opindex Wno-extra
3492 This enables some extra warning flags that are not enabled by
3493 @option{-Wall}. (This option used to be called @option{-W}.  The older
3494 name is still supported, but the newer name is more descriptive.)
3496 @gccoptlist{-Wclobbered  @gol
3497 -Wempty-body  @gol
3498 -Wignored-qualifiers @gol
3499 -Wmissing-field-initializers  @gol
3500 -Wmissing-parameter-type @r{(C only)}  @gol
3501 -Wold-style-declaration @r{(C only)}  @gol
3502 -Woverride-init  @gol
3503 -Wsign-compare  @gol
3504 -Wtype-limits  @gol
3505 -Wuninitialized  @gol
3506 -Wshift-negative-value  @gol
3507 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3508 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3511 The option @option{-Wextra} also prints warning messages for the
3512 following cases:
3514 @itemize @bullet
3516 @item
3517 A pointer is compared against integer zero with @code{<}, @code{<=},
3518 @code{>}, or @code{>=}.
3520 @item
3521 (C++ only) An enumerator and a non-enumerator both appear in a
3522 conditional expression.
3524 @item
3525 (C++ only) Ambiguous virtual bases.
3527 @item
3528 (C++ only) Subscripting an array that has been declared @code{register}.
3530 @item
3531 (C++ only) Taking the address of a variable that has been declared
3532 @code{register}.
3534 @item
3535 (C++ only) A base class is not initialized in a derived class's copy
3536 constructor.
3538 @end itemize
3540 @item -Wchar-subscripts
3541 @opindex Wchar-subscripts
3542 @opindex Wno-char-subscripts
3543 Warn if an array subscript has type @code{char}.  This is a common cause
3544 of error, as programmers often forget that this type is signed on some
3545 machines.
3546 This warning is enabled by @option{-Wall}.
3548 @item -Wcomment
3549 @opindex Wcomment
3550 @opindex Wno-comment
3551 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3552 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3553 This warning is enabled by @option{-Wall}.
3555 @item -Wno-coverage-mismatch
3556 @opindex Wno-coverage-mismatch
3557 Warn if feedback profiles do not match when using the
3558 @option{-fprofile-use} option.
3559 If a source file is changed between compiling with @option{-fprofile-gen} and
3560 with @option{-fprofile-use}, the files with the profile feedback can fail
3561 to match the source file and GCC cannot use the profile feedback
3562 information.  By default, this warning is enabled and is treated as an
3563 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3564 warning or @option{-Wno-error=coverage-mismatch} can be used to
3565 disable the error.  Disabling the error for this warning can result in
3566 poorly optimized code and is useful only in the
3567 case of very minor changes such as bug fixes to an existing code-base.
3568 Completely disabling the warning is not recommended.
3570 @item -Wno-cpp
3571 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3573 Suppress warning messages emitted by @code{#warning} directives.
3575 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3576 @opindex Wdouble-promotion
3577 @opindex Wno-double-promotion
3578 Give a warning when a value of type @code{float} is implicitly
3579 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3580 floating-point unit implement @code{float} in hardware, but emulate
3581 @code{double} in software.  On such a machine, doing computations
3582 using @code{double} values is much more expensive because of the
3583 overhead required for software emulation.
3585 It is easy to accidentally do computations with @code{double} because
3586 floating-point literals are implicitly of type @code{double}.  For
3587 example, in:
3588 @smallexample
3589 @group
3590 float area(float radius)
3592    return 3.14159 * radius * radius;
3594 @end group
3595 @end smallexample
3596 the compiler performs the entire computation with @code{double}
3597 because the floating-point literal is a @code{double}.
3599 @item -Wformat
3600 @itemx -Wformat=@var{n}
3601 @opindex Wformat
3602 @opindex Wno-format
3603 @opindex ffreestanding
3604 @opindex fno-builtin
3605 @opindex Wformat=
3606 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3607 the arguments supplied have types appropriate to the format string
3608 specified, and that the conversions specified in the format string make
3609 sense.  This includes standard functions, and others specified by format
3610 attributes (@pxref{Function Attributes}), in the @code{printf},
3611 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3612 not in the C standard) families (or other target-specific families).
3613 Which functions are checked without format attributes having been
3614 specified depends on the standard version selected, and such checks of
3615 functions without the attribute specified are disabled by
3616 @option{-ffreestanding} or @option{-fno-builtin}.
3618 The formats are checked against the format features supported by GNU
3619 libc version 2.2.  These include all ISO C90 and C99 features, as well
3620 as features from the Single Unix Specification and some BSD and GNU
3621 extensions.  Other library implementations may not support all these
3622 features; GCC does not support warning about features that go beyond a
3623 particular library's limitations.  However, if @option{-Wpedantic} is used
3624 with @option{-Wformat}, warnings are given about format features not
3625 in the selected standard version (but not for @code{strfmon} formats,
3626 since those are not in any version of the C standard).  @xref{C Dialect
3627 Options,,Options Controlling C Dialect}.
3629 @table @gcctabopt
3630 @item -Wformat=1
3631 @itemx -Wformat
3632 @opindex Wformat
3633 @opindex Wformat=1
3634 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3635 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3636 @option{-Wformat} also checks for null format arguments for several
3637 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3638 aspects of this level of format checking can be disabled by the
3639 options: @option{-Wno-format-contains-nul},
3640 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3641 @option{-Wformat} is enabled by @option{-Wall}.
3643 @item -Wno-format-contains-nul
3644 @opindex Wno-format-contains-nul
3645 @opindex Wformat-contains-nul
3646 If @option{-Wformat} is specified, do not warn about format strings that
3647 contain NUL bytes.
3649 @item -Wno-format-extra-args
3650 @opindex Wno-format-extra-args
3651 @opindex Wformat-extra-args
3652 If @option{-Wformat} is specified, do not warn about excess arguments to a
3653 @code{printf} or @code{scanf} format function.  The C standard specifies
3654 that such arguments are ignored.
3656 Where the unused arguments lie between used arguments that are
3657 specified with @samp{$} operand number specifications, normally
3658 warnings are still given, since the implementation could not know what
3659 type to pass to @code{va_arg} to skip the unused arguments.  However,
3660 in the case of @code{scanf} formats, this option suppresses the
3661 warning if the unused arguments are all pointers, since the Single
3662 Unix Specification says that such unused arguments are allowed.
3664 @item -Wno-format-zero-length
3665 @opindex Wno-format-zero-length
3666 @opindex Wformat-zero-length
3667 If @option{-Wformat} is specified, do not warn about zero-length formats.
3668 The C standard specifies that zero-length formats are allowed.
3671 @item -Wformat=2
3672 @opindex Wformat=2
3673 Enable @option{-Wformat} plus additional format checks.  Currently
3674 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3675 -Wformat-y2k}.
3677 @item -Wformat-nonliteral
3678 @opindex Wformat-nonliteral
3679 @opindex Wno-format-nonliteral
3680 If @option{-Wformat} is specified, also warn if the format string is not a
3681 string literal and so cannot be checked, unless the format function
3682 takes its format arguments as a @code{va_list}.
3684 @item -Wformat-security
3685 @opindex Wformat-security
3686 @opindex Wno-format-security
3687 If @option{-Wformat} is specified, also warn about uses of format
3688 functions that represent possible security problems.  At present, this
3689 warns about calls to @code{printf} and @code{scanf} functions where the
3690 format string is not a string literal and there are no format arguments,
3691 as in @code{printf (foo);}.  This may be a security hole if the format
3692 string came from untrusted input and contains @samp{%n}.  (This is
3693 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3694 in future warnings may be added to @option{-Wformat-security} that are not
3695 included in @option{-Wformat-nonliteral}.)
3697 @item -Wformat-signedness
3698 @opindex Wformat-signedness
3699 @opindex Wno-format-signedness
3700 If @option{-Wformat} is specified, also warn if the format string
3701 requires an unsigned argument and the argument is signed and vice versa.
3703 @item -Wformat-y2k
3704 @opindex Wformat-y2k
3705 @opindex Wno-format-y2k
3706 If @option{-Wformat} is specified, also warn about @code{strftime}
3707 formats that may yield only a two-digit year.
3708 @end table
3710 @item -Wnonnull
3711 @opindex Wnonnull
3712 @opindex Wno-nonnull
3713 Warn about passing a null pointer for arguments marked as
3714 requiring a non-null value by the @code{nonnull} function attribute.
3716 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3717 can be disabled with the @option{-Wno-nonnull} option.
3719 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3720 @opindex Winit-self
3721 @opindex Wno-init-self
3722 Warn about uninitialized variables that are initialized with themselves.
3723 Note this option can only be used with the @option{-Wuninitialized} option.
3725 For example, GCC warns about @code{i} being uninitialized in the
3726 following snippet only when @option{-Winit-self} has been specified:
3727 @smallexample
3728 @group
3729 int f()
3731   int i = i;
3732   return i;
3734 @end group
3735 @end smallexample
3737 This warning is enabled by @option{-Wall} in C++.
3739 @item -Wimplicit-int @r{(C and Objective-C only)}
3740 @opindex Wimplicit-int
3741 @opindex Wno-implicit-int
3742 Warn when a declaration does not specify a type.
3743 This warning is enabled by @option{-Wall}.
3745 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3746 @opindex Wimplicit-function-declaration
3747 @opindex Wno-implicit-function-declaration
3748 Give a warning whenever a function is used before being declared. In
3749 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3750 enabled by default and it is made into an error by
3751 @option{-pedantic-errors}. This warning is also enabled by
3752 @option{-Wall}.
3754 @item -Wimplicit @r{(C and Objective-C only)}
3755 @opindex Wimplicit
3756 @opindex Wno-implicit
3757 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3758 This warning is enabled by @option{-Wall}.
3760 @item -Wignored-qualifiers @r{(C and C++ only)}
3761 @opindex Wignored-qualifiers
3762 @opindex Wno-ignored-qualifiers
3763 Warn if the return type of a function has a type qualifier
3764 such as @code{const}.  For ISO C such a type qualifier has no effect,
3765 since the value returned by a function is not an lvalue.
3766 For C++, the warning is only emitted for scalar types or @code{void}.
3767 ISO C prohibits qualified @code{void} return types on function
3768 definitions, so such return types always receive a warning
3769 even without this option.
3771 This warning is also enabled by @option{-Wextra}.
3773 @item -Wmain
3774 @opindex Wmain
3775 @opindex Wno-main
3776 Warn if the type of @code{main} is suspicious.  @code{main} should be
3777 a function with external linkage, returning int, taking either zero
3778 arguments, two, or three arguments of appropriate types.  This warning
3779 is enabled by default in C++ and is enabled by either @option{-Wall}
3780 or @option{-Wpedantic}.
3782 @item -Wmisleading-indentation @r{(C and C++ only)}
3783 @opindex Wmisleading-indentation
3784 @opindex Wno-misleading-indentation
3785 Warn when the indentation of the code does not reflect the block structure.
3786 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
3787 @code{for} clauses with a guarded statement that does not use braces,
3788 followed by an unguarded statement with the same indentation.
3790 This warning is disabled by default.
3792 In the following example, the call to ``bar'' is misleadingly indented as
3793 if it were guarded by the ``if'' conditional.
3795 @smallexample
3796   if (some_condition ())
3797     foo ();
3798     bar ();  /* Gotcha: this is not guarded by the "if".  */
3799 @end smallexample
3801 In the case of mixed tabs and spaces, the warning uses the
3802 @option{-ftabstop=} option to determine if the statements line up
3803 (defaulting to 8).
3805 The warning is not issued for code involving multiline preprocessor logic
3806 such as the following example.
3808 @smallexample
3809   if (flagA)
3810     foo (0);
3811 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
3812   if (flagB)
3813 #endif
3814     foo (1);
3815 @end smallexample
3817 The warning is not issued after a @code{#line} directive, since this
3818 typically indicates autogenerated code, and no assumptions can be made
3819 about the layout of the file that the directive references.
3821 @item -Wmissing-braces
3822 @opindex Wmissing-braces
3823 @opindex Wno-missing-braces
3824 Warn if an aggregate or union initializer is not fully bracketed.  In
3825 the following example, the initializer for @code{a} is not fully
3826 bracketed, but that for @code{b} is fully bracketed.  This warning is
3827 enabled by @option{-Wall} in C.
3829 @smallexample
3830 int a[2][2] = @{ 0, 1, 2, 3 @};
3831 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3832 @end smallexample
3834 This warning is enabled by @option{-Wall}.
3836 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3837 @opindex Wmissing-include-dirs
3838 @opindex Wno-missing-include-dirs
3839 Warn if a user-supplied include directory does not exist.
3841 @item -Wparentheses
3842 @opindex Wparentheses
3843 @opindex Wno-parentheses
3844 Warn if parentheses are omitted in certain contexts, such
3845 as when there is an assignment in a context where a truth value
3846 is expected, or when operators are nested whose precedence people
3847 often get confused about.
3849 Also warn if a comparison like @code{x<=y<=z} appears; this is
3850 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3851 interpretation from that of ordinary mathematical notation.
3853 Also warn about constructions where there may be confusion to which
3854 @code{if} statement an @code{else} branch belongs.  Here is an example of
3855 such a case:
3857 @smallexample
3858 @group
3860   if (a)
3861     if (b)
3862       foo ();
3863   else
3864     bar ();
3866 @end group
3867 @end smallexample
3869 In C/C++, every @code{else} branch belongs to the innermost possible
3870 @code{if} statement, which in this example is @code{if (b)}.  This is
3871 often not what the programmer expected, as illustrated in the above
3872 example by indentation the programmer chose.  When there is the
3873 potential for this confusion, GCC issues a warning when this flag
3874 is specified.  To eliminate the warning, add explicit braces around
3875 the innermost @code{if} statement so there is no way the @code{else}
3876 can belong to the enclosing @code{if}.  The resulting code
3877 looks like this:
3879 @smallexample
3880 @group
3882   if (a)
3883     @{
3884       if (b)
3885         foo ();
3886       else
3887         bar ();
3888     @}
3890 @end group
3891 @end smallexample
3893 Also warn for dangerous uses of the GNU extension to
3894 @code{?:} with omitted middle operand. When the condition
3895 in the @code{?}: operator is a boolean expression, the omitted value is
3896 always 1.  Often programmers expect it to be a value computed
3897 inside the conditional expression instead.
3899 This warning is enabled by @option{-Wall}.
3901 @item -Wsequence-point
3902 @opindex Wsequence-point
3903 @opindex Wno-sequence-point
3904 Warn about code that may have undefined semantics because of violations
3905 of sequence point rules in the C and C++ standards.
3907 The C and C++ standards define the order in which expressions in a C/C++
3908 program are evaluated in terms of @dfn{sequence points}, which represent
3909 a partial ordering between the execution of parts of the program: those
3910 executed before the sequence point, and those executed after it.  These
3911 occur after the evaluation of a full expression (one which is not part
3912 of a larger expression), after the evaluation of the first operand of a
3913 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3914 function is called (but after the evaluation of its arguments and the
3915 expression denoting the called function), and in certain other places.
3916 Other than as expressed by the sequence point rules, the order of
3917 evaluation of subexpressions of an expression is not specified.  All
3918 these rules describe only a partial order rather than a total order,
3919 since, for example, if two functions are called within one expression
3920 with no sequence point between them, the order in which the functions
3921 are called is not specified.  However, the standards committee have
3922 ruled that function calls do not overlap.
3924 It is not specified when between sequence points modifications to the
3925 values of objects take effect.  Programs whose behavior depends on this
3926 have undefined behavior; the C and C++ standards specify that ``Between
3927 the previous and next sequence point an object shall have its stored
3928 value modified at most once by the evaluation of an expression.
3929 Furthermore, the prior value shall be read only to determine the value
3930 to be stored.''.  If a program breaks these rules, the results on any
3931 particular implementation are entirely unpredictable.
3933 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3934 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3935 diagnosed by this option, and it may give an occasional false positive
3936 result, but in general it has been found fairly effective at detecting
3937 this sort of problem in programs.
3939 The standard is worded confusingly, therefore there is some debate
3940 over the precise meaning of the sequence point rules in subtle cases.
3941 Links to discussions of the problem, including proposed formal
3942 definitions, may be found on the GCC readings page, at
3943 @uref{http://gcc.gnu.org/@/readings.html}.
3945 This warning is enabled by @option{-Wall} for C and C++.
3947 @item -Wno-return-local-addr
3948 @opindex Wno-return-local-addr
3949 @opindex Wreturn-local-addr
3950 Do not warn about returning a pointer (or in C++, a reference) to a
3951 variable that goes out of scope after the function returns.
3953 @item -Wreturn-type
3954 @opindex Wreturn-type
3955 @opindex Wno-return-type
3956 Warn whenever a function is defined with a return type that defaults
3957 to @code{int}.  Also warn about any @code{return} statement with no
3958 return value in a function whose return type is not @code{void}
3959 (falling off the end of the function body is considered returning
3960 without a value), and about a @code{return} statement with an
3961 expression in a function whose return type is @code{void}.
3963 For C++, a function without return type always produces a diagnostic
3964 message, even when @option{-Wno-return-type} is specified.  The only
3965 exceptions are @code{main} and functions defined in system headers.
3967 This warning is enabled by @option{-Wall}.
3969 @item -Wshift-count-negative
3970 @opindex Wshift-count-negative
3971 @opindex Wno-shift-count-negative
3972 Warn if shift count is negative. This warning is enabled by default.
3974 @item -Wshift-count-overflow
3975 @opindex Wshift-count-overflow
3976 @opindex Wno-shift-count-overflow
3977 Warn if shift count >= width of type. This warning is enabled by default.
3979 @item -Wshift-negative-value
3980 @opindex Wshift-negative-value
3981 @opindex Wno-shift-negative-value
3982 Warn if left shifting a negative value.  This warning is enabled by
3983 @option{-Wextra} in C99 and C++11 modes (and newer).
3985 @item -Wswitch
3986 @opindex Wswitch
3987 @opindex Wno-switch
3988 Warn whenever a @code{switch} statement has an index of enumerated type
3989 and lacks a @code{case} for one or more of the named codes of that
3990 enumeration.  (The presence of a @code{default} label prevents this
3991 warning.)  @code{case} labels outside the enumeration range also
3992 provoke warnings when this option is used (even if there is a
3993 @code{default} label).
3994 This warning is enabled by @option{-Wall}.
3996 @item -Wswitch-default
3997 @opindex Wswitch-default
3998 @opindex Wno-switch-default
3999 Warn whenever a @code{switch} statement does not have a @code{default}
4000 case.
4002 @item -Wswitch-enum
4003 @opindex Wswitch-enum
4004 @opindex Wno-switch-enum
4005 Warn whenever a @code{switch} statement has an index of enumerated type
4006 and lacks a @code{case} for one or more of the named codes of that
4007 enumeration.  @code{case} labels outside the enumeration range also
4008 provoke warnings when this option is used.  The only difference
4009 between @option{-Wswitch} and this option is that this option gives a
4010 warning about an omitted enumeration code even if there is a
4011 @code{default} label.
4013 @item -Wswitch-bool
4014 @opindex Wswitch-bool
4015 @opindex Wno-switch-bool
4016 Warn whenever a @code{switch} statement has an index of boolean type
4017 and the case values are outside the range of a boolean type.
4018 It is possible to suppress this warning by casting the controlling
4019 expression to a type other than @code{bool}.  For example:
4020 @smallexample
4021 @group
4022 switch ((int) (a == 4))
4023   @{
4024   @dots{}
4025   @}
4026 @end group
4027 @end smallexample
4028 This warning is enabled by default for C and C++ programs.
4030 @item -Wsync-nand @r{(C and C++ only)}
4031 @opindex Wsync-nand
4032 @opindex Wno-sync-nand
4033 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4034 built-in functions are used.  These functions changed semantics in GCC 4.4.
4036 @item -Wtrigraphs
4037 @opindex Wtrigraphs
4038 @opindex Wno-trigraphs
4039 Warn if any trigraphs are encountered that might change the meaning of
4040 the program (trigraphs within comments are not warned about).
4041 This warning is enabled by @option{-Wall}.
4043 @item -Wunused-but-set-parameter
4044 @opindex Wunused-but-set-parameter
4045 @opindex Wno-unused-but-set-parameter
4046 Warn whenever a function parameter is assigned to, but otherwise unused
4047 (aside from its declaration).
4049 To suppress this warning use the @code{unused} attribute
4050 (@pxref{Variable Attributes}).
4052 This warning is also enabled by @option{-Wunused} together with
4053 @option{-Wextra}.
4055 @item -Wunused-but-set-variable
4056 @opindex Wunused-but-set-variable
4057 @opindex Wno-unused-but-set-variable
4058 Warn whenever a local variable is assigned to, but otherwise unused
4059 (aside from its declaration).
4060 This warning is enabled by @option{-Wall}.
4062 To suppress this warning use the @code{unused} attribute
4063 (@pxref{Variable Attributes}).
4065 This warning is also enabled by @option{-Wunused}, which is enabled
4066 by @option{-Wall}.
4068 @item -Wunused-function
4069 @opindex Wunused-function
4070 @opindex Wno-unused-function
4071 Warn whenever a static function is declared but not defined or a
4072 non-inline static function is unused.
4073 This warning is enabled by @option{-Wall}.
4075 @item -Wunused-label
4076 @opindex Wunused-label
4077 @opindex Wno-unused-label
4078 Warn whenever a label is declared but not used.
4079 This warning is enabled by @option{-Wall}.
4081 To suppress this warning use the @code{unused} attribute
4082 (@pxref{Variable Attributes}).
4084 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4085 @opindex Wunused-local-typedefs
4086 Warn when a typedef locally defined in a function is not used.
4087 This warning is enabled by @option{-Wall}.
4089 @item -Wunused-parameter
4090 @opindex Wunused-parameter
4091 @opindex Wno-unused-parameter
4092 Warn whenever a function parameter is unused aside from its declaration.
4094 To suppress this warning use the @code{unused} attribute
4095 (@pxref{Variable Attributes}).
4097 @item -Wno-unused-result
4098 @opindex Wunused-result
4099 @opindex Wno-unused-result
4100 Do not warn if a caller of a function marked with attribute
4101 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4102 its return value. The default is @option{-Wunused-result}.
4104 @item -Wunused-variable
4105 @opindex Wunused-variable
4106 @opindex Wno-unused-variable
4107 Warn whenever a local variable or non-constant static variable is unused
4108 aside from its declaration.
4109 This warning is enabled by @option{-Wall}.
4111 To suppress this warning use the @code{unused} attribute
4112 (@pxref{Variable Attributes}).
4114 @item -Wunused-value
4115 @opindex Wunused-value
4116 @opindex Wno-unused-value
4117 Warn whenever a statement computes a result that is explicitly not
4118 used. To suppress this warning cast the unused expression to
4119 @code{void}. This includes an expression-statement or the left-hand
4120 side of a comma expression that contains no side effects. For example,
4121 an expression such as @code{x[i,j]} causes a warning, while
4122 @code{x[(void)i,j]} does not.
4124 This warning is enabled by @option{-Wall}.
4126 @item -Wunused
4127 @opindex Wunused
4128 @opindex Wno-unused
4129 All the above @option{-Wunused} options combined.
4131 In order to get a warning about an unused function parameter, you must
4132 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4133 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4135 @item -Wuninitialized
4136 @opindex Wuninitialized
4137 @opindex Wno-uninitialized
4138 Warn if an automatic variable is used without first being initialized
4139 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4140 warn if a non-static reference or non-static @code{const} member
4141 appears in a class without constructors.
4143 If you want to warn about code that uses the uninitialized value of the
4144 variable in its own initializer, use the @option{-Winit-self} option.
4146 These warnings occur for individual uninitialized or clobbered
4147 elements of structure, union or array variables as well as for
4148 variables that are uninitialized or clobbered as a whole.  They do
4149 not occur for variables or elements declared @code{volatile}.  Because
4150 these warnings depend on optimization, the exact variables or elements
4151 for which there are warnings depends on the precise optimization
4152 options and version of GCC used.
4154 Note that there may be no warning about a variable that is used only
4155 to compute a value that itself is never used, because such
4156 computations may be deleted by data flow analysis before the warnings
4157 are printed.
4159 @item -Wmaybe-uninitialized
4160 @opindex Wmaybe-uninitialized
4161 @opindex Wno-maybe-uninitialized
4162 For an automatic variable, if there exists a path from the function
4163 entry to a use of the variable that is initialized, but there exist
4164 some other paths for which the variable is not initialized, the compiler
4165 emits a warning if it cannot prove the uninitialized paths are not
4166 executed at run time. These warnings are made optional because GCC is
4167 not smart enough to see all the reasons why the code might be correct
4168 in spite of appearing to have an error.  Here is one example of how
4169 this can happen:
4171 @smallexample
4172 @group
4174   int x;
4175   switch (y)
4176     @{
4177     case 1: x = 1;
4178       break;
4179     case 2: x = 4;
4180       break;
4181     case 3: x = 5;
4182     @}
4183   foo (x);
4185 @end group
4186 @end smallexample
4188 @noindent
4189 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4190 always initialized, but GCC doesn't know this. To suppress the
4191 warning, you need to provide a default case with assert(0) or
4192 similar code.
4194 @cindex @code{longjmp} warnings
4195 This option also warns when a non-volatile automatic variable might be
4196 changed by a call to @code{longjmp}.  These warnings as well are possible
4197 only in optimizing compilation.
4199 The compiler sees only the calls to @code{setjmp}.  It cannot know
4200 where @code{longjmp} will be called; in fact, a signal handler could
4201 call it at any point in the code.  As a result, you may get a warning
4202 even when there is in fact no problem because @code{longjmp} cannot
4203 in fact be called at the place that would cause a problem.
4205 Some spurious warnings can be avoided if you declare all the functions
4206 you use that never return as @code{noreturn}.  @xref{Function
4207 Attributes}.
4209 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4211 @item -Wunknown-pragmas
4212 @opindex Wunknown-pragmas
4213 @opindex Wno-unknown-pragmas
4214 @cindex warning for unknown pragmas
4215 @cindex unknown pragmas, warning
4216 @cindex pragmas, warning of unknown
4217 Warn when a @code{#pragma} directive is encountered that is not understood by 
4218 GCC@.  If this command-line option is used, warnings are even issued
4219 for unknown pragmas in system header files.  This is not the case if
4220 the warnings are only enabled by the @option{-Wall} command-line option.
4222 @item -Wno-pragmas
4223 @opindex Wno-pragmas
4224 @opindex Wpragmas
4225 Do not warn about misuses of pragmas, such as incorrect parameters,
4226 invalid syntax, or conflicts between pragmas.  See also
4227 @option{-Wunknown-pragmas}.
4229 @item -Wstrict-aliasing
4230 @opindex Wstrict-aliasing
4231 @opindex Wno-strict-aliasing
4232 This option is only active when @option{-fstrict-aliasing} is active.
4233 It warns about code that might break the strict aliasing rules that the
4234 compiler is using for optimization.  The warning does not catch all
4235 cases, but does attempt to catch the more common pitfalls.  It is
4236 included in @option{-Wall}.
4237 It is equivalent to @option{-Wstrict-aliasing=3}
4239 @item -Wstrict-aliasing=n
4240 @opindex Wstrict-aliasing=n
4241 This option is only active when @option{-fstrict-aliasing} is active.
4242 It warns about code that might break the strict aliasing rules that the
4243 compiler is using for optimization.
4244 Higher levels correspond to higher accuracy (fewer false positives).
4245 Higher levels also correspond to more effort, similar to the way @option{-O} 
4246 works.
4247 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4249 Level 1: Most aggressive, quick, least accurate.
4250 Possibly useful when higher levels
4251 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4252 false negatives.  However, it has many false positives.
4253 Warns for all pointer conversions between possibly incompatible types,
4254 even if never dereferenced.  Runs in the front end only.
4256 Level 2: Aggressive, quick, not too precise.
4257 May still have many false positives (not as many as level 1 though),
4258 and few false negatives (but possibly more than level 1).
4259 Unlike level 1, it only warns when an address is taken.  Warns about
4260 incomplete types.  Runs in the front end only.
4262 Level 3 (default for @option{-Wstrict-aliasing}):
4263 Should have very few false positives and few false
4264 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4265 Takes care of the common pun+dereference pattern in the front end:
4266 @code{*(int*)&some_float}.
4267 If optimization is enabled, it also runs in the back end, where it deals
4268 with multiple statement cases using flow-sensitive points-to information.
4269 Only warns when the converted pointer is dereferenced.
4270 Does not warn about incomplete types.
4272 @item -Wstrict-overflow
4273 @itemx -Wstrict-overflow=@var{n}
4274 @opindex Wstrict-overflow
4275 @opindex Wno-strict-overflow
4276 This option is only active when @option{-fstrict-overflow} is active.
4277 It warns about cases where the compiler optimizes based on the
4278 assumption that signed overflow does not occur.  Note that it does not
4279 warn about all cases where the code might overflow: it only warns
4280 about cases where the compiler implements some optimization.  Thus
4281 this warning depends on the optimization level.
4283 An optimization that assumes that signed overflow does not occur is
4284 perfectly safe if the values of the variables involved are such that
4285 overflow never does, in fact, occur.  Therefore this warning can
4286 easily give a false positive: a warning about code that is not
4287 actually a problem.  To help focus on important issues, several
4288 warning levels are defined.  No warnings are issued for the use of
4289 undefined signed overflow when estimating how many iterations a loop
4290 requires, in particular when determining whether a loop will be
4291 executed at all.
4293 @table @gcctabopt
4294 @item -Wstrict-overflow=1
4295 Warn about cases that are both questionable and easy to avoid.  For
4296 example,  with @option{-fstrict-overflow}, the compiler simplifies
4297 @code{x + 1 > x} to @code{1}.  This level of
4298 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4299 are not, and must be explicitly requested.
4301 @item -Wstrict-overflow=2
4302 Also warn about other cases where a comparison is simplified to a
4303 constant.  For example: @code{abs (x) >= 0}.  This can only be
4304 simplified when @option{-fstrict-overflow} is in effect, because
4305 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4306 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4307 @option{-Wstrict-overflow=2}.
4309 @item -Wstrict-overflow=3
4310 Also warn about other cases where a comparison is simplified.  For
4311 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4313 @item -Wstrict-overflow=4
4314 Also warn about other simplifications not covered by the above cases.
4315 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4317 @item -Wstrict-overflow=5
4318 Also warn about cases where the compiler reduces the magnitude of a
4319 constant involved in a comparison.  For example: @code{x + 2 > y} is
4320 simplified to @code{x + 1 >= y}.  This is reported only at the
4321 highest warning level because this simplification applies to many
4322 comparisons, so this warning level gives a very large number of
4323 false positives.
4324 @end table
4326 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4327 @opindex Wsuggest-attribute=
4328 @opindex Wno-suggest-attribute=
4329 Warn for cases where adding an attribute may be beneficial. The
4330 attributes currently supported are listed below.
4332 @table @gcctabopt
4333 @item -Wsuggest-attribute=pure
4334 @itemx -Wsuggest-attribute=const
4335 @itemx -Wsuggest-attribute=noreturn
4336 @opindex Wsuggest-attribute=pure
4337 @opindex Wno-suggest-attribute=pure
4338 @opindex Wsuggest-attribute=const
4339 @opindex Wno-suggest-attribute=const
4340 @opindex Wsuggest-attribute=noreturn
4341 @opindex Wno-suggest-attribute=noreturn
4343 Warn about functions that might be candidates for attributes
4344 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4345 functions visible in other compilation units or (in the case of @code{pure} and
4346 @code{const}) if it cannot prove that the function returns normally. A function
4347 returns normally if it doesn't contain an infinite loop or return abnormally
4348 by throwing, calling @code{abort} or trapping.  This analysis requires option
4349 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4350 higher.  Higher optimization levels improve the accuracy of the analysis.
4352 @item -Wsuggest-attribute=format
4353 @itemx -Wmissing-format-attribute
4354 @opindex Wsuggest-attribute=format
4355 @opindex Wmissing-format-attribute
4356 @opindex Wno-suggest-attribute=format
4357 @opindex Wno-missing-format-attribute
4358 @opindex Wformat
4359 @opindex Wno-format
4361 Warn about function pointers that might be candidates for @code{format}
4362 attributes.  Note these are only possible candidates, not absolute ones.
4363 GCC guesses that function pointers with @code{format} attributes that
4364 are used in assignment, initialization, parameter passing or return
4365 statements should have a corresponding @code{format} attribute in the
4366 resulting type.  I.e.@: the left-hand side of the assignment or
4367 initialization, the type of the parameter variable, or the return type
4368 of the containing function respectively should also have a @code{format}
4369 attribute to avoid the warning.
4371 GCC also warns about function definitions that might be
4372 candidates for @code{format} attributes.  Again, these are only
4373 possible candidates.  GCC guesses that @code{format} attributes
4374 might be appropriate for any function that calls a function like
4375 @code{vprintf} or @code{vscanf}, but this might not always be the
4376 case, and some functions for which @code{format} attributes are
4377 appropriate may not be detected.
4378 @end table
4380 @item -Wsuggest-final-types
4381 @opindex Wno-suggest-final-types
4382 @opindex Wsuggest-final-types
4383 Warn about types with virtual methods where code quality would be improved
4384 if the type were declared with the C++11 @code{final} specifier, 
4385 or, if possible,
4386 declared in an anonymous namespace. This allows GCC to more aggressively
4387 devirtualize the polymorphic calls. This warning is more effective with link
4388 time optimization, where the information about the class hierarchy graph is
4389 more complete.
4391 @item -Wsuggest-final-methods
4392 @opindex Wno-suggest-final-methods
4393 @opindex Wsuggest-final-methods
4394 Warn about virtual methods where code quality would be improved if the method
4395 were declared with the C++11 @code{final} specifier, 
4396 or, if possible, its type were
4397 declared in an anonymous namespace or with the @code{final} specifier.
4398 This warning is
4399 more effective with link time optimization, where the information about the
4400 class hierarchy graph is more complete. It is recommended to first consider
4401 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4402 annotations.
4404 @item -Wsuggest-override
4405 Warn about overriding virtual functions that are not marked with the override
4406 keyword.
4408 @item -Warray-bounds
4409 @itemx -Warray-bounds=@var{n}
4410 @opindex Wno-array-bounds
4411 @opindex Warray-bounds
4412 This option is only active when @option{-ftree-vrp} is active
4413 (default for @option{-O2} and above). It warns about subscripts to arrays
4414 that are always out of bounds. This warning is enabled by @option{-Wall}.
4416 @table @gcctabopt
4417 @item -Warray-bounds=1
4418 This is the warning level of @option{-Warray-bounds} and is enabled
4419 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4421 @item -Warray-bounds=2
4422 This warning level also warns about out of bounds access for
4423 arrays at the end of a struct and for arrays accessed through
4424 pointers. This warning level may give a larger number of
4425 false positives and is deactivated by default.
4426 @end table
4428 @item -Wbool-compare
4429 @opindex Wno-bool-compare
4430 @opindex Wbool-compare
4431 Warn about boolean expression compared with an integer value different from
4432 @code{true}/@code{false}.  For instance, the following comparison is
4433 always false:
4434 @smallexample
4435 int n = 5;
4436 @dots{}
4437 if ((n > 1) == 2) @{ @dots{} @}
4438 @end smallexample
4439 This warning is enabled by @option{-Wall}.
4441 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4442 @opindex Wno-discarded-qualifiers
4443 @opindex Wdiscarded-qualifiers
4444 Do not warn if type qualifiers on pointers are being discarded.
4445 Typically, the compiler warns if a @code{const char *} variable is
4446 passed to a function that takes a @code{char *} parameter.  This option
4447 can be used to suppress such a warning.
4449 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4450 @opindex Wno-discarded-array-qualifiers
4451 @opindex Wdiscarded-array-qualifiers
4452 Do not warn if type qualifiers on arrays which are pointer targets
4453 are being discarded. Typically, the compiler warns if a
4454 @code{const int (*)[]} variable is passed to a function that
4455 takes a @code{int (*)[]} parameter.  This option can be used to
4456 suppress such a warning.
4458 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4459 @opindex Wno-incompatible-pointer-types
4460 @opindex Wincompatible-pointer-types
4461 Do not warn when there is a conversion between pointers that have incompatible
4462 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4463 which warns for pointer argument passing or assignment with different
4464 signedness.
4466 @item -Wno-int-conversion @r{(C and Objective-C only)}
4467 @opindex Wno-int-conversion
4468 @opindex Wint-conversion
4469 Do not warn about incompatible integer to pointer and pointer to integer
4470 conversions.  This warning is about implicit conversions; for explicit
4471 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4472 @option{-Wno-pointer-to-int-cast} may be used.
4474 @item -Wno-div-by-zero
4475 @opindex Wno-div-by-zero
4476 @opindex Wdiv-by-zero
4477 Do not warn about compile-time integer division by zero.  Floating-point
4478 division by zero is not warned about, as it can be a legitimate way of
4479 obtaining infinities and NaNs.
4481 @item -Wsystem-headers
4482 @opindex Wsystem-headers
4483 @opindex Wno-system-headers
4484 @cindex warnings from system headers
4485 @cindex system headers, warnings from
4486 Print warning messages for constructs found in system header files.
4487 Warnings from system headers are normally suppressed, on the assumption
4488 that they usually do not indicate real problems and would only make the
4489 compiler output harder to read.  Using this command-line option tells
4490 GCC to emit warnings from system headers as if they occurred in user
4491 code.  However, note that using @option{-Wall} in conjunction with this
4492 option does @emph{not} warn about unknown pragmas in system
4493 headers---for that, @option{-Wunknown-pragmas} must also be used.
4495 @item -Wtrampolines
4496 @opindex Wtrampolines
4497 @opindex Wno-trampolines
4498 Warn about trampolines generated for pointers to nested functions.
4499 A trampoline is a small piece of data or code that is created at run
4500 time on the stack when the address of a nested function is taken, and is
4501 used to call the nested function indirectly.  For some targets, it is
4502 made up of data only and thus requires no special treatment.  But, for
4503 most targets, it is made up of code and thus requires the stack to be
4504 made executable in order for the program to work properly.
4506 @item -Wfloat-equal
4507 @opindex Wfloat-equal
4508 @opindex Wno-float-equal
4509 Warn if floating-point values are used in equality comparisons.
4511 The idea behind this is that sometimes it is convenient (for the
4512 programmer) to consider floating-point values as approximations to
4513 infinitely precise real numbers.  If you are doing this, then you need
4514 to compute (by analyzing the code, or in some other way) the maximum or
4515 likely maximum error that the computation introduces, and allow for it
4516 when performing comparisons (and when producing output, but that's a
4517 different problem).  In particular, instead of testing for equality, you
4518 should check to see whether the two values have ranges that overlap; and
4519 this is done with the relational operators, so equality comparisons are
4520 probably mistaken.
4522 @item -Wtraditional @r{(C and Objective-C only)}
4523 @opindex Wtraditional
4524 @opindex Wno-traditional
4525 Warn about certain constructs that behave differently in traditional and
4526 ISO C@.  Also warn about ISO C constructs that have no traditional C
4527 equivalent, and/or problematic constructs that should be avoided.
4529 @itemize @bullet
4530 @item
4531 Macro parameters that appear within string literals in the macro body.
4532 In traditional C macro replacement takes place within string literals,
4533 but in ISO C it does not.
4535 @item
4536 In traditional C, some preprocessor directives did not exist.
4537 Traditional preprocessors only considered a line to be a directive
4538 if the @samp{#} appeared in column 1 on the line.  Therefore
4539 @option{-Wtraditional} warns about directives that traditional C
4540 understands but ignores because the @samp{#} does not appear as the
4541 first character on the line.  It also suggests you hide directives like
4542 @code{#pragma} not understood by traditional C by indenting them.  Some
4543 traditional implementations do not recognize @code{#elif}, so this option
4544 suggests avoiding it altogether.
4546 @item
4547 A function-like macro that appears without arguments.
4549 @item
4550 The unary plus operator.
4552 @item
4553 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4554 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4555 constants.)  Note, these suffixes appear in macros defined in the system
4556 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4557 Use of these macros in user code might normally lead to spurious
4558 warnings, however GCC's integrated preprocessor has enough context to
4559 avoid warning in these cases.
4561 @item
4562 A function declared external in one block and then used after the end of
4563 the block.
4565 @item
4566 A @code{switch} statement has an operand of type @code{long}.
4568 @item
4569 A non-@code{static} function declaration follows a @code{static} one.
4570 This construct is not accepted by some traditional C compilers.
4572 @item
4573 The ISO type of an integer constant has a different width or
4574 signedness from its traditional type.  This warning is only issued if
4575 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4576 typically represent bit patterns, are not warned about.
4578 @item
4579 Usage of ISO string concatenation is detected.
4581 @item
4582 Initialization of automatic aggregates.
4584 @item
4585 Identifier conflicts with labels.  Traditional C lacks a separate
4586 namespace for labels.
4588 @item
4589 Initialization of unions.  If the initializer is zero, the warning is
4590 omitted.  This is done under the assumption that the zero initializer in
4591 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4592 initializer warnings and relies on default initialization to zero in the
4593 traditional C case.
4595 @item
4596 Conversions by prototypes between fixed/floating-point values and vice
4597 versa.  The absence of these prototypes when compiling with traditional
4598 C causes serious problems.  This is a subset of the possible
4599 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4601 @item
4602 Use of ISO C style function definitions.  This warning intentionally is
4603 @emph{not} issued for prototype declarations or variadic functions
4604 because these ISO C features appear in your code when using
4605 libiberty's traditional C compatibility macros, @code{PARAMS} and
4606 @code{VPARAMS}.  This warning is also bypassed for nested functions
4607 because that feature is already a GCC extension and thus not relevant to
4608 traditional C compatibility.
4609 @end itemize
4611 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4612 @opindex Wtraditional-conversion
4613 @opindex Wno-traditional-conversion
4614 Warn if a prototype causes a type conversion that is different from what
4615 would happen to the same argument in the absence of a prototype.  This
4616 includes conversions of fixed point to floating and vice versa, and
4617 conversions changing the width or signedness of a fixed-point argument
4618 except when the same as the default promotion.
4620 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4621 @opindex Wdeclaration-after-statement
4622 @opindex Wno-declaration-after-statement
4623 Warn when a declaration is found after a statement in a block.  This
4624 construct, known from C++, was introduced with ISO C99 and is by default
4625 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4627 @item -Wundef
4628 @opindex Wundef
4629 @opindex Wno-undef
4630 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4632 @item -Wno-endif-labels
4633 @opindex Wno-endif-labels
4634 @opindex Wendif-labels
4635 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4637 @item -Wshadow
4638 @opindex Wshadow
4639 @opindex Wno-shadow
4640 Warn whenever a local variable or type declaration shadows another
4641 variable, parameter, type, class member (in C++), or instance variable
4642 (in Objective-C) or whenever a built-in function is shadowed. Note
4643 that in C++, the compiler warns if a local variable shadows an
4644 explicit typedef, but not if it shadows a struct/class/enum.
4646 @item -Wno-shadow-ivar @r{(Objective-C only)}
4647 @opindex Wno-shadow-ivar
4648 @opindex Wshadow-ivar
4649 Do not warn whenever a local variable shadows an instance variable in an
4650 Objective-C method.
4652 @item -Wlarger-than=@var{len}
4653 @opindex Wlarger-than=@var{len}
4654 @opindex Wlarger-than-@var{len}
4655 Warn whenever an object of larger than @var{len} bytes is defined.
4657 @item -Wframe-larger-than=@var{len}
4658 @opindex Wframe-larger-than
4659 Warn if the size of a function frame is larger than @var{len} bytes.
4660 The computation done to determine the stack frame size is approximate
4661 and not conservative.
4662 The actual requirements may be somewhat greater than @var{len}
4663 even if you do not get a warning.  In addition, any space allocated
4664 via @code{alloca}, variable-length arrays, or related constructs
4665 is not included by the compiler when determining
4666 whether or not to issue a warning.
4668 @item -Wno-free-nonheap-object
4669 @opindex Wno-free-nonheap-object
4670 @opindex Wfree-nonheap-object
4671 Do not warn when attempting to free an object that was not allocated
4672 on the heap.
4674 @item -Wstack-usage=@var{len}
4675 @opindex Wstack-usage
4676 Warn if the stack usage of a function might be larger than @var{len} bytes.
4677 The computation done to determine the stack usage is conservative.
4678 Any space allocated via @code{alloca}, variable-length arrays, or related
4679 constructs is included by the compiler when determining whether or not to
4680 issue a warning.
4682 The message is in keeping with the output of @option{-fstack-usage}.
4684 @itemize
4685 @item
4686 If the stack usage is fully static but exceeds the specified amount, it's:
4688 @smallexample
4689   warning: stack usage is 1120 bytes
4690 @end smallexample
4691 @item
4692 If the stack usage is (partly) dynamic but bounded, it's:
4694 @smallexample
4695   warning: stack usage might be 1648 bytes
4696 @end smallexample
4697 @item
4698 If the stack usage is (partly) dynamic and not bounded, it's:
4700 @smallexample
4701   warning: stack usage might be unbounded
4702 @end smallexample
4703 @end itemize
4705 @item -Wunsafe-loop-optimizations
4706 @opindex Wunsafe-loop-optimizations
4707 @opindex Wno-unsafe-loop-optimizations
4708 Warn if the loop cannot be optimized because the compiler cannot
4709 assume anything on the bounds of the loop indices.  With
4710 @option{-funsafe-loop-optimizations} warn if the compiler makes
4711 such assumptions.
4713 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4714 @opindex Wno-pedantic-ms-format
4715 @opindex Wpedantic-ms-format
4716 When used in combination with @option{-Wformat}
4717 and @option{-pedantic} without GNU extensions, this option
4718 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4719 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4720 which depend on the MS runtime.
4722 @item -Wpointer-arith
4723 @opindex Wpointer-arith
4724 @opindex Wno-pointer-arith
4725 Warn about anything that depends on the ``size of'' a function type or
4726 of @code{void}.  GNU C assigns these types a size of 1, for
4727 convenience in calculations with @code{void *} pointers and pointers
4728 to functions.  In C++, warn also when an arithmetic operation involves
4729 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4731 @item -Wtype-limits
4732 @opindex Wtype-limits
4733 @opindex Wno-type-limits
4734 Warn if a comparison is always true or always false due to the limited
4735 range of the data type, but do not warn for constant expressions.  For
4736 example, warn if an unsigned variable is compared against zero with
4737 @code{<} or @code{>=}.  This warning is also enabled by
4738 @option{-Wextra}.
4740 @item -Wbad-function-cast @r{(C and Objective-C only)}
4741 @opindex Wbad-function-cast
4742 @opindex Wno-bad-function-cast
4743 Warn when a function call is cast to a non-matching type.
4744 For example, warn if a call to a function returning an integer type 
4745 is cast to a pointer type.
4747 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4748 @opindex Wc90-c99-compat
4749 @opindex Wno-c90-c99-compat
4750 Warn about features not present in ISO C90, but present in ISO C99.
4751 For instance, warn about use of variable length arrays, @code{long long}
4752 type, @code{bool} type, compound literals, designated initializers, and so
4753 on.  This option is independent of the standards mode.  Warnings are disabled
4754 in the expression that follows @code{__extension__}.
4756 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4757 @opindex Wc99-c11-compat
4758 @opindex Wno-c99-c11-compat
4759 Warn about features not present in ISO C99, but present in ISO C11.
4760 For instance, warn about use of anonymous structures and unions,
4761 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4762 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4763 and so on.  This option is independent of the standards mode.  Warnings are
4764 disabled in the expression that follows @code{__extension__}.
4766 @item -Wc++-compat @r{(C and Objective-C only)}
4767 @opindex Wc++-compat
4768 Warn about ISO C constructs that are outside of the common subset of
4769 ISO C and ISO C++, e.g.@: request for implicit conversion from
4770 @code{void *} to a pointer to non-@code{void} type.
4772 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4773 @opindex Wc++11-compat
4774 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4775 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4776 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4777 enabled by @option{-Wall}.
4779 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4780 @opindex Wc++14-compat
4781 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4782 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4784 @item -Wcast-qual
4785 @opindex Wcast-qual
4786 @opindex Wno-cast-qual
4787 Warn whenever a pointer is cast so as to remove a type qualifier from
4788 the target type.  For example, warn if a @code{const char *} is cast
4789 to an ordinary @code{char *}.
4791 Also warn when making a cast that introduces a type qualifier in an
4792 unsafe way.  For example, casting @code{char **} to @code{const char **}
4793 is unsafe, as in this example:
4795 @smallexample
4796   /* p is char ** value.  */
4797   const char **q = (const char **) p;
4798   /* Assignment of readonly string to const char * is OK.  */
4799   *q = "string";
4800   /* Now char** pointer points to read-only memory.  */
4801   **p = 'b';
4802 @end smallexample
4804 @item -Wcast-align
4805 @opindex Wcast-align
4806 @opindex Wno-cast-align
4807 Warn whenever a pointer is cast such that the required alignment of the
4808 target is increased.  For example, warn if a @code{char *} is cast to
4809 an @code{int *} on machines where integers can only be accessed at
4810 two- or four-byte boundaries.
4812 @item -Wwrite-strings
4813 @opindex Wwrite-strings
4814 @opindex Wno-write-strings
4815 When compiling C, give string constants the type @code{const
4816 char[@var{length}]} so that copying the address of one into a
4817 non-@code{const} @code{char *} pointer produces a warning.  These
4818 warnings help you find at compile time code that can try to write
4819 into a string constant, but only if you have been very careful about
4820 using @code{const} in declarations and prototypes.  Otherwise, it is
4821 just a nuisance. This is why we did not make @option{-Wall} request
4822 these warnings.
4824 When compiling C++, warn about the deprecated conversion from string
4825 literals to @code{char *}.  This warning is enabled by default for C++
4826 programs.
4828 @item -Wclobbered
4829 @opindex Wclobbered
4830 @opindex Wno-clobbered
4831 Warn for variables that might be changed by @code{longjmp} or
4832 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
4834 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4835 @opindex Wconditionally-supported
4836 @opindex Wno-conditionally-supported
4837 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4839 @item -Wconversion
4840 @opindex Wconversion
4841 @opindex Wno-conversion
4842 Warn for implicit conversions that may alter a value. This includes
4843 conversions between real and integer, like @code{abs (x)} when
4844 @code{x} is @code{double}; conversions between signed and unsigned,
4845 like @code{unsigned ui = -1}; and conversions to smaller types, like
4846 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4847 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4848 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4849 conversions between signed and unsigned integers can be disabled by
4850 using @option{-Wno-sign-conversion}.
4852 For C++, also warn for confusing overload resolution for user-defined
4853 conversions; and conversions that never use a type conversion
4854 operator: conversions to @code{void}, the same type, a base class or a
4855 reference to them. Warnings about conversions between signed and
4856 unsigned integers are disabled by default in C++ unless
4857 @option{-Wsign-conversion} is explicitly enabled.
4859 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4860 @opindex Wconversion-null
4861 @opindex Wno-conversion-null
4862 Do not warn for conversions between @code{NULL} and non-pointer
4863 types. @option{-Wconversion-null} is enabled by default.
4865 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4866 @opindex Wzero-as-null-pointer-constant
4867 @opindex Wno-zero-as-null-pointer-constant
4868 Warn when a literal '0' is used as null pointer constant.  This can
4869 be useful to facilitate the conversion to @code{nullptr} in C++11.
4871 @item -Wdate-time
4872 @opindex Wdate-time
4873 @opindex Wno-date-time
4874 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4875 are encountered as they might prevent bit-wise-identical reproducible
4876 compilations.
4878 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4879 @opindex Wdelete-incomplete
4880 @opindex Wno-delete-incomplete
4881 Warn when deleting a pointer to incomplete type, which may cause
4882 undefined behavior at runtime.  This warning is enabled by default.
4884 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4885 @opindex Wuseless-cast
4886 @opindex Wno-useless-cast
4887 Warn when an expression is casted to its own type.
4889 @item -Wempty-body
4890 @opindex Wempty-body
4891 @opindex Wno-empty-body
4892 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
4893 while} statement.  This warning is also enabled by @option{-Wextra}.
4895 @item -Wenum-compare
4896 @opindex Wenum-compare
4897 @opindex Wno-enum-compare
4898 Warn about a comparison between values of different enumerated types.
4899 In C++ enumeral mismatches in conditional expressions are also
4900 diagnosed and the warning is enabled by default.  In C this warning is 
4901 enabled by @option{-Wall}.
4903 @item -Wjump-misses-init @r{(C, Objective-C only)}
4904 @opindex Wjump-misses-init
4905 @opindex Wno-jump-misses-init
4906 Warn if a @code{goto} statement or a @code{switch} statement jumps
4907 forward across the initialization of a variable, or jumps backward to a
4908 label after the variable has been initialized.  This only warns about
4909 variables that are initialized when they are declared.  This warning is
4910 only supported for C and Objective-C; in C++ this sort of branch is an
4911 error in any case.
4913 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4914 can be disabled with the @option{-Wno-jump-misses-init} option.
4916 @item -Wsign-compare
4917 @opindex Wsign-compare
4918 @opindex Wno-sign-compare
4919 @cindex warning for comparison of signed and unsigned values
4920 @cindex comparison of signed and unsigned values, warning
4921 @cindex signed and unsigned values, comparison warning
4922 Warn when a comparison between signed and unsigned values could produce
4923 an incorrect result when the signed value is converted to unsigned.
4924 This warning is also enabled by @option{-Wextra}; to get the other warnings
4925 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4927 @item -Wsign-conversion
4928 @opindex Wsign-conversion
4929 @opindex Wno-sign-conversion
4930 Warn for implicit conversions that may change the sign of an integer
4931 value, like assigning a signed integer expression to an unsigned
4932 integer variable. An explicit cast silences the warning. In C, this
4933 option is enabled also by @option{-Wconversion}.
4935 @item -Wfloat-conversion
4936 @opindex Wfloat-conversion
4937 @opindex Wno-float-conversion
4938 Warn for implicit conversions that reduce the precision of a real value.
4939 This includes conversions from real to integer, and from higher precision
4940 real to lower precision real values.  This option is also enabled by
4941 @option{-Wconversion}.
4943 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4944 @opindex Wsized-deallocation
4945 @opindex Wno-sized-deallocation
4946 Warn about a definition of an unsized deallocation function
4947 @smallexample
4948 void operator delete (void *) noexcept;
4949 void operator delete[] (void *) noexcept;
4950 @end smallexample
4951 without a definition of the corresponding sized deallocation function
4952 @smallexample
4953 void operator delete (void *, std::size_t) noexcept;
4954 void operator delete[] (void *, std::size_t) noexcept;
4955 @end smallexample
4956 or vice versa.  Enabled by @option{-Wextra} along with
4957 @option{-fsized-deallocation}.
4959 @item -Wsizeof-pointer-memaccess
4960 @opindex Wsizeof-pointer-memaccess
4961 @opindex Wno-sizeof-pointer-memaccess
4962 Warn for suspicious length parameters to certain string and memory built-in
4963 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4964 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4965 but a pointer, and suggests a possible fix, or about
4966 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4967 @option{-Wall}.
4969 @item -Wsizeof-array-argument
4970 @opindex Wsizeof-array-argument
4971 @opindex Wno-sizeof-array-argument
4972 Warn when the @code{sizeof} operator is applied to a parameter that is
4973 declared as an array in a function definition.  This warning is enabled by
4974 default for C and C++ programs.
4976 @item -Wmemset-transposed-args
4977 @opindex Wmemset-transposed-args
4978 @opindex Wno-memset-transposed-args
4979 Warn for suspicious calls to the @code{memset} built-in function, if the
4980 second argument is not zero and the third argument is zero.  This warns e.g.@
4981 about @code{memset (buf, sizeof buf, 0)} where most probably
4982 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4983 is only emitted if the third argument is literal zero.  If it is some
4984 expression that is folded to zero, a cast of zero to some type, etc., 
4985 it is far less likely that the user has mistakenly exchanged the arguments 
4986 and no warning is emitted.  This warning is enabled by @option{-Wall}.
4988 @item -Waddress
4989 @opindex Waddress
4990 @opindex Wno-address
4991 Warn about suspicious uses of memory addresses. These include using
4992 the address of a function in a conditional expression, such as
4993 @code{void func(void); if (func)}, and comparisons against the memory
4994 address of a string literal, such as @code{if (x == "abc")}.  Such
4995 uses typically indicate a programmer error: the address of a function
4996 always evaluates to true, so their use in a conditional usually
4997 indicate that the programmer forgot the parentheses in a function
4998 call; and comparisons against string literals result in unspecified
4999 behavior and are not portable in C, so they usually indicate that the
5000 programmer intended to use @code{strcmp}.  This warning is enabled by
5001 @option{-Wall}.
5003 @item -Wlogical-op
5004 @opindex Wlogical-op
5005 @opindex Wno-logical-op
5006 Warn about suspicious uses of logical operators in expressions.
5007 This includes using logical operators in contexts where a
5008 bit-wise operator is likely to be expected.  Also warns when
5009 the operands of a logical operator are the same:
5010 @smallexample
5011 extern int a;
5012 if (a < 0 && a < 0) @{ @dots{} @}
5013 @end smallexample
5015 @item -Wlogical-not-parentheses
5016 @opindex Wlogical-not-parentheses
5017 @opindex Wno-logical-not-parentheses
5018 Warn about logical not used on the left hand side operand of a comparison.
5019 This option does not warn if the RHS operand is of a boolean type.  Its
5020 purpose is to detect suspicious code like the following:
5021 @smallexample
5022 int a;
5023 @dots{}
5024 if (!a > 1) @{ @dots{} @}
5025 @end smallexample
5027 It is possible to suppress the warning by wrapping the LHS into
5028 parentheses:
5029 @smallexample
5030 if ((!a) > 1) @{ @dots{} @}
5031 @end smallexample
5033 This warning is enabled by @option{-Wall}.
5035 @item -Waggregate-return
5036 @opindex Waggregate-return
5037 @opindex Wno-aggregate-return
5038 Warn if any functions that return structures or unions are defined or
5039 called.  (In languages where you can return an array, this also elicits
5040 a warning.)
5042 @item -Wno-aggressive-loop-optimizations
5043 @opindex Wno-aggressive-loop-optimizations
5044 @opindex Waggressive-loop-optimizations
5045 Warn if in a loop with constant number of iterations the compiler detects
5046 undefined behavior in some statement during one or more of the iterations.
5048 @item -Wno-attributes
5049 @opindex Wno-attributes
5050 @opindex Wattributes
5051 Do not warn if an unexpected @code{__attribute__} is used, such as
5052 unrecognized attributes, function attributes applied to variables,
5053 etc.  This does not stop errors for incorrect use of supported
5054 attributes.
5056 @item -Wno-builtin-macro-redefined
5057 @opindex Wno-builtin-macro-redefined
5058 @opindex Wbuiltin-macro-redefined
5059 Do not warn if certain built-in macros are redefined.  This suppresses
5060 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5061 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5063 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5064 @opindex Wstrict-prototypes
5065 @opindex Wno-strict-prototypes
5066 Warn if a function is declared or defined without specifying the
5067 argument types.  (An old-style function definition is permitted without
5068 a warning if preceded by a declaration that specifies the argument
5069 types.)
5071 @item -Wold-style-declaration @r{(C and Objective-C only)}
5072 @opindex Wold-style-declaration
5073 @opindex Wno-old-style-declaration
5074 Warn for obsolescent usages, according to the C Standard, in a
5075 declaration. For example, warn if storage-class specifiers like
5076 @code{static} are not the first things in a declaration.  This warning
5077 is also enabled by @option{-Wextra}.
5079 @item -Wold-style-definition @r{(C and Objective-C only)}
5080 @opindex Wold-style-definition
5081 @opindex Wno-old-style-definition
5082 Warn if an old-style function definition is used.  A warning is given
5083 even if there is a previous prototype.
5085 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5086 @opindex Wmissing-parameter-type
5087 @opindex Wno-missing-parameter-type
5088 A function parameter is declared without a type specifier in K&R-style
5089 functions:
5091 @smallexample
5092 void foo(bar) @{ @}
5093 @end smallexample
5095 This warning is also enabled by @option{-Wextra}.
5097 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5098 @opindex Wmissing-prototypes
5099 @opindex Wno-missing-prototypes
5100 Warn if a global function is defined without a previous prototype
5101 declaration.  This warning is issued even if the definition itself
5102 provides a prototype.  Use this option to detect global functions
5103 that do not have a matching prototype declaration in a header file.
5104 This option is not valid for C++ because all function declarations
5105 provide prototypes and a non-matching declaration declares an
5106 overload rather than conflict with an earlier declaration.
5107 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5109 @item -Wmissing-declarations
5110 @opindex Wmissing-declarations
5111 @opindex Wno-missing-declarations
5112 Warn if a global function is defined without a previous declaration.
5113 Do so even if the definition itself provides a prototype.
5114 Use this option to detect global functions that are not declared in
5115 header files.  In C, no warnings are issued for functions with previous
5116 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5117 missing prototypes.  In C++, no warnings are issued for function templates,
5118 or for inline functions, or for functions in anonymous namespaces.
5120 @item -Wmissing-field-initializers
5121 @opindex Wmissing-field-initializers
5122 @opindex Wno-missing-field-initializers
5123 @opindex W
5124 @opindex Wextra
5125 @opindex Wno-extra
5126 Warn if a structure's initializer has some fields missing.  For
5127 example, the following code causes such a warning, because
5128 @code{x.h} is implicitly zero:
5130 @smallexample
5131 struct s @{ int f, g, h; @};
5132 struct s x = @{ 3, 4 @};
5133 @end smallexample
5135 This option does not warn about designated initializers, so the following
5136 modification does not trigger a warning:
5138 @smallexample
5139 struct s @{ int f, g, h; @};
5140 struct s x = @{ .f = 3, .g = 4 @};
5141 @end smallexample
5143 In C++ this option does not warn either about the empty @{ @}
5144 initializer, for example:
5146 @smallexample
5147 struct s @{ int f, g, h; @};
5148 s x = @{ @};
5149 @end smallexample
5151 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5152 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5154 @item -Wno-multichar
5155 @opindex Wno-multichar
5156 @opindex Wmultichar
5157 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5158 Usually they indicate a typo in the user's code, as they have
5159 implementation-defined values, and should not be used in portable code.
5161 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5162 @opindex Wnormalized=
5163 @opindex Wnormalized
5164 @opindex Wno-normalized
5165 @cindex NFC
5166 @cindex NFKC
5167 @cindex character set, input normalization
5168 In ISO C and ISO C++, two identifiers are different if they are
5169 different sequences of characters.  However, sometimes when characters
5170 outside the basic ASCII character set are used, you can have two
5171 different character sequences that look the same.  To avoid confusion,
5172 the ISO 10646 standard sets out some @dfn{normalization rules} which
5173 when applied ensure that two sequences that look the same are turned into
5174 the same sequence.  GCC can warn you if you are using identifiers that
5175 have not been normalized; this option controls that warning.
5177 There are four levels of warning supported by GCC@.  The default is
5178 @option{-Wnormalized=nfc}, which warns about any identifier that is
5179 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5180 recommended form for most uses.  It is equivalent to
5181 @option{-Wnormalized}.
5183 Unfortunately, there are some characters allowed in identifiers by
5184 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5185 identifiers.  That is, there's no way to use these symbols in portable
5186 ISO C or C++ and have all your identifiers in NFC@.
5187 @option{-Wnormalized=id} suppresses the warning for these characters.
5188 It is hoped that future versions of the standards involved will correct
5189 this, which is why this option is not the default.
5191 You can switch the warning off for all characters by writing
5192 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5193 only do this if you are using some other normalization scheme (like
5194 ``D''), because otherwise you can easily create bugs that are
5195 literally impossible to see.
5197 Some characters in ISO 10646 have distinct meanings but look identical
5198 in some fonts or display methodologies, especially once formatting has
5199 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5200 LETTER N'', displays just like a regular @code{n} that has been
5201 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5202 normalization scheme to convert all these into a standard form as
5203 well, and GCC warns if your code is not in NFKC if you use
5204 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5205 about every identifier that contains the letter O because it might be
5206 confused with the digit 0, and so is not the default, but may be
5207 useful as a local coding convention if the programming environment 
5208 cannot be fixed to display these characters distinctly.
5210 @item -Wno-deprecated
5211 @opindex Wno-deprecated
5212 @opindex Wdeprecated
5213 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5215 @item -Wno-deprecated-declarations
5216 @opindex Wno-deprecated-declarations
5217 @opindex Wdeprecated-declarations
5218 Do not warn about uses of functions (@pxref{Function Attributes}),
5219 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5220 Attributes}) marked as deprecated by using the @code{deprecated}
5221 attribute.
5223 @item -Wno-overflow
5224 @opindex Wno-overflow
5225 @opindex Woverflow
5226 Do not warn about compile-time overflow in constant expressions.
5228 @item -Wno-odr
5229 @opindex Wno-odr
5230 @opindex Wodr
5231 Warn about One Definition Rule violations during link-time optimization.
5232 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5234 @item -Wopenmp-simd
5235 @opindex Wopenm-simd
5236 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5237 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5238 option can be used to relax the cost model.
5240 @item -Woverride-init @r{(C and Objective-C only)}
5241 @opindex Woverride-init
5242 @opindex Wno-override-init
5243 @opindex W
5244 @opindex Wextra
5245 @opindex Wno-extra
5246 Warn if an initialized field without side effects is overridden when
5247 using designated initializers (@pxref{Designated Inits, , Designated
5248 Initializers}).
5250 This warning is included in @option{-Wextra}.  To get other
5251 @option{-Wextra} warnings without this one, use @option{-Wextra
5252 -Wno-override-init}.
5254 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
5255 @opindex Woverride-init-side-effects
5256 @opindex Wno-override-init-side-effects
5257 Warn if an initialized field with side effects is overridden when
5258 using designated initializers (@pxref{Designated Inits, , Designated
5259 Initializers}).  This warning is enabled by default.
5261 @item -Wpacked
5262 @opindex Wpacked
5263 @opindex Wno-packed
5264 Warn if a structure is given the packed attribute, but the packed
5265 attribute has no effect on the layout or size of the structure.
5266 Such structures may be mis-aligned for little benefit.  For
5267 instance, in this code, the variable @code{f.x} in @code{struct bar}
5268 is misaligned even though @code{struct bar} does not itself
5269 have the packed attribute:
5271 @smallexample
5272 @group
5273 struct foo @{
5274   int x;
5275   char a, b, c, d;
5276 @} __attribute__((packed));
5277 struct bar @{
5278   char z;
5279   struct foo f;
5281 @end group
5282 @end smallexample
5284 @item -Wpacked-bitfield-compat
5285 @opindex Wpacked-bitfield-compat
5286 @opindex Wno-packed-bitfield-compat
5287 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5288 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5289 the change can lead to differences in the structure layout.  GCC
5290 informs you when the offset of such a field has changed in GCC 4.4.
5291 For example there is no longer a 4-bit padding between field @code{a}
5292 and @code{b} in this structure:
5294 @smallexample
5295 struct foo
5297   char a:4;
5298   char b:8;
5299 @} __attribute__ ((packed));
5300 @end smallexample
5302 This warning is enabled by default.  Use
5303 @option{-Wno-packed-bitfield-compat} to disable this warning.
5305 @item -Wpadded
5306 @opindex Wpadded
5307 @opindex Wno-padded
5308 Warn if padding is included in a structure, either to align an element
5309 of the structure or to align the whole structure.  Sometimes when this
5310 happens it is possible to rearrange the fields of the structure to
5311 reduce the padding and so make the structure smaller.
5313 @item -Wredundant-decls
5314 @opindex Wredundant-decls
5315 @opindex Wno-redundant-decls
5316 Warn if anything is declared more than once in the same scope, even in
5317 cases where multiple declaration is valid and changes nothing.
5319 @item -Wnested-externs @r{(C and Objective-C only)}
5320 @opindex Wnested-externs
5321 @opindex Wno-nested-externs
5322 Warn if an @code{extern} declaration is encountered within a function.
5324 @item -Wno-inherited-variadic-ctor
5325 @opindex Winherited-variadic-ctor
5326 @opindex Wno-inherited-variadic-ctor
5327 Suppress warnings about use of C++11 inheriting constructors when the
5328 base class inherited from has a C variadic constructor; the warning is
5329 on by default because the ellipsis is not inherited.
5331 @item -Winline
5332 @opindex Winline
5333 @opindex Wno-inline
5334 Warn if a function that is declared as inline cannot be inlined.
5335 Even with this option, the compiler does not warn about failures to
5336 inline functions declared in system headers.
5338 The compiler uses a variety of heuristics to determine whether or not
5339 to inline a function.  For example, the compiler takes into account
5340 the size of the function being inlined and the amount of inlining
5341 that has already been done in the current function.  Therefore,
5342 seemingly insignificant changes in the source program can cause the
5343 warnings produced by @option{-Winline} to appear or disappear.
5345 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5346 @opindex Wno-invalid-offsetof
5347 @opindex Winvalid-offsetof
5348 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5349 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5350 to a non-standard-layout type is undefined.  In existing C++ implementations,
5351 however, @code{offsetof} typically gives meaningful results.
5352 This flag is for users who are aware that they are
5353 writing nonportable code and who have deliberately chosen to ignore the
5354 warning about it.
5356 The restrictions on @code{offsetof} may be relaxed in a future version
5357 of the C++ standard.
5359 @item -Wno-int-to-pointer-cast
5360 @opindex Wno-int-to-pointer-cast
5361 @opindex Wint-to-pointer-cast
5362 Suppress warnings from casts to pointer type of an integer of a
5363 different size. In C++, casting to a pointer type of smaller size is
5364 an error. @option{Wint-to-pointer-cast} is enabled by default.
5367 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5368 @opindex Wno-pointer-to-int-cast
5369 @opindex Wpointer-to-int-cast
5370 Suppress warnings from casts from a pointer to an integer type of a
5371 different size.
5373 @item -Winvalid-pch
5374 @opindex Winvalid-pch
5375 @opindex Wno-invalid-pch
5376 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5377 the search path but can't be used.
5379 @item -Wlong-long
5380 @opindex Wlong-long
5381 @opindex Wno-long-long
5382 Warn if @code{long long} type is used.  This is enabled by either
5383 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5384 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5386 @item -Wvariadic-macros
5387 @opindex Wvariadic-macros
5388 @opindex Wno-variadic-macros
5389 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5390 alternate syntax is used in ISO C99 mode.  This is enabled by either
5391 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5392 messages, use @option{-Wno-variadic-macros}.
5394 @item -Wvarargs
5395 @opindex Wvarargs
5396 @opindex Wno-varargs
5397 Warn upon questionable usage of the macros used to handle variable
5398 arguments like @code{va_start}.  This is default.  To inhibit the
5399 warning messages, use @option{-Wno-varargs}.
5401 @item -Wvector-operation-performance
5402 @opindex Wvector-operation-performance
5403 @opindex Wno-vector-operation-performance
5404 Warn if vector operation is not implemented via SIMD capabilities of the
5405 architecture.  Mainly useful for the performance tuning.
5406 Vector operation can be implemented @code{piecewise}, which means that the
5407 scalar operation is performed on every vector element; 
5408 @code{in parallel}, which means that the vector operation is implemented
5409 using scalars of wider type, which normally is more performance efficient;
5410 and @code{as a single scalar}, which means that vector fits into a
5411 scalar type.
5413 @item -Wno-virtual-move-assign
5414 @opindex Wvirtual-move-assign
5415 @opindex Wno-virtual-move-assign
5416 Suppress warnings about inheriting from a virtual base with a
5417 non-trivial C++11 move assignment operator.  This is dangerous because
5418 if the virtual base is reachable along more than one path, it is
5419 moved multiple times, which can mean both objects end up in the
5420 moved-from state.  If the move assignment operator is written to avoid
5421 moving from a moved-from object, this warning can be disabled.
5423 @item -Wvla
5424 @opindex Wvla
5425 @opindex Wno-vla
5426 Warn if variable length array is used in the code.
5427 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5428 the variable length array.
5430 @item -Wvolatile-register-var
5431 @opindex Wvolatile-register-var
5432 @opindex Wno-volatile-register-var
5433 Warn if a register variable is declared volatile.  The volatile
5434 modifier does not inhibit all optimizations that may eliminate reads
5435 and/or writes to register variables.  This warning is enabled by
5436 @option{-Wall}.
5438 @item -Wdisabled-optimization
5439 @opindex Wdisabled-optimization
5440 @opindex Wno-disabled-optimization
5441 Warn if a requested optimization pass is disabled.  This warning does
5442 not generally indicate that there is anything wrong with your code; it
5443 merely indicates that GCC's optimizers are unable to handle the code
5444 effectively.  Often, the problem is that your code is too big or too
5445 complex; GCC refuses to optimize programs when the optimization
5446 itself is likely to take inordinate amounts of time.
5448 @item -Wpointer-sign @r{(C and Objective-C only)}
5449 @opindex Wpointer-sign
5450 @opindex Wno-pointer-sign
5451 Warn for pointer argument passing or assignment with different signedness.
5452 This option is only supported for C and Objective-C@.  It is implied by
5453 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5454 @option{-Wno-pointer-sign}.
5456 @item -Wstack-protector
5457 @opindex Wstack-protector
5458 @opindex Wno-stack-protector
5459 This option is only active when @option{-fstack-protector} is active.  It
5460 warns about functions that are not protected against stack smashing.
5462 @item -Woverlength-strings
5463 @opindex Woverlength-strings
5464 @opindex Wno-overlength-strings
5465 Warn about string constants that are longer than the ``minimum
5466 maximum'' length specified in the C standard.  Modern compilers
5467 generally allow string constants that are much longer than the
5468 standard's minimum limit, but very portable programs should avoid
5469 using longer strings.
5471 The limit applies @emph{after} string constant concatenation, and does
5472 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5473 C99, it was raised to 4095.  C++98 does not specify a normative
5474 minimum maximum, so we do not diagnose overlength strings in C++@.
5476 This option is implied by @option{-Wpedantic}, and can be disabled with
5477 @option{-Wno-overlength-strings}.
5479 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5480 @opindex Wunsuffixed-float-constants
5482 Issue a warning for any floating constant that does not have
5483 a suffix.  When used together with @option{-Wsystem-headers} it
5484 warns about such constants in system header files.  This can be useful
5485 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5486 from the decimal floating-point extension to C99.
5488 @item -Wno-designated-init @r{(C and Objective-C only)}
5489 Suppress warnings when a positional initializer is used to initialize
5490 a structure that has been marked with the @code{designated_init}
5491 attribute.
5493 @end table
5495 @node Debugging Options
5496 @section Options for Debugging Your Program or GCC
5497 @cindex options, debugging
5498 @cindex debugging information options
5500 GCC has various special options that are used for debugging
5501 either your program or GCC:
5503 @table @gcctabopt
5504 @item -g
5505 @opindex g
5506 Produce debugging information in the operating system's native format
5507 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5508 information.
5510 On most systems that use stabs format, @option{-g} enables use of extra
5511 debugging information that only GDB can use; this extra information
5512 makes debugging work better in GDB but probably makes other debuggers
5513 crash or
5514 refuse to read the program.  If you want to control for certain whether
5515 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5516 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5518 GCC allows you to use @option{-g} with
5519 @option{-O}.  The shortcuts taken by optimized code may occasionally
5520 produce surprising results: some variables you declared may not exist
5521 at all; flow of control may briefly move where you did not expect it;
5522 some statements may not be executed because they compute constant
5523 results or their values are already at hand; some statements may
5524 execute in different places because they have been moved out of loops.
5526 Nevertheless it proves possible to debug optimized output.  This makes
5527 it reasonable to use the optimizer for programs that might have bugs.
5529 The following options are useful when GCC is generated with the
5530 capability for more than one debugging format.
5532 @item -gsplit-dwarf
5533 @opindex gsplit-dwarf
5534 Separate as much dwarf debugging information as possible into a
5535 separate output file with the extension .dwo.  This option allows
5536 the build system to avoid linking files with debug information.  To
5537 be useful, this option requires a debugger capable of reading .dwo
5538 files.
5540 @item -ggdb
5541 @opindex ggdb
5542 Produce debugging information for use by GDB@.  This means to use the
5543 most expressive format available (DWARF 2, stabs, or the native format
5544 if neither of those are supported), including GDB extensions if at all
5545 possible.
5547 @item -gpubnames
5548 @opindex gpubnames
5549 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5551 @item -ggnu-pubnames
5552 @opindex ggnu-pubnames
5553 Generate .debug_pubnames and .debug_pubtypes sections in a format
5554 suitable for conversion into a GDB@ index.  This option is only useful
5555 with a linker that can produce GDB@ index version 7.
5557 @item -gstabs
5558 @opindex gstabs
5559 Produce debugging information in stabs format (if that is supported),
5560 without GDB extensions.  This is the format used by DBX on most BSD
5561 systems.  On MIPS, Alpha and System V Release 4 systems this option
5562 produces stabs debugging output that is not understood by DBX or SDB@.
5563 On System V Release 4 systems this option requires the GNU assembler.
5565 @item -feliminate-unused-debug-symbols
5566 @opindex feliminate-unused-debug-symbols
5567 Produce debugging information in stabs format (if that is supported),
5568 for only symbols that are actually used.
5570 @item -femit-class-debug-always
5571 @opindex femit-class-debug-always
5572 Instead of emitting debugging information for a C++ class in only one
5573 object file, emit it in all object files using the class.  This option
5574 should be used only with debuggers that are unable to handle the way GCC
5575 normally emits debugging information for classes because using this
5576 option increases the size of debugging information by as much as a
5577 factor of two.
5579 @item -fdebug-types-section
5580 @opindex fdebug-types-section
5581 @opindex fno-debug-types-section
5582 When using DWARF Version 4 or higher, type DIEs can be put into
5583 their own @code{.debug_types} section instead of making them part of the
5584 @code{.debug_info} section.  It is more efficient to put them in a separate
5585 comdat sections since the linker can then remove duplicates.
5586 But not all DWARF consumers support @code{.debug_types} sections yet
5587 and on some objects @code{.debug_types} produces larger instead of smaller
5588 debugging information.
5590 @item -gstabs+
5591 @opindex gstabs+
5592 Produce debugging information in stabs format (if that is supported),
5593 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5594 use of these extensions is likely to make other debuggers crash or
5595 refuse to read the program.
5597 @item -gcoff
5598 @opindex gcoff
5599 Produce debugging information in COFF format (if that is supported).
5600 This is the format used by SDB on most System V systems prior to
5601 System V Release 4.
5603 @item -gxcoff
5604 @opindex gxcoff
5605 Produce debugging information in XCOFF format (if that is supported).
5606 This is the format used by the DBX debugger on IBM RS/6000 systems.
5608 @item -gxcoff+
5609 @opindex gxcoff+
5610 Produce debugging information in XCOFF format (if that is supported),
5611 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5612 use of these extensions is likely to make other debuggers crash or
5613 refuse to read the program, and may cause assemblers other than the GNU
5614 assembler (GAS) to fail with an error.
5616 @item -gdwarf-@var{version}
5617 @opindex gdwarf-@var{version}
5618 Produce debugging information in DWARF format (if that is supported).
5619 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5620 for most targets is 4.  DWARF Version 5 is only experimental.
5622 Note that with DWARF Version 2, some ports require and always
5623 use some non-conflicting DWARF 3 extensions in the unwind tables.
5625 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5626 for maximum benefit.
5628 @item -grecord-gcc-switches
5629 @opindex grecord-gcc-switches
5630 This switch causes the command-line options used to invoke the
5631 compiler that may affect code generation to be appended to the
5632 DW_AT_producer attribute in DWARF debugging information.  The options
5633 are concatenated with spaces separating them from each other and from
5634 the compiler version.  See also @option{-frecord-gcc-switches} for another
5635 way of storing compiler options into the object file.  This is the default.
5637 @item -gno-record-gcc-switches
5638 @opindex gno-record-gcc-switches
5639 Disallow appending command-line options to the DW_AT_producer attribute
5640 in DWARF debugging information.
5642 @item -gstrict-dwarf
5643 @opindex gstrict-dwarf
5644 Disallow using extensions of later DWARF standard version than selected
5645 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5646 DWARF extensions from later standard versions is allowed.
5648 @item -gno-strict-dwarf
5649 @opindex gno-strict-dwarf
5650 Allow using extensions of later DWARF standard version than selected with
5651 @option{-gdwarf-@var{version}}.
5653 @item -gz@r{[}=@var{type}@r{]}
5654 @opindex gz
5655 Produce compressed debug sections in DWARF format, if that is supported.
5656 If @var{type} is not given, the default type depends on the capabilities
5657 of the assembler and linker used.  @var{type} may be one of
5658 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
5659 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
5660 compression in traditional GNU format).  If the linker doesn't support
5661 writing compressed debug sections, the option is rejected.  Otherwise,
5662 if the assembler does not support them, @option{-gz} is silently ignored
5663 when producing object files.
5665 @item -gvms
5666 @opindex gvms
5667 Produce debugging information in Alpha/VMS debug format (if that is
5668 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5670 @item -g@var{level}
5671 @itemx -ggdb@var{level}
5672 @itemx -gstabs@var{level}
5673 @itemx -gcoff@var{level}
5674 @itemx -gxcoff@var{level}
5675 @itemx -gvms@var{level}
5676 Request debugging information and also use @var{level} to specify how
5677 much information.  The default level is 2.
5679 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5680 @option{-g}.
5682 Level 1 produces minimal information, enough for making backtraces in
5683 parts of the program that you don't plan to debug.  This includes
5684 descriptions of functions and external variables, and line number
5685 tables, but no information about local variables.
5687 Level 3 includes extra information, such as all the macro definitions
5688 present in the program.  Some debuggers support macro expansion when
5689 you use @option{-g3}.
5691 @option{-gdwarf-2} does not accept a concatenated debug level, because
5692 GCC used to support an option @option{-gdwarf} that meant to generate
5693 debug information in version 1 of the DWARF format (which is very
5694 different from version 2), and it would have been too confusing.  That
5695 debug format is long obsolete, but the option cannot be changed now.
5696 Instead use an additional @option{-g@var{level}} option to change the
5697 debug level for DWARF.
5699 @item -gtoggle
5700 @opindex gtoggle
5701 Turn off generation of debug info, if leaving out this option
5702 generates it, or turn it on at level 2 otherwise.  The position of this
5703 argument in the command line does not matter; it takes effect after all
5704 other options are processed, and it does so only once, no matter how
5705 many times it is given.  This is mainly intended to be used with
5706 @option{-fcompare-debug}.
5708 @item -fsanitize=address
5709 @opindex fsanitize=address
5710 Enable AddressSanitizer, a fast memory error detector.
5711 Memory access instructions are instrumented to detect
5712 out-of-bounds and use-after-free bugs.
5713 See @uref{http://code.google.com/p/address-sanitizer/} for
5714 more details.  The run-time behavior can be influenced using the
5715 @env{ASAN_OPTIONS} environment variable; see
5716 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5717 a list of supported options.
5719 @item -fsanitize=kernel-address
5720 @opindex fsanitize=kernel-address
5721 Enable AddressSanitizer for Linux kernel.
5722 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5724 @item -fsanitize=thread
5725 @opindex fsanitize=thread
5726 Enable ThreadSanitizer, a fast data race detector.
5727 Memory access instructions are instrumented to detect
5728 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5729 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5730 environment variable; see
5731 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5732 supported options.
5734 @item -fsanitize=leak
5735 @opindex fsanitize=leak
5736 Enable LeakSanitizer, a memory leak detector.
5737 This option only matters for linking of executables and if neither
5738 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5739 case the executable is linked against a library that overrides @code{malloc}
5740 and other allocator functions.  See
5741 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5742 details.  The run-time behavior can be influenced using the
5743 @env{LSAN_OPTIONS} environment variable.
5745 @item -fsanitize=undefined
5746 @opindex fsanitize=undefined
5747 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5748 Various computations are instrumented to detect undefined behavior
5749 at runtime.  Current suboptions are:
5751 @table @gcctabopt
5753 @item -fsanitize=shift
5754 @opindex fsanitize=shift
5755 This option enables checking that the result of a shift operation is
5756 not undefined.  Note that what exactly is considered undefined differs
5757 slightly between C and C++, as well as between ISO C90 and C99, etc.
5759 @item -fsanitize=integer-divide-by-zero
5760 @opindex fsanitize=integer-divide-by-zero
5761 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5763 @item -fsanitize=unreachable
5764 @opindex fsanitize=unreachable
5765 With this option, the compiler turns the @code{__builtin_unreachable}
5766 call into a diagnostics message call instead.  When reaching the
5767 @code{__builtin_unreachable} call, the behavior is undefined.
5769 @item -fsanitize=vla-bound
5770 @opindex fsanitize=vla-bound
5771 This option instructs the compiler to check that the size of a variable
5772 length array is positive.
5774 @item -fsanitize=null
5775 @opindex fsanitize=null
5776 This option enables pointer checking.  Particularly, the application
5777 built with this option turned on will issue an error message when it
5778 tries to dereference a NULL pointer, or if a reference (possibly an
5779 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5780 on an object pointed by a NULL pointer.
5782 @item -fsanitize=return
5783 @opindex fsanitize=return
5784 This option enables return statement checking.  Programs
5785 built with this option turned on will issue an error message
5786 when the end of a non-void function is reached without actually
5787 returning a value.  This option works in C++ only.
5789 @item -fsanitize=signed-integer-overflow
5790 @opindex fsanitize=signed-integer-overflow
5791 This option enables signed integer overflow checking.  We check that
5792 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5793 does not overflow in the signed arithmetics.  Note, integer promotion
5794 rules must be taken into account.  That is, the following is not an
5795 overflow:
5796 @smallexample
5797 signed char a = SCHAR_MAX;
5798 a++;
5799 @end smallexample
5801 @item -fsanitize=bounds
5802 @opindex fsanitize=bounds
5803 This option enables instrumentation of array bounds.  Various out of bounds
5804 accesses are detected.  Flexible array members, flexible array member-like
5805 arrays, and initializers of variables with static storage are not instrumented.
5807 @item -fsanitize=bounds-strict
5808 @opindex fsanitize=bounds-strict
5809 This option enables strict instrumentation of array bounds.  Most out of bounds
5810 accesses are detected, including flexible array members and flexible array
5811 member-like arrays.  Initializers of variables with static storage are not
5812 instrumented.
5814 @item -fsanitize=alignment
5815 @opindex fsanitize=alignment
5817 This option enables checking of alignment of pointers when they are
5818 dereferenced, or when a reference is bound to insufficiently aligned target,
5819 or when a method or constructor is invoked on insufficiently aligned object.
5821 @item -fsanitize=object-size
5822 @opindex fsanitize=object-size
5823 This option enables instrumentation of memory references using the
5824 @code{__builtin_object_size} function.  Various out of bounds pointer
5825 accesses are detected.
5827 @item -fsanitize=float-divide-by-zero
5828 @opindex fsanitize=float-divide-by-zero
5829 Detect floating-point division by zero.  Unlike other similar options,
5830 @option{-fsanitize=float-divide-by-zero} is not enabled by
5831 @option{-fsanitize=undefined}, since floating-point division by zero can
5832 be a legitimate way of obtaining infinities and NaNs.
5834 @item -fsanitize=float-cast-overflow
5835 @opindex fsanitize=float-cast-overflow
5836 This option enables floating-point type to integer conversion checking.
5837 We check that the result of the conversion does not overflow.
5838 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
5839 not enabled by @option{-fsanitize=undefined}.
5840 This option does not work well with @code{FE_INVALID} exceptions enabled.
5842 @item -fsanitize=nonnull-attribute
5843 @opindex fsanitize=nonnull-attribute
5845 This option enables instrumentation of calls, checking whether null values
5846 are not passed to arguments marked as requiring a non-null value by the
5847 @code{nonnull} function attribute.
5849 @item -fsanitize=returns-nonnull-attribute
5850 @opindex fsanitize=returns-nonnull-attribute
5852 This option enables instrumentation of return statements in functions
5853 marked with @code{returns_nonnull} function attribute, to detect returning
5854 of null values from such functions.
5856 @item -fsanitize=bool
5857 @opindex fsanitize=bool
5859 This option enables instrumentation of loads from bool.  If a value other
5860 than 0/1 is loaded, a run-time error is issued.
5862 @item -fsanitize=enum
5863 @opindex fsanitize=enum
5865 This option enables instrumentation of loads from an enum type.  If
5866 a value outside the range of values for the enum type is loaded,
5867 a run-time error is issued.
5869 @item -fsanitize=vptr
5870 @opindex fsanitize=vptr
5872 This option enables instrumentation of C++ member function calls, member
5873 accesses and some conversions between pointers to base and derived classes,
5874 to verify the referenced object has the correct dynamic type.
5876 @end table
5878 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5879 @option{-fsanitize=undefined} gives a diagnostic message.
5880 This currently works only for the C family of languages.
5882 @item -fno-sanitize=all
5883 @opindex fno-sanitize=all
5885 This option disables all previously enabled sanitizers.
5886 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
5887 together.
5889 @item -fasan-shadow-offset=@var{number}
5890 @opindex fasan-shadow-offset
5891 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5892 It is useful for experimenting with different shadow memory layouts in
5893 Kernel AddressSanitizer.
5895 @item -fsanitize-sections=@var{s1},@var{s2},...
5896 @opindex fsanitize-sections
5897 Sanitize global variables in selected user-defined sections.  @var{si} may
5898 contain wildcards.
5900 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5901 @opindex fsanitize-recover
5902 @opindex fno-sanitize-recover
5903 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5904 mentioned in comma-separated list of @var{opts}.  Enabling this option
5905 for a sanitizer component causes it to attempt to continue
5906 running the program as if no error happened.  This means multiple
5907 runtime errors can be reported in a single program run, and the exit
5908 code of the program may indicate success even when errors
5909 have been reported.  The @option{-fno-sanitize-recover=} option
5910 can be used to alter
5911 this behavior: only the first detected error is reported
5912 and program then exits with a non-zero exit code.
5914 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5915 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5916 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5917 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5918 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
5919 accepted, the former enables recovery for all sanitizers that support it,
5920 the latter disables recovery for all sanitizers that support it.
5922 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5923 @smallexample
5924 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5925 @end smallexample
5926 @noindent
5927 Similarly @option{-fno-sanitize-recover} is equivalent to
5928 @smallexample
5929 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5930 @end smallexample
5932 @item -fsanitize-undefined-trap-on-error
5933 @opindex fsanitize-undefined-trap-on-error
5934 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
5935 report undefined behavior using @code{__builtin_trap} rather than
5936 a @code{libubsan} library routine.  The advantage of this is that the
5937 @code{libubsan} library is not needed and is not linked in, so this
5938 is usable even in freestanding environments.
5940 @item -fcheck-pointer-bounds
5941 @opindex fcheck-pointer-bounds
5942 @opindex fno-check-pointer-bounds
5943 @cindex Pointer Bounds Checker options
5944 Enable Pointer Bounds Checker instrumentation.  Each memory reference
5945 is instrumented with checks of the pointer used for memory access against
5946 bounds associated with that pointer.  
5948 Currently there
5949 is only an implementation for Intel MPX available, thus x86 target
5950 and @option{-mmpx} are required to enable this feature.  
5951 MPX-based instrumentation requires
5952 a runtime library to enable MPX in hardware and handle bounds
5953 violation signals.  By default when @option{-fcheck-pointer-bounds}
5954 and @option{-mmpx} options are used to link a program, the GCC driver
5955 links against the @file{libmpx} runtime library and @file{libmpxwrappers}
5956 library.  It also passes '-z bndplt' to a linker in case it supports this
5957 option (which is checked on libmpx configuration).  Note that old versions
5958 of linker may ignore option.  Gold linker doesn't support '-z bndplt'
5959 option.  With no '-z bndplt' support in linker all calls to dynamic libraries
5960 lose passed bounds reducing overall protection level.  It's highly
5961 recommended to use linker with '-z bndplt' support.  In case such linker
5962 is not available it is adviced to always use @option{-static-libmpxwrappers}
5963 for better protection level or use @option{-static} to completely avoid
5964 external calls to dynamic libraries.  MPX-based instrumentation
5965 may be used for debugging and also may be included in production code
5966 to increase program security.  Depending on usage, you may
5967 have different requirements for the runtime library.  The current version
5968 of the MPX runtime library is more oriented for use as a debugging
5969 tool.  MPX runtime library usage implies @option{-lpthread}.  See
5970 also @option{-static-libmpx}.  The runtime library  behavior can be
5971 influenced using various @env{CHKP_RT_*} environment variables.  See
5972 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
5973 for more details.
5975 Generated instrumentation may be controlled by various
5976 @option{-fchkp-*} options and by the @code{bnd_variable_size}
5977 structure field attribute (@pxref{Type Attributes}) and
5978 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
5979 (@pxref{Function Attributes}).  GCC also provides a number of built-in
5980 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
5981 Bounds Checker builtins}, for more information.
5983 @item -fchkp-check-incomplete-type
5984 @opindex fchkp-check-incomplete-type
5985 @opindex fno-chkp-check-incomplete-type
5986 Generate pointer bounds checks for variables with incomplete type.
5987 Enabled by default.
5989 @item -fchkp-narrow-bounds
5990 @opindex fchkp-narrow-bounds
5991 @opindex fno-chkp-narrow-bounds
5992 Controls bounds used by Pointer Bounds Checker for pointers to object
5993 fields.  If narrowing is enabled then field bounds are used.  Otherwise
5994 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
5995 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
5997 @item -fchkp-first-field-has-own-bounds
5998 @opindex fchkp-first-field-has-own-bounds
5999 @opindex fno-chkp-first-field-has-own-bounds
6000 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
6001 first field in the structure.  By default a pointer to the first field has
6002 the same bounds as a pointer to the whole structure.
6004 @item -fchkp-narrow-to-innermost-array
6005 @opindex fchkp-narrow-to-innermost-array
6006 @opindex fno-chkp-narrow-to-innermost-array
6007 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
6008 case of nested static array access.  By default this option is disabled and
6009 bounds of the outermost array are used.
6011 @item -fchkp-optimize
6012 @opindex fchkp-optimize
6013 @opindex fno-chkp-optimize
6014 Enables Pointer Bounds Checker optimizations.  Enabled by default at
6015 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
6017 @item -fchkp-use-fast-string-functions
6018 @opindex fchkp-use-fast-string-functions
6019 @opindex fno-chkp-use-fast-string-functions
6020 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
6021 by Pointer Bounds Checker.  Disabled by default.
6023 @item -fchkp-use-nochk-string-functions
6024 @opindex fchkp-use-nochk-string-functions
6025 @opindex fno-chkp-use-nochk-string-functions
6026 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
6027 by Pointer Bounds Checker.  Disabled by default.
6029 @item -fchkp-use-static-bounds
6030 @opindex fchkp-use-static-bounds
6031 @opindex fno-chkp-use-static-bounds
6032 Allow Pointer Bounds Checker to generate static bounds holding
6033 bounds of static variables.  Enabled by default.
6035 @item -fchkp-use-static-const-bounds
6036 @opindex fchkp-use-static-const-bounds
6037 @opindex fno-chkp-use-static-const-bounds
6038 Use statically-initialized bounds for constant bounds instead of
6039 generating them each time they are required.  By default enabled when
6040 @option{-fchkp-use-static-bounds} is enabled.
6042 @item -fchkp-treat-zero-dynamic-size-as-infinite
6043 @opindex fchkp-treat-zero-dynamic-size-as-infinite
6044 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
6045 With this option, objects with incomplete type whose
6046 dynamically-obtained size is zero are treated as having infinite size
6047 instead by Pointer Bounds
6048 Checker.  This option may be helpful if a program is linked with a library
6049 missing size information for some symbols.  Disabled by default.
6051 @item -fchkp-check-read
6052 @opindex fchkp-check-read
6053 @opindex fno-chkp-check-read
6054 Instructs Pointer Bounds Checker to generate checks for all read
6055 accesses to memory.  Enabled by default.
6057 @item -fchkp-check-write
6058 @opindex fchkp-check-write
6059 @opindex fno-chkp-check-write
6060 Instructs Pointer Bounds Checker to generate checks for all write
6061 accesses to memory.  Enabled by default.
6063 @item -fchkp-store-bounds
6064 @opindex fchkp-store-bounds
6065 @opindex fno-chkp-store-bounds
6066 Instructs Pointer Bounds Checker to generate bounds stores for
6067 pointer writes.  Enabled by default.
6069 @item -fchkp-instrument-calls
6070 @opindex fchkp-instrument-calls
6071 @opindex fno-chkp-instrument-calls
6072 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
6073 Enabled by default.
6075 @item -fchkp-instrument-marked-only
6076 @opindex fchkp-instrument-marked-only
6077 @opindex fno-chkp-instrument-marked-only
6078 Instructs Pointer Bounds Checker to instrument only functions
6079 marked with the @code{bnd_instrument} attribute
6080 (@pxref{Function Attributes}).  Disabled by default.
6082 @item -fchkp-use-wrappers
6083 @opindex fchkp-use-wrappers
6084 @opindex fno-chkp-use-wrappers
6085 Allows Pointer Bounds Checker to replace calls to built-in functions
6086 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
6087 is used to link a program, the GCC driver automatically links
6088 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
6089 Enabled by default.
6091 @item -fdump-final-insns@r{[}=@var{file}@r{]}
6092 @opindex fdump-final-insns
6093 Dump the final internal representation (RTL) to @var{file}.  If the
6094 optional argument is omitted (or if @var{file} is @code{.}), the name
6095 of the dump file is determined by appending @code{.gkd} to the
6096 compilation output file name.
6098 @item -fcompare-debug@r{[}=@var{opts}@r{]}
6099 @opindex fcompare-debug
6100 @opindex fno-compare-debug
6101 If no error occurs during compilation, run the compiler a second time,
6102 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
6103 passed to the second compilation.  Dump the final internal
6104 representation in both compilations, and print an error if they differ.
6106 If the equal sign is omitted, the default @option{-gtoggle} is used.
6108 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
6109 and nonzero, implicitly enables @option{-fcompare-debug}.  If
6110 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
6111 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
6112 is used.
6114 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
6115 is equivalent to @option{-fno-compare-debug}, which disables the dumping
6116 of the final representation and the second compilation, preventing even
6117 @env{GCC_COMPARE_DEBUG} from taking effect.
6119 To verify full coverage during @option{-fcompare-debug} testing, set
6120 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
6121 which GCC rejects as an invalid option in any actual compilation
6122 (rather than preprocessing, assembly or linking).  To get just a
6123 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
6124 not overridden} will do.
6126 @item -fcompare-debug-second
6127 @opindex fcompare-debug-second
6128 This option is implicitly passed to the compiler for the second
6129 compilation requested by @option{-fcompare-debug}, along with options to
6130 silence warnings, and omitting other options that would cause
6131 side-effect compiler outputs to files or to the standard output.  Dump
6132 files and preserved temporary files are renamed so as to contain the
6133 @code{.gk} additional extension during the second compilation, to avoid
6134 overwriting those generated by the first.
6136 When this option is passed to the compiler driver, it causes the
6137 @emph{first} compilation to be skipped, which makes it useful for little
6138 other than debugging the compiler proper.
6140 @item -feliminate-dwarf2-dups
6141 @opindex feliminate-dwarf2-dups
6142 Compress DWARF 2 debugging information by eliminating duplicated
6143 information about each symbol.  This option only makes sense when
6144 generating DWARF 2 debugging information with @option{-gdwarf-2}.
6146 @item -femit-struct-debug-baseonly
6147 @opindex femit-struct-debug-baseonly
6148 Emit debug information for struct-like types
6149 only when the base name of the compilation source file
6150 matches the base name of file in which the struct is defined.
6152 This option substantially reduces the size of debugging information,
6153 but at significant potential loss in type information to the debugger.
6154 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6155 See @option{-femit-struct-debug-detailed} for more detailed control.
6157 This option works only with DWARF 2.
6159 @item -femit-struct-debug-reduced
6160 @opindex femit-struct-debug-reduced
6161 Emit debug information for struct-like types
6162 only when the base name of the compilation source file
6163 matches the base name of file in which the type is defined,
6164 unless the struct is a template or defined in a system header.
6166 This option significantly reduces the size of debugging information,
6167 with some potential loss in type information to the debugger.
6168 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6169 See @option{-femit-struct-debug-detailed} for more detailed control.
6171 This option works only with DWARF 2.
6173 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6174 @opindex femit-struct-debug-detailed
6175 Specify the struct-like types
6176 for which the compiler generates debug information.
6177 The intent is to reduce duplicate struct debug information
6178 between different object files within the same program.
6180 This option is a detailed version of
6181 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6182 which serves for most needs.
6184 A specification has the syntax@*
6185 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6187 The optional first word limits the specification to
6188 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6189 A struct type is used directly when it is the type of a variable, member.
6190 Indirect uses arise through pointers to structs.
6191 That is, when use of an incomplete struct is valid, the use is indirect.
6192 An example is
6193 @samp{struct one direct; struct two * indirect;}.
6195 The optional second word limits the specification to
6196 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6197 Generic structs are a bit complicated to explain.
6198 For C++, these are non-explicit specializations of template classes,
6199 or non-template classes within the above.
6200 Other programming languages have generics,
6201 but @option{-femit-struct-debug-detailed} does not yet implement them.
6203 The third word specifies the source files for those
6204 structs for which the compiler should emit debug information.
6205 The values @samp{none} and @samp{any} have the normal meaning.
6206 The value @samp{base} means that
6207 the base of name of the file in which the type declaration appears
6208 must match the base of the name of the main compilation file.
6209 In practice, this means that when compiling @file{foo.c}, debug information
6210 is generated for types declared in that file and @file{foo.h},
6211 but not other header files.
6212 The value @samp{sys} means those types satisfying @samp{base}
6213 or declared in system or compiler headers.
6215 You may need to experiment to determine the best settings for your application.
6217 The default is @option{-femit-struct-debug-detailed=all}.
6219 This option works only with DWARF 2.
6221 @item -fno-merge-debug-strings
6222 @opindex fmerge-debug-strings
6223 @opindex fno-merge-debug-strings
6224 Direct the linker to not merge together strings in the debugging
6225 information that are identical in different object files.  Merging is
6226 not supported by all assemblers or linkers.  Merging decreases the size
6227 of the debug information in the output file at the cost of increasing
6228 link processing time.  Merging is enabled by default.
6230 @item -fdebug-prefix-map=@var{old}=@var{new}
6231 @opindex fdebug-prefix-map
6232 When compiling files in directory @file{@var{old}}, record debugging
6233 information describing them as in @file{@var{new}} instead.
6235 @item -fno-dwarf2-cfi-asm
6236 @opindex fdwarf2-cfi-asm
6237 @opindex fno-dwarf2-cfi-asm
6238 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
6239 instead of using GAS @code{.cfi_*} directives.
6241 @cindex @command{prof}
6242 @item -p
6243 @opindex p
6244 Generate extra code to write profile information suitable for the
6245 analysis program @command{prof}.  You must use this option when compiling
6246 the source files you want data about, and you must also use it when
6247 linking.
6249 @cindex @command{gprof}
6250 @item -pg
6251 @opindex pg
6252 Generate extra code to write profile information suitable for the
6253 analysis program @command{gprof}.  You must use this option when compiling
6254 the source files you want data about, and you must also use it when
6255 linking.
6257 @item -Q
6258 @opindex Q
6259 Makes the compiler print out each function name as it is compiled, and
6260 print some statistics about each pass when it finishes.
6262 @item -ftime-report
6263 @opindex ftime-report
6264 Makes the compiler print some statistics about the time consumed by each
6265 pass when it finishes.
6267 @item -fmem-report
6268 @opindex fmem-report
6269 Makes the compiler print some statistics about permanent memory
6270 allocation when it finishes.
6272 @item -fmem-report-wpa
6273 @opindex fmem-report-wpa
6274 Makes the compiler print some statistics about permanent memory
6275 allocation for the WPA phase only.
6277 @item -fpre-ipa-mem-report
6278 @opindex fpre-ipa-mem-report
6279 @item -fpost-ipa-mem-report
6280 @opindex fpost-ipa-mem-report
6281 Makes the compiler print some statistics about permanent memory
6282 allocation before or after interprocedural optimization.
6284 @item -fprofile-report
6285 @opindex fprofile-report
6286 Makes the compiler print some statistics about consistency of the
6287 (estimated) profile and effect of individual passes.
6289 @item -fstack-usage
6290 @opindex fstack-usage
6291 Makes the compiler output stack usage information for the program, on a
6292 per-function basis.  The filename for the dump is made by appending
6293 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
6294 the output file, if explicitly specified and it is not an executable,
6295 otherwise it is the basename of the source file.  An entry is made up
6296 of three fields:
6298 @itemize
6299 @item
6300 The name of the function.
6301 @item
6302 A number of bytes.
6303 @item
6304 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
6305 @end itemize
6307 The qualifier @code{static} means that the function manipulates the stack
6308 statically: a fixed number of bytes are allocated for the frame on function
6309 entry and released on function exit; no stack adjustments are otherwise made
6310 in the function.  The second field is this fixed number of bytes.
6312 The qualifier @code{dynamic} means that the function manipulates the stack
6313 dynamically: in addition to the static allocation described above, stack
6314 adjustments are made in the body of the function, for example to push/pop
6315 arguments around function calls.  If the qualifier @code{bounded} is also
6316 present, the amount of these adjustments is bounded at compile time and
6317 the second field is an upper bound of the total amount of stack used by
6318 the function.  If it is not present, the amount of these adjustments is
6319 not bounded at compile time and the second field only represents the
6320 bounded part.
6322 @item -fprofile-arcs
6323 @opindex fprofile-arcs
6324 Add code so that program flow @dfn{arcs} are instrumented.  During
6325 execution the program records how many times each branch and call is
6326 executed and how many times it is taken or returns.  When the compiled
6327 program exits it saves this data to a file called
6328 @file{@var{auxname}.gcda} for each source file.  The data may be used for
6329 profile-directed optimizations (@option{-fbranch-probabilities}), or for
6330 test coverage analysis (@option{-ftest-coverage}).  Each object file's
6331 @var{auxname} is generated from the name of the output file, if
6332 explicitly specified and it is not the final executable, otherwise it is
6333 the basename of the source file.  In both cases any suffix is removed
6334 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
6335 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
6336 @xref{Cross-profiling}.
6338 @cindex @command{gcov}
6339 @item --coverage
6340 @opindex coverage
6342 This option is used to compile and link code instrumented for coverage
6343 analysis.  The option is a synonym for @option{-fprofile-arcs}
6344 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6345 linking).  See the documentation for those options for more details.
6347 @itemize
6349 @item
6350 Compile the source files with @option{-fprofile-arcs} plus optimization
6351 and code generation options.  For test coverage analysis, use the
6352 additional @option{-ftest-coverage} option.  You do not need to profile
6353 every source file in a program.
6355 @item
6356 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6357 (the latter implies the former).
6359 @item
6360 Run the program on a representative workload to generate the arc profile
6361 information.  This may be repeated any number of times.  You can run
6362 concurrent instances of your program, and provided that the file system
6363 supports locking, the data files will be correctly updated.  Also
6364 @code{fork} calls are detected and correctly handled (double counting
6365 will not happen).
6367 @item
6368 For profile-directed optimizations, compile the source files again with
6369 the same optimization and code generation options plus
6370 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6371 Control Optimization}).
6373 @item
6374 For test coverage analysis, use @command{gcov} to produce human readable
6375 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6376 @command{gcov} documentation for further information.
6378 @end itemize
6380 With @option{-fprofile-arcs}, for each function of your program GCC
6381 creates a program flow graph, then finds a spanning tree for the graph.
6382 Only arcs that are not on the spanning tree have to be instrumented: the
6383 compiler adds code to count the number of times that these arcs are
6384 executed.  When an arc is the only exit or only entrance to a block, the
6385 instrumentation code can be added to the block; otherwise, a new basic
6386 block must be created to hold the instrumentation code.
6388 @need 2000
6389 @item -ftest-coverage
6390 @opindex ftest-coverage
6391 Produce a notes file that the @command{gcov} code-coverage utility
6392 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6393 show program coverage.  Each source file's note file is called
6394 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6395 above for a description of @var{auxname} and instructions on how to
6396 generate test coverage data.  Coverage data matches the source files
6397 more closely if you do not optimize.
6399 @item -fdbg-cnt-list
6400 @opindex fdbg-cnt-list
6401 Print the name and the counter upper bound for all debug counters.
6404 @item -fdbg-cnt=@var{counter-value-list}
6405 @opindex fdbg-cnt
6406 Set the internal debug counter upper bound.  @var{counter-value-list}
6407 is a comma-separated list of @var{name}:@var{value} pairs
6408 which sets the upper bound of each debug counter @var{name} to @var{value}.
6409 All debug counters have the initial upper bound of @code{UINT_MAX};
6410 thus @code{dbg_cnt} returns true always unless the upper bound
6411 is set by this option.
6412 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6413 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6415 @item -fenable-@var{kind}-@var{pass}
6416 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6417 @opindex fdisable-
6418 @opindex fenable-
6420 This is a set of options that are used to explicitly disable/enable
6421 optimization passes.  These options are intended for use for debugging GCC.
6422 Compiler users should use regular options for enabling/disabling
6423 passes instead.
6425 @table @gcctabopt
6427 @item -fdisable-ipa-@var{pass}
6428 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6429 statically invoked in the compiler multiple times, the pass name should be
6430 appended with a sequential number starting from 1.
6432 @item -fdisable-rtl-@var{pass}
6433 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6434 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6435 statically invoked in the compiler multiple times, the pass name should be
6436 appended with a sequential number starting from 1.  @var{range-list} is a 
6437 comma-separated list of function ranges or assembler names.  Each range is a number
6438 pair separated by a colon.  The range is inclusive in both ends.  If the range
6439 is trivial, the number pair can be simplified as a single number.  If the
6440 function's call graph node's @var{uid} falls within one of the specified ranges,
6441 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6442 function header of a dump file, and the pass names can be dumped by using
6443 option @option{-fdump-passes}.
6445 @item -fdisable-tree-@var{pass}
6446 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6447 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6448 option arguments.
6450 @item -fenable-ipa-@var{pass}
6451 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6452 statically invoked in the compiler multiple times, the pass name should be
6453 appended with a sequential number starting from 1.
6455 @item -fenable-rtl-@var{pass}
6456 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6457 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6458 description and examples.
6460 @item -fenable-tree-@var{pass}
6461 @itemx -fenable-tree-@var{pass}=@var{range-list}
6462 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6463 of option arguments.
6465 @end table
6467 Here are some examples showing uses of these options.
6469 @smallexample
6471 # disable ccp1 for all functions
6472    -fdisable-tree-ccp1
6473 # disable complete unroll for function whose cgraph node uid is 1
6474    -fenable-tree-cunroll=1
6475 # disable gcse2 for functions at the following ranges [1,1],
6476 # [300,400], and [400,1000]
6477 # disable gcse2 for functions foo and foo2
6478    -fdisable-rtl-gcse2=foo,foo2
6479 # disable early inlining
6480    -fdisable-tree-einline
6481 # disable ipa inlining
6482    -fdisable-ipa-inline
6483 # enable tree full unroll
6484    -fenable-tree-unroll
6486 @end smallexample
6488 @item -d@var{letters}
6489 @itemx -fdump-rtl-@var{pass}
6490 @itemx -fdump-rtl-@var{pass}=@var{filename}
6491 @opindex d
6492 @opindex fdump-rtl-@var{pass}
6493 Says to make debugging dumps during compilation at times specified by
6494 @var{letters}.  This is used for debugging the RTL-based passes of the
6495 compiler.  The file names for most of the dumps are made by appending
6496 a pass number and a word to the @var{dumpname}, and the files are
6497 created in the directory of the output file. In case of
6498 @option{=@var{filename}} option, the dump is output on the given file
6499 instead of the pass numbered dump files. Note that the pass number is
6500 computed statically as passes get registered into the pass manager.
6501 Thus the numbering is not related to the dynamic order of execution of
6502 passes.  In particular, a pass installed by a plugin could have a
6503 number over 200 even if it executed quite early.  @var{dumpname} is
6504 generated from the name of the output file, if explicitly specified
6505 and it is not an executable, otherwise it is the basename of the
6506 source file. These switches may have different effects when
6507 @option{-E} is used for preprocessing.
6509 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6510 @option{-d} option @var{letters}.  Here are the possible
6511 letters for use in @var{pass} and @var{letters}, and their meanings:
6513 @table @gcctabopt
6515 @item -fdump-rtl-alignments
6516 @opindex fdump-rtl-alignments
6517 Dump after branch alignments have been computed.
6519 @item -fdump-rtl-asmcons
6520 @opindex fdump-rtl-asmcons
6521 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6523 @item -fdump-rtl-auto_inc_dec
6524 @opindex fdump-rtl-auto_inc_dec
6525 Dump after auto-inc-dec discovery.  This pass is only run on
6526 architectures that have auto inc or auto dec instructions.
6528 @item -fdump-rtl-barriers
6529 @opindex fdump-rtl-barriers
6530 Dump after cleaning up the barrier instructions.
6532 @item -fdump-rtl-bbpart
6533 @opindex fdump-rtl-bbpart
6534 Dump after partitioning hot and cold basic blocks.
6536 @item -fdump-rtl-bbro
6537 @opindex fdump-rtl-bbro
6538 Dump after block reordering.
6540 @item -fdump-rtl-btl1
6541 @itemx -fdump-rtl-btl2
6542 @opindex fdump-rtl-btl2
6543 @opindex fdump-rtl-btl2
6544 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6545 after the two branch
6546 target load optimization passes.
6548 @item -fdump-rtl-bypass
6549 @opindex fdump-rtl-bypass
6550 Dump after jump bypassing and control flow optimizations.
6552 @item -fdump-rtl-combine
6553 @opindex fdump-rtl-combine
6554 Dump after the RTL instruction combination pass.
6556 @item -fdump-rtl-compgotos
6557 @opindex fdump-rtl-compgotos
6558 Dump after duplicating the computed gotos.
6560 @item -fdump-rtl-ce1
6561 @itemx -fdump-rtl-ce2
6562 @itemx -fdump-rtl-ce3
6563 @opindex fdump-rtl-ce1
6564 @opindex fdump-rtl-ce2
6565 @opindex fdump-rtl-ce3
6566 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6567 @option{-fdump-rtl-ce3} enable dumping after the three
6568 if conversion passes.
6570 @item -fdump-rtl-cprop_hardreg
6571 @opindex fdump-rtl-cprop_hardreg
6572 Dump after hard register copy propagation.
6574 @item -fdump-rtl-csa
6575 @opindex fdump-rtl-csa
6576 Dump after combining stack adjustments.
6578 @item -fdump-rtl-cse1
6579 @itemx -fdump-rtl-cse2
6580 @opindex fdump-rtl-cse1
6581 @opindex fdump-rtl-cse2
6582 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6583 the two common subexpression elimination passes.
6585 @item -fdump-rtl-dce
6586 @opindex fdump-rtl-dce
6587 Dump after the standalone dead code elimination passes.
6589 @item -fdump-rtl-dbr
6590 @opindex fdump-rtl-dbr
6591 Dump after delayed branch scheduling.
6593 @item -fdump-rtl-dce1
6594 @itemx -fdump-rtl-dce2
6595 @opindex fdump-rtl-dce1
6596 @opindex fdump-rtl-dce2
6597 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6598 the two dead store elimination passes.
6600 @item -fdump-rtl-eh
6601 @opindex fdump-rtl-eh
6602 Dump after finalization of EH handling code.
6604 @item -fdump-rtl-eh_ranges
6605 @opindex fdump-rtl-eh_ranges
6606 Dump after conversion of EH handling range regions.
6608 @item -fdump-rtl-expand
6609 @opindex fdump-rtl-expand
6610 Dump after RTL generation.
6612 @item -fdump-rtl-fwprop1
6613 @itemx -fdump-rtl-fwprop2
6614 @opindex fdump-rtl-fwprop1
6615 @opindex fdump-rtl-fwprop2
6616 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6617 dumping after the two forward propagation passes.
6619 @item -fdump-rtl-gcse1
6620 @itemx -fdump-rtl-gcse2
6621 @opindex fdump-rtl-gcse1
6622 @opindex fdump-rtl-gcse2
6623 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6624 after global common subexpression elimination.
6626 @item -fdump-rtl-init-regs
6627 @opindex fdump-rtl-init-regs
6628 Dump after the initialization of the registers.
6630 @item -fdump-rtl-initvals
6631 @opindex fdump-rtl-initvals
6632 Dump after the computation of the initial value sets.
6634 @item -fdump-rtl-into_cfglayout
6635 @opindex fdump-rtl-into_cfglayout
6636 Dump after converting to cfglayout mode.
6638 @item -fdump-rtl-ira
6639 @opindex fdump-rtl-ira
6640 Dump after iterated register allocation.
6642 @item -fdump-rtl-jump
6643 @opindex fdump-rtl-jump
6644 Dump after the second jump optimization.
6646 @item -fdump-rtl-loop2
6647 @opindex fdump-rtl-loop2
6648 @option{-fdump-rtl-loop2} enables dumping after the rtl
6649 loop optimization passes.
6651 @item -fdump-rtl-mach
6652 @opindex fdump-rtl-mach
6653 Dump after performing the machine dependent reorganization pass, if that
6654 pass exists.
6656 @item -fdump-rtl-mode_sw
6657 @opindex fdump-rtl-mode_sw
6658 Dump after removing redundant mode switches.
6660 @item -fdump-rtl-rnreg
6661 @opindex fdump-rtl-rnreg
6662 Dump after register renumbering.
6664 @item -fdump-rtl-outof_cfglayout
6665 @opindex fdump-rtl-outof_cfglayout
6666 Dump after converting from cfglayout mode.
6668 @item -fdump-rtl-peephole2
6669 @opindex fdump-rtl-peephole2
6670 Dump after the peephole pass.
6672 @item -fdump-rtl-postreload
6673 @opindex fdump-rtl-postreload
6674 Dump after post-reload optimizations.
6676 @item -fdump-rtl-pro_and_epilogue
6677 @opindex fdump-rtl-pro_and_epilogue
6678 Dump after generating the function prologues and epilogues.
6680 @item -fdump-rtl-sched1
6681 @itemx -fdump-rtl-sched2
6682 @opindex fdump-rtl-sched1
6683 @opindex fdump-rtl-sched2
6684 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6685 after the basic block scheduling passes.
6687 @item -fdump-rtl-ree
6688 @opindex fdump-rtl-ree
6689 Dump after sign/zero extension elimination.
6691 @item -fdump-rtl-seqabstr
6692 @opindex fdump-rtl-seqabstr
6693 Dump after common sequence discovery.
6695 @item -fdump-rtl-shorten
6696 @opindex fdump-rtl-shorten
6697 Dump after shortening branches.
6699 @item -fdump-rtl-sibling
6700 @opindex fdump-rtl-sibling
6701 Dump after sibling call optimizations.
6703 @item -fdump-rtl-split1
6704 @itemx -fdump-rtl-split2
6705 @itemx -fdump-rtl-split3
6706 @itemx -fdump-rtl-split4
6707 @itemx -fdump-rtl-split5
6708 @opindex fdump-rtl-split1
6709 @opindex fdump-rtl-split2
6710 @opindex fdump-rtl-split3
6711 @opindex fdump-rtl-split4
6712 @opindex fdump-rtl-split5
6713 These options enable dumping after five rounds of
6714 instruction splitting.
6716 @item -fdump-rtl-sms
6717 @opindex fdump-rtl-sms
6718 Dump after modulo scheduling.  This pass is only run on some
6719 architectures.
6721 @item -fdump-rtl-stack
6722 @opindex fdump-rtl-stack
6723 Dump after conversion from GCC's ``flat register file'' registers to the
6724 x87's stack-like registers.  This pass is only run on x86 variants.
6726 @item -fdump-rtl-subreg1
6727 @itemx -fdump-rtl-subreg2
6728 @opindex fdump-rtl-subreg1
6729 @opindex fdump-rtl-subreg2
6730 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6731 the two subreg expansion passes.
6733 @item -fdump-rtl-unshare
6734 @opindex fdump-rtl-unshare
6735 Dump after all rtl has been unshared.
6737 @item -fdump-rtl-vartrack
6738 @opindex fdump-rtl-vartrack
6739 Dump after variable tracking.
6741 @item -fdump-rtl-vregs
6742 @opindex fdump-rtl-vregs
6743 Dump after converting virtual registers to hard registers.
6745 @item -fdump-rtl-web
6746 @opindex fdump-rtl-web
6747 Dump after live range splitting.
6749 @item -fdump-rtl-regclass
6750 @itemx -fdump-rtl-subregs_of_mode_init
6751 @itemx -fdump-rtl-subregs_of_mode_finish
6752 @itemx -fdump-rtl-dfinit
6753 @itemx -fdump-rtl-dfinish
6754 @opindex fdump-rtl-regclass
6755 @opindex fdump-rtl-subregs_of_mode_init
6756 @opindex fdump-rtl-subregs_of_mode_finish
6757 @opindex fdump-rtl-dfinit
6758 @opindex fdump-rtl-dfinish
6759 These dumps are defined but always produce empty files.
6761 @item -da
6762 @itemx -fdump-rtl-all
6763 @opindex da
6764 @opindex fdump-rtl-all
6765 Produce all the dumps listed above.
6767 @item -dA
6768 @opindex dA
6769 Annotate the assembler output with miscellaneous debugging information.
6771 @item -dD
6772 @opindex dD
6773 Dump all macro definitions, at the end of preprocessing, in addition to
6774 normal output.
6776 @item -dH
6777 @opindex dH
6778 Produce a core dump whenever an error occurs.
6780 @item -dp
6781 @opindex dp
6782 Annotate the assembler output with a comment indicating which
6783 pattern and alternative is used.  The length of each instruction is
6784 also printed.
6786 @item -dP
6787 @opindex dP
6788 Dump the RTL in the assembler output as a comment before each instruction.
6789 Also turns on @option{-dp} annotation.
6791 @item -dx
6792 @opindex dx
6793 Just generate RTL for a function instead of compiling it.  Usually used
6794 with @option{-fdump-rtl-expand}.
6795 @end table
6797 @item -fdump-noaddr
6798 @opindex fdump-noaddr
6799 When doing debugging dumps, suppress address output.  This makes it more
6800 feasible to use diff on debugging dumps for compiler invocations with
6801 different compiler binaries and/or different
6802 text / bss / data / heap / stack / dso start locations.
6804 @item -freport-bug
6805 @opindex freport-bug
6806 Collect and dump debug information into temporary file if ICE in C/C++
6807 compiler occured.
6809 @item -fdump-unnumbered
6810 @opindex fdump-unnumbered
6811 When doing debugging dumps, suppress instruction numbers and address output.
6812 This makes it more feasible to use diff on debugging dumps for compiler
6813 invocations with different options, in particular with and without
6814 @option{-g}.
6816 @item -fdump-unnumbered-links
6817 @opindex fdump-unnumbered-links
6818 When doing debugging dumps (see @option{-d} option above), suppress
6819 instruction numbers for the links to the previous and next instructions
6820 in a sequence.
6822 @item -fdump-translation-unit @r{(C++ only)}
6823 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6824 @opindex fdump-translation-unit
6825 Dump a representation of the tree structure for the entire translation
6826 unit to a file.  The file name is made by appending @file{.tu} to the
6827 source file name, and the file is created in the same directory as the
6828 output file.  If the @samp{-@var{options}} form is used, @var{options}
6829 controls the details of the dump as described for the
6830 @option{-fdump-tree} options.
6832 @item -fdump-class-hierarchy @r{(C++ only)}
6833 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6834 @opindex fdump-class-hierarchy
6835 Dump a representation of each class's hierarchy and virtual function
6836 table layout to a file.  The file name is made by appending
6837 @file{.class} to the source file name, and the file is created in the
6838 same directory as the output file.  If the @samp{-@var{options}} form
6839 is used, @var{options} controls the details of the dump as described
6840 for the @option{-fdump-tree} options.
6842 @item -fdump-ipa-@var{switch}
6843 @opindex fdump-ipa
6844 Control the dumping at various stages of inter-procedural analysis
6845 language tree to a file.  The file name is generated by appending a
6846 switch specific suffix to the source file name, and the file is created
6847 in the same directory as the output file.  The following dumps are
6848 possible:
6850 @table @samp
6851 @item all
6852 Enables all inter-procedural analysis dumps.
6854 @item cgraph
6855 Dumps information about call-graph optimization, unused function removal,
6856 and inlining decisions.
6858 @item inline
6859 Dump after function inlining.
6861 @end table
6863 @item -fdump-passes
6864 @opindex fdump-passes
6865 Dump the list of optimization passes that are turned on and off by
6866 the current command-line options.
6868 @item -fdump-statistics-@var{option}
6869 @opindex fdump-statistics
6870 Enable and control dumping of pass statistics in a separate file.  The
6871 file name is generated by appending a suffix ending in
6872 @samp{.statistics} to the source file name, and the file is created in
6873 the same directory as the output file.  If the @samp{-@var{option}}
6874 form is used, @samp{-stats} causes counters to be summed over the
6875 whole compilation unit while @samp{-details} dumps every event as
6876 the passes generate them.  The default with no option is to sum
6877 counters for each function compiled.
6879 @item -fdump-tree-@var{switch}
6880 @itemx -fdump-tree-@var{switch}-@var{options}
6881 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6882 @opindex fdump-tree
6883 Control the dumping at various stages of processing the intermediate
6884 language tree to a file.  The file name is generated by appending a
6885 switch-specific suffix to the source file name, and the file is
6886 created in the same directory as the output file. In case of
6887 @option{=@var{filename}} option, the dump is output on the given file
6888 instead of the auto named dump files.  If the @samp{-@var{options}}
6889 form is used, @var{options} is a list of @samp{-} separated options
6890 which control the details of the dump.  Not all options are applicable
6891 to all dumps; those that are not meaningful are ignored.  The
6892 following options are available
6894 @table @samp
6895 @item address
6896 Print the address of each node.  Usually this is not meaningful as it
6897 changes according to the environment and source file.  Its primary use
6898 is for tying up a dump file with a debug environment.
6899 @item asmname
6900 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6901 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6902 use working backward from mangled names in the assembly file.
6903 @item slim
6904 When dumping front-end intermediate representations, inhibit dumping
6905 of members of a scope or body of a function merely because that scope
6906 has been reached.  Only dump such items when they are directly reachable
6907 by some other path.
6909 When dumping pretty-printed trees, this option inhibits dumping the
6910 bodies of control structures.
6912 When dumping RTL, print the RTL in slim (condensed) form instead of
6913 the default LISP-like representation.
6914 @item raw
6915 Print a raw representation of the tree.  By default, trees are
6916 pretty-printed into a C-like representation.
6917 @item details
6918 Enable more detailed dumps (not honored by every dump option). Also
6919 include information from the optimization passes.
6920 @item stats
6921 Enable dumping various statistics about the pass (not honored by every dump
6922 option).
6923 @item blocks
6924 Enable showing basic block boundaries (disabled in raw dumps).
6925 @item graph
6926 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6927 dump a representation of the control flow graph suitable for viewing with
6928 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6929 the file is pretty-printed as a subgraph, so that GraphViz can render them
6930 all in a single plot.
6932 This option currently only works for RTL dumps, and the RTL is always
6933 dumped in slim form.
6934 @item vops
6935 Enable showing virtual operands for every statement.
6936 @item lineno
6937 Enable showing line numbers for statements.
6938 @item uid
6939 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6940 @item verbose
6941 Enable showing the tree dump for each statement.
6942 @item eh
6943 Enable showing the EH region number holding each statement.
6944 @item scev
6945 Enable showing scalar evolution analysis details.
6946 @item optimized
6947 Enable showing optimization information (only available in certain
6948 passes).
6949 @item missed
6950 Enable showing missed optimization information (only available in certain
6951 passes).
6952 @item note
6953 Enable other detailed optimization information (only available in
6954 certain passes).
6955 @item =@var{filename}
6956 Instead of an auto named dump file, output into the given file
6957 name. The file names @file{stdout} and @file{stderr} are treated
6958 specially and are considered already open standard streams. For
6959 example,
6961 @smallexample
6962 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6963      -fdump-tree-pre=stderr file.c
6964 @end smallexample
6966 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6967 output on to @file{stderr}. If two conflicting dump filenames are
6968 given for the same pass, then the latter option overrides the earlier
6969 one.
6971 @item all
6972 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6973 and @option{lineno}.
6975 @item optall
6976 Turn on all optimization options, i.e., @option{optimized},
6977 @option{missed}, and @option{note}.
6978 @end table
6980 The following tree dumps are possible:
6981 @table @samp
6983 @item original
6984 @opindex fdump-tree-original
6985 Dump before any tree based optimization, to @file{@var{file}.original}.
6987 @item optimized
6988 @opindex fdump-tree-optimized
6989 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6991 @item gimple
6992 @opindex fdump-tree-gimple
6993 Dump each function before and after the gimplification pass to a file.  The
6994 file name is made by appending @file{.gimple} to the source file name.
6996 @item cfg
6997 @opindex fdump-tree-cfg
6998 Dump the control flow graph of each function to a file.  The file name is
6999 made by appending @file{.cfg} to the source file name.
7001 @item ch
7002 @opindex fdump-tree-ch
7003 Dump each function after copying loop headers.  The file name is made by
7004 appending @file{.ch} to the source file name.
7006 @item ssa
7007 @opindex fdump-tree-ssa
7008 Dump SSA related information to a file.  The file name is made by appending
7009 @file{.ssa} to the source file name.
7011 @item alias
7012 @opindex fdump-tree-alias
7013 Dump aliasing information for each function.  The file name is made by
7014 appending @file{.alias} to the source file name.
7016 @item ccp
7017 @opindex fdump-tree-ccp
7018 Dump each function after CCP@.  The file name is made by appending
7019 @file{.ccp} to the source file name.
7021 @item storeccp
7022 @opindex fdump-tree-storeccp
7023 Dump each function after STORE-CCP@.  The file name is made by appending
7024 @file{.storeccp} to the source file name.
7026 @item pre
7027 @opindex fdump-tree-pre
7028 Dump trees after partial redundancy elimination.  The file name is made
7029 by appending @file{.pre} to the source file name.
7031 @item fre
7032 @opindex fdump-tree-fre
7033 Dump trees after full redundancy elimination.  The file name is made
7034 by appending @file{.fre} to the source file name.
7036 @item copyprop
7037 @opindex fdump-tree-copyprop
7038 Dump trees after copy propagation.  The file name is made
7039 by appending @file{.copyprop} to the source file name.
7041 @item store_copyprop
7042 @opindex fdump-tree-store_copyprop
7043 Dump trees after store copy-propagation.  The file name is made
7044 by appending @file{.store_copyprop} to the source file name.
7046 @item dce
7047 @opindex fdump-tree-dce
7048 Dump each function after dead code elimination.  The file name is made by
7049 appending @file{.dce} to the source file name.
7051 @item sra
7052 @opindex fdump-tree-sra
7053 Dump each function after performing scalar replacement of aggregates.  The
7054 file name is made by appending @file{.sra} to the source file name.
7056 @item sink
7057 @opindex fdump-tree-sink
7058 Dump each function after performing code sinking.  The file name is made
7059 by appending @file{.sink} to the source file name.
7061 @item dom
7062 @opindex fdump-tree-dom
7063 Dump each function after applying dominator tree optimizations.  The file
7064 name is made by appending @file{.dom} to the source file name.
7066 @item dse
7067 @opindex fdump-tree-dse
7068 Dump each function after applying dead store elimination.  The file
7069 name is made by appending @file{.dse} to the source file name.
7071 @item phiopt
7072 @opindex fdump-tree-phiopt
7073 Dump each function after optimizing PHI nodes into straightline code.  The file
7074 name is made by appending @file{.phiopt} to the source file name.
7076 @item forwprop
7077 @opindex fdump-tree-forwprop
7078 Dump each function after forward propagating single use variables.  The file
7079 name is made by appending @file{.forwprop} to the source file name.
7081 @item copyrename
7082 @opindex fdump-tree-copyrename
7083 Dump each function after applying the copy rename optimization.  The file
7084 name is made by appending @file{.copyrename} to the source file name.
7086 @item nrv
7087 @opindex fdump-tree-nrv
7088 Dump each function after applying the named return value optimization on
7089 generic trees.  The file name is made by appending @file{.nrv} to the source
7090 file name.
7092 @item vect
7093 @opindex fdump-tree-vect
7094 Dump each function after applying vectorization of loops.  The file name is
7095 made by appending @file{.vect} to the source file name.
7097 @item slp
7098 @opindex fdump-tree-slp
7099 Dump each function after applying vectorization of basic blocks.  The file name
7100 is made by appending @file{.slp} to the source file name.
7102 @item vrp
7103 @opindex fdump-tree-vrp
7104 Dump each function after Value Range Propagation (VRP).  The file name
7105 is made by appending @file{.vrp} to the source file name.
7107 @item all
7108 @opindex fdump-tree-all
7109 Enable all the available tree dumps with the flags provided in this option.
7110 @end table
7112 @item -fopt-info
7113 @itemx -fopt-info-@var{options}
7114 @itemx -fopt-info-@var{options}=@var{filename}
7115 @opindex fopt-info
7116 Controls optimization dumps from various optimization passes. If the
7117 @samp{-@var{options}} form is used, @var{options} is a list of
7118 @samp{-} separated option keywords to select the dump details and
7119 optimizations.  
7121 The @var{options} can be divided into two groups: options describing the
7122 verbosity of the dump, and options describing which optimizations
7123 should be included. The options from both the groups can be freely
7124 mixed as they are non-overlapping. However, in case of any conflicts,
7125 the later options override the earlier options on the command
7126 line. 
7128 The following options control the dump verbosity:
7130 @table @samp
7131 @item optimized
7132 Print information when an optimization is successfully applied. It is
7133 up to a pass to decide which information is relevant. For example, the
7134 vectorizer passes print the source location of loops which are
7135 successfully vectorized.
7136 @item missed
7137 Print information about missed optimizations. Individual passes
7138 control which information to include in the output. 
7139 @item note
7140 Print verbose information about optimizations, such as certain
7141 transformations, more detailed messages about decisions etc.
7142 @item all
7143 Print detailed optimization information. This includes
7144 @samp{optimized}, @samp{missed}, and @samp{note}.
7145 @end table
7147 One or more of the following option keywords can be used to describe a
7148 group of optimizations:
7150 @table @samp
7151 @item ipa
7152 Enable dumps from all interprocedural optimizations.
7153 @item loop
7154 Enable dumps from all loop optimizations.
7155 @item inline
7156 Enable dumps from all inlining optimizations.
7157 @item vec
7158 Enable dumps from all vectorization optimizations.
7159 @item optall
7160 Enable dumps from all optimizations. This is a superset of
7161 the optimization groups listed above.
7162 @end table
7164 If @var{options} is
7165 omitted, it defaults to @samp{optimized-optall}, which means to dump all
7166 info about successful optimizations from all the passes.  
7168 If the @var{filename} is provided, then the dumps from all the
7169 applicable optimizations are concatenated into the @var{filename}.
7170 Otherwise the dump is output onto @file{stderr}. Though multiple
7171 @option{-fopt-info} options are accepted, only one of them can include
7172 a @var{filename}. If other filenames are provided then all but the
7173 first such option are ignored.
7175 Note that the output @var{filename} is overwritten
7176 in case of multiple translation units. If a combined output from
7177 multiple translation units is desired, @file{stderr} should be used
7178 instead.
7180 In the following example, the optimization info is output to
7181 @file{stderr}:
7183 @smallexample
7184 gcc -O3 -fopt-info
7185 @end smallexample
7187 This example:
7188 @smallexample
7189 gcc -O3 -fopt-info-missed=missed.all
7190 @end smallexample
7192 @noindent
7193 outputs missed optimization report from all the passes into
7194 @file{missed.all}, and this one:
7196 @smallexample
7197 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
7198 @end smallexample
7200 @noindent
7201 prints information about missed optimization opportunities from
7202 vectorization passes on @file{stderr}.  
7203 Note that @option{-fopt-info-vec-missed} is equivalent to 
7204 @option{-fopt-info-missed-vec}.
7206 As another example,
7207 @smallexample
7208 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
7209 @end smallexample
7211 @noindent
7212 outputs information about missed optimizations as well as
7213 optimized locations from all the inlining passes into
7214 @file{inline.txt}.
7216 Finally, consider:
7218 @smallexample
7219 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
7220 @end smallexample
7222 @noindent
7223 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
7224 in conflict since only one output file is allowed. In this case, only
7225 the first option takes effect and the subsequent options are
7226 ignored. Thus only @file{vec.miss} is produced which contains
7227 dumps from the vectorizer about missed opportunities.
7229 @item -frandom-seed=@var{number}
7230 @opindex frandom-seed
7231 This option provides a seed that GCC uses in place of
7232 random numbers in generating certain symbol names
7233 that have to be different in every compiled file.  It is also used to
7234 place unique stamps in coverage data files and the object files that
7235 produce them.  You can use the @option{-frandom-seed} option to produce
7236 reproducibly identical object files.
7238 The @var{number} should be different for every file you compile.
7240 @item -fsched-verbose=@var{n}
7241 @opindex fsched-verbose
7242 On targets that use instruction scheduling, this option controls the
7243 amount of debugging output the scheduler prints.  This information is
7244 written to standard error, unless @option{-fdump-rtl-sched1} or
7245 @option{-fdump-rtl-sched2} is specified, in which case it is output
7246 to the usual dump listing file, @file{.sched1} or @file{.sched2}
7247 respectively.  However for @var{n} greater than nine, the output is
7248 always printed to standard error.
7250 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
7251 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
7252 For @var{n} greater than one, it also output basic block probabilities,
7253 detailed ready list information and unit/insn info.  For @var{n} greater
7254 than two, it includes RTL at abort point, control-flow and regions info.
7255 And for @var{n} over four, @option{-fsched-verbose} also includes
7256 dependence info.
7258 @item -save-temps
7259 @itemx -save-temps=cwd
7260 @opindex save-temps
7261 Store the usual ``temporary'' intermediate files permanently; place them
7262 in the current directory and name them based on the source file.  Thus,
7263 compiling @file{foo.c} with @option{-c -save-temps} produces files
7264 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
7265 preprocessed @file{foo.i} output file even though the compiler now
7266 normally uses an integrated preprocessor.
7268 When used in combination with the @option{-x} command-line option,
7269 @option{-save-temps} is sensible enough to avoid over writing an
7270 input source file with the same extension as an intermediate file.
7271 The corresponding intermediate file may be obtained by renaming the
7272 source file before using @option{-save-temps}.
7274 If you invoke GCC in parallel, compiling several different source
7275 files that share a common base name in different subdirectories or the
7276 same source file compiled for multiple output destinations, it is
7277 likely that the different parallel compilers will interfere with each
7278 other, and overwrite the temporary files.  For instance:
7280 @smallexample
7281 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
7282 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
7283 @end smallexample
7285 may result in @file{foo.i} and @file{foo.o} being written to
7286 simultaneously by both compilers.
7288 @item -save-temps=obj
7289 @opindex save-temps=obj
7290 Store the usual ``temporary'' intermediate files permanently.  If the
7291 @option{-o} option is used, the temporary files are based on the
7292 object file.  If the @option{-o} option is not used, the
7293 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
7295 For example:
7297 @smallexample
7298 gcc -save-temps=obj -c foo.c
7299 gcc -save-temps=obj -c bar.c -o dir/xbar.o
7300 gcc -save-temps=obj foobar.c -o dir2/yfoobar
7301 @end smallexample
7303 @noindent
7304 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
7305 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
7306 @file{dir2/yfoobar.o}.
7308 @item -time@r{[}=@var{file}@r{]}
7309 @opindex time
7310 Report the CPU time taken by each subprocess in the compilation
7311 sequence.  For C source files, this is the compiler proper and assembler
7312 (plus the linker if linking is done).
7314 Without the specification of an output file, the output looks like this:
7316 @smallexample
7317 # cc1 0.12 0.01
7318 # as 0.00 0.01
7319 @end smallexample
7321 The first number on each line is the ``user time'', that is time spent
7322 executing the program itself.  The second number is ``system time'',
7323 time spent executing operating system routines on behalf of the program.
7324 Both numbers are in seconds.
7326 With the specification of an output file, the output is appended to the
7327 named file, and it looks like this:
7329 @smallexample
7330 0.12 0.01 cc1 @var{options}
7331 0.00 0.01 as @var{options}
7332 @end smallexample
7334 The ``user time'' and the ``system time'' are moved before the program
7335 name, and the options passed to the program are displayed, so that one
7336 can later tell what file was being compiled, and with which options.
7338 @item -fvar-tracking
7339 @opindex fvar-tracking
7340 Run variable tracking pass.  It computes where variables are stored at each
7341 position in code.  Better debugging information is then generated
7342 (if the debugging information format supports this information).
7344 It is enabled by default when compiling with optimization (@option{-Os},
7345 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7346 the debug info format supports it.
7348 @item -fvar-tracking-assignments
7349 @opindex fvar-tracking-assignments
7350 @opindex fno-var-tracking-assignments
7351 Annotate assignments to user variables early in the compilation and
7352 attempt to carry the annotations over throughout the compilation all the
7353 way to the end, in an attempt to improve debug information while
7354 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7356 It can be enabled even if var-tracking is disabled, in which case
7357 annotations are created and maintained, but discarded at the end.
7358 By default, this flag is enabled together with @option{-fvar-tracking},
7359 except when selective scheduling is enabled.
7361 @item -fvar-tracking-assignments-toggle
7362 @opindex fvar-tracking-assignments-toggle
7363 @opindex fno-var-tracking-assignments-toggle
7364 Toggle @option{-fvar-tracking-assignments}, in the same way that
7365 @option{-gtoggle} toggles @option{-g}.
7367 @item -print-file-name=@var{library}
7368 @opindex print-file-name
7369 Print the full absolute name of the library file @var{library} that
7370 would be used when linking---and don't do anything else.  With this
7371 option, GCC does not compile or link anything; it just prints the
7372 file name.
7374 @item -print-multi-directory
7375 @opindex print-multi-directory
7376 Print the directory name corresponding to the multilib selected by any
7377 other switches present in the command line.  This directory is supposed
7378 to exist in @env{GCC_EXEC_PREFIX}.
7380 @item -print-multi-lib
7381 @opindex print-multi-lib
7382 Print the mapping from multilib directory names to compiler switches
7383 that enable them.  The directory name is separated from the switches by
7384 @samp{;}, and each switch starts with an @samp{@@} instead of the
7385 @samp{-}, without spaces between multiple switches.  This is supposed to
7386 ease shell processing.
7388 @item -print-multi-os-directory
7389 @opindex print-multi-os-directory
7390 Print the path to OS libraries for the selected
7391 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7392 present in the @file{lib} subdirectory and no multilibs are used, this is
7393 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7394 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7395 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7396 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7398 @item -print-multiarch
7399 @opindex print-multiarch
7400 Print the path to OS libraries for the selected multiarch,
7401 relative to some @file{lib} subdirectory.
7403 @item -print-prog-name=@var{program}
7404 @opindex print-prog-name
7405 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
7407 @item -print-libgcc-file-name
7408 @opindex print-libgcc-file-name
7409 Same as @option{-print-file-name=libgcc.a}.
7411 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7412 but you do want to link with @file{libgcc.a}.  You can do:
7414 @smallexample
7415 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7416 @end smallexample
7418 @item -print-search-dirs
7419 @opindex print-search-dirs
7420 Print the name of the configured installation directory and a list of
7421 program and library directories @command{gcc} searches---and don't do anything else.
7423 This is useful when @command{gcc} prints the error message
7424 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7425 To resolve this you either need to put @file{cpp0} and the other compiler
7426 components where @command{gcc} expects to find them, or you can set the environment
7427 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7428 Don't forget the trailing @samp{/}.
7429 @xref{Environment Variables}.
7431 @item -print-sysroot
7432 @opindex print-sysroot
7433 Print the target sysroot directory that is used during
7434 compilation.  This is the target sysroot specified either at configure
7435 time or using the @option{--sysroot} option, possibly with an extra
7436 suffix that depends on compilation options.  If no target sysroot is
7437 specified, the option prints nothing.
7439 @item -print-sysroot-headers-suffix
7440 @opindex print-sysroot-headers-suffix
7441 Print the suffix added to the target sysroot when searching for
7442 headers, or give an error if the compiler is not configured with such
7443 a suffix---and don't do anything else.
7445 @item -dumpmachine
7446 @opindex dumpmachine
7447 Print the compiler's target machine (for example,
7448 @samp{i686-pc-linux-gnu})---and don't do anything else.
7450 @item -dumpversion
7451 @opindex dumpversion
7452 Print the compiler version (for example, @code{3.0})---and don't do
7453 anything else.
7455 @item -dumpspecs
7456 @opindex dumpspecs
7457 Print the compiler's built-in specs---and don't do anything else.  (This
7458 is used when GCC itself is being built.)  @xref{Spec Files}.
7460 @item -fno-eliminate-unused-debug-types
7461 @opindex feliminate-unused-debug-types
7462 @opindex fno-eliminate-unused-debug-types
7463 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7464 output for types that are nowhere used in the source file being compiled.
7465 Sometimes it is useful to have GCC emit debugging
7466 information for all types declared in a compilation
7467 unit, regardless of whether or not they are actually used
7468 in that compilation unit, for example 
7469 if, in the debugger, you want to cast a value to a type that is
7470 not actually used in your program (but is declared).  More often,
7471 however, this results in a significant amount of wasted space.
7472 @end table
7474 @node Optimize Options
7475 @section Options That Control Optimization
7476 @cindex optimize options
7477 @cindex options, optimization
7479 These options control various sorts of optimizations.
7481 Without any optimization option, the compiler's goal is to reduce the
7482 cost of compilation and to make debugging produce the expected
7483 results.  Statements are independent: if you stop the program with a
7484 breakpoint between statements, you can then assign a new value to any
7485 variable or change the program counter to any other statement in the
7486 function and get exactly the results you expect from the source
7487 code.
7489 Turning on optimization flags makes the compiler attempt to improve
7490 the performance and/or code size at the expense of compilation time
7491 and possibly the ability to debug the program.
7493 The compiler performs optimization based on the knowledge it has of the
7494 program.  Compiling multiple files at once to a single output file mode allows
7495 the compiler to use information gained from all of the files when compiling
7496 each of them.
7498 Not all optimizations are controlled directly by a flag.  Only
7499 optimizations that have a flag are listed in this section.
7501 Most optimizations are only enabled if an @option{-O} level is set on
7502 the command line.  Otherwise they are disabled, even if individual
7503 optimization flags are specified.
7505 Depending on the target and how GCC was configured, a slightly different
7506 set of optimizations may be enabled at each @option{-O} level than
7507 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7508 to find out the exact set of optimizations that are enabled at each level.
7509 @xref{Overall Options}, for examples.
7511 @table @gcctabopt
7512 @item -O
7513 @itemx -O1
7514 @opindex O
7515 @opindex O1
7516 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7517 more memory for a large function.
7519 With @option{-O}, the compiler tries to reduce code size and execution
7520 time, without performing any optimizations that take a great deal of
7521 compilation time.
7523 @option{-O} turns on the following optimization flags:
7524 @gccoptlist{
7525 -fauto-inc-dec @gol
7526 -fbranch-count-reg @gol
7527 -fcombine-stack-adjustments @gol
7528 -fcompare-elim @gol
7529 -fcprop-registers @gol
7530 -fdce @gol
7531 -fdefer-pop @gol
7532 -fdelayed-branch @gol
7533 -fdse @gol
7534 -fforward-propagate @gol
7535 -fguess-branch-probability @gol
7536 -fif-conversion2 @gol
7537 -fif-conversion @gol
7538 -finline-functions-called-once @gol
7539 -fipa-pure-const @gol
7540 -fipa-profile @gol
7541 -fipa-reference @gol
7542 -fmerge-constants @gol
7543 -fmove-loop-invariants @gol
7544 -fshrink-wrap @gol
7545 -fsplit-wide-types @gol
7546 -ftree-bit-ccp @gol
7547 -ftree-ccp @gol
7548 -fssa-phiopt @gol
7549 -ftree-ch @gol
7550 -ftree-copy-prop @gol
7551 -ftree-copyrename @gol
7552 -ftree-dce @gol
7553 -ftree-dominator-opts @gol
7554 -ftree-dse @gol
7555 -ftree-forwprop @gol
7556 -ftree-fre @gol
7557 -ftree-phiprop @gol
7558 -ftree-sink @gol
7559 -ftree-slsr @gol
7560 -ftree-sra @gol
7561 -ftree-pta @gol
7562 -ftree-ter @gol
7563 -funit-at-a-time}
7565 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7566 where doing so does not interfere with debugging.
7568 @item -O2
7569 @opindex O2
7570 Optimize even more.  GCC performs nearly all supported optimizations
7571 that do not involve a space-speed tradeoff.
7572 As compared to @option{-O}, this option increases both compilation time
7573 and the performance of the generated code.
7575 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7576 also turns on the following optimization flags:
7577 @gccoptlist{-fthread-jumps @gol
7578 -falign-functions  -falign-jumps @gol
7579 -falign-loops  -falign-labels @gol
7580 -fcaller-saves @gol
7581 -fcrossjumping @gol
7582 -fcse-follow-jumps  -fcse-skip-blocks @gol
7583 -fdelete-null-pointer-checks @gol
7584 -fdevirtualize -fdevirtualize-speculatively @gol
7585 -fexpensive-optimizations @gol
7586 -fgcse  -fgcse-lm  @gol
7587 -fhoist-adjacent-loads @gol
7588 -finline-small-functions @gol
7589 -findirect-inlining @gol
7590 -fipa-cp @gol
7591 -fipa-cp-alignment @gol
7592 -fipa-sra @gol
7593 -fipa-icf @gol
7594 -fisolate-erroneous-paths-dereference @gol
7595 -flra-remat @gol
7596 -foptimize-sibling-calls @gol
7597 -foptimize-strlen @gol
7598 -fpartial-inlining @gol
7599 -fpeephole2 @gol
7600 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7601 -frerun-cse-after-loop  @gol
7602 -fsched-interblock  -fsched-spec @gol
7603 -fschedule-insns  -fschedule-insns2 @gol
7604 -fstrict-aliasing -fstrict-overflow @gol
7605 -ftree-builtin-call-dce @gol
7606 -ftree-switch-conversion -ftree-tail-merge @gol
7607 -ftree-pre @gol
7608 -ftree-vrp @gol
7609 -fipa-ra}
7611 Please note the warning under @option{-fgcse} about
7612 invoking @option{-O2} on programs that use computed gotos.
7614 @item -O3
7615 @opindex O3
7616 Optimize yet more.  @option{-O3} turns on all optimizations specified
7617 by @option{-O2} and also turns on the @option{-finline-functions},
7618 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7619 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7620 @option{-ftree-loop-distribute-patterns},
7621 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7622 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7624 @item -O0
7625 @opindex O0
7626 Reduce compilation time and make debugging produce the expected
7627 results.  This is the default.
7629 @item -Os
7630 @opindex Os
7631 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7632 do not typically increase code size.  It also performs further
7633 optimizations designed to reduce code size.
7635 @option{-Os} disables the following optimization flags:
7636 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7637 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7638 -fprefetch-loop-arrays}
7640 @item -Ofast
7641 @opindex Ofast
7642 Disregard strict standards compliance.  @option{-Ofast} enables all
7643 @option{-O3} optimizations.  It also enables optimizations that are not
7644 valid for all standard-compliant programs.
7645 It turns on @option{-ffast-math} and the Fortran-specific
7646 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7648 @item -Og
7649 @opindex Og
7650 Optimize debugging experience.  @option{-Og} enables optimizations
7651 that do not interfere with debugging. It should be the optimization
7652 level of choice for the standard edit-compile-debug cycle, offering
7653 a reasonable level of optimization while maintaining fast compilation
7654 and a good debugging experience.
7656 If you use multiple @option{-O} options, with or without level numbers,
7657 the last such option is the one that is effective.
7658 @end table
7660 Options of the form @option{-f@var{flag}} specify machine-independent
7661 flags.  Most flags have both positive and negative forms; the negative
7662 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7663 below, only one of the forms is listed---the one you typically 
7664 use.  You can figure out the other form by either removing @samp{no-}
7665 or adding it.
7667 The following options control specific optimizations.  They are either
7668 activated by @option{-O} options or are related to ones that are.  You
7669 can use the following flags in the rare cases when ``fine-tuning'' of
7670 optimizations to be performed is desired.
7672 @table @gcctabopt
7673 @item -fno-defer-pop
7674 @opindex fno-defer-pop
7675 Always pop the arguments to each function call as soon as that function
7676 returns.  For machines that must pop arguments after a function call,
7677 the compiler normally lets arguments accumulate on the stack for several
7678 function calls and pops them all at once.
7680 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7682 @item -fforward-propagate
7683 @opindex fforward-propagate
7684 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7685 instructions and checks if the result can be simplified.  If loop unrolling
7686 is active, two passes are performed and the second is scheduled after
7687 loop unrolling.
7689 This option is enabled by default at optimization levels @option{-O},
7690 @option{-O2}, @option{-O3}, @option{-Os}.
7692 @item -ffp-contract=@var{style}
7693 @opindex ffp-contract
7694 @option{-ffp-contract=off} disables floating-point expression contraction.
7695 @option{-ffp-contract=fast} enables floating-point expression contraction
7696 such as forming of fused multiply-add operations if the target has
7697 native support for them.
7698 @option{-ffp-contract=on} enables floating-point expression contraction
7699 if allowed by the language standard.  This is currently not implemented
7700 and treated equal to @option{-ffp-contract=off}.
7702 The default is @option{-ffp-contract=fast}.
7704 @item -fomit-frame-pointer
7705 @opindex fomit-frame-pointer
7706 Don't keep the frame pointer in a register for functions that
7707 don't need one.  This avoids the instructions to save, set up and
7708 restore frame pointers; it also makes an extra register available
7709 in many functions.  @strong{It also makes debugging impossible on
7710 some machines.}
7712 On some machines, such as the VAX, this flag has no effect, because
7713 the standard calling sequence automatically handles the frame pointer
7714 and nothing is saved by pretending it doesn't exist.  The
7715 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7716 whether a target machine supports this flag.  @xref{Registers,,Register
7717 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7719 The default setting (when not optimizing for
7720 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7721 @option{-fomit-frame-pointer}.  You can configure GCC with the
7722 @option{--enable-frame-pointer} configure option to change the default.
7724 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7726 @item -foptimize-sibling-calls
7727 @opindex foptimize-sibling-calls
7728 Optimize sibling and tail recursive calls.
7730 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7732 @item -foptimize-strlen
7733 @opindex foptimize-strlen
7734 Optimize various standard C string functions (e.g. @code{strlen},
7735 @code{strchr} or @code{strcpy}) and
7736 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7738 Enabled at levels @option{-O2}, @option{-O3}.
7740 @item -fno-inline
7741 @opindex fno-inline
7742 Do not expand any functions inline apart from those marked with
7743 the @code{always_inline} attribute.  This is the default when not
7744 optimizing.
7746 Single functions can be exempted from inlining by marking them
7747 with the @code{noinline} attribute.
7749 @item -finline-small-functions
7750 @opindex finline-small-functions
7751 Integrate functions into their callers when their body is smaller than expected
7752 function call code (so overall size of program gets smaller).  The compiler
7753 heuristically decides which functions are simple enough to be worth integrating
7754 in this way.  This inlining applies to all functions, even those not declared
7755 inline.
7757 Enabled at level @option{-O2}.
7759 @item -findirect-inlining
7760 @opindex findirect-inlining
7761 Inline also indirect calls that are discovered to be known at compile
7762 time thanks to previous inlining.  This option has any effect only
7763 when inlining itself is turned on by the @option{-finline-functions}
7764 or @option{-finline-small-functions} options.
7766 Enabled at level @option{-O2}.
7768 @item -finline-functions
7769 @opindex finline-functions
7770 Consider all functions for inlining, even if they are not declared inline.
7771 The compiler heuristically decides which functions are worth integrating
7772 in this way.
7774 If all calls to a given function are integrated, and the function is
7775 declared @code{static}, then the function is normally not output as
7776 assembler code in its own right.
7778 Enabled at level @option{-O3}.
7780 @item -finline-functions-called-once
7781 @opindex finline-functions-called-once
7782 Consider all @code{static} functions called once for inlining into their
7783 caller even if they are not marked @code{inline}.  If a call to a given
7784 function is integrated, then the function is not output as assembler code
7785 in its own right.
7787 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7789 @item -fearly-inlining
7790 @opindex fearly-inlining
7791 Inline functions marked by @code{always_inline} and functions whose body seems
7792 smaller than the function call overhead early before doing
7793 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7794 makes profiling significantly cheaper and usually inlining faster on programs
7795 having large chains of nested wrapper functions.
7797 Enabled by default.
7799 @item -fipa-sra
7800 @opindex fipa-sra
7801 Perform interprocedural scalar replacement of aggregates, removal of
7802 unused parameters and replacement of parameters passed by reference
7803 by parameters passed by value.
7805 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7807 @item -finline-limit=@var{n}
7808 @opindex finline-limit
7809 By default, GCC limits the size of functions that can be inlined.  This flag
7810 allows coarse control of this limit.  @var{n} is the size of functions that
7811 can be inlined in number of pseudo instructions.
7813 Inlining is actually controlled by a number of parameters, which may be
7814 specified individually by using @option{--param @var{name}=@var{value}}.
7815 The @option{-finline-limit=@var{n}} option sets some of these parameters
7816 as follows:
7818 @table @gcctabopt
7819 @item max-inline-insns-single
7820 is set to @var{n}/2.
7821 @item max-inline-insns-auto
7822 is set to @var{n}/2.
7823 @end table
7825 See below for a documentation of the individual
7826 parameters controlling inlining and for the defaults of these parameters.
7828 @emph{Note:} there may be no value to @option{-finline-limit} that results
7829 in default behavior.
7831 @emph{Note:} pseudo instruction represents, in this particular context, an
7832 abstract measurement of function's size.  In no way does it represent a count
7833 of assembly instructions and as such its exact meaning might change from one
7834 release to an another.
7836 @item -fno-keep-inline-dllexport
7837 @opindex fno-keep-inline-dllexport
7838 This is a more fine-grained version of @option{-fkeep-inline-functions},
7839 which applies only to functions that are declared using the @code{dllexport}
7840 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7841 Functions}.)
7843 @item -fkeep-inline-functions
7844 @opindex fkeep-inline-functions
7845 In C, emit @code{static} functions that are declared @code{inline}
7846 into the object file, even if the function has been inlined into all
7847 of its callers.  This switch does not affect functions using the
7848 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7849 inline functions into the object file.
7851 @item -fkeep-static-consts
7852 @opindex fkeep-static-consts
7853 Emit variables declared @code{static const} when optimization isn't turned
7854 on, even if the variables aren't referenced.
7856 GCC enables this option by default.  If you want to force the compiler to
7857 check if a variable is referenced, regardless of whether or not
7858 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7860 @item -fmerge-constants
7861 @opindex fmerge-constants
7862 Attempt to merge identical constants (string constants and floating-point
7863 constants) across compilation units.
7865 This option is the default for optimized compilation if the assembler and
7866 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7867 behavior.
7869 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7871 @item -fmerge-all-constants
7872 @opindex fmerge-all-constants
7873 Attempt to merge identical constants and identical variables.
7875 This option implies @option{-fmerge-constants}.  In addition to
7876 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7877 arrays or initialized constant variables with integral or floating-point
7878 types.  Languages like C or C++ require each variable, including multiple
7879 instances of the same variable in recursive calls, to have distinct locations,
7880 so using this option results in non-conforming
7881 behavior.
7883 @item -fmodulo-sched
7884 @opindex fmodulo-sched
7885 Perform swing modulo scheduling immediately before the first scheduling
7886 pass.  This pass looks at innermost loops and reorders their
7887 instructions by overlapping different iterations.
7889 @item -fmodulo-sched-allow-regmoves
7890 @opindex fmodulo-sched-allow-regmoves
7891 Perform more aggressive SMS-based modulo scheduling with register moves
7892 allowed.  By setting this flag certain anti-dependences edges are
7893 deleted, which triggers the generation of reg-moves based on the
7894 life-range analysis.  This option is effective only with
7895 @option{-fmodulo-sched} enabled.
7897 @item -fno-branch-count-reg
7898 @opindex fno-branch-count-reg
7899 Do not use ``decrement and branch'' instructions on a count register,
7900 but instead generate a sequence of instructions that decrement a
7901 register, compare it against zero, then branch based upon the result.
7902 This option is only meaningful on architectures that support such
7903 instructions, which include x86, PowerPC, IA-64 and S/390.
7905 Enabled by default at @option{-O1} and higher.
7907 The default is @option{-fbranch-count-reg}.
7909 @item -fno-function-cse
7910 @opindex fno-function-cse
7911 Do not put function addresses in registers; make each instruction that
7912 calls a constant function contain the function's address explicitly.
7914 This option results in less efficient code, but some strange hacks
7915 that alter the assembler output may be confused by the optimizations
7916 performed when this option is not used.
7918 The default is @option{-ffunction-cse}
7920 @item -fno-zero-initialized-in-bss
7921 @opindex fno-zero-initialized-in-bss
7922 If the target supports a BSS section, GCC by default puts variables that
7923 are initialized to zero into BSS@.  This can save space in the resulting
7924 code.
7926 This option turns off this behavior because some programs explicitly
7927 rely on variables going to the data section---e.g., so that the
7928 resulting executable can find the beginning of that section and/or make
7929 assumptions based on that.
7931 The default is @option{-fzero-initialized-in-bss}.
7933 @item -fthread-jumps
7934 @opindex fthread-jumps
7935 Perform optimizations that check to see if a jump branches to a
7936 location where another comparison subsumed by the first is found.  If
7937 so, the first branch is redirected to either the destination of the
7938 second branch or a point immediately following it, depending on whether
7939 the condition is known to be true or false.
7941 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7943 @item -fsplit-wide-types
7944 @opindex fsplit-wide-types
7945 When using a type that occupies multiple registers, such as @code{long
7946 long} on a 32-bit system, split the registers apart and allocate them
7947 independently.  This normally generates better code for those types,
7948 but may make debugging more difficult.
7950 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7951 @option{-Os}.
7953 @item -fcse-follow-jumps
7954 @opindex fcse-follow-jumps
7955 In common subexpression elimination (CSE), scan through jump instructions
7956 when the target of the jump is not reached by any other path.  For
7957 example, when CSE encounters an @code{if} statement with an
7958 @code{else} clause, CSE follows the jump when the condition
7959 tested is false.
7961 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7963 @item -fcse-skip-blocks
7964 @opindex fcse-skip-blocks
7965 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7966 follow jumps that conditionally skip over blocks.  When CSE
7967 encounters a simple @code{if} statement with no else clause,
7968 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7969 body of the @code{if}.
7971 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7973 @item -frerun-cse-after-loop
7974 @opindex frerun-cse-after-loop
7975 Re-run common subexpression elimination after loop optimizations are
7976 performed.
7978 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7980 @item -fgcse
7981 @opindex fgcse
7982 Perform a global common subexpression elimination pass.
7983 This pass also performs global constant and copy propagation.
7985 @emph{Note:} When compiling a program using computed gotos, a GCC
7986 extension, you may get better run-time performance if you disable
7987 the global common subexpression elimination pass by adding
7988 @option{-fno-gcse} to the command line.
7990 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7992 @item -fgcse-lm
7993 @opindex fgcse-lm
7994 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7995 attempts to move loads that are only killed by stores into themselves.  This
7996 allows a loop containing a load/store sequence to be changed to a load outside
7997 the loop, and a copy/store within the loop.
7999 Enabled by default when @option{-fgcse} is enabled.
8001 @item -fgcse-sm
8002 @opindex fgcse-sm
8003 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8004 global common subexpression elimination.  This pass attempts to move
8005 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8006 loops containing a load/store sequence can be changed to a load before
8007 the loop and a store after the loop.
8009 Not enabled at any optimization level.
8011 @item -fgcse-las
8012 @opindex fgcse-las
8013 When @option{-fgcse-las} is enabled, the global common subexpression
8014 elimination pass eliminates redundant loads that come after stores to the
8015 same memory location (both partial and full redundancies).
8017 Not enabled at any optimization level.
8019 @item -fgcse-after-reload
8020 @opindex fgcse-after-reload
8021 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8022 pass is performed after reload.  The purpose of this pass is to clean up
8023 redundant spilling.
8025 @item -faggressive-loop-optimizations
8026 @opindex faggressive-loop-optimizations
8027 This option tells the loop optimizer to use language constraints to
8028 derive bounds for the number of iterations of a loop.  This assumes that
8029 loop code does not invoke undefined behavior by for example causing signed
8030 integer overflows or out-of-bound array accesses.  The bounds for the
8031 number of iterations of a loop are used to guide loop unrolling and peeling
8032 and loop exit test optimizations.
8033 This option is enabled by default.
8035 @item -funsafe-loop-optimizations
8036 @opindex funsafe-loop-optimizations
8037 This option tells the loop optimizer to assume that loop indices do not
8038 overflow, and that loops with nontrivial exit condition are not
8039 infinite.  This enables a wider range of loop optimizations even if
8040 the loop optimizer itself cannot prove that these assumptions are valid.
8041 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
8042 if it finds this kind of loop.
8044 @item -fcrossjumping
8045 @opindex fcrossjumping
8046 Perform cross-jumping transformation.
8047 This transformation unifies equivalent code and saves code size.  The
8048 resulting code may or may not perform better than without cross-jumping.
8050 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8052 @item -fauto-inc-dec
8053 @opindex fauto-inc-dec
8054 Combine increments or decrements of addresses with memory accesses.
8055 This pass is always skipped on architectures that do not have
8056 instructions to support this.  Enabled by default at @option{-O} and
8057 higher on architectures that support this.
8059 @item -fdce
8060 @opindex fdce
8061 Perform dead code elimination (DCE) on RTL@.
8062 Enabled by default at @option{-O} and higher.
8064 @item -fdse
8065 @opindex fdse
8066 Perform dead store elimination (DSE) on RTL@.
8067 Enabled by default at @option{-O} and higher.
8069 @item -fif-conversion
8070 @opindex fif-conversion
8071 Attempt to transform conditional jumps into branch-less equivalents.  This
8072 includes use of conditional moves, min, max, set flags and abs instructions, and
8073 some tricks doable by standard arithmetics.  The use of conditional execution
8074 on chips where it is available is controlled by @option{-fif-conversion2}.
8076 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8078 @item -fif-conversion2
8079 @opindex fif-conversion2
8080 Use conditional execution (where available) to transform conditional jumps into
8081 branch-less equivalents.
8083 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8085 @item -fdeclone-ctor-dtor
8086 @opindex fdeclone-ctor-dtor
8087 The C++ ABI requires multiple entry points for constructors and
8088 destructors: one for a base subobject, one for a complete object, and
8089 one for a virtual destructor that calls operator delete afterwards.
8090 For a hierarchy with virtual bases, the base and complete variants are
8091 clones, which means two copies of the function.  With this option, the
8092 base and complete variants are changed to be thunks that call a common
8093 implementation.
8095 Enabled by @option{-Os}.
8097 @item -fdelete-null-pointer-checks
8098 @opindex fdelete-null-pointer-checks
8099 Assume that programs cannot safely dereference null pointers, and that
8100 no code or data element resides at address zero.
8101 This option enables simple constant
8102 folding optimizations at all optimization levels.  In addition, other
8103 optimization passes in GCC use this flag to control global dataflow
8104 analyses that eliminate useless checks for null pointers; these assume
8105 that a memory access to address zero always results in a trap, so
8106 that if a pointer is checked after it has already been dereferenced,
8107 it cannot be null.
8109 Note however that in some environments this assumption is not true.
8110 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8111 for programs that depend on that behavior.
8113 This option is enabled by default on most targets.  On Nios II ELF, it
8114 defaults to off.  On AVR and CR16, this option is completely disabled.  
8116 Passes that use the dataflow information
8117 are enabled independently at different optimization levels.
8119 @item -fdevirtualize
8120 @opindex fdevirtualize
8121 Attempt to convert calls to virtual functions to direct calls.  This
8122 is done both within a procedure and interprocedurally as part of
8123 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8124 propagation (@option{-fipa-cp}).
8125 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8127 @item -fdevirtualize-speculatively
8128 @opindex fdevirtualize-speculatively
8129 Attempt to convert calls to virtual functions to speculative direct calls.
8130 Based on the analysis of the type inheritance graph, determine for a given call
8131 the set of likely targets. If the set is small, preferably of size 1, change
8132 the call into a conditional deciding between direct and indirect calls.  The
8133 speculative calls enable more optimizations, such as inlining.  When they seem
8134 useless after further optimization, they are converted back into original form.
8136 @item -fdevirtualize-at-ltrans
8137 @opindex fdevirtualize-at-ltrans
8138 Stream extra information needed for aggressive devirtualization when running
8139 the link-time optimizer in local transformation mode.  
8140 This option enables more devirtualization but
8141 significantly increases the size of streamed data. For this reason it is
8142 disabled by default.
8144 @item -fexpensive-optimizations
8145 @opindex fexpensive-optimizations
8146 Perform a number of minor optimizations that are relatively expensive.
8148 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8150 @item -free
8151 @opindex free
8152 Attempt to remove redundant extension instructions.  This is especially
8153 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8154 registers after writing to their lower 32-bit half.
8156 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8157 @option{-O3}, @option{-Os}.
8159 @item -fno-lifetime-dse
8160 @opindex fno-lifetime-dse
8161 In C++ the value of an object is only affected by changes within its
8162 lifetime: when the constructor begins, the object has an indeterminate
8163 value, and any changes during the lifetime of the object are dead when
8164 the object is destroyed.  Normally dead store elimination will take
8165 advantage of this; if your code relies on the value of the object
8166 storage persisting beyond the lifetime of the object, you can use this
8167 flag to disable this optimization.
8169 @item -flive-range-shrinkage
8170 @opindex flive-range-shrinkage
8171 Attempt to decrease register pressure through register live range
8172 shrinkage.  This is helpful for fast processors with small or moderate
8173 size register sets.
8175 @item -fira-algorithm=@var{algorithm}
8176 @opindex fira-algorithm
8177 Use the specified coloring algorithm for the integrated register
8178 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8179 specifies Chow's priority coloring, or @samp{CB}, which specifies
8180 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8181 for all architectures, but for those targets that do support it, it is
8182 the default because it generates better code.
8184 @item -fira-region=@var{region}
8185 @opindex fira-region
8186 Use specified regions for the integrated register allocator.  The
8187 @var{region} argument should be one of the following:
8189 @table @samp
8191 @item all
8192 Use all loops as register allocation regions.
8193 This can give the best results for machines with a small and/or
8194 irregular register set.
8196 @item mixed
8197 Use all loops except for loops with small register pressure 
8198 as the regions.  This value usually gives
8199 the best results in most cases and for most architectures,
8200 and is enabled by default when compiling with optimization for speed
8201 (@option{-O}, @option{-O2}, @dots{}).
8203 @item one
8204 Use all functions as a single region.  
8205 This typically results in the smallest code size, and is enabled by default for
8206 @option{-Os} or @option{-O0}.
8208 @end table
8210 @item -fira-hoist-pressure
8211 @opindex fira-hoist-pressure
8212 Use IRA to evaluate register pressure in the code hoisting pass for
8213 decisions to hoist expressions.  This option usually results in smaller
8214 code, but it can slow the compiler down.
8216 This option is enabled at level @option{-Os} for all targets.
8218 @item -fira-loop-pressure
8219 @opindex fira-loop-pressure
8220 Use IRA to evaluate register pressure in loops for decisions to move
8221 loop invariants.  This option usually results in generation
8222 of faster and smaller code on machines with large register files (>= 32
8223 registers), but it can slow the compiler down.
8225 This option is enabled at level @option{-O3} for some targets.
8227 @item -fno-ira-share-save-slots
8228 @opindex fno-ira-share-save-slots
8229 Disable sharing of stack slots used for saving call-used hard
8230 registers living through a call.  Each hard register gets a
8231 separate stack slot, and as a result function stack frames are
8232 larger.
8234 @item -fno-ira-share-spill-slots
8235 @opindex fno-ira-share-spill-slots
8236 Disable sharing of stack slots allocated for pseudo-registers.  Each
8237 pseudo-register that does not get a hard register gets a separate
8238 stack slot, and as a result function stack frames are larger.
8240 @item -fira-verbose=@var{n}
8241 @opindex fira-verbose
8242 Control the verbosity of the dump file for the integrated register allocator.
8243 The default value is 5.  If the value @var{n} is greater or equal to 10,
8244 the dump output is sent to stderr using the same format as @var{n} minus 10.
8246 @item -flra-remat
8247 @opindex flra-remat
8248 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8249 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8250 values if it is profitable.
8252 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8254 @item -fdelayed-branch
8255 @opindex fdelayed-branch
8256 If supported for the target machine, attempt to reorder instructions
8257 to exploit instruction slots available after delayed branch
8258 instructions.
8260 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8262 @item -fschedule-insns
8263 @opindex fschedule-insns
8264 If supported for the target machine, attempt to reorder instructions to
8265 eliminate execution stalls due to required data being unavailable.  This
8266 helps machines that have slow floating point or memory load instructions
8267 by allowing other instructions to be issued until the result of the load
8268 or floating-point instruction is required.
8270 Enabled at levels @option{-O2}, @option{-O3}.
8272 @item -fschedule-insns2
8273 @opindex fschedule-insns2
8274 Similar to @option{-fschedule-insns}, but requests an additional pass of
8275 instruction scheduling after register allocation has been done.  This is
8276 especially useful on machines with a relatively small number of
8277 registers and where memory load instructions take more than one cycle.
8279 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8281 @item -fno-sched-interblock
8282 @opindex fno-sched-interblock
8283 Don't schedule instructions across basic blocks.  This is normally
8284 enabled by default when scheduling before register allocation, i.e.@:
8285 with @option{-fschedule-insns} or at @option{-O2} or higher.
8287 @item -fno-sched-spec
8288 @opindex fno-sched-spec
8289 Don't allow speculative motion of non-load instructions.  This is normally
8290 enabled by default when scheduling before register allocation, i.e.@:
8291 with @option{-fschedule-insns} or at @option{-O2} or higher.
8293 @item -fsched-pressure
8294 @opindex fsched-pressure
8295 Enable register pressure sensitive insn scheduling before register
8296 allocation.  This only makes sense when scheduling before register
8297 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8298 @option{-O2} or higher.  Usage of this option can improve the
8299 generated code and decrease its size by preventing register pressure
8300 increase above the number of available hard registers and subsequent
8301 spills in register allocation.
8303 @item -fsched-spec-load
8304 @opindex fsched-spec-load
8305 Allow speculative motion of some load instructions.  This only makes
8306 sense when scheduling before register allocation, i.e.@: with
8307 @option{-fschedule-insns} or at @option{-O2} or higher.
8309 @item -fsched-spec-load-dangerous
8310 @opindex fsched-spec-load-dangerous
8311 Allow speculative motion of more load instructions.  This only makes
8312 sense when scheduling before register allocation, i.e.@: with
8313 @option{-fschedule-insns} or at @option{-O2} or higher.
8315 @item -fsched-stalled-insns
8316 @itemx -fsched-stalled-insns=@var{n}
8317 @opindex fsched-stalled-insns
8318 Define how many insns (if any) can be moved prematurely from the queue
8319 of stalled insns into the ready list during the second scheduling pass.
8320 @option{-fno-sched-stalled-insns} means that no insns are moved
8321 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8322 on how many queued insns can be moved prematurely.
8323 @option{-fsched-stalled-insns} without a value is equivalent to
8324 @option{-fsched-stalled-insns=1}.
8326 @item -fsched-stalled-insns-dep
8327 @itemx -fsched-stalled-insns-dep=@var{n}
8328 @opindex fsched-stalled-insns-dep
8329 Define how many insn groups (cycles) are examined for a dependency
8330 on a stalled insn that is a candidate for premature removal from the queue
8331 of stalled insns.  This has an effect only during the second scheduling pass,
8332 and only if @option{-fsched-stalled-insns} is used.
8333 @option{-fno-sched-stalled-insns-dep} is equivalent to
8334 @option{-fsched-stalled-insns-dep=0}.
8335 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8336 @option{-fsched-stalled-insns-dep=1}.
8338 @item -fsched2-use-superblocks
8339 @opindex fsched2-use-superblocks
8340 When scheduling after register allocation, use superblock scheduling.
8341 This allows motion across basic block boundaries,
8342 resulting in faster schedules.  This option is experimental, as not all machine
8343 descriptions used by GCC model the CPU closely enough to avoid unreliable
8344 results from the algorithm.
8346 This only makes sense when scheduling after register allocation, i.e.@: with
8347 @option{-fschedule-insns2} or at @option{-O2} or higher.
8349 @item -fsched-group-heuristic
8350 @opindex fsched-group-heuristic
8351 Enable the group heuristic in the scheduler.  This heuristic favors
8352 the instruction that belongs to a schedule group.  This is enabled
8353 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8354 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8356 @item -fsched-critical-path-heuristic
8357 @opindex fsched-critical-path-heuristic
8358 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8359 instructions on the critical path.  This is enabled by default when
8360 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8361 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8363 @item -fsched-spec-insn-heuristic
8364 @opindex fsched-spec-insn-heuristic
8365 Enable the speculative instruction heuristic in the scheduler.  This
8366 heuristic favors speculative instructions with greater dependency weakness.
8367 This is enabled by default when scheduling is enabled, i.e.@:
8368 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8369 or at @option{-O2} or higher.
8371 @item -fsched-rank-heuristic
8372 @opindex fsched-rank-heuristic
8373 Enable the rank heuristic in the scheduler.  This heuristic favors
8374 the instruction belonging to a basic block with greater size or frequency.
8375 This is enabled by default when scheduling is enabled, i.e.@:
8376 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8377 at @option{-O2} or higher.
8379 @item -fsched-last-insn-heuristic
8380 @opindex fsched-last-insn-heuristic
8381 Enable the last-instruction heuristic in the scheduler.  This heuristic
8382 favors the instruction that is less dependent on the last instruction
8383 scheduled.  This is enabled by default when scheduling is enabled,
8384 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8385 at @option{-O2} or higher.
8387 @item -fsched-dep-count-heuristic
8388 @opindex fsched-dep-count-heuristic
8389 Enable the dependent-count heuristic in the scheduler.  This heuristic
8390 favors the instruction that has more instructions depending on it.
8391 This is enabled by default when scheduling is enabled, i.e.@:
8392 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8393 at @option{-O2} or higher.
8395 @item -freschedule-modulo-scheduled-loops
8396 @opindex freschedule-modulo-scheduled-loops
8397 Modulo scheduling is performed before traditional scheduling.  If a loop
8398 is modulo scheduled, later scheduling passes may change its schedule.  
8399 Use this option to control that behavior.
8401 @item -fselective-scheduling
8402 @opindex fselective-scheduling
8403 Schedule instructions using selective scheduling algorithm.  Selective
8404 scheduling runs instead of the first scheduler pass.
8406 @item -fselective-scheduling2
8407 @opindex fselective-scheduling2
8408 Schedule instructions using selective scheduling algorithm.  Selective
8409 scheduling runs instead of the second scheduler pass.
8411 @item -fsel-sched-pipelining
8412 @opindex fsel-sched-pipelining
8413 Enable software pipelining of innermost loops during selective scheduling.
8414 This option has no effect unless one of @option{-fselective-scheduling} or
8415 @option{-fselective-scheduling2} is turned on.
8417 @item -fsel-sched-pipelining-outer-loops
8418 @opindex fsel-sched-pipelining-outer-loops
8419 When pipelining loops during selective scheduling, also pipeline outer loops.
8420 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8422 @item -fsemantic-interposition
8423 @opindex fsemantic-interposition
8424 Some object formats, like ELF, allow interposing of symbols by the 
8425 dynamic linker.
8426 This means that for symbols exported from the DSO, the compiler cannot perform
8427 interprocedural propagation, inlining and other optimizations in anticipation
8428 that the function or variable in question may change. While this feature is
8429 useful, for example, to rewrite memory allocation functions by a debugging
8430 implementation, it is expensive in the terms of code quality.
8431 With @option{-fno-semantic-interposition} the compiler assumes that 
8432 if interposition happens for functions the overwriting function will have 
8433 precisely the same semantics (and side effects). 
8434 Similarly if interposition happens
8435 for variables, the constructor of the variable will be the same. The flag
8436 has no effect for functions explicitly declared inline 
8437 (where it is never allowed for interposition to change semantics) 
8438 and for symbols explicitly declared weak.
8440 @item -fshrink-wrap
8441 @opindex fshrink-wrap
8442 Emit function prologues only before parts of the function that need it,
8443 rather than at the top of the function.  This flag is enabled by default at
8444 @option{-O} and higher.
8446 @item -fcaller-saves
8447 @opindex fcaller-saves
8448 Enable allocation of values to registers that are clobbered by
8449 function calls, by emitting extra instructions to save and restore the
8450 registers around such calls.  Such allocation is done only when it
8451 seems to result in better code.
8453 This option is always enabled by default on certain machines, usually
8454 those which have no call-preserved registers to use instead.
8456 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8458 @item -fcombine-stack-adjustments
8459 @opindex fcombine-stack-adjustments
8460 Tracks stack adjustments (pushes and pops) and stack memory references
8461 and then tries to find ways to combine them.
8463 Enabled by default at @option{-O1} and higher.
8465 @item -fipa-ra
8466 @opindex fipa-ra
8467 Use caller save registers for allocation if those registers are not used by
8468 any called function.  In that case it is not necessary to save and restore
8469 them around calls.  This is only possible if called functions are part of
8470 same compilation unit as current function and they are compiled before it.
8472 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8474 @item -fconserve-stack
8475 @opindex fconserve-stack
8476 Attempt to minimize stack usage.  The compiler attempts to use less
8477 stack space, even if that makes the program slower.  This option
8478 implies setting the @option{large-stack-frame} parameter to 100
8479 and the @option{large-stack-frame-growth} parameter to 400.
8481 @item -ftree-reassoc
8482 @opindex ftree-reassoc
8483 Perform reassociation on trees.  This flag is enabled by default
8484 at @option{-O} and higher.
8486 @item -ftree-pre
8487 @opindex ftree-pre
8488 Perform partial redundancy elimination (PRE) on trees.  This flag is
8489 enabled by default at @option{-O2} and @option{-O3}.
8491 @item -ftree-partial-pre
8492 @opindex ftree-partial-pre
8493 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8494 enabled by default at @option{-O3}.
8496 @item -ftree-forwprop
8497 @opindex ftree-forwprop
8498 Perform forward propagation on trees.  This flag is enabled by default
8499 at @option{-O} and higher.
8501 @item -ftree-fre
8502 @opindex ftree-fre
8503 Perform full redundancy elimination (FRE) on trees.  The difference
8504 between FRE and PRE is that FRE only considers expressions
8505 that are computed on all paths leading to the redundant computation.
8506 This analysis is faster than PRE, though it exposes fewer redundancies.
8507 This flag is enabled by default at @option{-O} and higher.
8509 @item -ftree-phiprop
8510 @opindex ftree-phiprop
8511 Perform hoisting of loads from conditional pointers on trees.  This
8512 pass is enabled by default at @option{-O} and higher.
8514 @item -fhoist-adjacent-loads
8515 @opindex fhoist-adjacent-loads
8516 Speculatively hoist loads from both branches of an if-then-else if the
8517 loads are from adjacent locations in the same structure and the target
8518 architecture has a conditional move instruction.  This flag is enabled
8519 by default at @option{-O2} and higher.
8521 @item -ftree-copy-prop
8522 @opindex ftree-copy-prop
8523 Perform copy propagation on trees.  This pass eliminates unnecessary
8524 copy operations.  This flag is enabled by default at @option{-O} and
8525 higher.
8527 @item -fipa-pure-const
8528 @opindex fipa-pure-const
8529 Discover which functions are pure or constant.
8530 Enabled by default at @option{-O} and higher.
8532 @item -fipa-reference
8533 @opindex fipa-reference
8534 Discover which static variables do not escape the
8535 compilation unit.
8536 Enabled by default at @option{-O} and higher.
8538 @item -fipa-pta
8539 @opindex fipa-pta
8540 Perform interprocedural pointer analysis and interprocedural modification
8541 and reference analysis.  This option can cause excessive memory and
8542 compile-time usage on large compilation units.  It is not enabled by
8543 default at any optimization level.
8545 @item -fipa-profile
8546 @opindex fipa-profile
8547 Perform interprocedural profile propagation.  The functions called only from
8548 cold functions are marked as cold. Also functions executed once (such as
8549 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8550 functions and loop less parts of functions executed once are then optimized for
8551 size.
8552 Enabled by default at @option{-O} and higher.
8554 @item -fipa-cp
8555 @opindex fipa-cp
8556 Perform interprocedural constant propagation.
8557 This optimization analyzes the program to determine when values passed
8558 to functions are constants and then optimizes accordingly.
8559 This optimization can substantially increase performance
8560 if the application has constants passed to functions.
8561 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8563 @item -fipa-cp-clone
8564 @opindex fipa-cp-clone
8565 Perform function cloning to make interprocedural constant propagation stronger.
8566 When enabled, interprocedural constant propagation performs function cloning
8567 when externally visible function can be called with constant arguments.
8568 Because this optimization can create multiple copies of functions,
8569 it may significantly increase code size
8570 (see @option{--param ipcp-unit-growth=@var{value}}).
8571 This flag is enabled by default at @option{-O3}.
8573 @item -fipa-cp-alignment
8574 @opindex -fipa-cp-alignment
8575 When enabled, this optimization propagates alignment of function
8576 parameters to support better vectorization and string operations.
8578 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8579 requires that @option{-fipa-cp} is enabled.
8581 @item -fipa-icf
8582 @opindex fipa-icf
8583 Perform Identical Code Folding for functions and read-only variables.
8584 The optimization reduces code size and may disturb unwind stacks by replacing
8585 a function by equivalent one with a different name. The optimization works
8586 more effectively with link time optimization enabled.
8588 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8589 works on different levels and thus the optimizations are not same - there are
8590 equivalences that are found only by GCC and equivalences found only by Gold.
8592 This flag is enabled by default at @option{-O2} and @option{-Os}.
8594 @item -fisolate-erroneous-paths-dereference
8595 @opindex fisolate-erroneous-paths-dereference
8596 Detect paths that trigger erroneous or undefined behavior due to
8597 dereferencing a null pointer.  Isolate those paths from the main control
8598 flow and turn the statement with erroneous or undefined behavior into a trap.
8599 This flag is enabled by default at @option{-O2} and higher and depends on
8600 @option{-fdelete-null-pointer-checks} also being enabled.
8602 @item -fisolate-erroneous-paths-attribute
8603 @opindex fisolate-erroneous-paths-attribute
8604 Detect paths that trigger erroneous or undefined behavior due a null value
8605 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8606 attribute.  Isolate those paths from the main control flow and turn the
8607 statement with erroneous or undefined behavior into a trap.  This is not
8608 currently enabled, but may be enabled by @option{-O2} in the future.
8610 @item -ftree-sink
8611 @opindex ftree-sink
8612 Perform forward store motion  on trees.  This flag is
8613 enabled by default at @option{-O} and higher.
8615 @item -ftree-bit-ccp
8616 @opindex ftree-bit-ccp
8617 Perform sparse conditional bit constant propagation on trees and propagate
8618 pointer alignment information.
8619 This pass only operates on local scalar variables and is enabled by default
8620 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8622 @item -ftree-ccp
8623 @opindex ftree-ccp
8624 Perform sparse conditional constant propagation (CCP) on trees.  This
8625 pass only operates on local scalar variables and is enabled by default
8626 at @option{-O} and higher.
8628 @item -fssa-phiopt
8629 @opindex fssa-phiopt
8630 Perform pattern matching on SSA PHI nodes to optimize conditional
8631 code.  This pass is enabled by default at @option{-O} and higher.
8633 @item -ftree-switch-conversion
8634 @opindex ftree-switch-conversion
8635 Perform conversion of simple initializations in a switch to
8636 initializations from a scalar array.  This flag is enabled by default
8637 at @option{-O2} and higher.
8639 @item -ftree-tail-merge
8640 @opindex ftree-tail-merge
8641 Look for identical code sequences.  When found, replace one with a jump to the
8642 other.  This optimization is known as tail merging or cross jumping.  This flag
8643 is enabled by default at @option{-O2} and higher.  The compilation time
8644 in this pass can
8645 be limited using @option{max-tail-merge-comparisons} parameter and
8646 @option{max-tail-merge-iterations} parameter.
8648 @item -ftree-dce
8649 @opindex ftree-dce
8650 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8651 default at @option{-O} and higher.
8653 @item -ftree-builtin-call-dce
8654 @opindex ftree-builtin-call-dce
8655 Perform conditional dead code elimination (DCE) for calls to built-in functions
8656 that may set @code{errno} but are otherwise side-effect free.  This flag is
8657 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8658 specified.
8660 @item -ftree-dominator-opts
8661 @opindex ftree-dominator-opts
8662 Perform a variety of simple scalar cleanups (constant/copy
8663 propagation, redundancy elimination, range propagation and expression
8664 simplification) based on a dominator tree traversal.  This also
8665 performs jump threading (to reduce jumps to jumps). This flag is
8666 enabled by default at @option{-O} and higher.
8668 @item -ftree-dse
8669 @opindex ftree-dse
8670 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8671 a memory location that is later overwritten by another store without
8672 any intervening loads.  In this case the earlier store can be deleted.  This
8673 flag is enabled by default at @option{-O} and higher.
8675 @item -ftree-ch
8676 @opindex ftree-ch
8677 Perform loop header copying on trees.  This is beneficial since it increases
8678 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8679 is enabled by default at @option{-O} and higher.  It is not enabled
8680 for @option{-Os}, since it usually increases code size.
8682 @item -ftree-loop-optimize
8683 @opindex ftree-loop-optimize
8684 Perform loop optimizations on trees.  This flag is enabled by default
8685 at @option{-O} and higher.
8687 @item -ftree-loop-linear
8688 @opindex ftree-loop-linear
8689 Perform loop interchange transformations on tree.  Same as
8690 @option{-floop-interchange}.  To use this code transformation, GCC has
8691 to be configured with @option{--with-isl} to enable the Graphite loop
8692 transformation infrastructure.
8694 @item -floop-interchange
8695 @opindex floop-interchange
8696 Perform loop interchange transformations on loops.  Interchanging two
8697 nested loops switches the inner and outer loops.  For example, given a
8698 loop like:
8699 @smallexample
8700 DO J = 1, M
8701   DO I = 1, N
8702     A(J, I) = A(J, I) * C
8703   ENDDO
8704 ENDDO
8705 @end smallexample
8706 @noindent
8707 loop interchange transforms the loop as if it were written:
8708 @smallexample
8709 DO I = 1, N
8710   DO J = 1, M
8711     A(J, I) = A(J, I) * C
8712   ENDDO
8713 ENDDO
8714 @end smallexample
8715 which can be beneficial when @code{N} is larger than the caches,
8716 because in Fortran, the elements of an array are stored in memory
8717 contiguously by column, and the original loop iterates over rows,
8718 potentially creating at each access a cache miss.  This optimization
8719 applies to all the languages supported by GCC and is not limited to
8720 Fortran.  To use this code transformation, GCC has to be configured
8721 with @option{--with-isl} to enable the Graphite loop transformation
8722 infrastructure.
8724 @item -floop-strip-mine
8725 @opindex floop-strip-mine
8726 Perform loop strip mining transformations on loops.  Strip mining
8727 splits a loop into two nested loops.  The outer loop has strides
8728 equal to the strip size and the inner loop has strides of the
8729 original loop within a strip.  The strip length can be changed
8730 using the @option{loop-block-tile-size} parameter.  For example,
8731 given a loop like:
8732 @smallexample
8733 DO I = 1, N
8734   A(I) = A(I) + C
8735 ENDDO
8736 @end smallexample
8737 @noindent
8738 loop strip mining transforms the loop as if it were written:
8739 @smallexample
8740 DO II = 1, N, 51
8741   DO I = II, min (II + 50, N)
8742     A(I) = A(I) + C
8743   ENDDO
8744 ENDDO
8745 @end smallexample
8746 This optimization applies to all the languages supported by GCC and is
8747 not limited to Fortran.  To use this code transformation, GCC has to
8748 be configured with @option{--with-isl} to enable the Graphite loop
8749 transformation infrastructure.
8751 @item -floop-block
8752 @opindex floop-block
8753 Perform loop blocking transformations on loops.  Blocking strip mines
8754 each loop in the loop nest such that the memory accesses of the
8755 element loops fit inside caches.  The strip length can be changed
8756 using the @option{loop-block-tile-size} parameter.  For example, given
8757 a loop like:
8758 @smallexample
8759 DO I = 1, N
8760   DO J = 1, M
8761     A(J, I) = B(I) + C(J)
8762   ENDDO
8763 ENDDO
8764 @end smallexample
8765 @noindent
8766 loop blocking transforms the loop as if it were written:
8767 @smallexample
8768 DO II = 1, N, 51
8769   DO JJ = 1, M, 51
8770     DO I = II, min (II + 50, N)
8771       DO J = JJ, min (JJ + 50, M)
8772         A(J, I) = B(I) + C(J)
8773       ENDDO
8774     ENDDO
8775   ENDDO
8776 ENDDO
8777 @end smallexample
8778 which can be beneficial when @code{M} is larger than the caches,
8779 because the innermost loop iterates over a smaller amount of data
8780 which can be kept in the caches.  This optimization applies to all the
8781 languages supported by GCC and is not limited to Fortran.  To use this
8782 code transformation, GCC has to be configured with @option{--with-isl}
8783 to enable the Graphite loop transformation infrastructure.
8785 @item -fgraphite-identity
8786 @opindex fgraphite-identity
8787 Enable the identity transformation for graphite.  For every SCoP we generate
8788 the polyhedral representation and transform it back to gimple.  Using
8789 @option{-fgraphite-identity} we can check the costs or benefits of the
8790 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8791 are also performed by the code generator ISL, like index splitting and
8792 dead code elimination in loops.
8794 @item -floop-nest-optimize
8795 @opindex floop-nest-optimize
8796 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8797 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8798 structure optimized for data-locality and parallelism.  This option
8799 is experimental.
8801 @item -floop-unroll-and-jam
8802 @opindex floop-unroll-and-jam
8803 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8804 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8805 The unrolled dimension (counting from the most inner one) can be changed 
8806 using the @option{loop-unroll-jam-depth} parameter.                 .
8808 @item -floop-parallelize-all
8809 @opindex floop-parallelize-all
8810 Use the Graphite data dependence analysis to identify loops that can
8811 be parallelized.  Parallelize all the loops that can be analyzed to
8812 not contain loop carried dependences without checking that it is
8813 profitable to parallelize the loops.
8815 @item -fcheck-data-deps
8816 @opindex fcheck-data-deps
8817 Compare the results of several data dependence analyzers.  This option
8818 is used for debugging the data dependence analyzers.
8820 @item -ftree-loop-if-convert
8821 @opindex ftree-loop-if-convert
8822 Attempt to transform conditional jumps in the innermost loops to
8823 branch-less equivalents.  The intent is to remove control-flow from
8824 the innermost loops in order to improve the ability of the
8825 vectorization pass to handle these loops.  This is enabled by default
8826 if vectorization is enabled.
8828 @item -ftree-loop-if-convert-stores
8829 @opindex ftree-loop-if-convert-stores
8830 Attempt to also if-convert conditional jumps containing memory writes.
8831 This transformation can be unsafe for multi-threaded programs as it
8832 transforms conditional memory writes into unconditional memory writes.
8833 For example,
8834 @smallexample
8835 for (i = 0; i < N; i++)
8836   if (cond)
8837     A[i] = expr;
8838 @end smallexample
8839 is transformed to
8840 @smallexample
8841 for (i = 0; i < N; i++)
8842   A[i] = cond ? expr : A[i];
8843 @end smallexample
8844 potentially producing data races.
8846 @item -ftree-loop-distribution
8847 @opindex ftree-loop-distribution
8848 Perform loop distribution.  This flag can improve cache performance on
8849 big loop bodies and allow further loop optimizations, like
8850 parallelization or vectorization, to take place.  For example, the loop
8851 @smallexample
8852 DO I = 1, N
8853   A(I) = B(I) + C
8854   D(I) = E(I) * F
8855 ENDDO
8856 @end smallexample
8857 is transformed to
8858 @smallexample
8859 DO I = 1, N
8860    A(I) = B(I) + C
8861 ENDDO
8862 DO I = 1, N
8863    D(I) = E(I) * F
8864 ENDDO
8865 @end smallexample
8867 @item -ftree-loop-distribute-patterns
8868 @opindex ftree-loop-distribute-patterns
8869 Perform loop distribution of patterns that can be code generated with
8870 calls to a library.  This flag is enabled by default at @option{-O3}.
8872 This pass distributes the initialization loops and generates a call to
8873 memset zero.  For example, the loop
8874 @smallexample
8875 DO I = 1, N
8876   A(I) = 0
8877   B(I) = A(I) + I
8878 ENDDO
8879 @end smallexample
8880 is transformed to
8881 @smallexample
8882 DO I = 1, N
8883    A(I) = 0
8884 ENDDO
8885 DO I = 1, N
8886    B(I) = A(I) + I
8887 ENDDO
8888 @end smallexample
8889 and the initialization loop is transformed into a call to memset zero.
8891 @item -ftree-loop-im
8892 @opindex ftree-loop-im
8893 Perform loop invariant motion on trees.  This pass moves only invariants that
8894 are hard to handle at RTL level (function calls, operations that expand to
8895 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8896 operands of conditions that are invariant out of the loop, so that we can use
8897 just trivial invariantness analysis in loop unswitching.  The pass also includes
8898 store motion.
8900 @item -ftree-loop-ivcanon
8901 @opindex ftree-loop-ivcanon
8902 Create a canonical counter for number of iterations in loops for which
8903 determining number of iterations requires complicated analysis.  Later
8904 optimizations then may determine the number easily.  Useful especially
8905 in connection with unrolling.
8907 @item -fivopts
8908 @opindex fivopts
8909 Perform induction variable optimizations (strength reduction, induction
8910 variable merging and induction variable elimination) on trees.
8912 @item -ftree-parallelize-loops=n
8913 @opindex ftree-parallelize-loops
8914 Parallelize loops, i.e., split their iteration space to run in n threads.
8915 This is only possible for loops whose iterations are independent
8916 and can be arbitrarily reordered.  The optimization is only
8917 profitable on multiprocessor machines, for loops that are CPU-intensive,
8918 rather than constrained e.g.@: by memory bandwidth.  This option
8919 implies @option{-pthread}, and thus is only supported on targets
8920 that have support for @option{-pthread}.
8922 @item -ftree-pta
8923 @opindex ftree-pta
8924 Perform function-local points-to analysis on trees.  This flag is
8925 enabled by default at @option{-O} and higher.
8927 @item -ftree-sra
8928 @opindex ftree-sra
8929 Perform scalar replacement of aggregates.  This pass replaces structure
8930 references with scalars to prevent committing structures to memory too
8931 early.  This flag is enabled by default at @option{-O} and higher.
8933 @item -ftree-copyrename
8934 @opindex ftree-copyrename
8935 Perform copy renaming on trees.  This pass attempts to rename compiler
8936 temporaries to other variables at copy locations, usually resulting in
8937 variable names which more closely resemble the original variables.  This flag
8938 is enabled by default at @option{-O} and higher.
8940 @item -ftree-coalesce-inlined-vars
8941 @opindex ftree-coalesce-inlined-vars
8942 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8943 combine small user-defined variables too, but only if they are inlined
8944 from other functions.  It is a more limited form of
8945 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8946 inlined variables, but it keeps variables of the inlined-into
8947 function apart from each other, such that they are more likely to
8948 contain the expected values in a debugging session.
8950 @item -ftree-coalesce-vars
8951 @opindex ftree-coalesce-vars
8952 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8953 combine small user-defined variables too, instead of just compiler
8954 temporaries.  This may severely limit the ability to debug an optimized
8955 program compiled with @option{-fno-var-tracking-assignments}.  In the
8956 negated form, this flag prevents SSA coalescing of user variables,
8957 including inlined ones.  This option is enabled by default.
8959 @item -ftree-ter
8960 @opindex ftree-ter
8961 Perform temporary expression replacement during the SSA->normal phase.  Single
8962 use/single def temporaries are replaced at their use location with their
8963 defining expression.  This results in non-GIMPLE code, but gives the expanders
8964 much more complex trees to work on resulting in better RTL generation.  This is
8965 enabled by default at @option{-O} and higher.
8967 @item -ftree-slsr
8968 @opindex ftree-slsr
8969 Perform straight-line strength reduction on trees.  This recognizes related
8970 expressions involving multiplications and replaces them by less expensive
8971 calculations when possible.  This is enabled by default at @option{-O} and
8972 higher.
8974 @item -ftree-vectorize
8975 @opindex ftree-vectorize
8976 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8977 and @option{-ftree-slp-vectorize} if not explicitly specified.
8979 @item -ftree-loop-vectorize
8980 @opindex ftree-loop-vectorize
8981 Perform loop vectorization on trees. This flag is enabled by default at
8982 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8984 @item -ftree-slp-vectorize
8985 @opindex ftree-slp-vectorize
8986 Perform basic block vectorization on trees. This flag is enabled by default at
8987 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8989 @item -fvect-cost-model=@var{model}
8990 @opindex fvect-cost-model
8991 Alter the cost model used for vectorization.  The @var{model} argument
8992 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8993 With the @samp{unlimited} model the vectorized code-path is assumed
8994 to be profitable while with the @samp{dynamic} model a runtime check
8995 guards the vectorized code-path to enable it only for iteration
8996 counts that will likely execute faster than when executing the original
8997 scalar loop.  The @samp{cheap} model disables vectorization of
8998 loops where doing so would be cost prohibitive for example due to
8999 required runtime checks for data dependence or alignment but otherwise
9000 is equal to the @samp{dynamic} model.
9001 The default cost model depends on other optimization flags and is
9002 either @samp{dynamic} or @samp{cheap}.
9004 @item -fsimd-cost-model=@var{model}
9005 @opindex fsimd-cost-model
9006 Alter the cost model used for vectorization of loops marked with the OpenMP
9007 or Cilk Plus simd directive.  The @var{model} argument should be one of
9008 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
9009 have the same meaning as described in @option{-fvect-cost-model} and by
9010 default a cost model defined with @option{-fvect-cost-model} is used.
9012 @item -ftree-vrp
9013 @opindex ftree-vrp
9014 Perform Value Range Propagation on trees.  This is similar to the
9015 constant propagation pass, but instead of values, ranges of values are
9016 propagated.  This allows the optimizers to remove unnecessary range
9017 checks like array bound checks and null pointer checks.  This is
9018 enabled by default at @option{-O2} and higher.  Null pointer check
9019 elimination is only done if @option{-fdelete-null-pointer-checks} is
9020 enabled.
9022 @item -fsplit-ivs-in-unroller
9023 @opindex fsplit-ivs-in-unroller
9024 Enables expression of values of induction variables in later iterations
9025 of the unrolled loop using the value in the first iteration.  This breaks
9026 long dependency chains, thus improving efficiency of the scheduling passes.
9028 A combination of @option{-fweb} and CSE is often sufficient to obtain the
9029 same effect.  However, that is not reliable in cases where the loop body
9030 is more complicated than a single basic block.  It also does not work at all
9031 on some architectures due to restrictions in the CSE pass.
9033 This optimization is enabled by default.
9035 @item -fvariable-expansion-in-unroller
9036 @opindex fvariable-expansion-in-unroller
9037 With this option, the compiler creates multiple copies of some
9038 local variables when unrolling a loop, which can result in superior code.
9040 @item -fpartial-inlining
9041 @opindex fpartial-inlining
9042 Inline parts of functions.  This option has any effect only
9043 when inlining itself is turned on by the @option{-finline-functions}
9044 or @option{-finline-small-functions} options.
9046 Enabled at level @option{-O2}.
9048 @item -fpredictive-commoning
9049 @opindex fpredictive-commoning
9050 Perform predictive commoning optimization, i.e., reusing computations
9051 (especially memory loads and stores) performed in previous
9052 iterations of loops.
9054 This option is enabled at level @option{-O3}.
9056 @item -fprefetch-loop-arrays
9057 @opindex fprefetch-loop-arrays
9058 If supported by the target machine, generate instructions to prefetch
9059 memory to improve the performance of loops that access large arrays.
9061 This option may generate better or worse code; results are highly
9062 dependent on the structure of loops within the source code.
9064 Disabled at level @option{-Os}.
9066 @item -fno-peephole
9067 @itemx -fno-peephole2
9068 @opindex fno-peephole
9069 @opindex fno-peephole2
9070 Disable any machine-specific peephole optimizations.  The difference
9071 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9072 are implemented in the compiler; some targets use one, some use the
9073 other, a few use both.
9075 @option{-fpeephole} is enabled by default.
9076 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9078 @item -fno-guess-branch-probability
9079 @opindex fno-guess-branch-probability
9080 Do not guess branch probabilities using heuristics.
9082 GCC uses heuristics to guess branch probabilities if they are
9083 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9084 heuristics are based on the control flow graph.  If some branch probabilities
9085 are specified by @code{__builtin_expect}, then the heuristics are
9086 used to guess branch probabilities for the rest of the control flow graph,
9087 taking the @code{__builtin_expect} info into account.  The interactions
9088 between the heuristics and @code{__builtin_expect} can be complex, and in
9089 some cases, it may be useful to disable the heuristics so that the effects
9090 of @code{__builtin_expect} are easier to understand.
9092 The default is @option{-fguess-branch-probability} at levels
9093 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9095 @item -freorder-blocks
9096 @opindex freorder-blocks
9097 Reorder basic blocks in the compiled function in order to reduce number of
9098 taken branches and improve code locality.
9100 Enabled at levels @option{-O2}, @option{-O3}.
9102 @item -freorder-blocks-and-partition
9103 @opindex freorder-blocks-and-partition
9104 In addition to reordering basic blocks in the compiled function, in order
9105 to reduce number of taken branches, partitions hot and cold basic blocks
9106 into separate sections of the assembly and .o files, to improve
9107 paging and cache locality performance.
9109 This optimization is automatically turned off in the presence of
9110 exception handling, for linkonce sections, for functions with a user-defined
9111 section attribute and on any architecture that does not support named
9112 sections.
9114 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9116 @item -freorder-functions
9117 @opindex freorder-functions
9118 Reorder functions in the object file in order to
9119 improve code locality.  This is implemented by using special
9120 subsections @code{.text.hot} for most frequently executed functions and
9121 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9122 the linker so object file format must support named sections and linker must
9123 place them in a reasonable way.
9125 Also profile feedback must be available to make this option effective.  See
9126 @option{-fprofile-arcs} for details.
9128 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9130 @item -fstrict-aliasing
9131 @opindex fstrict-aliasing
9132 Allow the compiler to assume the strictest aliasing rules applicable to
9133 the language being compiled.  For C (and C++), this activates
9134 optimizations based on the type of expressions.  In particular, an
9135 object of one type is assumed never to reside at the same address as an
9136 object of a different type, unless the types are almost the same.  For
9137 example, an @code{unsigned int} can alias an @code{int}, but not a
9138 @code{void*} or a @code{double}.  A character type may alias any other
9139 type.
9141 @anchor{Type-punning}Pay special attention to code like this:
9142 @smallexample
9143 union a_union @{
9144   int i;
9145   double d;
9148 int f() @{
9149   union a_union t;
9150   t.d = 3.0;
9151   return t.i;
9153 @end smallexample
9154 The practice of reading from a different union member than the one most
9155 recently written to (called ``type-punning'') is common.  Even with
9156 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9157 is accessed through the union type.  So, the code above works as
9158 expected.  @xref{Structures unions enumerations and bit-fields
9159 implementation}.  However, this code might not:
9160 @smallexample
9161 int f() @{
9162   union a_union t;
9163   int* ip;
9164   t.d = 3.0;
9165   ip = &t.i;
9166   return *ip;
9168 @end smallexample
9170 Similarly, access by taking the address, casting the resulting pointer
9171 and dereferencing the result has undefined behavior, even if the cast
9172 uses a union type, e.g.:
9173 @smallexample
9174 int f() @{
9175   double d = 3.0;
9176   return ((union a_union *) &d)->i;
9178 @end smallexample
9180 The @option{-fstrict-aliasing} option is enabled at levels
9181 @option{-O2}, @option{-O3}, @option{-Os}.
9183 @item -fstrict-overflow
9184 @opindex fstrict-overflow
9185 Allow the compiler to assume strict signed overflow rules, depending
9186 on the language being compiled.  For C (and C++) this means that
9187 overflow when doing arithmetic with signed numbers is undefined, which
9188 means that the compiler may assume that it does not happen.  This
9189 permits various optimizations.  For example, the compiler assumes
9190 that an expression like @code{i + 10 > i} is always true for
9191 signed @code{i}.  This assumption is only valid if signed overflow is
9192 undefined, as the expression is false if @code{i + 10} overflows when
9193 using twos complement arithmetic.  When this option is in effect any
9194 attempt to determine whether an operation on signed numbers 
9195 overflows must be written carefully to not actually involve overflow.
9197 This option also allows the compiler to assume strict pointer
9198 semantics: given a pointer to an object, if adding an offset to that
9199 pointer does not produce a pointer to the same object, the addition is
9200 undefined.  This permits the compiler to conclude that @code{p + u >
9201 p} is always true for a pointer @code{p} and unsigned integer
9202 @code{u}.  This assumption is only valid because pointer wraparound is
9203 undefined, as the expression is false if @code{p + u} overflows using
9204 twos complement arithmetic.
9206 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
9207 that integer signed overflow is fully defined: it wraps.  When
9208 @option{-fwrapv} is used, there is no difference between
9209 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
9210 integers.  With @option{-fwrapv} certain types of overflow are
9211 permitted.  For example, if the compiler gets an overflow when doing
9212 arithmetic on constants, the overflowed value can still be used with
9213 @option{-fwrapv}, but not otherwise.
9215 The @option{-fstrict-overflow} option is enabled at levels
9216 @option{-O2}, @option{-O3}, @option{-Os}.
9218 @item -falign-functions
9219 @itemx -falign-functions=@var{n}
9220 @opindex falign-functions
9221 Align the start of functions to the next power-of-two greater than
9222 @var{n}, skipping up to @var{n} bytes.  For instance,
9223 @option{-falign-functions=32} aligns functions to the next 32-byte
9224 boundary, but @option{-falign-functions=24} aligns to the next
9225 32-byte boundary only if this can be done by skipping 23 bytes or less.
9227 @option{-fno-align-functions} and @option{-falign-functions=1} are
9228 equivalent and mean that functions are not aligned.
9230 Some assemblers only support this flag when @var{n} is a power of two;
9231 in that case, it is rounded up.
9233 If @var{n} is not specified or is zero, use a machine-dependent default.
9235 Enabled at levels @option{-O2}, @option{-O3}.
9237 @item -falign-labels
9238 @itemx -falign-labels=@var{n}
9239 @opindex falign-labels
9240 Align all branch targets to a power-of-two boundary, skipping up to
9241 @var{n} bytes like @option{-falign-functions}.  This option can easily
9242 make code slower, because it must insert dummy operations for when the
9243 branch target is reached in the usual flow of the code.
9245 @option{-fno-align-labels} and @option{-falign-labels=1} are
9246 equivalent and mean that labels are not aligned.
9248 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9249 are greater than this value, then their values are used instead.
9251 If @var{n} is not specified or is zero, use a machine-dependent default
9252 which is very likely to be @samp{1}, meaning no alignment.
9254 Enabled at levels @option{-O2}, @option{-O3}.
9256 @item -falign-loops
9257 @itemx -falign-loops=@var{n}
9258 @opindex falign-loops
9259 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9260 like @option{-falign-functions}.  If the loops are
9261 executed many times, this makes up for any execution of the dummy
9262 operations.
9264 @option{-fno-align-loops} and @option{-falign-loops=1} are
9265 equivalent and mean that loops are not aligned.
9267 If @var{n} is not specified or is zero, use a machine-dependent default.
9269 Enabled at levels @option{-O2}, @option{-O3}.
9271 @item -falign-jumps
9272 @itemx -falign-jumps=@var{n}
9273 @opindex falign-jumps
9274 Align branch targets to a power-of-two boundary, for branch targets
9275 where the targets can only be reached by jumping, skipping up to @var{n}
9276 bytes like @option{-falign-functions}.  In this case, no dummy operations
9277 need be executed.
9279 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9280 equivalent and mean that loops are not aligned.
9282 If @var{n} is not specified or is zero, use a machine-dependent default.
9284 Enabled at levels @option{-O2}, @option{-O3}.
9286 @item -funit-at-a-time
9287 @opindex funit-at-a-time
9288 This option is left for compatibility reasons. @option{-funit-at-a-time}
9289 has no effect, while @option{-fno-unit-at-a-time} implies
9290 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9292 Enabled by default.
9294 @item -fno-toplevel-reorder
9295 @opindex fno-toplevel-reorder
9296 Do not reorder top-level functions, variables, and @code{asm}
9297 statements.  Output them in the same order that they appear in the
9298 input file.  When this option is used, unreferenced static variables
9299 are not removed.  This option is intended to support existing code
9300 that relies on a particular ordering.  For new code, it is better to
9301 use attributes when possible.
9303 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9304 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9305 targets.
9307 @item -fweb
9308 @opindex fweb
9309 Constructs webs as commonly used for register allocation purposes and assign
9310 each web individual pseudo register.  This allows the register allocation pass
9311 to operate on pseudos directly, but also strengthens several other optimization
9312 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9313 however, make debugging impossible, since variables no longer stay in a
9314 ``home register''.
9316 Enabled by default with @option{-funroll-loops}.
9318 @item -fwhole-program
9319 @opindex fwhole-program
9320 Assume that the current compilation unit represents the whole program being
9321 compiled.  All public functions and variables with the exception of @code{main}
9322 and those merged by attribute @code{externally_visible} become static functions
9323 and in effect are optimized more aggressively by interprocedural optimizers.
9325 This option should not be used in combination with @option{-flto}.
9326 Instead relying on a linker plugin should provide safer and more precise
9327 information.
9329 @item -flto[=@var{n}]
9330 @opindex flto
9331 This option runs the standard link-time optimizer.  When invoked
9332 with source code, it generates GIMPLE (one of GCC's internal
9333 representations) and writes it to special ELF sections in the object
9334 file.  When the object files are linked together, all the function
9335 bodies are read from these ELF sections and instantiated as if they
9336 had been part of the same translation unit.
9338 To use the link-time optimizer, @option{-flto} and optimization
9339 options should be specified at compile time and during the final link.
9340 For example:
9342 @smallexample
9343 gcc -c -O2 -flto foo.c
9344 gcc -c -O2 -flto bar.c
9345 gcc -o myprog -flto -O2 foo.o bar.o
9346 @end smallexample
9348 The first two invocations to GCC save a bytecode representation
9349 of GIMPLE into special ELF sections inside @file{foo.o} and
9350 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9351 @file{foo.o} and @file{bar.o}, merges the two files into a single
9352 internal image, and compiles the result as usual.  Since both
9353 @file{foo.o} and @file{bar.o} are merged into a single image, this
9354 causes all the interprocedural analyses and optimizations in GCC to
9355 work across the two files as if they were a single one.  This means,
9356 for example, that the inliner is able to inline functions in
9357 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9359 Another (simpler) way to enable link-time optimization is:
9361 @smallexample
9362 gcc -o myprog -flto -O2 foo.c bar.c
9363 @end smallexample
9365 The above generates bytecode for @file{foo.c} and @file{bar.c},
9366 merges them together into a single GIMPLE representation and optimizes
9367 them as usual to produce @file{myprog}.
9369 The only important thing to keep in mind is that to enable link-time
9370 optimizations you need to use the GCC driver to perform the link-step.
9371 GCC then automatically performs link-time optimization if any of the
9372 objects involved were compiled with the @option{-flto} command-line option.  
9373 You generally
9374 should specify the optimization options to be used for link-time
9375 optimization though GCC tries to be clever at guessing an
9376 optimization level to use from the options used at compile-time
9377 if you fail to specify one at link-time.  You can always override
9378 the automatic decision to do link-time optimization at link-time
9379 by passing @option{-fno-lto} to the link command.
9381 To make whole program optimization effective, it is necessary to make
9382 certain whole program assumptions.  The compiler needs to know
9383 what functions and variables can be accessed by libraries and runtime
9384 outside of the link-time optimized unit.  When supported by the linker,
9385 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9386 to the compiler about used and externally visible symbols.  When
9387 the linker plugin is not available, @option{-fwhole-program} should be
9388 used to allow the compiler to make these assumptions, which leads
9389 to more aggressive optimization decisions.
9391 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9392 compiled with @option{-flto}, the generated object file is larger than
9393 a regular object file because it contains GIMPLE bytecodes and the usual
9394 final code (see @option{-ffat-lto-objects}.  This means that
9395 object files with LTO information can be linked as normal object
9396 files; if @option{-fno-lto} is passed to the linker, no
9397 interprocedural optimizations are applied.  Note that when
9398 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9399 but you cannot perform a regular, non-LTO link on them.
9401 Additionally, the optimization flags used to compile individual files
9402 are not necessarily related to those used at link time.  For instance,
9404 @smallexample
9405 gcc -c -O0 -ffat-lto-objects -flto foo.c
9406 gcc -c -O0 -ffat-lto-objects -flto bar.c
9407 gcc -o myprog -O3 foo.o bar.o
9408 @end smallexample
9410 This produces individual object files with unoptimized assembler
9411 code, but the resulting binary @file{myprog} is optimized at
9412 @option{-O3}.  If, instead, the final binary is generated with
9413 @option{-fno-lto}, then @file{myprog} is not optimized.
9415 When producing the final binary, GCC only
9416 applies link-time optimizations to those files that contain bytecode.
9417 Therefore, you can mix and match object files and libraries with
9418 GIMPLE bytecodes and final object code.  GCC automatically selects
9419 which files to optimize in LTO mode and which files to link without
9420 further processing.
9422 There are some code generation flags preserved by GCC when
9423 generating bytecodes, as they need to be used during the final link
9424 stage.  Generally options specified at link-time override those
9425 specified at compile-time.
9427 If you do not specify an optimization level option @option{-O} at
9428 link-time then GCC computes one based on the optimization levels
9429 used when compiling the object files.  The highest optimization
9430 level wins here.
9432 Currently, the following options and their setting are take from
9433 the first object file that explicitely specified it: 
9434 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9435 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9436 and all the @option{-m} target flags.
9438 Certain ABI changing flags are required to match in all compilation-units
9439 and trying to override this at link-time with a conflicting value
9440 is ignored.  This includes options such as @option{-freg-struct-return}
9441 and @option{-fpcc-struct-return}. 
9443 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9444 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9445 are passed through to the link stage and merged conservatively for
9446 conflicting translation units.  Specifically
9447 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9448 precedence and for example @option{-ffp-contract=off} takes precedence
9449 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9451 It is recommended that you compile all the files participating in the
9452 same link with the same options and also specify those options at
9453 link time.
9455 If LTO encounters objects with C linkage declared with incompatible
9456 types in separate translation units to be linked together (undefined
9457 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9458 issued.  The behavior is still undefined at run time.  Similar
9459 diagnostics may be raised for other languages.
9461 Another feature of LTO is that it is possible to apply interprocedural
9462 optimizations on files written in different languages:
9464 @smallexample
9465 gcc -c -flto foo.c
9466 g++ -c -flto bar.cc
9467 gfortran -c -flto baz.f90
9468 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9469 @end smallexample
9471 Notice that the final link is done with @command{g++} to get the C++
9472 runtime libraries and @option{-lgfortran} is added to get the Fortran
9473 runtime libraries.  In general, when mixing languages in LTO mode, you
9474 should use the same link command options as when mixing languages in a
9475 regular (non-LTO) compilation.
9477 If object files containing GIMPLE bytecode are stored in a library archive, say
9478 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9479 are using a linker with plugin support.  To create static libraries suitable
9480 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9481 and @command{ranlib}; 
9482 to show the symbols of object files with GIMPLE bytecode, use
9483 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9484 and @command{nm} have been compiled with plugin support.  At link time, use the the
9485 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9486 the LTO optimization process:
9488 @smallexample
9489 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9490 @end smallexample
9492 With the linker plugin enabled, the linker extracts the needed
9493 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9494 to make them part of the aggregated GIMPLE image to be optimized.
9496 If you are not using a linker with plugin support and/or do not
9497 enable the linker plugin, then the objects inside @file{libfoo.a}
9498 are extracted and linked as usual, but they do not participate
9499 in the LTO optimization process.  In order to make a static library suitable
9500 for both LTO optimization and usual linkage, compile its object files with
9501 @option{-flto} @option{-ffat-lto-objects}.
9503 Link-time optimizations do not require the presence of the whole program to
9504 operate.  If the program does not require any symbols to be exported, it is
9505 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9506 the interprocedural optimizers to use more aggressive assumptions which may
9507 lead to improved optimization opportunities.
9508 Use of @option{-fwhole-program} is not needed when linker plugin is
9509 active (see @option{-fuse-linker-plugin}).
9511 The current implementation of LTO makes no
9512 attempt to generate bytecode that is portable between different
9513 types of hosts.  The bytecode files are versioned and there is a
9514 strict version check, so bytecode files generated in one version of
9515 GCC do not work with an older or newer version of GCC.
9517 Link-time optimization does not work well with generation of debugging
9518 information.  Combining @option{-flto} with
9519 @option{-g} is currently experimental and expected to produce unexpected
9520 results.
9522 If you specify the optional @var{n}, the optimization and code
9523 generation done at link time is executed in parallel using @var{n}
9524 parallel jobs by utilizing an installed @command{make} program.  The
9525 environment variable @env{MAKE} may be used to override the program
9526 used.  The default value for @var{n} is 1.
9528 You can also specify @option{-flto=jobserver} to use GNU make's
9529 job server mode to determine the number of parallel jobs. This
9530 is useful when the Makefile calling GCC is already executing in parallel.
9531 You must prepend a @samp{+} to the command recipe in the parent Makefile
9532 for this to work.  This option likely only works if @env{MAKE} is
9533 GNU make.
9535 @item -flto-partition=@var{alg}
9536 @opindex flto-partition
9537 Specify the partitioning algorithm used by the link-time optimizer.
9538 The value is either @samp{1to1} to specify a partitioning mirroring
9539 the original source files or @samp{balanced} to specify partitioning
9540 into equally sized chunks (whenever possible) or @samp{max} to create
9541 new partition for every symbol where possible.  Specifying @samp{none}
9542 as an algorithm disables partitioning and streaming completely. 
9543 The default value is @samp{balanced}. While @samp{1to1} can be used
9544 as an workaround for various code ordering issues, the @samp{max}
9545 partitioning is intended for internal testing only.
9546 The value @samp{one} specifies that exactly one partition should be
9547 used while the value @samp{none} bypasses partitioning and executes
9548 the link-time optimization step directly from the WPA phase.
9550 @item -flto-odr-type-merging
9551 @opindex flto-odr-type-merging
9552 Enable streaming of mangled types names of C++ types and their unification
9553 at linktime.  This increases size of LTO object files, but enable
9554 diagnostics about One Definition Rule violations.
9556 @item -flto-compression-level=@var{n}
9557 @opindex flto-compression-level
9558 This option specifies the level of compression used for intermediate
9559 language written to LTO object files, and is only meaningful in
9560 conjunction with LTO mode (@option{-flto}).  Valid
9561 values are 0 (no compression) to 9 (maximum compression).  Values
9562 outside this range are clamped to either 0 or 9.  If the option is not
9563 given, a default balanced compression setting is used.
9565 @item -flto-report
9566 @opindex flto-report
9567 Prints a report with internal details on the workings of the link-time
9568 optimizer.  The contents of this report vary from version to version.
9569 It is meant to be useful to GCC developers when processing object
9570 files in LTO mode (via @option{-flto}).
9572 Disabled by default.
9574 @item -flto-report-wpa
9575 @opindex flto-report-wpa
9576 Like @option{-flto-report}, but only print for the WPA phase of Link
9577 Time Optimization.
9579 @item -fuse-linker-plugin
9580 @opindex fuse-linker-plugin
9581 Enables the use of a linker plugin during link-time optimization.  This
9582 option relies on plugin support in the linker, which is available in gold
9583 or in GNU ld 2.21 or newer.
9585 This option enables the extraction of object files with GIMPLE bytecode out
9586 of library archives. This improves the quality of optimization by exposing
9587 more code to the link-time optimizer.  This information specifies what
9588 symbols can be accessed externally (by non-LTO object or during dynamic
9589 linking).  Resulting code quality improvements on binaries (and shared
9590 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9591 See @option{-flto} for a description of the effect of this flag and how to
9592 use it.
9594 This option is enabled by default when LTO support in GCC is enabled
9595 and GCC was configured for use with
9596 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9598 @item -ffat-lto-objects
9599 @opindex ffat-lto-objects
9600 Fat LTO objects are object files that contain both the intermediate language
9601 and the object code. This makes them usable for both LTO linking and normal
9602 linking. This option is effective only when compiling with @option{-flto}
9603 and is ignored at link time.
9605 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9606 requires the complete toolchain to be aware of LTO. It requires a linker with
9607 linker plugin support for basic functionality.  Additionally,
9608 @command{nm}, @command{ar} and @command{ranlib}
9609 need to support linker plugins to allow a full-featured build environment
9610 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9611 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9612 to these tools. With non fat LTO makefiles need to be modified to use them.
9614 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9615 support.
9617 @item -fcompare-elim
9618 @opindex fcompare-elim
9619 After register allocation and post-register allocation instruction splitting,
9620 identify arithmetic instructions that compute processor flags similar to a
9621 comparison operation based on that arithmetic.  If possible, eliminate the
9622 explicit comparison operation.
9624 This pass only applies to certain targets that cannot explicitly represent
9625 the comparison operation before register allocation is complete.
9627 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9629 @item -fcprop-registers
9630 @opindex fcprop-registers
9631 After register allocation and post-register allocation instruction splitting,
9632 perform a copy-propagation pass to try to reduce scheduling dependencies
9633 and occasionally eliminate the copy.
9635 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9637 @item -fprofile-correction
9638 @opindex fprofile-correction
9639 Profiles collected using an instrumented binary for multi-threaded programs may
9640 be inconsistent due to missed counter updates. When this option is specified,
9641 GCC uses heuristics to correct or smooth out such inconsistencies. By
9642 default, GCC emits an error message when an inconsistent profile is detected.
9644 @item -fprofile-dir=@var{path}
9645 @opindex fprofile-dir
9647 Set the directory to search for the profile data files in to @var{path}.
9648 This option affects only the profile data generated by
9649 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9650 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9651 and its related options.  Both absolute and relative paths can be used.
9652 By default, GCC uses the current directory as @var{path}, thus the
9653 profile data file appears in the same directory as the object file.
9655 @item -fprofile-generate
9656 @itemx -fprofile-generate=@var{path}
9657 @opindex fprofile-generate
9659 Enable options usually used for instrumenting application to produce
9660 profile useful for later recompilation with profile feedback based
9661 optimization.  You must use @option{-fprofile-generate} both when
9662 compiling and when linking your program.
9664 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9666 If @var{path} is specified, GCC looks at the @var{path} to find
9667 the profile feedback data files. See @option{-fprofile-dir}.
9669 @item -fprofile-use
9670 @itemx -fprofile-use=@var{path}
9671 @opindex fprofile-use
9672 Enable profile feedback-directed optimizations, 
9673 and the following optimizations
9674 which are generally profitable only with profile feedback available:
9675 @option{-fbranch-probabilities}, @option{-fvpt},
9676 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9677 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9679 By default, GCC emits an error message if the feedback profiles do not
9680 match the source code.  This error can be turned into a warning by using
9681 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9682 code.
9684 If @var{path} is specified, GCC looks at the @var{path} to find
9685 the profile feedback data files. See @option{-fprofile-dir}.
9687 @item -fauto-profile
9688 @itemx -fauto-profile=@var{path}
9689 @opindex fauto-profile
9690 Enable sampling-based feedback-directed optimizations, 
9691 and the following optimizations
9692 which are generally profitable only with profile feedback available:
9693 @option{-fbranch-probabilities}, @option{-fvpt},
9694 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9695 @option{-ftree-vectorize},
9696 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9697 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9698 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9700 @var{path} is the name of a file containing AutoFDO profile information.
9701 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9703 Producing an AutoFDO profile data file requires running your program
9704 with the @command{perf} utility on a supported GNU/Linux target system.
9705 For more information, see @uref{https://perf.wiki.kernel.org/}.
9707 E.g.
9708 @smallexample
9709 perf record -e br_inst_retired:near_taken -b -o perf.data \
9710     -- your_program
9711 @end smallexample
9713 Then use the @command{create_gcov} tool to convert the raw profile data
9714 to a format that can be used by GCC.@  You must also supply the 
9715 unstripped binary for your program to this tool.  
9716 See @uref{https://github.com/google/autofdo}.
9718 E.g.
9719 @smallexample
9720 create_gcov --binary=your_program.unstripped --profile=perf.data \
9721     --gcov=profile.afdo
9722 @end smallexample
9723 @end table
9725 The following options control compiler behavior regarding floating-point 
9726 arithmetic.  These options trade off between speed and
9727 correctness.  All must be specifically enabled.
9729 @table @gcctabopt
9730 @item -ffloat-store
9731 @opindex ffloat-store
9732 Do not store floating-point variables in registers, and inhibit other
9733 options that might change whether a floating-point value is taken from a
9734 register or memory.
9736 @cindex floating-point precision
9737 This option prevents undesirable excess precision on machines such as
9738 the 68000 where the floating registers (of the 68881) keep more
9739 precision than a @code{double} is supposed to have.  Similarly for the
9740 x86 architecture.  For most programs, the excess precision does only
9741 good, but a few programs rely on the precise definition of IEEE floating
9742 point.  Use @option{-ffloat-store} for such programs, after modifying
9743 them to store all pertinent intermediate computations into variables.
9745 @item -fexcess-precision=@var{style}
9746 @opindex fexcess-precision
9747 This option allows further control over excess precision on machines
9748 where floating-point registers have more precision than the IEEE
9749 @code{float} and @code{double} types and the processor does not
9750 support operations rounding to those types.  By default,
9751 @option{-fexcess-precision=fast} is in effect; this means that
9752 operations are carried out in the precision of the registers and that
9753 it is unpredictable when rounding to the types specified in the source
9754 code takes place.  When compiling C, if
9755 @option{-fexcess-precision=standard} is specified then excess
9756 precision follows the rules specified in ISO C99; in particular,
9757 both casts and assignments cause values to be rounded to their
9758 semantic types (whereas @option{-ffloat-store} only affects
9759 assignments).  This option is enabled by default for C if a strict
9760 conformance option such as @option{-std=c99} is used.
9762 @opindex mfpmath
9763 @option{-fexcess-precision=standard} is not implemented for languages
9764 other than C, and has no effect if
9765 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9766 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9767 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9768 semantics apply without excess precision, and in the latter, rounding
9769 is unpredictable.
9771 @item -ffast-math
9772 @opindex ffast-math
9773 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9774 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9775 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9777 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9779 This option is not turned on by any @option{-O} option besides
9780 @option{-Ofast} since it can result in incorrect output for programs
9781 that depend on an exact implementation of IEEE or ISO rules/specifications
9782 for math functions. It may, however, yield faster code for programs
9783 that do not require the guarantees of these specifications.
9785 @item -fno-math-errno
9786 @opindex fno-math-errno
9787 Do not set @code{errno} after calling math functions that are executed
9788 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9789 IEEE exceptions for math error handling may want to use this flag
9790 for speed while maintaining IEEE arithmetic compatibility.
9792 This option is not turned on by any @option{-O} option since
9793 it can result in incorrect output for programs that depend on
9794 an exact implementation of IEEE or ISO rules/specifications for
9795 math functions. It may, however, yield faster code for programs
9796 that do not require the guarantees of these specifications.
9798 The default is @option{-fmath-errno}.
9800 On Darwin systems, the math library never sets @code{errno}.  There is
9801 therefore no reason for the compiler to consider the possibility that
9802 it might, and @option{-fno-math-errno} is the default.
9804 @item -funsafe-math-optimizations
9805 @opindex funsafe-math-optimizations
9807 Allow optimizations for floating-point arithmetic that (a) assume
9808 that arguments and results are valid and (b) may violate IEEE or
9809 ANSI standards.  When used at link-time, it may include libraries
9810 or startup files that change the default FPU control word or other
9811 similar optimizations.
9813 This option is not turned on by any @option{-O} option since
9814 it can result in incorrect output for programs that depend on
9815 an exact implementation of IEEE or ISO rules/specifications for
9816 math functions. It may, however, yield faster code for programs
9817 that do not require the guarantees of these specifications.
9818 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9819 @option{-fassociative-math} and @option{-freciprocal-math}.
9821 The default is @option{-fno-unsafe-math-optimizations}.
9823 @item -fassociative-math
9824 @opindex fassociative-math
9826 Allow re-association of operands in series of floating-point operations.
9827 This violates the ISO C and C++ language standard by possibly changing
9828 computation result.  NOTE: re-ordering may change the sign of zero as
9829 well as ignore NaNs and inhibit or create underflow or overflow (and
9830 thus cannot be used on code that relies on rounding behavior like
9831 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9832 and thus may not be used when ordered comparisons are required.
9833 This option requires that both @option{-fno-signed-zeros} and
9834 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9835 much sense with @option{-frounding-math}. For Fortran the option
9836 is automatically enabled when both @option{-fno-signed-zeros} and
9837 @option{-fno-trapping-math} are in effect.
9839 The default is @option{-fno-associative-math}.
9841 @item -freciprocal-math
9842 @opindex freciprocal-math
9844 Allow the reciprocal of a value to be used instead of dividing by
9845 the value if this enables optimizations.  For example @code{x / y}
9846 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9847 is subject to common subexpression elimination.  Note that this loses
9848 precision and increases the number of flops operating on the value.
9850 The default is @option{-fno-reciprocal-math}.
9852 @item -ffinite-math-only
9853 @opindex ffinite-math-only
9854 Allow optimizations for floating-point arithmetic that assume
9855 that arguments and results are not NaNs or +-Infs.
9857 This option is not turned on by any @option{-O} option since
9858 it can result in incorrect output for programs that depend on
9859 an exact implementation of IEEE or ISO rules/specifications for
9860 math functions. It may, however, yield faster code for programs
9861 that do not require the guarantees of these specifications.
9863 The default is @option{-fno-finite-math-only}.
9865 @item -fno-signed-zeros
9866 @opindex fno-signed-zeros
9867 Allow optimizations for floating-point arithmetic that ignore the
9868 signedness of zero.  IEEE arithmetic specifies the behavior of
9869 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9870 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9871 This option implies that the sign of a zero result isn't significant.
9873 The default is @option{-fsigned-zeros}.
9875 @item -fno-trapping-math
9876 @opindex fno-trapping-math
9877 Compile code assuming that floating-point operations cannot generate
9878 user-visible traps.  These traps include division by zero, overflow,
9879 underflow, inexact result and invalid operation.  This option requires
9880 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9881 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9883 This option should never be turned on by any @option{-O} option since
9884 it can result in incorrect output for programs that depend on
9885 an exact implementation of IEEE or ISO rules/specifications for
9886 math functions.
9888 The default is @option{-ftrapping-math}.
9890 @item -frounding-math
9891 @opindex frounding-math
9892 Disable transformations and optimizations that assume default floating-point
9893 rounding behavior.  This is round-to-zero for all floating point
9894 to integer conversions, and round-to-nearest for all other arithmetic
9895 truncations.  This option should be specified for programs that change
9896 the FP rounding mode dynamically, or that may be executed with a
9897 non-default rounding mode.  This option disables constant folding of
9898 floating-point expressions at compile time (which may be affected by
9899 rounding mode) and arithmetic transformations that are unsafe in the
9900 presence of sign-dependent rounding modes.
9902 The default is @option{-fno-rounding-math}.
9904 This option is experimental and does not currently guarantee to
9905 disable all GCC optimizations that are affected by rounding mode.
9906 Future versions of GCC may provide finer control of this setting
9907 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9908 will be used to specify the default state for @code{FENV_ACCESS}.
9910 @item -fsignaling-nans
9911 @opindex fsignaling-nans
9912 Compile code assuming that IEEE signaling NaNs may generate user-visible
9913 traps during floating-point operations.  Setting this option disables
9914 optimizations that may change the number of exceptions visible with
9915 signaling NaNs.  This option implies @option{-ftrapping-math}.
9917 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9918 be defined.
9920 The default is @option{-fno-signaling-nans}.
9922 This option is experimental and does not currently guarantee to
9923 disable all GCC optimizations that affect signaling NaN behavior.
9925 @item -fsingle-precision-constant
9926 @opindex fsingle-precision-constant
9927 Treat floating-point constants as single precision instead of
9928 implicitly converting them to double-precision constants.
9930 @item -fcx-limited-range
9931 @opindex fcx-limited-range
9932 When enabled, this option states that a range reduction step is not
9933 needed when performing complex division.  Also, there is no checking
9934 whether the result of a complex multiplication or division is @code{NaN
9935 + I*NaN}, with an attempt to rescue the situation in that case.  The
9936 default is @option{-fno-cx-limited-range}, but is enabled by
9937 @option{-ffast-math}.
9939 This option controls the default setting of the ISO C99
9940 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9941 all languages.
9943 @item -fcx-fortran-rules
9944 @opindex fcx-fortran-rules
9945 Complex multiplication and division follow Fortran rules.  Range
9946 reduction is done as part of complex division, but there is no checking
9947 whether the result of a complex multiplication or division is @code{NaN
9948 + I*NaN}, with an attempt to rescue the situation in that case.
9950 The default is @option{-fno-cx-fortran-rules}.
9952 @end table
9954 The following options control optimizations that may improve
9955 performance, but are not enabled by any @option{-O} options.  This
9956 section includes experimental options that may produce broken code.
9958 @table @gcctabopt
9959 @item -fbranch-probabilities
9960 @opindex fbranch-probabilities
9961 After running a program compiled with @option{-fprofile-arcs}
9962 (@pxref{Debugging Options,, Options for Debugging Your Program or
9963 @command{gcc}}), you can compile it a second time using
9964 @option{-fbranch-probabilities}, to improve optimizations based on
9965 the number of times each branch was taken.  When a program
9966 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9967 counts to a file called @file{@var{sourcename}.gcda} for each source
9968 file.  The information in this data file is very dependent on the
9969 structure of the generated code, so you must use the same source code
9970 and the same optimization options for both compilations.
9972 With @option{-fbranch-probabilities}, GCC puts a
9973 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9974 These can be used to improve optimization.  Currently, they are only
9975 used in one place: in @file{reorg.c}, instead of guessing which path a
9976 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9977 exactly determine which path is taken more often.
9979 @item -fprofile-values
9980 @opindex fprofile-values
9981 If combined with @option{-fprofile-arcs}, it adds code so that some
9982 data about values of expressions in the program is gathered.
9984 With @option{-fbranch-probabilities}, it reads back the data gathered
9985 from profiling values of expressions for usage in optimizations.
9987 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9989 @item -fprofile-reorder-functions
9990 @opindex fprofile-reorder-functions
9991 Function reordering based on profile instrumentation collects
9992 first time of execution of a function and orders these functions
9993 in ascending order.
9995 Enabled with @option{-fprofile-use}.
9997 @item -fvpt
9998 @opindex fvpt
9999 If combined with @option{-fprofile-arcs}, this option instructs the compiler
10000 to add code to gather information about values of expressions.
10002 With @option{-fbranch-probabilities}, it reads back the data gathered
10003 and actually performs the optimizations based on them.
10004 Currently the optimizations include specialization of division operations
10005 using the knowledge about the value of the denominator.
10007 @item -frename-registers
10008 @opindex frename-registers
10009 Attempt to avoid false dependencies in scheduled code by making use
10010 of registers left over after register allocation.  This optimization
10011 most benefits processors with lots of registers.  Depending on the
10012 debug information format adopted by the target, however, it can
10013 make debugging impossible, since variables no longer stay in
10014 a ``home register''.
10016 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
10018 @item -fschedule-fusion
10019 @opindex fschedule-fusion
10020 Performs a target dependent pass over the instruction stream to schedule
10021 instructions of same type together because target machine can execute them
10022 more efficiently if they are adjacent to each other in the instruction flow.
10024 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10026 @item -ftracer
10027 @opindex ftracer
10028 Perform tail duplication to enlarge superblock size.  This transformation
10029 simplifies the control flow of the function allowing other optimizations to do
10030 a better job.
10032 Enabled with @option{-fprofile-use}.
10034 @item -funroll-loops
10035 @opindex funroll-loops
10036 Unroll loops whose number of iterations can be determined at compile time or
10037 upon entry to the loop.  @option{-funroll-loops} implies
10038 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10039 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10040 a small constant number of iterations).  This option makes code larger, and may
10041 or may not make it run faster.
10043 Enabled with @option{-fprofile-use}.
10045 @item -funroll-all-loops
10046 @opindex funroll-all-loops
10047 Unroll all loops, even if their number of iterations is uncertain when
10048 the loop is entered.  This usually makes programs run more slowly.
10049 @option{-funroll-all-loops} implies the same options as
10050 @option{-funroll-loops}.
10052 @item -fpeel-loops
10053 @opindex fpeel-loops
10054 Peels loops for which there is enough information that they do not
10055 roll much (from profile feedback).  It also turns on complete loop peeling
10056 (i.e.@: complete removal of loops with small constant number of iterations).
10058 Enabled with @option{-fprofile-use}.
10060 @item -fmove-loop-invariants
10061 @opindex fmove-loop-invariants
10062 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10063 at level @option{-O1}
10065 @item -funswitch-loops
10066 @opindex funswitch-loops
10067 Move branches with loop invariant conditions out of the loop, with duplicates
10068 of the loop on both branches (modified according to result of the condition).
10070 @item -ffunction-sections
10071 @itemx -fdata-sections
10072 @opindex ffunction-sections
10073 @opindex fdata-sections
10074 Place each function or data item into its own section in the output
10075 file if the target supports arbitrary sections.  The name of the
10076 function or the name of the data item determines the section's name
10077 in the output file.
10079 Use these options on systems where the linker can perform optimizations
10080 to improve locality of reference in the instruction space.  Most systems
10081 using the ELF object format and SPARC processors running Solaris 2 have
10082 linkers with such optimizations.  AIX may have these optimizations in
10083 the future.
10085 Only use these options when there are significant benefits from doing
10086 so.  When you specify these options, the assembler and linker
10087 create larger object and executable files and are also slower.
10088 You cannot use @command{gprof} on all systems if you
10089 specify this option, and you may have problems with debugging if
10090 you specify both this option and @option{-g}.
10092 @item -fbranch-target-load-optimize
10093 @opindex fbranch-target-load-optimize
10094 Perform branch target register load optimization before prologue / epilogue
10095 threading.
10096 The use of target registers can typically be exposed only during reload,
10097 thus hoisting loads out of loops and doing inter-block scheduling needs
10098 a separate optimization pass.
10100 @item -fbranch-target-load-optimize2
10101 @opindex fbranch-target-load-optimize2
10102 Perform branch target register load optimization after prologue / epilogue
10103 threading.
10105 @item -fbtr-bb-exclusive
10106 @opindex fbtr-bb-exclusive
10107 When performing branch target register load optimization, don't reuse
10108 branch target registers within any basic block.
10110 @item -fstack-protector
10111 @opindex fstack-protector
10112 Emit extra code to check for buffer overflows, such as stack smashing
10113 attacks.  This is done by adding a guard variable to functions with
10114 vulnerable objects.  This includes functions that call @code{alloca}, and
10115 functions with buffers larger than 8 bytes.  The guards are initialized
10116 when a function is entered and then checked when the function exits.
10117 If a guard check fails, an error message is printed and the program exits.
10119 @item -fstack-protector-all
10120 @opindex fstack-protector-all
10121 Like @option{-fstack-protector} except that all functions are protected.
10123 @item -fstack-protector-strong
10124 @opindex fstack-protector-strong
10125 Like @option{-fstack-protector} but includes additional functions to
10126 be protected --- those that have local array definitions, or have
10127 references to local frame addresses.
10129 @item -fstack-protector-explicit
10130 @opindex fstack-protector-explicit
10131 Like @option{-fstack-protector} but only protects those functions which
10132 have the @code{stack_protect} attribute
10134 @item -fstdarg-opt
10135 @opindex fstdarg-opt
10136 Optimize the prologue of variadic argument functions with respect to usage of
10137 those arguments.
10139 @item -fsection-anchors
10140 @opindex fsection-anchors
10141 Try to reduce the number of symbolic address calculations by using
10142 shared ``anchor'' symbols to address nearby objects.  This transformation
10143 can help to reduce the number of GOT entries and GOT accesses on some
10144 targets.
10146 For example, the implementation of the following function @code{foo}:
10148 @smallexample
10149 static int a, b, c;
10150 int foo (void) @{ return a + b + c; @}
10151 @end smallexample
10153 @noindent
10154 usually calculates the addresses of all three variables, but if you
10155 compile it with @option{-fsection-anchors}, it accesses the variables
10156 from a common anchor point instead.  The effect is similar to the
10157 following pseudocode (which isn't valid C):
10159 @smallexample
10160 int foo (void)
10162   register int *xr = &x;
10163   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10165 @end smallexample
10167 Not all targets support this option.
10169 @item --param @var{name}=@var{value}
10170 @opindex param
10171 In some places, GCC uses various constants to control the amount of
10172 optimization that is done.  For example, GCC does not inline functions
10173 that contain more than a certain number of instructions.  You can
10174 control some of these constants on the command line using the
10175 @option{--param} option.
10177 The names of specific parameters, and the meaning of the values, are
10178 tied to the internals of the compiler, and are subject to change
10179 without notice in future releases.
10181 In each case, the @var{value} is an integer.  The allowable choices for
10182 @var{name} are:
10184 @table @gcctabopt
10185 @item predictable-branch-outcome
10186 When branch is predicted to be taken with probability lower than this threshold
10187 (in percent), then it is considered well predictable. The default is 10.
10189 @item max-crossjump-edges
10190 The maximum number of incoming edges to consider for cross-jumping.
10191 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10192 the number of edges incoming to each block.  Increasing values mean
10193 more aggressive optimization, making the compilation time increase with
10194 probably small improvement in executable size.
10196 @item min-crossjump-insns
10197 The minimum number of instructions that must be matched at the end
10198 of two blocks before cross-jumping is performed on them.  This
10199 value is ignored in the case where all instructions in the block being
10200 cross-jumped from are matched.  The default value is 5.
10202 @item max-grow-copy-bb-insns
10203 The maximum code size expansion factor when copying basic blocks
10204 instead of jumping.  The expansion is relative to a jump instruction.
10205 The default value is 8.
10207 @item max-goto-duplication-insns
10208 The maximum number of instructions to duplicate to a block that jumps
10209 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10210 passes, GCC factors computed gotos early in the compilation process,
10211 and unfactors them as late as possible.  Only computed jumps at the
10212 end of a basic blocks with no more than max-goto-duplication-insns are
10213 unfactored.  The default value is 8.
10215 @item max-delay-slot-insn-search
10216 The maximum number of instructions to consider when looking for an
10217 instruction to fill a delay slot.  If more than this arbitrary number of
10218 instructions are searched, the time savings from filling the delay slot
10219 are minimal, so stop searching.  Increasing values mean more
10220 aggressive optimization, making the compilation time increase with probably
10221 small improvement in execution time.
10223 @item max-delay-slot-live-search
10224 When trying to fill delay slots, the maximum number of instructions to
10225 consider when searching for a block with valid live register
10226 information.  Increasing this arbitrarily chosen value means more
10227 aggressive optimization, increasing the compilation time.  This parameter
10228 should be removed when the delay slot code is rewritten to maintain the
10229 control-flow graph.
10231 @item max-gcse-memory
10232 The approximate maximum amount of memory that can be allocated in
10233 order to perform the global common subexpression elimination
10234 optimization.  If more memory than specified is required, the
10235 optimization is not done.
10237 @item max-gcse-insertion-ratio
10238 If the ratio of expression insertions to deletions is larger than this value
10239 for any expression, then RTL PRE inserts or removes the expression and thus
10240 leaves partially redundant computations in the instruction stream.  The default value is 20.
10242 @item max-pending-list-length
10243 The maximum number of pending dependencies scheduling allows
10244 before flushing the current state and starting over.  Large functions
10245 with few branches or calls can create excessively large lists which
10246 needlessly consume memory and resources.
10248 @item max-modulo-backtrack-attempts
10249 The maximum number of backtrack attempts the scheduler should make
10250 when modulo scheduling a loop.  Larger values can exponentially increase
10251 compilation time.
10253 @item max-inline-insns-single
10254 Several parameters control the tree inliner used in GCC@.
10255 This number sets the maximum number of instructions (counted in GCC's
10256 internal representation) in a single function that the tree inliner
10257 considers for inlining.  This only affects functions declared
10258 inline and methods implemented in a class declaration (C++).
10259 The default value is 400.
10261 @item max-inline-insns-auto
10262 When you use @option{-finline-functions} (included in @option{-O3}),
10263 a lot of functions that would otherwise not be considered for inlining
10264 by the compiler are investigated.  To those functions, a different
10265 (more restrictive) limit compared to functions declared inline can
10266 be applied.
10267 The default value is 40.
10269 @item inline-min-speedup
10270 When estimated performance improvement of caller + callee runtime exceeds this
10271 threshold (in precent), the function can be inlined regardless the limit on
10272 @option{--param max-inline-insns-single} and @option{--param
10273 max-inline-insns-auto}.
10275 @item large-function-insns
10276 The limit specifying really large functions.  For functions larger than this
10277 limit after inlining, inlining is constrained by
10278 @option{--param large-function-growth}.  This parameter is useful primarily
10279 to avoid extreme compilation time caused by non-linear algorithms used by the
10280 back end.
10281 The default value is 2700.
10283 @item large-function-growth
10284 Specifies maximal growth of large function caused by inlining in percents.
10285 The default value is 100 which limits large function growth to 2.0 times
10286 the original size.
10288 @item large-unit-insns
10289 The limit specifying large translation unit.  Growth caused by inlining of
10290 units larger than this limit is limited by @option{--param inline-unit-growth}.
10291 For small units this might be too tight.
10292 For example, consider a unit consisting of function A
10293 that is inline and B that just calls A three times.  If B is small relative to
10294 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10295 large units consisting of small inlineable functions, however, the overall unit
10296 growth limit is needed to avoid exponential explosion of code size.  Thus for
10297 smaller units, the size is increased to @option{--param large-unit-insns}
10298 before applying @option{--param inline-unit-growth}.  The default is 10000.
10300 @item inline-unit-growth
10301 Specifies maximal overall growth of the compilation unit caused by inlining.
10302 The default value is 20 which limits unit growth to 1.2 times the original
10303 size. Cold functions (either marked cold via an attribute or by profile
10304 feedback) are not accounted into the unit size.
10306 @item ipcp-unit-growth
10307 Specifies maximal overall growth of the compilation unit caused by
10308 interprocedural constant propagation.  The default value is 10 which limits
10309 unit growth to 1.1 times the original size.
10311 @item large-stack-frame
10312 The limit specifying large stack frames.  While inlining the algorithm is trying
10313 to not grow past this limit too much.  The default value is 256 bytes.
10315 @item large-stack-frame-growth
10316 Specifies maximal growth of large stack frames caused by inlining in percents.
10317 The default value is 1000 which limits large stack frame growth to 11 times
10318 the original size.
10320 @item max-inline-insns-recursive
10321 @itemx max-inline-insns-recursive-auto
10322 Specifies the maximum number of instructions an out-of-line copy of a
10323 self-recursive inline
10324 function can grow into by performing recursive inlining.
10326 @option{--param max-inline-insns-recursive} applies to functions
10327 declared inline.
10328 For functions not declared inline, recursive inlining
10329 happens only when @option{-finline-functions} (included in @option{-O3}) is
10330 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10331 default value is 450.
10333 @item max-inline-recursive-depth
10334 @itemx max-inline-recursive-depth-auto
10335 Specifies the maximum recursion depth used for recursive inlining.
10337 @option{--param max-inline-recursive-depth} applies to functions
10338 declared inline.  For functions not declared inline, recursive inlining
10339 happens only when @option{-finline-functions} (included in @option{-O3}) is
10340 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10341 default value is 8.
10343 @item min-inline-recursive-probability
10344 Recursive inlining is profitable only for function having deep recursion
10345 in average and can hurt for function having little recursion depth by
10346 increasing the prologue size or complexity of function body to other
10347 optimizers.
10349 When profile feedback is available (see @option{-fprofile-generate}) the actual
10350 recursion depth can be guessed from probability that function recurses via a
10351 given call expression.  This parameter limits inlining only to call expressions
10352 whose probability exceeds the given threshold (in percents).
10353 The default value is 10.
10355 @item early-inlining-insns
10356 Specify growth that the early inliner can make.  In effect it increases
10357 the amount of inlining for code having a large abstraction penalty.
10358 The default value is 14.
10360 @item max-early-inliner-iterations
10361 Limit of iterations of the early inliner.  This basically bounds
10362 the number of nested indirect calls the early inliner can resolve.
10363 Deeper chains are still handled by late inlining.
10365 @item comdat-sharing-probability
10366 Probability (in percent) that C++ inline function with comdat visibility
10367 are shared across multiple compilation units.  The default value is 20.
10369 @item profile-func-internal-id
10370 A parameter to control whether to use function internal id in profile
10371 database lookup. If the value is 0, the compiler uses an id that
10372 is based on function assembler name and filename, which makes old profile
10373 data more tolerant to source changes such as function reordering etc.
10374 The default value is 0.
10376 @item min-vect-loop-bound
10377 The minimum number of iterations under which loops are not vectorized
10378 when @option{-ftree-vectorize} is used.  The number of iterations after
10379 vectorization needs to be greater than the value specified by this option
10380 to allow vectorization.  The default value is 0.
10382 @item gcse-cost-distance-ratio
10383 Scaling factor in calculation of maximum distance an expression
10384 can be moved by GCSE optimizations.  This is currently supported only in the
10385 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10386 is with simple expressions, i.e., the expressions that have cost
10387 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10388 hoisting of simple expressions.  The default value is 10.
10390 @item gcse-unrestricted-cost
10391 Cost, roughly measured as the cost of a single typical machine
10392 instruction, at which GCSE optimizations do not constrain
10393 the distance an expression can travel.  This is currently
10394 supported only in the code hoisting pass.  The lesser the cost,
10395 the more aggressive code hoisting is.  Specifying 0 
10396 allows all expressions to travel unrestricted distances.
10397 The default value is 3.
10399 @item max-hoist-depth
10400 The depth of search in the dominator tree for expressions to hoist.
10401 This is used to avoid quadratic behavior in hoisting algorithm.
10402 The value of 0 does not limit on the search, but may slow down compilation
10403 of huge functions.  The default value is 30.
10405 @item max-tail-merge-comparisons
10406 The maximum amount of similar bbs to compare a bb with.  This is used to
10407 avoid quadratic behavior in tree tail merging.  The default value is 10.
10409 @item max-tail-merge-iterations
10410 The maximum amount of iterations of the pass over the function.  This is used to
10411 limit compilation time in tree tail merging.  The default value is 2.
10413 @item max-unrolled-insns
10414 The maximum number of instructions that a loop may have to be unrolled.
10415 If a loop is unrolled, this parameter also determines how many times
10416 the loop code is unrolled.
10418 @item max-average-unrolled-insns
10419 The maximum number of instructions biased by probabilities of their execution
10420 that a loop may have to be unrolled.  If a loop is unrolled,
10421 this parameter also determines how many times the loop code is unrolled.
10423 @item max-unroll-times
10424 The maximum number of unrollings of a single loop.
10426 @item max-peeled-insns
10427 The maximum number of instructions that a loop may have to be peeled.
10428 If a loop is peeled, this parameter also determines how many times
10429 the loop code is peeled.
10431 @item max-peel-times
10432 The maximum number of peelings of a single loop.
10434 @item max-peel-branches
10435 The maximum number of branches on the hot path through the peeled sequence.
10437 @item max-completely-peeled-insns
10438 The maximum number of insns of a completely peeled loop.
10440 @item max-completely-peel-times
10441 The maximum number of iterations of a loop to be suitable for complete peeling.
10443 @item max-completely-peel-loop-nest-depth
10444 The maximum depth of a loop nest suitable for complete peeling.
10446 @item max-unswitch-insns
10447 The maximum number of insns of an unswitched loop.
10449 @item max-unswitch-level
10450 The maximum number of branches unswitched in a single loop.
10452 @item lim-expensive
10453 The minimum cost of an expensive expression in the loop invariant motion.
10455 @item iv-consider-all-candidates-bound
10456 Bound on number of candidates for induction variables, below which
10457 all candidates are considered for each use in induction variable
10458 optimizations.  If there are more candidates than this,
10459 only the most relevant ones are considered to avoid quadratic time complexity.
10461 @item iv-max-considered-uses
10462 The induction variable optimizations give up on loops that contain more
10463 induction variable uses.
10465 @item iv-always-prune-cand-set-bound
10466 If the number of candidates in the set is smaller than this value,
10467 always try to remove unnecessary ivs from the set
10468 when adding a new one.
10470 @item scev-max-expr-size
10471 Bound on size of expressions used in the scalar evolutions analyzer.
10472 Large expressions slow the analyzer.
10474 @item scev-max-expr-complexity
10475 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10476 Complex expressions slow the analyzer.
10478 @item omega-max-vars
10479 The maximum number of variables in an Omega constraint system.
10480 The default value is 128.
10482 @item omega-max-geqs
10483 The maximum number of inequalities in an Omega constraint system.
10484 The default value is 256.
10486 @item omega-max-eqs
10487 The maximum number of equalities in an Omega constraint system.
10488 The default value is 128.
10490 @item omega-max-wild-cards
10491 The maximum number of wildcard variables that the Omega solver is
10492 able to insert.  The default value is 18.
10494 @item omega-hash-table-size
10495 The size of the hash table in the Omega solver.  The default value is
10496 550.
10498 @item omega-max-keys
10499 The maximal number of keys used by the Omega solver.  The default
10500 value is 500.
10502 @item omega-eliminate-redundant-constraints
10503 When set to 1, use expensive methods to eliminate all redundant
10504 constraints.  The default value is 0.
10506 @item vect-max-version-for-alignment-checks
10507 The maximum number of run-time checks that can be performed when
10508 doing loop versioning for alignment in the vectorizer.
10510 @item vect-max-version-for-alias-checks
10511 The maximum number of run-time checks that can be performed when
10512 doing loop versioning for alias in the vectorizer.
10514 @item vect-max-peeling-for-alignment
10515 The maximum number of loop peels to enhance access alignment
10516 for vectorizer. Value -1 means 'no limit'.
10518 @item max-iterations-to-track
10519 The maximum number of iterations of a loop the brute-force algorithm
10520 for analysis of the number of iterations of the loop tries to evaluate.
10522 @item hot-bb-count-ws-permille
10523 A basic block profile count is considered hot if it contributes to 
10524 the given permillage (i.e. 0...1000) of the entire profiled execution.
10526 @item hot-bb-frequency-fraction
10527 Select fraction of the entry block frequency of executions of basic block in
10528 function given basic block needs to have to be considered hot.
10530 @item max-predicted-iterations
10531 The maximum number of loop iterations we predict statically.  This is useful
10532 in cases where a function contains a single loop with known bound and
10533 another loop with unknown bound.
10534 The known number of iterations is predicted correctly, while
10535 the unknown number of iterations average to roughly 10.  This means that the
10536 loop without bounds appears artificially cold relative to the other one.
10538 @item builtin-expect-probability
10539 Control the probability of the expression having the specified value. This
10540 parameter takes a percentage (i.e. 0 ... 100) as input.
10541 The default probability of 90 is obtained empirically.
10543 @item align-threshold
10545 Select fraction of the maximal frequency of executions of a basic block in
10546 a function to align the basic block.
10548 @item align-loop-iterations
10550 A loop expected to iterate at least the selected number of iterations is
10551 aligned.
10553 @item tracer-dynamic-coverage
10554 @itemx tracer-dynamic-coverage-feedback
10556 This value is used to limit superblock formation once the given percentage of
10557 executed instructions is covered.  This limits unnecessary code size
10558 expansion.
10560 The @option{tracer-dynamic-coverage-feedback} parameter
10561 is used only when profile
10562 feedback is available.  The real profiles (as opposed to statically estimated
10563 ones) are much less balanced allowing the threshold to be larger value.
10565 @item tracer-max-code-growth
10566 Stop tail duplication once code growth has reached given percentage.  This is
10567 a rather artificial limit, as most of the duplicates are eliminated later in
10568 cross jumping, so it may be set to much higher values than is the desired code
10569 growth.
10571 @item tracer-min-branch-ratio
10573 Stop reverse growth when the reverse probability of best edge is less than this
10574 threshold (in percent).
10576 @item tracer-min-branch-ratio
10577 @itemx tracer-min-branch-ratio-feedback
10579 Stop forward growth if the best edge has probability lower than this
10580 threshold.
10582 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10583 compilation for profile feedback and one for compilation without.  The value
10584 for compilation with profile feedback needs to be more conservative (higher) in
10585 order to make tracer effective.
10587 @item max-cse-path-length
10589 The maximum number of basic blocks on path that CSE considers.
10590 The default is 10.
10592 @item max-cse-insns
10593 The maximum number of instructions CSE processes before flushing.
10594 The default is 1000.
10596 @item ggc-min-expand
10598 GCC uses a garbage collector to manage its own memory allocation.  This
10599 parameter specifies the minimum percentage by which the garbage
10600 collector's heap should be allowed to expand between collections.
10601 Tuning this may improve compilation speed; it has no effect on code
10602 generation.
10604 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10605 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10606 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10607 GCC is not able to calculate RAM on a particular platform, the lower
10608 bound of 30% is used.  Setting this parameter and
10609 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10610 every opportunity.  This is extremely slow, but can be useful for
10611 debugging.
10613 @item ggc-min-heapsize
10615 Minimum size of the garbage collector's heap before it begins bothering
10616 to collect garbage.  The first collection occurs after the heap expands
10617 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10618 tuning this may improve compilation speed, and has no effect on code
10619 generation.
10621 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10622 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10623 with a lower bound of 4096 (four megabytes) and an upper bound of
10624 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10625 particular platform, the lower bound is used.  Setting this parameter
10626 very large effectively disables garbage collection.  Setting this
10627 parameter and @option{ggc-min-expand} to zero causes a full collection
10628 to occur at every opportunity.
10630 @item max-reload-search-insns
10631 The maximum number of instruction reload should look backward for equivalent
10632 register.  Increasing values mean more aggressive optimization, making the
10633 compilation time increase with probably slightly better performance.
10634 The default value is 100.
10636 @item max-cselib-memory-locations
10637 The maximum number of memory locations cselib should take into account.
10638 Increasing values mean more aggressive optimization, making the compilation time
10639 increase with probably slightly better performance.  The default value is 500.
10641 @item reorder-blocks-duplicate
10642 @itemx reorder-blocks-duplicate-feedback
10644 Used by the basic block reordering pass to decide whether to use unconditional
10645 branch or duplicate the code on its destination.  Code is duplicated when its
10646 estimated size is smaller than this value multiplied by the estimated size of
10647 unconditional jump in the hot spots of the program.
10649 The @option{reorder-block-duplicate-feedback} parameter
10650 is used only when profile
10651 feedback is available.  It may be set to higher values than
10652 @option{reorder-block-duplicate} since information about the hot spots is more
10653 accurate.
10655 @item max-sched-ready-insns
10656 The maximum number of instructions ready to be issued the scheduler should
10657 consider at any given time during the first scheduling pass.  Increasing
10658 values mean more thorough searches, making the compilation time increase
10659 with probably little benefit.  The default value is 100.
10661 @item max-sched-region-blocks
10662 The maximum number of blocks in a region to be considered for
10663 interblock scheduling.  The default value is 10.
10665 @item max-pipeline-region-blocks
10666 The maximum number of blocks in a region to be considered for
10667 pipelining in the selective scheduler.  The default value is 15.
10669 @item max-sched-region-insns
10670 The maximum number of insns in a region to be considered for
10671 interblock scheduling.  The default value is 100.
10673 @item max-pipeline-region-insns
10674 The maximum number of insns in a region to be considered for
10675 pipelining in the selective scheduler.  The default value is 200.
10677 @item min-spec-prob
10678 The minimum probability (in percents) of reaching a source block
10679 for interblock speculative scheduling.  The default value is 40.
10681 @item max-sched-extend-regions-iters
10682 The maximum number of iterations through CFG to extend regions.
10683 A value of 0 (the default) disables region extensions.
10685 @item max-sched-insn-conflict-delay
10686 The maximum conflict delay for an insn to be considered for speculative motion.
10687 The default value is 3.
10689 @item sched-spec-prob-cutoff
10690 The minimal probability of speculation success (in percents), so that
10691 speculative insns are scheduled.
10692 The default value is 40.
10694 @item sched-spec-state-edge-prob-cutoff
10695 The minimum probability an edge must have for the scheduler to save its
10696 state across it.
10697 The default value is 10.
10699 @item sched-mem-true-dep-cost
10700 Minimal distance (in CPU cycles) between store and load targeting same
10701 memory locations.  The default value is 1.
10703 @item selsched-max-lookahead
10704 The maximum size of the lookahead window of selective scheduling.  It is a
10705 depth of search for available instructions.
10706 The default value is 50.
10708 @item selsched-max-sched-times
10709 The maximum number of times that an instruction is scheduled during
10710 selective scheduling.  This is the limit on the number of iterations
10711 through which the instruction may be pipelined.  The default value is 2.
10713 @item selsched-max-insns-to-rename
10714 The maximum number of best instructions in the ready list that are considered
10715 for renaming in the selective scheduler.  The default value is 2.
10717 @item sms-min-sc
10718 The minimum value of stage count that swing modulo scheduler
10719 generates.  The default value is 2.
10721 @item max-last-value-rtl
10722 The maximum size measured as number of RTLs that can be recorded in an expression
10723 in combiner for a pseudo register as last known value of that register.  The default
10724 is 10000.
10726 @item max-combine-insns
10727 The maximum number of instructions the RTL combiner tries to combine.
10728 The default value is 2 at @option{-Og} and 4 otherwise.
10730 @item integer-share-limit
10731 Small integer constants can use a shared data structure, reducing the
10732 compiler's memory usage and increasing its speed.  This sets the maximum
10733 value of a shared integer constant.  The default value is 256.
10735 @item ssp-buffer-size
10736 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10737 protection when @option{-fstack-protection} is used.
10739 @item min-size-for-stack-sharing
10740 The minimum size of variables taking part in stack slot sharing when not
10741 optimizing. The default value is 32.
10743 @item max-jump-thread-duplication-stmts
10744 Maximum number of statements allowed in a block that needs to be
10745 duplicated when threading jumps.
10747 @item max-fields-for-field-sensitive
10748 Maximum number of fields in a structure treated in
10749 a field sensitive manner during pointer analysis.  The default is zero
10750 for @option{-O0} and @option{-O1},
10751 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10753 @item prefetch-latency
10754 Estimate on average number of instructions that are executed before
10755 prefetch finishes.  The distance prefetched ahead is proportional
10756 to this constant.  Increasing this number may also lead to less
10757 streams being prefetched (see @option{simultaneous-prefetches}).
10759 @item simultaneous-prefetches
10760 Maximum number of prefetches that can run at the same time.
10762 @item l1-cache-line-size
10763 The size of cache line in L1 cache, in bytes.
10765 @item l1-cache-size
10766 The size of L1 cache, in kilobytes.
10768 @item l2-cache-size
10769 The size of L2 cache, in kilobytes.
10771 @item min-insn-to-prefetch-ratio
10772 The minimum ratio between the number of instructions and the
10773 number of prefetches to enable prefetching in a loop.
10775 @item prefetch-min-insn-to-mem-ratio
10776 The minimum ratio between the number of instructions and the
10777 number of memory references to enable prefetching in a loop.
10779 @item use-canonical-types
10780 Whether the compiler should use the ``canonical'' type system.  By
10781 default, this should always be 1, which uses a more efficient internal
10782 mechanism for comparing types in C++ and Objective-C++.  However, if
10783 bugs in the canonical type system are causing compilation failures,
10784 set this value to 0 to disable canonical types.
10786 @item switch-conversion-max-branch-ratio
10787 Switch initialization conversion refuses to create arrays that are
10788 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10789 branches in the switch.
10791 @item max-partial-antic-length
10792 Maximum length of the partial antic set computed during the tree
10793 partial redundancy elimination optimization (@option{-ftree-pre}) when
10794 optimizing at @option{-O3} and above.  For some sorts of source code
10795 the enhanced partial redundancy elimination optimization can run away,
10796 consuming all of the memory available on the host machine.  This
10797 parameter sets a limit on the length of the sets that are computed,
10798 which prevents the runaway behavior.  Setting a value of 0 for
10799 this parameter allows an unlimited set length.
10801 @item sccvn-max-scc-size
10802 Maximum size of a strongly connected component (SCC) during SCCVN
10803 processing.  If this limit is hit, SCCVN processing for the whole
10804 function is not done and optimizations depending on it are
10805 disabled.  The default maximum SCC size is 10000.
10807 @item sccvn-max-alias-queries-per-access
10808 Maximum number of alias-oracle queries we perform when looking for
10809 redundancies for loads and stores.  If this limit is hit the search
10810 is aborted and the load or store is not considered redundant.  The
10811 number of queries is algorithmically limited to the number of
10812 stores on all paths from the load to the function entry.
10813 The default maxmimum number of queries is 1000.
10815 @item ira-max-loops-num
10816 IRA uses regional register allocation by default.  If a function
10817 contains more loops than the number given by this parameter, only at most
10818 the given number of the most frequently-executed loops form regions
10819 for regional register allocation.  The default value of the
10820 parameter is 100.
10822 @item ira-max-conflict-table-size 
10823 Although IRA uses a sophisticated algorithm to compress the conflict
10824 table, the table can still require excessive amounts of memory for
10825 huge functions.  If the conflict table for a function could be more
10826 than the size in MB given by this parameter, the register allocator
10827 instead uses a faster, simpler, and lower-quality
10828 algorithm that does not require building a pseudo-register conflict table.  
10829 The default value of the parameter is 2000.
10831 @item ira-loop-reserved-regs
10832 IRA can be used to evaluate more accurate register pressure in loops
10833 for decisions to move loop invariants (see @option{-O3}).  The number
10834 of available registers reserved for some other purposes is given
10835 by this parameter.  The default value of the parameter is 2, which is
10836 the minimal number of registers needed by typical instructions.
10837 This value is the best found from numerous experiments.
10839 @item lra-inheritance-ebb-probability-cutoff
10840 LRA tries to reuse values reloaded in registers in subsequent insns.
10841 This optimization is called inheritance.  EBB is used as a region to
10842 do this optimization.  The parameter defines a minimal fall-through
10843 edge probability in percentage used to add BB to inheritance EBB in
10844 LRA.  The default value of the parameter is 40.  The value was chosen
10845 from numerous runs of SPEC2000 on x86-64.
10847 @item loop-invariant-max-bbs-in-loop
10848 Loop invariant motion can be very expensive, both in compilation time and
10849 in amount of needed compile-time memory, with very large loops.  Loops
10850 with more basic blocks than this parameter won't have loop invariant
10851 motion optimization performed on them.  The default value of the
10852 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10854 @item loop-max-datarefs-for-datadeps
10855 Building data dapendencies is expensive for very large loops.  This
10856 parameter limits the number of data references in loops that are
10857 considered for data dependence analysis.  These large loops are no
10858 handled by the optimizations using loop data dependencies.
10859 The default value is 1000.
10861 @item max-vartrack-size
10862 Sets a maximum number of hash table slots to use during variable
10863 tracking dataflow analysis of any function.  If this limit is exceeded
10864 with variable tracking at assignments enabled, analysis for that
10865 function is retried without it, after removing all debug insns from
10866 the function.  If the limit is exceeded even without debug insns, var
10867 tracking analysis is completely disabled for the function.  Setting
10868 the parameter to zero makes it unlimited.
10870 @item max-vartrack-expr-depth
10871 Sets a maximum number of recursion levels when attempting to map
10872 variable names or debug temporaries to value expressions.  This trades
10873 compilation time for more complete debug information.  If this is set too
10874 low, value expressions that are available and could be represented in
10875 debug information may end up not being used; setting this higher may
10876 enable the compiler to find more complex debug expressions, but compile
10877 time and memory use may grow.  The default is 12.
10879 @item min-nondebug-insn-uid
10880 Use uids starting at this parameter for nondebug insns.  The range below
10881 the parameter is reserved exclusively for debug insns created by
10882 @option{-fvar-tracking-assignments}, but debug insns may get
10883 (non-overlapping) uids above it if the reserved range is exhausted.
10885 @item ipa-sra-ptr-growth-factor
10886 IPA-SRA replaces a pointer to an aggregate with one or more new
10887 parameters only when their cumulative size is less or equal to
10888 @option{ipa-sra-ptr-growth-factor} times the size of the original
10889 pointer parameter.
10891 @item sra-max-scalarization-size-Ospeed
10892 @item sra-max-scalarization-size-Osize
10893 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10894 replace scalar parts of aggregates with uses of independent scalar
10895 variables.  These parameters control the maximum size, in storage units,
10896 of aggregate which is considered for replacement when compiling for
10897 speed
10898 (@option{sra-max-scalarization-size-Ospeed}) or size
10899 (@option{sra-max-scalarization-size-Osize}) respectively.
10901 @item tm-max-aggregate-size
10902 When making copies of thread-local variables in a transaction, this
10903 parameter specifies the size in bytes after which variables are
10904 saved with the logging functions as opposed to save/restore code
10905 sequence pairs.  This option only applies when using
10906 @option{-fgnu-tm}.
10908 @item graphite-max-nb-scop-params
10909 To avoid exponential effects in the Graphite loop transforms, the
10910 number of parameters in a Static Control Part (SCoP) is bounded.  The
10911 default value is 10 parameters.  A variable whose value is unknown at
10912 compilation time and defined outside a SCoP is a parameter of the SCoP.
10914 @item graphite-max-bbs-per-function
10915 To avoid exponential effects in the detection of SCoPs, the size of
10916 the functions analyzed by Graphite is bounded.  The default value is
10917 100 basic blocks.
10919 @item loop-block-tile-size
10920 Loop blocking or strip mining transforms, enabled with
10921 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10922 loop in the loop nest by a given number of iterations.  The strip
10923 length can be changed using the @option{loop-block-tile-size}
10924 parameter.  The default value is 51 iterations.
10926 @item loop-unroll-jam-size
10927 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10928 default value is 4.
10930 @item loop-unroll-jam-depth
10931 Specify the dimension to be unrolled (counting from the most inner loop)
10932 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10934 @item ipa-cp-value-list-size
10935 IPA-CP attempts to track all possible values and types passed to a function's
10936 parameter in order to propagate them and perform devirtualization.
10937 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10938 stores per one formal parameter of a function.
10940 @item ipa-cp-eval-threshold
10941 IPA-CP calculates its own score of cloning profitability heuristics
10942 and performs those cloning opportunities with scores that exceed
10943 @option{ipa-cp-eval-threshold}.
10945 @item ipa-cp-recursion-penalty
10946 Percentage penalty the recursive functions will receive when they
10947 are evaluated for cloning.
10949 @item ipa-cp-single-call-penalty
10950 Percentage penalty functions containg a single call to another
10951 function will receive when they are evaluated for cloning.
10954 @item ipa-max-agg-items
10955 IPA-CP is also capable to propagate a number of scalar values passed
10956 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10957 number of such values per one parameter.
10959 @item ipa-cp-loop-hint-bonus
10960 When IPA-CP determines that a cloning candidate would make the number
10961 of iterations of a loop known, it adds a bonus of
10962 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10963 the candidate.
10965 @item ipa-cp-array-index-hint-bonus
10966 When IPA-CP determines that a cloning candidate would make the index of
10967 an array access known, it adds a bonus of
10968 @option{ipa-cp-array-index-hint-bonus} to the profitability
10969 score of the candidate.
10971 @item ipa-max-aa-steps
10972 During its analysis of function bodies, IPA-CP employs alias analysis
10973 in order to track values pointed to by function parameters.  In order
10974 not spend too much time analyzing huge functions, it gives up and
10975 consider all memory clobbered after examining
10976 @option{ipa-max-aa-steps} statements modifying memory.
10978 @item lto-partitions
10979 Specify desired number of partitions produced during WHOPR compilation.
10980 The number of partitions should exceed the number of CPUs used for compilation.
10981 The default value is 32.
10983 @item lto-minpartition
10984 Size of minimal partition for WHOPR (in estimated instructions).
10985 This prevents expenses of splitting very small programs into too many
10986 partitions.
10988 @item cxx-max-namespaces-for-diagnostic-help
10989 The maximum number of namespaces to consult for suggestions when C++
10990 name lookup fails for an identifier.  The default is 1000.
10992 @item sink-frequency-threshold
10993 The maximum relative execution frequency (in percents) of the target block
10994 relative to a statement's original block to allow statement sinking of a
10995 statement.  Larger numbers result in more aggressive statement sinking.
10996 The default value is 75.  A small positive adjustment is applied for
10997 statements with memory operands as those are even more profitable so sink.
10999 @item max-stores-to-sink
11000 The maximum number of conditional stores paires that can be sunk.  Set to 0
11001 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11002 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
11004 @item allow-store-data-races
11005 Allow optimizers to introduce new data races on stores.
11006 Set to 1 to allow, otherwise to 0.  This option is enabled by default
11007 at optimization level @option{-Ofast}.
11009 @item case-values-threshold
11010 The smallest number of different values for which it is best to use a
11011 jump-table instead of a tree of conditional branches.  If the value is
11012 0, use the default for the machine.  The default is 0.
11014 @item tree-reassoc-width
11015 Set the maximum number of instructions executed in parallel in
11016 reassociated tree. This parameter overrides target dependent
11017 heuristics used by default if has non zero value.
11019 @item sched-pressure-algorithm
11020 Choose between the two available implementations of
11021 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11022 and is the more likely to prevent instructions from being reordered.
11023 Algorithm 2 was designed to be a compromise between the relatively
11024 conservative approach taken by algorithm 1 and the rather aggressive
11025 approach taken by the default scheduler.  It relies more heavily on
11026 having a regular register file and accurate register pressure classes.
11027 See @file{haifa-sched.c} in the GCC sources for more details.
11029 The default choice depends on the target.
11031 @item max-slsr-cand-scan
11032 Set the maximum number of existing candidates that are considered when
11033 seeking a basis for a new straight-line strength reduction candidate.
11035 @item asan-globals
11036 Enable buffer overflow detection for global objects.  This kind
11037 of protection is enabled by default if you are using
11038 @option{-fsanitize=address} option.
11039 To disable global objects protection use @option{--param asan-globals=0}.
11041 @item asan-stack
11042 Enable buffer overflow detection for stack objects.  This kind of
11043 protection is enabled by default when using@option{-fsanitize=address}.
11044 To disable stack protection use @option{--param asan-stack=0} option.
11046 @item asan-instrument-reads
11047 Enable buffer overflow detection for memory reads.  This kind of
11048 protection is enabled by default when using @option{-fsanitize=address}.
11049 To disable memory reads protection use
11050 @option{--param asan-instrument-reads=0}.
11052 @item asan-instrument-writes
11053 Enable buffer overflow detection for memory writes.  This kind of
11054 protection is enabled by default when using @option{-fsanitize=address}.
11055 To disable memory writes protection use
11056 @option{--param asan-instrument-writes=0} option.
11058 @item asan-memintrin
11059 Enable detection for built-in functions.  This kind of protection
11060 is enabled by default when using @option{-fsanitize=address}.
11061 To disable built-in functions protection use
11062 @option{--param asan-memintrin=0}.
11064 @item asan-use-after-return
11065 Enable detection of use-after-return.  This kind of protection
11066 is enabled by default when using @option{-fsanitize=address} option.
11067 To disable use-after-return detection use 
11068 @option{--param asan-use-after-return=0}.
11070 @item asan-instrumentation-with-call-threshold
11071 If number of memory accesses in function being instrumented
11072 is greater or equal to this number, use callbacks instead of inline checks.
11073 E.g. to disable inline code use
11074 @option{--param asan-instrumentation-with-call-threshold=0}.
11076 @item chkp-max-ctor-size
11077 Static constructors generated by Pointer Bounds Checker may become very
11078 large and significantly increase compile time at optimization level
11079 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
11080 in a single generated constructor.  Default value is 5000.
11082 @item max-fsm-thread-path-insns
11083 Maximum number of instructions to copy when duplicating blocks on a
11084 finite state automaton jump thread path.  The default is 100.
11086 @item max-fsm-thread-length
11087 Maximum number of basic blocks on a finite state automaton jump thread
11088 path.  The default is 10.
11090 @item max-fsm-thread-paths
11091 Maximum number of new jump thread paths to create for a finite state
11092 automaton.  The default is 50.
11094 @end table
11095 @end table
11097 @node Preprocessor Options
11098 @section Options Controlling the Preprocessor
11099 @cindex preprocessor options
11100 @cindex options, preprocessor
11102 These options control the C preprocessor, which is run on each C source
11103 file before actual compilation.
11105 If you use the @option{-E} option, nothing is done except preprocessing.
11106 Some of these options make sense only together with @option{-E} because
11107 they cause the preprocessor output to be unsuitable for actual
11108 compilation.
11110 @table @gcctabopt
11111 @item -Wp,@var{option}
11112 @opindex Wp
11113 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11114 and pass @var{option} directly through to the preprocessor.  If
11115 @var{option} contains commas, it is split into multiple options at the
11116 commas.  However, many options are modified, translated or interpreted
11117 by the compiler driver before being passed to the preprocessor, and
11118 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11119 interface is undocumented and subject to change, so whenever possible
11120 you should avoid using @option{-Wp} and let the driver handle the
11121 options instead.
11123 @item -Xpreprocessor @var{option}
11124 @opindex Xpreprocessor
11125 Pass @var{option} as an option to the preprocessor.  You can use this to
11126 supply system-specific preprocessor options that GCC does not 
11127 recognize.
11129 If you want to pass an option that takes an argument, you must use
11130 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11132 @item -no-integrated-cpp
11133 @opindex no-integrated-cpp
11134 Perform preprocessing as a separate pass before compilation.
11135 By default, GCC performs preprocessing as an integrated part of
11136 input tokenization and parsing.
11137 If this option is provided, the appropriate language front end
11138 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11139 and Objective-C, respectively) is instead invoked twice,
11140 once for preprocessing only and once for actual compilation
11141 of the preprocessed input.
11142 This option may be useful in conjunction with the @option{-B} or
11143 @option{-wrapper} options to specify an alternate preprocessor or
11144 perform additional processing of the program source between
11145 normal preprocessing and compilation.
11146 @end table
11148 @include cppopts.texi
11150 @node Assembler Options
11151 @section Passing Options to the Assembler
11153 @c prevent bad page break with this line
11154 You can pass options to the assembler.
11156 @table @gcctabopt
11157 @item -Wa,@var{option}
11158 @opindex Wa
11159 Pass @var{option} as an option to the assembler.  If @var{option}
11160 contains commas, it is split into multiple options at the commas.
11162 @item -Xassembler @var{option}
11163 @opindex Xassembler
11164 Pass @var{option} as an option to the assembler.  You can use this to
11165 supply system-specific assembler options that GCC does not
11166 recognize.
11168 If you want to pass an option that takes an argument, you must use
11169 @option{-Xassembler} twice, once for the option and once for the argument.
11171 @end table
11173 @node Link Options
11174 @section Options for Linking
11175 @cindex link options
11176 @cindex options, linking
11178 These options come into play when the compiler links object files into
11179 an executable output file.  They are meaningless if the compiler is
11180 not doing a link step.
11182 @table @gcctabopt
11183 @cindex file names
11184 @item @var{object-file-name}
11185 A file name that does not end in a special recognized suffix is
11186 considered to name an object file or library.  (Object files are
11187 distinguished from libraries by the linker according to the file
11188 contents.)  If linking is done, these object files are used as input
11189 to the linker.
11191 @item -c
11192 @itemx -S
11193 @itemx -E
11194 @opindex c
11195 @opindex S
11196 @opindex E
11197 If any of these options is used, then the linker is not run, and
11198 object file names should not be used as arguments.  @xref{Overall
11199 Options}.
11201 @item -fuse-ld=bfd
11202 @opindex fuse-ld=bfd
11203 Use the @command{bfd} linker instead of the default linker.
11205 @item -fuse-ld=gold
11206 @opindex fuse-ld=gold
11207 Use the @command{gold} linker instead of the default linker.
11209 @cindex Libraries
11210 @item -l@var{library}
11211 @itemx -l @var{library}
11212 @opindex l
11213 Search the library named @var{library} when linking.  (The second
11214 alternative with the library as a separate argument is only for
11215 POSIX compliance and is not recommended.)
11217 It makes a difference where in the command you write this option; the
11218 linker searches and processes libraries and object files in the order they
11219 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11220 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11221 to functions in @samp{z}, those functions may not be loaded.
11223 The linker searches a standard list of directories for the library,
11224 which is actually a file named @file{lib@var{library}.a}.  The linker
11225 then uses this file as if it had been specified precisely by name.
11227 The directories searched include several standard system directories
11228 plus any that you specify with @option{-L}.
11230 Normally the files found this way are library files---archive files
11231 whose members are object files.  The linker handles an archive file by
11232 scanning through it for members which define symbols that have so far
11233 been referenced but not defined.  But if the file that is found is an
11234 ordinary object file, it is linked in the usual fashion.  The only
11235 difference between using an @option{-l} option and specifying a file name
11236 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11237 and searches several directories.
11239 @item -lobjc
11240 @opindex lobjc
11241 You need this special case of the @option{-l} option in order to
11242 link an Objective-C or Objective-C++ program.
11244 @item -nostartfiles
11245 @opindex nostartfiles
11246 Do not use the standard system startup files when linking.
11247 The standard system libraries are used normally, unless @option{-nostdlib}
11248 or @option{-nodefaultlibs} is used.
11250 @item -nodefaultlibs
11251 @opindex nodefaultlibs
11252 Do not use the standard system libraries when linking.
11253 Only the libraries you specify are passed to the linker, and options
11254 specifying linkage of the system libraries, such as @option{-static-libgcc}
11255 or @option{-shared-libgcc}, are ignored.  
11256 The standard startup files are used normally, unless @option{-nostartfiles}
11257 is used.  
11259 The compiler may generate calls to @code{memcmp},
11260 @code{memset}, @code{memcpy} and @code{memmove}.
11261 These entries are usually resolved by entries in
11262 libc.  These entry points should be supplied through some other
11263 mechanism when this option is specified.
11265 @item -nostdlib
11266 @opindex nostdlib
11267 Do not use the standard system startup files or libraries when linking.
11268 No startup files and only the libraries you specify are passed to
11269 the linker, and options specifying linkage of the system libraries, such as
11270 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11272 The compiler may generate calls to @code{memcmp}, @code{memset},
11273 @code{memcpy} and @code{memmove}.
11274 These entries are usually resolved by entries in
11275 libc.  These entry points should be supplied through some other
11276 mechanism when this option is specified.
11278 @cindex @option{-lgcc}, use with @option{-nostdlib}
11279 @cindex @option{-nostdlib} and unresolved references
11280 @cindex unresolved references and @option{-nostdlib}
11281 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11282 @cindex @option{-nodefaultlibs} and unresolved references
11283 @cindex unresolved references and @option{-nodefaultlibs}
11284 One of the standard libraries bypassed by @option{-nostdlib} and
11285 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11286 which GCC uses to overcome shortcomings of particular machines, or special
11287 needs for some languages.
11288 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11289 Collection (GCC) Internals},
11290 for more discussion of @file{libgcc.a}.)
11291 In most cases, you need @file{libgcc.a} even when you want to avoid
11292 other standard libraries.  In other words, when you specify @option{-nostdlib}
11293 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11294 This ensures that you have no unresolved references to internal GCC
11295 library subroutines.
11296 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11297 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11298 GNU Compiler Collection (GCC) Internals}.)
11300 @item -pie
11301 @opindex pie
11302 Produce a position independent executable on targets that support it.
11303 For predictable results, you must also specify the same set of options
11304 used for compilation (@option{-fpie}, @option{-fPIE},
11305 or model suboptions) when you specify this linker option.
11307 @item -no-pie
11308 @opindex no-pie
11309 Don't produce a position independent executable.
11311 @item -rdynamic
11312 @opindex rdynamic
11313 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11314 that support it. This instructs the linker to add all symbols, not
11315 only used ones, to the dynamic symbol table. This option is needed
11316 for some uses of @code{dlopen} or to allow obtaining backtraces
11317 from within a program.
11319 @item -s
11320 @opindex s
11321 Remove all symbol table and relocation information from the executable.
11323 @item -static
11324 @opindex static
11325 On systems that support dynamic linking, this prevents linking with the shared
11326 libraries.  On other systems, this option has no effect.
11328 @item -shared
11329 @opindex shared
11330 Produce a shared object which can then be linked with other objects to
11331 form an executable.  Not all systems support this option.  For predictable
11332 results, you must also specify the same set of options used for compilation
11333 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11334 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11335 needs to build supplementary stub code for constructors to work.  On
11336 multi-libbed systems, @samp{gcc -shared} must select the correct support
11337 libraries to link against.  Failing to supply the correct flags may lead
11338 to subtle defects.  Supplying them in cases where they are not necessary
11339 is innocuous.}
11341 @item -shared-libgcc
11342 @itemx -static-libgcc
11343 @opindex shared-libgcc
11344 @opindex static-libgcc
11345 On systems that provide @file{libgcc} as a shared library, these options
11346 force the use of either the shared or static version, respectively.
11347 If no shared version of @file{libgcc} was built when the compiler was
11348 configured, these options have no effect.
11350 There are several situations in which an application should use the
11351 shared @file{libgcc} instead of the static version.  The most common
11352 of these is when the application wishes to throw and catch exceptions
11353 across different shared libraries.  In that case, each of the libraries
11354 as well as the application itself should use the shared @file{libgcc}.
11356 Therefore, the G++ and GCJ drivers automatically add
11357 @option{-shared-libgcc} whenever you build a shared library or a main
11358 executable, because C++ and Java programs typically use exceptions, so
11359 this is the right thing to do.
11361 If, instead, you use the GCC driver to create shared libraries, you may
11362 find that they are not always linked with the shared @file{libgcc}.
11363 If GCC finds, at its configuration time, that you have a non-GNU linker
11364 or a GNU linker that does not support option @option{--eh-frame-hdr},
11365 it links the shared version of @file{libgcc} into shared libraries
11366 by default.  Otherwise, it takes advantage of the linker and optimizes
11367 away the linking with the shared version of @file{libgcc}, linking with
11368 the static version of libgcc by default.  This allows exceptions to
11369 propagate through such shared libraries, without incurring relocation
11370 costs at library load time.
11372 However, if a library or main executable is supposed to throw or catch
11373 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11374 for the languages used in the program, or using the option
11375 @option{-shared-libgcc}, such that it is linked with the shared
11376 @file{libgcc}.
11378 @item -static-libasan
11379 @opindex static-libasan
11380 When the @option{-fsanitize=address} option is used to link a program,
11381 the GCC driver automatically links against @option{libasan}.  If
11382 @file{libasan} is available as a shared library, and the @option{-static}
11383 option is not used, then this links against the shared version of
11384 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11385 driver to link @file{libasan} statically, without necessarily linking
11386 other libraries statically.
11388 @item -static-libtsan
11389 @opindex static-libtsan
11390 When the @option{-fsanitize=thread} option is used to link a program,
11391 the GCC driver automatically links against @option{libtsan}.  If
11392 @file{libtsan} is available as a shared library, and the @option{-static}
11393 option is not used, then this links against the shared version of
11394 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11395 driver to link @file{libtsan} statically, without necessarily linking
11396 other libraries statically.
11398 @item -static-liblsan
11399 @opindex static-liblsan
11400 When the @option{-fsanitize=leak} option is used to link a program,
11401 the GCC driver automatically links against @option{liblsan}.  If
11402 @file{liblsan} is available as a shared library, and the @option{-static}
11403 option is not used, then this links against the shared version of
11404 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11405 driver to link @file{liblsan} statically, without necessarily linking
11406 other libraries statically.
11408 @item -static-libubsan
11409 @opindex static-libubsan
11410 When the @option{-fsanitize=undefined} option is used to link a program,
11411 the GCC driver automatically links against @option{libubsan}.  If
11412 @file{libubsan} is available as a shared library, and the @option{-static}
11413 option is not used, then this links against the shared version of
11414 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11415 driver to link @file{libubsan} statically, without necessarily linking
11416 other libraries statically.
11418 @item -static-libmpx
11419 @opindex static-libmpx
11420 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11421 used to link a program, the GCC driver automatically links against
11422 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11423 and the @option{-static} option is not used, then this links against
11424 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11425 option directs the GCC driver to link @file{libmpx} statically,
11426 without necessarily linking other libraries statically.
11428 @item -static-libmpxwrappers
11429 @opindex static-libmpxwrappers
11430 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11431 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11432 GCC driver automatically links against @file{libmpxwrappers}.  If
11433 @file{libmpxwrappers} is available as a shared library, and the
11434 @option{-static} option is not used, then this links against the shared
11435 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11436 option directs the GCC driver to link @file{libmpxwrappers} statically,
11437 without necessarily linking other libraries statically.
11439 @item -static-libstdc++
11440 @opindex static-libstdc++
11441 When the @command{g++} program is used to link a C++ program, it
11442 normally automatically links against @option{libstdc++}.  If
11443 @file{libstdc++} is available as a shared library, and the
11444 @option{-static} option is not used, then this links against the
11445 shared version of @file{libstdc++}.  That is normally fine.  However, it
11446 is sometimes useful to freeze the version of @file{libstdc++} used by
11447 the program without going all the way to a fully static link.  The
11448 @option{-static-libstdc++} option directs the @command{g++} driver to
11449 link @file{libstdc++} statically, without necessarily linking other
11450 libraries statically.
11452 @item -symbolic
11453 @opindex symbolic
11454 Bind references to global symbols when building a shared object.  Warn
11455 about any unresolved references (unless overridden by the link editor
11456 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11457 this option.
11459 @item -T @var{script}
11460 @opindex T
11461 @cindex linker script
11462 Use @var{script} as the linker script.  This option is supported by most
11463 systems using the GNU linker.  On some targets, such as bare-board
11464 targets without an operating system, the @option{-T} option may be required
11465 when linking to avoid references to undefined symbols.
11467 @item -Xlinker @var{option}
11468 @opindex Xlinker
11469 Pass @var{option} as an option to the linker.  You can use this to
11470 supply system-specific linker options that GCC does not recognize.
11472 If you want to pass an option that takes a separate argument, you must use
11473 @option{-Xlinker} twice, once for the option and once for the argument.
11474 For example, to pass @option{-assert definitions}, you must write
11475 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11476 @option{-Xlinker "-assert definitions"}, because this passes the entire
11477 string as a single argument, which is not what the linker expects.
11479 When using the GNU linker, it is usually more convenient to pass
11480 arguments to linker options using the @option{@var{option}=@var{value}}
11481 syntax than as separate arguments.  For example, you can specify
11482 @option{-Xlinker -Map=output.map} rather than
11483 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11484 this syntax for command-line options.
11486 @item -Wl,@var{option}
11487 @opindex Wl
11488 Pass @var{option} as an option to the linker.  If @var{option} contains
11489 commas, it is split into multiple options at the commas.  You can use this
11490 syntax to pass an argument to the option.
11491 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11492 linker.  When using the GNU linker, you can also get the same effect with
11493 @option{-Wl,-Map=output.map}.
11495 @item -u @var{symbol}
11496 @opindex u
11497 Pretend the symbol @var{symbol} is undefined, to force linking of
11498 library modules to define it.  You can use @option{-u} multiple times with
11499 different symbols to force loading of additional library modules.
11501 @item -z @var{keyword}
11502 @opindex z
11503 @option{-z} is passed directly on to the linker along with the keyword
11504 @var{keyword}. See the section in the documentation of your linker for
11505 permitted values and their meanings.
11506 @end table
11508 @node Directory Options
11509 @section Options for Directory Search
11510 @cindex directory options
11511 @cindex options, directory search
11512 @cindex search path
11514 These options specify directories to search for header files, for
11515 libraries and for parts of the compiler:
11517 @table @gcctabopt
11518 @item -I@var{dir}
11519 @opindex I
11520 Add the directory @var{dir} to the head of the list of directories to be
11521 searched for header files.  This can be used to override a system header
11522 file, substituting your own version, since these directories are
11523 searched before the system header file directories.  However, you should
11524 not use this option to add directories that contain vendor-supplied
11525 system header files (use @option{-isystem} for that).  If you use more than
11526 one @option{-I} option, the directories are scanned in left-to-right
11527 order; the standard system directories come after.
11529 If a standard system include directory, or a directory specified with
11530 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11531 option is ignored.  The directory is still searched but as a
11532 system directory at its normal position in the system include chain.
11533 This is to ensure that GCC's procedure to fix buggy system headers and
11534 the ordering for the @code{include_next} directive are not inadvertently changed.
11535 If you really need to change the search order for system directories,
11536 use the @option{-nostdinc} and/or @option{-isystem} options.
11538 @item -iplugindir=@var{dir}
11539 @opindex iplugindir=
11540 Set the directory to search for plugins that are passed
11541 by @option{-fplugin=@var{name}} instead of
11542 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11543 to be used by the user, but only passed by the driver.
11545 @item -iquote@var{dir}
11546 @opindex iquote
11547 Add the directory @var{dir} to the head of the list of directories to
11548 be searched for header files only for the case of @code{#include
11549 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11550 otherwise just like @option{-I}.
11552 @item -L@var{dir}
11553 @opindex L
11554 Add directory @var{dir} to the list of directories to be searched
11555 for @option{-l}.
11557 @item -B@var{prefix}
11558 @opindex B
11559 This option specifies where to find the executables, libraries,
11560 include files, and data files of the compiler itself.
11562 The compiler driver program runs one or more of the subprograms
11563 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11564 @var{prefix} as a prefix for each program it tries to run, both with and
11565 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11567 For each subprogram to be run, the compiler driver first tries the
11568 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11569 is not specified, the driver tries two standard prefixes, 
11570 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11571 those results in a file name that is found, the unmodified program
11572 name is searched for using the directories specified in your
11573 @env{PATH} environment variable.
11575 The compiler checks to see if the path provided by @option{-B}
11576 refers to a directory, and if necessary it adds a directory
11577 separator character at the end of the path.
11579 @option{-B} prefixes that effectively specify directory names also apply
11580 to libraries in the linker, because the compiler translates these
11581 options into @option{-L} options for the linker.  They also apply to
11582 include files in the preprocessor, because the compiler translates these
11583 options into @option{-isystem} options for the preprocessor.  In this case,
11584 the compiler appends @samp{include} to the prefix.
11586 The runtime support file @file{libgcc.a} can also be searched for using
11587 the @option{-B} prefix, if needed.  If it is not found there, the two
11588 standard prefixes above are tried, and that is all.  The file is left
11589 out of the link if it is not found by those means.
11591 Another way to specify a prefix much like the @option{-B} prefix is to use
11592 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11593 Variables}.
11595 As a special kludge, if the path provided by @option{-B} is
11596 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11597 9, then it is replaced by @file{[dir/]include}.  This is to help
11598 with boot-strapping the compiler.
11600 @item -specs=@var{file}
11601 @opindex specs
11602 Process @var{file} after the compiler reads in the standard @file{specs}
11603 file, in order to override the defaults which the @command{gcc} driver
11604 program uses when determining what switches to pass to @command{cc1},
11605 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11606 @option{-specs=@var{file}} can be specified on the command line, and they
11607 are processed in order, from left to right.
11609 @item --sysroot=@var{dir}
11610 @opindex sysroot
11611 Use @var{dir} as the logical root directory for headers and libraries.
11612 For example, if the compiler normally searches for headers in
11613 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11614 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11616 If you use both this option and the @option{-isysroot} option, then
11617 the @option{--sysroot} option applies to libraries, but the
11618 @option{-isysroot} option applies to header files.
11620 The GNU linker (beginning with version 2.16) has the necessary support
11621 for this option.  If your linker does not support this option, the
11622 header file aspect of @option{--sysroot} still works, but the
11623 library aspect does not.
11625 @item --no-sysroot-suffix
11626 @opindex no-sysroot-suffix
11627 For some targets, a suffix is added to the root directory specified
11628 with @option{--sysroot}, depending on the other options used, so that
11629 headers may for example be found in
11630 @file{@var{dir}/@var{suffix}/usr/include} instead of
11631 @file{@var{dir}/usr/include}.  This option disables the addition of
11632 such a suffix.
11634 @item -I-
11635 @opindex I-
11636 This option has been deprecated.  Please use @option{-iquote} instead for
11637 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11638 option.
11639 Any directories you specify with @option{-I} options before the @option{-I-}
11640 option are searched only for the case of @code{#include "@var{file}"};
11641 they are not searched for @code{#include <@var{file}>}.
11643 If additional directories are specified with @option{-I} options after
11644 the @option{-I-} option, these directories are searched for all @code{#include}
11645 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11646 this way.)
11648 In addition, the @option{-I-} option inhibits the use of the current
11649 directory (where the current input file came from) as the first search
11650 directory for @code{#include "@var{file}"}.  There is no way to
11651 override this effect of @option{-I-}.  With @option{-I.} you can specify
11652 searching the directory that is current when the compiler is
11653 invoked.  That is not exactly the same as what the preprocessor does
11654 by default, but it is often satisfactory.
11656 @option{-I-} does not inhibit the use of the standard system directories
11657 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11658 independent.
11659 @end table
11661 @c man end
11663 @node Spec Files
11664 @section Specifying Subprocesses and the Switches to Pass to Them
11665 @cindex Spec Files
11667 @command{gcc} is a driver program.  It performs its job by invoking a
11668 sequence of other programs to do the work of compiling, assembling and
11669 linking.  GCC interprets its command-line parameters and uses these to
11670 deduce which programs it should invoke, and which command-line options
11671 it ought to place on their command lines.  This behavior is controlled
11672 by @dfn{spec strings}.  In most cases there is one spec string for each
11673 program that GCC can invoke, but a few programs have multiple spec
11674 strings to control their behavior.  The spec strings built into GCC can
11675 be overridden by using the @option{-specs=} command-line switch to specify
11676 a spec file.
11678 @dfn{Spec files} are plaintext files that are used to construct spec
11679 strings.  They consist of a sequence of directives separated by blank
11680 lines.  The type of directive is determined by the first non-whitespace
11681 character on the line, which can be one of the following:
11683 @table @code
11684 @item %@var{command}
11685 Issues a @var{command} to the spec file processor.  The commands that can
11686 appear here are:
11688 @table @code
11689 @item %include <@var{file}>
11690 @cindex @code{%include}
11691 Search for @var{file} and insert its text at the current point in the
11692 specs file.
11694 @item %include_noerr <@var{file}>
11695 @cindex @code{%include_noerr}
11696 Just like @samp{%include}, but do not generate an error message if the include
11697 file cannot be found.
11699 @item %rename @var{old_name} @var{new_name}
11700 @cindex @code{%rename}
11701 Rename the spec string @var{old_name} to @var{new_name}.
11703 @end table
11705 @item *[@var{spec_name}]:
11706 This tells the compiler to create, override or delete the named spec
11707 string.  All lines after this directive up to the next directive or
11708 blank line are considered to be the text for the spec string.  If this
11709 results in an empty string then the spec is deleted.  (Or, if the
11710 spec did not exist, then nothing happens.)  Otherwise, if the spec
11711 does not currently exist a new spec is created.  If the spec does
11712 exist then its contents are overridden by the text of this
11713 directive, unless the first character of that text is the @samp{+}
11714 character, in which case the text is appended to the spec.
11716 @item [@var{suffix}]:
11717 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11718 and up to the next directive or blank line are considered to make up the
11719 spec string for the indicated suffix.  When the compiler encounters an
11720 input file with the named suffix, it processes the spec string in
11721 order to work out how to compile that file.  For example:
11723 @smallexample
11724 .ZZ:
11725 z-compile -input %i
11726 @end smallexample
11728 This says that any input file whose name ends in @samp{.ZZ} should be
11729 passed to the program @samp{z-compile}, which should be invoked with the
11730 command-line switch @option{-input} and with the result of performing the
11731 @samp{%i} substitution.  (See below.)
11733 As an alternative to providing a spec string, the text following a
11734 suffix directive can be one of the following:
11736 @table @code
11737 @item @@@var{language}
11738 This says that the suffix is an alias for a known @var{language}.  This is
11739 similar to using the @option{-x} command-line switch to GCC to specify a
11740 language explicitly.  For example:
11742 @smallexample
11743 .ZZ:
11744 @@c++
11745 @end smallexample
11747 Says that .ZZ files are, in fact, C++ source files.
11749 @item #@var{name}
11750 This causes an error messages saying:
11752 @smallexample
11753 @var{name} compiler not installed on this system.
11754 @end smallexample
11755 @end table
11757 GCC already has an extensive list of suffixes built into it.
11758 This directive adds an entry to the end of the list of suffixes, but
11759 since the list is searched from the end backwards, it is effectively
11760 possible to override earlier entries using this technique.
11762 @end table
11764 GCC has the following spec strings built into it.  Spec files can
11765 override these strings or create their own.  Note that individual
11766 targets can also add their own spec strings to this list.
11768 @smallexample
11769 asm          Options to pass to the assembler
11770 asm_final    Options to pass to the assembler post-processor
11771 cpp          Options to pass to the C preprocessor
11772 cc1          Options to pass to the C compiler
11773 cc1plus      Options to pass to the C++ compiler
11774 endfile      Object files to include at the end of the link
11775 link         Options to pass to the linker
11776 lib          Libraries to include on the command line to the linker
11777 libgcc       Decides which GCC support library to pass to the linker
11778 linker       Sets the name of the linker
11779 predefines   Defines to be passed to the C preprocessor
11780 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11781              by default
11782 startfile    Object files to include at the start of the link
11783 @end smallexample
11785 Here is a small example of a spec file:
11787 @smallexample
11788 %rename lib                 old_lib
11790 *lib:
11791 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11792 @end smallexample
11794 This example renames the spec called @samp{lib} to @samp{old_lib} and
11795 then overrides the previous definition of @samp{lib} with a new one.
11796 The new definition adds in some extra command-line options before
11797 including the text of the old definition.
11799 @dfn{Spec strings} are a list of command-line options to be passed to their
11800 corresponding program.  In addition, the spec strings can contain
11801 @samp{%}-prefixed sequences to substitute variable text or to
11802 conditionally insert text into the command line.  Using these constructs
11803 it is possible to generate quite complex command lines.
11805 Here is a table of all defined @samp{%}-sequences for spec
11806 strings.  Note that spaces are not generated automatically around the
11807 results of expanding these sequences.  Therefore you can concatenate them
11808 together or combine them with constant text in a single argument.
11810 @table @code
11811 @item %%
11812 Substitute one @samp{%} into the program name or argument.
11814 @item %i
11815 Substitute the name of the input file being processed.
11817 @item %b
11818 Substitute the basename of the input file being processed.
11819 This is the substring up to (and not including) the last period
11820 and not including the directory.
11822 @item %B
11823 This is the same as @samp{%b}, but include the file suffix (text after
11824 the last period).
11826 @item %d
11827 Marks the argument containing or following the @samp{%d} as a
11828 temporary file name, so that that file is deleted if GCC exits
11829 successfully.  Unlike @samp{%g}, this contributes no text to the
11830 argument.
11832 @item %g@var{suffix}
11833 Substitute a file name that has suffix @var{suffix} and is chosen
11834 once per compilation, and mark the argument in the same way as
11835 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11836 name is now chosen in a way that is hard to predict even when previously
11837 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11838 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11839 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11840 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11841 was simply substituted with a file name chosen once per compilation,
11842 without regard to any appended suffix (which was therefore treated
11843 just like ordinary text), making such attacks more likely to succeed.
11845 @item %u@var{suffix}
11846 Like @samp{%g}, but generates a new temporary file name
11847 each time it appears instead of once per compilation.
11849 @item %U@var{suffix}
11850 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11851 new one if there is no such last file name.  In the absence of any
11852 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11853 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11854 involves the generation of two distinct file names, one
11855 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11856 simply substituted with a file name chosen for the previous @samp{%u},
11857 without regard to any appended suffix.
11859 @item %j@var{suffix}
11860 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11861 writable, and if @option{-save-temps} is not used; 
11862 otherwise, substitute the name
11863 of a temporary file, just like @samp{%u}.  This temporary file is not
11864 meant for communication between processes, but rather as a junk
11865 disposal mechanism.
11867 @item %|@var{suffix}
11868 @itemx %m@var{suffix}
11869 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11870 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11871 all.  These are the two most common ways to instruct a program that it
11872 should read from standard input or write to standard output.  If you
11873 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11874 construct: see for example @file{f/lang-specs.h}.
11876 @item %.@var{SUFFIX}
11877 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11878 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11879 terminated by the next space or %.
11881 @item %w
11882 Marks the argument containing or following the @samp{%w} as the
11883 designated output file of this compilation.  This puts the argument
11884 into the sequence of arguments that @samp{%o} substitutes.
11886 @item %o
11887 Substitutes the names of all the output files, with spaces
11888 automatically placed around them.  You should write spaces
11889 around the @samp{%o} as well or the results are undefined.
11890 @samp{%o} is for use in the specs for running the linker.
11891 Input files whose names have no recognized suffix are not compiled
11892 at all, but they are included among the output files, so they are
11893 linked.
11895 @item %O
11896 Substitutes the suffix for object files.  Note that this is
11897 handled specially when it immediately follows @samp{%g, %u, or %U},
11898 because of the need for those to form complete file names.  The
11899 handling is such that @samp{%O} is treated exactly as if it had already
11900 been substituted, except that @samp{%g, %u, and %U} do not currently
11901 support additional @var{suffix} characters following @samp{%O} as they do
11902 following, for example, @samp{.o}.
11904 @item %p
11905 Substitutes the standard macro predefinitions for the
11906 current target machine.  Use this when running @command{cpp}.
11908 @item %P
11909 Like @samp{%p}, but puts @samp{__} before and after the name of each
11910 predefined macro, except for macros that start with @samp{__} or with
11911 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11914 @item %I
11915 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11916 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11917 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11918 and @option{-imultilib} as necessary.
11920 @item %s
11921 Current argument is the name of a library or startup file of some sort.
11922 Search for that file in a standard list of directories and substitute
11923 the full name found.  The current working directory is included in the
11924 list of directories scanned.
11926 @item %T
11927 Current argument is the name of a linker script.  Search for that file
11928 in the current list of directories to scan for libraries. If the file
11929 is located insert a @option{--script} option into the command line
11930 followed by the full path name found.  If the file is not found then
11931 generate an error message.  Note: the current working directory is not
11932 searched.
11934 @item %e@var{str}
11935 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11936 Use this when inconsistent options are detected.
11938 @item %(@var{name})
11939 Substitute the contents of spec string @var{name} at this point.
11941 @item %x@{@var{option}@}
11942 Accumulate an option for @samp{%X}.
11944 @item %X
11945 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11946 spec string.
11948 @item %Y
11949 Output the accumulated assembler options specified by @option{-Wa}.
11951 @item %Z
11952 Output the accumulated preprocessor options specified by @option{-Wp}.
11954 @item %a
11955 Process the @code{asm} spec.  This is used to compute the
11956 switches to be passed to the assembler.
11958 @item %A
11959 Process the @code{asm_final} spec.  This is a spec string for
11960 passing switches to an assembler post-processor, if such a program is
11961 needed.
11963 @item %l
11964 Process the @code{link} spec.  This is the spec for computing the
11965 command line passed to the linker.  Typically it makes use of the
11966 @samp{%L %G %S %D and %E} sequences.
11968 @item %D
11969 Dump out a @option{-L} option for each directory that GCC believes might
11970 contain startup files.  If the target supports multilibs then the
11971 current multilib directory is prepended to each of these paths.
11973 @item %L
11974 Process the @code{lib} spec.  This is a spec string for deciding which
11975 libraries are included on the command line to the linker.
11977 @item %G
11978 Process the @code{libgcc} spec.  This is a spec string for deciding
11979 which GCC support library is included on the command line to the linker.
11981 @item %S
11982 Process the @code{startfile} spec.  This is a spec for deciding which
11983 object files are the first ones passed to the linker.  Typically
11984 this might be a file named @file{crt0.o}.
11986 @item %E
11987 Process the @code{endfile} spec.  This is a spec string that specifies
11988 the last object files that are passed to the linker.
11990 @item %C
11991 Process the @code{cpp} spec.  This is used to construct the arguments
11992 to be passed to the C preprocessor.
11994 @item %1
11995 Process the @code{cc1} spec.  This is used to construct the options to be
11996 passed to the actual C compiler (@command{cc1}).
11998 @item %2
11999 Process the @code{cc1plus} spec.  This is used to construct the options to be
12000 passed to the actual C++ compiler (@command{cc1plus}).
12002 @item %*
12003 Substitute the variable part of a matched option.  See below.
12004 Note that each comma in the substituted string is replaced by
12005 a single space.
12007 @item %<@code{S}
12008 Remove all occurrences of @code{-S} from the command line.  Note---this
12009 command is position dependent.  @samp{%} commands in the spec string
12010 before this one see @code{-S}, @samp{%} commands in the spec string
12011 after this one do not.
12013 @item %:@var{function}(@var{args})
12014 Call the named function @var{function}, passing it @var{args}.
12015 @var{args} is first processed as a nested spec string, then split
12016 into an argument vector in the usual fashion.  The function returns
12017 a string which is processed as if it had appeared literally as part
12018 of the current spec.
12020 The following built-in spec functions are provided:
12022 @table @code
12023 @item @code{getenv}
12024 The @code{getenv} spec function takes two arguments: an environment
12025 variable name and a string.  If the environment variable is not
12026 defined, a fatal error is issued.  Otherwise, the return value is the
12027 value of the environment variable concatenated with the string.  For
12028 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
12030 @smallexample
12031 %:getenv(TOPDIR /include)
12032 @end smallexample
12034 expands to @file{/path/to/top/include}.
12036 @item @code{if-exists}
12037 The @code{if-exists} spec function takes one argument, an absolute
12038 pathname to a file.  If the file exists, @code{if-exists} returns the
12039 pathname.  Here is a small example of its usage:
12041 @smallexample
12042 *startfile:
12043 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
12044 @end smallexample
12046 @item @code{if-exists-else}
12047 The @code{if-exists-else} spec function is similar to the @code{if-exists}
12048 spec function, except that it takes two arguments.  The first argument is
12049 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
12050 returns the pathname.  If it does not exist, it returns the second argument.
12051 This way, @code{if-exists-else} can be used to select one file or another,
12052 based on the existence of the first.  Here is a small example of its usage:
12054 @smallexample
12055 *startfile:
12056 crt0%O%s %:if-exists(crti%O%s) \
12057 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
12058 @end smallexample
12060 @item @code{replace-outfile}
12061 The @code{replace-outfile} spec function takes two arguments.  It looks for the
12062 first argument in the outfiles array and replaces it with the second argument.  Here
12063 is a small example of its usage:
12065 @smallexample
12066 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
12067 @end smallexample
12069 @item @code{remove-outfile}
12070 The @code{remove-outfile} spec function takes one argument.  It looks for the
12071 first argument in the outfiles array and removes it.  Here is a small example
12072 its usage:
12074 @smallexample
12075 %:remove-outfile(-lm)
12076 @end smallexample
12078 @item @code{pass-through-libs}
12079 The @code{pass-through-libs} spec function takes any number of arguments.  It
12080 finds any @option{-l} options and any non-options ending in @file{.a} (which it
12081 assumes are the names of linker input library archive files) and returns a
12082 result containing all the found arguments each prepended by
12083 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
12084 intended to be passed to the LTO linker plugin.
12086 @smallexample
12087 %:pass-through-libs(%G %L %G)
12088 @end smallexample
12090 @item @code{print-asm-header}
12091 The @code{print-asm-header} function takes no arguments and simply
12092 prints a banner like:
12094 @smallexample
12095 Assembler options
12096 =================
12098 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
12099 @end smallexample
12101 It is used to separate compiler options from assembler options
12102 in the @option{--target-help} output.
12103 @end table
12105 @item %@{@code{S}@}
12106 Substitutes the @code{-S} switch, if that switch is given to GCC@.
12107 If that switch is not specified, this substitutes nothing.  Note that
12108 the leading dash is omitted when specifying this option, and it is
12109 automatically inserted if the substitution is performed.  Thus the spec
12110 string @samp{%@{foo@}} matches the command-line option @option{-foo}
12111 and outputs the command-line option @option{-foo}.
12113 @item %W@{@code{S}@}
12114 Like %@{@code{S}@} but mark last argument supplied within as a file to be
12115 deleted on failure.
12117 @item %@{@code{S}*@}
12118 Substitutes all the switches specified to GCC whose names start
12119 with @code{-S}, but which also take an argument.  This is used for
12120 switches like @option{-o}, @option{-D}, @option{-I}, etc.
12121 GCC considers @option{-o foo} as being
12122 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
12123 text, including the space.  Thus two arguments are generated.
12125 @item %@{@code{S}*&@code{T}*@}
12126 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
12127 (the order of @code{S} and @code{T} in the spec is not significant).
12128 There can be any number of ampersand-separated variables; for each the
12129 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
12131 @item %@{@code{S}:@code{X}@}
12132 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
12134 @item %@{!@code{S}:@code{X}@}
12135 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
12137 @item %@{@code{S}*:@code{X}@}
12138 Substitutes @code{X} if one or more switches whose names start with
12139 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
12140 once, no matter how many such switches appeared.  However, if @code{%*}
12141 appears somewhere in @code{X}, then @code{X} is substituted once
12142 for each matching switch, with the @code{%*} replaced by the part of
12143 that switch matching the @code{*}.
12145 If @code{%*} appears as the last part of a spec sequence then a space
12146 is added after the end of the last substitution.  If there is more
12147 text in the sequence, however, then a space is not generated.  This
12148 allows the @code{%*} substitution to be used as part of a larger
12149 string.  For example, a spec string like this:
12151 @smallexample
12152 %@{mcu=*:--script=%*/memory.ld@}
12153 @end smallexample
12155 @noindent
12156 when matching an option like @option{-mcu=newchip} produces:
12158 @smallexample
12159 --script=newchip/memory.ld
12160 @end smallexample
12162 @item %@{.@code{S}:@code{X}@}
12163 Substitutes @code{X}, if processing a file with suffix @code{S}.
12165 @item %@{!.@code{S}:@code{X}@}
12166 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
12168 @item %@{,@code{S}:@code{X}@}
12169 Substitutes @code{X}, if processing a file for language @code{S}.
12171 @item %@{!,@code{S}:@code{X}@}
12172 Substitutes @code{X}, if not processing a file for language @code{S}.
12174 @item %@{@code{S}|@code{P}:@code{X}@}
12175 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
12176 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
12177 @code{*} sequences as well, although they have a stronger binding than
12178 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
12179 alternatives must be starred, and only the first matching alternative
12180 is substituted.
12182 For example, a spec string like this:
12184 @smallexample
12185 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
12186 @end smallexample
12188 @noindent
12189 outputs the following command-line options from the following input
12190 command-line options:
12192 @smallexample
12193 fred.c        -foo -baz
12194 jim.d         -bar -boggle
12195 -d fred.c     -foo -baz -boggle
12196 -d jim.d      -bar -baz -boggle
12197 @end smallexample
12199 @item %@{S:X; T:Y; :D@}
12201 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
12202 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
12203 be as many clauses as you need.  This may be combined with @code{.},
12204 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
12207 @end table
12209 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
12210 construct may contain other nested @samp{%} constructs or spaces, or
12211 even newlines.  They are processed as usual, as described above.
12212 Trailing white space in @code{X} is ignored.  White space may also
12213 appear anywhere on the left side of the colon in these constructs,
12214 except between @code{.} or @code{*} and the corresponding word.
12216 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
12217 handled specifically in these constructs.  If another value of
12218 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
12219 @option{-W} switch is found later in the command line, the earlier
12220 switch value is ignored, except with @{@code{S}*@} where @code{S} is
12221 just one letter, which passes all matching options.
12223 The character @samp{|} at the beginning of the predicate text is used to
12224 indicate that a command should be piped to the following command, but
12225 only if @option{-pipe} is specified.
12227 It is built into GCC which switches take arguments and which do not.
12228 (You might think it would be useful to generalize this to allow each
12229 compiler's spec to say which switches take arguments.  But this cannot
12230 be done in a consistent fashion.  GCC cannot even decide which input
12231 files have been specified without knowing which switches take arguments,
12232 and it must know which input files to compile in order to tell which
12233 compilers to run).
12235 GCC also knows implicitly that arguments starting in @option{-l} are to be
12236 treated as compiler output files, and passed to the linker in their
12237 proper position among the other output files.
12239 @c man begin OPTIONS
12241 @node Target Options
12242 @section Specifying Target Machine and Compiler Version
12243 @cindex target options
12244 @cindex cross compiling
12245 @cindex specifying machine version
12246 @cindex specifying compiler version and target machine
12247 @cindex compiler version, specifying
12248 @cindex target machine, specifying
12250 The usual way to run GCC is to run the executable called @command{gcc}, or
12251 @command{@var{machine}-gcc} when cross-compiling, or
12252 @command{@var{machine}-gcc-@var{version}} to run a version other than the
12253 one that was installed last.
12255 @node Submodel Options
12256 @section Hardware Models and Configurations
12257 @cindex submodel options
12258 @cindex specifying hardware config
12259 @cindex hardware models and configurations, specifying
12260 @cindex machine dependent options
12262 Each target machine types can have its own
12263 special options, starting with @samp{-m}, to choose among various
12264 hardware models or configurations---for example, 68010 vs 68020,
12265 floating coprocessor or none.  A single installed version of the
12266 compiler can compile for any model or configuration, according to the
12267 options specified.
12269 Some configurations of the compiler also support additional special
12270 options, usually for compatibility with other compilers on the same
12271 platform.
12273 @c This list is ordered alphanumerically by subsection name.
12274 @c It should be the same order and spelling as these options are listed
12275 @c in Machine Dependent Options
12277 @menu
12278 * AArch64 Options::
12279 * Adapteva Epiphany Options::
12280 * ARC Options::
12281 * ARM Options::
12282 * AVR Options::
12283 * Blackfin Options::
12284 * C6X Options::
12285 * CRIS Options::
12286 * CR16 Options::
12287 * Darwin Options::
12288 * DEC Alpha Options::
12289 * FR30 Options::
12290 * FT32 Options::
12291 * FRV Options::
12292 * GNU/Linux Options::
12293 * H8/300 Options::
12294 * HPPA Options::
12295 * IA-64 Options::
12296 * LM32 Options::
12297 * M32C Options::
12298 * M32R/D Options::
12299 * M680x0 Options::
12300 * MCore Options::
12301 * MeP Options::
12302 * MicroBlaze Options::
12303 * MIPS Options::
12304 * MMIX Options::
12305 * MN10300 Options::
12306 * Moxie Options::
12307 * MSP430 Options::
12308 * NDS32 Options::
12309 * Nios II Options::
12310 * Nvidia PTX Options::
12311 * PDP-11 Options::
12312 * picoChip Options::
12313 * PowerPC Options::
12314 * RL78 Options::
12315 * RS/6000 and PowerPC Options::
12316 * RX Options::
12317 * S/390 and zSeries Options::
12318 * Score Options::
12319 * SH Options::
12320 * Solaris 2 Options::
12321 * SPARC Options::
12322 * SPU Options::
12323 * System V Options::
12324 * TILE-Gx Options::
12325 * TILEPro Options::
12326 * V850 Options::
12327 * VAX Options::
12328 * Visium Options::
12329 * VMS Options::
12330 * VxWorks Options::
12331 * x86 Options::
12332 * x86 Windows Options::
12333 * Xstormy16 Options::
12334 * Xtensa Options::
12335 * zSeries Options::
12336 @end menu
12338 @node AArch64 Options
12339 @subsection AArch64 Options
12340 @cindex AArch64 Options
12342 These options are defined for AArch64 implementations:
12344 @table @gcctabopt
12346 @item -mabi=@var{name}
12347 @opindex mabi
12348 Generate code for the specified data model.  Permissible values
12349 are @samp{ilp32} for SysV-like data model where int, long int and pointer
12350 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
12351 but long int and pointer are 64-bit.
12353 The default depends on the specific target configuration.  Note that
12354 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
12355 entire program with the same ABI, and link with a compatible set of libraries.
12357 @item -mbig-endian
12358 @opindex mbig-endian
12359 Generate big-endian code.  This is the default when GCC is configured for an
12360 @samp{aarch64_be-*-*} target.
12362 @item -mgeneral-regs-only
12363 @opindex mgeneral-regs-only
12364 Generate code which uses only the general-purpose registers.  This is equivalent
12365 to feature modifier @option{nofp} of @option{-march} or @option{-mcpu}, except
12366 that @option{-mgeneral-regs-only} takes precedence over any conflicting feature
12367 modifier regardless of sequence.
12369 @item -mlittle-endian
12370 @opindex mlittle-endian
12371 Generate little-endian code.  This is the default when GCC is configured for an
12372 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12374 @item -mcmodel=tiny
12375 @opindex mcmodel=tiny
12376 Generate code for the tiny code model.  The program and its statically defined
12377 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
12378 be statically or dynamically linked.  This model is not fully implemented and
12379 mostly treated as @samp{small}.
12381 @item -mcmodel=small
12382 @opindex mcmodel=small
12383 Generate code for the small code model.  The program and its statically defined
12384 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
12385 be statically or dynamically linked.  This is the default code model.
12387 @item -mcmodel=large
12388 @opindex mcmodel=large
12389 Generate code for the large code model.  This makes no assumptions about
12390 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
12391 statically linked only.
12393 @item -mstrict-align
12394 @opindex mstrict-align
12395 Do not assume that unaligned memory references are handled by the system.
12397 @item -momit-leaf-frame-pointer
12398 @itemx -mno-omit-leaf-frame-pointer
12399 @opindex momit-leaf-frame-pointer
12400 @opindex mno-omit-leaf-frame-pointer
12401 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
12402 default.
12404 @item -mtls-dialect=desc
12405 @opindex mtls-dialect=desc
12406 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12407 of TLS variables.  This is the default.
12409 @item -mtls-dialect=traditional
12410 @opindex mtls-dialect=traditional
12411 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12412 of TLS variables.
12414 @item -mfix-cortex-a53-835769
12415 @itemx -mno-fix-cortex-a53-835769
12416 @opindex mfix-cortex-a53-835769
12417 @opindex mno-fix-cortex-a53-835769
12418 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12419 This involves inserting a NOP instruction between memory instructions and
12420 64-bit integer multiply-accumulate instructions.
12422 @item -mfix-cortex-a53-843419
12423 @itemx -mno-fix-cortex-a53-843419
12424 @opindex mfix-cortex-a53-843419
12425 @opindex mno-fix-cortex-a53-843419
12426 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
12427 This erratum workaround is made at link time and this will only pass the
12428 corresponding flag to the linker.
12430 @item -march=@var{name}
12431 @opindex march
12432 Specify the name of the target architecture, optionally suffixed by one or
12433 more feature modifiers.  This option has the form
12434 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
12436 The permissible values for @var{arch} are @samp{armv8-a} or
12437 @samp{armv8.1-a}.
12439 For the permissible values for @var{feature}, see the sub-section on
12440 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12441 Feature Modifiers}.  Where conflicting feature modifiers are
12442 specified, the right-most feature is used.
12444 Additionally on native AArch64 GNU/Linux systems the value
12445 @samp{native} is available.  This option causes the compiler to pick the
12446 architecture of the host system.  If the compiler is unable to recognize the
12447 architecture of the host system this option has no effect.
12449 GCC uses @var{name} to determine what kind of instructions it can emit
12450 when generating assembly code.  If @option{-march} is specified
12451 without either of @option{-mtune} or @option{-mcpu} also being
12452 specified, the code is tuned to perform well across a range of target
12453 processors implementing the target architecture.
12455 @item -mtune=@var{name}
12456 @opindex mtune
12457 Specify the name of the target processor for which GCC should tune the
12458 performance of the code.  Permissible values for this option are:
12459 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
12460 @samp{exynos-m1}, @samp{thunderx}, @samp{xgene1}.
12462 Additionally, this option can specify that GCC should tune the performance
12463 of the code for a big.LITTLE system.  Permissible values for this
12464 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
12466 Additionally on native AArch64 GNU/Linux systems the value
12467 @samp{native} is available.  This option causes the compiler to pick
12468 the architecture of and tune the performance of the code for the
12469 processor of the host system.  If the compiler is unable to recognize
12470 the processor of the host system this option has no effect.
12472 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12473 are specified, the code is tuned to perform well across a range
12474 of target processors.
12476 This option cannot be suffixed by feature modifiers.
12478 @item -mcpu=@var{name}
12479 @opindex mcpu
12480 Specify the name of the target processor, optionally suffixed by one
12481 or more feature modifiers.  This option has the form
12482 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
12483 the permissible values for @var{cpu} are the same as those available
12484 for @option{-mtune}.  The permissible values for @var{feature} are
12485 documented in the sub-section on
12486 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12487 Feature Modifiers}.  Where conflicting feature modifiers are
12488 specified, the right-most feature is used.
12490 Additionally on native AArch64 GNU/Linux systems the value
12491 @samp{native} is available.  This option causes the compiler to tune
12492 the performance of the code for the processor of the host system.  If
12493 the compiler is unable to recognize the processor of the host system
12494 this option has no effect.
12496 GCC uses @var{name} to determine what kind of instructions it can emit when
12497 generating assembly code (as if by @option{-march}) and to determine
12498 the target processor for which to tune for performance (as if
12499 by @option{-mtune}).  Where this option is used in conjunction
12500 with @option{-march} or @option{-mtune}, those options take precedence
12501 over the appropriate part of this option.
12503 @item -moverride=@var{string}
12504 @opindex moverride
12505 Override tuning decisions made by the back-end in response to a
12506 @option{-mtune=} switch.  The syntax, semantics, and accepted values
12507 for @var{string} in this option are not guaranteed to be consistent
12508 across releases.
12510 This option is only intended to be useful when developing GCC.
12511 @end table
12513 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
12514 @anchor{aarch64-feature-modifiers}
12515 @cindex @option{-march} feature modifiers
12516 @cindex @option{-mcpu} feature modifiers
12517 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
12518 the following and their inverses @option{no@var{feature}}:
12520 @table @samp
12521 @item crc
12522 Enable CRC extension.
12523 @item crypto
12524 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
12525 instructions.
12526 @item fp
12527 Enable floating-point instructions.  This is on by default for all possible
12528 values for options @option{-march} and @option{-mcpu}.
12529 @item simd
12530 Enable Advanced SIMD instructions.  This also enables floating-point
12531 instructions.  This is on by default for all possible values for options
12532 @option{-march} and @option{-mcpu}.
12533 @item lse
12534 Enable Large System Extension instructions.
12535 @item pan
12536 Enable Privileged Access Never support.
12537 @item lor
12538 Enable Limited Ordering Regions support.
12539 @item rdma
12540 Enable ARMv8.1 Advanced SIMD instructions.  This implies Advanced SIMD
12541 is enabled.
12543 @end table
12545 That is, @option{crypto} implies @option{simd} implies @option{fp}.
12546 Conversely, @option{nofp} (or equivalently, @option{-mgeneral-regs-only})
12547 implies @option{nosimd} implies @option{nocrypto}.
12549 @node Adapteva Epiphany Options
12550 @subsection Adapteva Epiphany Options
12552 These @samp{-m} options are defined for Adapteva Epiphany:
12554 @table @gcctabopt
12555 @item -mhalf-reg-file
12556 @opindex mhalf-reg-file
12557 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12558 That allows code to run on hardware variants that lack these registers.
12560 @item -mprefer-short-insn-regs
12561 @opindex mprefer-short-insn-regs
12562 Preferrentially allocate registers that allow short instruction generation.
12563 This can result in increased instruction count, so this may either reduce or
12564 increase overall code size.
12566 @item -mbranch-cost=@var{num}
12567 @opindex mbranch-cost
12568 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12569 This cost is only a heuristic and is not guaranteed to produce
12570 consistent results across releases.
12572 @item -mcmove
12573 @opindex mcmove
12574 Enable the generation of conditional moves.
12576 @item -mnops=@var{num}
12577 @opindex mnops
12578 Emit @var{num} NOPs before every other generated instruction.
12580 @item -mno-soft-cmpsf
12581 @opindex mno-soft-cmpsf
12582 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12583 and test the flags.  This is faster than a software comparison, but can
12584 get incorrect results in the presence of NaNs, or when two different small
12585 numbers are compared such that their difference is calculated as zero.
12586 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12587 software comparisons.
12589 @item -mstack-offset=@var{num}
12590 @opindex mstack-offset
12591 Set the offset between the top of the stack and the stack pointer.
12592 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12593 can be used by leaf functions without stack allocation.
12594 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12595 Note also that this option changes the ABI; compiling a program with a
12596 different stack offset than the libraries have been compiled with
12597 generally does not work.
12598 This option can be useful if you want to evaluate if a different stack
12599 offset would give you better code, but to actually use a different stack
12600 offset to build working programs, it is recommended to configure the
12601 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12603 @item -mno-round-nearest
12604 @opindex mno-round-nearest
12605 Make the scheduler assume that the rounding mode has been set to
12606 truncating.  The default is @option{-mround-nearest}.
12608 @item -mlong-calls
12609 @opindex mlong-calls
12610 If not otherwise specified by an attribute, assume all calls might be beyond
12611 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12612 function address into a register before performing a (otherwise direct) call.
12613 This is the default.
12615 @item -mshort-calls
12616 @opindex short-calls
12617 If not otherwise specified by an attribute, assume all direct calls are
12618 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12619 for direct calls.  The default is @option{-mlong-calls}.
12621 @item -msmall16
12622 @opindex msmall16
12623 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12624 apply to function addresses for which @option{-mlong-calls} semantics
12625 are in effect.
12627 @item -mfp-mode=@var{mode}
12628 @opindex mfp-mode
12629 Set the prevailing mode of the floating-point unit.
12630 This determines the floating-point mode that is provided and expected
12631 at function call and return time.  Making this mode match the mode you
12632 predominantly need at function start can make your programs smaller and
12633 faster by avoiding unnecessary mode switches.
12635 @var{mode} can be set to one the following values:
12637 @table @samp
12638 @item caller
12639 Any mode at function entry is valid, and retained or restored when
12640 the function returns, and when it calls other functions.
12641 This mode is useful for compiling libraries or other compilation units
12642 you might want to incorporate into different programs with different
12643 prevailing FPU modes, and the convenience of being able to use a single
12644 object file outweighs the size and speed overhead for any extra
12645 mode switching that might be needed, compared with what would be needed
12646 with a more specific choice of prevailing FPU mode.
12648 @item truncate
12649 This is the mode used for floating-point calculations with
12650 truncating (i.e.@: round towards zero) rounding mode.  That includes
12651 conversion from floating point to integer.
12653 @item round-nearest
12654 This is the mode used for floating-point calculations with
12655 round-to-nearest-or-even rounding mode.
12657 @item int
12658 This is the mode used to perform integer calculations in the FPU, e.g.@:
12659 integer multiply, or integer multiply-and-accumulate.
12660 @end table
12662 The default is @option{-mfp-mode=caller}
12664 @item -mnosplit-lohi
12665 @itemx -mno-postinc
12666 @itemx -mno-postmodify
12667 @opindex mnosplit-lohi
12668 @opindex mno-postinc
12669 @opindex mno-postmodify
12670 Code generation tweaks that disable, respectively, splitting of 32-bit
12671 loads, generation of post-increment addresses, and generation of
12672 post-modify addresses.  The defaults are @option{msplit-lohi},
12673 @option{-mpost-inc}, and @option{-mpost-modify}.
12675 @item -mnovect-double
12676 @opindex mno-vect-double
12677 Change the preferred SIMD mode to SImode.  The default is
12678 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12680 @item -max-vect-align=@var{num}
12681 @opindex max-vect-align
12682 The maximum alignment for SIMD vector mode types.
12683 @var{num} may be 4 or 8.  The default is 8.
12684 Note that this is an ABI change, even though many library function
12685 interfaces are unaffected if they don't use SIMD vector modes
12686 in places that affect size and/or alignment of relevant types.
12688 @item -msplit-vecmove-early
12689 @opindex msplit-vecmove-early
12690 Split vector moves into single word moves before reload.  In theory this
12691 can give better register allocation, but so far the reverse seems to be
12692 generally the case.
12694 @item -m1reg-@var{reg}
12695 @opindex m1reg-
12696 Specify a register to hold the constant @minus{}1, which makes loading small negative
12697 constants and certain bitmasks faster.
12698 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12699 which specify use of that register as a fixed register,
12700 and @samp{none}, which means that no register is used for this
12701 purpose.  The default is @option{-m1reg-none}.
12703 @end table
12705 @node ARC Options
12706 @subsection ARC Options
12707 @cindex ARC options
12709 The following options control the architecture variant for which code
12710 is being compiled:
12712 @c architecture variants
12713 @table @gcctabopt
12715 @item -mbarrel-shifter
12716 @opindex mbarrel-shifter
12717 Generate instructions supported by barrel shifter.  This is the default
12718 unless @option{-mcpu=ARC601} is in effect.
12720 @item -mcpu=@var{cpu}
12721 @opindex mcpu
12722 Set architecture type, register usage, and instruction scheduling
12723 parameters for @var{cpu}.  There are also shortcut alias options
12724 available for backward compatibility and convenience.  Supported
12725 values for @var{cpu} are
12727 @table @samp
12728 @opindex mA6
12729 @opindex mARC600
12730 @item ARC600
12731 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12733 @item ARC601
12734 @opindex mARC601
12735 Compile for ARC601.  Alias: @option{-mARC601}.
12737 @item ARC700
12738 @opindex mA7
12739 @opindex mARC700
12740 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12741 This is the default when configured with @option{--with-cpu=arc700}@.
12742 @end table
12744 @item -mdpfp
12745 @opindex mdpfp
12746 @itemx -mdpfp-compact
12747 @opindex mdpfp-compact
12748 FPX: Generate Double Precision FPX instructions, tuned for the compact
12749 implementation.
12751 @item -mdpfp-fast
12752 @opindex mdpfp-fast
12753 FPX: Generate Double Precision FPX instructions, tuned for the fast
12754 implementation.
12756 @item -mno-dpfp-lrsr
12757 @opindex mno-dpfp-lrsr
12758 Disable LR and SR instructions from using FPX extension aux registers.
12760 @item -mea
12761 @opindex mea
12762 Generate Extended arithmetic instructions.  Currently only
12763 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12764 supported.  This is always enabled for @option{-mcpu=ARC700}.
12766 @item -mno-mpy
12767 @opindex mno-mpy
12768 Do not generate mpy instructions for ARC700.
12770 @item -mmul32x16
12771 @opindex mmul32x16
12772 Generate 32x16 bit multiply and mac instructions.
12774 @item -mmul64
12775 @opindex mmul64
12776 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
12778 @item -mnorm
12779 @opindex mnorm
12780 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
12781 is in effect.
12783 @item -mspfp
12784 @opindex mspfp
12785 @itemx -mspfp-compact
12786 @opindex mspfp-compact
12787 FPX: Generate Single Precision FPX instructions, tuned for the compact
12788 implementation.
12790 @item -mspfp-fast
12791 @opindex mspfp-fast
12792 FPX: Generate Single Precision FPX instructions, tuned for the fast
12793 implementation.
12795 @item -msimd
12796 @opindex msimd
12797 Enable generation of ARC SIMD instructions via target-specific
12798 builtins.  Only valid for @option{-mcpu=ARC700}.
12800 @item -msoft-float
12801 @opindex msoft-float
12802 This option ignored; it is provided for compatibility purposes only.
12803 Software floating point code is emitted by default, and this default
12804 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12805 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12806 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12808 @item -mswap
12809 @opindex mswap
12810 Generate swap instructions.
12812 @end table
12814 The following options are passed through to the assembler, and also
12815 define preprocessor macro symbols.
12817 @c Flags used by the assembler, but for which we define preprocessor
12818 @c macro symbols as well.
12819 @table @gcctabopt
12820 @item -mdsp-packa
12821 @opindex mdsp-packa
12822 Passed down to the assembler to enable the DSP Pack A extensions.
12823 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12825 @item -mdvbf
12826 @opindex mdvbf
12827 Passed down to the assembler to enable the dual viterbi butterfly
12828 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12830 @c ARC700 4.10 extension instruction
12831 @item -mlock
12832 @opindex mlock
12833 Passed down to the assembler to enable the Locked Load/Store
12834 Conditional extension.  Also sets the preprocessor symbol
12835 @code{__Xlock}.
12837 @item -mmac-d16
12838 @opindex mmac-d16
12839 Passed down to the assembler.  Also sets the preprocessor symbol
12840 @code{__Xxmac_d16}.
12842 @item -mmac-24
12843 @opindex mmac-24
12844 Passed down to the assembler.  Also sets the preprocessor symbol
12845 @code{__Xxmac_24}.
12847 @c ARC700 4.10 extension instruction
12848 @item -mrtsc
12849 @opindex mrtsc
12850 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12851 extension instruction.  Also sets the preprocessor symbol
12852 @code{__Xrtsc}.
12854 @c ARC700 4.10 extension instruction
12855 @item -mswape
12856 @opindex mswape
12857 Passed down to the assembler to enable the swap byte ordering
12858 extension instruction.  Also sets the preprocessor symbol
12859 @code{__Xswape}.
12861 @item -mtelephony
12862 @opindex mtelephony
12863 Passed down to the assembler to enable dual and single operand
12864 instructions for telephony.  Also sets the preprocessor symbol
12865 @code{__Xtelephony}.
12867 @item -mxy
12868 @opindex mxy
12869 Passed down to the assembler to enable the XY Memory extension.  Also
12870 sets the preprocessor symbol @code{__Xxy}.
12872 @end table
12874 The following options control how the assembly code is annotated:
12876 @c Assembly annotation options
12877 @table @gcctabopt
12878 @item -misize
12879 @opindex misize
12880 Annotate assembler instructions with estimated addresses.
12882 @item -mannotate-align
12883 @opindex mannotate-align
12884 Explain what alignment considerations lead to the decision to make an
12885 instruction short or long.
12887 @end table
12889 The following options are passed through to the linker:
12891 @c options passed through to the linker
12892 @table @gcctabopt
12893 @item -marclinux
12894 @opindex marclinux
12895 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12896 This option is enabled by default in tool chains built for
12897 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12898 when profiling is not requested.
12900 @item -marclinux_prof
12901 @opindex marclinux_prof
12902 Passed through to the linker, to specify use of the
12903 @code{arclinux_prof} emulation.  This option is enabled by default in
12904 tool chains built for @w{@code{arc-linux-uclibc}} and
12905 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12907 @end table
12909 The following options control the semantics of generated code:
12911 @c semantically relevant code generation options
12912 @table @gcctabopt
12913 @item -mepilogue-cfi
12914 @opindex mepilogue-cfi
12915 Enable generation of call frame information for epilogues.
12917 @item -mno-epilogue-cfi
12918 @opindex mno-epilogue-cfi
12919 Disable generation of call frame information for epilogues.
12921 @item -mlong-calls
12922 @opindex mlong-calls
12923 Generate call insns as register indirect calls, thus providing access
12924 to the full 32-bit address range.
12926 @item -mmedium-calls
12927 @opindex mmedium-calls
12928 Don't use less than 25 bit addressing range for calls, which is the
12929 offset available for an unconditional branch-and-link
12930 instruction.  Conditional execution of function calls is suppressed, to
12931 allow use of the 25-bit range, rather than the 21-bit range with
12932 conditional branch-and-link.  This is the default for tool chains built
12933 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12935 @item -mno-sdata
12936 @opindex mno-sdata
12937 Do not generate sdata references.  This is the default for tool chains
12938 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12939 targets.
12941 @item -mucb-mcount
12942 @opindex mucb-mcount
12943 Instrument with mcount calls as used in UCB code.  I.e. do the
12944 counting in the callee, not the caller.  By default ARC instrumentation
12945 counts in the caller.
12947 @item -mvolatile-cache
12948 @opindex mvolatile-cache
12949 Use ordinarily cached memory accesses for volatile references.  This is the
12950 default.
12952 @item -mno-volatile-cache
12953 @opindex mno-volatile-cache
12954 Enable cache bypass for volatile references.
12956 @end table
12958 The following options fine tune code generation:
12959 @c code generation tuning options
12960 @table @gcctabopt
12961 @item -malign-call
12962 @opindex malign-call
12963 Do alignment optimizations for call instructions.
12965 @item -mauto-modify-reg
12966 @opindex mauto-modify-reg
12967 Enable the use of pre/post modify with register displacement.
12969 @item -mbbit-peephole
12970 @opindex mbbit-peephole
12971 Enable bbit peephole2.
12973 @item -mno-brcc
12974 @opindex mno-brcc
12975 This option disables a target-specific pass in @file{arc_reorg} to
12976 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12977 generation driven by the combiner pass.
12979 @item -mcase-vector-pcrel
12980 @opindex mcase-vector-pcrel
12981 Use pc-relative switch case tables - this enables case table shortening.
12982 This is the default for @option{-Os}.
12984 @item -mcompact-casesi
12985 @opindex mcompact-casesi
12986 Enable compact casesi pattern.
12987 This is the default for @option{-Os}.
12989 @item -mno-cond-exec
12990 @opindex mno-cond-exec
12991 Disable ARCompact specific pass to generate conditional execution instructions.
12992 Due to delay slot scheduling and interactions between operand numbers,
12993 literal sizes, instruction lengths, and the support for conditional execution,
12994 the target-independent pass to generate conditional execution is often lacking,
12995 so the ARC port has kept a special pass around that tries to find more
12996 conditional execution generating opportunities after register allocation,
12997 branch shortening, and delay slot scheduling have been done.  This pass
12998 generally, but not always, improves performance and code size, at the cost of
12999 extra compilation time, which is why there is an option to switch it off.
13000 If you have a problem with call instructions exceeding their allowable
13001 offset range because they are conditionalized, you should consider using
13002 @option{-mmedium-calls} instead.
13004 @item -mearly-cbranchsi
13005 @opindex mearly-cbranchsi
13006 Enable pre-reload use of the cbranchsi pattern.
13008 @item -mexpand-adddi
13009 @opindex mexpand-adddi
13010 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
13011 @code{add.f}, @code{adc} etc.
13013 @item -mindexed-loads
13014 @opindex mindexed-loads
13015 Enable the use of indexed loads.  This can be problematic because some
13016 optimizers then assume that indexed stores exist, which is not
13017 the case.
13019 @item -mlra
13020 @opindex mlra
13021 Enable Local Register Allocation.  This is still experimental for ARC,
13022 so by default the compiler uses standard reload
13023 (i.e. @option{-mno-lra}).
13025 @item -mlra-priority-none
13026 @opindex mlra-priority-none
13027 Don't indicate any priority for target registers.
13029 @item -mlra-priority-compact
13030 @opindex mlra-priority-compact
13031 Indicate target register priority for r0..r3 / r12..r15.
13033 @item -mlra-priority-noncompact
13034 @opindex mlra-priority-noncompact
13035 Reduce target regsiter priority for r0..r3 / r12..r15.
13037 @item -mno-millicode
13038 @opindex mno-millicode
13039 When optimizing for size (using @option{-Os}), prologues and epilogues
13040 that have to save or restore a large number of registers are often
13041 shortened by using call to a special function in libgcc; this is
13042 referred to as a @emph{millicode} call.  As these calls can pose
13043 performance issues, and/or cause linking issues when linking in a
13044 nonstandard way, this option is provided to turn off millicode call
13045 generation.
13047 @item -mmixed-code
13048 @opindex mmixed-code
13049 Tweak register allocation to help 16-bit instruction generation.
13050 This generally has the effect of decreasing the average instruction size
13051 while increasing the instruction count.
13053 @item -mq-class
13054 @opindex mq-class
13055 Enable 'q' instruction alternatives.
13056 This is the default for @option{-Os}.
13058 @item -mRcq
13059 @opindex mRcq
13060 Enable Rcq constraint handling - most short code generation depends on this.
13061 This is the default.
13063 @item -mRcw
13064 @opindex mRcw
13065 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
13066 This is the default.
13068 @item -msize-level=@var{level}
13069 @opindex msize-level
13070 Fine-tune size optimization with regards to instruction lengths and alignment.
13071 The recognized values for @var{level} are:
13072 @table @samp
13073 @item 0
13074 No size optimization.  This level is deprecated and treated like @samp{1}.
13076 @item 1
13077 Short instructions are used opportunistically.
13079 @item 2
13080 In addition, alignment of loops and of code after barriers are dropped.
13082 @item 3
13083 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
13085 @end table
13087 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
13088 the behavior when this is not set is equivalent to level @samp{1}.
13090 @item -mtune=@var{cpu}
13091 @opindex mtune
13092 Set instruction scheduling parameters for @var{cpu}, overriding any implied
13093 by @option{-mcpu=}.
13095 Supported values for @var{cpu} are
13097 @table @samp
13098 @item ARC600
13099 Tune for ARC600 cpu.
13101 @item ARC601
13102 Tune for ARC601 cpu.
13104 @item ARC700
13105 Tune for ARC700 cpu with standard multiplier block.
13107 @item ARC700-xmac
13108 Tune for ARC700 cpu with XMAC block.
13110 @item ARC725D
13111 Tune for ARC725D cpu.
13113 @item ARC750D
13114 Tune for ARC750D cpu.
13116 @end table
13118 @item -mmultcost=@var{num}
13119 @opindex mmultcost
13120 Cost to assume for a multiply instruction, with @samp{4} being equal to a
13121 normal instruction.
13123 @item -munalign-prob-threshold=@var{probability}
13124 @opindex munalign-prob-threshold
13125 Set probability threshold for unaligning branches.
13126 When tuning for @samp{ARC700} and optimizing for speed, branches without
13127 filled delay slot are preferably emitted unaligned and long, unless
13128 profiling indicates that the probability for the branch to be taken
13129 is below @var{probability}.  @xref{Cross-profiling}.
13130 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13132 @end table
13134 The following options are maintained for backward compatibility, but
13135 are now deprecated and will be removed in a future release:
13137 @c Deprecated options
13138 @table @gcctabopt
13140 @item -margonaut
13141 @opindex margonaut
13142 Obsolete FPX.
13144 @item -mbig-endian
13145 @opindex mbig-endian
13146 @itemx -EB
13147 @opindex EB
13148 Compile code for big endian targets.  Use of these options is now
13149 deprecated.  Users wanting big-endian code, should use the
13150 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13151 building the tool chain, for which big-endian is the default.
13153 @item -mlittle-endian
13154 @opindex mlittle-endian
13155 @itemx -EL
13156 @opindex EL
13157 Compile code for little endian targets.  Use of these options is now
13158 deprecated.  Users wanting little-endian code should use the
13159 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13160 building the tool chain, for which little-endian is the default.
13162 @item -mbarrel_shifter
13163 @opindex mbarrel_shifter
13164 Replaced by @option{-mbarrel-shifter}.
13166 @item -mdpfp_compact
13167 @opindex mdpfp_compact
13168 Replaced by @option{-mdpfp-compact}.
13170 @item -mdpfp_fast
13171 @opindex mdpfp_fast
13172 Replaced by @option{-mdpfp-fast}.
13174 @item -mdsp_packa
13175 @opindex mdsp_packa
13176 Replaced by @option{-mdsp-packa}.
13178 @item -mEA
13179 @opindex mEA
13180 Replaced by @option{-mea}.
13182 @item -mmac_24
13183 @opindex mmac_24
13184 Replaced by @option{-mmac-24}.
13186 @item -mmac_d16
13187 @opindex mmac_d16
13188 Replaced by @option{-mmac-d16}.
13190 @item -mspfp_compact
13191 @opindex mspfp_compact
13192 Replaced by @option{-mspfp-compact}.
13194 @item -mspfp_fast
13195 @opindex mspfp_fast
13196 Replaced by @option{-mspfp-fast}.
13198 @item -mtune=@var{cpu}
13199 @opindex mtune
13200 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13201 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13202 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13204 @item -multcost=@var{num}
13205 @opindex multcost
13206 Replaced by @option{-mmultcost}.
13208 @end table
13210 @node ARM Options
13211 @subsection ARM Options
13212 @cindex ARM options
13214 These @samp{-m} options are defined for the ARM port:
13216 @table @gcctabopt
13217 @item -mabi=@var{name}
13218 @opindex mabi
13219 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13220 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13222 @item -mapcs-frame
13223 @opindex mapcs-frame
13224 Generate a stack frame that is compliant with the ARM Procedure Call
13225 Standard for all functions, even if this is not strictly necessary for
13226 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13227 with this option causes the stack frames not to be generated for
13228 leaf functions.  The default is @option{-mno-apcs-frame}.
13229 This option is deprecated.
13231 @item -mapcs
13232 @opindex mapcs
13233 This is a synonym for @option{-mapcs-frame} and is deprecated.
13235 @ignore
13236 @c not currently implemented
13237 @item -mapcs-stack-check
13238 @opindex mapcs-stack-check
13239 Generate code to check the amount of stack space available upon entry to
13240 every function (that actually uses some stack space).  If there is
13241 insufficient space available then either the function
13242 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13243 called, depending upon the amount of stack space required.  The runtime
13244 system is required to provide these functions.  The default is
13245 @option{-mno-apcs-stack-check}, since this produces smaller code.
13247 @c not currently implemented
13248 @item -mapcs-float
13249 @opindex mapcs-float
13250 Pass floating-point arguments using the floating-point registers.  This is
13251 one of the variants of the APCS@.  This option is recommended if the
13252 target hardware has a floating-point unit or if a lot of floating-point
13253 arithmetic is going to be performed by the code.  The default is
13254 @option{-mno-apcs-float}, since the size of integer-only code is 
13255 slightly increased if @option{-mapcs-float} is used.
13257 @c not currently implemented
13258 @item -mapcs-reentrant
13259 @opindex mapcs-reentrant
13260 Generate reentrant, position-independent code.  The default is
13261 @option{-mno-apcs-reentrant}.
13262 @end ignore
13264 @item -mthumb-interwork
13265 @opindex mthumb-interwork
13266 Generate code that supports calling between the ARM and Thumb
13267 instruction sets.  Without this option, on pre-v5 architectures, the
13268 two instruction sets cannot be reliably used inside one program.  The
13269 default is @option{-mno-thumb-interwork}, since slightly larger code
13270 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13271 configurations this option is meaningless.
13273 @item -mno-sched-prolog
13274 @opindex mno-sched-prolog
13275 Prevent the reordering of instructions in the function prologue, or the
13276 merging of those instruction with the instructions in the function's
13277 body.  This means that all functions start with a recognizable set
13278 of instructions (or in fact one of a choice from a small set of
13279 different function prologues), and this information can be used to
13280 locate the start of functions inside an executable piece of code.  The
13281 default is @option{-msched-prolog}.
13283 @item -mfloat-abi=@var{name}
13284 @opindex mfloat-abi
13285 Specifies which floating-point ABI to use.  Permissible values
13286 are: @samp{soft}, @samp{softfp} and @samp{hard}.
13288 Specifying @samp{soft} causes GCC to generate output containing
13289 library calls for floating-point operations.
13290 @samp{softfp} allows the generation of code using hardware floating-point
13291 instructions, but still uses the soft-float calling conventions.
13292 @samp{hard} allows generation of floating-point instructions
13293 and uses FPU-specific calling conventions.
13295 The default depends on the specific target configuration.  Note that
13296 the hard-float and soft-float ABIs are not link-compatible; you must
13297 compile your entire program with the same ABI, and link with a
13298 compatible set of libraries.
13300 @item -mlittle-endian
13301 @opindex mlittle-endian
13302 Generate code for a processor running in little-endian mode.  This is
13303 the default for all standard configurations.
13305 @item -mbig-endian
13306 @opindex mbig-endian
13307 Generate code for a processor running in big-endian mode; the default is
13308 to compile code for a little-endian processor.
13310 @item -march=@var{name}
13311 @opindex march
13312 This specifies the name of the target ARM architecture.  GCC uses this
13313 name to determine what kind of instructions it can emit when generating
13314 assembly code.  This option can be used in conjunction with or instead
13315 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
13316 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
13317 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
13318 @samp{armv6}, @samp{armv6j},
13319 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
13320 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
13321 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
13322 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
13324 @option{-march=armv7ve} is the armv7-a architecture with virtualization
13325 extensions.
13327 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
13328 architecture together with the optional CRC32 extensions.
13330 @option{-march=native} causes the compiler to auto-detect the architecture
13331 of the build computer.  At present, this feature is only supported on
13332 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13333 is unsuccessful the option has no effect.
13335 @item -mtune=@var{name}
13336 @opindex mtune
13337 This option specifies the name of the target ARM processor for
13338 which GCC should tune the performance of the code.
13339 For some ARM implementations better performance can be obtained by using
13340 this option.
13341 Permissible names are: @samp{arm2}, @samp{arm250},
13342 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
13343 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
13344 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
13345 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
13346 @samp{arm720},
13347 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
13348 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
13349 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
13350 @samp{strongarm1110},
13351 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
13352 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
13353 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
13354 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
13355 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
13356 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
13357 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
13358 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
13359 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
13360 @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
13361 @samp{cortex-r4},
13362 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
13363 @samp{cortex-m4},
13364 @samp{cortex-m3},
13365 @samp{cortex-m1},
13366 @samp{cortex-m0},
13367 @samp{cortex-m0plus},
13368 @samp{cortex-m1.small-multiply},
13369 @samp{cortex-m0.small-multiply},
13370 @samp{cortex-m0plus.small-multiply},
13371 @samp{exynos-m1},
13372 @samp{marvell-pj4},
13373 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
13374 @samp{fa526}, @samp{fa626},
13375 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
13376 @samp{xgene1}.
13378 Additionally, this option can specify that GCC should tune the performance
13379 of the code for a big.LITTLE system.  Permissible names are:
13380 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
13381 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
13383 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
13384 performance for a blend of processors within architecture @var{arch}.
13385 The aim is to generate code that run well on the current most popular
13386 processors, balancing between optimizations that benefit some CPUs in the
13387 range, and avoiding performance pitfalls of other CPUs.  The effects of
13388 this option may change in future GCC versions as CPU models come and go.
13390 @option{-mtune=native} causes the compiler to auto-detect the CPU
13391 of the build computer.  At present, this feature is only supported on
13392 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
13393 unsuccessful the option has no effect.
13395 @item -mcpu=@var{name}
13396 @opindex mcpu
13397 This specifies the name of the target ARM processor.  GCC uses this name
13398 to derive the name of the target ARM architecture (as if specified
13399 by @option{-march}) and the ARM processor type for which to tune for
13400 performance (as if specified by @option{-mtune}).  Where this option
13401 is used in conjunction with @option{-march} or @option{-mtune},
13402 those options take precedence over the appropriate part of this option.
13404 Permissible names for this option are the same as those for
13405 @option{-mtune}.
13407 @option{-mcpu=generic-@var{arch}} is also permissible, and is
13408 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
13409 See @option{-mtune} for more information.
13411 @option{-mcpu=native} causes the compiler to auto-detect the CPU
13412 of the build computer.  At present, this feature is only supported on
13413 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13414 is unsuccessful the option has no effect.
13416 @item -mfpu=@var{name}
13417 @opindex mfpu
13418 This specifies what floating-point hardware (or hardware emulation) is
13419 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
13420 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
13421 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
13422 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
13423 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
13424 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
13426 If @option{-msoft-float} is specified this specifies the format of
13427 floating-point values.
13429 If the selected floating-point hardware includes the NEON extension
13430 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
13431 operations are not generated by GCC's auto-vectorization pass unless
13432 @option{-funsafe-math-optimizations} is also specified.  This is
13433 because NEON hardware does not fully implement the IEEE 754 standard for
13434 floating-point arithmetic (in particular denormal values are treated as
13435 zero), so the use of NEON instructions may lead to a loss of precision.
13437 @item -mfp16-format=@var{name}
13438 @opindex mfp16-format
13439 Specify the format of the @code{__fp16} half-precision floating-point type.
13440 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
13441 the default is @samp{none}, in which case the @code{__fp16} type is not
13442 defined.  @xref{Half-Precision}, for more information.
13444 @item -mstructure-size-boundary=@var{n}
13445 @opindex mstructure-size-boundary
13446 The sizes of all structures and unions are rounded up to a multiple
13447 of the number of bits set by this option.  Permissible values are 8, 32
13448 and 64.  The default value varies for different toolchains.  For the COFF
13449 targeted toolchain the default value is 8.  A value of 64 is only allowed
13450 if the underlying ABI supports it.
13452 Specifying a larger number can produce faster, more efficient code, but
13453 can also increase the size of the program.  Different values are potentially
13454 incompatible.  Code compiled with one value cannot necessarily expect to
13455 work with code or libraries compiled with another value, if they exchange
13456 information using structures or unions.
13458 @item -mabort-on-noreturn
13459 @opindex mabort-on-noreturn
13460 Generate a call to the function @code{abort} at the end of a
13461 @code{noreturn} function.  It is executed if the function tries to
13462 return.
13464 @item -mlong-calls
13465 @itemx -mno-long-calls
13466 @opindex mlong-calls
13467 @opindex mno-long-calls
13468 Tells the compiler to perform function calls by first loading the
13469 address of the function into a register and then performing a subroutine
13470 call on this register.  This switch is needed if the target function
13471 lies outside of the 64-megabyte addressing range of the offset-based
13472 version of subroutine call instruction.
13474 Even if this switch is enabled, not all function calls are turned
13475 into long calls.  The heuristic is that static functions, functions
13476 that have the @code{short_call} attribute, functions that are inside
13477 the scope of a @code{#pragma no_long_calls} directive, and functions whose
13478 definitions have already been compiled within the current compilation
13479 unit are not turned into long calls.  The exceptions to this rule are
13480 that weak function definitions, functions with the @code{long_call}
13481 attribute or the @code{section} attribute, and functions that are within
13482 the scope of a @code{#pragma long_calls} directive are always
13483 turned into long calls.
13485 This feature is not enabled by default.  Specifying
13486 @option{-mno-long-calls} restores the default behavior, as does
13487 placing the function calls within the scope of a @code{#pragma
13488 long_calls_off} directive.  Note these switches have no effect on how
13489 the compiler generates code to handle function calls via function
13490 pointers.
13492 @item -msingle-pic-base
13493 @opindex msingle-pic-base
13494 Treat the register used for PIC addressing as read-only, rather than
13495 loading it in the prologue for each function.  The runtime system is
13496 responsible for initializing this register with an appropriate value
13497 before execution begins.
13499 @item -mpic-register=@var{reg}
13500 @opindex mpic-register
13501 Specify the register to be used for PIC addressing.
13502 For standard PIC base case, the default is any suitable register
13503 determined by compiler.  For single PIC base case, the default is
13504 @samp{R9} if target is EABI based or stack-checking is enabled,
13505 otherwise the default is @samp{R10}.
13507 @item -mpic-data-is-text-relative
13508 @opindex mpic-data-is-text-relative
13509 Assume that each data segments are relative to text segment at load time.
13510 Therefore, it permits addressing data using PC-relative operations.
13511 This option is on by default for targets other than VxWorks RTP.
13513 @item -mpoke-function-name
13514 @opindex mpoke-function-name
13515 Write the name of each function into the text section, directly
13516 preceding the function prologue.  The generated code is similar to this:
13518 @smallexample
13519      t0
13520          .ascii "arm_poke_function_name", 0
13521          .align
13522      t1
13523          .word 0xff000000 + (t1 - t0)
13524      arm_poke_function_name
13525          mov     ip, sp
13526          stmfd   sp!, @{fp, ip, lr, pc@}
13527          sub     fp, ip, #4
13528 @end smallexample
13530 When performing a stack backtrace, code can inspect the value of
13531 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13532 location @code{pc - 12} and the top 8 bits are set, then we know that
13533 there is a function name embedded immediately preceding this location
13534 and has length @code{((pc[-3]) & 0xff000000)}.
13536 @item -mthumb
13537 @itemx -marm
13538 @opindex marm
13539 @opindex mthumb
13541 Select between generating code that executes in ARM and Thumb
13542 states.  The default for most configurations is to generate code
13543 that executes in ARM state, but the default can be changed by
13544 configuring GCC with the @option{--with-mode=}@var{state}
13545 configure option.
13547 You can also override the ARM and Thumb mode for each function
13548 by using the @code{target("thumb")} and @code{target("arm")} function attributes
13549 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
13551 @item -mtpcs-frame
13552 @opindex mtpcs-frame
13553 Generate a stack frame that is compliant with the Thumb Procedure Call
13554 Standard for all non-leaf functions.  (A leaf function is one that does
13555 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13557 @item -mtpcs-leaf-frame
13558 @opindex mtpcs-leaf-frame
13559 Generate a stack frame that is compliant with the Thumb Procedure Call
13560 Standard for all leaf functions.  (A leaf function is one that does
13561 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13563 @item -mcallee-super-interworking
13564 @opindex mcallee-super-interworking
13565 Gives all externally visible functions in the file being compiled an ARM
13566 instruction set header which switches to Thumb mode before executing the
13567 rest of the function.  This allows these functions to be called from
13568 non-interworking code.  This option is not valid in AAPCS configurations
13569 because interworking is enabled by default.
13571 @item -mcaller-super-interworking
13572 @opindex mcaller-super-interworking
13573 Allows calls via function pointers (including virtual functions) to
13574 execute correctly regardless of whether the target code has been
13575 compiled for interworking or not.  There is a small overhead in the cost
13576 of executing a function pointer if this option is enabled.  This option
13577 is not valid in AAPCS configurations because interworking is enabled
13578 by default.
13580 @item -mtp=@var{name}
13581 @opindex mtp
13582 Specify the access model for the thread local storage pointer.  The valid
13583 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
13584 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
13585 (supported in the arm6k architecture), and @samp{auto}, which uses the
13586 best available method for the selected processor.  The default setting is
13587 @samp{auto}.
13589 @item -mtls-dialect=@var{dialect}
13590 @opindex mtls-dialect
13591 Specify the dialect to use for accessing thread local storage.  Two
13592 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13593 @samp{gnu} dialect selects the original GNU scheme for supporting
13594 local and global dynamic TLS models.  The @samp{gnu2} dialect
13595 selects the GNU descriptor scheme, which provides better performance
13596 for shared libraries.  The GNU descriptor scheme is compatible with
13597 the original scheme, but does require new assembler, linker and
13598 library support.  Initial and local exec TLS models are unaffected by
13599 this option and always use the original scheme.
13601 @item -mword-relocations
13602 @opindex mword-relocations
13603 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13604 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13605 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13606 is specified.
13608 @item -mfix-cortex-m3-ldrd
13609 @opindex mfix-cortex-m3-ldrd
13610 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13611 with overlapping destination and base registers are used.  This option avoids
13612 generating these instructions.  This option is enabled by default when
13613 @option{-mcpu=cortex-m3} is specified.
13615 @item -munaligned-access
13616 @itemx -mno-unaligned-access
13617 @opindex munaligned-access
13618 @opindex mno-unaligned-access
13619 Enables (or disables) reading and writing of 16- and 32- bit values
13620 from addresses that are not 16- or 32- bit aligned.  By default
13621 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13622 architectures, and enabled for all other architectures.  If unaligned
13623 access is not enabled then words in packed data structures are
13624 accessed a byte at a time.
13626 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
13627 generated object file to either true or false, depending upon the
13628 setting of this option.  If unaligned access is enabled then the
13629 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
13630 defined.
13632 @item -mneon-for-64bits
13633 @opindex mneon-for-64bits
13634 Enables using Neon to handle scalar 64-bits operations. This is
13635 disabled by default since the cost of moving data from core registers
13636 to Neon is high.
13638 @item -mslow-flash-data
13639 @opindex mslow-flash-data
13640 Assume loading data from flash is slower than fetching instruction.
13641 Therefore literal load is minimized for better performance.
13642 This option is only supported when compiling for ARMv7 M-profile and
13643 off by default.
13645 @item -masm-syntax-unified
13646 @opindex masm-syntax-unified
13647 Assume inline assembler is using unified asm syntax.  The default is
13648 currently off which implies divided syntax.  Currently this option is
13649 available only for Thumb1 and has no effect on ARM state and Thumb2.
13650 However, this may change in future releases of GCC.  Divided syntax
13651 should be considered deprecated.
13653 @item -mrestrict-it
13654 @opindex mrestrict-it
13655 Restricts generation of IT blocks to conform to the rules of ARMv8.
13656 IT blocks can only contain a single 16-bit instruction from a select
13657 set of instructions. This option is on by default for ARMv8 Thumb mode.
13659 @item -mprint-tune-info
13660 @opindex mprint-tune-info
13661 Print CPU tuning information as comment in assembler file.  This is
13662 an option used only for regression testing of the compiler and not
13663 intended for ordinary use in compiling code.  This option is disabled
13664 by default.
13665 @end table
13667 @node AVR Options
13668 @subsection AVR Options
13669 @cindex AVR Options
13671 These options are defined for AVR implementations:
13673 @table @gcctabopt
13674 @item -mmcu=@var{mcu}
13675 @opindex mmcu
13676 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13678 The default for this option is@tie{}@samp{avr2}.
13680 GCC supports the following AVR devices and ISAs:
13682 @include avr-mmcu.texi
13684 @item -maccumulate-args
13685 @opindex maccumulate-args
13686 Accumulate outgoing function arguments and acquire/release the needed
13687 stack space for outgoing function arguments once in function
13688 prologue/epilogue.  Without this option, outgoing arguments are pushed
13689 before calling a function and popped afterwards.
13691 Popping the arguments after the function call can be expensive on
13692 AVR so that accumulating the stack space might lead to smaller
13693 executables because arguments need not to be removed from the
13694 stack after such a function call.
13696 This option can lead to reduced code size for functions that perform
13697 several calls to functions that get their arguments on the stack like
13698 calls to printf-like functions.
13700 @item -mbranch-cost=@var{cost}
13701 @opindex mbranch-cost
13702 Set the branch costs for conditional branch instructions to
13703 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13704 integers. The default branch cost is 0.
13706 @item -mcall-prologues
13707 @opindex mcall-prologues
13708 Functions prologues/epilogues are expanded as calls to appropriate
13709 subroutines.  Code size is smaller.
13711 @item -mint8
13712 @opindex mint8
13713 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13714 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13715 and @code{long long} is 4 bytes.  Please note that this option does not
13716 conform to the C standards, but it results in smaller code
13717 size.
13719 @item -mn-flash=@var{num}
13720 @opindex mn-flash
13721 Assume that the flash memory has a size of 
13722 @var{num} times 64@tie{}KiB.
13724 @item -mno-interrupts
13725 @opindex mno-interrupts
13726 Generated code is not compatible with hardware interrupts.
13727 Code size is smaller.
13729 @item -mrelax
13730 @opindex mrelax
13731 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13732 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13733 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
13734 the assembler's command line and the @option{--relax} option to the
13735 linker's command line.
13737 Jump relaxing is performed by the linker because jump offsets are not
13738 known before code is located. Therefore, the assembler code generated by the
13739 compiler is the same, but the instructions in the executable may
13740 differ from instructions in the assembler code.
13742 Relaxing must be turned on if linker stubs are needed, see the
13743 section on @code{EIND} and linker stubs below.
13745 @item -mrmw
13746 @opindex mrmw
13747 Assume that the device supports the Read-Modify-Write
13748 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
13750 @item -msp8
13751 @opindex msp8
13752 Treat the stack pointer register as an 8-bit register,
13753 i.e.@: assume the high byte of the stack pointer is zero.
13754 In general, you don't need to set this option by hand.
13756 This option is used internally by the compiler to select and
13757 build multilibs for architectures @code{avr2} and @code{avr25}.
13758 These architectures mix devices with and without @code{SPH}.
13759 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
13760 the compiler driver adds or removes this option from the compiler
13761 proper's command line, because the compiler then knows if the device
13762 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13763 register or not.
13765 @item -mstrict-X
13766 @opindex mstrict-X
13767 Use address register @code{X} in a way proposed by the hardware.  This means
13768 that @code{X} is only used in indirect, post-increment or
13769 pre-decrement addressing.
13771 Without this option, the @code{X} register may be used in the same way
13772 as @code{Y} or @code{Z} which then is emulated by additional
13773 instructions.  
13774 For example, loading a value with @code{X+const} addressing with a
13775 small non-negative @code{const < 64} to a register @var{Rn} is
13776 performed as
13778 @example
13779 adiw r26, const   ; X += const
13780 ld   @var{Rn}, X        ; @var{Rn} = *X
13781 sbiw r26, const   ; X -= const
13782 @end example
13784 @item -mtiny-stack
13785 @opindex mtiny-stack
13786 Only change the lower 8@tie{}bits of the stack pointer.
13788 @item -nodevicelib
13789 @opindex nodevicelib
13790 Don't link against AVR-LibC's device specific library @code{libdev.a}.
13792 @item -Waddr-space-convert
13793 @opindex Waddr-space-convert
13794 Warn about conversions between address spaces in the case where the
13795 resulting address space is not contained in the incoming address space.
13796 @end table
13798 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
13799 @cindex @code{EIND}
13800 Pointers in the implementation are 16@tie{}bits wide.
13801 The address of a function or label is represented as word address so
13802 that indirect jumps and calls can target any code address in the
13803 range of 64@tie{}Ki words.
13805 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13806 bytes of program memory space, there is a special function register called
13807 @code{EIND} that serves as most significant part of the target address
13808 when @code{EICALL} or @code{EIJMP} instructions are used.
13810 Indirect jumps and calls on these devices are handled as follows by
13811 the compiler and are subject to some limitations:
13813 @itemize @bullet
13815 @item
13816 The compiler never sets @code{EIND}.
13818 @item
13819 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13820 instructions or might read @code{EIND} directly in order to emulate an
13821 indirect call/jump by means of a @code{RET} instruction.
13823 @item
13824 The compiler assumes that @code{EIND} never changes during the startup
13825 code or during the application. In particular, @code{EIND} is not
13826 saved/restored in function or interrupt service routine
13827 prologue/epilogue.
13829 @item
13830 For indirect calls to functions and computed goto, the linker
13831 generates @emph{stubs}. Stubs are jump pads sometimes also called
13832 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13833 The stub contains a direct jump to the desired address.
13835 @item
13836 Linker relaxation must be turned on so that the linker generates
13837 the stubs correctly in all situations. See the compiler option
13838 @option{-mrelax} and the linker option @option{--relax}.
13839 There are corner cases where the linker is supposed to generate stubs
13840 but aborts without relaxation and without a helpful error message.
13842 @item
13843 The default linker script is arranged for code with @code{EIND = 0}.
13844 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13845 linker script has to be used in order to place the sections whose
13846 name start with @code{.trampolines} into the segment where @code{EIND}
13847 points to.
13849 @item
13850 The startup code from libgcc never sets @code{EIND}.
13851 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13852 For the impact of AVR-LibC on @code{EIND}, see the
13853 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13855 @item
13856 It is legitimate for user-specific startup code to set up @code{EIND}
13857 early, for example by means of initialization code located in
13858 section @code{.init3}. Such code runs prior to general startup code
13859 that initializes RAM and calls constructors, but after the bit
13860 of startup code from AVR-LibC that sets @code{EIND} to the segment
13861 where the vector table is located.
13862 @example
13863 #include <avr/io.h>
13865 static void
13866 __attribute__((section(".init3"),naked,used,no_instrument_function))
13867 init3_set_eind (void)
13869   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13870                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13872 @end example
13874 @noindent
13875 The @code{__trampolines_start} symbol is defined in the linker script.
13877 @item
13878 Stubs are generated automatically by the linker if
13879 the following two conditions are met:
13880 @itemize @minus
13882 @item The address of a label is taken by means of the @code{gs} modifier
13883 (short for @emph{generate stubs}) like so:
13884 @example
13885 LDI r24, lo8(gs(@var{func}))
13886 LDI r25, hi8(gs(@var{func}))
13887 @end example
13888 @item The final location of that label is in a code segment
13889 @emph{outside} the segment where the stubs are located.
13890 @end itemize
13892 @item
13893 The compiler emits such @code{gs} modifiers for code labels in the
13894 following situations:
13895 @itemize @minus
13896 @item Taking address of a function or code label.
13897 @item Computed goto.
13898 @item If prologue-save function is used, see @option{-mcall-prologues}
13899 command-line option.
13900 @item Switch/case dispatch tables. If you do not want such dispatch
13901 tables you can specify the @option{-fno-jump-tables} command-line option.
13902 @item C and C++ constructors/destructors called during startup/shutdown.
13903 @item If the tools hit a @code{gs()} modifier explained above.
13904 @end itemize
13906 @item
13907 Jumping to non-symbolic addresses like so is @emph{not} supported:
13909 @example
13910 int main (void)
13912     /* Call function at word address 0x2 */
13913     return ((int(*)(void)) 0x2)();
13915 @end example
13917 Instead, a stub has to be set up, i.e.@: the function has to be called
13918 through a symbol (@code{func_4} in the example):
13920 @example
13921 int main (void)
13923     extern int func_4 (void);
13925     /* Call function at byte address 0x4 */
13926     return func_4();
13928 @end example
13930 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
13931 Alternatively, @code{func_4} can be defined in the linker script.
13932 @end itemize
13934 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13935 @cindex @code{RAMPD}
13936 @cindex @code{RAMPX}
13937 @cindex @code{RAMPY}
13938 @cindex @code{RAMPZ}
13939 Some AVR devices support memories larger than the 64@tie{}KiB range
13940 that can be accessed with 16-bit pointers.  To access memory locations
13941 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13942 register is used as high part of the address:
13943 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13944 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13945 register, respectively, to get a wide address. Similarly,
13946 @code{RAMPD} is used together with direct addressing.
13948 @itemize
13949 @item
13950 The startup code initializes the @code{RAMP} special function
13951 registers with zero.
13953 @item
13954 If a @ref{AVR Named Address Spaces,named address space} other than
13955 generic or @code{__flash} is used, then @code{RAMPZ} is set
13956 as needed before the operation.
13958 @item
13959 If the device supports RAM larger than 64@tie{}KiB and the compiler
13960 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13961 is reset to zero after the operation.
13963 @item
13964 If the device comes with a specific @code{RAMP} register, the ISR
13965 prologue/epilogue saves/restores that SFR and initializes it with
13966 zero in case the ISR code might (implicitly) use it.
13968 @item
13969 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13970 If you use inline assembler to read from locations outside the
13971 16-bit address range and change one of the @code{RAMP} registers,
13972 you must reset it to zero after the access.
13974 @end itemize
13976 @subsubsection AVR Built-in Macros
13978 GCC defines several built-in macros so that the user code can test
13979 for the presence or absence of features.  Almost any of the following
13980 built-in macros are deduced from device capabilities and thus
13981 triggered by the @option{-mmcu=} command-line option.
13983 For even more AVR-specific built-in macros see
13984 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13986 @table @code
13988 @item __AVR_ARCH__
13989 Build-in macro that resolves to a decimal number that identifies the
13990 architecture and depends on the @option{-mmcu=@var{mcu}} option.
13991 Possible values are:
13993 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13994 @code{4}, @code{5}, @code{51}, @code{6}
13996 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
13997 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
13999 respectively and
14001 @code{100}, @code{102}, @code{104},
14002 @code{105}, @code{106}, @code{107}
14004 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
14005 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
14006 If @var{mcu} specifies a device, this built-in macro is set
14007 accordingly. For example, with @option{-mmcu=atmega8} the macro is
14008 defined to @code{4}.
14010 @item __AVR_@var{Device}__
14011 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
14012 the device's name. For example, @option{-mmcu=atmega8} defines the
14013 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
14014 @code{__AVR_ATtiny261A__}, etc.
14016 The built-in macros' names follow
14017 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
14018 the device name as from the AVR user manual. The difference between
14019 @var{Device} in the built-in macro and @var{device} in
14020 @option{-mmcu=@var{device}} is that the latter is always lowercase.
14022 If @var{device} is not a device but only a core architecture like
14023 @samp{avr51}, this macro is not defined.
14025 @item __AVR_DEVICE_NAME__
14026 Setting @option{-mmcu=@var{device}} defines this built-in macro to
14027 the device's name. For example, with @option{-mmcu=atmega8} the macro
14028 is defined to @code{atmega8}.
14030 If @var{device} is not a device but only a core architecture like
14031 @samp{avr51}, this macro is not defined.
14033 @item __AVR_XMEGA__
14034 The device / architecture belongs to the XMEGA family of devices.
14036 @item __AVR_HAVE_ELPM__
14037 The device has the @code{ELPM} instruction.
14039 @item __AVR_HAVE_ELPMX__
14040 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
14041 R@var{n},Z+} instructions.
14043 @item __AVR_HAVE_MOVW__
14044 The device has the @code{MOVW} instruction to perform 16-bit
14045 register-register moves.
14047 @item __AVR_HAVE_LPMX__
14048 The device has the @code{LPM R@var{n},Z} and
14049 @code{LPM R@var{n},Z+} instructions.
14051 @item __AVR_HAVE_MUL__
14052 The device has a hardware multiplier. 
14054 @item __AVR_HAVE_JMP_CALL__
14055 The device has the @code{JMP} and @code{CALL} instructions.
14056 This is the case for devices with at least 16@tie{}KiB of program
14057 memory.
14059 @item __AVR_HAVE_EIJMP_EICALL__
14060 @itemx __AVR_3_BYTE_PC__
14061 The device has the @code{EIJMP} and @code{EICALL} instructions.
14062 This is the case for devices with more than 128@tie{}KiB of program memory.
14063 This also means that the program counter
14064 (PC) is 3@tie{}bytes wide.
14066 @item __AVR_2_BYTE_PC__
14067 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
14068 with up to 128@tie{}KiB of program memory.
14070 @item __AVR_HAVE_8BIT_SP__
14071 @itemx __AVR_HAVE_16BIT_SP__
14072 The stack pointer (SP) register is treated as 8-bit respectively
14073 16-bit register by the compiler.
14074 The definition of these macros is affected by @option{-mtiny-stack}.
14076 @item __AVR_HAVE_SPH__
14077 @itemx __AVR_SP8__
14078 The device has the SPH (high part of stack pointer) special function
14079 register or has an 8-bit stack pointer, respectively.
14080 The definition of these macros is affected by @option{-mmcu=} and
14081 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
14082 by @option{-msp8}.
14084 @item __AVR_HAVE_RAMPD__
14085 @itemx __AVR_HAVE_RAMPX__
14086 @itemx __AVR_HAVE_RAMPY__
14087 @itemx __AVR_HAVE_RAMPZ__
14088 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
14089 @code{RAMPZ} special function register, respectively.
14091 @item __NO_INTERRUPTS__
14092 This macro reflects the @option{-mno-interrupts} command-line option.
14094 @item __AVR_ERRATA_SKIP__
14095 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
14096 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
14097 instructions because of a hardware erratum.  Skip instructions are
14098 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
14099 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
14100 set.
14102 @item __AVR_ISA_RMW__
14103 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
14105 @item __AVR_SFR_OFFSET__=@var{offset}
14106 Instructions that can address I/O special function registers directly
14107 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
14108 address as if addressed by an instruction to access RAM like @code{LD}
14109 or @code{STS}. This offset depends on the device architecture and has
14110 to be subtracted from the RAM address in order to get the
14111 respective I/O@tie{}address.
14113 @item __WITH_AVRLIBC__
14114 The compiler is configured to be used together with AVR-Libc.
14115 See the @option{--with-avrlibc} configure option.
14117 @end table
14119 @node Blackfin Options
14120 @subsection Blackfin Options
14121 @cindex Blackfin Options
14123 @table @gcctabopt
14124 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
14125 @opindex mcpu=
14126 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
14127 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14128 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14129 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14130 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14131 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14132 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14133 @samp{bf561}, @samp{bf592}.
14135 The optional @var{sirevision} specifies the silicon revision of the target
14136 Blackfin processor.  Any workarounds available for the targeted silicon revision
14137 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14138 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14139 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14140 hexadecimal digits representing the major and minor numbers in the silicon
14141 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14142 is not defined.  If @var{sirevision} is @samp{any}, the
14143 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14144 If this optional @var{sirevision} is not used, GCC assumes the latest known
14145 silicon revision of the targeted Blackfin processor.
14147 GCC defines a preprocessor macro for the specified @var{cpu}.
14148 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14149 provided by libgloss to be linked in if @option{-msim} is not given.
14151 Without this option, @samp{bf532} is used as the processor by default.
14153 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14154 only the preprocessor macro is defined.
14156 @item -msim
14157 @opindex msim
14158 Specifies that the program will be run on the simulator.  This causes
14159 the simulator BSP provided by libgloss to be linked in.  This option
14160 has effect only for @samp{bfin-elf} toolchain.
14161 Certain other options, such as @option{-mid-shared-library} and
14162 @option{-mfdpic}, imply @option{-msim}.
14164 @item -momit-leaf-frame-pointer
14165 @opindex momit-leaf-frame-pointer
14166 Don't keep the frame pointer in a register for leaf functions.  This
14167 avoids the instructions to save, set up and restore frame pointers and
14168 makes an extra register available in leaf functions.  The option
14169 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14170 which might make debugging harder.
14172 @item -mspecld-anomaly
14173 @opindex mspecld-anomaly
14174 When enabled, the compiler ensures that the generated code does not
14175 contain speculative loads after jump instructions. If this option is used,
14176 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14178 @item -mno-specld-anomaly
14179 @opindex mno-specld-anomaly
14180 Don't generate extra code to prevent speculative loads from occurring.
14182 @item -mcsync-anomaly
14183 @opindex mcsync-anomaly
14184 When enabled, the compiler ensures that the generated code does not
14185 contain CSYNC or SSYNC instructions too soon after conditional branches.
14186 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14188 @item -mno-csync-anomaly
14189 @opindex mno-csync-anomaly
14190 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14191 occurring too soon after a conditional branch.
14193 @item -mlow-64k
14194 @opindex mlow-64k
14195 When enabled, the compiler is free to take advantage of the knowledge that
14196 the entire program fits into the low 64k of memory.
14198 @item -mno-low-64k
14199 @opindex mno-low-64k
14200 Assume that the program is arbitrarily large.  This is the default.
14202 @item -mstack-check-l1
14203 @opindex mstack-check-l1
14204 Do stack checking using information placed into L1 scratchpad memory by the
14205 uClinux kernel.
14207 @item -mid-shared-library
14208 @opindex mid-shared-library
14209 Generate code that supports shared libraries via the library ID method.
14210 This allows for execute in place and shared libraries in an environment
14211 without virtual memory management.  This option implies @option{-fPIC}.
14212 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14214 @item -mno-id-shared-library
14215 @opindex mno-id-shared-library
14216 Generate code that doesn't assume ID-based shared libraries are being used.
14217 This is the default.
14219 @item -mleaf-id-shared-library
14220 @opindex mleaf-id-shared-library
14221 Generate code that supports shared libraries via the library ID method,
14222 but assumes that this library or executable won't link against any other
14223 ID shared libraries.  That allows the compiler to use faster code for jumps
14224 and calls.
14226 @item -mno-leaf-id-shared-library
14227 @opindex mno-leaf-id-shared-library
14228 Do not assume that the code being compiled won't link against any ID shared
14229 libraries.  Slower code is generated for jump and call insns.
14231 @item -mshared-library-id=n
14232 @opindex mshared-library-id
14233 Specifies the identification number of the ID-based shared library being
14234 compiled.  Specifying a value of 0 generates more compact code; specifying
14235 other values forces the allocation of that number to the current
14236 library but is no more space- or time-efficient than omitting this option.
14238 @item -msep-data
14239 @opindex msep-data
14240 Generate code that allows the data segment to be located in a different
14241 area of memory from the text segment.  This allows for execute in place in
14242 an environment without virtual memory management by eliminating relocations
14243 against the text section.
14245 @item -mno-sep-data
14246 @opindex mno-sep-data
14247 Generate code that assumes that the data segment follows the text segment.
14248 This is the default.
14250 @item -mlong-calls
14251 @itemx -mno-long-calls
14252 @opindex mlong-calls
14253 @opindex mno-long-calls
14254 Tells the compiler to perform function calls by first loading the
14255 address of the function into a register and then performing a subroutine
14256 call on this register.  This switch is needed if the target function
14257 lies outside of the 24-bit addressing range of the offset-based
14258 version of subroutine call instruction.
14260 This feature is not enabled by default.  Specifying
14261 @option{-mno-long-calls} restores the default behavior.  Note these
14262 switches have no effect on how the compiler generates code to handle
14263 function calls via function pointers.
14265 @item -mfast-fp
14266 @opindex mfast-fp
14267 Link with the fast floating-point library. This library relaxes some of
14268 the IEEE floating-point standard's rules for checking inputs against
14269 Not-a-Number (NAN), in the interest of performance.
14271 @item -minline-plt
14272 @opindex minline-plt
14273 Enable inlining of PLT entries in function calls to functions that are
14274 not known to bind locally.  It has no effect without @option{-mfdpic}.
14276 @item -mmulticore
14277 @opindex mmulticore
14278 Build a standalone application for multicore Blackfin processors. 
14279 This option causes proper start files and link scripts supporting 
14280 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
14281 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
14283 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
14284 selects the one-application-per-core programming model.  Without
14285 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
14286 programming model is used. In this model, the main function of Core B
14287 should be named as @code{coreb_main}.
14289 If this option is not used, the single-core application programming
14290 model is used.
14292 @item -mcorea
14293 @opindex mcorea
14294 Build a standalone application for Core A of BF561 when using
14295 the one-application-per-core programming model. Proper start files
14296 and link scripts are used to support Core A, and the macro
14297 @code{__BFIN_COREA} is defined.
14298 This option can only be used in conjunction with @option{-mmulticore}.
14300 @item -mcoreb
14301 @opindex mcoreb
14302 Build a standalone application for Core B of BF561 when using
14303 the one-application-per-core programming model. Proper start files
14304 and link scripts are used to support Core B, and the macro
14305 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
14306 should be used instead of @code{main}. 
14307 This option can only be used in conjunction with @option{-mmulticore}.
14309 @item -msdram
14310 @opindex msdram
14311 Build a standalone application for SDRAM. Proper start files and
14312 link scripts are used to put the application into SDRAM, and the macro
14313 @code{__BFIN_SDRAM} is defined.
14314 The loader should initialize SDRAM before loading the application.
14316 @item -micplb
14317 @opindex micplb
14318 Assume that ICPLBs are enabled at run time.  This has an effect on certain
14319 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
14320 are enabled; for standalone applications the default is off.
14321 @end table
14323 @node C6X Options
14324 @subsection C6X Options
14325 @cindex C6X Options
14327 @table @gcctabopt
14328 @item -march=@var{name}
14329 @opindex march
14330 This specifies the name of the target architecture.  GCC uses this
14331 name to determine what kind of instructions it can emit when generating
14332 assembly code.  Permissible names are: @samp{c62x},
14333 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
14335 @item -mbig-endian
14336 @opindex mbig-endian
14337 Generate code for a big-endian target.
14339 @item -mlittle-endian
14340 @opindex mlittle-endian
14341 Generate code for a little-endian target.  This is the default.
14343 @item -msim
14344 @opindex msim
14345 Choose startup files and linker script suitable for the simulator.
14347 @item -msdata=default
14348 @opindex msdata=default
14349 Put small global and static data in the @code{.neardata} section,
14350 which is pointed to by register @code{B14}.  Put small uninitialized
14351 global and static data in the @code{.bss} section, which is adjacent
14352 to the @code{.neardata} section.  Put small read-only data into the
14353 @code{.rodata} section.  The corresponding sections used for large
14354 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
14356 @item -msdata=all
14357 @opindex msdata=all
14358 Put all data, not just small objects, into the sections reserved for
14359 small data, and use addressing relative to the @code{B14} register to
14360 access them.
14362 @item -msdata=none
14363 @opindex msdata=none
14364 Make no use of the sections reserved for small data, and use absolute
14365 addresses to access all data.  Put all initialized global and static
14366 data in the @code{.fardata} section, and all uninitialized data in the
14367 @code{.far} section.  Put all constant data into the @code{.const}
14368 section.
14369 @end table
14371 @node CRIS Options
14372 @subsection CRIS Options
14373 @cindex CRIS Options
14375 These options are defined specifically for the CRIS ports.
14377 @table @gcctabopt
14378 @item -march=@var{architecture-type}
14379 @itemx -mcpu=@var{architecture-type}
14380 @opindex march
14381 @opindex mcpu
14382 Generate code for the specified architecture.  The choices for
14383 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
14384 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
14385 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
14386 @samp{v10}.
14388 @item -mtune=@var{architecture-type}
14389 @opindex mtune
14390 Tune to @var{architecture-type} everything applicable about the generated
14391 code, except for the ABI and the set of available instructions.  The
14392 choices for @var{architecture-type} are the same as for
14393 @option{-march=@var{architecture-type}}.
14395 @item -mmax-stack-frame=@var{n}
14396 @opindex mmax-stack-frame
14397 Warn when the stack frame of a function exceeds @var{n} bytes.
14399 @item -metrax4
14400 @itemx -metrax100
14401 @opindex metrax4
14402 @opindex metrax100
14403 The options @option{-metrax4} and @option{-metrax100} are synonyms for
14404 @option{-march=v3} and @option{-march=v8} respectively.
14406 @item -mmul-bug-workaround
14407 @itemx -mno-mul-bug-workaround
14408 @opindex mmul-bug-workaround
14409 @opindex mno-mul-bug-workaround
14410 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
14411 models where it applies.  This option is active by default.
14413 @item -mpdebug
14414 @opindex mpdebug
14415 Enable CRIS-specific verbose debug-related information in the assembly
14416 code.  This option also has the effect of turning off the @samp{#NO_APP}
14417 formatted-code indicator to the assembler at the beginning of the
14418 assembly file.
14420 @item -mcc-init
14421 @opindex mcc-init
14422 Do not use condition-code results from previous instruction; always emit
14423 compare and test instructions before use of condition codes.
14425 @item -mno-side-effects
14426 @opindex mno-side-effects
14427 Do not emit instructions with side effects in addressing modes other than
14428 post-increment.
14430 @item -mstack-align
14431 @itemx -mno-stack-align
14432 @itemx -mdata-align
14433 @itemx -mno-data-align
14434 @itemx -mconst-align
14435 @itemx -mno-const-align
14436 @opindex mstack-align
14437 @opindex mno-stack-align
14438 @opindex mdata-align
14439 @opindex mno-data-align
14440 @opindex mconst-align
14441 @opindex mno-const-align
14442 These options (@samp{no-} options) arrange (eliminate arrangements) for the
14443 stack frame, individual data and constants to be aligned for the maximum
14444 single data access size for the chosen CPU model.  The default is to
14445 arrange for 32-bit alignment.  ABI details such as structure layout are
14446 not affected by these options.
14448 @item -m32-bit
14449 @itemx -m16-bit
14450 @itemx -m8-bit
14451 @opindex m32-bit
14452 @opindex m16-bit
14453 @opindex m8-bit
14454 Similar to the stack- data- and const-align options above, these options
14455 arrange for stack frame, writable data and constants to all be 32-bit,
14456 16-bit or 8-bit aligned.  The default is 32-bit alignment.
14458 @item -mno-prologue-epilogue
14459 @itemx -mprologue-epilogue
14460 @opindex mno-prologue-epilogue
14461 @opindex mprologue-epilogue
14462 With @option{-mno-prologue-epilogue}, the normal function prologue and
14463 epilogue which set up the stack frame are omitted and no return
14464 instructions or return sequences are generated in the code.  Use this
14465 option only together with visual inspection of the compiled code: no
14466 warnings or errors are generated when call-saved registers must be saved,
14467 or storage for local variables needs to be allocated.
14469 @item -mno-gotplt
14470 @itemx -mgotplt
14471 @opindex mno-gotplt
14472 @opindex mgotplt
14473 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
14474 instruction sequences that load addresses for functions from the PLT part
14475 of the GOT rather than (traditional on other architectures) calls to the
14476 PLT@.  The default is @option{-mgotplt}.
14478 @item -melf
14479 @opindex melf
14480 Legacy no-op option only recognized with the cris-axis-elf and
14481 cris-axis-linux-gnu targets.
14483 @item -mlinux
14484 @opindex mlinux
14485 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
14487 @item -sim
14488 @opindex sim
14489 This option, recognized for the cris-axis-elf, arranges
14490 to link with input-output functions from a simulator library.  Code,
14491 initialized data and zero-initialized data are allocated consecutively.
14493 @item -sim2
14494 @opindex sim2
14495 Like @option{-sim}, but pass linker options to locate initialized data at
14496 0x40000000 and zero-initialized data at 0x80000000.
14497 @end table
14499 @node CR16 Options
14500 @subsection CR16 Options
14501 @cindex CR16 Options
14503 These options are defined specifically for the CR16 ports.
14505 @table @gcctabopt
14507 @item -mmac
14508 @opindex mmac
14509 Enable the use of multiply-accumulate instructions. Disabled by default.
14511 @item -mcr16cplus
14512 @itemx -mcr16c
14513 @opindex mcr16cplus
14514 @opindex mcr16c
14515 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14516 is default.
14518 @item -msim
14519 @opindex msim
14520 Links the library libsim.a which is in compatible with simulator. Applicable
14521 to ELF compiler only.
14523 @item -mint32
14524 @opindex mint32
14525 Choose integer type as 32-bit wide.
14527 @item -mbit-ops
14528 @opindex mbit-ops
14529 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14531 @item -mdata-model=@var{model}
14532 @opindex mdata-model
14533 Choose a data model. The choices for @var{model} are @samp{near},
14534 @samp{far} or @samp{medium}. @samp{medium} is default.
14535 However, @samp{far} is not valid with @option{-mcr16c}, as the
14536 CR16C architecture does not support the far data model.
14537 @end table
14539 @node Darwin Options
14540 @subsection Darwin Options
14541 @cindex Darwin options
14543 These options are defined for all architectures running the Darwin operating
14544 system.
14546 FSF GCC on Darwin does not create ``fat'' object files; it creates
14547 an object file for the single architecture that GCC was built to
14548 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14549 @option{-arch} options are used; it does so by running the compiler or
14550 linker multiple times and joining the results together with
14551 @file{lipo}.
14553 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14554 @samp{i686}) is determined by the flags that specify the ISA
14555 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14556 @option{-force_cpusubtype_ALL} option can be used to override this.
14558 The Darwin tools vary in their behavior when presented with an ISA
14559 mismatch.  The assembler, @file{as}, only permits instructions to
14560 be used that are valid for the subtype of the file it is generating,
14561 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14562 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14563 and prints an error if asked to create a shared library with a less
14564 restrictive subtype than its input files (for instance, trying to put
14565 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14566 for executables, @command{ld}, quietly gives the executable the most
14567 restrictive subtype of any of its input files.
14569 @table @gcctabopt
14570 @item -F@var{dir}
14571 @opindex F
14572 Add the framework directory @var{dir} to the head of the list of
14573 directories to be searched for header files.  These directories are
14574 interleaved with those specified by @option{-I} options and are
14575 scanned in a left-to-right order.
14577 A framework directory is a directory with frameworks in it.  A
14578 framework is a directory with a @file{Headers} and/or
14579 @file{PrivateHeaders} directory contained directly in it that ends
14580 in @file{.framework}.  The name of a framework is the name of this
14581 directory excluding the @file{.framework}.  Headers associated with
14582 the framework are found in one of those two directories, with
14583 @file{Headers} being searched first.  A subframework is a framework
14584 directory that is in a framework's @file{Frameworks} directory.
14585 Includes of subframework headers can only appear in a header of a
14586 framework that contains the subframework, or in a sibling subframework
14587 header.  Two subframeworks are siblings if they occur in the same
14588 framework.  A subframework should not have the same name as a
14589 framework; a warning is issued if this is violated.  Currently a
14590 subframework cannot have subframeworks; in the future, the mechanism
14591 may be extended to support this.  The standard frameworks can be found
14592 in @file{/System/Library/Frameworks} and
14593 @file{/Library/Frameworks}.  An example include looks like
14594 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14595 the name of the framework and @file{header.h} is found in the
14596 @file{PrivateHeaders} or @file{Headers} directory.
14598 @item -iframework@var{dir}
14599 @opindex iframework
14600 Like @option{-F} except the directory is a treated as a system
14601 directory.  The main difference between this @option{-iframework} and
14602 @option{-F} is that with @option{-iframework} the compiler does not
14603 warn about constructs contained within header files found via
14604 @var{dir}.  This option is valid only for the C family of languages.
14606 @item -gused
14607 @opindex gused
14608 Emit debugging information for symbols that are used.  For stabs
14609 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14610 This is by default ON@.
14612 @item -gfull
14613 @opindex gfull
14614 Emit debugging information for all symbols and types.
14616 @item -mmacosx-version-min=@var{version}
14617 The earliest version of MacOS X that this executable will run on
14618 is @var{version}.  Typical values of @var{version} include @code{10.1},
14619 @code{10.2}, and @code{10.3.9}.
14621 If the compiler was built to use the system's headers by default,
14622 then the default for this option is the system version on which the
14623 compiler is running, otherwise the default is to make choices that
14624 are compatible with as many systems and code bases as possible.
14626 @item -mkernel
14627 @opindex mkernel
14628 Enable kernel development mode.  The @option{-mkernel} option sets
14629 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14630 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14631 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14632 applicable.  This mode also sets @option{-mno-altivec},
14633 @option{-msoft-float}, @option{-fno-builtin} and
14634 @option{-mlong-branch} for PowerPC targets.
14636 @item -mone-byte-bool
14637 @opindex mone-byte-bool
14638 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
14639 By default @code{sizeof(bool)} is @code{4} when compiling for
14640 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
14641 option has no effect on x86.
14643 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14644 to generate code that is not binary compatible with code generated
14645 without that switch.  Using this switch may require recompiling all
14646 other modules in a program, including system libraries.  Use this
14647 switch to conform to a non-default data model.
14649 @item -mfix-and-continue
14650 @itemx -ffix-and-continue
14651 @itemx -findirect-data
14652 @opindex mfix-and-continue
14653 @opindex ffix-and-continue
14654 @opindex findirect-data
14655 Generate code suitable for fast turnaround development, such as to
14656 allow GDB to dynamically load @file{.o} files into already-running
14657 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14658 are provided for backwards compatibility.
14660 @item -all_load
14661 @opindex all_load
14662 Loads all members of static archive libraries.
14663 See man ld(1) for more information.
14665 @item -arch_errors_fatal
14666 @opindex arch_errors_fatal
14667 Cause the errors having to do with files that have the wrong architecture
14668 to be fatal.
14670 @item -bind_at_load
14671 @opindex bind_at_load
14672 Causes the output file to be marked such that the dynamic linker will
14673 bind all undefined references when the file is loaded or launched.
14675 @item -bundle
14676 @opindex bundle
14677 Produce a Mach-o bundle format file.
14678 See man ld(1) for more information.
14680 @item -bundle_loader @var{executable}
14681 @opindex bundle_loader
14682 This option specifies the @var{executable} that will load the build
14683 output file being linked.  See man ld(1) for more information.
14685 @item -dynamiclib
14686 @opindex dynamiclib
14687 When passed this option, GCC produces a dynamic library instead of
14688 an executable when linking, using the Darwin @file{libtool} command.
14690 @item -force_cpusubtype_ALL
14691 @opindex force_cpusubtype_ALL
14692 This causes GCC's output file to have the @samp{ALL} subtype, instead of
14693 one controlled by the @option{-mcpu} or @option{-march} option.
14695 @item -allowable_client  @var{client_name}
14696 @itemx -client_name
14697 @itemx -compatibility_version
14698 @itemx -current_version
14699 @itemx -dead_strip
14700 @itemx -dependency-file
14701 @itemx -dylib_file
14702 @itemx -dylinker_install_name
14703 @itemx -dynamic
14704 @itemx -exported_symbols_list
14705 @itemx -filelist
14706 @need 800
14707 @itemx -flat_namespace
14708 @itemx -force_flat_namespace
14709 @itemx -headerpad_max_install_names
14710 @itemx -image_base
14711 @itemx -init
14712 @itemx -install_name
14713 @itemx -keep_private_externs
14714 @itemx -multi_module
14715 @itemx -multiply_defined
14716 @itemx -multiply_defined_unused
14717 @need 800
14718 @itemx -noall_load
14719 @itemx -no_dead_strip_inits_and_terms
14720 @itemx -nofixprebinding
14721 @itemx -nomultidefs
14722 @itemx -noprebind
14723 @itemx -noseglinkedit
14724 @itemx -pagezero_size
14725 @itemx -prebind
14726 @itemx -prebind_all_twolevel_modules
14727 @itemx -private_bundle
14728 @need 800
14729 @itemx -read_only_relocs
14730 @itemx -sectalign
14731 @itemx -sectobjectsymbols
14732 @itemx -whyload
14733 @itemx -seg1addr
14734 @itemx -sectcreate
14735 @itemx -sectobjectsymbols
14736 @itemx -sectorder
14737 @itemx -segaddr
14738 @itemx -segs_read_only_addr
14739 @need 800
14740 @itemx -segs_read_write_addr
14741 @itemx -seg_addr_table
14742 @itemx -seg_addr_table_filename
14743 @itemx -seglinkedit
14744 @itemx -segprot
14745 @itemx -segs_read_only_addr
14746 @itemx -segs_read_write_addr
14747 @itemx -single_module
14748 @itemx -static
14749 @itemx -sub_library
14750 @need 800
14751 @itemx -sub_umbrella
14752 @itemx -twolevel_namespace
14753 @itemx -umbrella
14754 @itemx -undefined
14755 @itemx -unexported_symbols_list
14756 @itemx -weak_reference_mismatches
14757 @itemx -whatsloaded
14758 @opindex allowable_client
14759 @opindex client_name
14760 @opindex compatibility_version
14761 @opindex current_version
14762 @opindex dead_strip
14763 @opindex dependency-file
14764 @opindex dylib_file
14765 @opindex dylinker_install_name
14766 @opindex dynamic
14767 @opindex exported_symbols_list
14768 @opindex filelist
14769 @opindex flat_namespace
14770 @opindex force_flat_namespace
14771 @opindex headerpad_max_install_names
14772 @opindex image_base
14773 @opindex init
14774 @opindex install_name
14775 @opindex keep_private_externs
14776 @opindex multi_module
14777 @opindex multiply_defined
14778 @opindex multiply_defined_unused
14779 @opindex noall_load
14780 @opindex no_dead_strip_inits_and_terms
14781 @opindex nofixprebinding
14782 @opindex nomultidefs
14783 @opindex noprebind
14784 @opindex noseglinkedit
14785 @opindex pagezero_size
14786 @opindex prebind
14787 @opindex prebind_all_twolevel_modules
14788 @opindex private_bundle
14789 @opindex read_only_relocs
14790 @opindex sectalign
14791 @opindex sectobjectsymbols
14792 @opindex whyload
14793 @opindex seg1addr
14794 @opindex sectcreate
14795 @opindex sectobjectsymbols
14796 @opindex sectorder
14797 @opindex segaddr
14798 @opindex segs_read_only_addr
14799 @opindex segs_read_write_addr
14800 @opindex seg_addr_table
14801 @opindex seg_addr_table_filename
14802 @opindex seglinkedit
14803 @opindex segprot
14804 @opindex segs_read_only_addr
14805 @opindex segs_read_write_addr
14806 @opindex single_module
14807 @opindex static
14808 @opindex sub_library
14809 @opindex sub_umbrella
14810 @opindex twolevel_namespace
14811 @opindex umbrella
14812 @opindex undefined
14813 @opindex unexported_symbols_list
14814 @opindex weak_reference_mismatches
14815 @opindex whatsloaded
14816 These options are passed to the Darwin linker.  The Darwin linker man page
14817 describes them in detail.
14818 @end table
14820 @node DEC Alpha Options
14821 @subsection DEC Alpha Options
14823 These @samp{-m} options are defined for the DEC Alpha implementations:
14825 @table @gcctabopt
14826 @item -mno-soft-float
14827 @itemx -msoft-float
14828 @opindex mno-soft-float
14829 @opindex msoft-float
14830 Use (do not use) the hardware floating-point instructions for
14831 floating-point operations.  When @option{-msoft-float} is specified,
14832 functions in @file{libgcc.a} are used to perform floating-point
14833 operations.  Unless they are replaced by routines that emulate the
14834 floating-point operations, or compiled in such a way as to call such
14835 emulations routines, these routines issue floating-point
14836 operations.   If you are compiling for an Alpha without floating-point
14837 operations, you must ensure that the library is built so as not to call
14838 them.
14840 Note that Alpha implementations without floating-point operations are
14841 required to have floating-point registers.
14843 @item -mfp-reg
14844 @itemx -mno-fp-regs
14845 @opindex mfp-reg
14846 @opindex mno-fp-regs
14847 Generate code that uses (does not use) the floating-point register set.
14848 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14849 register set is not used, floating-point operands are passed in integer
14850 registers as if they were integers and floating-point results are passed
14851 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14852 so any function with a floating-point argument or return value called by code
14853 compiled with @option{-mno-fp-regs} must also be compiled with that
14854 option.
14856 A typical use of this option is building a kernel that does not use,
14857 and hence need not save and restore, any floating-point registers.
14859 @item -mieee
14860 @opindex mieee
14861 The Alpha architecture implements floating-point hardware optimized for
14862 maximum performance.  It is mostly compliant with the IEEE floating-point
14863 standard.  However, for full compliance, software assistance is
14864 required.  This option generates code fully IEEE-compliant code
14865 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14866 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14867 defined during compilation.  The resulting code is less efficient but is
14868 able to correctly support denormalized numbers and exceptional IEEE
14869 values such as not-a-number and plus/minus infinity.  Other Alpha
14870 compilers call this option @option{-ieee_with_no_inexact}.
14872 @item -mieee-with-inexact
14873 @opindex mieee-with-inexact
14874 This is like @option{-mieee} except the generated code also maintains
14875 the IEEE @var{inexact-flag}.  Turning on this option causes the
14876 generated code to implement fully-compliant IEEE math.  In addition to
14877 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14878 macro.  On some Alpha implementations the resulting code may execute
14879 significantly slower than the code generated by default.  Since there is
14880 very little code that depends on the @var{inexact-flag}, you should
14881 normally not specify this option.  Other Alpha compilers call this
14882 option @option{-ieee_with_inexact}.
14884 @item -mfp-trap-mode=@var{trap-mode}
14885 @opindex mfp-trap-mode
14886 This option controls what floating-point related traps are enabled.
14887 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14888 The trap mode can be set to one of four values:
14890 @table @samp
14891 @item n
14892 This is the default (normal) setting.  The only traps that are enabled
14893 are the ones that cannot be disabled in software (e.g., division by zero
14894 trap).
14896 @item u
14897 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14898 as well.
14900 @item su
14901 Like @samp{u}, but the instructions are marked to be safe for software
14902 completion (see Alpha architecture manual for details).
14904 @item sui
14905 Like @samp{su}, but inexact traps are enabled as well.
14906 @end table
14908 @item -mfp-rounding-mode=@var{rounding-mode}
14909 @opindex mfp-rounding-mode
14910 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14911 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14914 @table @samp
14915 @item n
14916 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14917 the nearest machine number or towards the even machine number in case
14918 of a tie.
14920 @item m
14921 Round towards minus infinity.
14923 @item c
14924 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14926 @item d
14927 Dynamic rounding mode.  A field in the floating-point control register
14928 (@var{fpcr}, see Alpha architecture reference manual) controls the
14929 rounding mode in effect.  The C library initializes this register for
14930 rounding towards plus infinity.  Thus, unless your program modifies the
14931 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14932 @end table
14934 @item -mtrap-precision=@var{trap-precision}
14935 @opindex mtrap-precision
14936 In the Alpha architecture, floating-point traps are imprecise.  This
14937 means without software assistance it is impossible to recover from a
14938 floating trap and program execution normally needs to be terminated.
14939 GCC can generate code that can assist operating system trap handlers
14940 in determining the exact location that caused a floating-point trap.
14941 Depending on the requirements of an application, different levels of
14942 precisions can be selected:
14944 @table @samp
14945 @item p
14946 Program precision.  This option is the default and means a trap handler
14947 can only identify which program caused a floating-point exception.
14949 @item f
14950 Function precision.  The trap handler can determine the function that
14951 caused a floating-point exception.
14953 @item i
14954 Instruction precision.  The trap handler can determine the exact
14955 instruction that caused a floating-point exception.
14956 @end table
14958 Other Alpha compilers provide the equivalent options called
14959 @option{-scope_safe} and @option{-resumption_safe}.
14961 @item -mieee-conformant
14962 @opindex mieee-conformant
14963 This option marks the generated code as IEEE conformant.  You must not
14964 use this option unless you also specify @option{-mtrap-precision=i} and either
14965 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14966 is to emit the line @samp{.eflag 48} in the function prologue of the
14967 generated assembly file.
14969 @item -mbuild-constants
14970 @opindex mbuild-constants
14971 Normally GCC examines a 32- or 64-bit integer constant to
14972 see if it can construct it from smaller constants in two or three
14973 instructions.  If it cannot, it outputs the constant as a literal and
14974 generates code to load it from the data segment at run time.
14976 Use this option to require GCC to construct @emph{all} integer constants
14977 using code, even if it takes more instructions (the maximum is six).
14979 You typically use this option to build a shared library dynamic
14980 loader.  Itself a shared library, it must relocate itself in memory
14981 before it can find the variables and constants in its own data segment.
14983 @item -mbwx
14984 @itemx -mno-bwx
14985 @itemx -mcix
14986 @itemx -mno-cix
14987 @itemx -mfix
14988 @itemx -mno-fix
14989 @itemx -mmax
14990 @itemx -mno-max
14991 @opindex mbwx
14992 @opindex mno-bwx
14993 @opindex mcix
14994 @opindex mno-cix
14995 @opindex mfix
14996 @opindex mno-fix
14997 @opindex mmax
14998 @opindex mno-max
14999 Indicate whether GCC should generate code to use the optional BWX,
15000 CIX, FIX and MAX instruction sets.  The default is to use the instruction
15001 sets supported by the CPU type specified via @option{-mcpu=} option or that
15002 of the CPU on which GCC was built if none is specified.
15004 @item -mfloat-vax
15005 @itemx -mfloat-ieee
15006 @opindex mfloat-vax
15007 @opindex mfloat-ieee
15008 Generate code that uses (does not use) VAX F and G floating-point
15009 arithmetic instead of IEEE single and double precision.
15011 @item -mexplicit-relocs
15012 @itemx -mno-explicit-relocs
15013 @opindex mexplicit-relocs
15014 @opindex mno-explicit-relocs
15015 Older Alpha assemblers provided no way to generate symbol relocations
15016 except via assembler macros.  Use of these macros does not allow
15017 optimal instruction scheduling.  GNU binutils as of version 2.12
15018 supports a new syntax that allows the compiler to explicitly mark
15019 which relocations should apply to which instructions.  This option
15020 is mostly useful for debugging, as GCC detects the capabilities of
15021 the assembler when it is built and sets the default accordingly.
15023 @item -msmall-data
15024 @itemx -mlarge-data
15025 @opindex msmall-data
15026 @opindex mlarge-data
15027 When @option{-mexplicit-relocs} is in effect, static data is
15028 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
15029 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
15030 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
15031 16-bit relocations off of the @code{$gp} register.  This limits the
15032 size of the small data area to 64KB, but allows the variables to be
15033 directly accessed via a single instruction.
15035 The default is @option{-mlarge-data}.  With this option the data area
15036 is limited to just below 2GB@.  Programs that require more than 2GB of
15037 data must use @code{malloc} or @code{mmap} to allocate the data in the
15038 heap instead of in the program's data segment.
15040 When generating code for shared libraries, @option{-fpic} implies
15041 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
15043 @item -msmall-text
15044 @itemx -mlarge-text
15045 @opindex msmall-text
15046 @opindex mlarge-text
15047 When @option{-msmall-text} is used, the compiler assumes that the
15048 code of the entire program (or shared library) fits in 4MB, and is
15049 thus reachable with a branch instruction.  When @option{-msmall-data}
15050 is used, the compiler can assume that all local symbols share the
15051 same @code{$gp} value, and thus reduce the number of instructions
15052 required for a function call from 4 to 1.
15054 The default is @option{-mlarge-text}.
15056 @item -mcpu=@var{cpu_type}
15057 @opindex mcpu
15058 Set the instruction set and instruction scheduling parameters for
15059 machine type @var{cpu_type}.  You can specify either the @samp{EV}
15060 style name or the corresponding chip number.  GCC supports scheduling
15061 parameters for the EV4, EV5 and EV6 family of processors and
15062 chooses the default values for the instruction set from the processor
15063 you specify.  If you do not specify a processor type, GCC defaults
15064 to the processor on which the compiler was built.
15066 Supported values for @var{cpu_type} are
15068 @table @samp
15069 @item ev4
15070 @itemx ev45
15071 @itemx 21064
15072 Schedules as an EV4 and has no instruction set extensions.
15074 @item ev5
15075 @itemx 21164
15076 Schedules as an EV5 and has no instruction set extensions.
15078 @item ev56
15079 @itemx 21164a
15080 Schedules as an EV5 and supports the BWX extension.
15082 @item pca56
15083 @itemx 21164pc
15084 @itemx 21164PC
15085 Schedules as an EV5 and supports the BWX and MAX extensions.
15087 @item ev6
15088 @itemx 21264
15089 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
15091 @item ev67
15092 @itemx 21264a
15093 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
15094 @end table
15096 Native toolchains also support the value @samp{native},
15097 which selects the best architecture option for the host processor.
15098 @option{-mcpu=native} has no effect if GCC does not recognize
15099 the processor.
15101 @item -mtune=@var{cpu_type}
15102 @opindex mtune
15103 Set only the instruction scheduling parameters for machine type
15104 @var{cpu_type}.  The instruction set is not changed.
15106 Native toolchains also support the value @samp{native},
15107 which selects the best architecture option for the host processor.
15108 @option{-mtune=native} has no effect if GCC does not recognize
15109 the processor.
15111 @item -mmemory-latency=@var{time}
15112 @opindex mmemory-latency
15113 Sets the latency the scheduler should assume for typical memory
15114 references as seen by the application.  This number is highly
15115 dependent on the memory access patterns used by the application
15116 and the size of the external cache on the machine.
15118 Valid options for @var{time} are
15120 @table @samp
15121 @item @var{number}
15122 A decimal number representing clock cycles.
15124 @item L1
15125 @itemx L2
15126 @itemx L3
15127 @itemx main
15128 The compiler contains estimates of the number of clock cycles for
15129 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15130 (also called Dcache, Scache, and Bcache), as well as to main memory.
15131 Note that L3 is only valid for EV5.
15133 @end table
15134 @end table
15136 @node FR30 Options
15137 @subsection FR30 Options
15138 @cindex FR30 Options
15140 These options are defined specifically for the FR30 port.
15142 @table @gcctabopt
15144 @item -msmall-model
15145 @opindex msmall-model
15146 Use the small address space model.  This can produce smaller code, but
15147 it does assume that all symbolic values and addresses fit into a
15148 20-bit range.
15150 @item -mno-lsim
15151 @opindex mno-lsim
15152 Assume that runtime support has been provided and so there is no need
15153 to include the simulator library (@file{libsim.a}) on the linker
15154 command line.
15156 @end table
15158 @node FT32 Options
15159 @subsection FT32 Options
15160 @cindex FT32 Options
15162 These options are defined specifically for the FT32 port.
15164 @table @gcctabopt
15166 @item -msim
15167 @opindex msim
15168 Specifies that the program will be run on the simulator.  This causes
15169 an alternate runtime startup and library to be linked.
15170 You must not use this option when generating programs that will run on
15171 real hardware; you must provide your own runtime library for whatever
15172 I/O functions are needed.
15174 @item -mlra
15175 @opindex mlra
15176 Enable Local Register Allocation.  This is still experimental for FT32,
15177 so by default the compiler uses standard reload.
15179 @end table
15181 @node FRV Options
15182 @subsection FRV Options
15183 @cindex FRV Options
15185 @table @gcctabopt
15186 @item -mgpr-32
15187 @opindex mgpr-32
15189 Only use the first 32 general-purpose registers.
15191 @item -mgpr-64
15192 @opindex mgpr-64
15194 Use all 64 general-purpose registers.
15196 @item -mfpr-32
15197 @opindex mfpr-32
15199 Use only the first 32 floating-point registers.
15201 @item -mfpr-64
15202 @opindex mfpr-64
15204 Use all 64 floating-point registers.
15206 @item -mhard-float
15207 @opindex mhard-float
15209 Use hardware instructions for floating-point operations.
15211 @item -msoft-float
15212 @opindex msoft-float
15214 Use library routines for floating-point operations.
15216 @item -malloc-cc
15217 @opindex malloc-cc
15219 Dynamically allocate condition code registers.
15221 @item -mfixed-cc
15222 @opindex mfixed-cc
15224 Do not try to dynamically allocate condition code registers, only
15225 use @code{icc0} and @code{fcc0}.
15227 @item -mdword
15228 @opindex mdword
15230 Change ABI to use double word insns.
15232 @item -mno-dword
15233 @opindex mno-dword
15235 Do not use double word instructions.
15237 @item -mdouble
15238 @opindex mdouble
15240 Use floating-point double instructions.
15242 @item -mno-double
15243 @opindex mno-double
15245 Do not use floating-point double instructions.
15247 @item -mmedia
15248 @opindex mmedia
15250 Use media instructions.
15252 @item -mno-media
15253 @opindex mno-media
15255 Do not use media instructions.
15257 @item -mmuladd
15258 @opindex mmuladd
15260 Use multiply and add/subtract instructions.
15262 @item -mno-muladd
15263 @opindex mno-muladd
15265 Do not use multiply and add/subtract instructions.
15267 @item -mfdpic
15268 @opindex mfdpic
15270 Select the FDPIC ABI, which uses function descriptors to represent
15271 pointers to functions.  Without any PIC/PIE-related options, it
15272 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
15273 assumes GOT entries and small data are within a 12-bit range from the
15274 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
15275 are computed with 32 bits.
15276 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15278 @item -minline-plt
15279 @opindex minline-plt
15281 Enable inlining of PLT entries in function calls to functions that are
15282 not known to bind locally.  It has no effect without @option{-mfdpic}.
15283 It's enabled by default if optimizing for speed and compiling for
15284 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
15285 optimization option such as @option{-O3} or above is present in the
15286 command line.
15288 @item -mTLS
15289 @opindex mTLS
15291 Assume a large TLS segment when generating thread-local code.
15293 @item -mtls
15294 @opindex mtls
15296 Do not assume a large TLS segment when generating thread-local code.
15298 @item -mgprel-ro
15299 @opindex mgprel-ro
15301 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
15302 that is known to be in read-only sections.  It's enabled by default,
15303 except for @option{-fpic} or @option{-fpie}: even though it may help
15304 make the global offset table smaller, it trades 1 instruction for 4.
15305 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
15306 one of which may be shared by multiple symbols, and it avoids the need
15307 for a GOT entry for the referenced symbol, so it's more likely to be a
15308 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
15310 @item -multilib-library-pic
15311 @opindex multilib-library-pic
15313 Link with the (library, not FD) pic libraries.  It's implied by
15314 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
15315 @option{-fpic} without @option{-mfdpic}.  You should never have to use
15316 it explicitly.
15318 @item -mlinked-fp
15319 @opindex mlinked-fp
15321 Follow the EABI requirement of always creating a frame pointer whenever
15322 a stack frame is allocated.  This option is enabled by default and can
15323 be disabled with @option{-mno-linked-fp}.
15325 @item -mlong-calls
15326 @opindex mlong-calls
15328 Use indirect addressing to call functions outside the current
15329 compilation unit.  This allows the functions to be placed anywhere
15330 within the 32-bit address space.
15332 @item -malign-labels
15333 @opindex malign-labels
15335 Try to align labels to an 8-byte boundary by inserting NOPs into the
15336 previous packet.  This option only has an effect when VLIW packing
15337 is enabled.  It doesn't create new packets; it merely adds NOPs to
15338 existing ones.
15340 @item -mlibrary-pic
15341 @opindex mlibrary-pic
15343 Generate position-independent EABI code.
15345 @item -macc-4
15346 @opindex macc-4
15348 Use only the first four media accumulator registers.
15350 @item -macc-8
15351 @opindex macc-8
15353 Use all eight media accumulator registers.
15355 @item -mpack
15356 @opindex mpack
15358 Pack VLIW instructions.
15360 @item -mno-pack
15361 @opindex mno-pack
15363 Do not pack VLIW instructions.
15365 @item -mno-eflags
15366 @opindex mno-eflags
15368 Do not mark ABI switches in e_flags.
15370 @item -mcond-move
15371 @opindex mcond-move
15373 Enable the use of conditional-move instructions (default).
15375 This switch is mainly for debugging the compiler and will likely be removed
15376 in a future version.
15378 @item -mno-cond-move
15379 @opindex mno-cond-move
15381 Disable the use of conditional-move instructions.
15383 This switch is mainly for debugging the compiler and will likely be removed
15384 in a future version.
15386 @item -mscc
15387 @opindex mscc
15389 Enable the use of conditional set instructions (default).
15391 This switch is mainly for debugging the compiler and will likely be removed
15392 in a future version.
15394 @item -mno-scc
15395 @opindex mno-scc
15397 Disable the use of conditional set instructions.
15399 This switch is mainly for debugging the compiler and will likely be removed
15400 in a future version.
15402 @item -mcond-exec
15403 @opindex mcond-exec
15405 Enable the use of conditional execution (default).
15407 This switch is mainly for debugging the compiler and will likely be removed
15408 in a future version.
15410 @item -mno-cond-exec
15411 @opindex mno-cond-exec
15413 Disable the use of conditional execution.
15415 This switch is mainly for debugging the compiler and will likely be removed
15416 in a future version.
15418 @item -mvliw-branch
15419 @opindex mvliw-branch
15421 Run a pass to pack branches into VLIW instructions (default).
15423 This switch is mainly for debugging the compiler and will likely be removed
15424 in a future version.
15426 @item -mno-vliw-branch
15427 @opindex mno-vliw-branch
15429 Do not run a pass to pack branches into VLIW instructions.
15431 This switch is mainly for debugging the compiler and will likely be removed
15432 in a future version.
15434 @item -mmulti-cond-exec
15435 @opindex mmulti-cond-exec
15437 Enable optimization of @code{&&} and @code{||} in conditional execution
15438 (default).
15440 This switch is mainly for debugging the compiler and will likely be removed
15441 in a future version.
15443 @item -mno-multi-cond-exec
15444 @opindex mno-multi-cond-exec
15446 Disable optimization of @code{&&} and @code{||} in conditional execution.
15448 This switch is mainly for debugging the compiler and will likely be removed
15449 in a future version.
15451 @item -mnested-cond-exec
15452 @opindex mnested-cond-exec
15454 Enable nested conditional execution optimizations (default).
15456 This switch is mainly for debugging the compiler and will likely be removed
15457 in a future version.
15459 @item -mno-nested-cond-exec
15460 @opindex mno-nested-cond-exec
15462 Disable nested conditional execution optimizations.
15464 This switch is mainly for debugging the compiler and will likely be removed
15465 in a future version.
15467 @item -moptimize-membar
15468 @opindex moptimize-membar
15470 This switch removes redundant @code{membar} instructions from the
15471 compiler-generated code.  It is enabled by default.
15473 @item -mno-optimize-membar
15474 @opindex mno-optimize-membar
15476 This switch disables the automatic removal of redundant @code{membar}
15477 instructions from the generated code.
15479 @item -mtomcat-stats
15480 @opindex mtomcat-stats
15482 Cause gas to print out tomcat statistics.
15484 @item -mcpu=@var{cpu}
15485 @opindex mcpu
15487 Select the processor type for which to generate code.  Possible values are
15488 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
15489 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
15491 @end table
15493 @node GNU/Linux Options
15494 @subsection GNU/Linux Options
15496 These @samp{-m} options are defined for GNU/Linux targets:
15498 @table @gcctabopt
15499 @item -mglibc
15500 @opindex mglibc
15501 Use the GNU C library.  This is the default except
15502 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
15503 @samp{*-*-linux-*android*} targets.
15505 @item -muclibc
15506 @opindex muclibc
15507 Use uClibc C library.  This is the default on
15508 @samp{*-*-linux-*uclibc*} targets.
15510 @item -mmusl
15511 @opindex mmusl
15512 Use the musl C library.  This is the default on
15513 @samp{*-*-linux-*musl*} targets.
15515 @item -mbionic
15516 @opindex mbionic
15517 Use Bionic C library.  This is the default on
15518 @samp{*-*-linux-*android*} targets.
15520 @item -mandroid
15521 @opindex mandroid
15522 Compile code compatible with Android platform.  This is the default on
15523 @samp{*-*-linux-*android*} targets.
15525 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15526 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15527 this option makes the GCC driver pass Android-specific options to the linker.
15528 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15529 to be defined.
15531 @item -tno-android-cc
15532 @opindex tno-android-cc
15533 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15534 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15535 @option{-fno-rtti} by default.
15537 @item -tno-android-ld
15538 @opindex tno-android-ld
15539 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15540 linking options to the linker.
15542 @end table
15544 @node H8/300 Options
15545 @subsection H8/300 Options
15547 These @samp{-m} options are defined for the H8/300 implementations:
15549 @table @gcctabopt
15550 @item -mrelax
15551 @opindex mrelax
15552 Shorten some address references at link time, when possible; uses the
15553 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15554 ld, Using ld}, for a fuller description.
15556 @item -mh
15557 @opindex mh
15558 Generate code for the H8/300H@.
15560 @item -ms
15561 @opindex ms
15562 Generate code for the H8S@.
15564 @item -mn
15565 @opindex mn
15566 Generate code for the H8S and H8/300H in the normal mode.  This switch
15567 must be used either with @option{-mh} or @option{-ms}.
15569 @item -ms2600
15570 @opindex ms2600
15571 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15573 @item -mexr
15574 @opindex mexr
15575 Extended registers are stored on stack before execution of function
15576 with monitor attribute. Default option is @option{-mexr}.
15577 This option is valid only for H8S targets.
15579 @item -mno-exr
15580 @opindex mno-exr
15581 Extended registers are not stored on stack before execution of function 
15582 with monitor attribute. Default option is @option{-mno-exr}. 
15583 This option is valid only for H8S targets.
15585 @item -mint32
15586 @opindex mint32
15587 Make @code{int} data 32 bits by default.
15589 @item -malign-300
15590 @opindex malign-300
15591 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15592 The default for the H8/300H and H8S is to align longs and floats on
15593 4-byte boundaries.
15594 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15595 This option has no effect on the H8/300.
15596 @end table
15598 @node HPPA Options
15599 @subsection HPPA Options
15600 @cindex HPPA Options
15602 These @samp{-m} options are defined for the HPPA family of computers:
15604 @table @gcctabopt
15605 @item -march=@var{architecture-type}
15606 @opindex march
15607 Generate code for the specified architecture.  The choices for
15608 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15609 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15610 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15611 architecture option for your machine.  Code compiled for lower numbered
15612 architectures runs on higher numbered architectures, but not the
15613 other way around.
15615 @item -mpa-risc-1-0
15616 @itemx -mpa-risc-1-1
15617 @itemx -mpa-risc-2-0
15618 @opindex mpa-risc-1-0
15619 @opindex mpa-risc-1-1
15620 @opindex mpa-risc-2-0
15621 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15623 @item -mjump-in-delay
15624 @opindex mjump-in-delay
15625 This option is ignored and provided for compatibility purposes only.
15627 @item -mdisable-fpregs
15628 @opindex mdisable-fpregs
15629 Prevent floating-point registers from being used in any manner.  This is
15630 necessary for compiling kernels that perform lazy context switching of
15631 floating-point registers.  If you use this option and attempt to perform
15632 floating-point operations, the compiler aborts.
15634 @item -mdisable-indexing
15635 @opindex mdisable-indexing
15636 Prevent the compiler from using indexing address modes.  This avoids some
15637 rather obscure problems when compiling MIG generated code under MACH@.
15639 @item -mno-space-regs
15640 @opindex mno-space-regs
15641 Generate code that assumes the target has no space registers.  This allows
15642 GCC to generate faster indirect calls and use unscaled index address modes.
15644 Such code is suitable for level 0 PA systems and kernels.
15646 @item -mfast-indirect-calls
15647 @opindex mfast-indirect-calls
15648 Generate code that assumes calls never cross space boundaries.  This
15649 allows GCC to emit code that performs faster indirect calls.
15651 This option does not work in the presence of shared libraries or nested
15652 functions.
15654 @item -mfixed-range=@var{register-range}
15655 @opindex mfixed-range
15656 Generate code treating the given register range as fixed registers.
15657 A fixed register is one that the register allocator cannot use.  This is
15658 useful when compiling kernel code.  A register range is specified as
15659 two registers separated by a dash.  Multiple register ranges can be
15660 specified separated by a comma.
15662 @item -mlong-load-store
15663 @opindex mlong-load-store
15664 Generate 3-instruction load and store sequences as sometimes required by
15665 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15666 the HP compilers.
15668 @item -mportable-runtime
15669 @opindex mportable-runtime
15670 Use the portable calling conventions proposed by HP for ELF systems.
15672 @item -mgas
15673 @opindex mgas
15674 Enable the use of assembler directives only GAS understands.
15676 @item -mschedule=@var{cpu-type}
15677 @opindex mschedule
15678 Schedule code according to the constraints for the machine type
15679 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15680 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15681 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15682 proper scheduling option for your machine.  The default scheduling is
15683 @samp{8000}.
15685 @item -mlinker-opt
15686 @opindex mlinker-opt
15687 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15688 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15689 linkers in which they give bogus error messages when linking some programs.
15691 @item -msoft-float
15692 @opindex msoft-float
15693 Generate output containing library calls for floating point.
15694 @strong{Warning:} the requisite libraries are not available for all HPPA
15695 targets.  Normally the facilities of the machine's usual C compiler are
15696 used, but this cannot be done directly in cross-compilation.  You must make
15697 your own arrangements to provide suitable library functions for
15698 cross-compilation.
15700 @option{-msoft-float} changes the calling convention in the output file;
15701 therefore, it is only useful if you compile @emph{all} of a program with
15702 this option.  In particular, you need to compile @file{libgcc.a}, the
15703 library that comes with GCC, with @option{-msoft-float} in order for
15704 this to work.
15706 @item -msio
15707 @opindex msio
15708 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15709 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15710 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15711 options are available under HP-UX and HI-UX@.
15713 @item -mgnu-ld
15714 @opindex mgnu-ld
15715 Use options specific to GNU @command{ld}.
15716 This passes @option{-shared} to @command{ld} when
15717 building a shared library.  It is the default when GCC is configured,
15718 explicitly or implicitly, with the GNU linker.  This option does not
15719 affect which @command{ld} is called; it only changes what parameters
15720 are passed to that @command{ld}.
15721 The @command{ld} that is called is determined by the
15722 @option{--with-ld} configure option, GCC's program search path, and
15723 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15724 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15725 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15727 @item -mhp-ld
15728 @opindex mhp-ld
15729 Use options specific to HP @command{ld}.
15730 This passes @option{-b} to @command{ld} when building
15731 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15732 links.  It is the default when GCC is configured, explicitly or
15733 implicitly, with the HP linker.  This option does not affect
15734 which @command{ld} is called; it only changes what parameters are passed to that
15735 @command{ld}.
15736 The @command{ld} that is called is determined by the @option{--with-ld}
15737 configure option, GCC's program search path, and finally by the user's
15738 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15739 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15740 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15742 @item -mlong-calls
15743 @opindex mno-long-calls
15744 Generate code that uses long call sequences.  This ensures that a call
15745 is always able to reach linker generated stubs.  The default is to generate
15746 long calls only when the distance from the call site to the beginning
15747 of the function or translation unit, as the case may be, exceeds a
15748 predefined limit set by the branch type being used.  The limits for
15749 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15750 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15751 240,000 bytes.
15753 Distances are measured from the beginning of functions when using the
15754 @option{-ffunction-sections} option, or when using the @option{-mgas}
15755 and @option{-mno-portable-runtime} options together under HP-UX with
15756 the SOM linker.
15758 It is normally not desirable to use this option as it degrades
15759 performance.  However, it may be useful in large applications,
15760 particularly when partial linking is used to build the application.
15762 The types of long calls used depends on the capabilities of the
15763 assembler and linker, and the type of code being generated.  The
15764 impact on systems that support long absolute calls, and long pic
15765 symbol-difference or pc-relative calls should be relatively small.
15766 However, an indirect call is used on 32-bit ELF systems in pic code
15767 and it is quite long.
15769 @item -munix=@var{unix-std}
15770 @opindex march
15771 Generate compiler predefines and select a startfile for the specified
15772 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15773 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15774 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15775 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15776 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15777 and later.
15779 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15780 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15781 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15782 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15783 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15784 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15786 It is @emph{important} to note that this option changes the interfaces
15787 for various library routines.  It also affects the operational behavior
15788 of the C library.  Thus, @emph{extreme} care is needed in using this
15789 option.
15791 Library code that is intended to operate with more than one UNIX
15792 standard must test, set and restore the variable @code{__xpg4_extended_mask}
15793 as appropriate.  Most GNU software doesn't provide this capability.
15795 @item -nolibdld
15796 @opindex nolibdld
15797 Suppress the generation of link options to search libdld.sl when the
15798 @option{-static} option is specified on HP-UX 10 and later.
15800 @item -static
15801 @opindex static
15802 The HP-UX implementation of setlocale in libc has a dependency on
15803 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15804 when the @option{-static} option is specified, special link options
15805 are needed to resolve this dependency.
15807 On HP-UX 10 and later, the GCC driver adds the necessary options to
15808 link with libdld.sl when the @option{-static} option is specified.
15809 This causes the resulting binary to be dynamic.  On the 64-bit port,
15810 the linkers generate dynamic binaries by default in any case.  The
15811 @option{-nolibdld} option can be used to prevent the GCC driver from
15812 adding these link options.
15814 @item -threads
15815 @opindex threads
15816 Add support for multithreading with the @dfn{dce thread} library
15817 under HP-UX@.  This option sets flags for both the preprocessor and
15818 linker.
15819 @end table
15821 @node IA-64 Options
15822 @subsection IA-64 Options
15823 @cindex IA-64 Options
15825 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15827 @table @gcctabopt
15828 @item -mbig-endian
15829 @opindex mbig-endian
15830 Generate code for a big-endian target.  This is the default for HP-UX@.
15832 @item -mlittle-endian
15833 @opindex mlittle-endian
15834 Generate code for a little-endian target.  This is the default for AIX5
15835 and GNU/Linux.
15837 @item -mgnu-as
15838 @itemx -mno-gnu-as
15839 @opindex mgnu-as
15840 @opindex mno-gnu-as
15841 Generate (or don't) code for the GNU assembler.  This is the default.
15842 @c Also, this is the default if the configure option @option{--with-gnu-as}
15843 @c is used.
15845 @item -mgnu-ld
15846 @itemx -mno-gnu-ld
15847 @opindex mgnu-ld
15848 @opindex mno-gnu-ld
15849 Generate (or don't) code for the GNU linker.  This is the default.
15850 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15851 @c is used.
15853 @item -mno-pic
15854 @opindex mno-pic
15855 Generate code that does not use a global pointer register.  The result
15856 is not position independent code, and violates the IA-64 ABI@.
15858 @item -mvolatile-asm-stop
15859 @itemx -mno-volatile-asm-stop
15860 @opindex mvolatile-asm-stop
15861 @opindex mno-volatile-asm-stop
15862 Generate (or don't) a stop bit immediately before and after volatile asm
15863 statements.
15865 @item -mregister-names
15866 @itemx -mno-register-names
15867 @opindex mregister-names
15868 @opindex mno-register-names
15869 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15870 the stacked registers.  This may make assembler output more readable.
15872 @item -mno-sdata
15873 @itemx -msdata
15874 @opindex mno-sdata
15875 @opindex msdata
15876 Disable (or enable) optimizations that use the small data section.  This may
15877 be useful for working around optimizer bugs.
15879 @item -mconstant-gp
15880 @opindex mconstant-gp
15881 Generate code that uses a single constant global pointer value.  This is
15882 useful when compiling kernel code.
15884 @item -mauto-pic
15885 @opindex mauto-pic
15886 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15887 This is useful when compiling firmware code.
15889 @item -minline-float-divide-min-latency
15890 @opindex minline-float-divide-min-latency
15891 Generate code for inline divides of floating-point values
15892 using the minimum latency algorithm.
15894 @item -minline-float-divide-max-throughput
15895 @opindex minline-float-divide-max-throughput
15896 Generate code for inline divides of floating-point values
15897 using the maximum throughput algorithm.
15899 @item -mno-inline-float-divide
15900 @opindex mno-inline-float-divide
15901 Do not generate inline code for divides of floating-point values.
15903 @item -minline-int-divide-min-latency
15904 @opindex minline-int-divide-min-latency
15905 Generate code for inline divides of integer values
15906 using the minimum latency algorithm.
15908 @item -minline-int-divide-max-throughput
15909 @opindex minline-int-divide-max-throughput
15910 Generate code for inline divides of integer values
15911 using the maximum throughput algorithm.
15913 @item -mno-inline-int-divide
15914 @opindex mno-inline-int-divide
15915 Do not generate inline code for divides of integer values.
15917 @item -minline-sqrt-min-latency
15918 @opindex minline-sqrt-min-latency
15919 Generate code for inline square roots
15920 using the minimum latency algorithm.
15922 @item -minline-sqrt-max-throughput
15923 @opindex minline-sqrt-max-throughput
15924 Generate code for inline square roots
15925 using the maximum throughput algorithm.
15927 @item -mno-inline-sqrt
15928 @opindex mno-inline-sqrt
15929 Do not generate inline code for @code{sqrt}.
15931 @item -mfused-madd
15932 @itemx -mno-fused-madd
15933 @opindex mfused-madd
15934 @opindex mno-fused-madd
15935 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
15936 instructions.  The default is to use these instructions.
15938 @item -mno-dwarf2-asm
15939 @itemx -mdwarf2-asm
15940 @opindex mno-dwarf2-asm
15941 @opindex mdwarf2-asm
15942 Don't (or do) generate assembler code for the DWARF 2 line number debugging
15943 info.  This may be useful when not using the GNU assembler.
15945 @item -mearly-stop-bits
15946 @itemx -mno-early-stop-bits
15947 @opindex mearly-stop-bits
15948 @opindex mno-early-stop-bits
15949 Allow stop bits to be placed earlier than immediately preceding the
15950 instruction that triggered the stop bit.  This can improve instruction
15951 scheduling, but does not always do so.
15953 @item -mfixed-range=@var{register-range}
15954 @opindex mfixed-range
15955 Generate code treating the given register range as fixed registers.
15956 A fixed register is one that the register allocator cannot use.  This is
15957 useful when compiling kernel code.  A register range is specified as
15958 two registers separated by a dash.  Multiple register ranges can be
15959 specified separated by a comma.
15961 @item -mtls-size=@var{tls-size}
15962 @opindex mtls-size
15963 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
15966 @item -mtune=@var{cpu-type}
15967 @opindex mtune
15968 Tune the instruction scheduling for a particular CPU, Valid values are
15969 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15970 and @samp{mckinley}.
15972 @item -milp32
15973 @itemx -mlp64
15974 @opindex milp32
15975 @opindex mlp64
15976 Generate code for a 32-bit or 64-bit environment.
15977 The 32-bit environment sets int, long and pointer to 32 bits.
15978 The 64-bit environment sets int to 32 bits and long and pointer
15979 to 64 bits.  These are HP-UX specific flags.
15981 @item -mno-sched-br-data-spec
15982 @itemx -msched-br-data-spec
15983 @opindex mno-sched-br-data-spec
15984 @opindex msched-br-data-spec
15985 (Dis/En)able data speculative scheduling before reload.
15986 This results in generation of @code{ld.a} instructions and
15987 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15988 The default is 'disable'.
15990 @item -msched-ar-data-spec
15991 @itemx -mno-sched-ar-data-spec
15992 @opindex msched-ar-data-spec
15993 @opindex mno-sched-ar-data-spec
15994 (En/Dis)able data speculative scheduling after reload.
15995 This results in generation of @code{ld.a} instructions and
15996 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15997 The default is 'enable'.
15999 @item -mno-sched-control-spec
16000 @itemx -msched-control-spec
16001 @opindex mno-sched-control-spec
16002 @opindex msched-control-spec
16003 (Dis/En)able control speculative scheduling.  This feature is
16004 available only during region scheduling (i.e.@: before reload).
16005 This results in generation of the @code{ld.s} instructions and
16006 the corresponding check instructions @code{chk.s}.
16007 The default is 'disable'.
16009 @item -msched-br-in-data-spec
16010 @itemx -mno-sched-br-in-data-spec
16011 @opindex msched-br-in-data-spec
16012 @opindex mno-sched-br-in-data-spec
16013 (En/Dis)able speculative scheduling of the instructions that
16014 are dependent on the data speculative loads before reload.
16015 This is effective only with @option{-msched-br-data-spec} enabled.
16016 The default is 'enable'.
16018 @item -msched-ar-in-data-spec
16019 @itemx -mno-sched-ar-in-data-spec
16020 @opindex msched-ar-in-data-spec
16021 @opindex mno-sched-ar-in-data-spec
16022 (En/Dis)able speculative scheduling of the instructions that
16023 are dependent on the data speculative loads after reload.
16024 This is effective only with @option{-msched-ar-data-spec} enabled.
16025 The default is 'enable'.
16027 @item -msched-in-control-spec
16028 @itemx -mno-sched-in-control-spec
16029 @opindex msched-in-control-spec
16030 @opindex mno-sched-in-control-spec
16031 (En/Dis)able speculative scheduling of the instructions that
16032 are dependent on the control speculative loads.
16033 This is effective only with @option{-msched-control-spec} enabled.
16034 The default is 'enable'.
16036 @item -mno-sched-prefer-non-data-spec-insns
16037 @itemx -msched-prefer-non-data-spec-insns
16038 @opindex mno-sched-prefer-non-data-spec-insns
16039 @opindex msched-prefer-non-data-spec-insns
16040 If enabled, data-speculative instructions are chosen for schedule
16041 only if there are no other choices at the moment.  This makes
16042 the use of the data speculation much more conservative.
16043 The default is 'disable'.
16045 @item -mno-sched-prefer-non-control-spec-insns
16046 @itemx -msched-prefer-non-control-spec-insns
16047 @opindex mno-sched-prefer-non-control-spec-insns
16048 @opindex msched-prefer-non-control-spec-insns
16049 If enabled, control-speculative instructions are chosen for schedule
16050 only if there are no other choices at the moment.  This makes
16051 the use of the control speculation much more conservative.
16052 The default is 'disable'.
16054 @item -mno-sched-count-spec-in-critical-path
16055 @itemx -msched-count-spec-in-critical-path
16056 @opindex mno-sched-count-spec-in-critical-path
16057 @opindex msched-count-spec-in-critical-path
16058 If enabled, speculative dependencies are considered during
16059 computation of the instructions priorities.  This makes the use of the
16060 speculation a bit more conservative.
16061 The default is 'disable'.
16063 @item -msched-spec-ldc
16064 @opindex msched-spec-ldc
16065 Use a simple data speculation check.  This option is on by default.
16067 @item -msched-control-spec-ldc
16068 @opindex msched-spec-ldc
16069 Use a simple check for control speculation.  This option is on by default.
16071 @item -msched-stop-bits-after-every-cycle
16072 @opindex msched-stop-bits-after-every-cycle
16073 Place a stop bit after every cycle when scheduling.  This option is on
16074 by default.
16076 @item -msched-fp-mem-deps-zero-cost
16077 @opindex msched-fp-mem-deps-zero-cost
16078 Assume that floating-point stores and loads are not likely to cause a conflict
16079 when placed into the same instruction group.  This option is disabled by
16080 default.
16082 @item -msel-sched-dont-check-control-spec
16083 @opindex msel-sched-dont-check-control-spec
16084 Generate checks for control speculation in selective scheduling.
16085 This flag is disabled by default.
16087 @item -msched-max-memory-insns=@var{max-insns}
16088 @opindex msched-max-memory-insns
16089 Limit on the number of memory insns per instruction group, giving lower
16090 priority to subsequent memory insns attempting to schedule in the same
16091 instruction group. Frequently useful to prevent cache bank conflicts.
16092 The default value is 1.
16094 @item -msched-max-memory-insns-hard-limit
16095 @opindex msched-max-memory-insns-hard-limit
16096 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16097 disallowing more than that number in an instruction group.
16098 Otherwise, the limit is ``soft'', meaning that non-memory operations
16099 are preferred when the limit is reached, but memory operations may still
16100 be scheduled.
16102 @end table
16104 @node LM32 Options
16105 @subsection LM32 Options
16106 @cindex LM32 options
16108 These @option{-m} options are defined for the LatticeMico32 architecture:
16110 @table @gcctabopt
16111 @item -mbarrel-shift-enabled
16112 @opindex mbarrel-shift-enabled
16113 Enable barrel-shift instructions.
16115 @item -mdivide-enabled
16116 @opindex mdivide-enabled
16117 Enable divide and modulus instructions.
16119 @item -mmultiply-enabled
16120 @opindex multiply-enabled
16121 Enable multiply instructions.
16123 @item -msign-extend-enabled
16124 @opindex msign-extend-enabled
16125 Enable sign extend instructions.
16127 @item -muser-enabled
16128 @opindex muser-enabled
16129 Enable user-defined instructions.
16131 @end table
16133 @node M32C Options
16134 @subsection M32C Options
16135 @cindex M32C options
16137 @table @gcctabopt
16138 @item -mcpu=@var{name}
16139 @opindex mcpu=
16140 Select the CPU for which code is generated.  @var{name} may be one of
16141 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16142 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16143 the M32C/80 series.
16145 @item -msim
16146 @opindex msim
16147 Specifies that the program will be run on the simulator.  This causes
16148 an alternate runtime library to be linked in which supports, for
16149 example, file I/O@.  You must not use this option when generating
16150 programs that will run on real hardware; you must provide your own
16151 runtime library for whatever I/O functions are needed.
16153 @item -memregs=@var{number}
16154 @opindex memregs=
16155 Specifies the number of memory-based pseudo-registers GCC uses
16156 during code generation.  These pseudo-registers are used like real
16157 registers, so there is a tradeoff between GCC's ability to fit the
16158 code into available registers, and the performance penalty of using
16159 memory instead of registers.  Note that all modules in a program must
16160 be compiled with the same value for this option.  Because of that, you
16161 must not use this option with GCC's default runtime libraries.
16163 @end table
16165 @node M32R/D Options
16166 @subsection M32R/D Options
16167 @cindex M32R/D options
16169 These @option{-m} options are defined for Renesas M32R/D architectures:
16171 @table @gcctabopt
16172 @item -m32r2
16173 @opindex m32r2
16174 Generate code for the M32R/2@.
16176 @item -m32rx
16177 @opindex m32rx
16178 Generate code for the M32R/X@.
16180 @item -m32r
16181 @opindex m32r
16182 Generate code for the M32R@.  This is the default.
16184 @item -mmodel=small
16185 @opindex mmodel=small
16186 Assume all objects live in the lower 16MB of memory (so that their addresses
16187 can be loaded with the @code{ld24} instruction), and assume all subroutines
16188 are reachable with the @code{bl} instruction.
16189 This is the default.
16191 The addressability of a particular object can be set with the
16192 @code{model} attribute.
16194 @item -mmodel=medium
16195 @opindex mmodel=medium
16196 Assume objects may be anywhere in the 32-bit address space (the compiler
16197 generates @code{seth/add3} instructions to load their addresses), and
16198 assume all subroutines are reachable with the @code{bl} instruction.
16200 @item -mmodel=large
16201 @opindex mmodel=large
16202 Assume objects may be anywhere in the 32-bit address space (the compiler
16203 generates @code{seth/add3} instructions to load their addresses), and
16204 assume subroutines may not be reachable with the @code{bl} instruction
16205 (the compiler generates the much slower @code{seth/add3/jl}
16206 instruction sequence).
16208 @item -msdata=none
16209 @opindex msdata=none
16210 Disable use of the small data area.  Variables are put into
16211 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16212 @code{section} attribute has been specified).
16213 This is the default.
16215 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16216 Objects may be explicitly put in the small data area with the
16217 @code{section} attribute using one of these sections.
16219 @item -msdata=sdata
16220 @opindex msdata=sdata
16221 Put small global and static data in the small data area, but do not
16222 generate special code to reference them.
16224 @item -msdata=use
16225 @opindex msdata=use
16226 Put small global and static data in the small data area, and generate
16227 special instructions to reference them.
16229 @item -G @var{num}
16230 @opindex G
16231 @cindex smaller data references
16232 Put global and static objects less than or equal to @var{num} bytes
16233 into the small data or BSS sections instead of the normal data or BSS
16234 sections.  The default value of @var{num} is 8.
16235 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16236 for this option to have any effect.
16238 All modules should be compiled with the same @option{-G @var{num}} value.
16239 Compiling with different values of @var{num} may or may not work; if it
16240 doesn't the linker gives an error message---incorrect code is not
16241 generated.
16243 @item -mdebug
16244 @opindex mdebug
16245 Makes the M32R-specific code in the compiler display some statistics
16246 that might help in debugging programs.
16248 @item -malign-loops
16249 @opindex malign-loops
16250 Align all loops to a 32-byte boundary.
16252 @item -mno-align-loops
16253 @opindex mno-align-loops
16254 Do not enforce a 32-byte alignment for loops.  This is the default.
16256 @item -missue-rate=@var{number}
16257 @opindex missue-rate=@var{number}
16258 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16259 or 2.
16261 @item -mbranch-cost=@var{number}
16262 @opindex mbranch-cost=@var{number}
16263 @var{number} can only be 1 or 2.  If it is 1 then branches are
16264 preferred over conditional code, if it is 2, then the opposite applies.
16266 @item -mflush-trap=@var{number}
16267 @opindex mflush-trap=@var{number}
16268 Specifies the trap number to use to flush the cache.  The default is
16269 12.  Valid numbers are between 0 and 15 inclusive.
16271 @item -mno-flush-trap
16272 @opindex mno-flush-trap
16273 Specifies that the cache cannot be flushed by using a trap.
16275 @item -mflush-func=@var{name}
16276 @opindex mflush-func=@var{name}
16277 Specifies the name of the operating system function to call to flush
16278 the cache.  The default is @samp{_flush_cache}, but a function call
16279 is only used if a trap is not available.
16281 @item -mno-flush-func
16282 @opindex mno-flush-func
16283 Indicates that there is no OS function for flushing the cache.
16285 @end table
16287 @node M680x0 Options
16288 @subsection M680x0 Options
16289 @cindex M680x0 options
16291 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16292 The default settings depend on which architecture was selected when
16293 the compiler was configured; the defaults for the most common choices
16294 are given below.
16296 @table @gcctabopt
16297 @item -march=@var{arch}
16298 @opindex march
16299 Generate code for a specific M680x0 or ColdFire instruction set
16300 architecture.  Permissible values of @var{arch} for M680x0
16301 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16302 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16303 architectures are selected according to Freescale's ISA classification
16304 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16305 @samp{isab} and @samp{isac}.
16307 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
16308 code for a ColdFire target.  The @var{arch} in this macro is one of the
16309 @option{-march} arguments given above.
16311 When used together, @option{-march} and @option{-mtune} select code
16312 that runs on a family of similar processors but that is optimized
16313 for a particular microarchitecture.
16315 @item -mcpu=@var{cpu}
16316 @opindex mcpu
16317 Generate code for a specific M680x0 or ColdFire processor.
16318 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16319 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16320 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16321 below, which also classifies the CPUs into families:
16323 @multitable @columnfractions 0.20 0.80
16324 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16325 @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}
16326 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16327 @item @samp{5206e} @tab @samp{5206e}
16328 @item @samp{5208} @tab @samp{5207} @samp{5208}
16329 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16330 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16331 @item @samp{5216} @tab @samp{5214} @samp{5216}
16332 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16333 @item @samp{5225} @tab @samp{5224} @samp{5225}
16334 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16335 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16336 @item @samp{5249} @tab @samp{5249}
16337 @item @samp{5250} @tab @samp{5250}
16338 @item @samp{5271} @tab @samp{5270} @samp{5271}
16339 @item @samp{5272} @tab @samp{5272}
16340 @item @samp{5275} @tab @samp{5274} @samp{5275}
16341 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16342 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16343 @item @samp{5307} @tab @samp{5307}
16344 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16345 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16346 @item @samp{5407} @tab @samp{5407}
16347 @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}
16348 @end multitable
16350 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16351 @var{arch} is compatible with @var{cpu}.  Other combinations of
16352 @option{-mcpu} and @option{-march} are rejected.
16354 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
16355 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
16356 where the value of @var{family} is given by the table above.
16358 @item -mtune=@var{tune}
16359 @opindex mtune
16360 Tune the code for a particular microarchitecture within the
16361 constraints set by @option{-march} and @option{-mcpu}.
16362 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16363 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16364 and @samp{cpu32}.  The ColdFire microarchitectures
16365 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16367 You can also use @option{-mtune=68020-40} for code that needs
16368 to run relatively well on 68020, 68030 and 68040 targets.
16369 @option{-mtune=68020-60} is similar but includes 68060 targets
16370 as well.  These two options select the same tuning decisions as
16371 @option{-m68020-40} and @option{-m68020-60} respectively.
16373 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
16374 when tuning for 680x0 architecture @var{arch}.  It also defines
16375 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16376 option is used.  If GCC is tuning for a range of architectures,
16377 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16378 it defines the macros for every architecture in the range.
16380 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
16381 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16382 of the arguments given above.
16384 @item -m68000
16385 @itemx -mc68000
16386 @opindex m68000
16387 @opindex mc68000
16388 Generate output for a 68000.  This is the default
16389 when the compiler is configured for 68000-based systems.
16390 It is equivalent to @option{-march=68000}.
16392 Use this option for microcontrollers with a 68000 or EC000 core,
16393 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16395 @item -m68010
16396 @opindex m68010
16397 Generate output for a 68010.  This is the default
16398 when the compiler is configured for 68010-based systems.
16399 It is equivalent to @option{-march=68010}.
16401 @item -m68020
16402 @itemx -mc68020
16403 @opindex m68020
16404 @opindex mc68020
16405 Generate output for a 68020.  This is the default
16406 when the compiler is configured for 68020-based systems.
16407 It is equivalent to @option{-march=68020}.
16409 @item -m68030
16410 @opindex m68030
16411 Generate output for a 68030.  This is the default when the compiler is
16412 configured for 68030-based systems.  It is equivalent to
16413 @option{-march=68030}.
16415 @item -m68040
16416 @opindex m68040
16417 Generate output for a 68040.  This is the default when the compiler is
16418 configured for 68040-based systems.  It is equivalent to
16419 @option{-march=68040}.
16421 This option inhibits the use of 68881/68882 instructions that have to be
16422 emulated by software on the 68040.  Use this option if your 68040 does not
16423 have code to emulate those instructions.
16425 @item -m68060
16426 @opindex m68060
16427 Generate output for a 68060.  This is the default when the compiler is
16428 configured for 68060-based systems.  It is equivalent to
16429 @option{-march=68060}.
16431 This option inhibits the use of 68020 and 68881/68882 instructions that
16432 have to be emulated by software on the 68060.  Use this option if your 68060
16433 does not have code to emulate those instructions.
16435 @item -mcpu32
16436 @opindex mcpu32
16437 Generate output for a CPU32.  This is the default
16438 when the compiler is configured for CPU32-based systems.
16439 It is equivalent to @option{-march=cpu32}.
16441 Use this option for microcontrollers with a
16442 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16443 68336, 68340, 68341, 68349 and 68360.
16445 @item -m5200
16446 @opindex m5200
16447 Generate output for a 520X ColdFire CPU@.  This is the default
16448 when the compiler is configured for 520X-based systems.
16449 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16450 in favor of that option.
16452 Use this option for microcontroller with a 5200 core, including
16453 the MCF5202, MCF5203, MCF5204 and MCF5206.
16455 @item -m5206e
16456 @opindex m5206e
16457 Generate output for a 5206e ColdFire CPU@.  The option is now
16458 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16460 @item -m528x
16461 @opindex m528x
16462 Generate output for a member of the ColdFire 528X family.
16463 The option is now deprecated in favor of the equivalent
16464 @option{-mcpu=528x}.
16466 @item -m5307
16467 @opindex m5307
16468 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16469 in favor of the equivalent @option{-mcpu=5307}.
16471 @item -m5407
16472 @opindex m5407
16473 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16474 in favor of the equivalent @option{-mcpu=5407}.
16476 @item -mcfv4e
16477 @opindex mcfv4e
16478 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16479 This includes use of hardware floating-point instructions.
16480 The option is equivalent to @option{-mcpu=547x}, and is now
16481 deprecated in favor of that option.
16483 @item -m68020-40
16484 @opindex m68020-40
16485 Generate output for a 68040, without using any of the new instructions.
16486 This results in code that can run relatively efficiently on either a
16487 68020/68881 or a 68030 or a 68040.  The generated code does use the
16488 68881 instructions that are emulated on the 68040.
16490 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16492 @item -m68020-60
16493 @opindex m68020-60
16494 Generate output for a 68060, without using any of the new instructions.
16495 This results in code that can run relatively efficiently on either a
16496 68020/68881 or a 68030 or a 68040.  The generated code does use the
16497 68881 instructions that are emulated on the 68060.
16499 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16501 @item -mhard-float
16502 @itemx -m68881
16503 @opindex mhard-float
16504 @opindex m68881
16505 Generate floating-point instructions.  This is the default for 68020
16506 and above, and for ColdFire devices that have an FPU@.  It defines the
16507 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
16508 on ColdFire targets.
16510 @item -msoft-float
16511 @opindex msoft-float
16512 Do not generate floating-point instructions; use library calls instead.
16513 This is the default for 68000, 68010, and 68832 targets.  It is also
16514 the default for ColdFire devices that have no FPU.
16516 @item -mdiv
16517 @itemx -mno-div
16518 @opindex mdiv
16519 @opindex mno-div
16520 Generate (do not generate) ColdFire hardware divide and remainder
16521 instructions.  If @option{-march} is used without @option{-mcpu},
16522 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16523 architectures.  Otherwise, the default is taken from the target CPU
16524 (either the default CPU, or the one specified by @option{-mcpu}).  For
16525 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16526 @option{-mcpu=5206e}.
16528 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
16530 @item -mshort
16531 @opindex mshort
16532 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16533 Additionally, parameters passed on the stack are also aligned to a
16534 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16536 @item -mno-short
16537 @opindex mno-short
16538 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16540 @item -mnobitfield
16541 @itemx -mno-bitfield
16542 @opindex mnobitfield
16543 @opindex mno-bitfield
16544 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16545 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16547 @item -mbitfield
16548 @opindex mbitfield
16549 Do use the bit-field instructions.  The @option{-m68020} option implies
16550 @option{-mbitfield}.  This is the default if you use a configuration
16551 designed for a 68020.
16553 @item -mrtd
16554 @opindex mrtd
16555 Use a different function-calling convention, in which functions
16556 that take a fixed number of arguments return with the @code{rtd}
16557 instruction, which pops their arguments while returning.  This
16558 saves one instruction in the caller since there is no need to pop
16559 the arguments there.
16561 This calling convention is incompatible with the one normally
16562 used on Unix, so you cannot use it if you need to call libraries
16563 compiled with the Unix compiler.
16565 Also, you must provide function prototypes for all functions that
16566 take variable numbers of arguments (including @code{printf});
16567 otherwise incorrect code is generated for calls to those
16568 functions.
16570 In addition, seriously incorrect code results if you call a
16571 function with too many arguments.  (Normally, extra arguments are
16572 harmlessly ignored.)
16574 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16575 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16577 @item -mno-rtd
16578 @opindex mno-rtd
16579 Do not use the calling conventions selected by @option{-mrtd}.
16580 This is the default.
16582 @item -malign-int
16583 @itemx -mno-align-int
16584 @opindex malign-int
16585 @opindex mno-align-int
16586 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16587 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16588 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16589 Aligning variables on 32-bit boundaries produces code that runs somewhat
16590 faster on processors with 32-bit busses at the expense of more memory.
16592 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16593 aligns structures containing the above types differently than
16594 most published application binary interface specifications for the m68k.
16596 @item -mpcrel
16597 @opindex mpcrel
16598 Use the pc-relative addressing mode of the 68000 directly, instead of
16599 using a global offset table.  At present, this option implies @option{-fpic},
16600 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16601 not presently supported with @option{-mpcrel}, though this could be supported for
16602 68020 and higher processors.
16604 @item -mno-strict-align
16605 @itemx -mstrict-align
16606 @opindex mno-strict-align
16607 @opindex mstrict-align
16608 Do not (do) assume that unaligned memory references are handled by
16609 the system.
16611 @item -msep-data
16612 Generate code that allows the data segment to be located in a different
16613 area of memory from the text segment.  This allows for execute-in-place in
16614 an environment without virtual memory management.  This option implies
16615 @option{-fPIC}.
16617 @item -mno-sep-data
16618 Generate code that assumes that the data segment follows the text segment.
16619 This is the default.
16621 @item -mid-shared-library
16622 Generate code that supports shared libraries via the library ID method.
16623 This allows for execute-in-place and shared libraries in an environment
16624 without virtual memory management.  This option implies @option{-fPIC}.
16626 @item -mno-id-shared-library
16627 Generate code that doesn't assume ID-based shared libraries are being used.
16628 This is the default.
16630 @item -mshared-library-id=n
16631 Specifies the identification number of the ID-based shared library being
16632 compiled.  Specifying a value of 0 generates more compact code; specifying
16633 other values forces the allocation of that number to the current
16634 library, but is no more space- or time-efficient than omitting this option.
16636 @item -mxgot
16637 @itemx -mno-xgot
16638 @opindex mxgot
16639 @opindex mno-xgot
16640 When generating position-independent code for ColdFire, generate code
16641 that works if the GOT has more than 8192 entries.  This code is
16642 larger and slower than code generated without this option.  On M680x0
16643 processors, this option is not needed; @option{-fPIC} suffices.
16645 GCC normally uses a single instruction to load values from the GOT@.
16646 While this is relatively efficient, it only works if the GOT
16647 is smaller than about 64k.  Anything larger causes the linker
16648 to report an error such as:
16650 @cindex relocation truncated to fit (ColdFire)
16651 @smallexample
16652 relocation truncated to fit: R_68K_GOT16O foobar
16653 @end smallexample
16655 If this happens, you should recompile your code with @option{-mxgot}.
16656 It should then work with very large GOTs.  However, code generated with
16657 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16658 the value of a global symbol.
16660 Note that some linkers, including newer versions of the GNU linker,
16661 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16662 you should only need to use @option{-mxgot} when compiling a single
16663 object file that accesses more than 8192 GOT entries.  Very few do.
16665 These options have no effect unless GCC is generating
16666 position-independent code.
16668 @end table
16670 @node MCore Options
16671 @subsection MCore Options
16672 @cindex MCore options
16674 These are the @samp{-m} options defined for the Motorola M*Core
16675 processors.
16677 @table @gcctabopt
16679 @item -mhardlit
16680 @itemx -mno-hardlit
16681 @opindex mhardlit
16682 @opindex mno-hardlit
16683 Inline constants into the code stream if it can be done in two
16684 instructions or less.
16686 @item -mdiv
16687 @itemx -mno-div
16688 @opindex mdiv
16689 @opindex mno-div
16690 Use the divide instruction.  (Enabled by default).
16692 @item -mrelax-immediate
16693 @itemx -mno-relax-immediate
16694 @opindex mrelax-immediate
16695 @opindex mno-relax-immediate
16696 Allow arbitrary-sized immediates in bit operations.
16698 @item -mwide-bitfields
16699 @itemx -mno-wide-bitfields
16700 @opindex mwide-bitfields
16701 @opindex mno-wide-bitfields
16702 Always treat bit-fields as @code{int}-sized.
16704 @item -m4byte-functions
16705 @itemx -mno-4byte-functions
16706 @opindex m4byte-functions
16707 @opindex mno-4byte-functions
16708 Force all functions to be aligned to a 4-byte boundary.
16710 @item -mcallgraph-data
16711 @itemx -mno-callgraph-data
16712 @opindex mcallgraph-data
16713 @opindex mno-callgraph-data
16714 Emit callgraph information.
16716 @item -mslow-bytes
16717 @itemx -mno-slow-bytes
16718 @opindex mslow-bytes
16719 @opindex mno-slow-bytes
16720 Prefer word access when reading byte quantities.
16722 @item -mlittle-endian
16723 @itemx -mbig-endian
16724 @opindex mlittle-endian
16725 @opindex mbig-endian
16726 Generate code for a little-endian target.
16728 @item -m210
16729 @itemx -m340
16730 @opindex m210
16731 @opindex m340
16732 Generate code for the 210 processor.
16734 @item -mno-lsim
16735 @opindex mno-lsim
16736 Assume that runtime support has been provided and so omit the
16737 simulator library (@file{libsim.a)} from the linker command line.
16739 @item -mstack-increment=@var{size}
16740 @opindex mstack-increment
16741 Set the maximum amount for a single stack increment operation.  Large
16742 values can increase the speed of programs that contain functions
16743 that need a large amount of stack space, but they can also trigger a
16744 segmentation fault if the stack is extended too much.  The default
16745 value is 0x1000.
16747 @end table
16749 @node MeP Options
16750 @subsection MeP Options
16751 @cindex MeP options
16753 @table @gcctabopt
16755 @item -mabsdiff
16756 @opindex mabsdiff
16757 Enables the @code{abs} instruction, which is the absolute difference
16758 between two registers.
16760 @item -mall-opts
16761 @opindex mall-opts
16762 Enables all the optional instructions---average, multiply, divide, bit
16763 operations, leading zero, absolute difference, min/max, clip, and
16764 saturation.
16767 @item -maverage
16768 @opindex maverage
16769 Enables the @code{ave} instruction, which computes the average of two
16770 registers.
16772 @item -mbased=@var{n}
16773 @opindex mbased=
16774 Variables of size @var{n} bytes or smaller are placed in the
16775 @code{.based} section by default.  Based variables use the @code{$tp}
16776 register as a base register, and there is a 128-byte limit to the
16777 @code{.based} section.
16779 @item -mbitops
16780 @opindex mbitops
16781 Enables the bit operation instructions---bit test (@code{btstm}), set
16782 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16783 test-and-set (@code{tas}).
16785 @item -mc=@var{name}
16786 @opindex mc=
16787 Selects which section constant data is placed in.  @var{name} may
16788 be @samp{tiny}, @samp{near}, or @samp{far}.
16790 @item -mclip
16791 @opindex mclip
16792 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
16793 useful unless you also provide @option{-mminmax}.
16795 @item -mconfig=@var{name}
16796 @opindex mconfig=
16797 Selects one of the built-in core configurations.  Each MeP chip has
16798 one or more modules in it; each module has a core CPU and a variety of
16799 coprocessors, optional instructions, and peripherals.  The
16800 @code{MeP-Integrator} tool, not part of GCC, provides these
16801 configurations through this option; using this option is the same as
16802 using all the corresponding command-line options.  The default
16803 configuration is @samp{default}.
16805 @item -mcop
16806 @opindex mcop
16807 Enables the coprocessor instructions.  By default, this is a 32-bit
16808 coprocessor.  Note that the coprocessor is normally enabled via the
16809 @option{-mconfig=} option.
16811 @item -mcop32
16812 @opindex mcop32
16813 Enables the 32-bit coprocessor's instructions.
16815 @item -mcop64
16816 @opindex mcop64
16817 Enables the 64-bit coprocessor's instructions.
16819 @item -mivc2
16820 @opindex mivc2
16821 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16823 @item -mdc
16824 @opindex mdc
16825 Causes constant variables to be placed in the @code{.near} section.
16827 @item -mdiv
16828 @opindex mdiv
16829 Enables the @code{div} and @code{divu} instructions.
16831 @item -meb
16832 @opindex meb
16833 Generate big-endian code.
16835 @item -mel
16836 @opindex mel
16837 Generate little-endian code.
16839 @item -mio-volatile
16840 @opindex mio-volatile
16841 Tells the compiler that any variable marked with the @code{io}
16842 attribute is to be considered volatile.
16844 @item -ml
16845 @opindex ml
16846 Causes variables to be assigned to the @code{.far} section by default.
16848 @item -mleadz
16849 @opindex mleadz
16850 Enables the @code{leadz} (leading zero) instruction.
16852 @item -mm
16853 @opindex mm
16854 Causes variables to be assigned to the @code{.near} section by default.
16856 @item -mminmax
16857 @opindex mminmax
16858 Enables the @code{min} and @code{max} instructions.
16860 @item -mmult
16861 @opindex mmult
16862 Enables the multiplication and multiply-accumulate instructions.
16864 @item -mno-opts
16865 @opindex mno-opts
16866 Disables all the optional instructions enabled by @option{-mall-opts}.
16868 @item -mrepeat
16869 @opindex mrepeat
16870 Enables the @code{repeat} and @code{erepeat} instructions, used for
16871 low-overhead looping.
16873 @item -ms
16874 @opindex ms
16875 Causes all variables to default to the @code{.tiny} section.  Note
16876 that there is a 65536-byte limit to this section.  Accesses to these
16877 variables use the @code{%gp} base register.
16879 @item -msatur
16880 @opindex msatur
16881 Enables the saturation instructions.  Note that the compiler does not
16882 currently generate these itself, but this option is included for
16883 compatibility with other tools, like @code{as}.
16885 @item -msdram
16886 @opindex msdram
16887 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16889 @item -msim
16890 @opindex msim
16891 Link the simulator run-time libraries.
16893 @item -msimnovec
16894 @opindex msimnovec
16895 Link the simulator runtime libraries, excluding built-in support
16896 for reset and exception vectors and tables.
16898 @item -mtf
16899 @opindex mtf
16900 Causes all functions to default to the @code{.far} section.  Without
16901 this option, functions default to the @code{.near} section.
16903 @item -mtiny=@var{n}
16904 @opindex mtiny=
16905 Variables that are @var{n} bytes or smaller are allocated to the
16906 @code{.tiny} section.  These variables use the @code{$gp} base
16907 register.  The default for this option is 4, but note that there's a
16908 65536-byte limit to the @code{.tiny} section.
16910 @end table
16912 @node MicroBlaze Options
16913 @subsection MicroBlaze Options
16914 @cindex MicroBlaze Options
16916 @table @gcctabopt
16918 @item -msoft-float
16919 @opindex msoft-float
16920 Use software emulation for floating point (default).
16922 @item -mhard-float
16923 @opindex mhard-float
16924 Use hardware floating-point instructions.
16926 @item -mmemcpy
16927 @opindex mmemcpy
16928 Do not optimize block moves, use @code{memcpy}.
16930 @item -mno-clearbss
16931 @opindex mno-clearbss
16932 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
16934 @item -mcpu=@var{cpu-type}
16935 @opindex mcpu=
16936 Use features of, and schedule code for, the given CPU.
16937 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
16938 where @var{X} is a major version, @var{YY} is the minor version, and
16939 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
16940 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
16942 @item -mxl-soft-mul
16943 @opindex mxl-soft-mul
16944 Use software multiply emulation (default).
16946 @item -mxl-soft-div
16947 @opindex mxl-soft-div
16948 Use software emulation for divides (default).
16950 @item -mxl-barrel-shift
16951 @opindex mxl-barrel-shift
16952 Use the hardware barrel shifter.
16954 @item -mxl-pattern-compare
16955 @opindex mxl-pattern-compare
16956 Use pattern compare instructions.
16958 @item -msmall-divides
16959 @opindex msmall-divides
16960 Use table lookup optimization for small signed integer divisions.
16962 @item -mxl-stack-check
16963 @opindex mxl-stack-check
16964 This option is deprecated.  Use @option{-fstack-check} instead.
16966 @item -mxl-gp-opt
16967 @opindex mxl-gp-opt
16968 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16970 @item -mxl-multiply-high
16971 @opindex mxl-multiply-high
16972 Use multiply high instructions for high part of 32x32 multiply.
16974 @item -mxl-float-convert
16975 @opindex mxl-float-convert
16976 Use hardware floating-point conversion instructions.
16978 @item -mxl-float-sqrt
16979 @opindex mxl-float-sqrt
16980 Use hardware floating-point square root instruction.
16982 @item -mbig-endian
16983 @opindex mbig-endian
16984 Generate code for a big-endian target.
16986 @item -mlittle-endian
16987 @opindex mlittle-endian
16988 Generate code for a little-endian target.
16990 @item -mxl-reorder
16991 @opindex mxl-reorder
16992 Use reorder instructions (swap and byte reversed load/store).
16994 @item -mxl-mode-@var{app-model}
16995 Select application model @var{app-model}.  Valid models are
16996 @table @samp
16997 @item executable
16998 normal executable (default), uses startup code @file{crt0.o}.
17000 @item xmdstub
17001 for use with Xilinx Microprocessor Debugger (XMD) based
17002 software intrusive debug agent called xmdstub. This uses startup file
17003 @file{crt1.o} and sets the start address of the program to 0x800.
17005 @item bootstrap
17006 for applications that are loaded using a bootloader.
17007 This model uses startup file @file{crt2.o} which does not contain a processor
17008 reset vector handler. This is suitable for transferring control on a
17009 processor reset to the bootloader rather than the application.
17011 @item novectors
17012 for applications that do not require any of the
17013 MicroBlaze vectors. This option may be useful for applications running
17014 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17015 @end table
17017 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17018 @option{-mxl-mode-@var{app-model}}.
17020 @end table
17022 @node MIPS Options
17023 @subsection MIPS Options
17024 @cindex MIPS options
17026 @table @gcctabopt
17028 @item -EB
17029 @opindex EB
17030 Generate big-endian code.
17032 @item -EL
17033 @opindex EL
17034 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17035 configurations.
17037 @item -march=@var{arch}
17038 @opindex march
17039 Generate code that runs on @var{arch}, which can be the name of a
17040 generic MIPS ISA, or the name of a particular processor.
17041 The ISA names are:
17042 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17043 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17044 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17045 @samp{mips64r5} and @samp{mips64r6}.
17046 The processor names are:
17047 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17048 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17049 @samp{5kc}, @samp{5kf},
17050 @samp{20kc},
17051 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17052 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17053 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17054 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17055 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17056 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17057 @samp{m4k},
17058 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17059 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17060 @samp{orion},
17061 @samp{p5600},
17062 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17063 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17064 @samp{rm7000}, @samp{rm9000},
17065 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17066 @samp{sb1},
17067 @samp{sr71000},
17068 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17069 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17070 @samp{xlr} and @samp{xlp}.
17071 The special value @samp{from-abi} selects the
17072 most compatible architecture for the selected ABI (that is,
17073 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17075 The native Linux/GNU toolchain also supports the value @samp{native},
17076 which selects the best architecture option for the host processor.
17077 @option{-march=native} has no effect if GCC does not recognize
17078 the processor.
17080 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17081 (for example, @option{-march=r2k}).  Prefixes are optional, and
17082 @samp{vr} may be written @samp{r}.
17084 Names of the form @samp{@var{n}f2_1} refer to processors with
17085 FPUs clocked at half the rate of the core, names of the form
17086 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17087 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17088 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17089 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17090 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17091 accepted as synonyms for @samp{@var{n}f1_1}.
17093 GCC defines two macros based on the value of this option.  The first
17094 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
17095 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
17096 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
17097 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
17098 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
17100 Note that the @code{_MIPS_ARCH} macro uses the processor names given
17101 above.  In other words, it has the full prefix and does not
17102 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17103 the macro names the resolved architecture (either @code{"mips1"} or
17104 @code{"mips3"}).  It names the default architecture when no
17105 @option{-march} option is given.
17107 @item -mtune=@var{arch}
17108 @opindex mtune
17109 Optimize for @var{arch}.  Among other things, this option controls
17110 the way instructions are scheduled, and the perceived cost of arithmetic
17111 operations.  The list of @var{arch} values is the same as for
17112 @option{-march}.
17114 When this option is not used, GCC optimizes for the processor
17115 specified by @option{-march}.  By using @option{-march} and
17116 @option{-mtune} together, it is possible to generate code that
17117 runs on a family of processors, but optimize the code for one
17118 particular member of that family.
17120 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
17121 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17122 @option{-march} ones described above.
17124 @item -mips1
17125 @opindex mips1
17126 Equivalent to @option{-march=mips1}.
17128 @item -mips2
17129 @opindex mips2
17130 Equivalent to @option{-march=mips2}.
17132 @item -mips3
17133 @opindex mips3
17134 Equivalent to @option{-march=mips3}.
17136 @item -mips4
17137 @opindex mips4
17138 Equivalent to @option{-march=mips4}.
17140 @item -mips32
17141 @opindex mips32
17142 Equivalent to @option{-march=mips32}.
17144 @item -mips32r3
17145 @opindex mips32r3
17146 Equivalent to @option{-march=mips32r3}.
17148 @item -mips32r5
17149 @opindex mips32r5
17150 Equivalent to @option{-march=mips32r5}.
17152 @item -mips32r6
17153 @opindex mips32r6
17154 Equivalent to @option{-march=mips32r6}.
17156 @item -mips64
17157 @opindex mips64
17158 Equivalent to @option{-march=mips64}.
17160 @item -mips64r2
17161 @opindex mips64r2
17162 Equivalent to @option{-march=mips64r2}.
17164 @item -mips64r3
17165 @opindex mips64r3
17166 Equivalent to @option{-march=mips64r3}.
17168 @item -mips64r5
17169 @opindex mips64r5
17170 Equivalent to @option{-march=mips64r5}.
17172 @item -mips64r6
17173 @opindex mips64r6
17174 Equivalent to @option{-march=mips64r6}.
17176 @item -mips16
17177 @itemx -mno-mips16
17178 @opindex mips16
17179 @opindex mno-mips16
17180 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17181 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17183 MIPS16 code generation can also be controlled on a per-function basis
17184 by means of @code{mips16} and @code{nomips16} attributes.
17185 @xref{Function Attributes}, for more information.
17187 @item -mflip-mips16
17188 @opindex mflip-mips16
17189 Generate MIPS16 code on alternating functions.  This option is provided
17190 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17191 not intended for ordinary use in compiling user code.
17193 @item -minterlink-compressed
17194 @item -mno-interlink-compressed
17195 @opindex minterlink-compressed
17196 @opindex mno-interlink-compressed
17197 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17198 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17200 For example, code using the standard ISA encoding cannot jump directly
17201 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17202 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17203 knows that the target of the jump is not compressed.
17205 @item -minterlink-mips16
17206 @itemx -mno-interlink-mips16
17207 @opindex minterlink-mips16
17208 @opindex mno-interlink-mips16
17209 Aliases of @option{-minterlink-compressed} and
17210 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17211 and are retained for backwards compatibility.
17213 @item -mabi=32
17214 @itemx -mabi=o64
17215 @itemx -mabi=n32
17216 @itemx -mabi=64
17217 @itemx -mabi=eabi
17218 @opindex mabi=32
17219 @opindex mabi=o64
17220 @opindex mabi=n32
17221 @opindex mabi=64
17222 @opindex mabi=eabi
17223 Generate code for the given ABI@.
17225 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17226 generates 64-bit code when you select a 64-bit architecture, but you
17227 can use @option{-mgp32} to get 32-bit code instead.
17229 For information about the O64 ABI, see
17230 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17232 GCC supports a variant of the o32 ABI in which floating-point registers
17233 are 64 rather than 32 bits wide.  You can select this combination with
17234 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17235 and @code{mfhc1} instructions and is therefore only supported for
17236 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17238 The register assignments for arguments and return values remain the
17239 same, but each scalar value is passed in a single 64-bit register
17240 rather than a pair of 32-bit registers.  For example, scalar
17241 floating-point values are returned in @samp{$f0} only, not a
17242 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17243 remains the same in that the even-numbered double-precision registers
17244 are saved.
17246 Two additional variants of the o32 ABI are supported to enable
17247 a transition from 32-bit to 64-bit registers.  These are FPXX
17248 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17249 The FPXX extension mandates that all code must execute correctly
17250 when run using 32-bit or 64-bit registers.  The code can be interlinked
17251 with either FP32 or FP64, but not both.
17252 The FP64A extension is similar to the FP64 extension but forbids the
17253 use of odd-numbered single-precision registers.  This can be used
17254 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17255 processors and allows both FP32 and FP64A code to interlink and
17256 run in the same process without changing FPU modes.
17258 @item -mabicalls
17259 @itemx -mno-abicalls
17260 @opindex mabicalls
17261 @opindex mno-abicalls
17262 Generate (do not generate) code that is suitable for SVR4-style
17263 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17264 systems.
17266 @item -mshared
17267 @itemx -mno-shared
17268 Generate (do not generate) code that is fully position-independent,
17269 and that can therefore be linked into shared libraries.  This option
17270 only affects @option{-mabicalls}.
17272 All @option{-mabicalls} code has traditionally been position-independent,
17273 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17274 as an extension, the GNU toolchain allows executables to use absolute
17275 accesses for locally-binding symbols.  It can also use shorter GP
17276 initialization sequences and generate direct calls to locally-defined
17277 functions.  This mode is selected by @option{-mno-shared}.
17279 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17280 objects that can only be linked by the GNU linker.  However, the option
17281 does not affect the ABI of the final executable; it only affects the ABI
17282 of relocatable objects.  Using @option{-mno-shared} generally makes
17283 executables both smaller and quicker.
17285 @option{-mshared} is the default.
17287 @item -mplt
17288 @itemx -mno-plt
17289 @opindex mplt
17290 @opindex mno-plt
17291 Assume (do not assume) that the static and dynamic linkers
17292 support PLTs and copy relocations.  This option only affects
17293 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17294 has no effect without @option{-msym32}.
17296 You can make @option{-mplt} the default by configuring
17297 GCC with @option{--with-mips-plt}.  The default is
17298 @option{-mno-plt} otherwise.
17300 @item -mxgot
17301 @itemx -mno-xgot
17302 @opindex mxgot
17303 @opindex mno-xgot
17304 Lift (do not lift) the usual restrictions on the size of the global
17305 offset table.
17307 GCC normally uses a single instruction to load values from the GOT@.
17308 While this is relatively efficient, it only works if the GOT
17309 is smaller than about 64k.  Anything larger causes the linker
17310 to report an error such as:
17312 @cindex relocation truncated to fit (MIPS)
17313 @smallexample
17314 relocation truncated to fit: R_MIPS_GOT16 foobar
17315 @end smallexample
17317 If this happens, you should recompile your code with @option{-mxgot}.
17318 This works with very large GOTs, although the code is also
17319 less efficient, since it takes three instructions to fetch the
17320 value of a global symbol.
17322 Note that some linkers can create multiple GOTs.  If you have such a
17323 linker, you should only need to use @option{-mxgot} when a single object
17324 file accesses more than 64k's worth of GOT entries.  Very few do.
17326 These options have no effect unless GCC is generating position
17327 independent code.
17329 @item -mgp32
17330 @opindex mgp32
17331 Assume that general-purpose registers are 32 bits wide.
17333 @item -mgp64
17334 @opindex mgp64
17335 Assume that general-purpose registers are 64 bits wide.
17337 @item -mfp32
17338 @opindex mfp32
17339 Assume that floating-point registers are 32 bits wide.
17341 @item -mfp64
17342 @opindex mfp64
17343 Assume that floating-point registers are 64 bits wide.
17345 @item -mfpxx
17346 @opindex mfpxx
17347 Do not assume the width of floating-point registers.
17349 @item -mhard-float
17350 @opindex mhard-float
17351 Use floating-point coprocessor instructions.
17353 @item -msoft-float
17354 @opindex msoft-float
17355 Do not use floating-point coprocessor instructions.  Implement
17356 floating-point calculations using library calls instead.
17358 @item -mno-float
17359 @opindex mno-float
17360 Equivalent to @option{-msoft-float}, but additionally asserts that the
17361 program being compiled does not perform any floating-point operations.
17362 This option is presently supported only by some bare-metal MIPS
17363 configurations, where it may select a special set of libraries
17364 that lack all floating-point support (including, for example, the
17365 floating-point @code{printf} formats).  
17366 If code compiled with @option{-mno-float} accidentally contains
17367 floating-point operations, it is likely to suffer a link-time
17368 or run-time failure.
17370 @item -msingle-float
17371 @opindex msingle-float
17372 Assume that the floating-point coprocessor only supports single-precision
17373 operations.
17375 @item -mdouble-float
17376 @opindex mdouble-float
17377 Assume that the floating-point coprocessor supports double-precision
17378 operations.  This is the default.
17380 @item -modd-spreg
17381 @itemx -mno-odd-spreg
17382 @opindex modd-spreg
17383 @opindex mno-odd-spreg
17384 Enable the use of odd-numbered single-precision floating-point registers
17385 for the o32 ABI.  This is the default for processors that are known to
17386 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
17387 is set by default.
17389 @item -mabs=2008
17390 @itemx -mabs=legacy
17391 @opindex mabs=2008
17392 @opindex mabs=legacy
17393 These options control the treatment of the special not-a-number (NaN)
17394 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17395 @code{neg.@i{fmt}} machine instructions.
17397 By default or when @option{-mabs=legacy} is used the legacy
17398 treatment is selected.  In this case these instructions are considered
17399 arithmetic and avoided where correct operation is required and the
17400 input operand might be a NaN.  A longer sequence of instructions that
17401 manipulate the sign bit of floating-point datum manually is used
17402 instead unless the @option{-ffinite-math-only} option has also been
17403 specified.
17405 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17406 this case these instructions are considered non-arithmetic and therefore
17407 operating correctly in all cases, including in particular where the
17408 input operand is a NaN.  These instructions are therefore always used
17409 for the respective operations.
17411 @item -mnan=2008
17412 @itemx -mnan=legacy
17413 @opindex mnan=2008
17414 @opindex mnan=legacy
17415 These options control the encoding of the special not-a-number (NaN)
17416 IEEE 754 floating-point data.
17418 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17419 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17420 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17421 by the first bit of their trailing significand field being 1.
17423 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17424 this case qNaNs are denoted by the first bit of their trailing
17425 significand field being 1, whereas sNaNs are denoted by the first bit of
17426 their trailing significand field being 0.
17428 The default is @option{-mnan=legacy} unless GCC has been configured with
17429 @option{--with-nan=2008}.
17431 @item -mllsc
17432 @itemx -mno-llsc
17433 @opindex mllsc
17434 @opindex mno-llsc
17435 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17436 implement atomic memory built-in functions.  When neither option is
17437 specified, GCC uses the instructions if the target architecture
17438 supports them.
17440 @option{-mllsc} is useful if the runtime environment can emulate the
17441 instructions and @option{-mno-llsc} can be useful when compiling for
17442 nonstandard ISAs.  You can make either option the default by
17443 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17444 respectively.  @option{--with-llsc} is the default for some
17445 configurations; see the installation documentation for details.
17447 @item -mdsp
17448 @itemx -mno-dsp
17449 @opindex mdsp
17450 @opindex mno-dsp
17451 Use (do not use) revision 1 of the MIPS DSP ASE@.
17452 @xref{MIPS DSP Built-in Functions}.  This option defines the
17453 preprocessor macro @code{__mips_dsp}.  It also defines
17454 @code{__mips_dsp_rev} to 1.
17456 @item -mdspr2
17457 @itemx -mno-dspr2
17458 @opindex mdspr2
17459 @opindex mno-dspr2
17460 Use (do not use) revision 2 of the MIPS DSP ASE@.
17461 @xref{MIPS DSP Built-in Functions}.  This option defines the
17462 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
17463 It also defines @code{__mips_dsp_rev} to 2.
17465 @item -msmartmips
17466 @itemx -mno-smartmips
17467 @opindex msmartmips
17468 @opindex mno-smartmips
17469 Use (do not use) the MIPS SmartMIPS ASE.
17471 @item -mpaired-single
17472 @itemx -mno-paired-single
17473 @opindex mpaired-single
17474 @opindex mno-paired-single
17475 Use (do not use) paired-single floating-point instructions.
17476 @xref{MIPS Paired-Single Support}.  This option requires
17477 hardware floating-point support to be enabled.
17479 @item -mdmx
17480 @itemx -mno-mdmx
17481 @opindex mdmx
17482 @opindex mno-mdmx
17483 Use (do not use) MIPS Digital Media Extension instructions.
17484 This option can only be used when generating 64-bit code and requires
17485 hardware floating-point support to be enabled.
17487 @item -mips3d
17488 @itemx -mno-mips3d
17489 @opindex mips3d
17490 @opindex mno-mips3d
17491 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17492 The option @option{-mips3d} implies @option{-mpaired-single}.
17494 @item -mmicromips
17495 @itemx -mno-micromips
17496 @opindex mmicromips
17497 @opindex mno-mmicromips
17498 Generate (do not generate) microMIPS code.
17500 MicroMIPS code generation can also be controlled on a per-function basis
17501 by means of @code{micromips} and @code{nomicromips} attributes.
17502 @xref{Function Attributes}, for more information.
17504 @item -mmt
17505 @itemx -mno-mt
17506 @opindex mmt
17507 @opindex mno-mt
17508 Use (do not use) MT Multithreading instructions.
17510 @item -mmcu
17511 @itemx -mno-mcu
17512 @opindex mmcu
17513 @opindex mno-mcu
17514 Use (do not use) the MIPS MCU ASE instructions.
17516 @item -meva
17517 @itemx -mno-eva
17518 @opindex meva
17519 @opindex mno-eva
17520 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17522 @item -mvirt
17523 @itemx -mno-virt
17524 @opindex mvirt
17525 @opindex mno-virt
17526 Use (do not use) the MIPS Virtualization Application Specific instructions.
17528 @item -mxpa
17529 @itemx -mno-xpa
17530 @opindex mxpa
17531 @opindex mno-xpa
17532 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17534 @item -mlong64
17535 @opindex mlong64
17536 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17537 an explanation of the default and the way that the pointer size is
17538 determined.
17540 @item -mlong32
17541 @opindex mlong32
17542 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17544 The default size of @code{int}s, @code{long}s and pointers depends on
17545 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17546 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17547 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17548 or the same size as integer registers, whichever is smaller.
17550 @item -msym32
17551 @itemx -mno-sym32
17552 @opindex msym32
17553 @opindex mno-sym32
17554 Assume (do not assume) that all symbols have 32-bit values, regardless
17555 of the selected ABI@.  This option is useful in combination with
17556 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17557 to generate shorter and faster references to symbolic addresses.
17559 @item -G @var{num}
17560 @opindex G
17561 Put definitions of externally-visible data in a small data section
17562 if that data is no bigger than @var{num} bytes.  GCC can then generate
17563 more efficient accesses to the data; see @option{-mgpopt} for details.
17565 The default @option{-G} option depends on the configuration.
17567 @item -mlocal-sdata
17568 @itemx -mno-local-sdata
17569 @opindex mlocal-sdata
17570 @opindex mno-local-sdata
17571 Extend (do not extend) the @option{-G} behavior to local data too,
17572 such as to static variables in C@.  @option{-mlocal-sdata} is the
17573 default for all configurations.
17575 If the linker complains that an application is using too much small data,
17576 you might want to try rebuilding the less performance-critical parts with
17577 @option{-mno-local-sdata}.  You might also want to build large
17578 libraries with @option{-mno-local-sdata}, so that the libraries leave
17579 more room for the main program.
17581 @item -mextern-sdata
17582 @itemx -mno-extern-sdata
17583 @opindex mextern-sdata
17584 @opindex mno-extern-sdata
17585 Assume (do not assume) that externally-defined data is in
17586 a small data section if the size of that data is within the @option{-G} limit.
17587 @option{-mextern-sdata} is the default for all configurations.
17589 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17590 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17591 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17592 is placed in a small data section.  If @var{Var} is defined by another
17593 module, you must either compile that module with a high-enough
17594 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17595 definition.  If @var{Var} is common, you must link the application
17596 with a high-enough @option{-G} setting.
17598 The easiest way of satisfying these restrictions is to compile
17599 and link every module with the same @option{-G} option.  However,
17600 you may wish to build a library that supports several different
17601 small data limits.  You can do this by compiling the library with
17602 the highest supported @option{-G} setting and additionally using
17603 @option{-mno-extern-sdata} to stop the library from making assumptions
17604 about externally-defined data.
17606 @item -mgpopt
17607 @itemx -mno-gpopt
17608 @opindex mgpopt
17609 @opindex mno-gpopt
17610 Use (do not use) GP-relative accesses for symbols that are known to be
17611 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17612 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17613 configurations.
17615 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17616 might not hold the value of @code{_gp}.  For example, if the code is
17617 part of a library that might be used in a boot monitor, programs that
17618 call boot monitor routines pass an unknown value in @code{$gp}.
17619 (In such situations, the boot monitor itself is usually compiled
17620 with @option{-G0}.)
17622 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17623 @option{-mno-extern-sdata}.
17625 @item -membedded-data
17626 @itemx -mno-embedded-data
17627 @opindex membedded-data
17628 @opindex mno-embedded-data
17629 Allocate variables to the read-only data section first if possible, then
17630 next in the small data section if possible, otherwise in data.  This gives
17631 slightly slower code than the default, but reduces the amount of RAM required
17632 when executing, and thus may be preferred for some embedded systems.
17634 @item -muninit-const-in-rodata
17635 @itemx -mno-uninit-const-in-rodata
17636 @opindex muninit-const-in-rodata
17637 @opindex mno-uninit-const-in-rodata
17638 Put uninitialized @code{const} variables in the read-only data section.
17639 This option is only meaningful in conjunction with @option{-membedded-data}.
17641 @item -mcode-readable=@var{setting}
17642 @opindex mcode-readable
17643 Specify whether GCC may generate code that reads from executable sections.
17644 There are three possible settings:
17646 @table @gcctabopt
17647 @item -mcode-readable=yes
17648 Instructions may freely access executable sections.  This is the
17649 default setting.
17651 @item -mcode-readable=pcrel
17652 MIPS16 PC-relative load instructions can access executable sections,
17653 but other instructions must not do so.  This option is useful on 4KSc
17654 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17655 It is also useful on processors that can be configured to have a dual
17656 instruction/data SRAM interface and that, like the M4K, automatically
17657 redirect PC-relative loads to the instruction RAM.
17659 @item -mcode-readable=no
17660 Instructions must not access executable sections.  This option can be
17661 useful on targets that are configured to have a dual instruction/data
17662 SRAM interface but that (unlike the M4K) do not automatically redirect
17663 PC-relative loads to the instruction RAM.
17664 @end table
17666 @item -msplit-addresses
17667 @itemx -mno-split-addresses
17668 @opindex msplit-addresses
17669 @opindex mno-split-addresses
17670 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17671 relocation operators.  This option has been superseded by
17672 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17674 @item -mexplicit-relocs
17675 @itemx -mno-explicit-relocs
17676 @opindex mexplicit-relocs
17677 @opindex mno-explicit-relocs
17678 Use (do not use) assembler relocation operators when dealing with symbolic
17679 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17680 is to use assembler macros instead.
17682 @option{-mexplicit-relocs} is the default if GCC was configured
17683 to use an assembler that supports relocation operators.
17685 @item -mcheck-zero-division
17686 @itemx -mno-check-zero-division
17687 @opindex mcheck-zero-division
17688 @opindex mno-check-zero-division
17689 Trap (do not trap) on integer division by zero.
17691 The default is @option{-mcheck-zero-division}.
17693 @item -mdivide-traps
17694 @itemx -mdivide-breaks
17695 @opindex mdivide-traps
17696 @opindex mdivide-breaks
17697 MIPS systems check for division by zero by generating either a
17698 conditional trap or a break instruction.  Using traps results in
17699 smaller code, but is only supported on MIPS II and later.  Also, some
17700 versions of the Linux kernel have a bug that prevents trap from
17701 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17702 allow conditional traps on architectures that support them and
17703 @option{-mdivide-breaks} to force the use of breaks.
17705 The default is usually @option{-mdivide-traps}, but this can be
17706 overridden at configure time using @option{--with-divide=breaks}.
17707 Divide-by-zero checks can be completely disabled using
17708 @option{-mno-check-zero-division}.
17710 @item -mmemcpy
17711 @itemx -mno-memcpy
17712 @opindex mmemcpy
17713 @opindex mno-memcpy
17714 Force (do not force) the use of @code{memcpy} for non-trivial block
17715 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17716 most constant-sized copies.
17718 @item -mlong-calls
17719 @itemx -mno-long-calls
17720 @opindex mlong-calls
17721 @opindex mno-long-calls
17722 Disable (do not disable) use of the @code{jal} instruction.  Calling
17723 functions using @code{jal} is more efficient but requires the caller
17724 and callee to be in the same 256 megabyte segment.
17726 This option has no effect on abicalls code.  The default is
17727 @option{-mno-long-calls}.
17729 @item -mmad
17730 @itemx -mno-mad
17731 @opindex mmad
17732 @opindex mno-mad
17733 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17734 instructions, as provided by the R4650 ISA@.
17736 @item -mimadd
17737 @itemx -mno-imadd
17738 @opindex mimadd
17739 @opindex mno-imadd
17740 Enable (disable) use of the @code{madd} and @code{msub} integer
17741 instructions.  The default is @option{-mimadd} on architectures
17742 that support @code{madd} and @code{msub} except for the 74k 
17743 architecture where it was found to generate slower code.
17745 @item -mfused-madd
17746 @itemx -mno-fused-madd
17747 @opindex mfused-madd
17748 @opindex mno-fused-madd
17749 Enable (disable) use of the floating-point multiply-accumulate
17750 instructions, when they are available.  The default is
17751 @option{-mfused-madd}.
17753 On the R8000 CPU when multiply-accumulate instructions are used,
17754 the intermediate product is calculated to infinite precision
17755 and is not subject to the FCSR Flush to Zero bit.  This may be
17756 undesirable in some circumstances.  On other processors the result
17757 is numerically identical to the equivalent computation using
17758 separate multiply, add, subtract and negate instructions.
17760 @item -nocpp
17761 @opindex nocpp
17762 Tell the MIPS assembler to not run its preprocessor over user
17763 assembler files (with a @samp{.s} suffix) when assembling them.
17765 @item -mfix-24k
17766 @item -mno-fix-24k
17767 @opindex mfix-24k
17768 @opindex mno-fix-24k
17769 Work around the 24K E48 (lost data on stores during refill) errata.
17770 The workarounds are implemented by the assembler rather than by GCC@.
17772 @item -mfix-r4000
17773 @itemx -mno-fix-r4000
17774 @opindex mfix-r4000
17775 @opindex mno-fix-r4000
17776 Work around certain R4000 CPU errata:
17777 @itemize @minus
17778 @item
17779 A double-word or a variable shift may give an incorrect result if executed
17780 immediately after starting an integer division.
17781 @item
17782 A double-word or a variable shift may give an incorrect result if executed
17783 while an integer multiplication is in progress.
17784 @item
17785 An integer division may give an incorrect result if started in a delay slot
17786 of a taken branch or a jump.
17787 @end itemize
17789 @item -mfix-r4400
17790 @itemx -mno-fix-r4400
17791 @opindex mfix-r4400
17792 @opindex mno-fix-r4400
17793 Work around certain R4400 CPU errata:
17794 @itemize @minus
17795 @item
17796 A double-word or a variable shift may give an incorrect result if executed
17797 immediately after starting an integer division.
17798 @end itemize
17800 @item -mfix-r10000
17801 @itemx -mno-fix-r10000
17802 @opindex mfix-r10000
17803 @opindex mno-fix-r10000
17804 Work around certain R10000 errata:
17805 @itemize @minus
17806 @item
17807 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17808 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17809 @end itemize
17811 This option can only be used if the target architecture supports
17812 branch-likely instructions.  @option{-mfix-r10000} is the default when
17813 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17814 otherwise.
17816 @item -mfix-rm7000
17817 @itemx -mno-fix-rm7000
17818 @opindex mfix-rm7000
17819 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17820 workarounds are implemented by the assembler rather than by GCC@.
17822 @item -mfix-vr4120
17823 @itemx -mno-fix-vr4120
17824 @opindex mfix-vr4120
17825 Work around certain VR4120 errata:
17826 @itemize @minus
17827 @item
17828 @code{dmultu} does not always produce the correct result.
17829 @item
17830 @code{div} and @code{ddiv} do not always produce the correct result if one
17831 of the operands is negative.
17832 @end itemize
17833 The workarounds for the division errata rely on special functions in
17834 @file{libgcc.a}.  At present, these functions are only provided by
17835 the @code{mips64vr*-elf} configurations.
17837 Other VR4120 errata require a NOP to be inserted between certain pairs of
17838 instructions.  These errata are handled by the assembler, not by GCC itself.
17840 @item -mfix-vr4130
17841 @opindex mfix-vr4130
17842 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17843 workarounds are implemented by the assembler rather than by GCC,
17844 although GCC avoids using @code{mflo} and @code{mfhi} if the
17845 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17846 instructions are available instead.
17848 @item -mfix-sb1
17849 @itemx -mno-fix-sb1
17850 @opindex mfix-sb1
17851 Work around certain SB-1 CPU core errata.
17852 (This flag currently works around the SB-1 revision 2
17853 ``F1'' and ``F2'' floating-point errata.)
17855 @item -mr10k-cache-barrier=@var{setting}
17856 @opindex mr10k-cache-barrier
17857 Specify whether GCC should insert cache barriers to avoid the
17858 side-effects of speculation on R10K processors.
17860 In common with many processors, the R10K tries to predict the outcome
17861 of a conditional branch and speculatively executes instructions from
17862 the ``taken'' branch.  It later aborts these instructions if the
17863 predicted outcome is wrong.  However, on the R10K, even aborted
17864 instructions can have side effects.
17866 This problem only affects kernel stores and, depending on the system,
17867 kernel loads.  As an example, a speculatively-executed store may load
17868 the target memory into cache and mark the cache line as dirty, even if
17869 the store itself is later aborted.  If a DMA operation writes to the
17870 same area of memory before the ``dirty'' line is flushed, the cached
17871 data overwrites the DMA-ed data.  See the R10K processor manual
17872 for a full description, including other potential problems.
17874 One workaround is to insert cache barrier instructions before every memory
17875 access that might be speculatively executed and that might have side
17876 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17877 controls GCC's implementation of this workaround.  It assumes that
17878 aborted accesses to any byte in the following regions does not have
17879 side effects:
17881 @enumerate
17882 @item
17883 the memory occupied by the current function's stack frame;
17885 @item
17886 the memory occupied by an incoming stack argument;
17888 @item
17889 the memory occupied by an object with a link-time-constant address.
17890 @end enumerate
17892 It is the kernel's responsibility to ensure that speculative
17893 accesses to these regions are indeed safe.
17895 If the input program contains a function declaration such as:
17897 @smallexample
17898 void foo (void);
17899 @end smallexample
17901 then the implementation of @code{foo} must allow @code{j foo} and
17902 @code{jal foo} to be executed speculatively.  GCC honors this
17903 restriction for functions it compiles itself.  It expects non-GCC
17904 functions (such as hand-written assembly code) to do the same.
17906 The option has three forms:
17908 @table @gcctabopt
17909 @item -mr10k-cache-barrier=load-store
17910 Insert a cache barrier before a load or store that might be
17911 speculatively executed and that might have side effects even
17912 if aborted.
17914 @item -mr10k-cache-barrier=store
17915 Insert a cache barrier before a store that might be speculatively
17916 executed and that might have side effects even if aborted.
17918 @item -mr10k-cache-barrier=none
17919 Disable the insertion of cache barriers.  This is the default setting.
17920 @end table
17922 @item -mflush-func=@var{func}
17923 @itemx -mno-flush-func
17924 @opindex mflush-func
17925 Specifies the function to call to flush the I and D caches, or to not
17926 call any such function.  If called, the function must take the same
17927 arguments as the common @code{_flush_func}, that is, the address of the
17928 memory range for which the cache is being flushed, the size of the
17929 memory range, and the number 3 (to flush both caches).  The default
17930 depends on the target GCC was configured for, but commonly is either
17931 @code{_flush_func} or @code{__cpu_flush}.
17933 @item mbranch-cost=@var{num}
17934 @opindex mbranch-cost
17935 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17936 This cost is only a heuristic and is not guaranteed to produce
17937 consistent results across releases.  A zero cost redundantly selects
17938 the default, which is based on the @option{-mtune} setting.
17940 @item -mbranch-likely
17941 @itemx -mno-branch-likely
17942 @opindex mbranch-likely
17943 @opindex mno-branch-likely
17944 Enable or disable use of Branch Likely instructions, regardless of the
17945 default for the selected architecture.  By default, Branch Likely
17946 instructions may be generated if they are supported by the selected
17947 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17948 and processors that implement those architectures; for those, Branch
17949 Likely instructions are not be generated by default because the MIPS32
17950 and MIPS64 architectures specifically deprecate their use.
17952 @item -mfp-exceptions
17953 @itemx -mno-fp-exceptions
17954 @opindex mfp-exceptions
17955 Specifies whether FP exceptions are enabled.  This affects how
17956 FP instructions are scheduled for some processors.
17957 The default is that FP exceptions are
17958 enabled.
17960 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17961 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17962 FP pipe.
17964 @item -mvr4130-align
17965 @itemx -mno-vr4130-align
17966 @opindex mvr4130-align
17967 The VR4130 pipeline is two-way superscalar, but can only issue two
17968 instructions together if the first one is 8-byte aligned.  When this
17969 option is enabled, GCC aligns pairs of instructions that it
17970 thinks should execute in parallel.
17972 This option only has an effect when optimizing for the VR4130.
17973 It normally makes code faster, but at the expense of making it bigger.
17974 It is enabled by default at optimization level @option{-O3}.
17976 @item -msynci
17977 @itemx -mno-synci
17978 @opindex msynci
17979 Enable (disable) generation of @code{synci} instructions on
17980 architectures that support it.  The @code{synci} instructions (if
17981 enabled) are generated when @code{__builtin___clear_cache} is
17982 compiled.
17984 This option defaults to @option{-mno-synci}, but the default can be
17985 overridden by configuring GCC with @option{--with-synci}.
17987 When compiling code for single processor systems, it is generally safe
17988 to use @code{synci}.  However, on many multi-core (SMP) systems, it
17989 does not invalidate the instruction caches on all cores and may lead
17990 to undefined behavior.
17992 @item -mrelax-pic-calls
17993 @itemx -mno-relax-pic-calls
17994 @opindex mrelax-pic-calls
17995 Try to turn PIC calls that are normally dispatched via register
17996 @code{$25} into direct calls.  This is only possible if the linker can
17997 resolve the destination at link-time and if the destination is within
17998 range for a direct call.
18000 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18001 an assembler and a linker that support the @code{.reloc} assembly
18002 directive and @option{-mexplicit-relocs} is in effect.  With
18003 @option{-mno-explicit-relocs}, this optimization can be performed by the
18004 assembler and the linker alone without help from the compiler.
18006 @item -mmcount-ra-address
18007 @itemx -mno-mcount-ra-address
18008 @opindex mmcount-ra-address
18009 @opindex mno-mcount-ra-address
18010 Emit (do not emit) code that allows @code{_mcount} to modify the
18011 calling function's return address.  When enabled, this option extends
18012 the usual @code{_mcount} interface with a new @var{ra-address}
18013 parameter, which has type @code{intptr_t *} and is passed in register
18014 @code{$12}.  @code{_mcount} can then modify the return address by
18015 doing both of the following:
18016 @itemize
18017 @item
18018 Returning the new address in register @code{$31}.
18019 @item
18020 Storing the new address in @code{*@var{ra-address}},
18021 if @var{ra-address} is nonnull.
18022 @end itemize
18024 The default is @option{-mno-mcount-ra-address}.
18026 @end table
18028 @node MMIX Options
18029 @subsection MMIX Options
18030 @cindex MMIX Options
18032 These options are defined for the MMIX:
18034 @table @gcctabopt
18035 @item -mlibfuncs
18036 @itemx -mno-libfuncs
18037 @opindex mlibfuncs
18038 @opindex mno-libfuncs
18039 Specify that intrinsic library functions are being compiled, passing all
18040 values in registers, no matter the size.
18042 @item -mepsilon
18043 @itemx -mno-epsilon
18044 @opindex mepsilon
18045 @opindex mno-epsilon
18046 Generate floating-point comparison instructions that compare with respect
18047 to the @code{rE} epsilon register.
18049 @item -mabi=mmixware
18050 @itemx -mabi=gnu
18051 @opindex mabi=mmixware
18052 @opindex mabi=gnu
18053 Generate code that passes function parameters and return values that (in
18054 the called function) are seen as registers @code{$0} and up, as opposed to
18055 the GNU ABI which uses global registers @code{$231} and up.
18057 @item -mzero-extend
18058 @itemx -mno-zero-extend
18059 @opindex mzero-extend
18060 @opindex mno-zero-extend
18061 When reading data from memory in sizes shorter than 64 bits, use (do not
18062 use) zero-extending load instructions by default, rather than
18063 sign-extending ones.
18065 @item -mknuthdiv
18066 @itemx -mno-knuthdiv
18067 @opindex mknuthdiv
18068 @opindex mno-knuthdiv
18069 Make the result of a division yielding a remainder have the same sign as
18070 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18071 remainder follows the sign of the dividend.  Both methods are
18072 arithmetically valid, the latter being almost exclusively used.
18074 @item -mtoplevel-symbols
18075 @itemx -mno-toplevel-symbols
18076 @opindex mtoplevel-symbols
18077 @opindex mno-toplevel-symbols
18078 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18079 code can be used with the @code{PREFIX} assembly directive.
18081 @item -melf
18082 @opindex melf
18083 Generate an executable in the ELF format, rather than the default
18084 @samp{mmo} format used by the @command{mmix} simulator.
18086 @item -mbranch-predict
18087 @itemx -mno-branch-predict
18088 @opindex mbranch-predict
18089 @opindex mno-branch-predict
18090 Use (do not use) the probable-branch instructions, when static branch
18091 prediction indicates a probable branch.
18093 @item -mbase-addresses
18094 @itemx -mno-base-addresses
18095 @opindex mbase-addresses
18096 @opindex mno-base-addresses
18097 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18098 base address automatically generates a request (handled by the assembler
18099 and the linker) for a constant to be set up in a global register.  The
18100 register is used for one or more base address requests within the range 0
18101 to 255 from the value held in the register.  The generally leads to short
18102 and fast code, but the number of different data items that can be
18103 addressed is limited.  This means that a program that uses lots of static
18104 data may require @option{-mno-base-addresses}.
18106 @item -msingle-exit
18107 @itemx -mno-single-exit
18108 @opindex msingle-exit
18109 @opindex mno-single-exit
18110 Force (do not force) generated code to have a single exit point in each
18111 function.
18112 @end table
18114 @node MN10300 Options
18115 @subsection MN10300 Options
18116 @cindex MN10300 options
18118 These @option{-m} options are defined for Matsushita MN10300 architectures:
18120 @table @gcctabopt
18121 @item -mmult-bug
18122 @opindex mmult-bug
18123 Generate code to avoid bugs in the multiply instructions for the MN10300
18124 processors.  This is the default.
18126 @item -mno-mult-bug
18127 @opindex mno-mult-bug
18128 Do not generate code to avoid bugs in the multiply instructions for the
18129 MN10300 processors.
18131 @item -mam33
18132 @opindex mam33
18133 Generate code using features specific to the AM33 processor.
18135 @item -mno-am33
18136 @opindex mno-am33
18137 Do not generate code using features specific to the AM33 processor.  This
18138 is the default.
18140 @item -mam33-2
18141 @opindex mam33-2
18142 Generate code using features specific to the AM33/2.0 processor.
18144 @item -mam34
18145 @opindex mam34
18146 Generate code using features specific to the AM34 processor.
18148 @item -mtune=@var{cpu-type}
18149 @opindex mtune
18150 Use the timing characteristics of the indicated CPU type when
18151 scheduling instructions.  This does not change the targeted processor
18152 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18153 @samp{am33-2} or @samp{am34}.
18155 @item -mreturn-pointer-on-d0
18156 @opindex mreturn-pointer-on-d0
18157 When generating a function that returns a pointer, return the pointer
18158 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18159 only in @code{a0}, and attempts to call such functions without a prototype
18160 result in errors.  Note that this option is on by default; use
18161 @option{-mno-return-pointer-on-d0} to disable it.
18163 @item -mno-crt0
18164 @opindex mno-crt0
18165 Do not link in the C run-time initialization object file.
18167 @item -mrelax
18168 @opindex mrelax
18169 Indicate to the linker that it should perform a relaxation optimization pass
18170 to shorten branches, calls and absolute memory addresses.  This option only
18171 has an effect when used on the command line for the final link step.
18173 This option makes symbolic debugging impossible.
18175 @item -mliw
18176 @opindex mliw
18177 Allow the compiler to generate @emph{Long Instruction Word}
18178 instructions if the target is the @samp{AM33} or later.  This is the
18179 default.  This option defines the preprocessor macro @code{__LIW__}.
18181 @item -mnoliw
18182 @opindex mnoliw
18183 Do not allow the compiler to generate @emph{Long Instruction Word}
18184 instructions.  This option defines the preprocessor macro
18185 @code{__NO_LIW__}.
18187 @item -msetlb
18188 @opindex msetlb
18189 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18190 instructions if the target is the @samp{AM33} or later.  This is the
18191 default.  This option defines the preprocessor macro @code{__SETLB__}.
18193 @item -mnosetlb
18194 @opindex mnosetlb
18195 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18196 instructions.  This option defines the preprocessor macro
18197 @code{__NO_SETLB__}.
18199 @end table
18201 @node Moxie Options
18202 @subsection Moxie Options
18203 @cindex Moxie Options
18205 @table @gcctabopt
18207 @item -meb
18208 @opindex meb
18209 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18210 configurations.
18212 @item -mel
18213 @opindex mel
18214 Generate little-endian code.
18216 @item -mmul.x
18217 @opindex mmul.x
18218 Generate mul.x and umul.x instructions.  This is the default for
18219 @samp{moxiebox-*-*} configurations.
18221 @item -mno-crt0
18222 @opindex mno-crt0
18223 Do not link in the C run-time initialization object file.
18225 @end table
18227 @node MSP430 Options
18228 @subsection MSP430 Options
18229 @cindex MSP430 Options
18231 These options are defined for the MSP430:
18233 @table @gcctabopt
18235 @item -masm-hex
18236 @opindex masm-hex
18237 Force assembly output to always use hex constants.  Normally such
18238 constants are signed decimals, but this option is available for
18239 testsuite and/or aesthetic purposes.
18241 @item -mmcu=
18242 @opindex mmcu=
18243 Select the MCU to target.  This is used to create a C preprocessor
18244 symbol based upon the MCU name, converted to upper case and pre- and
18245 post-fixed with @samp{__}.  This in turn is used by the
18246 @file{msp430.h} header file to select an MCU-specific supplementary
18247 header file.
18249 The option also sets the ISA to use.  If the MCU name is one that is
18250 known to only support the 430 ISA then that is selected, otherwise the
18251 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
18252 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
18253 name selects the 430X ISA.
18255 In addition an MCU-specific linker script is added to the linker
18256 command line.  The script's name is the name of the MCU with
18257 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
18258 command line defines the C preprocessor symbol @code{__XXX__} and
18259 cause the linker to search for a script called @file{xxx.ld}.
18261 This option is also passed on to the assembler.
18263 @item -mcpu=
18264 @opindex mcpu=
18265 Specifies the ISA to use.  Accepted values are @samp{msp430},
18266 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
18267 @option{-mmcu=} option should be used to select the ISA.
18269 @item -msim
18270 @opindex msim
18271 Link to the simulator runtime libraries and linker script.  Overrides
18272 any scripts that would be selected by the @option{-mmcu=} option.
18274 @item -mlarge
18275 @opindex mlarge
18276 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18278 @item -msmall
18279 @opindex msmall
18280 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18282 @item -mrelax
18283 @opindex mrelax
18284 This option is passed to the assembler and linker, and allows the
18285 linker to perform certain optimizations that cannot be done until
18286 the final link.
18288 @item mhwmult=
18289 @opindex mhwmult=
18290 Describes the type of hardware multiply supported by the target.
18291 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
18292 for the original 16-bit-only multiply supported by early MCUs.
18293 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
18294 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18295 A value of @samp{auto} can also be given.  This tells GCC to deduce
18296 the hardware multiply support based upon the MCU name provided by the
18297 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18298 @samp{32bit} hardware multiply support is assumed.  @samp{auto} is the
18299 default setting.
18301 Hardware multiplies are normally performed by calling a library
18302 routine.  This saves space in the generated code.  When compiling at
18303 @option{-O3} or higher however the hardware multiplier is invoked
18304 inline.  This makes for bigger, but faster code.
18306 The hardware multiply routines disable interrupts whilst running and
18307 restore the previous interrupt state when they finish.  This makes
18308 them safe to use inside interrupt handlers as well as in normal code.
18310 @item -minrt
18311 @opindex minrt
18312 Enable the use of a minimum runtime environment - no static
18313 initializers or constructors.  This is intended for memory-constrained
18314 devices.  The compiler includes special symbols in some objects
18315 that tell the linker and runtime which code fragments are required.
18317 @item -mcode-region=
18318 @itemx -mdata-region=
18319 @opindex mcode-region
18320 @opindex mdata-region
18321 These options tell the compiler where to place functions and data that
18322 do not have one of the @code{lower}, @code{upper}, @code{either} or
18323 @code{section} attributes.  Possible values are @code{lower},
18324 @code{upper}, @code{either} or @code{any}.  The first three behave
18325 like the corresponding attribute.  The fourth possible value -
18326 @code{any} - is the default.  It leaves placement entirely up to the
18327 linker script and how it assigns the standard sections (.text, .data
18328 etc) to the memory regions.
18330 @end table
18332 @node NDS32 Options
18333 @subsection NDS32 Options
18334 @cindex NDS32 Options
18336 These options are defined for NDS32 implementations:
18338 @table @gcctabopt
18340 @item -mbig-endian
18341 @opindex mbig-endian
18342 Generate code in big-endian mode.
18344 @item -mlittle-endian
18345 @opindex mlittle-endian
18346 Generate code in little-endian mode.
18348 @item -mreduced-regs
18349 @opindex mreduced-regs
18350 Use reduced-set registers for register allocation.
18352 @item -mfull-regs
18353 @opindex mfull-regs
18354 Use full-set registers for register allocation.
18356 @item -mcmov
18357 @opindex mcmov
18358 Generate conditional move instructions.
18360 @item -mno-cmov
18361 @opindex mno-cmov
18362 Do not generate conditional move instructions.
18364 @item -mperf-ext
18365 @opindex mperf-ext
18366 Generate performance extension instructions.
18368 @item -mno-perf-ext
18369 @opindex mno-perf-ext
18370 Do not generate performance extension instructions.
18372 @item -mv3push
18373 @opindex mv3push
18374 Generate v3 push25/pop25 instructions.
18376 @item -mno-v3push
18377 @opindex mno-v3push
18378 Do not generate v3 push25/pop25 instructions.
18380 @item -m16-bit
18381 @opindex m16-bit
18382 Generate 16-bit instructions.
18384 @item -mno-16-bit
18385 @opindex mno-16-bit
18386 Do not generate 16-bit instructions.
18388 @item -misr-vector-size=@var{num}
18389 @opindex misr-vector-size
18390 Specify the size of each interrupt vector, which must be 4 or 16.
18392 @item -mcache-block-size=@var{num}
18393 @opindex mcache-block-size
18394 Specify the size of each cache block,
18395 which must be a power of 2 between 4 and 512.
18397 @item -march=@var{arch}
18398 @opindex march
18399 Specify the name of the target architecture.
18401 @item -mcmodel=@var{code-model}
18402 @opindex mcmodel
18403 Set the code model to one of
18404 @table @asis
18405 @item @samp{small}
18406 All the data and read-only data segments must be within 512KB addressing space.
18407 The text segment must be within 16MB addressing space.
18408 @item @samp{medium}
18409 The data segment must be within 512KB while the read-only data segment can be
18410 within 4GB addressing space.  The text segment should be still within 16MB
18411 addressing space.
18412 @item @samp{large}
18413 All the text and data segments can be within 4GB addressing space.
18414 @end table
18416 @item -mctor-dtor
18417 @opindex mctor-dtor
18418 Enable constructor/destructor feature.
18420 @item -mrelax
18421 @opindex mrelax
18422 Guide linker to relax instructions.
18424 @end table
18426 @node Nios II Options
18427 @subsection Nios II Options
18428 @cindex Nios II options
18429 @cindex Altera Nios II options
18431 These are the options defined for the Altera Nios II processor.
18433 @table @gcctabopt
18435 @item -G @var{num}
18436 @opindex G
18437 @cindex smaller data references
18438 Put global and static objects less than or equal to @var{num} bytes
18439 into the small data or BSS sections instead of the normal data or BSS
18440 sections.  The default value of @var{num} is 8.
18442 @item -mgpopt=@var{option}
18443 @item -mgpopt
18444 @itemx -mno-gpopt
18445 @opindex mgpopt
18446 @opindex mno-gpopt
18447 Generate (do not generate) GP-relative accesses.  The following 
18448 @var{option} names are recognized:
18450 @table @samp
18452 @item none
18453 Do not generate GP-relative accesses.
18455 @item local
18456 Generate GP-relative accesses for small data objects that are not 
18457 external or weak.  Also use GP-relative addressing for objects that
18458 have been explicitly placed in a small data section via a @code{section}
18459 attribute.
18461 @item global
18462 As for @samp{local}, but also generate GP-relative accesses for
18463 small data objects that are external or weak.  If you use this option,
18464 you must ensure that all parts of your program (including libraries) are
18465 compiled with the same @option{-G} setting.
18467 @item data
18468 Generate GP-relative accesses for all data objects in the program.  If you
18469 use this option, the entire data and BSS segments
18470 of your program must fit in 64K of memory and you must use an appropriate
18471 linker script to allocate them within the addressible range of the
18472 global pointer.
18474 @item all
18475 Generate GP-relative addresses for function pointers as well as data
18476 pointers.  If you use this option, the entire text, data, and BSS segments
18477 of your program must fit in 64K of memory and you must use an appropriate
18478 linker script to allocate them within the addressible range of the
18479 global pointer.
18481 @end table
18483 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
18484 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
18486 The default is @option{-mgpopt} except when @option{-fpic} or
18487 @option{-fPIC} is specified to generate position-independent code.
18488 Note that the Nios II ABI does not permit GP-relative accesses from
18489 shared libraries.
18491 You may need to specify @option{-mno-gpopt} explicitly when building
18492 programs that include large amounts of small data, including large
18493 GOT data sections.  In this case, the 16-bit offset for GP-relative
18494 addressing may not be large enough to allow access to the entire 
18495 small data section.
18497 @item -mel
18498 @itemx -meb
18499 @opindex mel
18500 @opindex meb
18501 Generate little-endian (default) or big-endian (experimental) code,
18502 respectively.
18504 @item -march=@var{arch}
18505 @opindex march
18506 This specifies the name of the target Nios II architecture.  GCC uses this
18507 name to determine what kind of instructions it can emit when generating
18508 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
18510 The preprocessor macro @code{__nios2_arch__} is available to programs,
18511 with value 1 or 2, indicating the targeted ISA level.
18513 @item -mbypass-cache
18514 @itemx -mno-bypass-cache
18515 @opindex mno-bypass-cache
18516 @opindex mbypass-cache
18517 Force all load and store instructions to always bypass cache by 
18518 using I/O variants of the instructions. The default is not to
18519 bypass the cache.
18521 @item -mno-cache-volatile 
18522 @itemx -mcache-volatile       
18523 @opindex mcache-volatile 
18524 @opindex mno-cache-volatile
18525 Volatile memory access bypass the cache using the I/O variants of 
18526 the load and store instructions. The default is not to bypass the cache.
18528 @item -mno-fast-sw-div
18529 @itemx -mfast-sw-div
18530 @opindex mno-fast-sw-div
18531 @opindex mfast-sw-div
18532 Do not use table-based fast divide for small numbers. The default 
18533 is to use the fast divide at @option{-O3} and above.
18535 @item -mno-hw-mul
18536 @itemx -mhw-mul
18537 @itemx -mno-hw-mulx
18538 @itemx -mhw-mulx
18539 @itemx -mno-hw-div
18540 @itemx -mhw-div
18541 @opindex mno-hw-mul
18542 @opindex mhw-mul
18543 @opindex mno-hw-mulx
18544 @opindex mhw-mulx
18545 @opindex mno-hw-div
18546 @opindex mhw-div
18547 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18548 instructions by the compiler. The default is to emit @code{mul}
18549 and not emit @code{div} and @code{mulx}.
18551 @item -mbmx
18552 @itemx -mno-bmx
18553 @itemx -mcdx
18554 @itemx -mno-cdx
18555 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
18556 CDX (code density) instructions.  Enabling these instructions also
18557 requires @option{-march=r2}.  Since these instructions are optional
18558 extensions to the R2 architecture, the default is not to emit them.
18560 @item -mcustom-@var{insn}=@var{N}
18561 @itemx -mno-custom-@var{insn}
18562 @opindex mcustom-@var{insn}
18563 @opindex mno-custom-@var{insn}
18564 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18565 custom instruction with encoding @var{N} when generating code that uses 
18566 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
18567 instruction 253 for single-precision floating-point add operations instead
18568 of the default behavior of using a library call.
18570 The following values of @var{insn} are supported.  Except as otherwise
18571 noted, floating-point operations are expected to be implemented with
18572 normal IEEE 754 semantics and correspond directly to the C operators or the
18573 equivalent GCC built-in functions (@pxref{Other Builtins}).
18575 Single-precision floating point:
18576 @table @asis
18578 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18579 Binary arithmetic operations.
18581 @item @samp{fnegs}
18582 Unary negation.
18584 @item @samp{fabss}
18585 Unary absolute value.
18587 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18588 Comparison operations.
18590 @item @samp{fmins}, @samp{fmaxs}
18591 Floating-point minimum and maximum.  These instructions are only
18592 generated if @option{-ffinite-math-only} is specified.
18594 @item @samp{fsqrts}
18595 Unary square root operation.
18597 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18598 Floating-point trigonometric and exponential functions.  These instructions
18599 are only generated if @option{-funsafe-math-optimizations} is also specified.
18601 @end table
18603 Double-precision floating point:
18604 @table @asis
18606 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18607 Binary arithmetic operations.
18609 @item @samp{fnegd}
18610 Unary negation.
18612 @item @samp{fabsd}
18613 Unary absolute value.
18615 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18616 Comparison operations.
18618 @item @samp{fmind}, @samp{fmaxd}
18619 Double-precision minimum and maximum.  These instructions are only
18620 generated if @option{-ffinite-math-only} is specified.
18622 @item @samp{fsqrtd}
18623 Unary square root operation.
18625 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18626 Double-precision trigonometric and exponential functions.  These instructions
18627 are only generated if @option{-funsafe-math-optimizations} is also specified.
18629 @end table
18631 Conversions:
18632 @table @asis
18633 @item @samp{fextsd}
18634 Conversion from single precision to double precision.
18636 @item @samp{ftruncds}
18637 Conversion from double precision to single precision.
18639 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18640 Conversion from floating point to signed or unsigned integer types, with
18641 truncation towards zero.
18643 @item @samp{round}
18644 Conversion from single-precision floating point to signed integer,
18645 rounding to the nearest integer and ties away from zero.
18646 This corresponds to the @code{__builtin_lroundf} function when
18647 @option{-fno-math-errno} is used.
18649 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18650 Conversion from signed or unsigned integer types to floating-point types.
18652 @end table
18654 In addition, all of the following transfer instructions for internal
18655 registers X and Y must be provided to use any of the double-precision
18656 floating-point instructions.  Custom instructions taking two
18657 double-precision source operands expect the first operand in the
18658 64-bit register X.  The other operand (or only operand of a unary
18659 operation) is given to the custom arithmetic instruction with the
18660 least significant half in source register @var{src1} and the most
18661 significant half in @var{src2}.  A custom instruction that returns a
18662 double-precision result returns the most significant 32 bits in the
18663 destination register and the other half in 32-bit register Y.  
18664 GCC automatically generates the necessary code sequences to write
18665 register X and/or read register Y when double-precision floating-point
18666 instructions are used.
18668 @table @asis
18670 @item @samp{fwrx}
18671 Write @var{src1} into the least significant half of X and @var{src2} into
18672 the most significant half of X.
18674 @item @samp{fwry}
18675 Write @var{src1} into Y.
18677 @item @samp{frdxhi}, @samp{frdxlo}
18678 Read the most or least (respectively) significant half of X and store it in
18679 @var{dest}.
18681 @item @samp{frdy}
18682 Read the value of Y and store it into @var{dest}.
18683 @end table
18685 Note that you can gain more local control over generation of Nios II custom
18686 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18687 and @code{target("no-custom-@var{insn}")} function attributes
18688 (@pxref{Function Attributes})
18689 or pragmas (@pxref{Function Specific Option Pragmas}).
18691 @item -mcustom-fpu-cfg=@var{name}
18692 @opindex mcustom-fpu-cfg
18694 This option enables a predefined, named set of custom instruction encodings
18695 (see @option{-mcustom-@var{insn}} above).  
18696 Currently, the following sets are defined:
18698 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18699 @gccoptlist{-mcustom-fmuls=252 @gol
18700 -mcustom-fadds=253 @gol
18701 -mcustom-fsubs=254 @gol
18702 -fsingle-precision-constant}
18704 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18705 @gccoptlist{-mcustom-fmuls=252 @gol
18706 -mcustom-fadds=253 @gol
18707 -mcustom-fsubs=254 @gol
18708 -mcustom-fdivs=255 @gol
18709 -fsingle-precision-constant}
18711 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18712 @gccoptlist{-mcustom-floatus=243 @gol
18713 -mcustom-fixsi=244 @gol
18714 -mcustom-floatis=245 @gol
18715 -mcustom-fcmpgts=246 @gol
18716 -mcustom-fcmples=249 @gol
18717 -mcustom-fcmpeqs=250 @gol
18718 -mcustom-fcmpnes=251 @gol
18719 -mcustom-fmuls=252 @gol
18720 -mcustom-fadds=253 @gol
18721 -mcustom-fsubs=254 @gol
18722 -mcustom-fdivs=255 @gol
18723 -fsingle-precision-constant}
18725 Custom instruction assignments given by individual
18726 @option{-mcustom-@var{insn}=} options override those given by
18727 @option{-mcustom-fpu-cfg=}, regardless of the
18728 order of the options on the command line.
18730 Note that you can gain more local control over selection of a FPU
18731 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18732 function attribute (@pxref{Function Attributes})
18733 or pragma (@pxref{Function Specific Option Pragmas}).
18735 @end table
18737 These additional @samp{-m} options are available for the Altera Nios II
18738 ELF (bare-metal) target:
18740 @table @gcctabopt
18742 @item -mhal
18743 @opindex mhal
18744 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18745 startup and termination code, and is typically used in conjunction with
18746 @option{-msys-crt0=} to specify the location of the alternate startup code
18747 provided by the HAL BSP.
18749 @item -msmallc
18750 @opindex msmallc
18751 Link with a limited version of the C library, @option{-lsmallc}, rather than
18752 Newlib.
18754 @item -msys-crt0=@var{startfile}
18755 @opindex msys-crt0
18756 @var{startfile} is the file name of the startfile (crt0) to use 
18757 when linking.  This option is only useful in conjunction with @option{-mhal}.
18759 @item -msys-lib=@var{systemlib}
18760 @opindex msys-lib
18761 @var{systemlib} is the library name of the library that provides
18762 low-level system calls required by the C library,
18763 e.g. @code{read} and @code{write}.
18764 This option is typically used to link with a library provided by a HAL BSP.
18766 @end table
18768 @node Nvidia PTX Options
18769 @subsection Nvidia PTX Options
18770 @cindex Nvidia PTX options
18771 @cindex nvptx options
18773 These options are defined for Nvidia PTX:
18775 @table @gcctabopt
18777 @item -m32
18778 @itemx -m64
18779 @opindex m32
18780 @opindex m64
18781 Generate code for 32-bit or 64-bit ABI.
18783 @item -mmainkernel
18784 @opindex mmainkernel
18785 Link in code for a __main kernel.  This is for stand-alone instead of
18786 offloading execution.
18788 @end table
18790 @node PDP-11 Options
18791 @subsection PDP-11 Options
18792 @cindex PDP-11 Options
18794 These options are defined for the PDP-11:
18796 @table @gcctabopt
18797 @item -mfpu
18798 @opindex mfpu
18799 Use hardware FPP floating point.  This is the default.  (FIS floating
18800 point on the PDP-11/40 is not supported.)
18802 @item -msoft-float
18803 @opindex msoft-float
18804 Do not use hardware floating point.
18806 @item -mac0
18807 @opindex mac0
18808 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18810 @item -mno-ac0
18811 @opindex mno-ac0
18812 Return floating-point results in memory.  This is the default.
18814 @item -m40
18815 @opindex m40
18816 Generate code for a PDP-11/40.
18818 @item -m45
18819 @opindex m45
18820 Generate code for a PDP-11/45.  This is the default.
18822 @item -m10
18823 @opindex m10
18824 Generate code for a PDP-11/10.
18826 @item -mbcopy-builtin
18827 @opindex mbcopy-builtin
18828 Use inline @code{movmemhi} patterns for copying memory.  This is the
18829 default.
18831 @item -mbcopy
18832 @opindex mbcopy
18833 Do not use inline @code{movmemhi} patterns for copying memory.
18835 @item -mint16
18836 @itemx -mno-int32
18837 @opindex mint16
18838 @opindex mno-int32
18839 Use 16-bit @code{int}.  This is the default.
18841 @item -mint32
18842 @itemx -mno-int16
18843 @opindex mint32
18844 @opindex mno-int16
18845 Use 32-bit @code{int}.
18847 @item -mfloat64
18848 @itemx -mno-float32
18849 @opindex mfloat64
18850 @opindex mno-float32
18851 Use 64-bit @code{float}.  This is the default.
18853 @item -mfloat32
18854 @itemx -mno-float64
18855 @opindex mfloat32
18856 @opindex mno-float64
18857 Use 32-bit @code{float}.
18859 @item -mabshi
18860 @opindex mabshi
18861 Use @code{abshi2} pattern.  This is the default.
18863 @item -mno-abshi
18864 @opindex mno-abshi
18865 Do not use @code{abshi2} pattern.
18867 @item -mbranch-expensive
18868 @opindex mbranch-expensive
18869 Pretend that branches are expensive.  This is for experimenting with
18870 code generation only.
18872 @item -mbranch-cheap
18873 @opindex mbranch-cheap
18874 Do not pretend that branches are expensive.  This is the default.
18876 @item -munix-asm
18877 @opindex munix-asm
18878 Use Unix assembler syntax.  This is the default when configured for
18879 @samp{pdp11-*-bsd}.
18881 @item -mdec-asm
18882 @opindex mdec-asm
18883 Use DEC assembler syntax.  This is the default when configured for any
18884 PDP-11 target other than @samp{pdp11-*-bsd}.
18885 @end table
18887 @node picoChip Options
18888 @subsection picoChip Options
18889 @cindex picoChip options
18891 These @samp{-m} options are defined for picoChip implementations:
18893 @table @gcctabopt
18895 @item -mae=@var{ae_type}
18896 @opindex mcpu
18897 Set the instruction set, register set, and instruction scheduling
18898 parameters for array element type @var{ae_type}.  Supported values
18899 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18901 @option{-mae=ANY} selects a completely generic AE type.  Code
18902 generated with this option runs on any of the other AE types.  The
18903 code is not as efficient as it would be if compiled for a specific
18904 AE type, and some types of operation (e.g., multiplication) do not
18905 work properly on all types of AE.
18907 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18908 for compiled code, and is the default.
18910 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18911 option may suffer from poor performance of byte (char) manipulation,
18912 since the DSP AE does not provide hardware support for byte load/stores.
18914 @item -msymbol-as-address
18915 Enable the compiler to directly use a symbol name as an address in a
18916 load/store instruction, without first loading it into a
18917 register.  Typically, the use of this option generates larger
18918 programs, which run faster than when the option isn't used.  However, the
18919 results vary from program to program, so it is left as a user option,
18920 rather than being permanently enabled.
18922 @item -mno-inefficient-warnings
18923 Disables warnings about the generation of inefficient code.  These
18924 warnings can be generated, for example, when compiling code that
18925 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18926 no hardware support for byte-level memory operations, so all byte
18927 load/stores must be synthesized from word load/store operations.  This is
18928 inefficient and a warning is generated to indicate
18929 that you should rewrite the code to avoid byte operations, or to target
18930 an AE type that has the necessary hardware support.  This option disables
18931 these warnings.
18933 @end table
18935 @node PowerPC Options
18936 @subsection PowerPC Options
18937 @cindex PowerPC options
18939 These are listed under @xref{RS/6000 and PowerPC Options}.
18941 @node RL78 Options
18942 @subsection RL78 Options
18943 @cindex RL78 Options
18945 @table @gcctabopt
18947 @item -msim
18948 @opindex msim
18949 Links in additional target libraries to support operation within a
18950 simulator.
18952 @item -mmul=none
18953 @itemx -mmul=g10
18954 @itemx -mmul=g13
18955 @itemx -mmul=g14
18956 @itemx -mmul=rl78
18957 @opindex mmul
18958 Specifies the type of hardware multiplication and division support to
18959 be used.  The simplest is @code{none}, which uses software for both
18960 multiplication and division.  This is the default.  The @code{g13}
18961 value is for the hardware multiply/divide peripheral found on the
18962 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
18963 the multiplication and division instructions supported by the RL78/G14
18964 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
18965 the value @code{mg10} is an alias for @code{none}.
18967 In addition a C preprocessor macro is defined, based upon the setting
18968 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
18969 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
18971 @item -mcpu=g10
18972 @itemx -mcpu=g13
18973 @itemx -mcpu=g14
18974 @itemx -mcpu=rl78
18975 @opindex mcpu
18976 Specifies the RL78 core to target.  The default is the G14 core, also
18977 known as an S3 core or just RL78.  The G13 or S2 core does not have
18978 multiply or divide instructions, instead it uses a hardware peripheral
18979 for these operations.  The G10 or S1 core does not have register
18980 banks, so it uses a different calling convention.
18982 If this option is set it also selects the type of hardware multiply
18983 support to use, unless this is overridden by an explicit
18984 @option{-mmul=none} option on the command line.  Thus specifying
18985 @option{-mcpu=g13} enables the use of the G13 hardware multiply
18986 peripheral and specifying @option{-mcpu=g10} disables the use of
18987 hardware multipications altogether.
18989 Note, although the RL78/G14 core is the default target, specifying
18990 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
18991 change the behaviour of the toolchain since it also enables G14
18992 hardware multiply support.  If these options are not specified on the
18993 command line then software multiplication routines will be used even
18994 though the code targets the RL78 core.  This is for backwards
18995 compatibility with older toolchains which did not have hardware
18996 multiply and divide support.
18998 In addition a C preprocessor macro is defined, based upon the setting
18999 of this option.  Possible values are: @code{__RL78_G10__},
19000 @code{__RL78_G13__} or @code{__RL78_G14__}.
19002 @item -mg10
19003 @itemx -mg13
19004 @itemx -mg14
19005 @itemx -mrl78
19006 @opindex mg10
19007 @opindex mg13
19008 @opindex mg14
19009 @opindex mrl78
19010 These are aliases for the corresponding @option{-mcpu=} option.  They
19011 are provided for backwards compatibility.
19013 @item -mallregs
19014 @opindex mallregs
19015 Allow the compiler to use all of the available registers.  By default
19016 registers @code{r24..r31} are reserved for use in interrupt handlers.
19017 With this option enabled these registers can be used in ordinary
19018 functions as well.
19020 @item -m64bit-doubles
19021 @itemx -m32bit-doubles
19022 @opindex m64bit-doubles
19023 @opindex m32bit-doubles
19024 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19025 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19026 @option{-m32bit-doubles}.
19028 @end table
19030 @node RS/6000 and PowerPC Options
19031 @subsection IBM RS/6000 and PowerPC Options
19032 @cindex RS/6000 and PowerPC Options
19033 @cindex IBM RS/6000 and PowerPC Options
19035 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19036 @table @gcctabopt
19037 @item -mpowerpc-gpopt
19038 @itemx -mno-powerpc-gpopt
19039 @itemx -mpowerpc-gfxopt
19040 @itemx -mno-powerpc-gfxopt
19041 @need 800
19042 @itemx -mpowerpc64
19043 @itemx -mno-powerpc64
19044 @itemx -mmfcrf
19045 @itemx -mno-mfcrf
19046 @itemx -mpopcntb
19047 @itemx -mno-popcntb
19048 @itemx -mpopcntd
19049 @itemx -mno-popcntd
19050 @itemx -mfprnd
19051 @itemx -mno-fprnd
19052 @need 800
19053 @itemx -mcmpb
19054 @itemx -mno-cmpb
19055 @itemx -mmfpgpr
19056 @itemx -mno-mfpgpr
19057 @itemx -mhard-dfp
19058 @itemx -mno-hard-dfp
19059 @opindex mpowerpc-gpopt
19060 @opindex mno-powerpc-gpopt
19061 @opindex mpowerpc-gfxopt
19062 @opindex mno-powerpc-gfxopt
19063 @opindex mpowerpc64
19064 @opindex mno-powerpc64
19065 @opindex mmfcrf
19066 @opindex mno-mfcrf
19067 @opindex mpopcntb
19068 @opindex mno-popcntb
19069 @opindex mpopcntd
19070 @opindex mno-popcntd
19071 @opindex mfprnd
19072 @opindex mno-fprnd
19073 @opindex mcmpb
19074 @opindex mno-cmpb
19075 @opindex mmfpgpr
19076 @opindex mno-mfpgpr
19077 @opindex mhard-dfp
19078 @opindex mno-hard-dfp
19079 You use these options to specify which instructions are available on the
19080 processor you are using.  The default value of these options is
19081 determined when configuring GCC@.  Specifying the
19082 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19083 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19084 rather than the options listed above.
19086 Specifying @option{-mpowerpc-gpopt} allows
19087 GCC to use the optional PowerPC architecture instructions in the
19088 General Purpose group, including floating-point square root.  Specifying
19089 @option{-mpowerpc-gfxopt} allows GCC to
19090 use the optional PowerPC architecture instructions in the Graphics
19091 group, including floating-point select.
19093 The @option{-mmfcrf} option allows GCC to generate the move from
19094 condition register field instruction implemented on the POWER4
19095 processor and other processors that support the PowerPC V2.01
19096 architecture.
19097 The @option{-mpopcntb} option allows GCC to generate the popcount and
19098 double-precision FP reciprocal estimate instruction implemented on the
19099 POWER5 processor and other processors that support the PowerPC V2.02
19100 architecture.
19101 The @option{-mpopcntd} option allows GCC to generate the popcount
19102 instruction implemented on the POWER7 processor and other processors
19103 that support the PowerPC V2.06 architecture.
19104 The @option{-mfprnd} option allows GCC to generate the FP round to
19105 integer instructions implemented on the POWER5+ processor and other
19106 processors that support the PowerPC V2.03 architecture.
19107 The @option{-mcmpb} option allows GCC to generate the compare bytes
19108 instruction implemented on the POWER6 processor and other processors
19109 that support the PowerPC V2.05 architecture.
19110 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19111 general-purpose register instructions implemented on the POWER6X
19112 processor and other processors that support the extended PowerPC V2.05
19113 architecture.
19114 The @option{-mhard-dfp} option allows GCC to generate the decimal
19115 floating-point instructions implemented on some POWER processors.
19117 The @option{-mpowerpc64} option allows GCC to generate the additional
19118 64-bit instructions that are found in the full PowerPC64 architecture
19119 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19120 @option{-mno-powerpc64}.
19122 @item -mcpu=@var{cpu_type}
19123 @opindex mcpu
19124 Set architecture type, register usage, and
19125 instruction scheduling parameters for machine type @var{cpu_type}.
19126 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19127 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19128 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19129 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19130 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19131 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19132 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19133 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19134 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19135 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19136 @samp{powerpc64}, @samp{powerpc64le}, and @samp{rs64}.
19138 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
19139 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
19140 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
19141 architecture machine types, with an appropriate, generic processor
19142 model assumed for scheduling purposes.
19144 The other options specify a specific processor.  Code generated under
19145 those options runs best on that processor, and may not run at all on
19146 others.
19148 The @option{-mcpu} options automatically enable or disable the
19149 following options:
19151 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19152 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19153 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19154 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19155 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19156 -mquad-memory -mquad-memory-atomic}
19158 The particular options set for any particular CPU varies between
19159 compiler versions, depending on what setting seems to produce optimal
19160 code for that CPU; it doesn't necessarily reflect the actual hardware's
19161 capabilities.  If you wish to set an individual option to a particular
19162 value, you may specify it after the @option{-mcpu} option, like
19163 @option{-mcpu=970 -mno-altivec}.
19165 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19166 not enabled or disabled by the @option{-mcpu} option at present because
19167 AIX does not have full support for these options.  You may still
19168 enable or disable them individually if you're sure it'll work in your
19169 environment.
19171 @item -mtune=@var{cpu_type}
19172 @opindex mtune
19173 Set the instruction scheduling parameters for machine type
19174 @var{cpu_type}, but do not set the architecture type or register usage,
19175 as @option{-mcpu=@var{cpu_type}} does.  The same
19176 values for @var{cpu_type} are used for @option{-mtune} as for
19177 @option{-mcpu}.  If both are specified, the code generated uses the
19178 architecture and registers set by @option{-mcpu}, but the
19179 scheduling parameters set by @option{-mtune}.
19181 @item -mcmodel=small
19182 @opindex mcmodel=small
19183 Generate PowerPC64 code for the small model: The TOC is limited to
19184 64k.
19186 @item -mcmodel=medium
19187 @opindex mcmodel=medium
19188 Generate PowerPC64 code for the medium model: The TOC and other static
19189 data may be up to a total of 4G in size.
19191 @item -mcmodel=large
19192 @opindex mcmodel=large
19193 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19194 in size.  Other data and code is only limited by the 64-bit address
19195 space.
19197 @item -maltivec
19198 @itemx -mno-altivec
19199 @opindex maltivec
19200 @opindex mno-altivec
19201 Generate code that uses (does not use) AltiVec instructions, and also
19202 enable the use of built-in functions that allow more direct access to
19203 the AltiVec instruction set.  You may also need to set
19204 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19205 enhancements.
19207 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19208 @option{-maltivec=be}, the element order for Altivec intrinsics such
19209 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
19210 match array element order corresponding to the endianness of the
19211 target.  That is, element zero identifies the leftmost element in a
19212 vector register when targeting a big-endian platform, and identifies
19213 the rightmost element in a vector register when targeting a
19214 little-endian platform.
19216 @item -maltivec=be
19217 @opindex maltivec=be
19218 Generate Altivec instructions using big-endian element order,
19219 regardless of whether the target is big- or little-endian.  This is
19220 the default when targeting a big-endian platform.
19222 The element order is used to interpret element numbers in Altivec
19223 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19224 @code{vec_insert}.  By default, these match array element order
19225 corresponding to the endianness for the target.
19227 @item -maltivec=le
19228 @opindex maltivec=le
19229 Generate Altivec instructions using little-endian element order,
19230 regardless of whether the target is big- or little-endian.  This is
19231 the default when targeting a little-endian platform.  This option is
19232 currently ignored when targeting a big-endian platform.
19234 The element order is used to interpret element numbers in Altivec
19235 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19236 @code{vec_insert}.  By default, these match array element order
19237 corresponding to the endianness for the target.
19239 @item -mvrsave
19240 @itemx -mno-vrsave
19241 @opindex mvrsave
19242 @opindex mno-vrsave
19243 Generate VRSAVE instructions when generating AltiVec code.
19245 @item -mgen-cell-microcode
19246 @opindex mgen-cell-microcode
19247 Generate Cell microcode instructions.
19249 @item -mwarn-cell-microcode
19250 @opindex mwarn-cell-microcode
19251 Warn when a Cell microcode instruction is emitted.  An example
19252 of a Cell microcode instruction is a variable shift.
19254 @item -msecure-plt
19255 @opindex msecure-plt
19256 Generate code that allows @command{ld} and @command{ld.so}
19257 to build executables and shared
19258 libraries with non-executable @code{.plt} and @code{.got} sections.
19259 This is a PowerPC
19260 32-bit SYSV ABI option.
19262 @item -mbss-plt
19263 @opindex mbss-plt
19264 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19265 fills in, and
19266 requires @code{.plt} and @code{.got}
19267 sections that are both writable and executable.
19268 This is a PowerPC 32-bit SYSV ABI option.
19270 @item -misel
19271 @itemx -mno-isel
19272 @opindex misel
19273 @opindex mno-isel
19274 This switch enables or disables the generation of ISEL instructions.
19276 @item -misel=@var{yes/no}
19277 This switch has been deprecated.  Use @option{-misel} and
19278 @option{-mno-isel} instead.
19280 @item -mspe
19281 @itemx -mno-spe
19282 @opindex mspe
19283 @opindex mno-spe
19284 This switch enables or disables the generation of SPE simd
19285 instructions.
19287 @item -mpaired
19288 @itemx -mno-paired
19289 @opindex mpaired
19290 @opindex mno-paired
19291 This switch enables or disables the generation of PAIRED simd
19292 instructions.
19294 @item -mspe=@var{yes/no}
19295 This option has been deprecated.  Use @option{-mspe} and
19296 @option{-mno-spe} instead.
19298 @item -mvsx
19299 @itemx -mno-vsx
19300 @opindex mvsx
19301 @opindex mno-vsx
19302 Generate code that uses (does not use) vector/scalar (VSX)
19303 instructions, and also enable the use of built-in functions that allow
19304 more direct access to the VSX instruction set.
19306 @item -mcrypto
19307 @itemx -mno-crypto
19308 @opindex mcrypto
19309 @opindex mno-crypto
19310 Enable the use (disable) of the built-in functions that allow direct
19311 access to the cryptographic instructions that were added in version
19312 2.07 of the PowerPC ISA.
19314 @item -mdirect-move
19315 @itemx -mno-direct-move
19316 @opindex mdirect-move
19317 @opindex mno-direct-move
19318 Generate code that uses (does not use) the instructions to move data
19319 between the general purpose registers and the vector/scalar (VSX)
19320 registers that were added in version 2.07 of the PowerPC ISA.
19322 @item -mpower8-fusion
19323 @itemx -mno-power8-fusion
19324 @opindex mpower8-fusion
19325 @opindex mno-power8-fusion
19326 Generate code that keeps (does not keeps) some integer operations
19327 adjacent so that the instructions can be fused together on power8 and
19328 later processors.
19330 @item -mpower8-vector
19331 @itemx -mno-power8-vector
19332 @opindex mpower8-vector
19333 @opindex mno-power8-vector
19334 Generate code that uses (does not use) the vector and scalar
19335 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19336 enable the use of built-in functions that allow more direct access to
19337 the vector instructions.
19339 @item -mquad-memory
19340 @itemx -mno-quad-memory
19341 @opindex mquad-memory
19342 @opindex mno-quad-memory
19343 Generate code that uses (does not use) the non-atomic quad word memory
19344 instructions.  The @option{-mquad-memory} option requires use of
19345 64-bit mode.
19347 @item -mquad-memory-atomic
19348 @itemx -mno-quad-memory-atomic
19349 @opindex mquad-memory-atomic
19350 @opindex mno-quad-memory-atomic
19351 Generate code that uses (does not use) the atomic quad word memory
19352 instructions.  The @option{-mquad-memory-atomic} option requires use of
19353 64-bit mode.
19355 @item -mupper-regs-df
19356 @itemx -mno-upper-regs-df
19357 @opindex mupper-regs-df
19358 @opindex mno-upper-regs-df
19359 Generate code that uses (does not use) the scalar double precision
19360 instructions that target all 64 registers in the vector/scalar
19361 floating point register set that were added in version 2.06 of the
19362 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
19363 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19364 @option{-mvsx} options.
19366 @item -mupper-regs-sf
19367 @itemx -mno-upper-regs-sf
19368 @opindex mupper-regs-sf
19369 @opindex mno-upper-regs-sf
19370 Generate code that uses (does not use) the scalar single precision
19371 instructions that target all 64 registers in the vector/scalar
19372 floating point register set that were added in version 2.07 of the
19373 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
19374 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
19375 options.
19377 @item -mupper-regs
19378 @itemx -mno-upper-regs
19379 @opindex mupper-regs
19380 @opindex mno-upper-regs
19381 Generate code that uses (does not use) the scalar
19382 instructions that target all 64 registers in the vector/scalar
19383 floating point register set, depending on the model of the machine.
19385 If the @option{-mno-upper-regs} option is used, it turns off both
19386 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19388 @item -mfloat-gprs=@var{yes/single/double/no}
19389 @itemx -mfloat-gprs
19390 @opindex mfloat-gprs
19391 This switch enables or disables the generation of floating-point
19392 operations on the general-purpose registers for architectures that
19393 support it.
19395 The argument @samp{yes} or @samp{single} enables the use of
19396 single-precision floating-point operations.
19398 The argument @samp{double} enables the use of single and
19399 double-precision floating-point operations.
19401 The argument @samp{no} disables floating-point operations on the
19402 general-purpose registers.
19404 This option is currently only available on the MPC854x.
19406 @item -m32
19407 @itemx -m64
19408 @opindex m32
19409 @opindex m64
19410 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19411 targets (including GNU/Linux).  The 32-bit environment sets int, long
19412 and pointer to 32 bits and generates code that runs on any PowerPC
19413 variant.  The 64-bit environment sets int to 32 bits and long and
19414 pointer to 64 bits, and generates code for PowerPC64, as for
19415 @option{-mpowerpc64}.
19417 @item -mfull-toc
19418 @itemx -mno-fp-in-toc
19419 @itemx -mno-sum-in-toc
19420 @itemx -mminimal-toc
19421 @opindex mfull-toc
19422 @opindex mno-fp-in-toc
19423 @opindex mno-sum-in-toc
19424 @opindex mminimal-toc
19425 Modify generation of the TOC (Table Of Contents), which is created for
19426 every executable file.  The @option{-mfull-toc} option is selected by
19427 default.  In that case, GCC allocates at least one TOC entry for
19428 each unique non-automatic variable reference in your program.  GCC
19429 also places floating-point constants in the TOC@.  However, only
19430 16,384 entries are available in the TOC@.
19432 If you receive a linker error message that saying you have overflowed
19433 the available TOC space, you can reduce the amount of TOC space used
19434 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19435 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19436 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19437 generate code to calculate the sum of an address and a constant at
19438 run time instead of putting that sum into the TOC@.  You may specify one
19439 or both of these options.  Each causes GCC to produce very slightly
19440 slower and larger code at the expense of conserving TOC space.
19442 If you still run out of space in the TOC even when you specify both of
19443 these options, specify @option{-mminimal-toc} instead.  This option causes
19444 GCC to make only one TOC entry for every file.  When you specify this
19445 option, GCC produces code that is slower and larger but which
19446 uses extremely little TOC space.  You may wish to use this option
19447 only on files that contain less frequently-executed code.
19449 @item -maix64
19450 @itemx -maix32
19451 @opindex maix64
19452 @opindex maix32
19453 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19454 @code{long} type, and the infrastructure needed to support them.
19455 Specifying @option{-maix64} implies @option{-mpowerpc64},
19456 while @option{-maix32} disables the 64-bit ABI and
19457 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19459 @item -mxl-compat
19460 @itemx -mno-xl-compat
19461 @opindex mxl-compat
19462 @opindex mno-xl-compat
19463 Produce code that conforms more closely to IBM XL compiler semantics
19464 when using AIX-compatible ABI@.  Pass floating-point arguments to
19465 prototyped functions beyond the register save area (RSA) on the stack
19466 in addition to argument FPRs.  Do not assume that most significant
19467 double in 128-bit long double value is properly rounded when comparing
19468 values and converting to double.  Use XL symbol names for long double
19469 support routines.
19471 The AIX calling convention was extended but not initially documented to
19472 handle an obscure K&R C case of calling a function that takes the
19473 address of its arguments with fewer arguments than declared.  IBM XL
19474 compilers access floating-point arguments that do not fit in the
19475 RSA from the stack when a subroutine is compiled without
19476 optimization.  Because always storing floating-point arguments on the
19477 stack is inefficient and rarely needed, this option is not enabled by
19478 default and only is necessary when calling subroutines compiled by IBM
19479 XL compilers without optimization.
19481 @item -mpe
19482 @opindex mpe
19483 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19484 application written to use message passing with special startup code to
19485 enable the application to run.  The system must have PE installed in the
19486 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19487 must be overridden with the @option{-specs=} option to specify the
19488 appropriate directory location.  The Parallel Environment does not
19489 support threads, so the @option{-mpe} option and the @option{-pthread}
19490 option are incompatible.
19492 @item -malign-natural
19493 @itemx -malign-power
19494 @opindex malign-natural
19495 @opindex malign-power
19496 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19497 @option{-malign-natural} overrides the ABI-defined alignment of larger
19498 types, such as floating-point doubles, on their natural size-based boundary.
19499 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19500 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19502 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19503 is not supported.
19505 @item -msoft-float
19506 @itemx -mhard-float
19507 @opindex msoft-float
19508 @opindex mhard-float
19509 Generate code that does not use (uses) the floating-point register set.
19510 Software floating-point emulation is provided if you use the
19511 @option{-msoft-float} option, and pass the option to GCC when linking.
19513 @item -msingle-float
19514 @itemx -mdouble-float
19515 @opindex msingle-float
19516 @opindex mdouble-float
19517 Generate code for single- or double-precision floating-point operations.
19518 @option{-mdouble-float} implies @option{-msingle-float}.
19520 @item -msimple-fpu
19521 @opindex msimple-fpu
19522 Do not generate @code{sqrt} and @code{div} instructions for hardware
19523 floating-point unit.
19525 @item -mfpu=@var{name}
19526 @opindex mfpu
19527 Specify type of floating-point unit.  Valid values for @var{name} are
19528 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19529 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19530 @samp{sp_full} (equivalent to @option{-msingle-float}),
19531 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19533 @item -mxilinx-fpu
19534 @opindex mxilinx-fpu
19535 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19537 @item -mmultiple
19538 @itemx -mno-multiple
19539 @opindex mmultiple
19540 @opindex mno-multiple
19541 Generate code that uses (does not use) the load multiple word
19542 instructions and the store multiple word instructions.  These
19543 instructions are generated by default on POWER systems, and not
19544 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19545 PowerPC systems, since those instructions do not work when the
19546 processor is in little-endian mode.  The exceptions are PPC740 and
19547 PPC750 which permit these instructions in little-endian mode.
19549 @item -mstring
19550 @itemx -mno-string
19551 @opindex mstring
19552 @opindex mno-string
19553 Generate code that uses (does not use) the load string instructions
19554 and the store string word instructions to save multiple registers and
19555 do small block moves.  These instructions are generated by default on
19556 POWER systems, and not generated on PowerPC systems.  Do not use
19557 @option{-mstring} on little-endian PowerPC systems, since those
19558 instructions do not work when the processor is in little-endian mode.
19559 The exceptions are PPC740 and PPC750 which permit these instructions
19560 in little-endian mode.
19562 @item -mupdate
19563 @itemx -mno-update
19564 @opindex mupdate
19565 @opindex mno-update
19566 Generate code that uses (does not use) the load or store instructions
19567 that update the base register to the address of the calculated memory
19568 location.  These instructions are generated by default.  If you use
19569 @option{-mno-update}, there is a small window between the time that the
19570 stack pointer is updated and the address of the previous frame is
19571 stored, which means code that walks the stack frame across interrupts or
19572 signals may get corrupted data.
19574 @item -mavoid-indexed-addresses
19575 @itemx -mno-avoid-indexed-addresses
19576 @opindex mavoid-indexed-addresses
19577 @opindex mno-avoid-indexed-addresses
19578 Generate code that tries to avoid (not avoid) the use of indexed load
19579 or store instructions. These instructions can incur a performance
19580 penalty on Power6 processors in certain situations, such as when
19581 stepping through large arrays that cross a 16M boundary.  This option
19582 is enabled by default when targeting Power6 and disabled otherwise.
19584 @item -mfused-madd
19585 @itemx -mno-fused-madd
19586 @opindex mfused-madd
19587 @opindex mno-fused-madd
19588 Generate code that uses (does not use) the floating-point multiply and
19589 accumulate instructions.  These instructions are generated by default
19590 if hardware floating point is used.  The machine-dependent
19591 @option{-mfused-madd} option is now mapped to the machine-independent
19592 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19593 mapped to @option{-ffp-contract=off}.
19595 @item -mmulhw
19596 @itemx -mno-mulhw
19597 @opindex mmulhw
19598 @opindex mno-mulhw
19599 Generate code that uses (does not use) the half-word multiply and
19600 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19601 These instructions are generated by default when targeting those
19602 processors.
19604 @item -mdlmzb
19605 @itemx -mno-dlmzb
19606 @opindex mdlmzb
19607 @opindex mno-dlmzb
19608 Generate code that uses (does not use) the string-search @samp{dlmzb}
19609 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19610 generated by default when targeting those processors.
19612 @item -mno-bit-align
19613 @itemx -mbit-align
19614 @opindex mno-bit-align
19615 @opindex mbit-align
19616 On System V.4 and embedded PowerPC systems do not (do) force structures
19617 and unions that contain bit-fields to be aligned to the base type of the
19618 bit-field.
19620 For example, by default a structure containing nothing but 8
19621 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19622 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19623 the structure is aligned to a 1-byte boundary and is 1 byte in
19624 size.
19626 @item -mno-strict-align
19627 @itemx -mstrict-align
19628 @opindex mno-strict-align
19629 @opindex mstrict-align
19630 On System V.4 and embedded PowerPC systems do not (do) assume that
19631 unaligned memory references are handled by the system.
19633 @item -mrelocatable
19634 @itemx -mno-relocatable
19635 @opindex mrelocatable
19636 @opindex mno-relocatable
19637 Generate code that allows (does not allow) a static executable to be
19638 relocated to a different address at run time.  A simple embedded
19639 PowerPC system loader should relocate the entire contents of
19640 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19641 a table of 32-bit addresses generated by this option.  For this to
19642 work, all objects linked together must be compiled with
19643 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19644 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19646 @item -mrelocatable-lib
19647 @itemx -mno-relocatable-lib
19648 @opindex mrelocatable-lib
19649 @opindex mno-relocatable-lib
19650 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19651 @code{.fixup} section to allow static executables to be relocated at
19652 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19653 alignment of @option{-mrelocatable}.  Objects compiled with
19654 @option{-mrelocatable-lib} may be linked with objects compiled with
19655 any combination of the @option{-mrelocatable} options.
19657 @item -mno-toc
19658 @itemx -mtoc
19659 @opindex mno-toc
19660 @opindex mtoc
19661 On System V.4 and embedded PowerPC systems do not (do) assume that
19662 register 2 contains a pointer to a global area pointing to the addresses
19663 used in the program.
19665 @item -mlittle
19666 @itemx -mlittle-endian
19667 @opindex mlittle
19668 @opindex mlittle-endian
19669 On System V.4 and embedded PowerPC systems compile code for the
19670 processor in little-endian mode.  The @option{-mlittle-endian} option is
19671 the same as @option{-mlittle}.
19673 @item -mbig
19674 @itemx -mbig-endian
19675 @opindex mbig
19676 @opindex mbig-endian
19677 On System V.4 and embedded PowerPC systems compile code for the
19678 processor in big-endian mode.  The @option{-mbig-endian} option is
19679 the same as @option{-mbig}.
19681 @item -mdynamic-no-pic
19682 @opindex mdynamic-no-pic
19683 On Darwin and Mac OS X systems, compile code so that it is not
19684 relocatable, but that its external references are relocatable.  The
19685 resulting code is suitable for applications, but not shared
19686 libraries.
19688 @item -msingle-pic-base
19689 @opindex msingle-pic-base
19690 Treat the register used for PIC addressing as read-only, rather than
19691 loading it in the prologue for each function.  The runtime system is
19692 responsible for initializing this register with an appropriate value
19693 before execution begins.
19695 @item -mprioritize-restricted-insns=@var{priority}
19696 @opindex mprioritize-restricted-insns
19697 This option controls the priority that is assigned to
19698 dispatch-slot restricted instructions during the second scheduling
19699 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19700 or @samp{2} to assign no, highest, or second-highest (respectively) 
19701 priority to dispatch-slot restricted
19702 instructions.
19704 @item -msched-costly-dep=@var{dependence_type}
19705 @opindex msched-costly-dep
19706 This option controls which dependences are considered costly
19707 by the target during instruction scheduling.  The argument
19708 @var{dependence_type} takes one of the following values:
19710 @table @asis
19711 @item @samp{no}
19712 No dependence is costly.
19714 @item @samp{all}
19715 All dependences are costly.
19717 @item @samp{true_store_to_load}
19718 A true dependence from store to load is costly.
19720 @item @samp{store_to_load}
19721 Any dependence from store to load is costly.
19723 @item @var{number}
19724 Any dependence for which the latency is greater than or equal to 
19725 @var{number} is costly.
19726 @end table
19728 @item -minsert-sched-nops=@var{scheme}
19729 @opindex minsert-sched-nops
19730 This option controls which NOP insertion scheme is used during
19731 the second scheduling pass.  The argument @var{scheme} takes one of the
19732 following values:
19734 @table @asis
19735 @item @samp{no}
19736 Don't insert NOPs.
19738 @item @samp{pad}
19739 Pad with NOPs any dispatch group that has vacant issue slots,
19740 according to the scheduler's grouping.
19742 @item @samp{regroup_exact}
19743 Insert NOPs to force costly dependent insns into
19744 separate groups.  Insert exactly as many NOPs as needed to force an insn
19745 to a new group, according to the estimated processor grouping.
19747 @item @var{number}
19748 Insert NOPs to force costly dependent insns into
19749 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19750 @end table
19752 @item -mcall-sysv
19753 @opindex mcall-sysv
19754 On System V.4 and embedded PowerPC systems compile code using calling
19755 conventions that adhere to the March 1995 draft of the System V
19756 Application Binary Interface, PowerPC processor supplement.  This is the
19757 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19759 @item -mcall-sysv-eabi
19760 @itemx -mcall-eabi
19761 @opindex mcall-sysv-eabi
19762 @opindex mcall-eabi
19763 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19765 @item -mcall-sysv-noeabi
19766 @opindex mcall-sysv-noeabi
19767 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19769 @item -mcall-aixdesc
19770 @opindex m
19771 On System V.4 and embedded PowerPC systems compile code for the AIX
19772 operating system.
19774 @item -mcall-linux
19775 @opindex mcall-linux
19776 On System V.4 and embedded PowerPC systems compile code for the
19777 Linux-based GNU system.
19779 @item -mcall-freebsd
19780 @opindex mcall-freebsd
19781 On System V.4 and embedded PowerPC systems compile code for the
19782 FreeBSD operating system.
19784 @item -mcall-netbsd
19785 @opindex mcall-netbsd
19786 On System V.4 and embedded PowerPC systems compile code for the
19787 NetBSD operating system.
19789 @item -mcall-openbsd
19790 @opindex mcall-netbsd
19791 On System V.4 and embedded PowerPC systems compile code for the
19792 OpenBSD operating system.
19794 @item -maix-struct-return
19795 @opindex maix-struct-return
19796 Return all structures in memory (as specified by the AIX ABI)@.
19798 @item -msvr4-struct-return
19799 @opindex msvr4-struct-return
19800 Return structures smaller than 8 bytes in registers (as specified by the
19801 SVR4 ABI)@.
19803 @item -mabi=@var{abi-type}
19804 @opindex mabi
19805 Extend the current ABI with a particular extension, or remove such extension.
19806 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
19807 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
19808 @samp{elfv1}, @samp{elfv2}@.
19810 @item -mabi=spe
19811 @opindex mabi=spe
19812 Extend the current ABI with SPE ABI extensions.  This does not change
19813 the default ABI, instead it adds the SPE ABI extensions to the current
19814 ABI@.
19816 @item -mabi=no-spe
19817 @opindex mabi=no-spe
19818 Disable Book-E SPE ABI extensions for the current ABI@.
19820 @item -mabi=ibmlongdouble
19821 @opindex mabi=ibmlongdouble
19822 Change the current ABI to use IBM extended-precision long double.
19823 This is a PowerPC 32-bit SYSV ABI option.
19825 @item -mabi=ieeelongdouble
19826 @opindex mabi=ieeelongdouble
19827 Change the current ABI to use IEEE extended-precision long double.
19828 This is a PowerPC 32-bit Linux ABI option.
19830 @item -mabi=elfv1
19831 @opindex mabi=elfv1
19832 Change the current ABI to use the ELFv1 ABI.
19833 This is the default ABI for big-endian PowerPC 64-bit Linux.
19834 Overriding the default ABI requires special system support and is
19835 likely to fail in spectacular ways.
19837 @item -mabi=elfv2
19838 @opindex mabi=elfv2
19839 Change the current ABI to use the ELFv2 ABI.
19840 This is the default ABI for little-endian PowerPC 64-bit Linux.
19841 Overriding the default ABI requires special system support and is
19842 likely to fail in spectacular ways.
19844 @item -mprototype
19845 @itemx -mno-prototype
19846 @opindex mprototype
19847 @opindex mno-prototype
19848 On System V.4 and embedded PowerPC systems assume that all calls to
19849 variable argument functions are properly prototyped.  Otherwise, the
19850 compiler must insert an instruction before every non-prototyped call to
19851 set or clear bit 6 of the condition code register (@code{CR}) to
19852 indicate whether floating-point values are passed in the floating-point
19853 registers in case the function takes variable arguments.  With
19854 @option{-mprototype}, only calls to prototyped variable argument functions
19855 set or clear the bit.
19857 @item -msim
19858 @opindex msim
19859 On embedded PowerPC systems, assume that the startup module is called
19860 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19861 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19862 configurations.
19864 @item -mmvme
19865 @opindex mmvme
19866 On embedded PowerPC systems, assume that the startup module is called
19867 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19868 @file{libc.a}.
19870 @item -mads
19871 @opindex mads
19872 On embedded PowerPC systems, assume that the startup module is called
19873 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19874 @file{libc.a}.
19876 @item -myellowknife
19877 @opindex myellowknife
19878 On embedded PowerPC systems, assume that the startup module is called
19879 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19880 @file{libc.a}.
19882 @item -mvxworks
19883 @opindex mvxworks
19884 On System V.4 and embedded PowerPC systems, specify that you are
19885 compiling for a VxWorks system.
19887 @item -memb
19888 @opindex memb
19889 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
19890 header to indicate that @samp{eabi} extended relocations are used.
19892 @item -meabi
19893 @itemx -mno-eabi
19894 @opindex meabi
19895 @opindex mno-eabi
19896 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19897 Embedded Applications Binary Interface (EABI), which is a set of
19898 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19899 means that the stack is aligned to an 8-byte boundary, a function
19900 @code{__eabi} is called from @code{main} to set up the EABI
19901 environment, and the @option{-msdata} option can use both @code{r2} and
19902 @code{r13} to point to two separate small data areas.  Selecting
19903 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19904 no EABI initialization function is called from @code{main}, and the
19905 @option{-msdata} option only uses @code{r13} to point to a single
19906 small data area.  The @option{-meabi} option is on by default if you
19907 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19909 @item -msdata=eabi
19910 @opindex msdata=eabi
19911 On System V.4 and embedded PowerPC systems, put small initialized
19912 @code{const} global and static data in the @code{.sdata2} section, which
19913 is pointed to by register @code{r2}.  Put small initialized
19914 non-@code{const} global and static data in the @code{.sdata} section,
19915 which is pointed to by register @code{r13}.  Put small uninitialized
19916 global and static data in the @code{.sbss} section, which is adjacent to
19917 the @code{.sdata} section.  The @option{-msdata=eabi} option is
19918 incompatible with the @option{-mrelocatable} option.  The
19919 @option{-msdata=eabi} option also sets the @option{-memb} option.
19921 @item -msdata=sysv
19922 @opindex msdata=sysv
19923 On System V.4 and embedded PowerPC systems, put small global and static
19924 data in the @code{.sdata} section, which is pointed to by register
19925 @code{r13}.  Put small uninitialized global and static data in the
19926 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
19927 The @option{-msdata=sysv} option is incompatible with the
19928 @option{-mrelocatable} option.
19930 @item -msdata=default
19931 @itemx -msdata
19932 @opindex msdata=default
19933 @opindex msdata
19934 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19935 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19936 same as @option{-msdata=sysv}.
19938 @item -msdata=data
19939 @opindex msdata=data
19940 On System V.4 and embedded PowerPC systems, put small global
19941 data in the @code{.sdata} section.  Put small uninitialized global
19942 data in the @code{.sbss} section.  Do not use register @code{r13}
19943 to address small data however.  This is the default behavior unless
19944 other @option{-msdata} options are used.
19946 @item -msdata=none
19947 @itemx -mno-sdata
19948 @opindex msdata=none
19949 @opindex mno-sdata
19950 On embedded PowerPC systems, put all initialized global and static data
19951 in the @code{.data} section, and all uninitialized data in the
19952 @code{.bss} section.
19954 @item -mblock-move-inline-limit=@var{num}
19955 @opindex mblock-move-inline-limit
19956 Inline all block moves (such as calls to @code{memcpy} or structure
19957 copies) less than or equal to @var{num} bytes.  The minimum value for
19958 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19959 targets.  The default value is target-specific.
19961 @item -G @var{num}
19962 @opindex G
19963 @cindex smaller data references (PowerPC)
19964 @cindex .sdata/.sdata2 references (PowerPC)
19965 On embedded PowerPC systems, put global and static items less than or
19966 equal to @var{num} bytes into the small data or BSS sections instead of
19967 the normal data or BSS section.  By default, @var{num} is 8.  The
19968 @option{-G @var{num}} switch is also passed to the linker.
19969 All modules should be compiled with the same @option{-G @var{num}} value.
19971 @item -mregnames
19972 @itemx -mno-regnames
19973 @opindex mregnames
19974 @opindex mno-regnames
19975 On System V.4 and embedded PowerPC systems do (do not) emit register
19976 names in the assembly language output using symbolic forms.
19978 @item -mlongcall
19979 @itemx -mno-longcall
19980 @opindex mlongcall
19981 @opindex mno-longcall
19982 By default assume that all calls are far away so that a longer and more
19983 expensive calling sequence is required.  This is required for calls
19984 farther than 32 megabytes (33,554,432 bytes) from the current location.
19985 A short call is generated if the compiler knows
19986 the call cannot be that far away.  This setting can be overridden by
19987 the @code{shortcall} function attribute, or by @code{#pragma
19988 longcall(0)}.
19990 Some linkers are capable of detecting out-of-range calls and generating
19991 glue code on the fly.  On these systems, long calls are unnecessary and
19992 generate slower code.  As of this writing, the AIX linker can do this,
19993 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19994 to the GNU linker for 32-bit PowerPC systems as well.
19996 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19997 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19998 addresses represent the callee and the branch island.  The
19999 Darwin/PPC linker prefers the first address and generates a @code{bl
20000 callee} if the PPC @code{bl} instruction reaches the callee directly;
20001 otherwise, the linker generates @code{bl L42} to call the branch
20002 island.  The branch island is appended to the body of the
20003 calling function; it computes the full 32-bit address of the callee
20004 and jumps to it.
20006 On Mach-O (Darwin) systems, this option directs the compiler emit to
20007 the glue for every direct call, and the Darwin linker decides whether
20008 to use or discard it.
20010 In the future, GCC may ignore all longcall specifications
20011 when the linker is known to generate glue.
20013 @item -mtls-markers
20014 @itemx -mno-tls-markers
20015 @opindex mtls-markers
20016 @opindex mno-tls-markers
20017 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20018 specifying the function argument.  The relocation allows the linker to
20019 reliably associate function call with argument setup instructions for
20020 TLS optimization, which in turn allows GCC to better schedule the
20021 sequence.
20023 @item -pthread
20024 @opindex pthread
20025 Adds support for multithreading with the @dfn{pthreads} library.
20026 This option sets flags for both the preprocessor and linker.
20028 @item -mrecip
20029 @itemx -mno-recip
20030 @opindex mrecip
20031 This option enables use of the reciprocal estimate and
20032 reciprocal square root estimate instructions with additional
20033 Newton-Raphson steps to increase precision instead of doing a divide or
20034 square root and divide for floating-point arguments.  You should use
20035 the @option{-ffast-math} option when using @option{-mrecip} (or at
20036 least @option{-funsafe-math-optimizations},
20037 @option{-finite-math-only}, @option{-freciprocal-math} and
20038 @option{-fno-trapping-math}).  Note that while the throughput of the
20039 sequence is generally higher than the throughput of the non-reciprocal
20040 instruction, the precision of the sequence can be decreased by up to 2
20041 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20042 roots.
20044 @item -mrecip=@var{opt}
20045 @opindex mrecip=opt
20046 This option controls which reciprocal estimate instructions
20047 may be used.  @var{opt} is a comma-separated list of options, which may
20048 be preceded by a @code{!} to invert the option:
20050 @table @samp
20052 @item all
20053 Enable all estimate instructions.
20055 @item default 
20056 Enable the default instructions, equivalent to @option{-mrecip}.
20058 @item none 
20059 Disable all estimate instructions, equivalent to @option{-mno-recip}.
20061 @item div 
20062 Enable the reciprocal approximation instructions for both 
20063 single and double precision.
20065 @item divf 
20066 Enable the single-precision reciprocal approximation instructions.
20068 @item divd 
20069 Enable the double-precision reciprocal approximation instructions.
20071 @item rsqrt 
20072 Enable the reciprocal square root approximation instructions for both
20073 single and double precision.
20075 @item rsqrtf 
20076 Enable the single-precision reciprocal square root approximation instructions.
20078 @item rsqrtd 
20079 Enable the double-precision reciprocal square root approximation instructions.
20081 @end table
20083 So, for example, @option{-mrecip=all,!rsqrtd} enables
20084 all of the reciprocal estimate instructions, except for the
20085 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20086 which handle the double-precision reciprocal square root calculations.
20088 @item -mrecip-precision
20089 @itemx -mno-recip-precision
20090 @opindex mrecip-precision
20091 Assume (do not assume) that the reciprocal estimate instructions
20092 provide higher-precision estimates than is mandated by the PowerPC
20093 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20094 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20095 The double-precision square root estimate instructions are not generated by
20096 default on low-precision machines, since they do not provide an
20097 estimate that converges after three steps.
20099 @item -mveclibabi=@var{type}
20100 @opindex mveclibabi
20101 Specifies the ABI type to use for vectorizing intrinsics using an
20102 external library.  The only type supported at present is @samp{mass},
20103 which specifies to use IBM's Mathematical Acceleration Subsystem
20104 (MASS) libraries for vectorizing intrinsics using external libraries.
20105 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20106 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20107 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20108 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20109 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20110 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20111 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20112 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20113 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20114 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20115 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20116 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20117 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20118 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20119 for power7.  Both @option{-ftree-vectorize} and
20120 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20121 libraries must be specified at link time.
20123 @item -mfriz
20124 @itemx -mno-friz
20125 @opindex mfriz
20126 Generate (do not generate) the @code{friz} instruction when the
20127 @option{-funsafe-math-optimizations} option is used to optimize
20128 rounding of floating-point values to 64-bit integer and back to floating
20129 point.  The @code{friz} instruction does not return the same value if
20130 the floating-point number is too large to fit in an integer.
20132 @item -mpointers-to-nested-functions
20133 @itemx -mno-pointers-to-nested-functions
20134 @opindex mpointers-to-nested-functions
20135 Generate (do not generate) code to load up the static chain register
20136 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
20137 systems where a function pointer points to a 3-word descriptor giving
20138 the function address, TOC value to be loaded in register @code{r2}, and
20139 static chain value to be loaded in register @code{r11}.  The
20140 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20141 call through pointers to nested functions or pointers
20142 to functions compiled in other languages that use the static chain if
20143 you use @option{-mno-pointers-to-nested-functions}.
20145 @item -msave-toc-indirect
20146 @itemx -mno-save-toc-indirect
20147 @opindex msave-toc-indirect
20148 Generate (do not generate) code to save the TOC value in the reserved
20149 stack location in the function prologue if the function calls through
20150 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20151 saved in the prologue, it is saved just before the call through the
20152 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20154 @item -mcompat-align-parm
20155 @itemx -mno-compat-align-parm
20156 @opindex mcompat-align-parm
20157 Generate (do not generate) code to pass structure parameters with a
20158 maximum alignment of 64 bits, for compatibility with older versions
20159 of GCC.
20161 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20162 structure parameter on a 128-bit boundary when that structure contained
20163 a member requiring 128-bit alignment.  This is corrected in more
20164 recent versions of GCC.  This option may be used to generate code
20165 that is compatible with functions compiled with older versions of
20166 GCC.
20168 The @option{-mno-compat-align-parm} option is the default.
20169 @end table
20171 @node RX Options
20172 @subsection RX Options
20173 @cindex RX Options
20175 These command-line options are defined for RX targets:
20177 @table @gcctabopt
20178 @item -m64bit-doubles
20179 @itemx -m32bit-doubles
20180 @opindex m64bit-doubles
20181 @opindex m32bit-doubles
20182 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20183 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20184 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20185 works on 32-bit values, which is why the default is
20186 @option{-m32bit-doubles}.
20188 @item -fpu
20189 @itemx -nofpu
20190 @opindex fpu
20191 @opindex nofpu
20192 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20193 floating-point hardware.  The default is enabled for the RX600
20194 series and disabled for the RX200 series.
20196 Floating-point instructions are only generated for 32-bit floating-point 
20197 values, however, so the FPU hardware is not used for doubles if the
20198 @option{-m64bit-doubles} option is used.
20200 @emph{Note} If the @option{-fpu} option is enabled then
20201 @option{-funsafe-math-optimizations} is also enabled automatically.
20202 This is because the RX FPU instructions are themselves unsafe.
20204 @item -mcpu=@var{name}
20205 @opindex mcpu
20206 Selects the type of RX CPU to be targeted.  Currently three types are
20207 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
20208 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
20210 The only difference between @samp{RX600} and @samp{RX610} is that the
20211 @samp{RX610} does not support the @code{MVTIPL} instruction.
20213 The @samp{RX200} series does not have a hardware floating-point unit
20214 and so @option{-nofpu} is enabled by default when this type is
20215 selected.
20217 @item -mbig-endian-data
20218 @itemx -mlittle-endian-data
20219 @opindex mbig-endian-data
20220 @opindex mlittle-endian-data
20221 Store data (but not code) in the big-endian format.  The default is
20222 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20223 format.
20225 @item -msmall-data-limit=@var{N}
20226 @opindex msmall-data-limit
20227 Specifies the maximum size in bytes of global and static variables
20228 which can be placed into the small data area.  Using the small data
20229 area can lead to smaller and faster code, but the size of area is
20230 limited and it is up to the programmer to ensure that the area does
20231 not overflow.  Also when the small data area is used one of the RX's
20232 registers (usually @code{r13}) is reserved for use pointing to this
20233 area, so it is no longer available for use by the compiler.  This
20234 could result in slower and/or larger code if variables are pushed onto
20235 the stack instead of being held in this register.
20237 Note, common variables (variables that have not been initialized) and
20238 constants are not placed into the small data area as they are assigned
20239 to other sections in the output executable.
20241 The default value is zero, which disables this feature.  Note, this
20242 feature is not enabled by default with higher optimization levels
20243 (@option{-O2} etc) because of the potentially detrimental effects of
20244 reserving a register.  It is up to the programmer to experiment and
20245 discover whether this feature is of benefit to their program.  See the
20246 description of the @option{-mpid} option for a description of how the
20247 actual register to hold the small data area pointer is chosen.
20249 @item -msim
20250 @itemx -mno-sim
20251 @opindex msim
20252 @opindex mno-sim
20253 Use the simulator runtime.  The default is to use the libgloss
20254 board-specific runtime.
20256 @item -mas100-syntax
20257 @itemx -mno-as100-syntax
20258 @opindex mas100-syntax
20259 @opindex mno-as100-syntax
20260 When generating assembler output use a syntax that is compatible with
20261 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20262 assembler, but it has some restrictions so it is not generated by default.
20264 @item -mmax-constant-size=@var{N}
20265 @opindex mmax-constant-size
20266 Specifies the maximum size, in bytes, of a constant that can be used as
20267 an operand in a RX instruction.  Although the RX instruction set does
20268 allow constants of up to 4 bytes in length to be used in instructions,
20269 a longer value equates to a longer instruction.  Thus in some
20270 circumstances it can be beneficial to restrict the size of constants
20271 that are used in instructions.  Constants that are too big are instead
20272 placed into a constant pool and referenced via register indirection.
20274 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20275 or 4 means that constants of any size are allowed.
20277 @item -mrelax
20278 @opindex mrelax
20279 Enable linker relaxation.  Linker relaxation is a process whereby the
20280 linker attempts to reduce the size of a program by finding shorter
20281 versions of various instructions.  Disabled by default.
20283 @item -mint-register=@var{N}
20284 @opindex mint-register
20285 Specify the number of registers to reserve for fast interrupt handler
20286 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20287 means that register @code{r13} is reserved for the exclusive use
20288 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20289 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20290 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20291 A value of 0, the default, does not reserve any registers.
20293 @item -msave-acc-in-interrupts
20294 @opindex msave-acc-in-interrupts
20295 Specifies that interrupt handler functions should preserve the
20296 accumulator register.  This is only necessary if normal code might use
20297 the accumulator register, for example because it performs 64-bit
20298 multiplications.  The default is to ignore the accumulator as this
20299 makes the interrupt handlers faster.
20301 @item -mpid
20302 @itemx -mno-pid
20303 @opindex mpid
20304 @opindex mno-pid
20305 Enables the generation of position independent data.  When enabled any
20306 access to constant data is done via an offset from a base address
20307 held in a register.  This allows the location of constant data to be
20308 determined at run time without requiring the executable to be
20309 relocated, which is a benefit to embedded applications with tight
20310 memory constraints.  Data that can be modified is not affected by this
20311 option.
20313 Note, using this feature reserves a register, usually @code{r13}, for
20314 the constant data base address.  This can result in slower and/or
20315 larger code, especially in complicated functions.
20317 The actual register chosen to hold the constant data base address
20318 depends upon whether the @option{-msmall-data-limit} and/or the
20319 @option{-mint-register} command-line options are enabled.  Starting
20320 with register @code{r13} and proceeding downwards, registers are
20321 allocated first to satisfy the requirements of @option{-mint-register},
20322 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20323 is possible for the small data area register to be @code{r8} if both
20324 @option{-mint-register=4} and @option{-mpid} are specified on the
20325 command line.
20327 By default this feature is not enabled.  The default can be restored
20328 via the @option{-mno-pid} command-line option.
20330 @item -mno-warn-multiple-fast-interrupts
20331 @itemx -mwarn-multiple-fast-interrupts
20332 @opindex mno-warn-multiple-fast-interrupts
20333 @opindex mwarn-multiple-fast-interrupts
20334 Prevents GCC from issuing a warning message if it finds more than one
20335 fast interrupt handler when it is compiling a file.  The default is to
20336 issue a warning for each extra fast interrupt handler found, as the RX
20337 only supports one such interrupt.
20339 @item -mallow-string-insns
20340 @itemx -mno-allow-string-insns
20341 @opindex mallow-string-insns
20342 @opindex mno-allow-string-insns
20343 Enables or disables the use of the string manipulation instructions
20344 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
20345 @code{SWHILE} and also the @code{RMPA} instruction.  These
20346 instructions may prefetch data, which is not safe to do if accessing
20347 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
20348 for more information).
20350 The default is to allow these instructions, but it is not possible for
20351 GCC to reliably detect all circumstances where a string instruction
20352 might be used to access an I/O register, so their use cannot be
20353 disabled automatically.  Instead it is reliant upon the programmer to
20354 use the @option{-mno-allow-string-insns} option if their program
20355 accesses I/O space.
20357 When the instructions are enabled GCC defines the C preprocessor
20358 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
20359 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
20360 @end table
20362 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20363 has special significance to the RX port when used with the
20364 @code{interrupt} function attribute.  This attribute indicates a
20365 function intended to process fast interrupts.  GCC ensures
20366 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20367 and/or @code{r13} and only provided that the normal use of the
20368 corresponding registers have been restricted via the
20369 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20370 options.
20372 @node S/390 and zSeries Options
20373 @subsection S/390 and zSeries Options
20374 @cindex S/390 and zSeries Options
20376 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20378 @table @gcctabopt
20379 @item -mhard-float
20380 @itemx -msoft-float
20381 @opindex mhard-float
20382 @opindex msoft-float
20383 Use (do not use) the hardware floating-point instructions and registers
20384 for floating-point operations.  When @option{-msoft-float} is specified,
20385 functions in @file{libgcc.a} are used to perform floating-point
20386 operations.  When @option{-mhard-float} is specified, the compiler
20387 generates IEEE floating-point instructions.  This is the default.
20389 @item -mhard-dfp
20390 @itemx -mno-hard-dfp
20391 @opindex mhard-dfp
20392 @opindex mno-hard-dfp
20393 Use (do not use) the hardware decimal-floating-point instructions for
20394 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20395 specified, functions in @file{libgcc.a} are used to perform
20396 decimal-floating-point operations.  When @option{-mhard-dfp} is
20397 specified, the compiler generates decimal-floating-point hardware
20398 instructions.  This is the default for @option{-march=z9-ec} or higher.
20400 @item -mlong-double-64
20401 @itemx -mlong-double-128
20402 @opindex mlong-double-64
20403 @opindex mlong-double-128
20404 These switches control the size of @code{long double} type. A size
20405 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20406 type. This is the default.
20408 @item -mbackchain
20409 @itemx -mno-backchain
20410 @opindex mbackchain
20411 @opindex mno-backchain
20412 Store (do not store) the address of the caller's frame as backchain pointer
20413 into the callee's stack frame.
20414 A backchain may be needed to allow debugging using tools that do not understand
20415 DWARF 2 call frame information.
20416 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20417 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20418 the backchain is placed into the topmost word of the 96/160 byte register
20419 save area.
20421 In general, code compiled with @option{-mbackchain} is call-compatible with
20422 code compiled with @option{-mmo-backchain}; however, use of the backchain
20423 for debugging purposes usually requires that the whole binary is built with
20424 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20425 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20426 to build a linux kernel use @option{-msoft-float}.
20428 The default is to not maintain the backchain.
20430 @item -mpacked-stack
20431 @itemx -mno-packed-stack
20432 @opindex mpacked-stack
20433 @opindex mno-packed-stack
20434 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20435 specified, the compiler uses the all fields of the 96/160 byte register save
20436 area only for their default purpose; unused fields still take up stack space.
20437 When @option{-mpacked-stack} is specified, register save slots are densely
20438 packed at the top of the register save area; unused space is reused for other
20439 purposes, allowing for more efficient use of the available stack space.
20440 However, when @option{-mbackchain} is also in effect, the topmost word of
20441 the save area is always used to store the backchain, and the return address
20442 register is always saved two words below the backchain.
20444 As long as the stack frame backchain is not used, code generated with
20445 @option{-mpacked-stack} is call-compatible with code generated with
20446 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20447 S/390 or zSeries generated code that uses the stack frame backchain at run
20448 time, not just for debugging purposes.  Such code is not call-compatible
20449 with code compiled with @option{-mpacked-stack}.  Also, note that the
20450 combination of @option{-mbackchain},
20451 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20452 to build a linux kernel use @option{-msoft-float}.
20454 The default is to not use the packed stack layout.
20456 @item -msmall-exec
20457 @itemx -mno-small-exec
20458 @opindex msmall-exec
20459 @opindex mno-small-exec
20460 Generate (or do not generate) code using the @code{bras} instruction
20461 to do subroutine calls.
20462 This only works reliably if the total executable size does not
20463 exceed 64k.  The default is to use the @code{basr} instruction instead,
20464 which does not have this limitation.
20466 @item -m64
20467 @itemx -m31
20468 @opindex m64
20469 @opindex m31
20470 When @option{-m31} is specified, generate code compliant to the
20471 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20472 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20473 particular to generate 64-bit instructions.  For the @samp{s390}
20474 targets, the default is @option{-m31}, while the @samp{s390x}
20475 targets default to @option{-m64}.
20477 @item -mzarch
20478 @itemx -mesa
20479 @opindex mzarch
20480 @opindex mesa
20481 When @option{-mzarch} is specified, generate code using the
20482 instructions available on z/Architecture.
20483 When @option{-mesa} is specified, generate code using the
20484 instructions available on ESA/390.  Note that @option{-mesa} is
20485 not possible with @option{-m64}.
20486 When generating code compliant to the GNU/Linux for S/390 ABI,
20487 the default is @option{-mesa}.  When generating code compliant
20488 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20490 @item -mmvcle
20491 @itemx -mno-mvcle
20492 @opindex mmvcle
20493 @opindex mno-mvcle
20494 Generate (or do not generate) code using the @code{mvcle} instruction
20495 to perform block moves.  When @option{-mno-mvcle} is specified,
20496 use a @code{mvc} loop instead.  This is the default unless optimizing for
20497 size.
20499 @item -mdebug
20500 @itemx -mno-debug
20501 @opindex mdebug
20502 @opindex mno-debug
20503 Print (or do not print) additional debug information when compiling.
20504 The default is to not print debug information.
20506 @item -march=@var{cpu-type}
20507 @opindex march
20508 Generate code that runs on @var{cpu-type}, which is the name of a system
20509 representing a certain processor type.  Possible values for
20510 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20511 @samp{z9-109}, @samp{z9-ec}, @samp{z10},  @samp{z196}, @samp{zEC12},
20512 and @samp{z13}.
20513 When generating code using the instructions available on z/Architecture,
20514 the default is @option{-march=z900}.  Otherwise, the default is
20515 @option{-march=g5}.
20517 @item -mtune=@var{cpu-type}
20518 @opindex mtune
20519 Tune to @var{cpu-type} everything applicable about the generated code,
20520 except for the ABI and the set of available instructions.
20521 The list of @var{cpu-type} values is the same as for @option{-march}.
20522 The default is the value used for @option{-march}.
20524 @item -mtpf-trace
20525 @itemx -mno-tpf-trace
20526 @opindex mtpf-trace
20527 @opindex mno-tpf-trace
20528 Generate code that adds (does not add) in TPF OS specific branches to trace
20529 routines in the operating system.  This option is off by default, even
20530 when compiling for the TPF OS@.
20532 @item -mfused-madd
20533 @itemx -mno-fused-madd
20534 @opindex mfused-madd
20535 @opindex mno-fused-madd
20536 Generate code that uses (does not use) the floating-point multiply and
20537 accumulate instructions.  These instructions are generated by default if
20538 hardware floating point is used.
20540 @item -mwarn-framesize=@var{framesize}
20541 @opindex mwarn-framesize
20542 Emit a warning if the current function exceeds the given frame size.  Because
20543 this is a compile-time check it doesn't need to be a real problem when the program
20544 runs.  It is intended to identify functions that most probably cause
20545 a stack overflow.  It is useful to be used in an environment with limited stack
20546 size e.g.@: the linux kernel.
20548 @item -mwarn-dynamicstack
20549 @opindex mwarn-dynamicstack
20550 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20551 arrays.  This is generally a bad idea with a limited stack size.
20553 @item -mstack-guard=@var{stack-guard}
20554 @itemx -mstack-size=@var{stack-size}
20555 @opindex mstack-guard
20556 @opindex mstack-size
20557 If these options are provided the S/390 back end emits additional instructions in
20558 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20559 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20560 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20561 the frame size of the compiled function is chosen.
20562 These options are intended to be used to help debugging stack overflow problems.
20563 The additionally emitted code causes only little overhead and hence can also be
20564 used in production-like systems without greater performance degradation.  The given
20565 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20566 @var{stack-guard} without exceeding 64k.
20567 In order to be efficient the extra code makes the assumption that the stack starts
20568 at an address aligned to the value given by @var{stack-size}.
20569 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20571 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20572 @opindex mhotpatch
20573 If the hotpatch option is enabled, a ``hot-patching'' function
20574 prologue is generated for all functions in the compilation unit.
20575 The funtion label is prepended with the given number of two-byte
20576 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20577 the label, 2 * @var{post-halfwords} bytes are appended, using the
20578 largest NOP like instructions the architecture allows (maximum
20579 1000000).
20581 If both arguments are zero, hotpatching is disabled.
20583 This option can be overridden for individual functions with the
20584 @code{hotpatch} attribute.
20585 @end table
20587 @node Score Options
20588 @subsection Score Options
20589 @cindex Score Options
20591 These options are defined for Score implementations:
20593 @table @gcctabopt
20594 @item -meb
20595 @opindex meb
20596 Compile code for big-endian mode.  This is the default.
20598 @item -mel
20599 @opindex mel
20600 Compile code for little-endian mode.
20602 @item -mnhwloop
20603 @opindex mnhwloop
20604 Disable generation of @code{bcnz} instructions.
20606 @item -muls
20607 @opindex muls
20608 Enable generation of unaligned load and store instructions.
20610 @item -mmac
20611 @opindex mmac
20612 Enable the use of multiply-accumulate instructions. Disabled by default.
20614 @item -mscore5
20615 @opindex mscore5
20616 Specify the SCORE5 as the target architecture.
20618 @item -mscore5u
20619 @opindex mscore5u
20620 Specify the SCORE5U of the target architecture.
20622 @item -mscore7
20623 @opindex mscore7
20624 Specify the SCORE7 as the target architecture. This is the default.
20626 @item -mscore7d
20627 @opindex mscore7d
20628 Specify the SCORE7D as the target architecture.
20629 @end table
20631 @node SH Options
20632 @subsection SH Options
20634 These @samp{-m} options are defined for the SH implementations:
20636 @table @gcctabopt
20637 @item -m1
20638 @opindex m1
20639 Generate code for the SH1.
20641 @item -m2
20642 @opindex m2
20643 Generate code for the SH2.
20645 @item -m2e
20646 Generate code for the SH2e.
20648 @item -m2a-nofpu
20649 @opindex m2a-nofpu
20650 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20651 that the floating-point unit is not used.
20653 @item -m2a-single-only
20654 @opindex m2a-single-only
20655 Generate code for the SH2a-FPU, in such a way that no double-precision
20656 floating-point operations are used.
20658 @item -m2a-single
20659 @opindex m2a-single
20660 Generate code for the SH2a-FPU assuming the floating-point unit is in
20661 single-precision mode by default.
20663 @item -m2a
20664 @opindex m2a
20665 Generate code for the SH2a-FPU assuming the floating-point unit is in
20666 double-precision mode by default.
20668 @item -m3
20669 @opindex m3
20670 Generate code for the SH3.
20672 @item -m3e
20673 @opindex m3e
20674 Generate code for the SH3e.
20676 @item -m4-nofpu
20677 @opindex m4-nofpu
20678 Generate code for the SH4 without a floating-point unit.
20680 @item -m4-single-only
20681 @opindex m4-single-only
20682 Generate code for the SH4 with a floating-point unit that only
20683 supports single-precision arithmetic.
20685 @item -m4-single
20686 @opindex m4-single
20687 Generate code for the SH4 assuming the floating-point unit is in
20688 single-precision mode by default.
20690 @item -m4
20691 @opindex m4
20692 Generate code for the SH4.
20694 @item -m4-100
20695 @opindex m4-100
20696 Generate code for SH4-100.
20698 @item -m4-100-nofpu
20699 @opindex m4-100-nofpu
20700 Generate code for SH4-100 in such a way that the
20701 floating-point unit is not used.
20703 @item -m4-100-single
20704 @opindex m4-100-single
20705 Generate code for SH4-100 assuming the floating-point unit is in
20706 single-precision mode by default.
20708 @item -m4-100-single-only
20709 @opindex m4-100-single-only
20710 Generate code for SH4-100 in such a way that no double-precision
20711 floating-point operations are used.
20713 @item -m4-200
20714 @opindex m4-200
20715 Generate code for SH4-200.
20717 @item -m4-200-nofpu
20718 @opindex m4-200-nofpu
20719 Generate code for SH4-200 without in such a way that the
20720 floating-point unit is not used.
20722 @item -m4-200-single
20723 @opindex m4-200-single
20724 Generate code for SH4-200 assuming the floating-point unit is in
20725 single-precision mode by default.
20727 @item -m4-200-single-only
20728 @opindex m4-200-single-only
20729 Generate code for SH4-200 in such a way that no double-precision
20730 floating-point operations are used.
20732 @item -m4-300
20733 @opindex m4-300
20734 Generate code for SH4-300.
20736 @item -m4-300-nofpu
20737 @opindex m4-300-nofpu
20738 Generate code for SH4-300 without in such a way that the
20739 floating-point unit is not used.
20741 @item -m4-300-single
20742 @opindex m4-300-single
20743 Generate code for SH4-300 in such a way that no double-precision
20744 floating-point operations are used.
20746 @item -m4-300-single-only
20747 @opindex m4-300-single-only
20748 Generate code for SH4-300 in such a way that no double-precision
20749 floating-point operations are used.
20751 @item -m4-340
20752 @opindex m4-340
20753 Generate code for SH4-340 (no MMU, no FPU).
20755 @item -m4-500
20756 @opindex m4-500
20757 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20758 assembler.
20760 @item -m4a-nofpu
20761 @opindex m4a-nofpu
20762 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20763 floating-point unit is not used.
20765 @item -m4a-single-only
20766 @opindex m4a-single-only
20767 Generate code for the SH4a, in such a way that no double-precision
20768 floating-point operations are used.
20770 @item -m4a-single
20771 @opindex m4a-single
20772 Generate code for the SH4a assuming the floating-point unit is in
20773 single-precision mode by default.
20775 @item -m4a
20776 @opindex m4a
20777 Generate code for the SH4a.
20779 @item -m4al
20780 @opindex m4al
20781 Same as @option{-m4a-nofpu}, except that it implicitly passes
20782 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20783 instructions at the moment.
20785 @item -m5-32media
20786 @opindex m5-32media
20787 Generate 32-bit code for SHmedia.
20789 @item -m5-32media-nofpu
20790 @opindex m5-32media-nofpu
20791 Generate 32-bit code for SHmedia in such a way that the
20792 floating-point unit is not used.
20794 @item -m5-64media
20795 @opindex m5-64media
20796 Generate 64-bit code for SHmedia.
20798 @item -m5-64media-nofpu
20799 @opindex m5-64media-nofpu
20800 Generate 64-bit code for SHmedia in such a way that the
20801 floating-point unit is not used.
20803 @item -m5-compact
20804 @opindex m5-compact
20805 Generate code for SHcompact.
20807 @item -m5-compact-nofpu
20808 @opindex m5-compact-nofpu
20809 Generate code for SHcompact in such a way that the
20810 floating-point unit is not used.
20812 @item -mb
20813 @opindex mb
20814 Compile code for the processor in big-endian mode.
20816 @item -ml
20817 @opindex ml
20818 Compile code for the processor in little-endian mode.
20820 @item -mdalign
20821 @opindex mdalign
20822 Align doubles at 64-bit boundaries.  Note that this changes the calling
20823 conventions, and thus some functions from the standard C library do
20824 not work unless you recompile it first with @option{-mdalign}.
20826 @item -mrelax
20827 @opindex mrelax
20828 Shorten some address references at link time, when possible; uses the
20829 linker option @option{-relax}.
20831 @item -mbigtable
20832 @opindex mbigtable
20833 Use 32-bit offsets in @code{switch} tables.  The default is to use
20834 16-bit offsets.
20836 @item -mbitops
20837 @opindex mbitops
20838 Enable the use of bit manipulation instructions on SH2A.
20840 @item -mfmovd
20841 @opindex mfmovd
20842 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20843 alignment constraints.
20845 @item -mrenesas
20846 @opindex mrenesas
20847 Comply with the calling conventions defined by Renesas.
20849 @item -mno-renesas
20850 @opindex mno-renesas
20851 Comply with the calling conventions defined for GCC before the Renesas
20852 conventions were available.  This option is the default for all
20853 targets of the SH toolchain.
20855 @item -mnomacsave
20856 @opindex mnomacsave
20857 Mark the @code{MAC} register as call-clobbered, even if
20858 @option{-mrenesas} is given.
20860 @item -mieee
20861 @itemx -mno-ieee
20862 @opindex mieee
20863 @opindex mno-ieee
20864 Control the IEEE compliance of floating-point comparisons, which affects the
20865 handling of cases where the result of a comparison is unordered.  By default
20866 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20867 enabled @option{-mno-ieee} is implicitly set, which results in faster
20868 floating-point greater-equal and less-equal comparisons.  The implcit settings
20869 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20871 @item -minline-ic_invalidate
20872 @opindex minline-ic_invalidate
20873 Inline code to invalidate instruction cache entries after setting up
20874 nested function trampolines.
20875 This option has no effect if @option{-musermode} is in effect and the selected
20876 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20877 instruction.
20878 If the selected code generation option does not allow the use of the @code{icbi}
20879 instruction, and @option{-musermode} is not in effect, the inlined code
20880 manipulates the instruction cache address array directly with an associative
20881 write.  This not only requires privileged mode at run time, but it also
20882 fails if the cache line had been mapped via the TLB and has become unmapped.
20884 @item -misize
20885 @opindex misize
20886 Dump instruction size and location in the assembly code.
20888 @item -mpadstruct
20889 @opindex mpadstruct
20890 This option is deprecated.  It pads structures to multiple of 4 bytes,
20891 which is incompatible with the SH ABI@.
20893 @item -matomic-model=@var{model}
20894 @opindex matomic-model=@var{model}
20895 Sets the model of atomic operations and additional parameters as a comma
20896 separated list.  For details on the atomic built-in functions see
20897 @ref{__atomic Builtins}.  The following models and parameters are supported:
20899 @table @samp
20901 @item none
20902 Disable compiler generated atomic sequences and emit library calls for atomic
20903 operations.  This is the default if the target is not @code{sh*-*-linux*}.
20905 @item soft-gusa
20906 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20907 built-in functions.  The generated atomic sequences require additional support
20908 from the interrupt/exception handling code of the system and are only suitable
20909 for SH3* and SH4* single-core systems.  This option is enabled by default when
20910 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20911 this option also partially utilizes the hardware atomic instructions
20912 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20913 @samp{strict} is specified.  
20915 @item soft-tcb
20916 Generate software atomic sequences that use a variable in the thread control
20917 block.  This is a variation of the gUSA sequences which can also be used on
20918 SH1* and SH2* targets.  The generated atomic sequences require additional
20919 support from the interrupt/exception handling code of the system and are only
20920 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20921 parameter has to be specified as well.
20923 @item soft-imask
20924 Generate software atomic sequences that temporarily disable interrupts by
20925 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20926 in privileged mode and is only suitable for single-core systems.  Additional
20927 support from the interrupt/exception handling code of the system is not
20928 required.  This model is enabled by default when the target is
20929 @code{sh*-*-linux*} and SH1* or SH2*.
20931 @item hard-llcs
20932 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20933 instructions only.  This is only available on SH4A and is suitable for
20934 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20935 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20936 Code compiled with this option is also compatible with other software
20937 atomic model interrupt/exception handling systems if executed on an SH4A
20938 system.  Additional support from the interrupt/exception handling code of the
20939 system is not required for this model.
20941 @item gbr-offset=
20942 This parameter specifies the offset in bytes of the variable in the thread
20943 control block structure that should be used by the generated atomic sequences
20944 when the @samp{soft-tcb} model has been selected.  For other models this
20945 parameter is ignored.  The specified value must be an integer multiple of four
20946 and in the range 0-1020.
20948 @item strict
20949 This parameter prevents mixed usage of multiple atomic models, even if they
20950 are compatible, and makes the compiler generate atomic sequences of the
20951 specified model only.
20953 @end table
20955 @item -mtas
20956 @opindex mtas
20957 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20958 Notice that depending on the particular hardware and software configuration
20959 this can degrade overall performance due to the operand cache line flushes
20960 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20961 processors the @code{tas.b} instruction must be used with caution since it
20962 can result in data corruption for certain cache configurations.
20964 @item -mprefergot
20965 @opindex mprefergot
20966 When generating position-independent code, emit function calls using
20967 the Global Offset Table instead of the Procedure Linkage Table.
20969 @item -musermode
20970 @itemx -mno-usermode
20971 @opindex musermode
20972 @opindex mno-usermode
20973 Don't allow (allow) the compiler generating privileged mode code.  Specifying
20974 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
20975 inlined code would not work in user mode.  @option{-musermode} is the default
20976 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
20977 @option{-musermode} has no effect, since there is no user mode.
20979 @item -multcost=@var{number}
20980 @opindex multcost=@var{number}
20981 Set the cost to assume for a multiply insn.
20983 @item -mdiv=@var{strategy}
20984 @opindex mdiv=@var{strategy}
20985 Set the division strategy to be used for integer division operations.
20986 For SHmedia @var{strategy} can be one of: 
20988 @table @samp
20990 @item fp 
20991 Performs the operation in floating point.  This has a very high latency,
20992 but needs only a few instructions, so it might be a good choice if
20993 your code has enough easily-exploitable ILP to allow the compiler to
20994 schedule the floating-point instructions together with other instructions.
20995 Division by zero causes a floating-point exception.
20997 @item inv
20998 Uses integer operations to calculate the inverse of the divisor,
20999 and then multiplies the dividend with the inverse.  This strategy allows
21000 CSE and hoisting of the inverse calculation.  Division by zero calculates
21001 an unspecified result, but does not trap.
21003 @item inv:minlat
21004 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21005 have been found, or if the entire operation has been hoisted to the same
21006 place, the last stages of the inverse calculation are intertwined with the
21007 final multiply to reduce the overall latency, at the expense of using a few
21008 more instructions, and thus offering fewer scheduling opportunities with
21009 other code.
21011 @item call
21012 Calls a library function that usually implements the @samp{inv:minlat}
21013 strategy.
21014 This gives high code density for @code{m5-*media-nofpu} compilations.
21016 @item call2
21017 Uses a different entry point of the same library function, where it
21018 assumes that a pointer to a lookup table has already been set up, which
21019 exposes the pointer load to CSE and code hoisting optimizations.
21021 @item inv:call
21022 @itemx inv:call2
21023 @itemx inv:fp
21024 Use the @samp{inv} algorithm for initial
21025 code generation, but if the code stays unoptimized, revert to the @samp{call},
21026 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21027 potentially-trapping side effect of division by zero is carried by a
21028 separate instruction, so it is possible that all the integer instructions
21029 are hoisted out, but the marker for the side effect stays where it is.
21030 A recombination to floating-point operations or a call is not possible
21031 in that case.
21033 @item inv20u
21034 @itemx inv20l
21035 Variants of the @samp{inv:minlat} strategy.  In the case
21036 that the inverse calculation is not separated from the multiply, they speed
21037 up division where the dividend fits into 20 bits (plus sign where applicable)
21038 by inserting a test to skip a number of operations in this case; this test
21039 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21040 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21042 @end table
21044 For targets other than SHmedia @var{strategy} can be one of:
21046 @table @samp
21048 @item call-div1
21049 Calls a library function that uses the single-step division instruction
21050 @code{div1} to perform the operation.  Division by zero calculates an
21051 unspecified result and does not trap.  This is the default except for SH4,
21052 SH2A and SHcompact.
21054 @item call-fp
21055 Calls a library function that performs the operation in double precision
21056 floating point.  Division by zero causes a floating-point exception.  This is
21057 the default for SHcompact with FPU.  Specifying this for targets that do not
21058 have a double precision FPU defaults to @code{call-div1}.
21060 @item call-table
21061 Calls a library function that uses a lookup table for small divisors and
21062 the @code{div1} instruction with case distinction for larger divisors.  Division
21063 by zero calculates an unspecified result and does not trap.  This is the default
21064 for SH4.  Specifying this for targets that do not have dynamic shift
21065 instructions defaults to @code{call-div1}.
21067 @end table
21069 When a division strategy has not been specified the default strategy is
21070 selected based on the current target.  For SH2A the default strategy is to
21071 use the @code{divs} and @code{divu} instructions instead of library function
21072 calls.
21074 @item -maccumulate-outgoing-args
21075 @opindex maccumulate-outgoing-args
21076 Reserve space once for outgoing arguments in the function prologue rather
21077 than around each call.  Generally beneficial for performance and size.  Also
21078 needed for unwinding to avoid changing the stack frame around conditional code.
21080 @item -mdivsi3_libfunc=@var{name}
21081 @opindex mdivsi3_libfunc=@var{name}
21082 Set the name of the library function used for 32-bit signed division to
21083 @var{name}.
21084 This only affects the name used in the @samp{call} and @samp{inv:call}
21085 division strategies, and the compiler still expects the same
21086 sets of input/output/clobbered registers as if this option were not present.
21088 @item -mfixed-range=@var{register-range}
21089 @opindex mfixed-range
21090 Generate code treating the given register range as fixed registers.
21091 A fixed register is one that the register allocator can not use.  This is
21092 useful when compiling kernel code.  A register range is specified as
21093 two registers separated by a dash.  Multiple register ranges can be
21094 specified separated by a comma.
21096 @item -mindexed-addressing
21097 @opindex mindexed-addressing
21098 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21099 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21100 semantics for the indexed addressing mode.  The architecture allows the
21101 implementation of processors with 64-bit MMU, which the OS could use to
21102 get 32-bit addressing, but since no current hardware implementation supports
21103 this or any other way to make the indexed addressing mode safe to use in
21104 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21106 @item -mgettrcost=@var{number}
21107 @opindex mgettrcost=@var{number}
21108 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21109 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21111 @item -mpt-fixed
21112 @opindex mpt-fixed
21113 Assume @code{pt*} instructions won't trap.  This generally generates
21114 better-scheduled code, but is unsafe on current hardware.
21115 The current architecture
21116 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21117 anded with 3 is 3.
21118 This has the unintentional effect of making it unsafe to schedule these
21119 instructions before a branch, or hoist them out of a loop.  For example,
21120 @code{__do_global_ctors}, a part of @file{libgcc}
21121 that runs constructors at program
21122 startup, calls functions in a list which is delimited by @minus{}1.  With the
21123 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21124 That means that all the constructors run a bit more quickly, but when
21125 the loop comes to the end of the list, the program crashes because @code{ptabs}
21126 loads @minus{}1 into a target register.  
21128 Since this option is unsafe for any
21129 hardware implementing the current architecture specification, the default
21130 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21131 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21132 this deters register allocation from using target registers for storing
21133 ordinary integers.
21135 @item -minvalid-symbols
21136 @opindex minvalid-symbols
21137 Assume symbols might be invalid.  Ordinary function symbols generated by
21138 the compiler are always valid to load with
21139 @code{movi}/@code{shori}/@code{ptabs} or
21140 @code{movi}/@code{shori}/@code{ptrel},
21141 but with assembler and/or linker tricks it is possible
21142 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21143 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21144 It prevents cross-basic-block CSE, hoisting and most scheduling
21145 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21147 @item -mbranch-cost=@var{num}
21148 @opindex mbranch-cost=@var{num}
21149 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21150 make the compiler try to generate more branch-free code if possible.  
21151 If not specified the value is selected depending on the processor type that
21152 is being compiled for.
21154 @item -mzdcbranch
21155 @itemx -mno-zdcbranch
21156 @opindex mzdcbranch
21157 @opindex mno-zdcbranch
21158 Assume (do not assume) that zero displacement conditional branch instructions
21159 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21160 compiler prefers zero displacement branch code sequences.  This is
21161 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21162 disabled by specifying @option{-mno-zdcbranch}.
21164 @item -mcbranch-force-delay-slot
21165 @opindex mcbranch-force-delay-slot
21166 Force the usage of delay slots for conditional branches, which stuffs the delay
21167 slot with a @code{nop} if a suitable instruction can't be found.  By default
21168 this option is disabled.  It can be enabled to work around hardware bugs as
21169 found in the original SH7055.
21171 @item -mfused-madd
21172 @itemx -mno-fused-madd
21173 @opindex mfused-madd
21174 @opindex mno-fused-madd
21175 Generate code that uses (does not use) the floating-point multiply and
21176 accumulate instructions.  These instructions are generated by default
21177 if hardware floating point is used.  The machine-dependent
21178 @option{-mfused-madd} option is now mapped to the machine-independent
21179 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21180 mapped to @option{-ffp-contract=off}.
21182 @item -mfsca
21183 @itemx -mno-fsca
21184 @opindex mfsca
21185 @opindex mno-fsca
21186 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21187 and cosine approximations.  The option @option{-mfsca} must be used in
21188 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21189 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21190 approximations even if @option{-funsafe-math-optimizations} is in effect.
21192 @item -mfsrra
21193 @itemx -mno-fsrra
21194 @opindex mfsrra
21195 @opindex mno-fsrra
21196 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21197 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21198 in combination with @option{-funsafe-math-optimizations} and
21199 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21200 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21201 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21202 in effect.
21204 @item -mpretend-cmove
21205 @opindex mpretend-cmove
21206 Prefer zero-displacement conditional branches for conditional move instruction
21207 patterns.  This can result in faster code on the SH4 processor.
21209 @end table
21211 @node Solaris 2 Options
21212 @subsection Solaris 2 Options
21213 @cindex Solaris 2 options
21215 These @samp{-m} options are supported on Solaris 2:
21217 @table @gcctabopt
21218 @item -mclear-hwcap
21219 @opindex mclear-hwcap
21220 @option{-mclear-hwcap} tells the compiler to remove the hardware
21221 capabilities generated by the Solaris assembler.  This is only necessary
21222 when object files use ISA extensions not supported by the current
21223 machine, but check at runtime whether or not to use them.
21225 @item -mimpure-text
21226 @opindex mimpure-text
21227 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21228 the compiler to not pass @option{-z text} to the linker when linking a
21229 shared object.  Using this option, you can link position-dependent
21230 code into a shared object.
21232 @option{-mimpure-text} suppresses the ``relocations remain against
21233 allocatable but non-writable sections'' linker error message.
21234 However, the necessary relocations trigger copy-on-write, and the
21235 shared object is not actually shared across processes.  Instead of
21236 using @option{-mimpure-text}, you should compile all source code with
21237 @option{-fpic} or @option{-fPIC}.
21239 @end table
21241 These switches are supported in addition to the above on Solaris 2:
21243 @table @gcctabopt
21244 @item -pthreads
21245 @opindex pthreads
21246 Add support for multithreading using the POSIX threads library.  This
21247 option sets flags for both the preprocessor and linker.  This option does
21248 not affect the thread safety of object code produced  by the compiler or
21249 that of libraries supplied with it.
21251 @item -pthread
21252 @opindex pthread
21253 This is a synonym for @option{-pthreads}.
21254 @end table
21256 @node SPARC Options
21257 @subsection SPARC Options
21258 @cindex SPARC options
21260 These @samp{-m} options are supported on the SPARC:
21262 @table @gcctabopt
21263 @item -mno-app-regs
21264 @itemx -mapp-regs
21265 @opindex mno-app-regs
21266 @opindex mapp-regs
21267 Specify @option{-mapp-regs} to generate output using the global registers
21268 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21269 global register 1, each global register 2 through 4 is then treated as an
21270 allocable register that is clobbered by function calls.  This is the default.
21272 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21273 specify @option{-mno-app-regs}.  You should compile libraries and system
21274 software with this option.
21276 @item -mflat
21277 @itemx -mno-flat
21278 @opindex mflat
21279 @opindex mno-flat
21280 With @option{-mflat}, the compiler does not generate save/restore instructions
21281 and uses a ``flat'' or single register window model.  This model is compatible
21282 with the regular register window model.  The local registers and the input
21283 registers (0--5) are still treated as ``call-saved'' registers and are
21284 saved on the stack as needed.
21286 With @option{-mno-flat} (the default), the compiler generates save/restore
21287 instructions (except for leaf functions).  This is the normal operating mode.
21289 @item -mfpu
21290 @itemx -mhard-float
21291 @opindex mfpu
21292 @opindex mhard-float
21293 Generate output containing floating-point instructions.  This is the
21294 default.
21296 @item -mno-fpu
21297 @itemx -msoft-float
21298 @opindex mno-fpu
21299 @opindex msoft-float
21300 Generate output containing library calls for floating point.
21301 @strong{Warning:} the requisite libraries are not available for all SPARC
21302 targets.  Normally the facilities of the machine's usual C compiler are
21303 used, but this cannot be done directly in cross-compilation.  You must make
21304 your own arrangements to provide suitable library functions for
21305 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21306 @samp{sparclite-*-*} do provide software floating-point support.
21308 @option{-msoft-float} changes the calling convention in the output file;
21309 therefore, it is only useful if you compile @emph{all} of a program with
21310 this option.  In particular, you need to compile @file{libgcc.a}, the
21311 library that comes with GCC, with @option{-msoft-float} in order for
21312 this to work.
21314 @item -mhard-quad-float
21315 @opindex mhard-quad-float
21316 Generate output containing quad-word (long double) floating-point
21317 instructions.
21319 @item -msoft-quad-float
21320 @opindex msoft-quad-float
21321 Generate output containing library calls for quad-word (long double)
21322 floating-point instructions.  The functions called are those specified
21323 in the SPARC ABI@.  This is the default.
21325 As of this writing, there are no SPARC implementations that have hardware
21326 support for the quad-word floating-point instructions.  They all invoke
21327 a trap handler for one of these instructions, and then the trap handler
21328 emulates the effect of the instruction.  Because of the trap handler overhead,
21329 this is much slower than calling the ABI library routines.  Thus the
21330 @option{-msoft-quad-float} option is the default.
21332 @item -mno-unaligned-doubles
21333 @itemx -munaligned-doubles
21334 @opindex mno-unaligned-doubles
21335 @opindex munaligned-doubles
21336 Assume that doubles have 8-byte alignment.  This is the default.
21338 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21339 alignment only if they are contained in another type, or if they have an
21340 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21341 Specifying this option avoids some rare compatibility problems with code
21342 generated by other compilers.  It is not the default because it results
21343 in a performance loss, especially for floating-point code.
21345 @item -muser-mode
21346 @itemx -mno-user-mode
21347 @opindex muser-mode
21348 @opindex mno-user-mode
21349 Do not generate code that can only run in supervisor mode.  This is relevant
21350 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21351 default is @option{-mno-user-mode}.
21353 @item -mno-faster-structs
21354 @itemx -mfaster-structs
21355 @opindex mno-faster-structs
21356 @opindex mfaster-structs
21357 With @option{-mfaster-structs}, the compiler assumes that structures
21358 should have 8-byte alignment.  This enables the use of pairs of
21359 @code{ldd} and @code{std} instructions for copies in structure
21360 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21361 However, the use of this changed alignment directly violates the SPARC
21362 ABI@.  Thus, it's intended only for use on targets where the developer
21363 acknowledges that their resulting code is not directly in line with
21364 the rules of the ABI@.
21366 @item -mcpu=@var{cpu_type}
21367 @opindex mcpu
21368 Set the instruction set, register set, and instruction scheduling parameters
21369 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21370 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21371 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21372 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21373 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21374 @samp{niagara3} and @samp{niagara4}.
21376 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21377 which selects the best architecture option for the host processor.
21378 @option{-mcpu=native} has no effect if GCC does not recognize
21379 the processor.
21381 Default instruction scheduling parameters are used for values that select
21382 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21383 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21385 Here is a list of each supported architecture and their supported
21386 implementations.
21388 @table @asis
21389 @item v7
21390 cypress, leon3v7
21392 @item v8
21393 supersparc, hypersparc, leon, leon3
21395 @item sparclite
21396 f930, f934, sparclite86x
21398 @item sparclet
21399 tsc701
21401 @item v9
21402 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21403 @end table
21405 By default (unless configured otherwise), GCC generates code for the V7
21406 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21407 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21408 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21409 SPARCStation 1, 2, IPX etc.
21411 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21412 architecture.  The only difference from V7 code is that the compiler emits
21413 the integer multiply and integer divide instructions which exist in SPARC-V8
21414 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21415 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21416 2000 series.
21418 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21419 the SPARC architecture.  This adds the integer multiply, integer divide step
21420 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21421 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21422 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21423 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21424 MB86934 chip, which is the more recent SPARClite with FPU@.
21426 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21427 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21428 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21429 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21430 optimizes it for the TEMIC SPARClet chip.
21432 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21433 architecture.  This adds 64-bit integer and floating-point move instructions,
21434 3 additional floating-point condition code registers and conditional move
21435 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21436 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21437 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21438 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21439 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21440 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21441 additionally optimizes it for Sun UltraSPARC T2 chips. With
21442 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21443 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21444 additionally optimizes it for Sun UltraSPARC T4 chips.
21446 @item -mtune=@var{cpu_type}
21447 @opindex mtune
21448 Set the instruction scheduling parameters for machine type
21449 @var{cpu_type}, but do not set the instruction set or register set that the
21450 option @option{-mcpu=@var{cpu_type}} does.
21452 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21453 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21454 that select a particular CPU implementation.  Those are @samp{cypress},
21455 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21456 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21457 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21458 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21459 toolchains, @samp{native} can also be used.
21461 @item -mv8plus
21462 @itemx -mno-v8plus
21463 @opindex mv8plus
21464 @opindex mno-v8plus
21465 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21466 difference from the V8 ABI is that the global and out registers are
21467 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21468 mode for all SPARC-V9 processors.
21470 @item -mvis
21471 @itemx -mno-vis
21472 @opindex mvis
21473 @opindex mno-vis
21474 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21475 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21477 @item -mvis2
21478 @itemx -mno-vis2
21479 @opindex mvis2
21480 @opindex mno-vis2
21481 With @option{-mvis2}, GCC generates code that takes advantage of
21482 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21483 default is @option{-mvis2} when targeting a cpu that supports such
21484 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21485 also sets @option{-mvis}.
21487 @item -mvis3
21488 @itemx -mno-vis3
21489 @opindex mvis3
21490 @opindex mno-vis3
21491 With @option{-mvis3}, GCC generates code that takes advantage of
21492 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21493 default is @option{-mvis3} when targeting a cpu that supports such
21494 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21495 also sets @option{-mvis2} and @option{-mvis}.
21497 @item -mcbcond
21498 @itemx -mno-cbcond
21499 @opindex mcbcond
21500 @opindex mno-cbcond
21501 With @option{-mcbcond}, GCC generates code that takes advantage of
21502 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21503 The default is @option{-mcbcond} when targeting a cpu that supports such
21504 instructions, such as niagara-4 and later.
21506 @item -mpopc
21507 @itemx -mno-popc
21508 @opindex mpopc
21509 @opindex mno-popc
21510 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21511 population count instruction.  The default is @option{-mpopc}
21512 when targeting a cpu that supports such instructions, such as Niagara-2 and
21513 later.
21515 @item -mfmaf
21516 @itemx -mno-fmaf
21517 @opindex mfmaf
21518 @opindex mno-fmaf
21519 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21520 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21521 when targeting a cpu that supports such instructions, such as Niagara-3 and
21522 later.
21524 @item -mfix-at697f
21525 @opindex mfix-at697f
21526 Enable the documented workaround for the single erratum of the Atmel AT697F
21527 processor (which corresponds to erratum #13 of the AT697E processor).
21529 @item -mfix-ut699
21530 @opindex mfix-ut699
21531 Enable the documented workarounds for the floating-point errata and the data
21532 cache nullify errata of the UT699 processor.
21533 @end table
21535 These @samp{-m} options are supported in addition to the above
21536 on SPARC-V9 processors in 64-bit environments:
21538 @table @gcctabopt
21539 @item -m32
21540 @itemx -m64
21541 @opindex m32
21542 @opindex m64
21543 Generate code for a 32-bit or 64-bit environment.
21544 The 32-bit environment sets int, long and pointer to 32 bits.
21545 The 64-bit environment sets int to 32 bits and long and pointer
21546 to 64 bits.
21548 @item -mcmodel=@var{which}
21549 @opindex mcmodel
21550 Set the code model to one of
21552 @table @samp
21553 @item medlow
21554 The Medium/Low code model: 64-bit addresses, programs
21555 must be linked in the low 32 bits of memory.  Programs can be statically
21556 or dynamically linked.
21558 @item medmid
21559 The Medium/Middle code model: 64-bit addresses, programs
21560 must be linked in the low 44 bits of memory, the text and data segments must
21561 be less than 2GB in size and the data segment must be located within 2GB of
21562 the text segment.
21564 @item medany
21565 The Medium/Anywhere code model: 64-bit addresses, programs
21566 may be linked anywhere in memory, the text and data segments must be less
21567 than 2GB in size and the data segment must be located within 2GB of the
21568 text segment.
21570 @item embmedany
21571 The Medium/Anywhere code model for embedded systems:
21572 64-bit addresses, the text and data segments must be less than 2GB in
21573 size, both starting anywhere in memory (determined at link time).  The
21574 global register %g4 points to the base of the data segment.  Programs
21575 are statically linked and PIC is not supported.
21576 @end table
21578 @item -mmemory-model=@var{mem-model}
21579 @opindex mmemory-model
21580 Set the memory model in force on the processor to one of
21582 @table @samp
21583 @item default
21584 The default memory model for the processor and operating system.
21586 @item rmo
21587 Relaxed Memory Order
21589 @item pso
21590 Partial Store Order
21592 @item tso
21593 Total Store Order
21595 @item sc
21596 Sequential Consistency
21597 @end table
21599 These memory models are formally defined in Appendix D of the Sparc V9
21600 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21602 @item -mstack-bias
21603 @itemx -mno-stack-bias
21604 @opindex mstack-bias
21605 @opindex mno-stack-bias
21606 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21607 frame pointer if present, are offset by @minus{}2047 which must be added back
21608 when making stack frame references.  This is the default in 64-bit mode.
21609 Otherwise, assume no such offset is present.
21610 @end table
21612 @node SPU Options
21613 @subsection SPU Options
21614 @cindex SPU options
21616 These @samp{-m} options are supported on the SPU:
21618 @table @gcctabopt
21619 @item -mwarn-reloc
21620 @itemx -merror-reloc
21621 @opindex mwarn-reloc
21622 @opindex merror-reloc
21624 The loader for SPU does not handle dynamic relocations.  By default, GCC
21625 gives an error when it generates code that requires a dynamic
21626 relocation.  @option{-mno-error-reloc} disables the error,
21627 @option{-mwarn-reloc} generates a warning instead.
21629 @item -msafe-dma
21630 @itemx -munsafe-dma
21631 @opindex msafe-dma
21632 @opindex munsafe-dma
21634 Instructions that initiate or test completion of DMA must not be
21635 reordered with respect to loads and stores of the memory that is being
21636 accessed.
21637 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21638 memory accesses, but that can lead to inefficient code in places where the
21639 memory is known to not change.  Rather than mark the memory as volatile,
21640 you can use @option{-msafe-dma} to tell the compiler to treat
21641 the DMA instructions as potentially affecting all memory.  
21643 @item -mbranch-hints
21644 @opindex mbranch-hints
21646 By default, GCC generates a branch hint instruction to avoid
21647 pipeline stalls for always-taken or probably-taken branches.  A hint
21648 is not generated closer than 8 instructions away from its branch.
21649 There is little reason to disable them, except for debugging purposes,
21650 or to make an object a little bit smaller.
21652 @item -msmall-mem
21653 @itemx -mlarge-mem
21654 @opindex msmall-mem
21655 @opindex mlarge-mem
21657 By default, GCC generates code assuming that addresses are never larger
21658 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21659 a full 32-bit address.
21661 @item -mstdmain
21662 @opindex mstdmain
21664 By default, GCC links against startup code that assumes the SPU-style
21665 main function interface (which has an unconventional parameter list).
21666 With @option{-mstdmain}, GCC links your program against startup
21667 code that assumes a C99-style interface to @code{main}, including a
21668 local copy of @code{argv} strings.
21670 @item -mfixed-range=@var{register-range}
21671 @opindex mfixed-range
21672 Generate code treating the given register range as fixed registers.
21673 A fixed register is one that the register allocator cannot use.  This is
21674 useful when compiling kernel code.  A register range is specified as
21675 two registers separated by a dash.  Multiple register ranges can be
21676 specified separated by a comma.
21678 @item -mea32
21679 @itemx -mea64
21680 @opindex mea32
21681 @opindex mea64
21682 Compile code assuming that pointers to the PPU address space accessed
21683 via the @code{__ea} named address space qualifier are either 32 or 64
21684 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21685 all object code in an executable must be compiled with the same setting.
21687 @item -maddress-space-conversion
21688 @itemx -mno-address-space-conversion
21689 @opindex maddress-space-conversion
21690 @opindex mno-address-space-conversion
21691 Allow/disallow treating the @code{__ea} address space as superset
21692 of the generic address space.  This enables explicit type casts
21693 between @code{__ea} and generic pointer as well as implicit
21694 conversions of generic pointers to @code{__ea} pointers.  The
21695 default is to allow address space pointer conversions.
21697 @item -mcache-size=@var{cache-size}
21698 @opindex mcache-size
21699 This option controls the version of libgcc that the compiler links to an
21700 executable and selects a software-managed cache for accessing variables
21701 in the @code{__ea} address space with a particular cache size.  Possible
21702 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21703 and @samp{128}.  The default cache size is 64KB.
21705 @item -matomic-updates
21706 @itemx -mno-atomic-updates
21707 @opindex matomic-updates
21708 @opindex mno-atomic-updates
21709 This option controls the version of libgcc that the compiler links to an
21710 executable and selects whether atomic updates to the software-managed
21711 cache of PPU-side variables are used.  If you use atomic updates, changes
21712 to a PPU variable from SPU code using the @code{__ea} named address space
21713 qualifier do not interfere with changes to other PPU variables residing
21714 in the same cache line from PPU code.  If you do not use atomic updates,
21715 such interference may occur; however, writing back cache lines is
21716 more efficient.  The default behavior is to use atomic updates.
21718 @item -mdual-nops
21719 @itemx -mdual-nops=@var{n}
21720 @opindex mdual-nops
21721 By default, GCC inserts nops to increase dual issue when it expects
21722 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21723 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21724 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21726 @item -mhint-max-nops=@var{n}
21727 @opindex mhint-max-nops
21728 Maximum number of nops to insert for a branch hint.  A branch hint must
21729 be at least 8 instructions away from the branch it is affecting.  GCC
21730 inserts up to @var{n} nops to enforce this, otherwise it does not
21731 generate the branch hint.
21733 @item -mhint-max-distance=@var{n}
21734 @opindex mhint-max-distance
21735 The encoding of the branch hint instruction limits the hint to be within
21736 256 instructions of the branch it is affecting.  By default, GCC makes
21737 sure it is within 125.
21739 @item -msafe-hints
21740 @opindex msafe-hints
21741 Work around a hardware bug that causes the SPU to stall indefinitely.
21742 By default, GCC inserts the @code{hbrp} instruction to make sure
21743 this stall won't happen.
21745 @end table
21747 @node System V Options
21748 @subsection Options for System V
21750 These additional options are available on System V Release 4 for
21751 compatibility with other compilers on those systems:
21753 @table @gcctabopt
21754 @item -G
21755 @opindex G
21756 Create a shared object.
21757 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21759 @item -Qy
21760 @opindex Qy
21761 Identify the versions of each tool used by the compiler, in a
21762 @code{.ident} assembler directive in the output.
21764 @item -Qn
21765 @opindex Qn
21766 Refrain from adding @code{.ident} directives to the output file (this is
21767 the default).
21769 @item -YP,@var{dirs}
21770 @opindex YP
21771 Search the directories @var{dirs}, and no others, for libraries
21772 specified with @option{-l}.
21774 @item -Ym,@var{dir}
21775 @opindex Ym
21776 Look in the directory @var{dir} to find the M4 preprocessor.
21777 The assembler uses this option.
21778 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21779 @c the generic assembler that comes with Solaris takes just -Ym.
21780 @end table
21782 @node TILE-Gx Options
21783 @subsection TILE-Gx Options
21784 @cindex TILE-Gx options
21786 These @samp{-m} options are supported on the TILE-Gx:
21788 @table @gcctabopt
21789 @item -mcmodel=small
21790 @opindex mcmodel=small
21791 Generate code for the small model.  The distance for direct calls is
21792 limited to 500M in either direction.  PC-relative addresses are 32
21793 bits.  Absolute addresses support the full address range.
21795 @item -mcmodel=large
21796 @opindex mcmodel=large
21797 Generate code for the large model.  There is no limitation on call
21798 distance, pc-relative addresses, or absolute addresses.
21800 @item -mcpu=@var{name}
21801 @opindex mcpu
21802 Selects the type of CPU to be targeted.  Currently the only supported
21803 type is @samp{tilegx}.
21805 @item -m32
21806 @itemx -m64
21807 @opindex m32
21808 @opindex m64
21809 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21810 environment sets int, long, and pointer to 32 bits.  The 64-bit
21811 environment sets int to 32 bits and long and pointer to 64 bits.
21813 @item -mbig-endian
21814 @itemx -mlittle-endian
21815 @opindex mbig-endian
21816 @opindex mlittle-endian
21817 Generate code in big/little endian mode, respectively.
21818 @end table
21820 @node TILEPro Options
21821 @subsection TILEPro Options
21822 @cindex TILEPro options
21824 These @samp{-m} options are supported on the TILEPro:
21826 @table @gcctabopt
21827 @item -mcpu=@var{name}
21828 @opindex mcpu
21829 Selects the type of CPU to be targeted.  Currently the only supported
21830 type is @samp{tilepro}.
21832 @item -m32
21833 @opindex m32
21834 Generate code for a 32-bit environment, which sets int, long, and
21835 pointer to 32 bits.  This is the only supported behavior so the flag
21836 is essentially ignored.
21837 @end table
21839 @node V850 Options
21840 @subsection V850 Options
21841 @cindex V850 Options
21843 These @samp{-m} options are defined for V850 implementations:
21845 @table @gcctabopt
21846 @item -mlong-calls
21847 @itemx -mno-long-calls
21848 @opindex mlong-calls
21849 @opindex mno-long-calls
21850 Treat all calls as being far away (near).  If calls are assumed to be
21851 far away, the compiler always loads the function's address into a
21852 register, and calls indirect through the pointer.
21854 @item -mno-ep
21855 @itemx -mep
21856 @opindex mno-ep
21857 @opindex mep
21858 Do not optimize (do optimize) basic blocks that use the same index
21859 pointer 4 or more times to copy pointer into the @code{ep} register, and
21860 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21861 option is on by default if you optimize.
21863 @item -mno-prolog-function
21864 @itemx -mprolog-function
21865 @opindex mno-prolog-function
21866 @opindex mprolog-function
21867 Do not use (do use) external functions to save and restore registers
21868 at the prologue and epilogue of a function.  The external functions
21869 are slower, but use less code space if more than one function saves
21870 the same number of registers.  The @option{-mprolog-function} option
21871 is on by default if you optimize.
21873 @item -mspace
21874 @opindex mspace
21875 Try to make the code as small as possible.  At present, this just turns
21876 on the @option{-mep} and @option{-mprolog-function} options.
21878 @item -mtda=@var{n}
21879 @opindex mtda
21880 Put static or global variables whose size is @var{n} bytes or less into
21881 the tiny data area that register @code{ep} points to.  The tiny data
21882 area can hold up to 256 bytes in total (128 bytes for byte references).
21884 @item -msda=@var{n}
21885 @opindex msda
21886 Put static or global variables whose size is @var{n} bytes or less into
21887 the small data area that register @code{gp} points to.  The small data
21888 area can hold up to 64 kilobytes.
21890 @item -mzda=@var{n}
21891 @opindex mzda
21892 Put static or global variables whose size is @var{n} bytes or less into
21893 the first 32 kilobytes of memory.
21895 @item -mv850
21896 @opindex mv850
21897 Specify that the target processor is the V850.
21899 @item -mv850e3v5
21900 @opindex mv850e3v5
21901 Specify that the target processor is the V850E3V5.  The preprocessor
21902 constant @code{__v850e3v5__} is defined if this option is used.
21904 @item -mv850e2v4
21905 @opindex mv850e2v4
21906 Specify that the target processor is the V850E3V5.  This is an alias for
21907 the @option{-mv850e3v5} option.
21909 @item -mv850e2v3
21910 @opindex mv850e2v3
21911 Specify that the target processor is the V850E2V3.  The preprocessor
21912 constant @code{__v850e2v3__} is defined if this option is used.
21914 @item -mv850e2
21915 @opindex mv850e2
21916 Specify that the target processor is the V850E2.  The preprocessor
21917 constant @code{__v850e2__} is defined if this option is used.
21919 @item -mv850e1
21920 @opindex mv850e1
21921 Specify that the target processor is the V850E1.  The preprocessor
21922 constants @code{__v850e1__} and @code{__v850e__} are defined if
21923 this option is used.
21925 @item -mv850es
21926 @opindex mv850es
21927 Specify that the target processor is the V850ES.  This is an alias for
21928 the @option{-mv850e1} option.
21930 @item -mv850e
21931 @opindex mv850e
21932 Specify that the target processor is the V850E@.  The preprocessor
21933 constant @code{__v850e__} is defined if this option is used.
21935 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21936 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21937 are defined then a default target processor is chosen and the
21938 relevant @samp{__v850*__} preprocessor constant is defined.
21940 The preprocessor constants @code{__v850} and @code{__v851__} are always
21941 defined, regardless of which processor variant is the target.
21943 @item -mdisable-callt
21944 @itemx -mno-disable-callt
21945 @opindex mdisable-callt
21946 @opindex mno-disable-callt
21947 This option suppresses generation of the @code{CALLT} instruction for the
21948 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21949 architecture.
21951 This option is enabled by default when the RH850 ABI is
21952 in use (see @option{-mrh850-abi}), and disabled by default when the
21953 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21954 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
21956 @item -mrelax
21957 @itemx -mno-relax
21958 @opindex mrelax
21959 @opindex mno-relax
21960 Pass on (or do not pass on) the @option{-mrelax} command-line option
21961 to the assembler.
21963 @item -mlong-jumps
21964 @itemx -mno-long-jumps
21965 @opindex mlong-jumps
21966 @opindex mno-long-jumps
21967 Disable (or re-enable) the generation of PC-relative jump instructions.
21969 @item -msoft-float
21970 @itemx -mhard-float
21971 @opindex msoft-float
21972 @opindex mhard-float
21973 Disable (or re-enable) the generation of hardware floating point
21974 instructions.  This option is only significant when the target
21975 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21976 instructions are being generated then the C preprocessor symbol
21977 @code{__FPU_OK__} is defined, otherwise the symbol
21978 @code{__NO_FPU__} is defined.
21980 @item -mloop
21981 @opindex mloop
21982 Enables the use of the e3v5 LOOP instruction.  The use of this
21983 instruction is not enabled by default when the e3v5 architecture is
21984 selected because its use is still experimental.
21986 @item -mrh850-abi
21987 @itemx -mghs
21988 @opindex mrh850-abi
21989 @opindex mghs
21990 Enables support for the RH850 version of the V850 ABI.  This is the
21991 default.  With this version of the ABI the following rules apply:
21993 @itemize
21994 @item
21995 Integer sized structures and unions are returned via a memory pointer
21996 rather than a register.
21998 @item
21999 Large structures and unions (more than 8 bytes in size) are passed by
22000 value.
22002 @item
22003 Functions are aligned to 16-bit boundaries.
22005 @item
22006 The @option{-m8byte-align} command-line option is supported.
22008 @item
22009 The @option{-mdisable-callt} command-line option is enabled by
22010 default.  The @option{-mno-disable-callt} command-line option is not
22011 supported.
22012 @end itemize
22014 When this version of the ABI is enabled the C preprocessor symbol
22015 @code{__V850_RH850_ABI__} is defined.
22017 @item -mgcc-abi
22018 @opindex mgcc-abi
22019 Enables support for the old GCC version of the V850 ABI.  With this
22020 version of the ABI the following rules apply:
22022 @itemize
22023 @item
22024 Integer sized structures and unions are returned in register @code{r10}.
22026 @item
22027 Large structures and unions (more than 8 bytes in size) are passed by
22028 reference.
22030 @item
22031 Functions are aligned to 32-bit boundaries, unless optimizing for
22032 size.
22034 @item
22035 The @option{-m8byte-align} command-line option is not supported.
22037 @item
22038 The @option{-mdisable-callt} command-line option is supported but not
22039 enabled by default.
22040 @end itemize
22042 When this version of the ABI is enabled the C preprocessor symbol
22043 @code{__V850_GCC_ABI__} is defined.
22045 @item -m8byte-align
22046 @itemx -mno-8byte-align
22047 @opindex m8byte-align
22048 @opindex mno-8byte-align
22049 Enables support for @code{double} and @code{long long} types to be
22050 aligned on 8-byte boundaries.  The default is to restrict the
22051 alignment of all objects to at most 4-bytes.  When
22052 @option{-m8byte-align} is in effect the C preprocessor symbol
22053 @code{__V850_8BYTE_ALIGN__} is defined.
22055 @item -mbig-switch
22056 @opindex mbig-switch
22057 Generate code suitable for big switch tables.  Use this option only if
22058 the assembler/linker complain about out of range branches within a switch
22059 table.
22061 @item -mapp-regs
22062 @opindex mapp-regs
22063 This option causes r2 and r5 to be used in the code generated by
22064 the compiler.  This setting is the default.
22066 @item -mno-app-regs
22067 @opindex mno-app-regs
22068 This option causes r2 and r5 to be treated as fixed registers.
22070 @end table
22072 @node VAX Options
22073 @subsection VAX Options
22074 @cindex VAX options
22076 These @samp{-m} options are defined for the VAX:
22078 @table @gcctabopt
22079 @item -munix
22080 @opindex munix
22081 Do not output certain jump instructions (@code{aobleq} and so on)
22082 that the Unix assembler for the VAX cannot handle across long
22083 ranges.
22085 @item -mgnu
22086 @opindex mgnu
22087 Do output those jump instructions, on the assumption that the
22088 GNU assembler is being used.
22090 @item -mg
22091 @opindex mg
22092 Output code for G-format floating-point numbers instead of D-format.
22093 @end table
22095 @node Visium Options
22096 @subsection Visium Options
22097 @cindex Visium options
22099 @table @gcctabopt
22101 @item -mdebug
22102 @opindex mdebug
22103 A program which performs file I/O and is destined to run on an MCM target
22104 should be linked with this option.  It causes the libraries libc.a and
22105 libdebug.a to be linked.  The program should be run on the target under
22106 the control of the GDB remote debugging stub.
22108 @item -msim
22109 @opindex msim
22110 A program which performs file I/O and is destined to run on the simulator
22111 should be linked with option.  This causes libraries libc.a and libsim.a to
22112 be linked.
22114 @item -mfpu
22115 @itemx -mhard-float
22116 @opindex mfpu
22117 @opindex mhard-float
22118 Generate code containing floating-point instructions.  This is the
22119 default.
22121 @item -mno-fpu
22122 @itemx -msoft-float
22123 @opindex mno-fpu
22124 @opindex msoft-float
22125 Generate code containing library calls for floating-point.
22127 @option{-msoft-float} changes the calling convention in the output file;
22128 therefore, it is only useful if you compile @emph{all} of a program with
22129 this option.  In particular, you need to compile @file{libgcc.a}, the
22130 library that comes with GCC, with @option{-msoft-float} in order for
22131 this to work.
22133 @item -mcpu=@var{cpu_type}
22134 @opindex mcpu
22135 Set the instruction set, register set, and instruction scheduling parameters
22136 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22137 @samp{mcm}, @samp{gr5} and @samp{gr6}.
22139 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
22141 By default (unless configured otherwise), GCC generates code for the GR5
22142 variant of the Visium architecture.  
22144 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
22145 architecture.  The only difference from GR5 code is that the compiler will
22146 generate block move instructions.
22148 @item -mtune=@var{cpu_type}
22149 @opindex mtune
22150 Set the instruction scheduling parameters for machine type @var{cpu_type},
22151 but do not set the instruction set or register set that the option
22152 @option{-mcpu=@var{cpu_type}} would.
22154 @item -msv-mode
22155 @opindex msv-mode
22156 Generate code for the supervisor mode, where there are no restrictions on
22157 the access to general registers.  This is the default.
22159 @item -muser-mode
22160 @opindex muser-mode
22161 Generate code for the user mode, where the access to some general registers
22162 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
22163 mode; on the GR6, only registers r29 to r31 are affected.
22164 @end table
22166 @node VMS Options
22167 @subsection VMS Options
22169 These @samp{-m} options are defined for the VMS implementations:
22171 @table @gcctabopt
22172 @item -mvms-return-codes
22173 @opindex mvms-return-codes
22174 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22175 condition (e.g.@ error) codes.
22177 @item -mdebug-main=@var{prefix}
22178 @opindex mdebug-main=@var{prefix}
22179 Flag the first routine whose name starts with @var{prefix} as the main
22180 routine for the debugger.
22182 @item -mmalloc64
22183 @opindex mmalloc64
22184 Default to 64-bit memory allocation routines.
22186 @item -mpointer-size=@var{size}
22187 @opindex mpointer-size=@var{size}
22188 Set the default size of pointers. Possible options for @var{size} are
22189 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22190 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22191 The later option disables @code{pragma pointer_size}.
22192 @end table
22194 @node VxWorks Options
22195 @subsection VxWorks Options
22196 @cindex VxWorks Options
22198 The options in this section are defined for all VxWorks targets.
22199 Options specific to the target hardware are listed with the other
22200 options for that target.
22202 @table @gcctabopt
22203 @item -mrtp
22204 @opindex mrtp
22205 GCC can generate code for both VxWorks kernels and real time processes
22206 (RTPs).  This option switches from the former to the latter.  It also
22207 defines the preprocessor macro @code{__RTP__}.
22209 @item -non-static
22210 @opindex non-static
22211 Link an RTP executable against shared libraries rather than static
22212 libraries.  The options @option{-static} and @option{-shared} can
22213 also be used for RTPs (@pxref{Link Options}); @option{-static}
22214 is the default.
22216 @item -Bstatic
22217 @itemx -Bdynamic
22218 @opindex Bstatic
22219 @opindex Bdynamic
22220 These options are passed down to the linker.  They are defined for
22221 compatibility with Diab.
22223 @item -Xbind-lazy
22224 @opindex Xbind-lazy
22225 Enable lazy binding of function calls.  This option is equivalent to
22226 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22228 @item -Xbind-now
22229 @opindex Xbind-now
22230 Disable lazy binding of function calls.  This option is the default and
22231 is defined for compatibility with Diab.
22232 @end table
22234 @node x86 Options
22235 @subsection x86 Options
22236 @cindex x86 Options
22238 These @samp{-m} options are defined for the x86 family of computers.
22240 @table @gcctabopt
22242 @item -march=@var{cpu-type}
22243 @opindex march
22244 Generate instructions for the machine type @var{cpu-type}.  In contrast to
22245 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
22246 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
22247 to generate code that may not run at all on processors other than the one
22248 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
22249 @option{-mtune=@var{cpu-type}}.
22251 The choices for @var{cpu-type} are:
22253 @table @samp
22254 @item native
22255 This selects the CPU to generate code for at compilation time by determining
22256 the processor type of the compiling machine.  Using @option{-march=native}
22257 enables all instruction subsets supported by the local machine (hence
22258 the result might not run on different machines).  Using @option{-mtune=native}
22259 produces code optimized for the local machine under the constraints
22260 of the selected instruction set.  
22262 @item i386
22263 Original Intel i386 CPU@.
22265 @item i486
22266 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
22268 @item i586
22269 @itemx pentium
22270 Intel Pentium CPU with no MMX support.
22272 @item iamcu
22273 Intel MCU, based on Intel Pentium CPU.
22275 @item pentium-mmx
22276 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
22278 @item pentiumpro
22279 Intel Pentium Pro CPU@.
22281 @item i686
22282 When used with @option{-march}, the Pentium Pro
22283 instruction set is used, so the code runs on all i686 family chips.
22284 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
22286 @item pentium2
22287 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
22288 support.
22290 @item pentium3
22291 @itemx pentium3m
22292 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
22293 set support.
22295 @item pentium-m
22296 Intel Pentium M; low-power version of Intel Pentium III CPU
22297 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
22299 @item pentium4
22300 @itemx pentium4m
22301 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
22303 @item prescott
22304 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
22305 set support.
22307 @item nocona
22308 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
22309 SSE2 and SSE3 instruction set support.
22311 @item core2
22312 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
22313 instruction set support.
22315 @item nehalem
22316 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22317 SSE4.1, SSE4.2 and POPCNT instruction set support.
22319 @item westmere
22320 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22321 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
22323 @item sandybridge
22324 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22325 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
22327 @item ivybridge
22328 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22329 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
22330 instruction set support.
22332 @item haswell
22333 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22334 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22335 BMI, BMI2 and F16C instruction set support.
22337 @item broadwell
22338 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22339 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22340 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
22342 @item bonnell
22343 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
22344 instruction set support.
22346 @item silvermont
22347 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22348 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
22350 @item knl
22351 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22352 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22353 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
22354 AVX512CD instruction set support.
22356 @item k6
22357 AMD K6 CPU with MMX instruction set support.
22359 @item k6-2
22360 @itemx k6-3
22361 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
22363 @item athlon
22364 @itemx athlon-tbird
22365 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
22366 support.
22368 @item athlon-4
22369 @itemx athlon-xp
22370 @itemx athlon-mp
22371 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
22372 instruction set support.
22374 @item k8
22375 @itemx opteron
22376 @itemx athlon64
22377 @itemx athlon-fx
22378 Processors based on the AMD K8 core with x86-64 instruction set support,
22379 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
22380 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
22381 instruction set extensions.)
22383 @item k8-sse3
22384 @itemx opteron-sse3
22385 @itemx athlon64-sse3
22386 Improved versions of AMD K8 cores with SSE3 instruction set support.
22388 @item amdfam10
22389 @itemx barcelona
22390 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
22391 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
22392 instruction set extensions.)
22394 @item bdver1
22395 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
22396 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
22397 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
22398 @item bdver2
22399 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22400 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
22401 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
22402 extensions.)
22403 @item bdver3
22404 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22405 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
22406 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
22407 64-bit instruction set extensions.
22408 @item bdver4
22409 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22410 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
22411 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
22412 SSE4.2, ABM and 64-bit instruction set extensions.
22414 @item btver1
22415 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
22416 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
22417 instruction set extensions.)
22419 @item btver2
22420 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
22421 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
22422 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
22424 @item winchip-c6
22425 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
22426 set support.
22428 @item winchip2
22429 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
22430 instruction set support.
22432 @item c3
22433 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
22434 implemented for this chip.)
22436 @item c3-2
22437 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
22438 (No scheduling is
22439 implemented for this chip.)
22441 @item geode
22442 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
22443 @end table
22445 @item -mtune=@var{cpu-type}
22446 @opindex mtune
22447 Tune to @var{cpu-type} everything applicable about the generated code, except
22448 for the ABI and the set of available instructions.  
22449 While picking a specific @var{cpu-type} schedules things appropriately
22450 for that particular chip, the compiler does not generate any code that
22451 cannot run on the default machine type unless you use a
22452 @option{-march=@var{cpu-type}} option.
22453 For example, if GCC is configured for i686-pc-linux-gnu
22454 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
22455 but still runs on i686 machines.
22457 The choices for @var{cpu-type} are the same as for @option{-march}.
22458 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
22460 @table @samp
22461 @item generic
22462 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
22463 If you know the CPU on which your code will run, then you should use
22464 the corresponding @option{-mtune} or @option{-march} option instead of
22465 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
22466 of your application will have, then you should use this option.
22468 As new processors are deployed in the marketplace, the behavior of this
22469 option will change.  Therefore, if you upgrade to a newer version of
22470 GCC, code generation controlled by this option will change to reflect
22471 the processors
22472 that are most common at the time that version of GCC is released.
22474 There is no @option{-march=generic} option because @option{-march}
22475 indicates the instruction set the compiler can use, and there is no
22476 generic instruction set applicable to all processors.  In contrast,
22477 @option{-mtune} indicates the processor (or, in this case, collection of
22478 processors) for which the code is optimized.
22480 @item intel
22481 Produce code optimized for the most current Intel processors, which are
22482 Haswell and Silvermont for this version of GCC.  If you know the CPU
22483 on which your code will run, then you should use the corresponding
22484 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
22485 But, if you want your application performs better on both Haswell and
22486 Silvermont, then you should use this option.
22488 As new Intel processors are deployed in the marketplace, the behavior of
22489 this option will change.  Therefore, if you upgrade to a newer version of
22490 GCC, code generation controlled by this option will change to reflect
22491 the most current Intel processors at the time that version of GCC is
22492 released.
22494 There is no @option{-march=intel} option because @option{-march} indicates
22495 the instruction set the compiler can use, and there is no common
22496 instruction set applicable to all processors.  In contrast,
22497 @option{-mtune} indicates the processor (or, in this case, collection of
22498 processors) for which the code is optimized.
22499 @end table
22501 @item -mcpu=@var{cpu-type}
22502 @opindex mcpu
22503 A deprecated synonym for @option{-mtune}.
22505 @item -mfpmath=@var{unit}
22506 @opindex mfpmath
22507 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
22508 for @var{unit} are:
22510 @table @samp
22511 @item 387
22512 Use the standard 387 floating-point coprocessor present on the majority of chips and
22513 emulated otherwise.  Code compiled with this option runs almost everywhere.
22514 The temporary results are computed in 80-bit precision instead of the precision
22515 specified by the type, resulting in slightly different results compared to most
22516 of other chips.  See @option{-ffloat-store} for more detailed description.
22518 This is the default choice for x86-32 targets.
22520 @item sse
22521 Use scalar floating-point instructions present in the SSE instruction set.
22522 This instruction set is supported by Pentium III and newer chips,
22523 and in the AMD line
22524 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
22525 instruction set supports only single-precision arithmetic, thus the double and
22526 extended-precision arithmetic are still done using 387.  A later version, present
22527 only in Pentium 4 and AMD x86-64 chips, supports double-precision
22528 arithmetic too.
22530 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
22531 or @option{-msse2} switches to enable SSE extensions and make this option
22532 effective.  For the x86-64 compiler, these extensions are enabled by default.
22534 The resulting code should be considerably faster in the majority of cases and avoid
22535 the numerical instability problems of 387 code, but may break some existing
22536 code that expects temporaries to be 80 bits.
22538 This is the default choice for the x86-64 compiler.
22540 @item sse,387
22541 @itemx sse+387
22542 @itemx both
22543 Attempt to utilize both instruction sets at once.  This effectively doubles the
22544 amount of available registers, and on chips with separate execution units for
22545 387 and SSE the execution resources too.  Use this option with care, as it is
22546 still experimental, because the GCC register allocator does not model separate
22547 functional units well, resulting in unstable performance.
22548 @end table
22550 @item -masm=@var{dialect}
22551 @opindex masm=@var{dialect}
22552 Output assembly instructions using selected @var{dialect}.  Also affects
22553 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
22554 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
22555 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
22556 not support @samp{intel}.
22558 @item -mieee-fp
22559 @itemx -mno-ieee-fp
22560 @opindex mieee-fp
22561 @opindex mno-ieee-fp
22562 Control whether or not the compiler uses IEEE floating-point
22563 comparisons.  These correctly handle the case where the result of a
22564 comparison is unordered.
22566 @item -msoft-float
22567 @opindex msoft-float
22568 Generate output containing library calls for floating point.
22570 @strong{Warning:} the requisite libraries are not part of GCC@.
22571 Normally the facilities of the machine's usual C compiler are used, but
22572 this can't be done directly in cross-compilation.  You must make your
22573 own arrangements to provide suitable library functions for
22574 cross-compilation.
22576 On machines where a function returns floating-point results in the 80387
22577 register stack, some floating-point opcodes may be emitted even if
22578 @option{-msoft-float} is used.
22580 @item -mno-fp-ret-in-387
22581 @opindex mno-fp-ret-in-387
22582 Do not use the FPU registers for return values of functions.
22584 The usual calling convention has functions return values of types
22585 @code{float} and @code{double} in an FPU register, even if there
22586 is no FPU@.  The idea is that the operating system should emulate
22587 an FPU@.
22589 The option @option{-mno-fp-ret-in-387} causes such values to be returned
22590 in ordinary CPU registers instead.
22592 @item -mno-fancy-math-387
22593 @opindex mno-fancy-math-387
22594 Some 387 emulators do not support the @code{sin}, @code{cos} and
22595 @code{sqrt} instructions for the 387.  Specify this option to avoid
22596 generating those instructions.  This option is the default on
22597 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
22598 indicates that the target CPU always has an FPU and so the
22599 instruction does not need emulation.  These
22600 instructions are not generated unless you also use the
22601 @option{-funsafe-math-optimizations} switch.
22603 @item -malign-double
22604 @itemx -mno-align-double
22605 @opindex malign-double
22606 @opindex mno-align-double
22607 Control whether GCC aligns @code{double}, @code{long double}, and
22608 @code{long long} variables on a two-word boundary or a one-word
22609 boundary.  Aligning @code{double} variables on a two-word boundary
22610 produces code that runs somewhat faster on a Pentium at the
22611 expense of more memory.
22613 On x86-64, @option{-malign-double} is enabled by default.
22615 @strong{Warning:} if you use the @option{-malign-double} switch,
22616 structures containing the above types are aligned differently than
22617 the published application binary interface specifications for the x86-32
22618 and are not binary compatible with structures in code compiled
22619 without that switch.
22621 @item -m96bit-long-double
22622 @itemx -m128bit-long-double
22623 @opindex m96bit-long-double
22624 @opindex m128bit-long-double
22625 These switches control the size of @code{long double} type.  The x86-32
22626 application binary interface specifies the size to be 96 bits,
22627 so @option{-m96bit-long-double} is the default in 32-bit mode.
22629 Modern architectures (Pentium and newer) prefer @code{long double}
22630 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
22631 conforming to the ABI, this is not possible.  So specifying
22632 @option{-m128bit-long-double} aligns @code{long double}
22633 to a 16-byte boundary by padding the @code{long double} with an additional
22634 32-bit zero.
22636 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
22637 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
22639 Notice that neither of these options enable any extra precision over the x87
22640 standard of 80 bits for a @code{long double}.
22642 @strong{Warning:} if you override the default value for your target ABI, this
22643 changes the size of 
22644 structures and arrays containing @code{long double} variables,
22645 as well as modifying the function calling convention for functions taking
22646 @code{long double}.  Hence they are not binary-compatible
22647 with code compiled without that switch.
22649 @item -mlong-double-64
22650 @itemx -mlong-double-80
22651 @itemx -mlong-double-128
22652 @opindex mlong-double-64
22653 @opindex mlong-double-80
22654 @opindex mlong-double-128
22655 These switches control the size of @code{long double} type. A size
22656 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22657 type. This is the default for 32-bit Bionic C library.  A size
22658 of 128 bits makes the @code{long double} type equivalent to the
22659 @code{__float128} type. This is the default for 64-bit Bionic C library.
22661 @strong{Warning:} if you override the default value for your target ABI, this
22662 changes the size of
22663 structures and arrays containing @code{long double} variables,
22664 as well as modifying the function calling convention for functions taking
22665 @code{long double}.  Hence they are not binary-compatible
22666 with code compiled without that switch.
22668 @item -malign-data=@var{type}
22669 @opindex malign-data
22670 Control how GCC aligns variables.  Supported values for @var{type} are
22671 @samp{compat} uses increased alignment value compatible uses GCC 4.8
22672 and earlier, @samp{abi} uses alignment value as specified by the
22673 psABI, and @samp{cacheline} uses increased alignment value to match
22674 the cache line size.  @samp{compat} is the default.
22676 @item -mlarge-data-threshold=@var{threshold}
22677 @opindex mlarge-data-threshold
22678 When @option{-mcmodel=medium} is specified, data objects larger than
22679 @var{threshold} are placed in the large data section.  This value must be the
22680 same across all objects linked into the binary, and defaults to 65535.
22682 @item -mrtd
22683 @opindex mrtd
22684 Use a different function-calling convention, in which functions that
22685 take a fixed number of arguments return with the @code{ret @var{num}}
22686 instruction, which pops their arguments while returning.  This saves one
22687 instruction in the caller since there is no need to pop the arguments
22688 there.
22690 You can specify that an individual function is called with this calling
22691 sequence with the function attribute @code{stdcall}.  You can also
22692 override the @option{-mrtd} option by using the function attribute
22693 @code{cdecl}.  @xref{Function Attributes}.
22695 @strong{Warning:} this calling convention is incompatible with the one
22696 normally used on Unix, so you cannot use it if you need to call
22697 libraries compiled with the Unix compiler.
22699 Also, you must provide function prototypes for all functions that
22700 take variable numbers of arguments (including @code{printf});
22701 otherwise incorrect code is generated for calls to those
22702 functions.
22704 In addition, seriously incorrect code results if you call a
22705 function with too many arguments.  (Normally, extra arguments are
22706 harmlessly ignored.)
22708 @item -mregparm=@var{num}
22709 @opindex mregparm
22710 Control how many registers are used to pass integer arguments.  By
22711 default, no registers are used to pass arguments, and at most 3
22712 registers can be used.  You can control this behavior for a specific
22713 function by using the function attribute @code{regparm}.
22714 @xref{Function Attributes}.
22716 @strong{Warning:} if you use this switch, and
22717 @var{num} is nonzero, then you must build all modules with the same
22718 value, including any libraries.  This includes the system libraries and
22719 startup modules.
22721 @item -msseregparm
22722 @opindex msseregparm
22723 Use SSE register passing conventions for float and double arguments
22724 and return values.  You can control this behavior for a specific
22725 function by using the function attribute @code{sseregparm}.
22726 @xref{Function Attributes}.
22728 @strong{Warning:} if you use this switch then you must build all
22729 modules with the same value, including any libraries.  This includes
22730 the system libraries and startup modules.
22732 @item -mvect8-ret-in-mem
22733 @opindex mvect8-ret-in-mem
22734 Return 8-byte vectors in memory instead of MMX registers.  This is the
22735 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
22736 Studio compilers until version 12.  Later compiler versions (starting
22737 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
22738 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
22739 you need to remain compatible with existing code produced by those
22740 previous compiler versions or older versions of GCC@.
22742 @item -mpc32
22743 @itemx -mpc64
22744 @itemx -mpc80
22745 @opindex mpc32
22746 @opindex mpc64
22747 @opindex mpc80
22749 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
22750 is specified, the significands of results of floating-point operations are
22751 rounded to 24 bits (single precision); @option{-mpc64} rounds the
22752 significands of results of floating-point operations to 53 bits (double
22753 precision) and @option{-mpc80} rounds the significands of results of
22754 floating-point operations to 64 bits (extended double precision), which is
22755 the default.  When this option is used, floating-point operations in higher
22756 precisions are not available to the programmer without setting the FPU
22757 control word explicitly.
22759 Setting the rounding of floating-point operations to less than the default
22760 80 bits can speed some programs by 2% or more.  Note that some mathematical
22761 libraries assume that extended-precision (80-bit) floating-point operations
22762 are enabled by default; routines in such libraries could suffer significant
22763 loss of accuracy, typically through so-called ``catastrophic cancellation'',
22764 when this option is used to set the precision to less than extended precision.
22766 @item -mstackrealign
22767 @opindex mstackrealign
22768 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
22769 option generates an alternate prologue and epilogue that realigns the
22770 run-time stack if necessary.  This supports mixing legacy codes that keep
22771 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
22772 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
22773 applicable to individual functions.
22775 @item -mpreferred-stack-boundary=@var{num}
22776 @opindex mpreferred-stack-boundary
22777 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
22778 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
22779 the default is 4 (16 bytes or 128 bits).
22781 @strong{Warning:} When generating code for the x86-64 architecture with
22782 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
22783 used to keep the stack boundary aligned to 8 byte boundary.  Since
22784 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
22785 intended to be used in controlled environment where stack space is
22786 important limitation.  This option leads to wrong code when functions
22787 compiled with 16 byte stack alignment (such as functions from a standard
22788 library) are called with misaligned stack.  In this case, SSE
22789 instructions may lead to misaligned memory access traps.  In addition,
22790 variable arguments are handled incorrectly for 16 byte aligned
22791 objects (including x87 long double and __int128), leading to wrong
22792 results.  You must build all modules with
22793 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
22794 includes the system libraries and startup modules.
22796 @item -mincoming-stack-boundary=@var{num}
22797 @opindex mincoming-stack-boundary
22798 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
22799 boundary.  If @option{-mincoming-stack-boundary} is not specified,
22800 the one specified by @option{-mpreferred-stack-boundary} is used.
22802 On Pentium and Pentium Pro, @code{double} and @code{long double} values
22803 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
22804 suffer significant run time performance penalties.  On Pentium III, the
22805 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
22806 properly if it is not 16-byte aligned.
22808 To ensure proper alignment of this values on the stack, the stack boundary
22809 must be as aligned as that required by any value stored on the stack.
22810 Further, every function must be generated such that it keeps the stack
22811 aligned.  Thus calling a function compiled with a higher preferred
22812 stack boundary from a function compiled with a lower preferred stack
22813 boundary most likely misaligns the stack.  It is recommended that
22814 libraries that use callbacks always use the default setting.
22816 This extra alignment does consume extra stack space, and generally
22817 increases code size.  Code that is sensitive to stack space usage, such
22818 as embedded systems and operating system kernels, may want to reduce the
22819 preferred alignment to @option{-mpreferred-stack-boundary=2}.
22821 @need 200
22822 @item -mmmx
22823 @opindex mmmx
22824 @need 200
22825 @itemx -msse
22826 @opindex msse
22827 @need 200
22828 @itemx -msse2
22829 @need 200
22830 @itemx -msse3
22831 @need 200
22832 @itemx -mssse3
22833 @need 200
22834 @itemx -msse4
22835 @need 200
22836 @itemx -msse4a
22837 @need 200
22838 @itemx -msse4.1
22839 @need 200
22840 @itemx -msse4.2
22841 @need 200
22842 @itemx -mavx
22843 @opindex mavx
22844 @need 200
22845 @itemx -mavx2
22846 @need 200
22847 @itemx -mavx512f
22848 @need 200
22849 @itemx -mavx512pf
22850 @need 200
22851 @itemx -mavx512er
22852 @need 200
22853 @itemx -mavx512cd
22854 @need 200
22855 @itemx -msha
22856 @opindex msha
22857 @need 200
22858 @itemx -maes
22859 @opindex maes
22860 @need 200
22861 @itemx -mpclmul
22862 @opindex mpclmul
22863 @need 200
22864 @itemx -mclfushopt
22865 @opindex mclfushopt
22866 @need 200
22867 @itemx -mfsgsbase
22868 @opindex mfsgsbase
22869 @need 200
22870 @itemx -mrdrnd
22871 @opindex mrdrnd
22872 @need 200
22873 @itemx -mf16c
22874 @opindex mf16c
22875 @need 200
22876 @itemx -mfma
22877 @opindex mfma
22878 @need 200
22879 @itemx -mfma4
22880 @need 200
22881 @itemx -mno-fma4
22882 @need 200
22883 @itemx -mprefetchwt1
22884 @opindex mprefetchwt1
22885 @need 200
22886 @itemx -mxop
22887 @opindex mxop
22888 @need 200
22889 @itemx -mlwp
22890 @opindex mlwp
22891 @need 200
22892 @itemx -m3dnow
22893 @opindex m3dnow
22894 @need 200
22895 @itemx -mpopcnt
22896 @opindex mpopcnt
22897 @need 200
22898 @itemx -mabm
22899 @opindex mabm
22900 @need 200
22901 @itemx -mbmi
22902 @opindex mbmi
22903 @need 200
22904 @itemx -mbmi2
22905 @need 200
22906 @itemx -mlzcnt
22907 @opindex mlzcnt
22908 @need 200
22909 @itemx -mfxsr
22910 @opindex mfxsr
22911 @need 200
22912 @itemx -mxsave
22913 @opindex mxsave
22914 @need 200
22915 @itemx -mxsaveopt
22916 @opindex mxsaveopt
22917 @need 200
22918 @itemx -mxsavec
22919 @opindex mxsavec
22920 @need 200
22921 @itemx -mxsaves
22922 @opindex mxsaves
22923 @need 200
22924 @itemx -mrtm
22925 @opindex mrtm
22926 @need 200
22927 @itemx -mtbm
22928 @opindex mtbm
22929 @need 200
22930 @itemx -mmpx
22931 @opindex mmpx
22932 @need 200
22933 @itemx -mmwaitx
22934 @opindex mmwaitx
22935 These switches enable the use of instructions in the MMX, SSE,
22936 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
22937 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
22938 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX or 3DNow!@:
22939 extended instruction sets.  Each has a corresponding @option{-mno-} option
22940 to disable use of these instructions.
22942 These extensions are also available as built-in functions: see
22943 @ref{x86 Built-in Functions}, for details of the functions enabled and
22944 disabled by these switches.
22946 To generate SSE/SSE2 instructions automatically from floating-point
22947 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
22949 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
22950 generates new AVX instructions or AVX equivalence for all SSEx instructions
22951 when needed.
22953 These options enable GCC to use these extended instructions in
22954 generated code, even without @option{-mfpmath=sse}.  Applications that
22955 perform run-time CPU detection must compile separate files for each
22956 supported architecture, using the appropriate flags.  In particular,
22957 the file containing the CPU detection code should be compiled without
22958 these options.
22960 @item -mdump-tune-features
22961 @opindex mdump-tune-features
22962 This option instructs GCC to dump the names of the x86 performance 
22963 tuning features and default settings. The names can be used in 
22964 @option{-mtune-ctrl=@var{feature-list}}.
22966 @item -mtune-ctrl=@var{feature-list}
22967 @opindex mtune-ctrl=@var{feature-list}
22968 This option is used to do fine grain control of x86 code generation features.
22969 @var{feature-list} is a comma separated list of @var{feature} names. See also
22970 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
22971 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
22972 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
22973 developers. Using it may lead to code paths not covered by testing and can
22974 potentially result in compiler ICEs or runtime errors.
22976 @item -mno-default
22977 @opindex mno-default
22978 This option instructs GCC to turn off all tunable features. See also 
22979 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
22981 @item -mcld
22982 @opindex mcld
22983 This option instructs GCC to emit a @code{cld} instruction in the prologue
22984 of functions that use string instructions.  String instructions depend on
22985 the DF flag to select between autoincrement or autodecrement mode.  While the
22986 ABI specifies the DF flag to be cleared on function entry, some operating
22987 systems violate this specification by not clearing the DF flag in their
22988 exception dispatchers.  The exception handler can be invoked with the DF flag
22989 set, which leads to wrong direction mode when string instructions are used.
22990 This option can be enabled by default on 32-bit x86 targets by configuring
22991 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
22992 instructions can be suppressed with the @option{-mno-cld} compiler option
22993 in this case.
22995 @item -mvzeroupper
22996 @opindex mvzeroupper
22997 This option instructs GCC to emit a @code{vzeroupper} instruction
22998 before a transfer of control flow out of the function to minimize
22999 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
23000 intrinsics.
23002 @item -mprefer-avx128
23003 @opindex mprefer-avx128
23004 This option instructs GCC to use 128-bit AVX instructions instead of
23005 256-bit AVX instructions in the auto-vectorizer.
23007 @item -mcx16
23008 @opindex mcx16
23009 This option enables GCC to generate @code{CMPXCHG16B} instructions.
23010 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
23011 (or oword) data types.  
23012 This is useful for high-resolution counters that can be updated
23013 by multiple processors (or cores).  This instruction is generated as part of
23014 atomic built-in functions: see @ref{__sync Builtins} or
23015 @ref{__atomic Builtins} for details.
23017 @item -msahf
23018 @opindex msahf
23019 This option enables generation of @code{SAHF} instructions in 64-bit code.
23020 Early Intel Pentium 4 CPUs with Intel 64 support,
23021 prior to the introduction of Pentium 4 G1 step in December 2005,
23022 lacked the @code{LAHF} and @code{SAHF} instructions
23023 which are supported by AMD64.
23024 These are load and store instructions, respectively, for certain status flags.
23025 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
23026 @code{drem}, and @code{remainder} built-in functions;
23027 see @ref{Other Builtins} for details.
23029 @item -mmovbe
23030 @opindex mmovbe
23031 This option enables use of the @code{movbe} instruction to implement
23032 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
23034 @item -mcrc32
23035 @opindex mcrc32
23036 This option enables built-in functions @code{__builtin_ia32_crc32qi},
23037 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
23038 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
23040 @item -mrecip
23041 @opindex mrecip
23042 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
23043 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
23044 with an additional Newton-Raphson step
23045 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
23046 (and their vectorized
23047 variants) for single-precision floating-point arguments.  These instructions
23048 are generated only when @option{-funsafe-math-optimizations} is enabled
23049 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
23050 Note that while the throughput of the sequence is higher than the throughput
23051 of the non-reciprocal instruction, the precision of the sequence can be
23052 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
23054 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
23055 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
23056 combination), and doesn't need @option{-mrecip}.
23058 Also note that GCC emits the above sequence with additional Newton-Raphson step
23059 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
23060 already with @option{-ffast-math} (or the above option combination), and
23061 doesn't need @option{-mrecip}.
23063 @item -mrecip=@var{opt}
23064 @opindex mrecip=opt
23065 This option controls which reciprocal estimate instructions
23066 may be used.  @var{opt} is a comma-separated list of options, which may
23067 be preceded by a @samp{!} to invert the option:
23069 @table @samp
23070 @item all
23071 Enable all estimate instructions.
23073 @item default
23074 Enable the default instructions, equivalent to @option{-mrecip}.
23076 @item none
23077 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23079 @item div
23080 Enable the approximation for scalar division.
23082 @item vec-div
23083 Enable the approximation for vectorized division.
23085 @item sqrt
23086 Enable the approximation for scalar square root.
23088 @item vec-sqrt
23089 Enable the approximation for vectorized square root.
23090 @end table
23092 So, for example, @option{-mrecip=all,!sqrt} enables
23093 all of the reciprocal approximations, except for square root.
23095 @item -mveclibabi=@var{type}
23096 @opindex mveclibabi
23097 Specifies the ABI type to use for vectorizing intrinsics using an
23098 external library.  Supported values for @var{type} are @samp{svml} 
23099 for the Intel short
23100 vector math library and @samp{acml} for the AMD math core library.
23101 To use this option, both @option{-ftree-vectorize} and
23102 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
23103 ABI-compatible library must be specified at link time.
23105 GCC currently emits calls to @code{vmldExp2},
23106 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
23107 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
23108 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
23109 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
23110 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
23111 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
23112 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
23113 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
23114 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
23115 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
23116 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
23117 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
23118 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
23119 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
23120 when @option{-mveclibabi=acml} is used.  
23122 @item -mabi=@var{name}
23123 @opindex mabi
23124 Generate code for the specified calling convention.  Permissible values
23125 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
23126 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
23127 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
23128 You can control this behavior for specific functions by
23129 using the function attributes @code{ms_abi} and @code{sysv_abi}.
23130 @xref{Function Attributes}.
23132 @item -mtls-dialect=@var{type}
23133 @opindex mtls-dialect
23134 Generate code to access thread-local storage using the @samp{gnu} or
23135 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
23136 @samp{gnu2} is more efficient, but it may add compile- and run-time
23137 requirements that cannot be satisfied on all systems.
23139 @item -mpush-args
23140 @itemx -mno-push-args
23141 @opindex mpush-args
23142 @opindex mno-push-args
23143 Use PUSH operations to store outgoing parameters.  This method is shorter
23144 and usually equally fast as method using SUB/MOV operations and is enabled
23145 by default.  In some cases disabling it may improve performance because of
23146 improved scheduling and reduced dependencies.
23148 @item -maccumulate-outgoing-args
23149 @opindex maccumulate-outgoing-args
23150 If enabled, the maximum amount of space required for outgoing arguments is
23151 computed in the function prologue.  This is faster on most modern CPUs
23152 because of reduced dependencies, improved scheduling and reduced stack usage
23153 when the preferred stack boundary is not equal to 2.  The drawback is a notable
23154 increase in code size.  This switch implies @option{-mno-push-args}.
23156 @item -mthreads
23157 @opindex mthreads
23158 Support thread-safe exception handling on MinGW.  Programs that rely
23159 on thread-safe exception handling must compile and link all code with the
23160 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
23161 @option{-D_MT}; when linking, it links in a special thread helper library
23162 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
23164 @item -mno-align-stringops
23165 @opindex mno-align-stringops
23166 Do not align the destination of inlined string operations.  This switch reduces
23167 code size and improves performance in case the destination is already aligned,
23168 but GCC doesn't know about it.
23170 @item -minline-all-stringops
23171 @opindex minline-all-stringops
23172 By default GCC inlines string operations only when the destination is 
23173 known to be aligned to least a 4-byte boundary.  
23174 This enables more inlining and increases code
23175 size, but may improve performance of code that depends on fast
23176 @code{memcpy}, @code{strlen},
23177 and @code{memset} for short lengths.
23179 @item -minline-stringops-dynamically
23180 @opindex minline-stringops-dynamically
23181 For string operations of unknown size, use run-time checks with
23182 inline code for small blocks and a library call for large blocks.
23184 @item -mstringop-strategy=@var{alg}
23185 @opindex mstringop-strategy=@var{alg}
23186 Override the internal decision heuristic for the particular algorithm to use
23187 for inlining string operations.  The allowed values for @var{alg} are:
23189 @table @samp
23190 @item rep_byte
23191 @itemx rep_4byte
23192 @itemx rep_8byte
23193 Expand using i386 @code{rep} prefix of the specified size.
23195 @item byte_loop
23196 @itemx loop
23197 @itemx unrolled_loop
23198 Expand into an inline loop.
23200 @item libcall
23201 Always use a library call.
23202 @end table
23204 @item -mmemcpy-strategy=@var{strategy}
23205 @opindex mmemcpy-strategy=@var{strategy}
23206 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
23207 should be inlined and what inline algorithm to use when the expected size
23208 of the copy operation is known. @var{strategy} 
23209 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
23210 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
23211 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
23212 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
23213 in the list must be specified in increasing order.  The minimal byte size for 
23214 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
23215 preceding range.
23217 @item -mmemset-strategy=@var{strategy}
23218 @opindex mmemset-strategy=@var{strategy}
23219 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
23220 @code{__builtin_memset} expansion.
23222 @item -momit-leaf-frame-pointer
23223 @opindex momit-leaf-frame-pointer
23224 Don't keep the frame pointer in a register for leaf functions.  This
23225 avoids the instructions to save, set up, and restore frame pointers and
23226 makes an extra register available in leaf functions.  The option
23227 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
23228 which might make debugging harder.
23230 @item -mtls-direct-seg-refs
23231 @itemx -mno-tls-direct-seg-refs
23232 @opindex mtls-direct-seg-refs
23233 Controls whether TLS variables may be accessed with offsets from the
23234 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
23235 or whether the thread base pointer must be added.  Whether or not this
23236 is valid depends on the operating system, and whether it maps the
23237 segment to cover the entire TLS area.
23239 For systems that use the GNU C Library, the default is on.
23241 @item -msse2avx
23242 @itemx -mno-sse2avx
23243 @opindex msse2avx
23244 Specify that the assembler should encode SSE instructions with VEX
23245 prefix.  The option @option{-mavx} turns this on by default.
23247 @item -mfentry
23248 @itemx -mno-fentry
23249 @opindex mfentry
23250 If profiling is active (@option{-pg}), put the profiling
23251 counter call before the prologue.
23252 Note: On x86 architectures the attribute @code{ms_hook_prologue}
23253 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
23255 @item -mrecord-mcount
23256 @itemx -mno-record-mcount
23257 @opindex mrecord-mcount
23258 If profiling is active (@option{-pg}), generate a __mcount_loc section
23259 that contains pointers to each profiling call. This is useful for
23260 automatically patching and out calls.
23262 @item -mnop-mcount
23263 @itemx -mno-nop-mcount
23264 @opindex mnop-mcount
23265 If profiling is active (@option{-pg}), generate the calls to
23266 the profiling functions as nops. This is useful when they
23267 should be patched in later dynamically. This is likely only
23268 useful together with @option{-mrecord-mcount}.
23270 @item -mskip-rax-setup
23271 @itemx -mno-skip-rax-setup
23272 @opindex mskip-rax-setup
23273 When generating code for the x86-64 architecture with SSE extensions
23274 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
23275 register when there are no variable arguments passed in vector registers.
23277 @strong{Warning:} Since RAX register is used to avoid unnecessarily
23278 saving vector registers on stack when passing variable arguments, the
23279 impacts of this option are callees may waste some stack space,
23280 misbehave or jump to a random location.  GCC 4.4 or newer don't have
23281 those issues, regardless the RAX register value.
23283 @item -m8bit-idiv
23284 @itemx -mno-8bit-idiv
23285 @opindex m8bit-idiv
23286 On some processors, like Intel Atom, 8-bit unsigned integer divide is
23287 much faster than 32-bit/64-bit integer divide.  This option generates a
23288 run-time check.  If both dividend and divisor are within range of 0
23289 to 255, 8-bit unsigned integer divide is used instead of
23290 32-bit/64-bit integer divide.
23292 @item -mavx256-split-unaligned-load
23293 @itemx -mavx256-split-unaligned-store
23294 @opindex mavx256-split-unaligned-load
23295 @opindex mavx256-split-unaligned-store
23296 Split 32-byte AVX unaligned load and store.
23298 @item -mstack-protector-guard=@var{guard}
23299 @opindex mstack-protector-guard=@var{guard}
23300 Generate stack protection code using canary at @var{guard}.  Supported
23301 locations are @samp{global} for global canary or @samp{tls} for per-thread
23302 canary in the TLS block (the default).  This option has effect only when
23303 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
23305 @end table
23307 These @samp{-m} switches are supported in addition to the above
23308 on x86-64 processors in 64-bit environments.
23310 @table @gcctabopt
23311 @item -m32
23312 @itemx -m64
23313 @itemx -mx32
23314 @itemx -m16
23315 @itemx -miamcu
23316 @opindex m32
23317 @opindex m64
23318 @opindex mx32
23319 @opindex m16
23320 @opindex miamcu
23321 Generate code for a 16-bit, 32-bit or 64-bit environment.
23322 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
23323 to 32 bits, and
23324 generates code that runs on any i386 system.
23326 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
23327 types to 64 bits, and generates code for the x86-64 architecture.
23328 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
23329 and @option{-mdynamic-no-pic} options.
23331 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
23332 to 32 bits, and
23333 generates code for the x86-64 architecture.
23335 The @option{-m16} option is the same as @option{-m32}, except for that
23336 it outputs the @code{.code16gcc} assembly directive at the beginning of
23337 the assembly output so that the binary can run in 16-bit mode.
23339 The @option{-miamcu} option generates code which conforms to Intel MCU
23340 psABI.  It requires the @option{-m32} option to be turned on.
23342 @item -mno-red-zone
23343 @opindex mno-red-zone
23344 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
23345 by the x86-64 ABI; it is a 128-byte area beyond the location of the
23346 stack pointer that is not modified by signal or interrupt handlers
23347 and therefore can be used for temporary data without adjusting the stack
23348 pointer.  The flag @option{-mno-red-zone} disables this red zone.
23350 @item -mcmodel=small
23351 @opindex mcmodel=small
23352 Generate code for the small code model: the program and its symbols must
23353 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
23354 Programs can be statically or dynamically linked.  This is the default
23355 code model.
23357 @item -mcmodel=kernel
23358 @opindex mcmodel=kernel
23359 Generate code for the kernel code model.  The kernel runs in the
23360 negative 2 GB of the address space.
23361 This model has to be used for Linux kernel code.
23363 @item -mcmodel=medium
23364 @opindex mcmodel=medium
23365 Generate code for the medium model: the program is linked in the lower 2
23366 GB of the address space.  Small symbols are also placed there.  Symbols
23367 with sizes larger than @option{-mlarge-data-threshold} are put into
23368 large data or BSS sections and can be located above 2GB.  Programs can
23369 be statically or dynamically linked.
23371 @item -mcmodel=large
23372 @opindex mcmodel=large
23373 Generate code for the large model.  This model makes no assumptions
23374 about addresses and sizes of sections.
23376 @item -maddress-mode=long
23377 @opindex maddress-mode=long
23378 Generate code for long address mode.  This is only supported for 64-bit
23379 and x32 environments.  It is the default address mode for 64-bit
23380 environments.
23382 @item -maddress-mode=short
23383 @opindex maddress-mode=short
23384 Generate code for short address mode.  This is only supported for 32-bit
23385 and x32 environments.  It is the default address mode for 32-bit and
23386 x32 environments.
23387 @end table
23389 @node x86 Windows Options
23390 @subsection x86 Windows Options
23391 @cindex x86 Windows Options
23392 @cindex Windows Options for x86
23394 These additional options are available for Microsoft Windows targets:
23396 @table @gcctabopt
23397 @item -mconsole
23398 @opindex mconsole
23399 This option
23400 specifies that a console application is to be generated, by
23401 instructing the linker to set the PE header subsystem type
23402 required for console applications.
23403 This option is available for Cygwin and MinGW targets and is
23404 enabled by default on those targets.
23406 @item -mdll
23407 @opindex mdll
23408 This option is available for Cygwin and MinGW targets.  It
23409 specifies that a DLL---a dynamic link library---is to be
23410 generated, enabling the selection of the required runtime
23411 startup object and entry point.
23413 @item -mnop-fun-dllimport
23414 @opindex mnop-fun-dllimport
23415 This option is available for Cygwin and MinGW targets.  It
23416 specifies that the @code{dllimport} attribute should be ignored.
23418 @item -mthread
23419 @opindex mthread
23420 This option is available for MinGW targets. It specifies
23421 that MinGW-specific thread support is to be used.
23423 @item -municode
23424 @opindex municode
23425 This option is available for MinGW-w64 targets.  It causes
23426 the @code{UNICODE} preprocessor macro to be predefined, and
23427 chooses Unicode-capable runtime startup code.
23429 @item -mwin32
23430 @opindex mwin32
23431 This option is available for Cygwin and MinGW targets.  It
23432 specifies that the typical Microsoft Windows predefined macros are to
23433 be set in the pre-processor, but does not influence the choice
23434 of runtime library/startup code.
23436 @item -mwindows
23437 @opindex mwindows
23438 This option is available for Cygwin and MinGW targets.  It
23439 specifies that a GUI application is to be generated by
23440 instructing the linker to set the PE header subsystem type
23441 appropriately.
23443 @item -fno-set-stack-executable
23444 @opindex fno-set-stack-executable
23445 This option is available for MinGW targets. It specifies that
23446 the executable flag for the stack used by nested functions isn't
23447 set. This is necessary for binaries running in kernel mode of
23448 Microsoft Windows, as there the User32 API, which is used to set executable
23449 privileges, isn't available.
23451 @item -fwritable-relocated-rdata
23452 @opindex fno-writable-relocated-rdata
23453 This option is available for MinGW and Cygwin targets.  It specifies
23454 that relocated-data in read-only section is put into .data
23455 section.  This is a necessary for older runtimes not supporting
23456 modification of .rdata sections for pseudo-relocation.
23458 @item -mpe-aligned-commons
23459 @opindex mpe-aligned-commons
23460 This option is available for Cygwin and MinGW targets.  It
23461 specifies that the GNU extension to the PE file format that
23462 permits the correct alignment of COMMON variables should be
23463 used when generating code.  It is enabled by default if
23464 GCC detects that the target assembler found during configuration
23465 supports the feature.
23466 @end table
23468 See also under @ref{x86 Options} for standard options.
23470 @node Xstormy16 Options
23471 @subsection Xstormy16 Options
23472 @cindex Xstormy16 Options
23474 These options are defined for Xstormy16:
23476 @table @gcctabopt
23477 @item -msim
23478 @opindex msim
23479 Choose startup files and linker script suitable for the simulator.
23480 @end table
23482 @node Xtensa Options
23483 @subsection Xtensa Options
23484 @cindex Xtensa Options
23486 These options are supported for Xtensa targets:
23488 @table @gcctabopt
23489 @item -mconst16
23490 @itemx -mno-const16
23491 @opindex mconst16
23492 @opindex mno-const16
23493 Enable or disable use of @code{CONST16} instructions for loading
23494 constant values.  The @code{CONST16} instruction is currently not a
23495 standard option from Tensilica.  When enabled, @code{CONST16}
23496 instructions are always used in place of the standard @code{L32R}
23497 instructions.  The use of @code{CONST16} is enabled by default only if
23498 the @code{L32R} instruction is not available.
23500 @item -mfused-madd
23501 @itemx -mno-fused-madd
23502 @opindex mfused-madd
23503 @opindex mno-fused-madd
23504 Enable or disable use of fused multiply/add and multiply/subtract
23505 instructions in the floating-point option.  This has no effect if the
23506 floating-point option is not also enabled.  Disabling fused multiply/add
23507 and multiply/subtract instructions forces the compiler to use separate
23508 instructions for the multiply and add/subtract operations.  This may be
23509 desirable in some cases where strict IEEE 754-compliant results are
23510 required: the fused multiply add/subtract instructions do not round the
23511 intermediate result, thereby producing results with @emph{more} bits of
23512 precision than specified by the IEEE standard.  Disabling fused multiply
23513 add/subtract instructions also ensures that the program output is not
23514 sensitive to the compiler's ability to combine multiply and add/subtract
23515 operations.
23517 @item -mserialize-volatile
23518 @itemx -mno-serialize-volatile
23519 @opindex mserialize-volatile
23520 @opindex mno-serialize-volatile
23521 When this option is enabled, GCC inserts @code{MEMW} instructions before
23522 @code{volatile} memory references to guarantee sequential consistency.
23523 The default is @option{-mserialize-volatile}.  Use
23524 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
23526 @item -mforce-no-pic
23527 @opindex mforce-no-pic
23528 For targets, like GNU/Linux, where all user-mode Xtensa code must be
23529 position-independent code (PIC), this option disables PIC for compiling
23530 kernel code.
23532 @item -mtext-section-literals
23533 @itemx -mno-text-section-literals
23534 @opindex mtext-section-literals
23535 @opindex mno-text-section-literals
23536 These options control the treatment of literal pools.  The default is
23537 @option{-mno-text-section-literals}, which places literals in a separate
23538 section in the output file.  This allows the literal pool to be placed
23539 in a data RAM/ROM, and it also allows the linker to combine literal
23540 pools from separate object files to remove redundant literals and
23541 improve code size.  With @option{-mtext-section-literals}, the literals
23542 are interspersed in the text section in order to keep them as close as
23543 possible to their references.  This may be necessary for large assembly
23544 files.
23546 @item -mtarget-align
23547 @itemx -mno-target-align
23548 @opindex mtarget-align
23549 @opindex mno-target-align
23550 When this option is enabled, GCC instructs the assembler to
23551 automatically align instructions to reduce branch penalties at the
23552 expense of some code density.  The assembler attempts to widen density
23553 instructions to align branch targets and the instructions following call
23554 instructions.  If there are not enough preceding safe density
23555 instructions to align a target, no widening is performed.  The
23556 default is @option{-mtarget-align}.  These options do not affect the
23557 treatment of auto-aligned instructions like @code{LOOP}, which the
23558 assembler always aligns, either by widening density instructions or
23559 by inserting NOP instructions.
23561 @item -mlongcalls
23562 @itemx -mno-longcalls
23563 @opindex mlongcalls
23564 @opindex mno-longcalls
23565 When this option is enabled, GCC instructs the assembler to translate
23566 direct calls to indirect calls unless it can determine that the target
23567 of a direct call is in the range allowed by the call instruction.  This
23568 translation typically occurs for calls to functions in other source
23569 files.  Specifically, the assembler translates a direct @code{CALL}
23570 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
23571 The default is @option{-mno-longcalls}.  This option should be used in
23572 programs where the call target can potentially be out of range.  This
23573 option is implemented in the assembler, not the compiler, so the
23574 assembly code generated by GCC still shows direct call
23575 instructions---look at the disassembled object code to see the actual
23576 instructions.  Note that the assembler uses an indirect call for
23577 every cross-file call, not just those that really are out of range.
23578 @end table
23580 @node zSeries Options
23581 @subsection zSeries Options
23582 @cindex zSeries options
23584 These are listed under @xref{S/390 and zSeries Options}.
23586 @node Code Gen Options
23587 @section Options for Code Generation Conventions
23588 @cindex code generation conventions
23589 @cindex options, code generation
23590 @cindex run-time options
23592 These machine-independent options control the interface conventions
23593 used in code generation.
23595 Most of them have both positive and negative forms; the negative form
23596 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
23597 one of the forms is listed---the one that is not the default.  You
23598 can figure out the other form by either removing @samp{no-} or adding
23601 @table @gcctabopt
23602 @item -fbounds-check
23603 @opindex fbounds-check
23604 For front ends that support it, generate additional code to check that
23605 indices used to access arrays are within the declared range.  This is
23606 currently only supported by the Java and Fortran front ends, where
23607 this option defaults to true and false respectively.
23609 @item -fstack-reuse=@var{reuse-level}
23610 @opindex fstack_reuse
23611 This option controls stack space reuse for user declared local/auto variables
23612 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
23613 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
23614 local variables and temporaries, @samp{named_vars} enables the reuse only for
23615 user defined local variables with names, and @samp{none} disables stack reuse
23616 completely. The default value is @samp{all}. The option is needed when the
23617 program extends the lifetime of a scoped local variable or a compiler generated
23618 temporary beyond the end point defined by the language.  When a lifetime of
23619 a variable ends, and if the variable lives in memory, the optimizing compiler
23620 has the freedom to reuse its stack space with other temporaries or scoped
23621 local variables whose live range does not overlap with it. Legacy code extending
23622 local lifetime is likely to break with the stack reuse optimization.
23624 For example,
23626 @smallexample
23627    int *p;
23628    @{
23629      int local1;
23631      p = &local1;
23632      local1 = 10;
23633      ....
23634    @}
23635    @{
23636       int local2;
23637       local2 = 20;
23638       ...
23639    @}
23641    if (*p == 10)  // out of scope use of local1
23642      @{
23644      @}
23645 @end smallexample
23647 Another example:
23648 @smallexample
23650    struct A
23651    @{
23652        A(int k) : i(k), j(k) @{ @}
23653        int i;
23654        int j;
23655    @};
23657    A *ap;
23659    void foo(const A& ar)
23660    @{
23661       ap = &ar;
23662    @}
23664    void bar()
23665    @{
23666       foo(A(10)); // temp object's lifetime ends when foo returns
23668       @{
23669         A a(20);
23670         ....
23671       @}
23672       ap->i+= 10;  // ap references out of scope temp whose space
23673                    // is reused with a. What is the value of ap->i?
23674    @}
23676 @end smallexample
23678 The lifetime of a compiler generated temporary is well defined by the C++
23679 standard. When a lifetime of a temporary ends, and if the temporary lives
23680 in memory, the optimizing compiler has the freedom to reuse its stack
23681 space with other temporaries or scoped local variables whose live range
23682 does not overlap with it. However some of the legacy code relies on
23683 the behavior of older compilers in which temporaries' stack space is
23684 not reused, the aggressive stack reuse can lead to runtime errors. This
23685 option is used to control the temporary stack reuse optimization.
23687 @item -ftrapv
23688 @opindex ftrapv
23689 This option generates traps for signed overflow on addition, subtraction,
23690 multiplication operations.
23692 @item -fwrapv
23693 @opindex fwrapv
23694 This option instructs the compiler to assume that signed arithmetic
23695 overflow of addition, subtraction and multiplication wraps around
23696 using twos-complement representation.  This flag enables some optimizations
23697 and disables others.  This option is enabled by default for the Java
23698 front end, as required by the Java language specification.
23700 @item -fexceptions
23701 @opindex fexceptions
23702 Enable exception handling.  Generates extra code needed to propagate
23703 exceptions.  For some targets, this implies GCC generates frame
23704 unwind information for all functions, which can produce significant data
23705 size overhead, although it does not affect execution.  If you do not
23706 specify this option, GCC enables it by default for languages like
23707 C++ that normally require exception handling, and disables it for
23708 languages like C that do not normally require it.  However, you may need
23709 to enable this option when compiling C code that needs to interoperate
23710 properly with exception handlers written in C++.  You may also wish to
23711 disable this option if you are compiling older C++ programs that don't
23712 use exception handling.
23714 @item -fnon-call-exceptions
23715 @opindex fnon-call-exceptions
23716 Generate code that allows trapping instructions to throw exceptions.
23717 Note that this requires platform-specific runtime support that does
23718 not exist everywhere.  Moreover, it only allows @emph{trapping}
23719 instructions to throw exceptions, i.e.@: memory references or floating-point
23720 instructions.  It does not allow exceptions to be thrown from
23721 arbitrary signal handlers such as @code{SIGALRM}.
23723 @item -fdelete-dead-exceptions
23724 @opindex fdelete-dead-exceptions
23725 Consider that instructions that may throw exceptions but don't otherwise
23726 contribute to the execution of the program can be optimized away.
23727 This option is enabled by default for the Ada front end, as permitted by
23728 the Ada language specification.
23729 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
23731 @item -funwind-tables
23732 @opindex funwind-tables
23733 Similar to @option{-fexceptions}, except that it just generates any needed
23734 static data, but does not affect the generated code in any other way.
23735 You normally do not need to enable this option; instead, a language processor
23736 that needs this handling enables it on your behalf.
23738 @item -fasynchronous-unwind-tables
23739 @opindex fasynchronous-unwind-tables
23740 Generate unwind table in DWARF 2 format, if supported by target machine.  The
23741 table is exact at each instruction boundary, so it can be used for stack
23742 unwinding from asynchronous events (such as debugger or garbage collector).
23744 @item -fno-gnu-unique
23745 @opindex fno-gnu-unique
23746 On systems with recent GNU assembler and C library, the C++ compiler
23747 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
23748 of template static data members and static local variables in inline
23749 functions are unique even in the presence of @code{RTLD_LOCAL}; this
23750 is necessary to avoid problems with a library used by two different
23751 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
23752 therefore disagreeing with the other one about the binding of the
23753 symbol.  But this causes @code{dlclose} to be ignored for affected
23754 DSOs; if your program relies on reinitialization of a DSO via
23755 @code{dlclose} and @code{dlopen}, you can use
23756 @option{-fno-gnu-unique}.
23758 @item -fpcc-struct-return
23759 @opindex fpcc-struct-return
23760 Return ``short'' @code{struct} and @code{union} values in memory like
23761 longer ones, rather than in registers.  This convention is less
23762 efficient, but it has the advantage of allowing intercallability between
23763 GCC-compiled files and files compiled with other compilers, particularly
23764 the Portable C Compiler (pcc).
23766 The precise convention for returning structures in memory depends
23767 on the target configuration macros.
23769 Short structures and unions are those whose size and alignment match
23770 that of some integer type.
23772 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
23773 switch is not binary compatible with code compiled with the
23774 @option{-freg-struct-return} switch.
23775 Use it to conform to a non-default application binary interface.
23777 @item -freg-struct-return
23778 @opindex freg-struct-return
23779 Return @code{struct} and @code{union} values in registers when possible.
23780 This is more efficient for small structures than
23781 @option{-fpcc-struct-return}.
23783 If you specify neither @option{-fpcc-struct-return} nor
23784 @option{-freg-struct-return}, GCC defaults to whichever convention is
23785 standard for the target.  If there is no standard convention, GCC
23786 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
23787 the principal compiler.  In those cases, we can choose the standard, and
23788 we chose the more efficient register return alternative.
23790 @strong{Warning:} code compiled with the @option{-freg-struct-return}
23791 switch is not binary compatible with code compiled with the
23792 @option{-fpcc-struct-return} switch.
23793 Use it to conform to a non-default application binary interface.
23795 @item -fshort-enums
23796 @opindex fshort-enums
23797 Allocate to an @code{enum} type only as many bytes as it needs for the
23798 declared range of possible values.  Specifically, the @code{enum} type
23799 is equivalent to the smallest integer type that has enough room.
23801 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
23802 code that is not binary compatible with code generated without that switch.
23803 Use it to conform to a non-default application binary interface.
23805 @item -fshort-double
23806 @opindex fshort-double
23807 Use the same size for @code{double} as for @code{float}.
23809 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
23810 code that is not binary compatible with code generated without that switch.
23811 Use it to conform to a non-default application binary interface.
23813 @item -fshort-wchar
23814 @opindex fshort-wchar
23815 Override the underlying type for @code{wchar_t} to be @code{short
23816 unsigned int} instead of the default for the target.  This option is
23817 useful for building programs to run under WINE@.
23819 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
23820 code that is not binary compatible with code generated without that switch.
23821 Use it to conform to a non-default application binary interface.
23823 @item -fno-common
23824 @opindex fno-common
23825 In C code, controls the placement of uninitialized global variables.
23826 Unix C compilers have traditionally permitted multiple definitions of
23827 such variables in different compilation units by placing the variables
23828 in a common block.
23829 This is the behavior specified by @option{-fcommon}, and is the default
23830 for GCC on most targets.
23831 On the other hand, this behavior is not required by ISO C, and on some
23832 targets may carry a speed or code size penalty on variable references.
23833 The @option{-fno-common} option specifies that the compiler should place
23834 uninitialized global variables in the data section of the object file,
23835 rather than generating them as common blocks.
23836 This has the effect that if the same variable is declared
23837 (without @code{extern}) in two different compilations,
23838 you get a multiple-definition error when you link them.
23839 In this case, you must compile with @option{-fcommon} instead.
23840 Compiling with @option{-fno-common} is useful on targets for which
23841 it provides better performance, or if you wish to verify that the
23842 program will work on other systems that always treat uninitialized
23843 variable declarations this way.
23845 @item -fno-ident
23846 @opindex fno-ident
23847 Ignore the @code{#ident} directive.
23849 @item -finhibit-size-directive
23850 @opindex finhibit-size-directive
23851 Don't output a @code{.size} assembler directive, or anything else that
23852 would cause trouble if the function is split in the middle, and the
23853 two halves are placed at locations far apart in memory.  This option is
23854 used when compiling @file{crtstuff.c}; you should not need to use it
23855 for anything else.
23857 @item -fverbose-asm
23858 @opindex fverbose-asm
23859 Put extra commentary information in the generated assembly code to
23860 make it more readable.  This option is generally only of use to those
23861 who actually need to read the generated assembly code (perhaps while
23862 debugging the compiler itself).
23864 @option{-fno-verbose-asm}, the default, causes the
23865 extra information to be omitted and is useful when comparing two assembler
23866 files.
23868 @item -frecord-gcc-switches
23869 @opindex frecord-gcc-switches
23870 This switch causes the command line used to invoke the
23871 compiler to be recorded into the object file that is being created.
23872 This switch is only implemented on some targets and the exact format
23873 of the recording is target and binary file format dependent, but it
23874 usually takes the form of a section containing ASCII text.  This
23875 switch is related to the @option{-fverbose-asm} switch, but that
23876 switch only records information in the assembler output file as
23877 comments, so it never reaches the object file.
23878 See also @option{-grecord-gcc-switches} for another
23879 way of storing compiler options into the object file.
23881 @item -fpic
23882 @opindex fpic
23883 @cindex global offset table
23884 @cindex PIC
23885 Generate position-independent code (PIC) suitable for use in a shared
23886 library, if supported for the target machine.  Such code accesses all
23887 constant addresses through a global offset table (GOT)@.  The dynamic
23888 loader resolves the GOT entries when the program starts (the dynamic
23889 loader is not part of GCC; it is part of the operating system).  If
23890 the GOT size for the linked executable exceeds a machine-specific
23891 maximum size, you get an error message from the linker indicating that
23892 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23893 instead.  (These maximums are 8k on the SPARC and 32k
23894 on the m68k and RS/6000.  The x86 has no such limit.)
23896 Position-independent code requires special support, and therefore works
23897 only on certain machines.  For the x86, GCC supports PIC for System V
23898 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23899 position-independent.
23901 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23902 are defined to 1.
23904 @item -fPIC
23905 @opindex fPIC
23906 If supported for the target machine, emit position-independent code,
23907 suitable for dynamic linking and avoiding any limit on the size of the
23908 global offset table.  This option makes a difference on the m68k,
23909 PowerPC and SPARC@.
23911 Position-independent code requires special support, and therefore works
23912 only on certain machines.
23914 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23915 are defined to 2.
23917 @item -fpie
23918 @itemx -fPIE
23919 @opindex fpie
23920 @opindex fPIE
23921 These options are similar to @option{-fpic} and @option{-fPIC}, but
23922 generated position independent code can be only linked into executables.
23923 Usually these options are used when @option{-pie} GCC option is
23924 used during linking.
23926 @option{-fpie} and @option{-fPIE} both define the macros
23927 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23928 for @option{-fpie} and 2 for @option{-fPIE}.
23930 @item -fno-plt
23931 @opindex fno-plt
23932 Do not use PLT for external function calls in position-independent code.
23933 Instead, load callee address at call site from GOT and branch to it.
23934 This leads to more efficient code by eliminating PLT stubs and exposing
23935 GOT load to optimizations.  On architectures such as 32-bit x86 where
23936 PLT stubs expect GOT pointer in a specific register, this gives more
23937 register allocation freedom to the compiler.  Lazy binding requires PLT:
23938 with @option{-fno-plt} all external symbols are resolved at load time.
23940 Alternatively, function attribute @code{noplt} can be used to avoid PLT
23941 for calls to specific external functions by marking those functions with
23942 this attribute.
23944 Additionally, a few targets also convert calls to those functions that are
23945 marked to not use the PLT to use the GOT instead for non-position independent
23946 code.
23948 @item -fno-jump-tables
23949 @opindex fno-jump-tables
23950 Do not use jump tables for switch statements even where it would be
23951 more efficient than other code generation strategies.  This option is
23952 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23953 building code that forms part of a dynamic linker and cannot
23954 reference the address of a jump table.  On some targets, jump tables
23955 do not require a GOT and this option is not needed.
23957 @item -ffixed-@var{reg}
23958 @opindex ffixed
23959 Treat the register named @var{reg} as a fixed register; generated code
23960 should never refer to it (except perhaps as a stack pointer, frame
23961 pointer or in some other fixed role).
23963 @var{reg} must be the name of a register.  The register names accepted
23964 are machine-specific and are defined in the @code{REGISTER_NAMES}
23965 macro in the machine description macro file.
23967 This flag does not have a negative form, because it specifies a
23968 three-way choice.
23970 @item -fcall-used-@var{reg}
23971 @opindex fcall-used
23972 Treat the register named @var{reg} as an allocable register that is
23973 clobbered by function calls.  It may be allocated for temporaries or
23974 variables that do not live across a call.  Functions compiled this way
23975 do not save and restore the register @var{reg}.
23977 It is an error to use this flag with the frame pointer or stack pointer.
23978 Use of this flag for other registers that have fixed pervasive roles in
23979 the machine's execution model produces disastrous results.
23981 This flag does not have a negative form, because it specifies a
23982 three-way choice.
23984 @item -fcall-saved-@var{reg}
23985 @opindex fcall-saved
23986 Treat the register named @var{reg} as an allocable register saved by
23987 functions.  It may be allocated even for temporaries or variables that
23988 live across a call.  Functions compiled this way save and restore
23989 the register @var{reg} if they use it.
23991 It is an error to use this flag with the frame pointer or stack pointer.
23992 Use of this flag for other registers that have fixed pervasive roles in
23993 the machine's execution model produces disastrous results.
23995 A different sort of disaster results from the use of this flag for
23996 a register in which function values may be returned.
23998 This flag does not have a negative form, because it specifies a
23999 three-way choice.
24001 @item -fpack-struct[=@var{n}]
24002 @opindex fpack-struct
24003 Without a value specified, pack all structure members together without
24004 holes.  When a value is specified (which must be a small power of two), pack
24005 structure members according to this value, representing the maximum
24006 alignment (that is, objects with default alignment requirements larger than
24007 this are output potentially unaligned at the next fitting location.
24009 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
24010 code that is not binary compatible with code generated without that switch.
24011 Additionally, it makes the code suboptimal.
24012 Use it to conform to a non-default application binary interface.
24014 @item -finstrument-functions
24015 @opindex finstrument-functions
24016 Generate instrumentation calls for entry and exit to functions.  Just
24017 after function entry and just before function exit, the following
24018 profiling functions are called with the address of the current
24019 function and its call site.  (On some platforms,
24020 @code{__builtin_return_address} does not work beyond the current
24021 function, so the call site information may not be available to the
24022 profiling functions otherwise.)
24024 @smallexample
24025 void __cyg_profile_func_enter (void *this_fn,
24026                                void *call_site);
24027 void __cyg_profile_func_exit  (void *this_fn,
24028                                void *call_site);
24029 @end smallexample
24031 The first argument is the address of the start of the current function,
24032 which may be looked up exactly in the symbol table.
24034 This instrumentation is also done for functions expanded inline in other
24035 functions.  The profiling calls indicate where, conceptually, the
24036 inline function is entered and exited.  This means that addressable
24037 versions of such functions must be available.  If all your uses of a
24038 function are expanded inline, this may mean an additional expansion of
24039 code size.  If you use @code{extern inline} in your C code, an
24040 addressable version of such functions must be provided.  (This is
24041 normally the case anyway, but if you get lucky and the optimizer always
24042 expands the functions inline, you might have gotten away without
24043 providing static copies.)
24045 A function may be given the attribute @code{no_instrument_function}, in
24046 which case this instrumentation is not done.  This can be used, for
24047 example, for the profiling functions listed above, high-priority
24048 interrupt routines, and any functions from which the profiling functions
24049 cannot safely be called (perhaps signal handlers, if the profiling
24050 routines generate output or allocate memory).
24052 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
24053 @opindex finstrument-functions-exclude-file-list
24055 Set the list of functions that are excluded from instrumentation (see
24056 the description of @option{-finstrument-functions}).  If the file that
24057 contains a function definition matches with one of @var{file}, then
24058 that function is not instrumented.  The match is done on substrings:
24059 if the @var{file} parameter is a substring of the file name, it is
24060 considered to be a match.
24062 For example:
24064 @smallexample
24065 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
24066 @end smallexample
24068 @noindent
24069 excludes any inline function defined in files whose pathnames
24070 contain @file{/bits/stl} or @file{include/sys}.
24072 If, for some reason, you want to include letter @samp{,} in one of
24073 @var{sym}, write @samp{\,}. For example,
24074 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
24075 (note the single quote surrounding the option).
24077 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
24078 @opindex finstrument-functions-exclude-function-list
24080 This is similar to @option{-finstrument-functions-exclude-file-list},
24081 but this option sets the list of function names to be excluded from
24082 instrumentation.  The function name to be matched is its user-visible
24083 name, such as @code{vector<int> blah(const vector<int> &)}, not the
24084 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
24085 match is done on substrings: if the @var{sym} parameter is a substring
24086 of the function name, it is considered to be a match.  For C99 and C++
24087 extended identifiers, the function name must be given in UTF-8, not
24088 using universal character names.
24090 @item -fstack-check
24091 @opindex fstack-check
24092 Generate code to verify that you do not go beyond the boundary of the
24093 stack.  You should specify this flag if you are running in an
24094 environment with multiple threads, but you only rarely need to specify it in
24095 a single-threaded environment since stack overflow is automatically
24096 detected on nearly all systems if there is only one stack.
24098 Note that this switch does not actually cause checking to be done; the
24099 operating system or the language runtime must do that.  The switch causes
24100 generation of code to ensure that they see the stack being extended.
24102 You can additionally specify a string parameter: @samp{no} means no
24103 checking, @samp{generic} means force the use of old-style checking,
24104 @samp{specific} means use the best checking method and is equivalent
24105 to bare @option{-fstack-check}.
24107 Old-style checking is a generic mechanism that requires no specific
24108 target support in the compiler but comes with the following drawbacks:
24110 @enumerate
24111 @item
24112 Modified allocation strategy for large objects: they are always
24113 allocated dynamically if their size exceeds a fixed threshold.
24115 @item
24116 Fixed limit on the size of the static frame of functions: when it is
24117 topped by a particular function, stack checking is not reliable and
24118 a warning is issued by the compiler.
24120 @item
24121 Inefficiency: because of both the modified allocation strategy and the
24122 generic implementation, code performance is hampered.
24123 @end enumerate
24125 Note that old-style stack checking is also the fallback method for
24126 @samp{specific} if no target support has been added in the compiler.
24128 @item -fstack-limit-register=@var{reg}
24129 @itemx -fstack-limit-symbol=@var{sym}
24130 @itemx -fno-stack-limit
24131 @opindex fstack-limit-register
24132 @opindex fstack-limit-symbol
24133 @opindex fno-stack-limit
24134 Generate code to ensure that the stack does not grow beyond a certain value,
24135 either the value of a register or the address of a symbol.  If a larger
24136 stack is required, a signal is raised at run time.  For most targets,
24137 the signal is raised before the stack overruns the boundary, so
24138 it is possible to catch the signal without taking special precautions.
24140 For instance, if the stack starts at absolute address @samp{0x80000000}
24141 and grows downwards, you can use the flags
24142 @option{-fstack-limit-symbol=__stack_limit} and
24143 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
24144 of 128KB@.  Note that this may only work with the GNU linker.
24146 @item -fsplit-stack
24147 @opindex fsplit-stack
24148 Generate code to automatically split the stack before it overflows.
24149 The resulting program has a discontiguous stack which can only
24150 overflow if the program is unable to allocate any more memory.  This
24151 is most useful when running threaded programs, as it is no longer
24152 necessary to calculate a good stack size to use for each thread.  This
24153 is currently only implemented for the x86 targets running
24154 GNU/Linux.
24156 When code compiled with @option{-fsplit-stack} calls code compiled
24157 without @option{-fsplit-stack}, there may not be much stack space
24158 available for the latter code to run.  If compiling all code,
24159 including library code, with @option{-fsplit-stack} is not an option,
24160 then the linker can fix up these calls so that the code compiled
24161 without @option{-fsplit-stack} always has a large stack.  Support for
24162 this is implemented in the gold linker in GNU binutils release 2.21
24163 and later.
24165 @item -fleading-underscore
24166 @opindex fleading-underscore
24167 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
24168 change the way C symbols are represented in the object file.  One use
24169 is to help link with legacy assembly code.
24171 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
24172 generate code that is not binary compatible with code generated without that
24173 switch.  Use it to conform to a non-default application binary interface.
24174 Not all targets provide complete support for this switch.
24176 @item -ftls-model=@var{model}
24177 @opindex ftls-model
24178 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
24179 The @var{model} argument should be one of @samp{global-dynamic},
24180 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
24181 Note that the choice is subject to optimization: the compiler may use
24182 a more efficient model for symbols not visible outside of the translation
24183 unit, or if @option{-fpic} is not given on the command line.
24185 The default without @option{-fpic} is @samp{initial-exec}; with
24186 @option{-fpic} the default is @samp{global-dynamic}.
24188 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
24189 @opindex fvisibility
24190 Set the default ELF image symbol visibility to the specified option---all
24191 symbols are marked with this unless overridden within the code.
24192 Using this feature can very substantially improve linking and
24193 load times of shared object libraries, produce more optimized
24194 code, provide near-perfect API export and prevent symbol clashes.
24195 It is @strong{strongly} recommended that you use this in any shared objects
24196 you distribute.
24198 Despite the nomenclature, @samp{default} always means public; i.e.,
24199 available to be linked against from outside the shared object.
24200 @samp{protected} and @samp{internal} are pretty useless in real-world
24201 usage so the only other commonly used option is @samp{hidden}.
24202 The default if @option{-fvisibility} isn't specified is
24203 @samp{default}, i.e., make every symbol public.
24205 A good explanation of the benefits offered by ensuring ELF
24206 symbols have the correct visibility is given by ``How To Write
24207 Shared Libraries'' by Ulrich Drepper (which can be found at
24208 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
24209 solution made possible by this option to marking things hidden when
24210 the default is public is to make the default hidden and mark things
24211 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
24212 and @code{__attribute__ ((visibility("default")))} instead of
24213 @code{__declspec(dllexport)} you get almost identical semantics with
24214 identical syntax.  This is a great boon to those working with
24215 cross-platform projects.
24217 For those adding visibility support to existing code, you may find
24218 @code{#pragma GCC visibility} of use.  This works by you enclosing
24219 the declarations you wish to set visibility for with (for example)
24220 @code{#pragma GCC visibility push(hidden)} and
24221 @code{#pragma GCC visibility pop}.
24222 Bear in mind that symbol visibility should be viewed @strong{as
24223 part of the API interface contract} and thus all new code should
24224 always specify visibility when it is not the default; i.e., declarations
24225 only for use within the local DSO should @strong{always} be marked explicitly
24226 as hidden as so to avoid PLT indirection overheads---making this
24227 abundantly clear also aids readability and self-documentation of the code.
24228 Note that due to ISO C++ specification requirements, @code{operator new} and
24229 @code{operator delete} must always be of default visibility.
24231 Be aware that headers from outside your project, in particular system
24232 headers and headers from any other library you use, may not be
24233 expecting to be compiled with visibility other than the default.  You
24234 may need to explicitly say @code{#pragma GCC visibility push(default)}
24235 before including any such headers.
24237 @code{extern} declarations are not affected by @option{-fvisibility}, so
24238 a lot of code can be recompiled with @option{-fvisibility=hidden} with
24239 no modifications.  However, this means that calls to @code{extern}
24240 functions with no explicit visibility use the PLT, so it is more
24241 effective to use @code{__attribute ((visibility))} and/or
24242 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
24243 declarations should be treated as hidden.
24245 Note that @option{-fvisibility} does affect C++ vague linkage
24246 entities. This means that, for instance, an exception class that is
24247 be thrown between DSOs must be explicitly marked with default
24248 visibility so that the @samp{type_info} nodes are unified between
24249 the DSOs.
24251 An overview of these techniques, their benefits and how to use them
24252 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
24254 @item -fstrict-volatile-bitfields
24255 @opindex fstrict-volatile-bitfields
24256 This option should be used if accesses to volatile bit-fields (or other
24257 structure fields, although the compiler usually honors those types
24258 anyway) should use a single access of the width of the
24259 field's type, aligned to a natural alignment if possible.  For
24260 example, targets with memory-mapped peripheral registers might require
24261 all such accesses to be 16 bits wide; with this flag you can
24262 declare all peripheral bit-fields as @code{unsigned short} (assuming short
24263 is 16 bits on these targets) to force GCC to use 16-bit accesses
24264 instead of, perhaps, a more efficient 32-bit access.
24266 If this option is disabled, the compiler uses the most efficient
24267 instruction.  In the previous example, that might be a 32-bit load
24268 instruction, even though that accesses bytes that do not contain
24269 any portion of the bit-field, or memory-mapped registers unrelated to
24270 the one being updated.
24272 In some cases, such as when the @code{packed} attribute is applied to a 
24273 structure field, it may not be possible to access the field with a single
24274 read or write that is correctly aligned for the target machine.  In this
24275 case GCC falls back to generating multiple accesses rather than code that 
24276 will fault or truncate the result at run time.
24278 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
24279 not allowed to touch non bit-field members.  It is therefore recommended
24280 to define all bits of the field's type as bit-field members.
24282 The default value of this option is determined by the application binary
24283 interface for the target processor.
24285 @item -fsync-libcalls
24286 @opindex fsync-libcalls
24287 This option controls whether any out-of-line instance of the @code{__sync}
24288 family of functions may be used to implement the C++11 @code{__atomic}
24289 family of functions.
24291 The default value of this option is enabled, thus the only useful form
24292 of the option is @option{-fno-sync-libcalls}.  This option is used in
24293 the implementation of the @file{libatomic} runtime library.
24295 @end table
24297 @c man end
24299 @node Environment Variables
24300 @section Environment Variables Affecting GCC
24301 @cindex environment variables
24303 @c man begin ENVIRONMENT
24304 This section describes several environment variables that affect how GCC
24305 operates.  Some of them work by specifying directories or prefixes to use
24306 when searching for various kinds of files.  Some are used to specify other
24307 aspects of the compilation environment.
24309 Note that you can also specify places to search using options such as
24310 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
24311 take precedence over places specified using environment variables, which
24312 in turn take precedence over those specified by the configuration of GCC@.
24313 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
24314 GNU Compiler Collection (GCC) Internals}.
24316 @table @env
24317 @item LANG
24318 @itemx LC_CTYPE
24319 @c @itemx LC_COLLATE
24320 @itemx LC_MESSAGES
24321 @c @itemx LC_MONETARY
24322 @c @itemx LC_NUMERIC
24323 @c @itemx LC_TIME
24324 @itemx LC_ALL
24325 @findex LANG
24326 @findex LC_CTYPE
24327 @c @findex LC_COLLATE
24328 @findex LC_MESSAGES
24329 @c @findex LC_MONETARY
24330 @c @findex LC_NUMERIC
24331 @c @findex LC_TIME
24332 @findex LC_ALL
24333 @cindex locale
24334 These environment variables control the way that GCC uses
24335 localization information which allows GCC to work with different
24336 national conventions.  GCC inspects the locale categories
24337 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
24338 so.  These locale categories can be set to any value supported by your
24339 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
24340 Kingdom encoded in UTF-8.
24342 The @env{LC_CTYPE} environment variable specifies character
24343 classification.  GCC uses it to determine the character boundaries in
24344 a string; this is needed for some multibyte encodings that contain quote
24345 and escape characters that are otherwise interpreted as a string
24346 end or escape.
24348 The @env{LC_MESSAGES} environment variable specifies the language to
24349 use in diagnostic messages.
24351 If the @env{LC_ALL} environment variable is set, it overrides the value
24352 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
24353 and @env{LC_MESSAGES} default to the value of the @env{LANG}
24354 environment variable.  If none of these variables are set, GCC
24355 defaults to traditional C English behavior.
24357 @item TMPDIR
24358 @findex TMPDIR
24359 If @env{TMPDIR} is set, it specifies the directory to use for temporary
24360 files.  GCC uses temporary files to hold the output of one stage of
24361 compilation which is to be used as input to the next stage: for example,
24362 the output of the preprocessor, which is the input to the compiler
24363 proper.
24365 @item GCC_COMPARE_DEBUG
24366 @findex GCC_COMPARE_DEBUG
24367 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
24368 @option{-fcompare-debug} to the compiler driver.  See the documentation
24369 of this option for more details.
24371 @item GCC_EXEC_PREFIX
24372 @findex GCC_EXEC_PREFIX
24373 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
24374 names of the subprograms executed by the compiler.  No slash is added
24375 when this prefix is combined with the name of a subprogram, but you can
24376 specify a prefix that ends with a slash if you wish.
24378 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
24379 an appropriate prefix to use based on the pathname it is invoked with.
24381 If GCC cannot find the subprogram using the specified prefix, it
24382 tries looking in the usual places for the subprogram.
24384 The default value of @env{GCC_EXEC_PREFIX} is
24385 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
24386 the installed compiler. In many cases @var{prefix} is the value
24387 of @code{prefix} when you ran the @file{configure} script.
24389 Other prefixes specified with @option{-B} take precedence over this prefix.
24391 This prefix is also used for finding files such as @file{crt0.o} that are
24392 used for linking.
24394 In addition, the prefix is used in an unusual way in finding the
24395 directories to search for header files.  For each of the standard
24396 directories whose name normally begins with @samp{/usr/local/lib/gcc}
24397 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
24398 replacing that beginning with the specified prefix to produce an
24399 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
24400 @file{foo/bar} just before it searches the standard directory 
24401 @file{/usr/local/lib/bar}.
24402 If a standard directory begins with the configured
24403 @var{prefix} then the value of @var{prefix} is replaced by
24404 @env{GCC_EXEC_PREFIX} when looking for header files.
24406 @item COMPILER_PATH
24407 @findex COMPILER_PATH
24408 The value of @env{COMPILER_PATH} is a colon-separated list of
24409 directories, much like @env{PATH}.  GCC tries the directories thus
24410 specified when searching for subprograms, if it can't find the
24411 subprograms using @env{GCC_EXEC_PREFIX}.
24413 @item LIBRARY_PATH
24414 @findex LIBRARY_PATH
24415 The value of @env{LIBRARY_PATH} is a colon-separated list of
24416 directories, much like @env{PATH}.  When configured as a native compiler,
24417 GCC tries the directories thus specified when searching for special
24418 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
24419 using GCC also uses these directories when searching for ordinary
24420 libraries for the @option{-l} option (but directories specified with
24421 @option{-L} come first).
24423 @item LANG
24424 @findex LANG
24425 @cindex locale definition
24426 This variable is used to pass locale information to the compiler.  One way in
24427 which this information is used is to determine the character set to be used
24428 when character literals, string literals and comments are parsed in C and C++.
24429 When the compiler is configured to allow multibyte characters,
24430 the following values for @env{LANG} are recognized:
24432 @table @samp
24433 @item C-JIS
24434 Recognize JIS characters.
24435 @item C-SJIS
24436 Recognize SJIS characters.
24437 @item C-EUCJP
24438 Recognize EUCJP characters.
24439 @end table
24441 If @env{LANG} is not defined, or if it has some other value, then the
24442 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
24443 recognize and translate multibyte characters.
24444 @end table
24446 @noindent
24447 Some additional environment variables affect the behavior of the
24448 preprocessor.
24450 @include cppenv.texi
24452 @c man end
24454 @node Precompiled Headers
24455 @section Using Precompiled Headers
24456 @cindex precompiled headers
24457 @cindex speed of compilation
24459 Often large projects have many header files that are included in every
24460 source file.  The time the compiler takes to process these header files
24461 over and over again can account for nearly all of the time required to
24462 build the project.  To make builds faster, GCC allows you to
24463 @dfn{precompile} a header file.
24465 To create a precompiled header file, simply compile it as you would any
24466 other file, if necessary using the @option{-x} option to make the driver
24467 treat it as a C or C++ header file.  You may want to use a
24468 tool like @command{make} to keep the precompiled header up-to-date when
24469 the headers it contains change.
24471 A precompiled header file is searched for when @code{#include} is
24472 seen in the compilation.  As it searches for the included file
24473 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
24474 compiler looks for a precompiled header in each directory just before it
24475 looks for the include file in that directory.  The name searched for is
24476 the name specified in the @code{#include} with @samp{.gch} appended.  If
24477 the precompiled header file can't be used, it is ignored.
24479 For instance, if you have @code{#include "all.h"}, and you have
24480 @file{all.h.gch} in the same directory as @file{all.h}, then the
24481 precompiled header file is used if possible, and the original
24482 header is used otherwise.
24484 Alternatively, you might decide to put the precompiled header file in a
24485 directory and use @option{-I} to ensure that directory is searched
24486 before (or instead of) the directory containing the original header.
24487 Then, if you want to check that the precompiled header file is always
24488 used, you can put a file of the same name as the original header in this
24489 directory containing an @code{#error} command.
24491 This also works with @option{-include}.  So yet another way to use
24492 precompiled headers, good for projects not designed with precompiled
24493 header files in mind, is to simply take most of the header files used by
24494 a project, include them from another header file, precompile that header
24495 file, and @option{-include} the precompiled header.  If the header files
24496 have guards against multiple inclusion, they are skipped because
24497 they've already been included (in the precompiled header).
24499 If you need to precompile the same header file for different
24500 languages, targets, or compiler options, you can instead make a
24501 @emph{directory} named like @file{all.h.gch}, and put each precompiled
24502 header in the directory, perhaps using @option{-o}.  It doesn't matter
24503 what you call the files in the directory; every precompiled header in
24504 the directory is considered.  The first precompiled header
24505 encountered in the directory that is valid for this compilation is
24506 used; they're searched in no particular order.
24508 There are many other possibilities, limited only by your imagination,
24509 good sense, and the constraints of your build system.
24511 A precompiled header file can be used only when these conditions apply:
24513 @itemize
24514 @item
24515 Only one precompiled header can be used in a particular compilation.
24517 @item
24518 A precompiled header can't be used once the first C token is seen.  You
24519 can have preprocessor directives before a precompiled header; you cannot
24520 include a precompiled header from inside another header.
24522 @item
24523 The precompiled header file must be produced for the same language as
24524 the current compilation.  You can't use a C precompiled header for a C++
24525 compilation.
24527 @item
24528 The precompiled header file must have been produced by the same compiler
24529 binary as the current compilation is using.
24531 @item
24532 Any macros defined before the precompiled header is included must
24533 either be defined in the same way as when the precompiled header was
24534 generated, or must not affect the precompiled header, which usually
24535 means that they don't appear in the precompiled header at all.
24537 The @option{-D} option is one way to define a macro before a
24538 precompiled header is included; using a @code{#define} can also do it.
24539 There are also some options that define macros implicitly, like
24540 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
24541 defined this way.
24543 @item If debugging information is output when using the precompiled
24544 header, using @option{-g} or similar, the same kind of debugging information
24545 must have been output when building the precompiled header.  However,
24546 a precompiled header built using @option{-g} can be used in a compilation
24547 when no debugging information is being output.
24549 @item The same @option{-m} options must generally be used when building
24550 and using the precompiled header.  @xref{Submodel Options},
24551 for any cases where this rule is relaxed.
24553 @item Each of the following options must be the same when building and using
24554 the precompiled header:
24556 @gccoptlist{-fexceptions}
24558 @item
24559 Some other command-line options starting with @option{-f},
24560 @option{-p}, or @option{-O} must be defined in the same way as when
24561 the precompiled header was generated.  At present, it's not clear
24562 which options are safe to change and which are not; the safest choice
24563 is to use exactly the same options when generating and using the
24564 precompiled header.  The following are known to be safe:
24566 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
24567 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
24568 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
24569 -pedantic-errors}
24571 @end itemize
24573 For all of these except the last, the compiler automatically
24574 ignores the precompiled header if the conditions aren't met.  If you
24575 find an option combination that doesn't work and doesn't cause the
24576 precompiled header to be ignored, please consider filing a bug report,
24577 see @ref{Bugs}.
24579 If you do use differing options when generating and using the
24580 precompiled header, the actual behavior is a mixture of the
24581 behavior for the options.  For instance, if you use @option{-g} to
24582 generate the precompiled header but not when using it, you may or may
24583 not get debugging information for routines in the precompiled header.